pocketmine\event\inventory\InventoryTransactionEvent Class Reference

Inheritance diagram for pocketmine\event\inventory\InventoryTransactionEvent:

Collaboration diagram for pocketmine\event\inventory\InventoryTransactionEvent:

Public Member Functions
	__construct (private InventoryTransaction $transaction)
	call ()
	getEventName ()
	getTransaction ()
	isCancelled ()

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Detailed Description

Called when a player performs actions involving items in inventories.

This may involve multiple inventories, and may include actions such as:

• moving items from one slot to another
• splitting itemstacks
• dragging itemstacks across inventory slots (slot painting)
• dropping an item on the ground
• taking an item from the creative inventory menu
• destroying (trashing) an item

See also

https://doc.pmmp.io/en/rtfd/developer-reference/inventory-transactions.html for more information on inventory transactions

Definition at line 44 of file InventoryTransactionEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\inventory\InventoryTransactionEvent::__construct

(

private InventoryTransaction

$transaction

)

Definition at line 47 of file InventoryTransactionEvent.php.

Member Function Documentation

call()

pocketmine\event\Event::call ( )

inherited

Calls event handlers registered for this event.

Exceptions

RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getTransaction()

pocketmine\event\inventory\InventoryTransactionEvent::getTransaction

(

)

Definition at line 49 of file InventoryTransactionEvent.php.

hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

staticinherited

Returns whether the current class context has any registered global handlers. This can be used in hot code paths to avoid unnecessary event object creation.

Usage: SomeEventClass::hasHandlers()

Definition at line 77 of file Event.php.

isCancelled()

pocketmine\event\Cancellable::isCancelled ( )

inherited

Returns whether this instance of the event is currently cancelled.

If it is cancelled, only downstream handlers that declare @handleCancelled will be called with this event.

Member Data Documentation

$eventName

string pocketmine\event\Event::$eventName = null

protectedinherited

Definition at line 38 of file Event.php.

---

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

• InventoryTransactionEvent.php