CKS TYPECKS reference

Item

Browse its members and the signatures that accept or return this type.

11 members3 return it6 accept it

Members

Expand a member to read its notes or open its full entry. Each overload keeps its own identity.

Member	Signature and description
`IsValid` returns true when the handle's registry base plus subobject offset is nonzero, and false when the registry slot is empty. Open full entry → Item	`bool Item::IsValid()` returns true when the handle's registry base plus subobject offset is nonzero, and false when the registry slot is empty.
`use_count` Item::use_count resolves an Item, resolves the registry slot stored at Item [field], and returns the secondary object's dword at [field]. Open full entry → Item	`int Item::use_count()` Item::use_count resolves an Item, resolves the registry slot stored at Item [field], and returns the secondary object's dword at [field].
`custom_data` Item::custom_data re-resolves the Item wrapper's registered base object through [field] and returns its dword at [field]. Open full entry → Item	`int Item::custom_data()` Item::custom_data re-resolves the Item wrapper's registered base object through [field] and returns its dword at [field].
`id` Builds a VM string from the registered item base descriptor first string. Open full entry → Item	`str Item::id()` Builds a VM string from the registered item base descriptor first string.
`name` Builds a VM string from the same descriptor string selected by Item id. Open full entry → Item	`str Item::name()` Builds a VM string from the same descriptor string selected by Item id.
`display_name` Builds a VM string from the descriptor second string at [field]. Open full entry → Item	`str Item::display_name()` Builds a VM string from the descriptor second string at [field].
`Use` Resolves the registered Item base and forwards it to the immediate use helper. Open full entry → Item	`void Item::Use()` Resolves the registered Item base and forwards it to the immediate use helper.
`Use` Forwards a target object handle to the targeted use helper after resolving the Item base. Open full entry → Item	`void Item::Use(Obj)` Forwards a target object handle to the targeted use helper after resolving the Item base.
`Use` Clamps a point to signed map bounds and forwards it to the positional use helper. Open full entry → Item	`void Item::Use(point)` Clamps a point to signed map bounds and forwards it to the positional use helper.
`SetCustomData` Behavior awaiting documentation. Open full entry → Item	`void Item::SetCustomData(int)`Description pending Description pending.
`SetUseCount` Stores the supplied 32-bit value in a base item field. Open full entry → Item	`void Item::SetUseCount(int)` Stores the supplied 32-bit value in a base item field.

Return this type

Member	Signature and description
`Obj::FindItem`Obj	`Item Obj::FindItem(str)`Description pending Description pending.
`Obj::GetItem`Obj	`Item Obj::GetItem(int)` GetItem builds a handle from the virtual lookup result.
`GetThis`Global	`Item GetThis()` Returns the item reference stored by the current item script while its registry entry remains nonnull.

Accept this type

Member	Signature and description
`=`Global	`void =(Item&, Item)`Description pending Description pending.
`Obj::GiveItem`Obj	`bool Obj::GiveItem(Item, Obj)` Transfers an owned item to another live object. If the destination cannot accept it, the transfer attempts to return it to the source.
`Obj::PutItem`Obj	`bool Obj::PutItem(Item, ItemHolder)` Moves an inventory item into the specified item holder.
`Obj::DropItem`Obj	`bool Obj::DropItem(Item, point)` Requests that a specified receiver item be dropped at a point while returning false.
`Obj::ExchangeItem`Obj	`bool Obj::ExchangeItem(Item, str)` ExchangeItem returns true after a gated replacement dispatch.
`Obj::GetItemIndex`Obj	`int Obj::GetItemIndex(Item)` GetItemIndex increments the virtual index result.

Coverage and limits

10 / 11 members with a published description.

These lists come from published signatures. “Accept” counts explicit parameters, excluding the method receiver; reference variants (&) are included. No inheritance hierarchy is asserted. Undocumented names, units and effects remain unresolved.