Class HqHudSystem<RoomType>

Represents a system responsible for handling communication consoles on Mira HQ.

See HqHudSystemEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

SystemStatus<RoomType, HqHudSystemEvents<RoomType>>
- HqHudSystem

Constructors

constructor

new HqHudSystem<RoomType extends StatefulRoom<any>>(
ship: InnerShipStatus<RoomType>,
systemType: SystemType,
): HqHudSystem<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- ship: InnerShipStatus<RoomType>
- systemType: SystemType
Returns HqHudSystem<RoomType>
Inherited from SystemStatus.constructor
- Defined in packages/core/lib/systems/SystemStatus.ts:17

Properties

activeConsoles

activeConsoles: UserConsolePair[] = []

The currently opened consoles.

completedConsoles

completedConsoles: Set<number> = ...

The completed consoles.

`Protected`ship

ship: InnerShipStatus<RoomType>

systemType

systemType: SystemType

timer

timer: number = 10000

The timer until the consoles are reset.

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from SystemStatus.dirty
- Defined in packages/core/lib/systems/SystemStatus.ts:27
set dirty(isDirty: boolean): void
Parameters
- isDirty: boolean
Returns void
Inherited from SystemStatus.dirty
- Defined in packages/core/lib/systems/SystemStatus.ts:31

room

get room(): RoomType
Return the room that this system belongs to.

Returns RoomType
Inherited from SystemStatus.room
- Defined in packages/core/lib/systems/SystemStatus.ts:46

sabotaged

get sabotaged(): boolean
Whether or not this system is sabotaged.

Returns boolean
Overrides SystemStatus.sabotaged
- Defined in packages/core/lib/systems/HqHudSystem.ts:63

Methods

`Protected`_sendRepair

_sendRepair(amount: number): Promise<void>
Parameters
- amount: number
Returns Promise<void>
Inherited from SystemStatus._sendRepair
- Defined in packages/core/lib/systems/SystemStatus.ts:99

closeConsole

closeConsole(consoleId: number): Promise<void>
Mark the console as no longer being used by your player.
Parameters
- consoleId: number
  The ID of the console to mark as not being used.
Returns Promise<void>
- Defined in packages/core/lib/systems/HqHudSystem.ts:252

closeConsolePlayer

closeConsolePlayer(
consoleId: number,
closedByPlayer: Player<RoomType>,
): Promise<void>
Parameters
- consoleId: number
- closedByPlayer: Player<RoomType>
Returns Promise<void>
- Defined in packages/core/lib/systems/HqHudSystem.ts:244

completeConsole

completeConsole(consoleId: number): Promise<void>
Parameters
- consoleId: number
Returns Promise<void>
- Defined in packages/core/lib/systems/HqHudSystem.ts:283

completeConsolePlayer

completeConsolePlayer(
consoleId: number,
completedByPlayer: Player<RoomType>,
): Promise<void>
Mark a console as completed.
Parameters
- consoleId: number
  The ID of the console to mark as completed.
- completedByPlayer: Player<RoomType>
Returns Promise<void>
- Defined in packages/core/lib/systems/HqHudSystem.ts:279

deserializeFromReader

deserializeFromReader(reader: HazelReader, spawn: boolean): void
Parameters
- reader: HazelReader
- spawn: boolean
Returns void
Overrides SystemStatus.deserializeFromReader
- Defined in packages/core/lib/systems/HqHudSystem.ts:74

emit

emit<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Inherited from SystemStatus.emit
- Defined in packages/core/lib/systems/SystemStatus.ts:50

emitSerial

emitSerial<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Inherited from SystemStatus.emitSerial
- Defined in packages/core/lib/systems/SystemStatus.ts:58

emitSync

emitSync<Event extends BasicEvent>(event: Event): Event
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Event
Inherited from SystemStatus.emitSync
- Defined in packages/core/lib/systems/SystemStatus.ts:66

fullyRepairHost

