pocketmine\event\block\BlockSpreadEvent Class Reference

Inheritance diagram for pocketmine\event\block\BlockSpreadEvent:

Collaboration diagram for pocketmine\event\block\BlockSpreadEvent:

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

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Detailed Description

Called when a block spreads to another block, such as grass spreading to nearby dirt blocks.

Definition at line 31 of file BlockSpreadEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\block\BlockSpreadEvent::__construct	(	Block	$block,
		private Block	$source,
		Block	$newState )

Parameters

Block	$block	Block being replaced (TODO: rename this)
Block	$source	Origin of the spread
Block	$newState	Replacement block

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

getNewState()

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

inherited

Definition at line 43 of file BaseBlockChangeEvent.php.

getSource()

pocketmine\event\block\BlockSpreadEvent::getSource

(

)

Definition at line 46 of file BlockSpreadEvent.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:

• BlockSpreadEvent.php