Show / Hide Table of Contents

    Class ItemTypeEntity

    Class that represents an item type entity.

    Inheritance
    System.Object
    BaseEntity
    ItemTypeEntity
    Implements
    IItemTypeEntity
    IIdentifiableEntity
    IEntity
    System.ICloneable
    Inherited Members
    BaseEntity.Id
    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)
    System.Object.ToString()
    Namespace: Fibula.Data.Entities
    Assembly: Fibula.Data.Entities.dll
    Syntax
    public class ItemTypeEntity : BaseEntity, IItemTypeEntity, IIdentifiableEntity, IEntity, ICloneable

    Constructors

    | Improve this Doc View Source

    ItemTypeEntity()

    Initializes a new instance of the ItemTypeEntity class.

    Declaration
    public ItemTypeEntity()

    Properties

    | Improve this Doc View Source

    ClientId

    Gets the client id of the type of this item.

    Declaration
    public ushort ClientId { get; }
    Property Value
    Type Description
    System.UInt16
    | Improve this Doc View Source

    DefaultAttributes

    Gets the attributes of this type of item.

    Declaration
    public IDictionary<byte, IConvertible> DefaultAttributes { get; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.Byte, System.IConvertible>
    | Improve this Doc View Source

    Description

    Gets or sets the decription of this type of item.

    Declaration
    public string Description { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Flags

    Gets the flags for this type of item.

    Declaration
    public ulong Flags { get; }
    Property Value
    Type Description
    System.UInt64
    Remarks

    The flags are stored as bits in a 64 bit unsigned integer.

    | Improve this Doc View Source

    Locked

    Gets a value indicating whether this item type is locked and no longer accepting changes.

    Declaration
    public bool Locked { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Name

    Gets or sets the name of this type of item.

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    TypeId

    Gets or sets the id of the type of this item.

    Declaration
    public ushort TypeId { get; set; }
    Property Value
    Type Description
    System.UInt16

    Methods

    | Improve this Doc View Source

    LockChanges()

    Locks the type, preventing it from accepting changes.

    Declaration
    public void LockChanges()
    | Improve this Doc View Source

    SetAttribute(ItemAttribute, Int32)

    Sets an attribute in this type.

    Declaration
    public void SetAttribute(ItemAttribute attribute, int attributeValue)
    Parameters
    Type Name Description
    ItemAttribute attribute

    The attribute to set in the type.

    System.Int32 attributeValue

    The value of the attribute to set in the type.

    | Improve this Doc View Source

    SetItemFlag(ItemFlag)

    Sets a flag in this type.

    Declaration
    public void SetItemFlag(ItemFlag itemFlag)
    Parameters
    Type Name Description
    ItemFlag itemFlag

    The flag to set in the type.

    Explicit Interface Implementations

    | Improve this Doc View Source

    ICloneable.Clone()

    Clones the ItemTypeEntity into a new instance without locking the clone.

    Declaration
    object ICloneable.Clone()
    Returns
    Type Description
    System.Object

    The cloned ItemTypeEntity.

    Implements

    IItemTypeEntity
    IIdentifiableEntity
    IEntity
    System.ICloneable

    Extension Methods

    ItemTypeEntityExtensions.HasItemFlag(IItemTypeEntity, ItemFlag)
    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.