Documentation

PlayerTransferEvent extends PlayerEvent
in package
implements Cancellable Uses CancellableTrait

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
$address  : string
$eventName  : string|null
$message  : string
$player  : Player
$port  : int
$eventCallDepth  : int
$isCancelled  : bool
__construct()  : mixed
call()  : void
Calls event handlers registered for this event.
cancel()  : void
getAddress()  : string
getEventName()  : string
getMessage()  : string
getPlayer()  : Player
getPort()  : int
isCancelled()  : bool
setAddress()  : void
setMessage()  : void
setPort()  : 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(Player $player, string $address, int $port, string $message) : mixed
Parameters
$player : Player
$address : string
$port : int
$message : string
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

setAddress()

public setAddress(string $address) : void
Parameters
$address : string
Return values
void

setMessage()

public setMessage(string $message) : void
Parameters
$message : string
Return values
void

setPort()

public setPort(int $port) : void
Parameters
$port : int
Return values
void

Search results