Inheritance diagram for pocketmine\inventory\BaseInventory:

Collaboration diagram for pocketmine\inventory\BaseInventory:

Public Member Functions
	addItem (Item ... $slots)

	all (Item $item)

	canAddItem (Item $item)

	clear (int $index)

	clearAll ()

	contains (Item $item)

	first (Item $item, bool $exact=false)

	firstEmpty ()

	getAddableItemQuantity (Item $item)

	getContents (bool $includeEmpty=false)

	getItem (int $index)

	getListeners ()

	getMaxStackSize ()

	getSize ()

	getSlotValidators ()

	getViewers ()

	isSlotEmpty (int $index)

	onClose (Player $who)

	onOpen (Player $who)

	remove (Item $item)

	removeAllViewers ()

	removeItem (Item ... $slots)

	setContents (array $items)

	setItem (int $index, Item $item)

	setMaxStackSize (int $size)

	slotExists (int $slot)

	swap (int $slot1, int $slot2)

Public Attributes
const	MAX_STACK = 64

Protected Member Functions
	getMatchingItemCount (int $slot, Item $test, bool $checkTags)

	internalSetContents (array $items)

	internalSetItem (int $index, Item $item)

	onContentChange (array $itemsBefore)

	onSlotChange (int $index, Item $before)

Protected Attributes
ObjectSet	$listeners

int	$maxStackSize = Inventory::MAX_STACK

ObjectSet	$validators

array	$viewers = []

Detailed Description

This class provides everything needed to implement an inventory, minus the underlying storage system.

@phpstan-import-type SlotValidators from SlotValidatedInventory

Definition at line 42 of file BaseInventory.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\inventory\BaseInventory::__construct ( )

Definition at line 54 of file BaseInventory.php.

Member Function Documentation

◆ addItem()

pocketmine\inventory\BaseInventory::addItem ( Item ... $slots )

Stores the given Items in the inventory. This will add to any non-full existing stacks first, and then put the remaining items in empty slots if there are any available.

Returns an array of items which could not fit in the inventory.

Returns: Item[]

Implements pocketmine\inventory\Inventory.

Definition at line 210 of file BaseInventory.php.

◆ all()

pocketmine\inventory\BaseInventory::all ( Item $item )

Returns all matching items in the inventory, irrespective of stack size. The returned array is indexed by slot number.

If the input item has specific NBT, only items with the same type and NBT will match. Otherwise, only the item type is checked.

Returns: Item[] @phpstan-return array<int, Item>

Implements pocketmine\inventory\Inventory.

Definition at line 140 of file BaseInventory.php.

◆ canAddItem()

pocketmine\inventory\BaseInventory::canAddItem ( Item $item )

Checks if a given Item can be added to the inventory

Implements pocketmine\inventory\Inventory.

Reimplemented in pocketmine\block\inventory\ShulkerBoxInventory.

Definition at line 184 of file BaseInventory.php.

◆ clear()

pocketmine\inventory\BaseInventory::clear ( int $index )

Will clear a specific slot

Implements pocketmine\inventory\Inventory.

Definition at line 326 of file BaseInventory.php.

Referenced by pocketmine\inventory\transaction\TransactionBuilderInventory\internalSetContents().

Here is the caller graph for this function:

◆ clearAll()

pocketmine\inventory\BaseInventory::clearAll ( )

Clears all the slots

Implements pocketmine\inventory\Inventory.

Definition at line 330 of file BaseInventory.php.

◆ contains()

pocketmine\inventory\BaseInventory::contains ( Item $item )

Returns whether the total amount of matching items is at least the stack size of the given item. Multiple stacks of the same item are added together.

If the input item has specific NBT, only items with the same type and NBT will match. Otherwise, only the item type is checked.

Implements pocketmine\inventory\Inventory.

Definition at line 124 of file BaseInventory.php.

◆ first()

pocketmine\inventory\BaseInventory::first	(	Item	$item,
		bool	$exact = false )

Returns the first slot number containing a matching item with a stack size greater than or equal to the input item.

If the input item has specific NBT, or if $exact is true, only items with the same type and NBT will match. Otherwise, only the item type is checked.

Implements pocketmine\inventory\Inventory.

Definition at line 152 of file BaseInventory.php.

◆ firstEmpty()

pocketmine\inventory\BaseInventory::firstEmpty ( )

Returns the first empty slot, or -1 if not found

Implements pocketmine\inventory\Inventory.

Definition at line 166 of file BaseInventory.php.

◆ getAddableItemQuantity()

pocketmine\inventory\BaseInventory::getAddableItemQuantity ( Item $item )

