Class PlayerExitVentEvent<RoomType>

Emitted when a player leaves a vent.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerExitVentEvent

Implements

Index

Properties

Constructors

constructor

Properties

Static eventName

eventName: "player.exitvent" = ...

eventName

eventName: "player.exitvent" = ...

Readonly message

message: undefined | ExitVentMessage

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 PlayerExitVentEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | ExitVentMessage, ventId: number): PlayerExitVentEvent<RoomType>

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

Generated using TypeDoc