JSPrismarine

API reference / @jsprismarine/prismarine / events/player/PlayerEvent / PlayerEvent

Class: PlayerEvent ​

Defined in: prismarine/src/events/player/PlayerEvent.ts:11

An event about one player.

It names the player by its runtime id and the identity it logged in with, which stay right once the player has left, and hands a listener that acts on the player its session.

Extends ​

Extended by ​

Constructors ​

Constructor ​

new PlayerEvent(session): PlayerEvent

Defined in: prismarine/src/events/player/PlayerEvent.ts:17

Parameters ​

session ​

PlayerSession

The session of the player the event is about.

Returns ​

PlayerEvent

Overrides ​

Event.constructor

Methods ​

getIdentity() ​

getIdentity(): PlayerIdentity

Defined in: prismarine/src/events/player/PlayerEvent.ts:34

Who the player logged in as.

Returns ​

PlayerIdentity

The name, the XUID (empty when the login carried none) and the UUID.

getRuntimeId() ​

getRuntimeId(): bigint

Defined in: prismarine/src/events/player/PlayerEvent.ts:26

The player's runtime id, which the wire and the player's session use.

Returns ​

bigint

The id.

getSession() ​

getSession(): PlayerSession

Defined in: prismarine/src/events/player/PlayerEvent.ts:44

The session of the player the event is about, for a listener that acts on the player: it sends to the client, and getPlayer() reaches the player's state while it is connected. To name the player, read PlayerEvent.getRuntimeId or PlayerEvent.getIdentity.

Returns ​

PlayerSession

The session.

isCanceled() ​

isCanceled(): boolean

Defined in: prismarine/src/events/Event.ts:12

Is the event canceled

Returns ​

boolean

Whether the event is canceled

Inherited from ​

Event.isCanceled

preventDefault() ​

preventDefault(): void

Defined in: prismarine/src/events/Event.ts:19

Cancel the event

Returns ​

void

Inherited from ​

Event.preventDefault