pocketmine\event\block\BlockFormEvent Class Reference

Inheritance diagram for pocketmine\event\block\BlockFormEvent:

Collaboration diagram for pocketmine\event\block\BlockFormEvent:

Public Member Functions
	__construct (Block $block, Block $newState, private Block $causingBlock)
	call ()
	getBlock ()
	getCausingBlock ()
	getEventName ()
	getNewState ()
	isCancelled ()

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Detailed Description

Called when a new block forms, usually as the result of some action. This could be things like obsidian forming due to collision of lava and water.

Definition at line 32 of file BlockFormEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\block\BlockFormEvent::__construct	(	Block	$block,
		Block	$newState,
		private Block	$causingBlock
	)

Definition at line 34 of file BlockFormEvent.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.

getCausingBlock()

pocketmine\event\block\BlockFormEvent::getCausingBlock

(

)

Returns the block which caused the target block to form into a new state.

Definition at line 45 of file BlockFormEvent.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getNewState()

pocketmine\event\block\BaseBlockChangeEvent::getNewState ( )

inherited

Definition at line 43 of file BaseBlockChangeEvent.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:

• BlockFormEvent.php