API reference / @jsprismarine/prismarine / events/player/PlayerDespawnEvent / PlayerDespawnEvent
Class: PlayerDespawnEvent
Defined in: prismarine/src/events/player/PlayerDespawnEvent.ts:7
Fired just after a player despawns from the world
Extends
Constructors
Constructor
new PlayerDespawnEvent(
session):PlayerDespawnEvent
Defined in: prismarine/src/events/player/PlayerDespawnEvent.ts:8
Parameters
session
Returns
PlayerDespawnEvent
Overrides
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.
Inherited from
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.
Inherited from
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
The session.
Inherited from
isCanceled()
isCanceled():
boolean
Defined in: prismarine/src/events/Event.ts:12
Is the event canceled
Returns
boolean
Whether the event is canceled
Inherited from
preventDefault()
preventDefault():
void
Defined in: prismarine/src/events/Event.ts:19
Cancel the event
Returns
void