IInventory

Импорт класса

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
Copy
import crafttweaker.api.inventory.IInventory;

Methods

clear

Clears this inventory of all items.

Return Type: void

ZenScript
Copy
// IInventory.clear() as void

myIInventory.clear();
closeInventory

Marks the inventory as closed, this is used by chests and barrels to determine if they should have a closed texture / model, but other inventories may use it in a different way.

Return Type: void

ZenScript
Copy
// IInventory.closeInventory(player as MCPlayerEntity) as void

myIInventory.closeInventory(player);
ПараметрТипDescription
playerMCPlayerEntityThe player that opened the inventory.
count

Counts how many of the given Item is in this inventory.

NOTE: This does not work for IItemStacks, so all NBT will be ignored.

Returns: The amount of the Item in this inventory.
Return Type: int

ZenScript
Copy
// IInventory.count(item as MCItemDefinition) as int

myIInventory.count(<item:minecraft:dirt>);
ПараметрТипDescription
itemMCItemDefinitionThe Item to look for.
decrStackSize

Decreases the stack size of the stack in the given slot by the given count.

Returns: A new stack with how much was removed.
Return Type: IItemStack

ZenScript
Copy
// IInventory.decrStackSize(index as int, count as int) as IItemStack

myIInventory.decrStackSize(2, 2);
ПараметрТипDescriptionOptionalDefaultValue
indexintThe slot index to decrement.false
countintHow much should be removed.true1
getInventorySize

Gets how many slots this inventory has.

Example: A hopper will return 5

Returns: The amount of slots this inventory has.
Return Type: int

ZenScript
Copy
// IInventory.getInventorySize() as int

myIInventory.getInventorySize();
getInventoryStackLimit

Gets the max stack size that is allowed in this inventory.

This is nearly always 64, but some inventories like the Beacon and Compostor have a limit of 1.

Returns: The max stack size allowed in the inventory.
Return Type: int

ZenScript
Copy
// IInventory.getInventoryStackLimit() as int

myIInventory.getInventoryStackLimit();
getStackInSlot

Gets the IItemStack in the given slot.

Returns: The IItemStack in the slot.
Return Type: IItemStack

ZenScript
Copy
// IInventory.getStackInSlot(index as int) as IItemStack

myIInventory.getStackInSlot(2);
ПараметрТипDescription
indexintThe index to get the stack from.
hasAny

Checks if this inventory has any of the given Items.

NOTE: This does not work for IItemStacks, so all NBT will be ignored.

Returns: True if this inventory has any of the items. False otherwise.
Return Type: boolean

ZenScript
Copy
// IInventory.hasAny(list as stdlib.List<MCItemDefinition>) as boolean

myIInventory.hasAny([<item:minecraft:diamond>]);
ПараметрТипDescription
liststdlib.List<MCItemDefinition>The Items to look for.
isEmpty

Checks if this inventory is empty.

Returns: True if this inventory is empty. False otherwise.
Return Type: boolean

ZenScript
Copy
// IInventory.isEmpty() as boolean

myIInventory.isEmpty();
isItemValidForSlot

Checks if the given stack is valid for the given slot index.

Returns: True if the stack is valid. False otherwise.
Return Type: boolean

ZenScript
Copy
// IInventory.isItemValidForSlot(index as int, stack as IItemStack) as boolean

myIInventory.isItemValidForSlot(2, <item:minecraft:dirt>);
ПараметрТипDescription
indexintThe slot index to check.
stackIItemStackThe stack to check.
isUsableByPlayer

Checks if this IInventory can be used by the player.

Returns: True if the player can use this inventory. False otherwise.
Return Type: boolean

ZenScript
Copy
// IInventory.isUsableByPlayer(player as MCPlayerEntity) as boolean

myIInventory.isUsableByPlayer(player);
ПараметрТипDescription
playerMCPlayerEntityThe player to check if they can use this inventory.
markDirty

Used by tile entities to ensure that chunks are up to date when they are saved to disk.

Return Type: void

ZenScript
Copy
// IInventory.markDirty() as void

myIInventory.markDirty();
openInventory

Marks the inventory as opened, this is used by chests and barrels to determine if they should have an open texture / model, but other inventories may use it in a different way.

Return Type: void

ZenScript
Copy
// IInventory.openInventory(player as MCPlayerEntity) as void

myIInventory.openInventory(player);
ПараметрТипDescription
playerMCPlayerEntityThe player that opened the inventory.
removeStackFromSlot

Removes the IItemStack from the given slot and returns it.

Returns: The removed stack from the slot.
Return Type: IItemStack

ZenScript
Copy
// IInventory.removeStackFromSlot(index as int) as IItemStack

myIInventory.removeStackFromSlot(2);
ПараметрТипDescription
indexintThe slot index to remove.
setInventorySlotContents

Sets the contents of the given slot to the given IItemStack.

Return Type: void

ZenScript
Copy
// IInventory.setInventorySlotContents(index as int, stack as IItemStack) as void

myIInventory.setInventorySlotContents(2, <item:minecraft:diamond>);
ПараметрТипDescription
indexintThe slot index to set.
stackIItemStackThe IItemStack to put in the slot.

Свойства

НазваниеТипИмеет GetterИмеет SetterDescription
inventorySizeinttruefalseGets how many slots this inventory has.

Example:
A hopper will return 5
inventoryStackLimitinttruefalseGets the max stack size that is allowed in this inventory.

This is nearly always 64, but some inventories like the Beacon and Compostor have a limit of 1.
isEmptybooleantruefalseChecks if this inventory is empty.