Documentation

DataPacketSendEvent extends ServerEvent
in package
implements Cancellable Uses CancellableTrait

Called when packets are sent to network sessions.

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
$packets  : array<string|int, ClientboundPacket>
$targets  : array<string|int, NetworkSession>
__construct()  : mixed
call()  : void
Calls event handlers registered for this event.
cancel()  : void
getEventName()  : string
getPackets()  : array<string|int, ClientboundPacket>
getTargets()  : array<string|int, NetworkSession>
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

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