JSPrismarine

API reference / @jsprismarine/prismarine / SessionManager

Class: SessionManager ​

Defined in: prismarine/src/SessionManager.ts:6

Constructors ​

Constructor ​

new SessionManager(): SessionManager

Returns ​

SessionManager

Methods ​

add() ​

add(id, connection): void

Defined in: prismarine/src/SessionManager.ts:10

Parameters ​

id ​

number

connection ​

ClientConnection

Returns ​

void

findPlayer() ​

findPlayer(__namedParameters): Player | null

Defined in: prismarine/src/SessionManager.ts:52

Parameters ​

__namedParameters ​
name? ​

string

xuid? ​

string

Returns ​

Player | null

get() ​

get(id): ClientConnection | null

Defined in: prismarine/src/SessionManager.ts:18

Parameters ​

id ​

number

Returns ​

ClientConnection | null

getAllPlayers() ​

getAllPlayers(): Player[]

Defined in: prismarine/src/SessionManager.ts:38

Every player on the server, in any world.

Online only, the same test World.getPlayers applies. A connection has a session from the moment it authenticates, well before the client is ready to be sent anything, and without this the login handshake was among the recipients of every broadcast.

Returns ​

Player[]

The online players.

getPlayerByExactName() ​

getPlayerByExactName(name): Player | null

Defined in: prismarine/src/SessionManager.ts:63

Just a compatibility layer to not break everything for now

Parameters ​

name ​

string

Returns ​

Player | null

Deprecated ​

getPlayerById() ​

getPlayerById(id): Player | null

Defined in: prismarine/src/SessionManager.ts:78

The online player with runtime id id.

Null when nobody has it, as the signature always said. It used to assert instead, so asking after a player who had just left took the caller down with it.

Parameters ​

id ​

bigint

The runtime id to look up.

Returns ​

Player | null

The player, or null when no online player has that id.

Deprecated ​

getPlayerList() ​

getPlayerList(): Map<string, PlayerListEntry>

Defined in: prismarine/src/SessionManager.ts:26

Returns ​

Map<string, PlayerListEntry>

has() ​

has(id): boolean

Defined in: prismarine/src/SessionManager.ts:14

Parameters ​

id ​

number

Returns ​

boolean

kickAllPlayers() ​

kickAllPlayers(reason): Promise<void>

Defined in: prismarine/src/SessionManager.ts:48

Kick all players.

Parameters ​

reason ​

string

The reason to kick the players.

Returns ​

Promise<void>

remove() ​

remove(id): boolean

Defined in: prismarine/src/SessionManager.ts:22

Parameters ​

id ​

number

Returns ​

boolean