SInventoryItem

Index

Functions Index

Function Name
bool StoreCustomData (string data)
void Use ()
void Delete ()

Properties Index

Property Name
long MasterID get
long PlayerItemID get
string Name get
string Description get
string Brand get
string CustomData get

Functions

StoreCustomData

bool StoreCustomData (string data)

Updates the inventory items custom data, and requests a synchronisation with the inventory server. It may not update on the server immediately, but all local calls will reflect the new data. Note: this request can be rate limited and should only be called from a user initiated action (such as clicking a button). Updates to custom data must not be initiated on a timer or regular automatic event. Access to this function can be blacklisted to specific creators if abused.

Parameter	Type	Description

Lua

Items = Space.Inventory.Items
Items[1].StoreCustomData('data1data2data3')

Use

void Use ()

Player will 'Use' this item. (White-label only)

Lua

Items = Space.Inventory.Items
Items[1].Use() 

Delete

void Delete ()

Player will 'Delete' this item. (White-label only)

Lua

Items = Space.Inventory.Items
Items[1].Delete()

Properties

MasterID

long MasterID get

The master ID for this item - also known as the Curator ID or Item ID, this is the ID for the master item from which this copy exists.

Lua

Items = Space.Inventory.Items
iMasterID = Items[1].MasterID

PlayerItemID

long PlayerItemID get

The instance ID for this item - this is guaranteed to be unique per inventory item

Lua

Items = Space.Inventory.Items
iPlayerItemID= Items[1].PlayerItemID

Name

string Name get

Returns the name of the inventory item

Lua

Items = Space.Inventory.Items
iName= Items[1].Name

Description

string Description get

Returns the registered description of the inventory item in the users locale

Lua

Items = Space.Inventory.Items
iDescription=Items[1].Description

Brand

string Brand get

Returns brand information about the item

Lua

Items = Space.Inventory.Items
iBrand = Items[1].Brand

CustomData

string CustomData get

Returns any custom data associated with this item, typically used for 'game' items

Lua

Items = Space.Inventory.Items
iCustomData = Items[1].CustomData