Returns how many items from the given itemstack can be added to this inventory.

Implements pocketmine\inventory\Inventory.

Definition at line 188 of file BaseInventory.php.

◆ getContents()

pocketmine\inventory\Inventory::getContents ( bool $includeEmpty = false )

inherited

Returns an array of all the itemstacks in the inventory, indexed by their slot number. Empty slots are not included unless includeEmpty is true.

Returns: Item[] @phpstan-return array<int, Item>

Implemented in pocketmine\block\inventory\DoubleChestInventory, pocketmine\inventory\DelegateInventory, pocketmine\inventory\SimpleInventory, and pocketmine\inventory\transaction\TransactionBuilderInventory.

◆ getItem()

pocketmine\inventory\Inventory::getItem ( int $index )

inherited

Returns the item in the specified slot.

Implemented in pocketmine\block\inventory\DoubleChestInventory, pocketmine\inventory\DelegateInventory, pocketmine\inventory\SimpleInventory, and pocketmine\inventory\transaction\TransactionBuilderInventory.

◆ getListeners()

pocketmine\inventory\BaseInventory::getListeners ( )

Returns: InventoryListener[]|ObjectSet @phpstan-return ObjectSet<InventoryListener>

Implements pocketmine\inventory\Inventory.

Definition at line 403 of file BaseInventory.php.

◆ getMatchingItemCount()

pocketmine\inventory\BaseInventory::getMatchingItemCount	(	int	$slot,
		Item	$test,
		bool	$checkTags )

protected

Helper for utility functions which search the inventory. TODO: make this abstract instead of providing a slow default implementation (BC break)

Reimplemented in pocketmine\block\inventory\DoubleChestInventory, and pocketmine\inventory\SimpleInventory.

Definition at line 119 of file BaseInventory.php.

◆ getMaxStackSize()

pocketmine\inventory\BaseInventory::getMaxStackSize ( )

Returns the maximum stack size for items in this inventory. Individual item types (such as armor or tools) may have a smaller maximum stack size.

Implements pocketmine\inventory\Inventory.

Reimplemented in pocketmine\block\inventory\CampfireInventory.

Definition at line 59 of file BaseInventory.php.

◆ getSize()

pocketmine\inventory\Inventory::getSize ( )

inherited

Returns the number of slots in the inventory.

Implemented in pocketmine\block\inventory\DoubleChestInventory, pocketmine\inventory\DelegateInventory, pocketmine\inventory\SimpleInventory, and pocketmine\inventory\transaction\TransactionBuilderInventory.

◆ getSlotValidators()

pocketmine\inventory\BaseInventory::getSlotValidators ( )

Returns a set of validators that will be used to determine whether an item can be placed in a particular slot. All validators need to return null for the transaction to be allowed. If one of the validators returns an exception, the transaction will be cancelled.

There is no guarantee that the validators will be called in any particular order.

@phpstan-return SlotValidators

Implements pocketmine\inventory\SlotValidatedInventory.

Definition at line 407 of file BaseInventory.php.

◆ getViewers()

pocketmine\inventory\BaseInventory::getViewers ( )

Returns: Player[]

Implements pocketmine\inventory\Inventory.

Definition at line 344 of file BaseInventory.php.

◆ internalSetContents()

pocketmine\inventory\BaseInventory::internalSetContents ( array $items )

abstractprotected

Parameters

Item[] $items @phpstan-param array<int, Item> $items

Reimplemented in pocketmine\block\inventory\DoubleChestInventory, pocketmine\inventory\DelegateInventory, pocketmine\inventory\SimpleInventory, and pocketmine\inventory\transaction\TransactionBuilderInventory.

◆ isSlotEmpty()

pocketmine\inventory\BaseInventory::isSlotEmpty ( int $index )

TODO: make this abstract and force implementations to implement it properly (BC break) This default implementation works, but is slow.

Implements pocketmine\inventory\Inventory.

Reimplemented in pocketmine\block\inventory\DoubleChestInventory, pocketmine\inventory\DelegateInventory, and pocketmine\inventory\SimpleInventory.

Definition at line 180 of file BaseInventory.php.

◆ onClose()

pocketmine\inventory\BaseInventory::onClose ( Player $who )

Implements pocketmine\inventory\Inventory.

Definition at line 364 of file BaseInventory.php.

◆ onContentChange()

pocketmine\inventory\BaseInventory::onContentChange ( array $itemsBefore )

protected

Parameters

Item[] $itemsBefore @phpstan-param array<int, Item> $itemsBefore

Reimplemented in pocketmine\inventory\DelegateInventory.

