Documentation

PlayerExperienceChangeEvent extends EntityEvent
in package
implements Cancellable Uses CancellableTrait

Called when a player gains or loses XP levels and/or progress.

Tags
phpstan-extends

EntityEvent<Human>

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
$entity  : Human
$eventName  : string|null
$eventCallDepth  : int
$isCancelled  : bool
$newLevel  : int|null
$newProgress  : float|null
$oldLevel  : int
$oldProgress  : float
__construct()  : mixed
call()  : void
Calls event handlers registered for this event.
cancel()  : void
getEntity()  : Entity
getEventName()  : string
getNewLevel()  : int|null
getNewProgress()  : float|null
getOldLevel()  : int
getOldProgress()  : float
isCancelled()  : bool
setNewLevel()  : void
setNewProgress()  : 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(Human $player, int $oldLevel, float $oldProgress, int|null $newLevel, float|null $newProgress) : mixed
Parameters
$player : Human
$oldLevel : int
$oldProgress : float
$newLevel : int|null
$newProgress : float|null
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

getEventName()

public final getEventName() : string
Return values
string

setNewProgress()

public setNewProgress(float|null $newProgress) : void
Parameters
$newProgress : float|null
Return values
void

Search results