This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
component:inventory_controller [2015/04/05 15:42] rashy Edited example, sides.back breaks. |
component:inventory_controller [2018/07/22 00:16] sulljason Inventory Controller returns a label now. |
||
|---|---|---|---|
| Line 12: | Line 12: | ||
| - `getInventorySize(side: number): number or nil[, string]` | - `getInventorySize(side: number): number or nil[, string]` | ||
| - | Returns the size of the inventory at the specified side. | + | Returns the size of the inventory at the specified side. |
| **side** - must be a valid side. | **side** - must be a valid side. | ||
| **Returns:** the size of the inventory, or `nil` followed by a description why this function failed (usually `no inventory`). | **Returns:** the size of the inventory, or `nil` followed by a description why this function failed (usually `no inventory`). | ||
| - `getStackInSlot(side:number, slot:number):table` | - `getStackInSlot(side:number, slot:number):table` | ||
| - | Returns a table describing the item in the specified slot or nil. | + | |
| + | Returns a table describing the item in the specified slot or nil. Deprecated for getting info about robot's own inventory, see `getStackInInternalSlot`. | ||
| **side** - must be a valid side. | **side** - must be a valid side. | ||
| **slot** - the slot to analyze. This does not check the inventory size and will consider slots outside the inventory bounds to be empty. | **slot** - the slot to analyze. This does not check the inventory size and will consider slots outside the inventory bounds to be empty. | ||
| Line 24: | Line 25: | ||
| - **size**:number - the current stack size of the item. | - **size**:number - the current stack size of the item. | ||
| - **maxSize**:number - the maximum stack size of this item. | - **maxSize**:number - the maximum stack size of this item. | ||
| - | - **id**:number - the Minecraft id of the item. Note that this depends on the server's config setting and can vary between servers! | + | - **id**:number - the Minecraft id of the item. Note that this field is only included if `insertIdsInConverters=true` in the configs, and can vary between servers! |
| - **name**:string - the **untranslated** item name, which is an internal Minecraft value like `oc:item.FloppyDisk` | - **name**:string - the **untranslated** item name, which is an internal Minecraft value like `oc:item.FloppyDisk` | ||
| + | - **label**:string - the **translated** item name | ||
| - **hasTag**:boolean - whether or not the item has an NBT tag associated with it. | - **hasTag**:boolean - whether or not the item has an NBT tag associated with it. | ||
| + | - `getStackInInternalSlot(slot:number):table` | ||
| + | Gets Itemstack description of item in specified or selected slot (if no input provided) of robot inventory. | ||
| - `dropIntoSlot(side:number, slot:number[, count:number]):boolean[, string]` | - `dropIntoSlot(side:number, slot:number[, count:number]):boolean[, string]` | ||
| Puts up to count items from the currently selected slot into the specified slot of the inventory at the specified side. | Puts up to count items from the currently selected slot into the specified slot of the inventory at the specified side. | ||
| Line 58: | Line 62: | ||
| - `getSlotStackSize(side:number, slot:number):number` | - `getSlotStackSize(side:number, slot:number):number` | ||
| Gets number of items in specified slot in inventory on the specified side. | Gets number of items in specified slot in inventory on the specified side. | ||
| - | - `getStackInInternalSlot(slot:number):table` | + | |
| - | Gets Itemstack description of item in specified or selected slot (if no input provided) or robot inventory. | + | |
| Example: | Example: | ||