pocketmine\event\block\StructureGrowEvent Class Reference

Inheritance diagram for pocketmine\event\block\StructureGrowEvent:

Collaboration diagram for pocketmine\event\block\StructureGrowEvent:

Public Member Functions
	__construct (Block $block, private BlockTransaction $transaction, private ?Player $player)
	call ()
	getBlock ()
	getEventName ()
	getPlayer ()
	getTransaction ()
	isCancelled ()

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Detailed Description

Called when structures such as Saplings or Bamboo grow. These types of plants tend to change multiple blocks at once upon growing.

Definition at line 36 of file StructureGrowEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\block\StructureGrowEvent::__construct	(	Block	$block,
		private BlockTransaction	$transaction,
		private ?Player	$player )

Definition at line 39 of file StructureGrowEvent.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.

getBlock()

pocketmine\event\block\BlockEvent::getBlock ( )

inherited

Definition at line 37 of file BlockEvent.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getPlayer()

pocketmine\event\block\StructureGrowEvent::getPlayer

(

)

It returns the player which grows the structure. It returns null when the structure grows by itself.

Definition at line 55 of file StructureGrowEvent.php.

getTransaction()

pocketmine\event\block\StructureGrowEvent::getTransaction

(

)

Definition at line 47 of file StructureGrowEvent.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:

• StructureGrowEvent.php