Class PlayerSpawnEvent

Fired just before a player spawns into the world

Hierarchy (View Summary)

Event
- PlayerSpawnEvent
  - PlayerDespawnEvent

Index

Constructors

Methods

getPlayer isCancelled preventDefault

Constructors

constructor

new PlayerSpawnEvent(player: Player): PlayerSpawnEvent
Parameters
- player: Player
Returns PlayerSpawnEvent
Overrides Event.constructor
- Defined in packages/prismarine/src/events/player/PlayerSpawnEvent.ts:10

Methods

getPlayer

getPlayer(): Player
Returns Player
- Defined in packages/prismarine/src/events/player/PlayerSpawnEvent.ts:15

isCancelled

isCancelled(): boolean
Is the event cancelled

Returns boolean
Whether the event is cancelled
Inherited from Event.isCancelled
- Defined in packages/prismarine/src/events/Event.ts:12

preventDefault

preventDefault(): void
Cancel the event

Returns void
Inherited from Event.preventDefault
- Defined in packages/prismarine/src/events/Event.ts:19