Documentation

NetworkSession
in package

Table of Contents

$authenticated  : bool
$broadcaster  : PacketBroadcaster
$cachedOfflinePlayerData  : CompoundTag|null
$cipher  : EncryptionContext|null
$compressedQueue  : SplQueue
$compressor  : Compressor
$connected  : bool
$connectTime  : int
$disconnectGuard  : bool
$disposeHooks  : ObjectSet
$forceAsyncCompression  : bool
$handler  : PacketHandler|null
$info  : PlayerInfo|null
$invManager  : InventoryManager|null
$ip  : string
$loggedIn  : bool
$logger  : PrefixedLogger
$manager  : NetworkSessionManager
$packetPool  : PacketPool
$packetSerializerContext  : PacketSerializerContext
$ping  : int|null
$player  : Player|null
$port  : int
$sendBuffer  : array<string|int, mixed>
$sender  : PacketSender
$server  : Server
__construct()  : mixed
disconnect()  : void
Disconnects the session, destroying the associated player (if it exists).
getBroadcaster()  : PacketBroadcaster
getCompressor()  : Compressor
getDisplayName()  : string
getHandler()  : PacketHandler|null
getInvManager()  : InventoryManager|null
getIp()  : string
getLogger()  : Logger
getPacketSerializerContext()  : PacketSerializerContext
getPing()  : int|null
Returns the last recorded ping measurement for this session, in milliseconds, or null if a ping measurement has not yet been recorded.
getPlayer()  : Player|null
getPlayerInfo()  : PlayerInfo|null
getPort()  : int
handleDataPacket()  : void
handleEncoded()  : void
isConnected()  : bool
notifyTerrainReady()  : void
onActionBar()  : void
onClearTitle()  : void
onClientDisconnect()  : void
Called by the network interface to close the session when the client disconnects without server input, for example in a timeout condition or voluntary client disconnect.
onEmote()  : void
onEnterWorld()  : void
onEntityEffectAdded()  : void
onEntityEffectRemoved()  : void
onEntityRemoved()  : void
onFormSent()  : bool
onJukeboxPopup()  : void
onMobArmorChange()  : void
onMobMainHandItemChange()  : void
TODO: expand this to more than just humans
onMobOffHandItemChange()  : void
onPlayerAdded()  : void
onPlayerDestroyed()  : void
Called by the Player when it is closed (for example due to getting kicked).
onPlayerPickUpItem()  : void
onPlayerRemoved()  : void
onPopup()  : void
onRawChatMessage()  : void
onResetTitleOptions()  : void
onServerDeath()  : void
onServerRespawn()  : void
onSubTitle()  : void
onTip()  : void
onTitle()  : void
onTitleDuration()  : void
onTranslatedChatMessage()  : void
queueCompressed()  : void
sendDataPacket()  : bool
setHandler()  : void
startUsingChunk()  : void
Instructs the networksession to start using the chunk at the given coordinates. This may occur asynchronously.
stopUsingChunk()  : void
syncActorData()  : void
syncAdventureSettings()  : void
TODO: make this less specialized
syncAttributes()  : void
syncAvailableCommands()  : void
syncGameMode()  : void
syncMovement()  : void
syncPlayerList()  : void
syncPlayerSpawnPoint()  : void
syncViewAreaCenterPoint()  : void
syncViewAreaRadius()  : void
syncWorldDifficulty()  : void
syncWorldSpawnPoint()  : void
syncWorldTime()  : void
tick()  : void
transfer()  : void
Instructs the remote client to connect to a different server.
createPlayer()  : void
beginSpawnSequence()  : void
doServerDisconnect()  : void
Internal helper function used to handle server disconnections.
flushSendBuffer()  : void
getLogPrefix()  : string
onClientSpawnResponse()  : void
onPlayerCreated()  : void
onServerLoginSuccess()  : void
queueCompressedNoBufferFlush()  : void
sendEncoded()  : void
setAuthenticationStatus()  : void
tryDisconnect()  : void

Properties

$compressedQueue

private SplQueue $compressedQueue
Tags
phpstan-var

\SplQueue<CompressBatchPromise>

$forceAsyncCompression

private bool $forceAsyncCompression = true

Methods

disconnect()

Disconnects the session, destroying the associated player (if it exists).

public disconnect(string $reason[, bool $notify = true ]) : void
Parameters
$reason : string
$notify : bool = true
Return values
void —

getDisplayName()

public getDisplayName() : string
Return values
string —

getPing()

Returns the last recorded ping measurement for this session, in milliseconds, or null if a ping measurement has not yet been recorded.

public getPing() : int|null
Return values
int|null —

isConnected()

public isConnected() : bool
Return values
bool —

notifyTerrainReady()

public notifyTerrainReady() : void
Return values
void —

onActionBar()

public onActionBar(string $actionBar) : void
Parameters
$actionBar : string
Return values
void —

onClearTitle()

public onClearTitle() : void
Return values
void —

onClientDisconnect()

Called by the network interface to close the session when the client disconnects without server input, for example in a timeout condition or voluntary client disconnect.

public onClientDisconnect(string $reason) : void
Parameters
$reason : string
Return values
void —

onEmote()

public onEmote(Player $from, string $emoteId) : void
Parameters
$from : Player
$emoteId : string
Return values
void —

onEnterWorld()

public onEnterWorld() : void
Return values
void —

onFormSent()

public onFormSent(int $id, Form $form) : bool
Parameters
$id : int
$form : Form
Return values
bool —

