Class PlayerClimbLadderEvent<RoomType>

Emitted when a player climbs a ladder on the map.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

BasicEvent
- PlayerClimbLadderEvent

Implements

Index

Properties

eventName eventName ladderId message player room

Constructors

Properties

`Static` eventName

eventName: "player.climbladder"

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: 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>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | ClimbLadderMessage
- ladderId: number
  
  The ID of the ladder that the player climbed.
Returns PlayerClimbLadderEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/ClimbLadder.d.ts:21

Generated using TypeDoc