Class HqHudConsoleOpenEvent<RoomType>

Emitted when a player opens a communications console on Mira HQ.

Type Parameters

Hierarchy

  • RevertableEvent
    • HqHudConsoleOpenEvent

Implements

Properties

eventName consoleId eventName hqhudsystem message player reverted room

Accessors

alteredConsoleId alteredPlayer

Constructors

constructor

Methods

revert setConsoleId setPlayer

Properties

Static eventName

eventName: "hqhud.consoles.open"

Readonly consoleId

consoleId: number

The ID of the console that was opened.

eventName

eventName: "hqhud.consoles.open"

Readonly hqhudsystem

hqhudsystem: HqHudSystem<RoomType>

The Mira HQ communications system that this event is for.

Readonly message

message: undefined | RepairSystemMessage

The message that this event originated from.

Readonly player

player: PlayerData<RoomType>

The player that opened the console.

reverted

reverted: boolean

Readonly room

room: RoomType

The room or client that the event came from.

Accessors

alteredConsoleId

  • get alteredConsoleId(): number

  • The alternate console ID that will be opened, if changed.

    Returns number

alteredPlayer

  • get alteredPlayer(): PlayerData<RoomType>

  • The alternate player that will open the console, if changed.

    Returns PlayerData<RoomType>

Constructors

constructor

Methods

revert

  • Returns void

setConsoleId

  • Change the ID of the console that was opened.

    Parameters

    • consoleId: number

      The ID of the console to open.

    Returns void

setPlayer

  • Change the player that opened the console.

    Parameters

    • player: PlayerData<RoomType>

      The player to open the console.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc