StructureGrowEvent
extends BlockEvent
in package
implements
Cancellable
Uses
CancellableTrait
Called when structures such as Saplings or Bamboo grow.
These types of plants tend to change multiple blocks at once upon growing.
Interfaces, Classes, Traits and Enums
- Cancellable
- This interface is implemented by an Event subclass if and only if it can be cancelled.
Table of Contents
- MAX_EVENT_CALL_DEPTH = 50
- $block : Block
- $eventName : string|null
- $eventCallDepth : int
- $isCancelled : bool
- $player : Player|null
- $transaction : BlockTransaction
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getBlock() : Block
- getEventName() : string
- getPlayer() : Player|null
- It returns the player which grows the structure.
- getTransaction() : BlockTransaction
- isCancelled() : bool
- uncancel() : void
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$block
protected
Block
$block
$eventName
protected
string|null
$eventName
= null
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
$player
private
Player|null
$player
$transaction
private
BlockTransaction
$transaction
Methods
__construct()
public
__construct(Block $block, BlockTransaction $transaction, Player|null $player) : mixed
Parameters
- $block : Block
- $transaction : BlockTransaction
- $player : Player|null
Return values
mixed —call()
Calls event handlers registered for this event.
public
call() : void
Tags
Return values
void —cancel()
public
cancel() : void
Return values
void —getBlock()
public
getBlock() : Block
Return values
Block —getEventName()
public
final getEventName() : string
Return values
string —getPlayer()
It returns the player which grows the structure.
public
getPlayer() : Player|null
It returns null when the structure grows by itself.
Return values
Player|null —getTransaction()
public
getTransaction() : BlockTransaction
Return values
BlockTransaction —isCancelled()
public
isCancelled() : bool
Return values
bool —uncancel()
public
uncancel() : void