Class PlayerEnterVentEvent<RoomType>

Emitted when a player goes into a vent.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerEnterVentEvent

Implements

PlayerEvent<RoomType>
ProtocolEvent

Index

Constructors

Properties

eventName eventName message player room ventId

Constructors

constructor

new PlayerEnterVentEvent<
    RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
>(
    room: RoomType,
    player: Player<RoomType>,
    message: undefined | EnterVentMessage,
    ventId: number,
): PlayerEnterVentEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
Parameters
- room: RoomType
- player: Player<RoomType>
- message: undefined | EnterVentMessage
- ventId: number
  The ID of the vent that the player went into.
Returns PlayerEnterVentEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/player/EnterVent.ts:17

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: Player<RoomType>

`Readonly`room

`Readonly`ventId

ventId: number

The ID of the vent that the player went into.