fullyRepairHost(): Promise<void>
Returns Promise<void>
Overrides SystemStatus.fullyRepairHost
- Defined in packages/core/lib/systems/HqHudSystem.ts:307

fullyRepairPlayer

fullyRepairPlayer(player: Player<RoomType>): Promise<void>
Parameters
- player: Player<RoomType>
Returns Promise<void>
Overrides SystemStatus.fullyRepairPlayer
- Defined in packages/core/lib/systems/HqHudSystem.ts:311

getListeners

getListeners<Event extends BasicEvent = BasicEvent>(
event: string,
): Listener<Event>[]
Type Parameters
- Event extends BasicEvent = BasicEvent
Parameters
- event: string
Returns Listener<Event>[]
Inherited from SystemStatus.getListeners
- Defined in packages/events/lib/EventEmitter.ts:150

handleRepairByPlayer

handleRepairByPlayer(
    player: undefined | Player<RoomType>,
    amount: number,
    rpc: undefined | RepairSystemMessage,
): Promise<void>
Parameters
- player: undefined | Player<RoomType>
- amount: number
- rpc: undefined | RepairSystemMessage
Returns Promise<void>
Overrides SystemStatus.handleRepairByPlayer
- Defined in packages/core/lib/systems/HqHudSystem.ts:320

handleSabotageByPlayer

handleSabotageByPlayer(
player: undefined | Player<RoomType>,
rpc: undefined | RepairSystemMessage,
): Promise<void>
Parameters
- player: undefined | Player<RoomType>
- rpc: undefined | RepairSystemMessage
Returns Promise<void>
Overrides SystemStatus.handleSabotageByPlayer
- Defined in packages/core/lib/systems/HqHudSystem.ts:144

off

off<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete",
>(
    event: EventName,
    listener: Listener<HqHudSystemEvents<RoomType>[EventName]>,
): void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
Parameters
- event: EventName
- listener: Listener<HqHudSystemEvents<RoomType>[EventName]>
Returns void
Inherited from SystemStatus.off
- Defined in packages/events/lib/EventEmitter.ts:137
off<K extends BasicEvent>(event: string, listener: Listener<K>): void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns void
Inherited from SystemStatus.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

