pocketmine\event\player\PlayerBucketEvent Class Reference

Inheritance diagram for pocketmine\event\player\PlayerBucketEvent:

Collaboration diagram for pocketmine\event\player\PlayerBucketEvent:

Public Member Functions
	__construct (Player $who, private Block $blockClicked, private int $blockFace, private Item $bucket, private Item $itemInHand)
	call ()
	getBlockClicked ()
	getBlockFace ()
	getBucket ()
	getEventName ()
	getItem ()
	getPlayer ()
	isCancelled ()
	setItem (Item $item)

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null
Player	$player

Detailed Description

@allowHandle

Definition at line 35 of file PlayerBucketEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\player\PlayerBucketEvent::__construct	(	Player	$who,
		private Block	$blockClicked,
		private int	$blockFace,
		private Item	$bucket,
		private Item	$itemInHand )

Definition at line 38 of file PlayerBucketEvent.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.

getBlockClicked()

pocketmine\event\player\PlayerBucketEvent::getBlockClicked

(

)

Definition at line 66 of file PlayerBucketEvent.php.

getBlockFace()

pocketmine\event\player\PlayerBucketEvent::getBlockFace

(

)

Definition at line 70 of file PlayerBucketEvent.php.

getBucket()

pocketmine\event\player\PlayerBucketEvent::getBucket

(

)

Returns the bucket used in this event

Definition at line 51 of file PlayerBucketEvent.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getItem()

pocketmine\event\player\PlayerBucketEvent::getItem

(

)

Returns the item in hand after the event

Definition at line 58 of file PlayerBucketEvent.php.

getPlayer()

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

inherited

Definition at line 35 of file PlayerEvent.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.

setItem()

pocketmine\event\player\PlayerBucketEvent::setItem

(

Item

$item

)

Definition at line 62 of file PlayerBucketEvent.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:

• PlayerBucketEvent.php