pocketmine\event\player\PlayerItemConsumeEvent Class Reference

Inheritance diagram for pocketmine\event\player\PlayerItemConsumeEvent:

Collaboration diagram for pocketmine\event\player\PlayerItemConsumeEvent:

Public Member Functions
	__construct (Player $player, private Item $item, private array $residue=[])
	call ()
	getEventName ()
	getItem ()
	getPlayer ()
	getResidue ()
	isCancelled ()
	setResidue (array $items)

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null
Player	$player

Detailed Description

Called when a player eats something

Definition at line 35 of file PlayerItemConsumeEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\player\PlayerItemConsumeEvent::__construct	(	Player	$player,
		private Item	$item,
		private array	$residue = [] )

Parameters

Item[]

$residue

Definition at line 41 of file PlayerItemConsumeEvent.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.

getItem()

pocketmine\event\player\PlayerItemConsumeEvent::getItem

(

)

Definition at line 49 of file PlayerItemConsumeEvent.php.

getPlayer()

pocketmine\event\player\PlayerEvent::getPlayer ( )

inherited

Definition at line 35 of file PlayerEvent.php.

getResidue()

pocketmine\event\player\PlayerItemConsumeEvent::getResidue

(

)

Returns the leftover items returned to the player after consuming the item. For example, glass bottles for potions, bowls for beetroot soup, etc.

Returns

Item[]

Definition at line 59 of file PlayerItemConsumeEvent.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.

setResidue()

pocketmine\event\player\PlayerItemConsumeEvent::setResidue

(

array

$items

)

Sets the items returned to the player after consuming the item.

Parameters

Item[]

$items

Definition at line 68 of file PlayerItemConsumeEvent.php.

Member Data Documentation

$eventName

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

protectedinherited

Definition at line 38 of file Event.php.

$player

Player pocketmine\event\player\PlayerEvent::$player

protectedinherited

Definition at line 33 of file PlayerEvent.php.

---

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

• PlayerItemConsumeEvent.php