on<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete",
>(
    event: EventName,
    listener: Listener<HqHudSystemEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
Parameters
- event: EventName
- listener: Listener<HqHudSystemEvents<RoomType>[EventName]>
Returns () => void
Inherited from SystemStatus.on
- Defined in packages/events/lib/EventEmitter.ts:86
on<K extends BasicEvent>(event: string, listener: Listener<K>): () => void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns () => void
Inherited from SystemStatus.on
- Defined in packages/events/lib/EventEmitter.ts:90

once

once<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete",
>(
    event: EventName,
    listener: Listener<HqHudSystemEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
Parameters
- event: EventName
- listener: Listener<HqHudSystemEvents<RoomType>[EventName]>
Returns () => void
Inherited from SystemStatus.once
- Defined in packages/events/lib/EventEmitter.ts:98
once<K extends BasicEvent>(event: string, listener: Listener<K>): () => void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns () => void
Inherited from SystemStatus.once
- Defined in packages/events/lib/EventEmitter.ts:102

openConsole

openConsole(consoleId: number): Promise<void>
Parameters
- consoleId: number
Returns Promise<void>
- Defined in packages/core/lib/systems/HqHudSystem.ts:215

openConsolePlayer

openConsolePlayer(
consoleId: number,
openedByPlayer: Player<RoomType>,
): Promise<void>
Mark the console as being used by your player.
Parameters
- consoleId: number
  The ID of the console to mark as being used.
- openedByPlayer: Player<RoomType>
Returns Promise<void>
- Defined in packages/core/lib/systems/HqHudSystem.ts:211

processFixedUpdate

processFixedUpdate(delta: number): Promise<void>
Parameters
- delta: number
Returns Promise<void>
Overrides SystemStatus.processFixedUpdate
- Defined in packages/core/lib/systems/HqHudSystem.ts:346

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from SystemStatus.removeAllListeners
- Defined in packages/events/lib/EventEmitter.ts:164

removeListeners

removeListeners(event: string): void
Parameters
- event: string
Returns void
Inherited from SystemStatus.removeListeners
- Defined in packages/events/lib/EventEmitter.ts:159

sabotage

sabotage(): Promise<void>
Returns Promise<void>
Inherited from SystemStatus.sabotage
- Defined in packages/core/lib/systems/SystemStatus.ts:94

sabotagePlayer

sabotagePlayer(sabotagedByPlayer: Player<RoomType>): Promise<void>
Sabotage this system.
Parameters
- sabotagedByPlayer: Player<RoomType>
Returns Promise<void>
Inherited from SystemStatus.sabotagePlayer
- Defined in packages/core/lib/systems/SystemStatus.ts:89

sendFullRepair

sendFullRepair(): Promise<void>
Returns Promise<void>
Overrides SystemStatus.sendFullRepair
- Defined in packages/core/lib/systems/HqHudSystem.ts:315

serializeToWriter

serializeToWriter(writer: HazelWriter, spawn: boolean): void
Parameters
- writer: HazelWriter
- spawn: boolean
Returns void
Overrides SystemStatus.serializeToWriter
- Defined in packages/core/lib/systems/HqHudSystem.ts:126

wait

wait<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete",
>(
    event: EventName,
): Promise<HqHudSystemEvents<RoomType>[EventName]>
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
Parameters
- event: EventName
Returns Promise<HqHudSystemEvents<RoomType>[EventName]>
Inherited from SystemStatus.wait
- Defined in packages/events/lib/EventEmitter.ts:111
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from SystemStatus.wait
- Defined in packages/events/lib/EventEmitter.ts:114

waitf

waitf<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete",
>(
    event: EventName,
    filter: (
        ev: HqHudSystemEvents<RoomType>[EventName],
    ) => boolean | Promise<boolean>,
): Promise<HqHudSystemEvents<RoomType>[EventName]>
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
Parameters
- event: EventName
- filter: (ev: HqHudSystemEvents<RoomType>[EventName]) => boolean | Promise<boolean>
Returns Promise<HqHudSystemEvents<RoomType>[EventName]>
Inherited from SystemStatus.waitf
- Defined in packages/events/lib/EventEmitter.ts:121
waitf<K extends BasicEvent>(
event: string,
filter: (ev: K) => boolean | Promise<boolean>,
): Promise<BasicEvent>
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- filter: (ev: K) => boolean | Promise<boolean>
Returns Promise<BasicEvent>
Inherited from SystemStatus.waitf
- Defined in packages/events/lib/EventEmitter.ts:125

Class HqHudSystem<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HqHudSystem<RoomType>

Properties

activeConsoles

completedConsoles

Protectedship

systemType

timer

Accessors

dirty

Returns boolean

Parameters

Returns void

room

Returns RoomType

sabotaged

Returns boolean

Methods

Protected_sendRepair

Parameters

Returns Promise<void>

closeConsole

Parameters

Returns Promise<void>

closeConsolePlayer

Parameters

Returns Promise<void>

completeConsole

Parameters

Returns Promise<void>

completeConsolePlayer

Parameters

Returns Promise<void>

deserializeFromReader

Parameters

Returns void

emit

Type Parameters

Parameters

Returns Promise<Event>

emitSerial

Type Parameters

Parameters

Returns Promise<Event>

emitSync

Type Parameters

Parameters

Returns Event

fullyRepairHost

Returns Promise<void>

fullyRepairPlayer

Parameters

Returns Promise<void>

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

handleRepairByPlayer

Parameters

Returns Promise<void>

handleSabotageByPlayer

Parameters

Returns Promise<void>

off

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

`Protected`ship

`Protected`_sendRepair