|
|
| Line 1: |
Line 1: |
| − | Each SInventoryItem refers to a single item in the users inventory. Below members may require inventory authorization, please see [[Scripting/SInventory]] for master inventory access.
| + | This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/sinventoryitem |
| − | | + | |
| − | ==Members==
| + | |
| − | {{ScriptFunction|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'''.}}
| + | |
| − | | + | |
| − | {{ScriptFunction|void|Use|();|Player will 'Use' this item. (White-label only) |5=
| + | |
| − | <pre>Items = Space.Inventory.Items
| + | |
| − | Items[1].Use() </pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|void|Delete|();|Player will 'Delete' this item. (White-label only) |5=
| + | |
| − | <pre>Items = Space.Inventory.Items
| + | |
| − | Items[1].Delete()</pre>}}
| + | |
| − | | + | |
| − | ==Properties==
| + | |
| − | {{ScriptFunction|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.|5=
| + | |
| − | <pre>Items = Space.Inventory.Items
| + | |
| − | iMasterID = Items[1].MasterID</pre>}}
| + | |
| − | {{ScriptFunction|long|PlayerItemID|{ get; }|The instance ID for this item - this is guaranteed to be unique per inventory item|5=
| + | |
| − | <pre>Items = Space.Inventory.Items
| + | |
| − | iPlayerItemID= Items[1].PlayerItemID</pre>}}
| + | |
| − | {{ScriptFunction|string|Name|{ get; }|Returns the name of the inventory item|5=
| + | |
| − | <pre>Items = Space.Inventory.Items
| + | |
| − | iName= Items[1].Name</pre>}}
| + | |
| − | {{ScriptFunction|string|Description|{ get; }|Returns the registered description of the inventory item in the users locale|5=
| + | |
| − | <pre>Items = Space.Inventory.Items
| + | |
| − | iDescription=Items[1].Description</pre>}}
| + | |
| − | {{ScriptFunction|string|Brand|{ get; }|Returns brand information about the item|5=
| + | |
| − | <pre>Items = Space.Inventory.Items
| + | |
| − | iBrand = Items[1].Brand</pre>}}
| + | |
| − | {{ScriptFunction|string|CustomData|{ get; }|Returns any custom data associated with this item, typically used for 'game' items|5=
| + | |
| − | <pre>Items = Space.Inventory.Items
| + | |
| − | iCustomData = Items[1].CustomData</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | {{Scripting Navbox}}
| + | |
