Documentation

WorldUnloadEvent extends WorldEvent
in package
implements Cancellable Uses CancellableTrait

Called when a World is unloaded

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
$eventName  : string|null
$eventCallDepth  : int
$isCancelled  : bool
$world  : World
__construct()  : mixed
call()  : void
Calls event handlers registered for this event.
cancel()  : void
getEventName()  : string
getWorld()  : World
isCancelled()  : bool
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(World $world) : mixed
Parameters
$world : World
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

Search results