Class SwitchSystem<RoomType>

Represents a system responsible for handling switches in Electrical.

See SwitchSystemEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

SystemStatus<RoomType, SwitchSystemEvents<RoomType>>
- SwitchSystem

Constructors

constructor

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

Properties

actual

actual: SwitchSetup = ...

The current switch states.

brightness

brightness: number = 255

The brightness of lights.

expected

expected: SwitchSetup = ...

The switch states that are expected.

`Protected`ship

ship: InnerShipStatus<RoomType>

systemType

systemType: SystemType

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/SwitchSystem.ts:49

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

deserializeFromReader

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

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

flip

flip(num: number): Promise<void>
Parameters
- num: number
Returns Promise<void>
- Defined in packages/core/lib/systems/SwitchSystem.ts:188

flipPlayer

flipPlayer(num: number, flippedByPlayer: Player<RoomType>): Promise<void>
Invert the position of a switch.
Parameters
- num: number
  The ID of the switch to invert.
- flippedByPlayer: Player<RoomType>
Returns Promise<void>
Example
```
// Invert the position of each switch.
for (let i = 0; i < 5; i++) {
  electrical.flip(i);
}
```
- Defined in packages/core/lib/systems/SwitchSystem.ts:184

fullyRepairHost

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

fullyRepairPlayer

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

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/SwitchSystem.ts:229

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/SwitchSystem.ts:90

off

off<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "electrical.switchflip",
>(
    event: EventName,
    listener: Listener<SwitchSystemEvents<RoomType>[EventName]>,
): void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "electrical.switchflip"
Parameters
- event: EventName
- listener: Listener<SwitchSystemEvents<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"
        | "electrical.switchflip",
>(
    event: EventName,
    listener: Listener<SwitchSystemEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "electrical.switchflip"
Parameters
- event: EventName
- listener: Listener<SwitchSystemEvents<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"
        | "electrical.switchflip",
>(
    event: EventName,
    listener: Listener<SwitchSystemEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "electrical.switchflip"
Parameters
- event: EventName
- listener: Listener<SwitchSystemEvents<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

processFixedUpdate

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

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/SwitchSystem.ts:218

serializeToWriter

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

setSwitch

setSwitch(num: number, value: boolean): Promise<void>
Set the value of a switch as flipped or not flipped
Parameters
- num: number
  The ID of the switch to flip.
- value: boolean
  Whether the switch is flipped.
Returns Promise<void>
Example
```
// Randomise each switch.
for (let i = 0; i < 5; i++) {
  electrical.setSwitch(i, Math.random() > 0.5);
}
```
- Defined in packages/core/lib/systems/SwitchSystem.ts:166

setSwitchPlayer

setSwitchPlayer(
    num: number,
    value: boolean,
    setByPlayer: Player<RoomType>,
): Promise<void>
Parameters
- num: number
- value: boolean
- setByPlayer: Player<RoomType>
Returns Promise<void>
- Defined in packages/core/lib/systems/SwitchSystem.ts:147

wait

wait<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "electrical.switchflip",
>(
    event: EventName,
): Promise<SwitchSystemEvents<RoomType>[EventName]>
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "electrical.switchflip"
Parameters
- event: EventName
Returns Promise<SwitchSystemEvents<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"
        | "electrical.switchflip",
>(
    event: EventName,
    filter: (
        ev: SwitchSystemEvents<RoomType>[EventName],
    ) => boolean | Promise<boolean>,
): Promise<SwitchSystemEvents<RoomType>[EventName]>
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "electrical.switchflip"
Parameters
- event: EventName
- filter: (ev: SwitchSystemEvents<RoomType>[EventName]) => boolean | Promise<boolean>
Returns Promise<SwitchSystemEvents<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

`Static`readSwitches

readSwitches(byte: number): SwitchSetup
Read the value of each switch from a byte.
Parameters
- byte: number
  The byte to read from.
Returns SwitchSetup
An array of the value of each switch.
Example
```
console.log(readSwitches(0x5));
// [ true, false, true, false, false ]
```
- Defined in packages/core/lib/systems/SwitchSystem.ts:265

`Static`writeSwitches

writeSwitches(switches: SwitchSetup): number
Write the value of each switch to a byte.
Parameters
- switches: SwitchSetup
  An array of the value of each switch.
Returns number
The byte representation of the switches.
Example
```
console.log(writeSwitches([ false, true, false, false, true ]));
// 0x12 (18)
```
- Defined in packages/core/lib/systems/SwitchSystem.ts:287

Class SwitchSystem<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SwitchSystem<RoomType>

Properties

actual

brightness

expected

Protectedship

systemType

Accessors

dirty

Returns boolean

Parameters

Returns void

room

Returns RoomType

sabotaged

Returns boolean

Methods

Protected_sendRepair

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

flip

Parameters

Returns Promise<void>

flipPlayer

Parameters

Returns Promise<void>

Example

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

Returns void

on

Type Parameters

Parameters

Returns () => void

`Protected`ship

`Protected`_sendRepair

`Static`readSwitches

`Static`writeSwitches