Class SwitchSystem<RoomType>

Represents a system responsible for handling switches in Electrical.

See SwitchSystemEvents for events to listen to.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

SystemStatus<SwitchSystemData, SwitchSystemEvents, RoomType>
- SwitchSystem

Implements

SwitchSystemData

Index

Methods

`Static` readSwitches

readSwitches(byte: number): SwitchSetup
Read the value of each switch from a byte.

Returns
An array of the value of each switch.

Example
```
console.log(readSwitches(0x5));
// [ true, false, true, false, false ]
```
Parameters
- byte: number
  
  The byte to read from.
Returns SwitchSetup
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:84

`Static` writeSwitches

writeSwitches(switches: SwitchSetup): number
Write the value of each switch to a byte.

Returns
The byte representation of the switches.

Example
```
console.log(writeSwitches([ false, true, false, false, true ]));
// 0x12 (18)
```
Parameters
- switches: SwitchSetup
  
  An array of the value of each switch.
Returns number
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:95

Deserialize

Deserialize(reader: HazelReader, spawn: boolean): void
Parameters
- reader: HazelReader
- spawn: boolean
Returns void
Overrides SystemStatus.Deserialize
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:41

Detoriorate

Detoriorate(delta: number): void
Parameters
- delta: number
Returns void
Overrides SystemStatus.Detoriorate
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:73

HandleRepair

HandleRepair(player: undefined | PlayerData<RoomType>, amount: number, rpc: undefined | RepairSystemMessage): Promise<void>
Parameters
- player: undefined | PlayerData<RoomType>
- amount: number
- rpc: undefined | RepairSystemMessage
Returns Promise<void>
Overrides SystemStatus.HandleRepair
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:72

HandleSabotage

HandleSabotage(player: undefined | PlayerData<RoomType>, rpc: undefined | RepairSystemMessage): Promise<void>
Parameters
- player: undefined | PlayerData<RoomType>
- rpc: undefined | RepairSystemMessage
Returns Promise<void>
Overrides SystemStatus.HandleSabotage
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:43

Serialize

Serialize(writer: HazelWriter, spawn: boolean): void
Parameters
- writer: HazelWriter
- spawn: boolean
Returns void
Overrides SystemStatus.Serialize
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:42

emit

emit<Event>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>
Inherited from SystemStatus.emit
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:25

emitSerial

emitSerial<Event>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>
Inherited from SystemStatus.emitSerial
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:26

emitSync

emitSync<Event>(event: Event): Event
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Event
Inherited from SystemStatus.emitSync
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:27

flip

flip(num: number): Promise<void>
Invert the position of a switch.

Example
```
// Invert the position of each switch.
for (let i = 0; i < 5; i++) {
  electrical.flip(i);
}
```
Parameters
- num: number
  
  The ID of the switch to invert.
Returns Promise<void>
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:69

getListeners

getListeners<Event>(event: string): Listener<Event>[]
Type Parameters
- Event extends BasicEvent<Event> = BasicEvent
Parameters
- event: string
Returns Listener<Event>[]
Inherited from SystemStatus.getListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:32

off

off<EventName>(event: EventName, listener: Listener<SwitchSystemEvents<Hostable<any>>[EventName]>): void
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "electrical.switchflip"
Parameters
- event: EventName
- listener: Listener<SwitchSystemEvents<Hostable<any>>[EventName]>
Returns void
Inherited from SystemStatus.off
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:30
off<K>(event: string, listener: Listener<K>): void
Type Parameters
- K extends BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns void
Inherited from SystemStatus.off
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:31

on

