Class PlayerClimbLadderEvent<RoomType>

Emitted when a player climbs a ladder on the map.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerClimbLadderEvent

Implements

Index

Constructors

Properties

eventName ladderId message player room eventName

Constructors

constructor

new PlayerClimbLadderEvent<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    player: Player<RoomType>,
    message: undefined | ClimbLadderMessage,
    ladderId: number,
): PlayerClimbLadderEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- player: Player<RoomType>
- message: undefined | ClimbLadderMessage
- ladderId: number
  The ID of the ladder that the player climbed.
Returns PlayerClimbLadderEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/player/ClimbLadder.ts:17

Properties

eventName

eventName: "player.climbladder" = ...

`Readonly`ladderId

ladderId: number

The ID of the ladder that the player climbed.

`Readonly`message

message: undefined | ClimbLadderMessage

The message that this event originated from.

`Readonly`player

player: Player<RoomType>

The player that this event is for.

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "player.climbladder" = ...