EntityRegainHealthEvent
extends EntityEvent
in package
implements
Cancellable
Uses
CancellableTrait
Tags
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
- CAUSE_CUSTOM = 3
- CAUSE_EATING = 1
- CAUSE_MAGIC = 2
- CAUSE_REGEN = 0
- CAUSE_SATURATION = 4
- MAX_EVENT_CALL_DEPTH = 50
- $entity : Entity
- $eventName : string|null
- $amount : float
- $eventCallDepth : int
- $isCancelled : bool
- $reason : int
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getAmount() : float
- getEntity() : Entity
- getEventName() : string
- getRegainReason() : int
- Returns one of the CAUSE_* constants to indicate why this regeneration occurred.
- isCancelled() : bool
- setAmount() : void
- uncancel() : void
Constants
CAUSE_CUSTOM
public
mixed
CAUSE_CUSTOM
= 3
CAUSE_EATING
public
mixed
CAUSE_EATING
= 1
CAUSE_MAGIC
public
mixed
CAUSE_MAGIC
= 2
CAUSE_REGEN
public
mixed
CAUSE_REGEN
= 0
CAUSE_SATURATION
public
mixed
CAUSE_SATURATION
= 4
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$entity
protected
Entity
$entity
Tags
$eventName
protected
string|null
$eventName
= null
$amount
private
float
$amount
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
$reason
private
int
$reason
Methods
__construct()
public
__construct(Entity $entity, float $amount, int $regainReason) : mixed
Parameters
- $entity : Entity
- $amount : float
- $regainReason : int
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 —getAmount()
public
getAmount() : float
Return values
float —getEntity()
public
getEntity() : Entity
Tags
Return values
Entity —getEventName()
public
final getEventName() : string
Return values
string —getRegainReason()
Returns one of the CAUSE_* constants to indicate why this regeneration occurred.
public
getRegainReason() : int
Return values
int —isCancelled()
public
isCancelled() : bool
Return values
bool —setAmount()
public
setAmount(float $amount) : void
Parameters
- $amount : float
Return values
void —uncancel()
public
uncancel() : void