on<EventName>(event: EventName, listener: Listener<SwitchSystemEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "electrical.switchflip"
Parameters
- event: EventName
- listener: Listener<SwitchSystemEvents<Hostable<any>>[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from SystemStatus.on
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:22
on<K>(event: string, listener: Listener<K>): (() => void)
Type Parameters
- K extends BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns (() => void)
- - (): void
  - Returns void
Inherited from SystemStatus.on
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:23

once

once<EventName>(event: EventName, listener: Listener<SwitchSystemEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "electrical.switchflip"
Parameters
- event: EventName
- listener: Listener<SwitchSystemEvents<Hostable<any>>[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from SystemStatus.once
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:24
once<K>(event: string, listener: Listener<K>): (() => void)
Type Parameters
- K extends BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns (() => void)
- - (): void
  - Returns void
Inherited from SystemStatus.once
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:25

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from SystemStatus.removeAllListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:34

removeListeners

removeListeners(event: string): void
Parameters
- event: string
Returns void
Inherited from SystemStatus.removeListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:33

repair

repair(): Promise<void>
Fully repair this system.

Returns Promise<void>
Overrides SystemStatus.repair
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:71

sabotage

sabotage(): Promise<void>
Sabotage this system.

Returns Promise<void>
Inherited from SystemStatus.sabotage
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:40

setSwitch

setSwitch(num: number, value: boolean): Promise<void>
Set the value of a switch as flipped or not flipped

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

wait

wait<EventName>(event: EventName): Promise<SwitchSystemEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "electrical.switchflip"
Parameters
- event: EventName
Returns Promise<SwitchSystemEvents<Hostable<any>>[EventName]>
Inherited from SystemStatus.wait
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:26
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from SystemStatus.wait
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:27

waitf

waitf<EventName>(event: EventName, filter: ((ev: SwitchSystemEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)): Promise<SwitchSystemEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "electrical.switchflip"
Parameters
- event: EventName
- filter: ((ev: SwitchSystemEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)
  - - (ev: SwitchSystemEvents<Hostable<any>>[EventName]): boolean | Promise<boolean>
    - Parameters
      
      ev: SwitchSystemEvents<Hostable<any>>[EventName]
      
      Returns boolean | Promise<boolean>
Returns Promise<SwitchSystemEvents<Hostable<any>>[EventName]>
Inherited from SystemStatus.waitf
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:28
waitf<K>(event: string, filter: ((ev: K) => boolean | Promise<boolean>)): Promise<BasicEvent>
Type Parameters
- K extends BasicEvent<K>
Parameters
- event: string
- filter: ((ev: K) => boolean | Promise<boolean>)
  - - (ev: K): boolean | Promise<boolean>
    - Parameters
      
      ev: K
      
      Returns boolean | Promise<boolean>
Returns Promise<BasicEvent>
Inherited from SystemStatus.waitf
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:29

Properties

actual

actual: SwitchSetup

The current switch states.

brightness

brightness: number

The brightness of lights.

expected

expected: SwitchSetup

The switch states that are expected.

systemType

systemType: SystemType

Constructors

constructor

new SwitchSystem<RoomType>(ship: InnerShipStatus<RoomType>, systemType: SystemType, data?: HazelReader | SwitchSystemData): SwitchSystem<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- ship: InnerShipStatus<RoomType>
- systemType: SystemType
- Optional data: HazelReader | SwitchSystemData
Returns SwitchSystem<RoomType>
Overrides SystemStatus.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:40

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from SystemStatus.dirty
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:14
set dirty(isDirty: boolean): void
Parameters
- isDirty: boolean
Returns void
Inherited from SystemStatus.dirty
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:15

room

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

Returns RoomType
Inherited from SystemStatus.room
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:24

sabotaged

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

Returns boolean
Overrides SystemStatus.sabotaged
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SwitchSystem.d.ts:39

Class SwitchSystem<RoomType>

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

Implements

Index

Methods

Properties

Constructors

Accessors

Methods

Static readSwitches

Returns

Example

Parameters

byte: number

Returns SwitchSetup

Static writeSwitches

Returns

Example

Parameters

switches: SwitchSetup

Returns number

Deserialize

Parameters

reader: HazelReader

spawn: boolean

Returns void

Detoriorate

Parameters

delta: number

Returns void

HandleRepair

Parameters

player: undefined | PlayerData<RoomType>

amount: number

rpc: undefined | RepairSystemMessage

Returns Promise<void>

HandleSabotage

Parameters

player: undefined | PlayerData<RoomType>

rpc: undefined | RepairSystemMessage

Returns Promise<void>

Serialize

Parameters

writer: HazelWriter

spawn: boolean

Returns void

emit

Type Parameters

Event extends BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSerial

Type Parameters

Event extends BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSync

Type Parameters

Event extends BasicEvent<Event>

Parameters

event: Event

Returns Event

flip

Example

Parameters

num: number

Returns Promise<void>

getListeners

Type Parameters

Event extends BasicEvent<Event> = BasicEvent

Parameters

event: string

Returns Listener<Event>[]

off

Type Parameters

EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "electrical.switchflip"

`Static` readSwitches

`Static` writeSwitches