onJukeboxPopup()

public onJukeboxPopup(string $key, array<string|int, string> $parameters) : void
Parameters
$key : string
$parameters : array<string|int, string>
Return values
void —

onMobMainHandItemChange()

TODO: expand this to more than just humans

public onMobMainHandItemChange(Human $mob) : void
Parameters
$mob : Human
Return values
void —

onMobOffHandItemChange()

public onMobOffHandItemChange(Human $mob) : void
Parameters
$mob : Human
Return values
void —

onPlayerDestroyed()

Called by the Player when it is closed (for example due to getting kicked).

public onPlayerDestroyed(string $reason) : void
Parameters
$reason : string
Return values
void —

onPopup()

public onPopup(string $message) : void
Parameters
$message : string
Return values
void —

onRawChatMessage()

public onRawChatMessage(string $message) : void
Parameters
$message : string
Return values
void —

onResetTitleOptions()

public onResetTitleOptions() : void
Return values
void —

onServerDeath()

public onServerDeath() : void
Return values
void —

onServerRespawn()

public onServerRespawn() : void
Return values
void —

onSubTitle()

public onSubTitle(string $subtitle) : void
Parameters
$subtitle : string
Return values
void —

onTip()

public onTip(string $message) : void
Parameters
$message : string
Return values
void —

onTitle()

public onTitle(string $title) : void
Parameters
$title : string
Return values
void —

onTitleDuration()

public onTitleDuration(int $fadeIn, int $stay, int $fadeOut) : void
Parameters
$fadeIn : int
$stay : int
$fadeOut : int
Return values
void —

onTranslatedChatMessage()

public onTranslatedChatMessage(string $key, array<string|int, string> $parameters) : void
Parameters
$key : string
$parameters : array<string|int, string>
Return values
void —

startUsingChunk()

Instructs the networksession to start using the chunk at the given coordinates. This may occur asynchronously.

public startUsingChunk(int $chunkX, int $chunkZ, Closure $onCompletion) : void
Parameters
$chunkX : int
$chunkZ : int
$onCompletion : Closure

To be called when chunk sending has completed.

Tags
phpstan-param

\Closure() : void $onCompletion

Return values
void —

stopUsingChunk()

public stopUsingChunk(int $chunkX, int $chunkZ) : void
Parameters
$chunkX : int
$chunkZ : int
Return values
void —

syncAdventureSettings()

TODO: make this less specialized

public syncAdventureSettings(Player $for) : void
Parameters
$for : Player
Return values
void —

syncAvailableCommands()

public syncAvailableCommands() : void
Return values
void —

syncGameMode()

public syncGameMode(GameMode $mode[, bool $isRollback = false ]) : void
Parameters
$mode : GameMode
$isRollback : bool = false
Return values
void —

syncMovement()

public syncMovement(Vector3 $pos[, float|null $yaw = null ][, float|null $pitch = null ][, int $mode = MovePlayerPacket::MODE_NORMAL ]) : void
Parameters
$pos : Vector3
$yaw : float|null = null
$pitch : float|null = null
$mode : int = MovePlayerPacket::MODE_NORMAL
Return values
void —

syncPlayerList()

public syncPlayerList(array<string|int, Player> $players) : void
Parameters
$players : array<string|int, Player>
Return values
void —

syncViewAreaCenterPoint()

public syncViewAreaCenterPoint(Vector3 $newPos, int $viewDistance) : void
Parameters
$newPos : Vector3
$viewDistance : int
Return values
void —

syncViewAreaRadius()

public syncViewAreaRadius(int $distance) : void
Parameters
$distance : int
Return values
void —

syncWorldDifficulty()

public syncWorldDifficulty(int $worldDifficulty) : void
Parameters
$worldDifficulty : int
Return values
void —

syncWorldTime()

public syncWorldTime(int $worldTime) : void
Parameters
$worldTime : int
Return values
void —

transfer()

Instructs the remote client to connect to a different server.

public transfer(string $ip, int $port[, string $reason = "transfer" ]) : void
Parameters
$ip : string
$port : int
$reason : string = "transfer"
Return values
void —

createPlayer()

protected createPlayer() : void
Return values
void —

beginSpawnSequence()

private beginSpawnSequence() : void
Return values
void —

doServerDisconnect()

Internal helper function used to handle server disconnections.

private doServerDisconnect(string $reason[, bool $notify = true ]) : void
Parameters
$reason : string
$notify : bool = true
Return values
void —

flushSendBuffer()

private flushSendBuffer([bool $immediate = false ]) : void
Parameters
$immediate : bool = false
Return values
void —

getLogPrefix()

private getLogPrefix() : string
Return values
string —

onClientSpawnResponse()

private onClientSpawnResponse() : void
Return values
void —

onServerLoginSuccess()

private onServerLoginSuccess() : void
Return values
void —

sendEncoded()

private sendEncoded(string $payload[, bool $immediate = false ]) : void
Parameters
$payload : string
$immediate : bool = false
Return values
void —

setAuthenticationStatus()

private setAuthenticationStatus(bool $authenticated, bool $authRequired, string|null $error, string|null $clientPubKey) : void
Parameters
$authenticated : bool
$authRequired : bool
$error : string|null
$clientPubKey : string|null
Return values
void —

tryDisconnect()

private tryDisconnect(Closure $func, string $reason) : void
Parameters
$func : Closure
$reason : string
Tags
phpstan-param

\Closure() : void $func

Return values
void —

Search results