Show / Hide Table of Contents

    Class BodyContainerItem

    Class that represents a container item for body slots.

    Inheritance
    System.Object
    Thing
    Item
    ContainerItem
    BodyContainerItem
    Implements
    IContainerItem
    IItem
    IThing
    System.IEquatable<IThing>
    IContainedThing
    IThingContainer
    ILocatable
    Inherited Members
    ContainerItem.ContentAdded
    ContainerItem.ContentUpdated
    ContainerItem.ContentRemoved
    ContainerItem.Content
    ContainerItem.Item[Int32]
    ContainerItem.RemoveContent(IThingFactory, IThing, Byte, Byte)
    ContainerItem.ReplaceContent(IThingFactory, IThing, IThing, Byte, Byte)
    ContainerItem.CountAmountAt(Byte, UInt16)
    ContainerItem.IsChildOf(IItem)
    ContainerItem.FindThingAtIndex(Byte)
    ContainerItem.InvokeContentAdded(IItem)
    ContainerItem.InvokeContentRemoved(Byte)
    ContainerItem.InvokeContentUpdated(Byte, IItem)
    Item.Type
    Item.Attributes
    Item.TypeId
    Item.ChangesOnUse
    Item.ChangeOnUseTo
    Item.CanBeRotated
    Item.RotateTo
    Item.HasExpiration
    Item.ExpirationTimeLeft
    Item.ExpirationTarget
    Item.CanBeMoved
    Item.HasCollision
    Item.HasSeparation
    Item.IsCumulative
    Item.Amount
    Item.IsContainer
    Item.CanBeDressed
    Item.DressPosition
    Item.IsGround
    Item.MovementPenalty
    Item.IsGroundFix
    Item.StaysOnTop
    Item.StaysOnBottom
    Item.IsLiquidPool
    Item.IsLiquidSource
    Item.IsLiquidContainer
    Item.LiquidType
    Item.BlocksThrow
    Item.BlocksPass
    Item.BlocksLay
    Item.IsPathBlocking(Byte)
    Item.Merge(IItem)
    Item.Split(IItemFactory, Byte)
    Item.DescribeForLogger()
    Thing.LocationChanged
    Thing.UniqueId
    Thing.ParentContainer
    Thing.TrackedEvents
    Thing.Conditions
    Thing.RaiseLocationChanged(Location)
    Thing.ToString()
    Thing.Equals(IThing)
    Thing.StartTrackingEvent(IEvent, String)
    Thing.StopTrackingEvent(IEvent, String)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Fibula.Items
    Assembly: Fibula.Items.dll
    Syntax
    public class BodyContainerItem : ContainerItem, IContainerItem, IItem, IThing, IEquatable<IThing>, IContainedThing, IThingContainer, ILocatable

    Constructors

    | Improve this Doc View Source

    BodyContainerItem(Slot)

    Initializes a new instance of the BodyContainerItem class.

    Declaration
    public BodyContainerItem(Slot slot)
    Parameters
    Type Name Description
    Slot slot

    The slot at which this body container is.

    Properties

    | Improve this Doc View Source

    Capacity

    Gets the capacity of this container.

    Declaration
    public override byte Capacity { get; }
    Property Value
    Type Description
    System.Byte
    Overrides
    ContainerItem.Capacity
    | Improve this Doc View Source

    CarryLocation

    Gets the location where this thing is being carried at, which is none for creatures.

    Declaration
    public override Location? CarryLocation { get; }
    Property Value
    Type Description
    System.Nullable<Location>
    Overrides
    Item.CarryLocation
    | Improve this Doc View Source

    Location

    Gets this body container's location.

    Declaration
    public override Location Location { get; }
    Property Value
    Type Description
    Location
    Overrides
    Thing.Location
    | Improve this Doc View Source

    Slot

    Gets this body container's slot.

    Declaration
    public Slot Slot { get; }
    Property Value
    Type Description
    Slot

    Methods

    | Improve this Doc View Source

    AddContent(IThingFactory, IThing, Byte)

    Attempts to add a IThing to this container.

    Declaration
    public override (bool result, IThing remainder) AddContent(IThingFactory thingFactory, IThing thing, byte index = 255)
    Parameters
    Type Name Description
    IThingFactory thingFactory

    A reference to the factory of things to use.

    IThing thing

    The IThing to add to the container.

    System.Byte index

    Optional. The index at which to add the IThing. Defaults to byte.MaxValue, which instructs to add the IThing at any free index.

    Returns
    Type Description
    System.ValueTuple<System.Boolean, IThing>

    A tuple with a value indicating whether the attempt was at least partially successful, and false otherwise. If the result was only partially successful, a remainder of the thing may be returned.

    Overrides
    ContainerItem.AddContent(IThingFactory, IThing, Byte)

    Implements

    IContainerItem
    IItem
    IThing
    System.IEquatable<T>
    IContainedThing
    IThingContainer
    ILocatable

    Extension Methods

    ObjectExtensions.YieldSingleItem<T>(T)
    ObjectExtensions.GetPropertyValue(Object, String)
    Validate.ThrowIfNull(Object, String)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2018-2020 | The Fibula Project
    Generated using DocFX | Jose L. Nuñez de Caceres et al.