Sinespace Client  2023.2.17543
Client-side scripting for Sinespace
SineSpace.Scripting.Player.SInventoryItem Class Reference

Public Member Functions

bool StoreCustomData (string data)
 Whether store the customdata or not More...
 
void Use ()
 Use the item but this only works on white label grids More...
 
void Delete ()
 Delete the item More...
 

Properties

long MasterID [get]
 Return the itemID of the item More...
 
long PlayerItemID [get]
 Return the PlayerItemID of the item More...
 
string Name [get]
 Return the Name of the item More...
 
string Description [get]
 Return the Description of the item More...
 
string Brand [get]
 Return the Brand of the item More...
 
string CustomData [get]
 Return the StoredDataString of the item More...
 

Member Function Documentation

◆ Delete()

void SineSpace.Scripting.Player.SInventoryItem.Delete ( )

Delete the item

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
item[1].Delete()
end
</example>

◆ StoreCustomData()

bool SineSpace.Scripting.Player.SInventoryItem.StoreCustomData ( string  data)

Whether store the customdata or not

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
Space.Log(item[1].StoreCustomData("pz"))
end
</example>
Parameters
dataThe customization data

◆ Use()

void SineSpace.Scripting.Player.SInventoryItem.Use ( )

Use the item but this only works on white label grids

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
item[1].Use()
end
</example>

Property Documentation

◆ Brand

string SineSpace.Scripting.Player.SInventoryItem.Brand
get

Return the Brand of the item

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
Space.Log(item[1].Brand)
end
</example>

◆ CustomData

string SineSpace.Scripting.Player.SInventoryItem.CustomData
get

Return the StoredDataString of the item

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
Space.Log(item[1].CustomData)
end
</example>

◆ Description

string SineSpace.Scripting.Player.SInventoryItem.Description
get

Return the Description of the item

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
Space.Log(item[1].Description)
end
</example>

◆ MasterID

long SineSpace.Scripting.Player.SInventoryItem.MasterID
get

Return the itemID of the item

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
Space.Log(item[1].MasterID)
end
</example>

◆ Name

string SineSpace.Scripting.Player.SInventoryItem.Name
get

Return the Name of the item

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
Space.Log(item[1].Name)
end
</example>

◆ PlayerItemID

long SineSpace.Scripting.Player.SInventoryItem.PlayerItemID
get

Return the PlayerItemID of the item

local inventory=Space.Inventory
inventory.Authorize()
function Log()
local item=Space.Inventory.Items
Space.Log(item[1].PlayerItemID)
end
</example>
SineSpace.Scripting.Player.SInventoryItem.Name
string Name
Return the Name of the item
Definition: SInventoryItem.cs:63
SineSpace.Scripting.Player.SInventoryItem.Brand
string Brand
Return the Brand of the item
Definition: SInventoryItem.cs:99
SineSpace.Scripting.Player.SInventoryItem.CustomData
string CustomData
Return the StoredDataString of the item
Definition: SInventoryItem.cs:117
SineSpace.Scripting.Player.SInventoryItem.Delete
void Delete()
Delete the item
Definition: SInventoryItem.cs:200
SineSpace.Scripting.Player.SInventoryItem.PlayerItemID
long PlayerItemID
Return the PlayerItemID of the item
Definition: SInventoryItem.cs:45
SineSpace.Scripting.Player.SInventoryItem.MasterID
long MasterID
Return the itemID of the item
Definition: SInventoryItem.cs:27
SineSpace.Scripting.Player.SInventoryItem.StoreCustomData
bool StoreCustomData(string data)
Whether store the customdata or not
Definition: SInventoryItem.cs:141
SineSpace.Scripting.Player.SInventoryItem.Description
string Description
Return the Description of the item
Definition: SInventoryItem.cs:81
SineSpace.Scripting.Player.SInventoryItem.Use
void Use()
Use the item but this only works on white label grids
Definition: SInventoryItem.cs:172