SInventory
Index
Functions Index
| Function Name |
|---|
| void Authorize (Closure onAuthorized=null, Closure onRejected=null) |
| int CountCopiesOfItem (int itemID) |
| void AddToHotbar (int index, int itemID) |
| void RemoveFromHotbar (int index) |
| void RequestRefresh () |
Properties Index
| Property Name |
|---|
bool Authorized get |
SInventoryItem[] Items get |
Functions
Authorize
void Authorize (Closure onAuthorized=null, Closure onRejected=null)
Requests access to inventory functions, must be called prior to attempting to access inventory. As soon as the player has accepted the request, the Authorized attribute will be 'true'.
| Parameter | Type | Description |
|---|---|---|
- Lua
Space.Inventory.Authorize()
--or
Space.Inventory.Authorize(onAuth, onRej)
- Lua
--this script shows you how to use this function to take authorization and immediately
--take action based on the result all in a single prompt (a click in this case)
function ifno()
Space.Log("not authorized")
end
function ifyes()
Space.Log("authorized")
--your next steps go here
end
function click()
Space.Inventory.Authorize(ifyes,ifno)
end
Space.Host.ExecutingObject.AddClickable()
Space.Host.ExecutingObject.Clickable.OnClick(click)
CountCopiesOfItem
int CountCopiesOfItem (int itemID)
Function Description
| Parameter | Type | Description |
|---|---|---|
- Lua
numOfCopies = Space.Inventory.CountCopiesOfItem(38384839)
AddToHotbar
void AddToHotbar (int index, int itemID)
Adds the first found instance of itemID to the players hotbar entry at slot 'index'.
| Parameter | Type | Description |
|---|---|---|
- Lua
Space.Inventory.AddToHotbar(2, 23423523)
RemoveFromHotbar
void RemoveFromHotbar (int index)
Remove item at slot index from Hotbar
| Parameter | Type | Description |
|---|---|---|
- Lua
Space.Inventory.RemoveFromHotbar(2)
RequestRefresh
void RequestRefresh ()
Forces a check for external changes to the users inventory, can only be called once every 60 seconds
| Parameter | Type | Description |
|---|---|---|
- Lua
Space.Inventory.RequestRefresh()
Properties
Authorized
bool Authorized get
Returns true if player has accepted access authorization request to his inventory
- Lua
isAuthorized = Space.Inventory.Authorized
Items
SInventoryItem[] Items get
Returns the array of the users current inventory items
- Lua
invItems = Space.Inventory.Items