Class PlayerEnterVentEvent<RoomType>

Emitted when a player goes into a vent.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerEnterVentEvent

Implements

Index

Properties

Constructors

constructor

Properties

Static eventName

eventName: "player.entervent" = ...

eventName

eventName: "player.entervent" = ...

Readonly message

message: undefined | EnterVentMessage

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.

Readonly ventId

ventId: number

Constructors

constructor

new PlayerEnterVentEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | EnterVentMessage, ventId: number): PlayerEnterVentEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/EnterVent.ts:18
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | EnterVentMessage
- ventId: number
Returns PlayerEnterVentEvent<RoomType>

Generated using TypeDoc