Documentation

PlayerDuplicateLoginEvent extends Event
in package
implements Cancellable Uses CancellableTrait

Called when a player connects with a username or UUID that is already used by another player on the server.

If cancelled, the newly connecting session will be disconnected; otherwise, the existing player will be disconnected.

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
$connectingSession  : NetworkSession
$disconnectMessage  : string
$eventCallDepth  : int
$existingSession  : NetworkSession
$isCancelled  : bool
__construct()  : mixed
call()  : void
Calls event handlers registered for this event.
cancel()  : void
getConnectingSession()  : NetworkSession
getDisconnectMessage()  : string
Returns the message shown to the session which gets disconnected.
getEventName()  : string
getExistingSession()  : NetworkSession
isCancelled()  : bool
setDisconnectMessage()  : 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

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

getDisconnectMessage()

Returns the message shown to the session which gets disconnected.

public getDisconnectMessage() : string
Return values
string

getEventName()

public final getEventName() : string
Return values
string

setDisconnectMessage()

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

Search results