wiki.sine.space | sinespace

Difference between revisions of "Scripting/SInventoryItem"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/sinventoryitem")
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Each SInventoryItem refers to a single item in the users inventory. See also {{Scripting/SInventory}} for master inventory access.
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/sinventoryitem
 
+
==Members==
+
{{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}}
+
{{ScriptFunction|long|PlayerItemID|{ get; }|The instance ID for this item - this is guaranteed to be unique per inventory item}}
+
{{ScriptFunction|string|Name|{ get; }|Returns the name of the inventory item}}
+
{{ScriptFunction|string|Description|{ get; }|Returns the registered description of the inventory item in the users locale}}
+
{{ScriptFunction|string|Brand|{ get; }|Returns brand information about the item}}
+
{{ScriptFunction|string|CustomData|{ get; }|Returns any custom data associated with this item, typically used for 'game' items}}
+
{{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'''.}}
+
 
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 07:09, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/sinventoryitem