SineSpace.Scripting.Player.SInventoryItem Class Reference

Public Member Functions
bool	StoreCustomData (string data)
	Whether store the customdata or not.
void	Use ()
	Use the item but this only works on white label grids.
void	Delete (int amount=1)
	Delete the item.

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

Member Function Documentation

Delete()

void SineSpace.Scripting.Player.SInventoryItem.Delete

(

int

amount = 1

)

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

data	The 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>