S9SourceNine Labs / CMAPI Docs 1.1
CMAPI / API reference

InventoryItemDescriptor

Stable item metadata supplied to an inventory slot provider. CMAPI does not expose or transfer the game's mutable world-object instance.

View source ↗
CMAPI 1.1.4Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIClassAssembly CMAPI.API.dll
public sealed class InventoryItemDescriptor

Stable item metadata supplied to an inventory slot provider. CMAPI does not expose or transfer the game's mutable world-object instance.

Members

WorldObjectIdGets the game's world-object identifier, or -1 for a prospective item.propertyItemIdGets the stable group identifier.propertyItemCategoryGets the native item-category name.propertyItemSubCategoryGets the native item-subcategory name.propertyUsableTypeGets the native usable-type name.propertyEquipableTypeGets the native equipable-type name.propertyIsLockedGets whether the world object is locked in its inventory.propertyHasCustomStateGets whether this instance carries mutable state which should normally keep it in an independent slot.propertyStateKeyGets an opaque equality key for the mutable state represented by this descriptor. The format is owned by CMAPI and may change between API versions.propertyInventoryItemDescriptorCreates immutable item metadata.method

WorldObjectId

property
public int WorldObjectId

Gets the game's world-object identifier, or -1 for a prospective item.

ItemId

property
public string ItemId

Gets the stable group identifier.

ItemCategory

property
public string ItemCategory

Gets the native item-category name.

ItemSubCategory

property
public string ItemSubCategory

Gets the native item-subcategory name.

UsableType

property
public string UsableType

Gets the native usable-type name.

EquipableType

property
public string EquipableType

Gets the native equipable-type name.

IsLocked

property
public bool IsLocked

Gets whether the world object is locked in its inventory.

HasCustomState

property
public bool HasCustomState

Gets whether this instance carries mutable state which should normally keep it in an independent slot.

StateKey

property
public string StateKey

Gets an opaque equality key for the mutable state represented by this descriptor. The format is owned by CMAPI and may change between API versions.

InventoryItemDescriptor

method
public InventoryItemDescriptor( int worldObjectId, string itemId, string itemCategory, string itemSubCategory, string usableType, string equipableType, bool isLocked, bool hasCustomState, string stateKey)

Creates immutable item metadata.