Class PlayerClimbLadderEvent<RoomType>

Emitted when a player climbs a ladder on the map.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerClimbLadderEvent

Implements

Index

Properties

Constructors

constructor

Properties

Static eventName

eventName: "player.climbladder" = ...

eventName

eventName: "player.climbladder" = ...

Readonly ladderId

ladderId: number

Readonly message

message: undefined | ClimbLadderMessage

The message that this event originated from.

Readonly player

player: PlayerData<RoomType>

The player that this event is for.

Readonly room

room: RoomType

The room or client that the event came from.

Constructors

constructor

new PlayerClimbLadderEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | ClimbLadderMessage, ladderId: number): PlayerClimbLadderEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/ClimbLadder.ts:18
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | ClimbLadderMessage
- ladderId: number
Returns PlayerClimbLadderEvent<RoomType>

Generated using TypeDoc