Definition at line 385 of file BaseInventory.php.

◆ onOpen()

pocketmine\inventory\BaseInventory::onOpen ( Player $who )

Called when a player opens this inventory.

Implements pocketmine\inventory\Inventory.

Definition at line 360 of file BaseInventory.php.

◆ onSlotChange()

pocketmine\inventory\BaseInventory::onSlotChange	(	int	$index,
		Item	$before )

protected

Definition at line 368 of file BaseInventory.php.

◆ remove()

pocketmine\inventory\BaseInventory::remove ( Item $item )

Clears all slots containing items equivalent to the given item.

If the input item has specific NBT, only items with the same type and NBT will match. Otherwise, only the item type is checked.

Implements pocketmine\inventory\Inventory.

Definition at line 278 of file BaseInventory.php.

◆ removeAllViewers()

pocketmine\inventory\BaseInventory::removeAllViewers ( )

Removes the inventory window from all players currently viewing it.

Definition at line 351 of file BaseInventory.php.

◆ removeItem()

pocketmine\inventory\BaseInventory::removeItem ( Item ... $slots )

Removes items from the inventory in the amounts specified by the given itemstacks. Returns an array of items that couldn't be removed.

If the input item has specific NBT, only items with the same type and NBT will match. Otherwise, only the item type is checked.

Returns: Item[]

Implements pocketmine\inventory\Inventory.

Definition at line 288 of file BaseInventory.php.

◆ setContents()

pocketmine\inventory\BaseInventory::setContents ( array $items )

Parameters

Item[] $items @phpstan-param array<int, Item> $items

Implements pocketmine\inventory\Inventory.

Definition at line 92 of file BaseInventory.php.

◆ setItem()

pocketmine\inventory\BaseInventory::setItem	(	int	$index,
		Item	$item )

Puts an Item in a slot.

Implements pocketmine\inventory\Inventory.

Reimplemented in pocketmine\crafting\CraftingGrid.

Definition at line 69 of file BaseInventory.php.

Referenced by pocketmine\inventory\transaction\TransactionBuilderInventory\internalSetContents().

Here is the caller graph for this function:

◆ setMaxStackSize()

pocketmine\inventory\BaseInventory::setMaxStackSize ( int $size )

Sets the maximum stack size for items in this inventory.

Implements pocketmine\inventory\Inventory.

Definition at line 63 of file BaseInventory.php.

◆ slotExists()

pocketmine\inventory\BaseInventory::slotExists ( int $slot )

Returns whether the specified slot exists in the inventory.

Implements pocketmine\inventory\Inventory.

Definition at line 399 of file BaseInventory.php.

◆ swap()

pocketmine\inventory\BaseInventory::swap	(	int	$slot1,
		int	$slot2 )

Swaps the specified slots.

Implements pocketmine\inventory\Inventory.

Definition at line 334 of file BaseInventory.php.

Member Data Documentation

◆ $listeners

ObjectSet pocketmine\inventory\BaseInventory::$listeners

protected

Definition at line 50 of file BaseInventory.php.

◆ $maxStackSize

int pocketmine\inventory\BaseInventory::$maxStackSize = Inventory::MAX_STACK

protected

Definition at line 43 of file BaseInventory.php.

◆ $validators

ObjectSet pocketmine\inventory\BaseInventory::$validators

protected

@phpstan-var SlotValidators

Definition at line 52 of file BaseInventory.php.

◆ $viewers

array pocketmine\inventory\BaseInventory::$viewers = []

protected

Definition at line 45 of file BaseInventory.php.

◆ MAX_STACK

const pocketmine\inventory\Inventory::MAX_STACK = 64

inherited

Definition at line 34 of file Inventory.php.

The documentation for this class was generated from the following file:

BaseInventory.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addItem()

◆ all()

◆ canAddItem()

◆ clear()

◆ clearAll()

◆ contains()

◆ first()

◆ firstEmpty()

◆ getAddableItemQuantity()

◆ getContents()

◆ getItem()

◆ getListeners()

◆ getMatchingItemCount()

◆ getMaxStackSize()

◆ getSize()

◆ getSlotValidators()

◆ getViewers()

◆ internalSetContents()

◆ isSlotEmpty()

◆ onClose()

◆ onContentChange()

◆ onOpen()

◆ onSlotChange()

◆ remove()

◆ removeAllViewers()

◆ removeItem()

◆ setContents()

◆ setItem()

◆ setMaxStackSize()

◆ slotExists()

◆ swap()

Member Data Documentation

◆ $listeners

◆ $maxStackSize

◆ $validators

◆ $viewers

◆ MAX_STACK