Inheritance diagram for pocketmine\inventory\transaction\TransactionBuilderInventory:

Collaboration diagram for pocketmine\inventory\transaction\TransactionBuilderInventory:

Public Member Functions
	__construct (private Inventory $actualInventory)

	addItem (Item ... $slots)

	all (Item $item)

	canAddItem (Item $item)

	clear (int $index)

	clearAll ()

	contains (Item $item)

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

	firstEmpty ()

	generateActions ()

	getActualInventory ()

	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 facilitates generating SlotChangeActions to build an inventory transaction. It wraps around the inventory you want to modify under transaction, and generates a diff of changes. This allows you to use the normal Inventory API methods like addItem() and so on to build a transaction, without modifying the original inventory.

Definition at line 38 of file TransactionBuilderInventory.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\inventory\transaction\TransactionBuilderInventory::__construct ( private Inventory $actualInventory )

Definition at line 46 of file TransactionBuilderInventory.php.

Member Function Documentation

◆ addItem()

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

inherited

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 213 of file BaseInventory.php.

◆ all()

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

inherited

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 143 of file BaseInventory.php.

◆ canAddItem()

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

inherited

Checks if a given Item can be added to the inventory

Implements pocketmine\inventory\Inventory.

Reimplemented in pocketmine\block\inventory\ShulkerBoxInventory.

Definition at line 187 of file BaseInventory.php.

◆ clear()

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

inherited

Will clear a specific slot

Implements pocketmine\inventory\Inventory.

Definition at line 327 of file BaseInventory.php.

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

Here is the caller graph for this function:

◆ clearAll()

pocketmine\inventory\BaseInventory::clearAll ( )

inherited

Clears all the slots

Implements pocketmine\inventory\Inventory.

Definition at line 331 of file BaseInventory.php.

◆ contains()

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

inherited

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 127 of file BaseInventory.php.

◆ first()

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

inherited

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 155 of file BaseInventory.php.

◆ firstEmpty()

pocketmine\inventory\BaseInventory::firstEmpty ( )

inherited

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

Implements pocketmine\inventory\Inventory.

Definition at line 169 of file BaseInventory.php.

◆ generateActions()

pocketmine\inventory\transaction\TransactionBuilderInventory::generateActions ( )

Returns: SlotChangeAction[]

Definition at line 98 of file TransactionBuilderInventory.php.

◆ getActualInventory()

pocketmine\inventory\transaction\TransactionBuilderInventory::getActualInventory ( )

Definition at line 53 of file TransactionBuilderInventory.php.

◆ getAddableItemQuantity()

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

inherited

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

Implements pocketmine\inventory\Inventory.

Definition at line 191 of file BaseInventory.php.

◆ getContents()

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

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>

Implements pocketmine\inventory\Inventory.

Definition at line 81 of file TransactionBuilderInventory.php.

◆ getItem()

pocketmine\inventory\transaction\TransactionBuilderInventory::getItem ( int $index )

Returns the item in the specified slot.

Implements pocketmine\inventory\Inventory.

Definition at line 77 of file TransactionBuilderInventory.php.

◆ getListeners()

pocketmine\inventory\BaseInventory::getListeners ( )

inherited

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

Implements pocketmine\inventory\Inventory.

Definition at line 404 of file BaseInventory.php.

◆ getMatchingItemCount()

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

protectedinherited

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 122 of file BaseInventory.php.

◆ getMaxStackSize()

pocketmine\inventory\BaseInventory::getMaxStackSize ( )

inherited

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 62 of file BaseInventory.php.

◆ getSize()

pocketmine\inventory\transaction\TransactionBuilderInventory::getSize ( )

Returns the number of slots in the inventory.

Implements pocketmine\inventory\Inventory.

Definition at line 73 of file TransactionBuilderInventory.php.

◆ getSlotValidators()

pocketmine\inventory\BaseInventory::getSlotValidators ( )

inherited

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 408 of file BaseInventory.php.

◆ getViewers()

pocketmine\inventory\BaseInventory::getViewers ( )

inherited

Returns: Player[]

