Class PlayerExitVentEvent<RoomType>

Emitted when a player leaves a vent.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerExitVentEvent

Implements

Properties

eventName eventName message player room ventId

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

The ID of the vent that the player left.

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | ExitVentMessage
    • ventId: number

      The ID of the vent that the player left.

    Returns PlayerExitVentEvent<RoomType>

Settings

Member Visibility

Theme

Generated using TypeDoc