Documentation

EntityCombustEvent extends EntityEvent
in package
implements Cancellable Uses CancellableTrait

Tags
phpstan-extends

EntityEvent<Entity>

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
$duration  : int
$entity  : Entity
$eventName  : string|null
$eventCallDepth  : int
$isCancelled  : bool
__construct()  : mixed
call()  : void
Calls event handlers registered for this event.
cancel()  : void
getDuration()  : int
Returns the duration in seconds the entity will burn for.
getEntity()  : Entity
getEventName()  : string
isCancelled()  : bool
setDuration()  : void
uncancel()  : void

Constants

MAX_EVENT_CALL_DEPTH

private mixed MAX_EVENT_CALL_DEPTH = 50

Properties

$eventName

protected string|null $eventName = null

$eventCallDepth

private static int $eventCallDepth = 1

Methods

__construct()

public __construct(Entity $combustee, int $duration) : mixed
Parameters
$combustee : Entity
$duration : int
Return values
mixed

call()

Calls event handlers registered for this event.

public call() : void
Tags
throws
RuntimeException

if event call recursion reaches the max depth limit

Return values
void

getDuration()

Returns the duration in seconds the entity will burn for.

public getDuration() : int
Return values
int

getEventName()

public final getEventName() : string
Return values
string

setDuration()

public setDuration(int $duration) : void
Parameters
$duration : int
Return values
void

Search results