Implements pocketmine\inventory\Inventory.

Definition at line 345 of file BaseInventory.php.

◆ internalSetContents()

pocketmine\inventory\transaction\TransactionBuilderInventory::internalSetContents ( array $items )

protected

Parameters

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

Reimplemented from pocketmine\inventory\BaseInventory.

Definition at line 57 of file TransactionBuilderInventory.php.

References pocketmine\inventory\BaseInventory\clear(), and pocketmine\inventory\BaseInventory\setItem().

Here is the call graph for this function:

◆ internalSetItem()

pocketmine\inventory\transaction\TransactionBuilderInventory::internalSetItem	(	int	$index,
		Item	$item )

protected

Reimplemented from pocketmine\inventory\BaseInventory.

Definition at line 67 of file TransactionBuilderInventory.php.

◆ isSlotEmpty()

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

inherited

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 183 of file BaseInventory.php.

◆ onClose()

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

inherited

Implements pocketmine\inventory\Inventory.

Definition at line 365 of file BaseInventory.php.

◆ onContentChange()

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

protectedinherited

Parameters

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

Reimplemented in pocketmine\inventory\DelegateInventory.

Definition at line 386 of file BaseInventory.php.

◆ onOpen()

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

inherited

Called when a player opens this inventory.

Implements pocketmine\inventory\Inventory.

Definition at line 361 of file BaseInventory.php.

◆ onSlotChange()

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

protectedinherited

Definition at line 369 of file BaseInventory.php.

◆ remove()

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

inherited

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 281 of file BaseInventory.php.

◆ removeAllViewers()

pocketmine\inventory\BaseInventory::removeAllViewers ( )

inherited

Removes the inventory window from all players currently viewing it.

Definition at line 352 of file BaseInventory.php.

◆ removeItem()

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

inherited

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 291 of file BaseInventory.php.

◆ setContents()

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

inherited

Parameters

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

Implements pocketmine\inventory\Inventory.

Definition at line 95 of file BaseInventory.php.

◆ setItem()

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

inherited

Puts an Item in a slot.

Implements pocketmine\inventory\Inventory.

Reimplemented in pocketmine\crafting\CraftingGrid.

Definition at line 72 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 )

inherited

Sets the maximum stack size for items in this inventory.

Implements pocketmine\inventory\Inventory.

Definition at line 66 of file BaseInventory.php.

◆ slotExists()

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

inherited

Returns whether the specified slot exists in the inventory.

Implements pocketmine\inventory\Inventory.

Definition at line 400 of file BaseInventory.php.

◆ swap()

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

inherited

Swaps the specified slots.

Implements pocketmine\inventory\Inventory.

Definition at line 335 of file BaseInventory.php.

Member Data Documentation

◆ $listeners

ObjectSet pocketmine\inventory\BaseInventory::$listeners

protectedinherited

Definition at line 53 of file BaseInventory.php.

◆ $maxStackSize

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

protectedinherited

Definition at line 43 of file BaseInventory.php.

◆ $validators

ObjectSet pocketmine\inventory\BaseInventory::$validators

protectedinherited

@phpstan-var SlotValidators

Definition at line 55 of file BaseInventory.php.

◆ $viewers

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

protectedinherited

Definition at line 48 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:

TransactionBuilderInventory.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()

◆ generateActions()

◆ getActualInventory()

◆ getAddableItemQuantity()

◆ getContents()

◆ getItem()

◆ getListeners()

◆ getMatchingItemCount()

◆ getMaxStackSize()

◆ getSize()

◆ getSlotValidators()

◆ getViewers()

◆ internalSetContents()

◆ internalSetItem()

◆ isSlotEmpty()

◆ onClose()

◆ onContentChange()

◆ onOpen()

◆ onSlotChange()

◆ remove()

◆ removeAllViewers()

◆ removeItem()

◆ setContents()

◆ setItem()

◆ setMaxStackSize()

◆ slotExists()

◆ swap()

Member Data Documentation

◆ $listeners

◆ $maxStackSize

◆ $validators

◆ $viewers

◆ MAX_STACK