EntityEffectAddEvent
extends EntityEffectEvent
in package
Called when an effect is added to an Entity.
Table of Contents
- MAX_EVENT_CALL_DEPTH = 50
- $entity : Entity
- $eventName : string|null
- $effect : EffectInstance
- $eventCallDepth : int
- $isCancelled : bool
- $oldEffect : EffectInstance|null
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getEffect() : EffectInstance
- getEntity() : Entity
- getEventName() : string
- getOldEffect() : EffectInstance|null
- hasOldEffect() : bool
- isCancelled() : bool
- uncancel() : void
- willModify() : bool
- Returns whether the effect addition will replace an existing effect already applied to the entity.
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$entity
protected
Entity
$entity
Tags
$eventName
protected
string|null
$eventName
= null
$effect
private
EffectInstance
$effect
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
$oldEffect
private
EffectInstance|null
$oldEffect
Methods
__construct()
public
__construct(Entity $entity, EffectInstance $effect[, EffectInstance|null $oldEffect = null ]) : mixed
Parameters
- $entity : Entity
- $effect : EffectInstance
- $oldEffect : EffectInstance|null = 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 —getEffect()
public
getEffect() : EffectInstance
Return values
EffectInstance —getEntity()
public
getEntity() : Entity
Tags
Return values
Entity —getEventName()
public
final getEventName() : string
Return values
string —getOldEffect()
public
getOldEffect() : EffectInstance|null
Return values
EffectInstance|null —hasOldEffect()
public
hasOldEffect() : bool
Return values
bool —isCancelled()
public
isCancelled() : bool
Return values
bool —uncancel()
public
uncancel() : void
Return values
void —willModify()
Returns whether the effect addition will replace an existing effect already applied to the entity.
public
willModify() : bool