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)

SabotagableSystem<RoomType, SwitchSystemEvents<RoomType>>
- SwitchSystem

Constructors

constructor

new SwitchSystem<RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>>(
shipStatus: ShipStatus<RoomType>,
systemType: SystemType,
): SwitchSystem<RoomType>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
Parameters
- shipStatus: ShipStatus<RoomType>
- systemType: SystemType
Returns SwitchSystem<RoomType>
Inherited from SabotagableSystem.constructor
- Defined in packages/core/lib/systems/System.ts:18

Properties

`Static`alwaysFlipSwitch

alwaysFlipSwitch: number = 2

`Static`brightnessChangePerTick

brightnessChangePerTick: number = 3

`Static`flipChance

flipChance: number = 0.5

`Static`maxBrightness

maxBrightness: number = 255

`Static`minBrightness

minBrightness: number = 0

`Static`updateCooldownDuration

updateCooldownDuration: number = 0.03

actual

actual: SwitchSetup = ...

The current switch states.

brightness

brightness: number = SwitchSystem.maxBrightness

The brightness of lights.

expected

expected: SwitchSetup = ...

The switch states that are expected.

isDirty

isDirty: boolean = false

`Readonly`shipStatus

shipStatus: ShipStatus<RoomType>

`Readonly`systemType

systemType: SystemType

Accessors

room

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

Returns RoomType
Inherited from SabotagableSystem.room
- Defined in packages/core/lib/systems/System.ts:28

Methods

_fullyRepairWithAuth

_fullyRepairWithAuth(): Promise<void>
Returns Promise<void>
Overrides SabotagableSystem._fullyRepairWithAuth
- Defined in packages/core/lib/systems/Switch.ts:175

_handleData

_handleData(data: BaseSystemMessage): Promise<void>
Parameters
- data: BaseSystemMessage
Returns Promise<void>
Overrides SabotagableSystem._handleData
- Defined in packages/core/lib/systems/Switch.ts:99

_handleUpdate

_handleUpdate(
player: Player<RoomType>,
message: BaseSystemMessage,
): Promise<void>
Parameters
- player: Player<RoomType>
- message: BaseSystemMessage
Returns Promise<void>
Overrides SabotagableSystem._handleUpdate
- Defined in packages/core/lib/systems/Switch.ts:124

_sabotageWithAuth

_sabotageWithAuth(): Promise<void>
Sabotage this system. This is an authoritative operation and can result in a client being banned for hacking if called improperly.

Returns Promise<void>
Overrides SabotagableSystem._sabotageWithAuth
- Defined in packages/core/lib/systems/Switch.ts:165

emit

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

emitSerial

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

emitSync

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

fullyRepair

fullyRepair(): Promise<void>
Returns Promise<void>
Inherited from SabotagableSystem.fullyRepair
- Defined in packages/core/lib/systems/System.ts:176

fullyRepairRequest

fullyRepairRequest(): Promise<void>
Returns Promise<void>
Overrides SabotagableSystem.fullyRepairRequest
- Defined in packages/core/lib/systems/Switch.ts:180

fullyRepairWithAuth

fullyRepairWithAuth(): Promise<void>
Returns Promise<void>
Inherited from SabotagableSystem.fullyRepairWithAuth
- Defined in packages/core/lib/systems/System.ts:172

getListeners

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

handleData

handleData(data: BaseSystemMessage): Promise<void>
Parameters
- data: BaseSystemMessage
Returns Promise<void>
Inherited from SabotagableSystem.handleData
- Defined in packages/core/lib/systems/System.ts:129

handleUpdate

handleUpdate(
player: Player<RoomType>,
message: BaseSystemMessage,
): Promise<void>
Parameters
- player: Player<RoomType>
- message: BaseSystemMessage
Returns Promise<void>
Inherited from SabotagableSystem.handleUpdate
- Defined in packages/core/lib/systems/System.ts:133

isCritical

isCritical(): boolean
Returns boolean
Overrides SabotagableSystem.isCritical
- Defined in packages/core/lib/systems/Switch.ts:153

isSabotaged

isSabotaged(): boolean
Returns boolean
Overrides SabotagableSystem.isSabotaged
- Defined in packages/core/lib/systems/Switch.ts:157

off

off<EventName extends never>(
    event: EventName,
    listener: Listener<
        (SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName],
    >,
): void
Type Parameters
- EventName extends never
Parameters
- event: EventName
- listener: Listener<(SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName]>
Returns void
Inherited from SabotagableSystem.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 SabotagableSystem.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

on<EventName extends never>(
    event: EventName,
    listener: Listener<
        (SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName],
    >,
): () => void
Type Parameters
- EventName extends never
Parameters
- event: EventName
- listener: Listener<(SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName]>
Returns () => void
Inherited from SabotagableSystem.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 SabotagableSystem.on
- Defined in packages/events/lib/EventEmitter.ts:90

once

once<EventName extends never>(
    event: EventName,
    listener: Listener<
        (SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName],
    >,
): () => void
Type Parameters
- EventName extends never
Parameters
- event: EventName
- listener: Listener<(SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName]>
Returns () => void
Inherited from SabotagableSystem.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 SabotagableSystem.once
- Defined in packages/events/lib/EventEmitter.ts:102

parseData

parseData(
dataState: DataState,
reader: HazelReader,
): undefined | BaseSystemMessage
Parameters
- dataState: DataState
- reader: HazelReader
Returns undefined | BaseSystemMessage
Overrides SabotagableSystem.parseData
- Defined in packages/core/lib/systems/Switch.ts:91

parseUpdate

parseUpdate(reader: HazelReader): undefined | BaseSystemMessage
Parameters
- reader: HazelReader
Returns undefined | BaseSystemMessage
Overrides SabotagableSystem.parseUpdate
- Defined in packages/core/lib/systems/Switch.ts:120

processFixedUpdate

processFixedUpdate(deltaSeconds: number): Promise<void>
Parameters
- deltaSeconds: number
Returns Promise<void>
Overrides SabotagableSystem.processFixedUpdate
- Defined in packages/core/lib/systems/Switch.ts:135

pushDataUpdate

pushDataUpdate(): void
Returns void
Inherited from SabotagableSystem.pushDataUpdate
- Defined in packages/core/lib/systems/System.ts:56

removeAllListeners

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

removeListeners

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

sabotage

sabotage(): Promise<void>
Sabotage this system, either as the room authority or by requesting a sabotage from the room authority. Calls _sabotageWithAuth or sabotageRequest.

Returns Promise<void>
Inherited from SabotagableSystem.sabotage
- Defined in packages/core/lib/systems/System.ts:161

sabotageRequest

sabotageRequest(): Promise<void>
Ask the authority of the room to sabotage this system.

Returns Promise<void>
Inherited from SabotagableSystem.sabotageRequest
- Defined in packages/core/lib/systems/System.ts:150

sabotageWithAuth

sabotageWithAuth(): Promise<void>
Returns Promise<void>
Inherited from SabotagableSystem.sabotageWithAuth
- Defined in packages/core/lib/systems/System.ts:143

sendUpdateSystem

sendUpdateSystem(message: BaseSystemMessage): Promise<void>
Parameters
- message: BaseSystemMessage
Returns Promise<void>
Inherited from SabotagableSystem.sendUpdateSystem
- Defined in packages/core/lib/systems/System.ts:74

wait

wait<EventName extends never>(
event: EventName,
): Promise<
(SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName],
>
Type Parameters
- EventName extends never
Parameters
- event: EventName
Returns Promise<(SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName]>
Inherited from SabotagableSystem.wait
- Defined in packages/events/lib/EventEmitter.ts:111
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from SabotagableSystem.wait
- Defined in packages/events/lib/EventEmitter.ts:114

waitf

waitf<EventName extends never>(
    event: EventName,
    filter: (
        ev: (SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName],
    ) => boolean | Promise<boolean>,
): Promise<
    (SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName],
>
Type Parameters
- EventName extends never
Parameters
- event: EventName
- filter: (
  ev: (SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName],
  ) => boolean | Promise<boolean>
Returns Promise<(SystemEvents<RoomType> & SwitchSystemEvents<RoomType>)[EventName]>
Inherited from SabotagableSystem.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 SabotagableSystem.waitf
- Defined in packages/events/lib/EventEmitter.ts:125

Class SwitchSystem<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SwitchSystem<RoomType>

Properties

StaticalwaysFlipSwitch

StaticbrightnessChangePerTick

StaticflipChance

StaticmaxBrightness

StaticminBrightness

StaticupdateCooldownDuration

actual

brightness

expected

isDirty

ReadonlyshipStatus

ReadonlysystemType

Accessors

room

Returns RoomType

Methods

_fullyRepairWithAuth

Returns Promise<void>

_handleData

Parameters

Returns Promise<void>

_handleUpdate

Parameters

Returns Promise<void>

_sabotageWithAuth

Returns Promise<void>

canBeSabotaged

Returns this is SabotagableSystem<RoomType, SwitchSystemEvents<RoomType>>

cancelDataUpdate

Returns void

createData

Parameters

Returns undefined | BaseSystemMessage

emit

Type Parameters

Parameters

Returns Promise<Event>

emitSerial

Type Parameters

Parameters

Returns Promise<Event>

emitSync

Type Parameters

Parameters

Returns Event

fullyRepair

Returns Promise<void>

fullyRepairRequest

Returns Promise<void>

fullyRepairWithAuth

Returns Promise<void>

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

handleData

Parameters

Returns Promise<void>

handleUpdate

Parameters

Returns Promise<void>

isCritical

Returns boolean

isSabotaged

Returns boolean

off

`Static`alwaysFlipSwitch

`Static`brightnessChangePerTick

`Static`flipChance

`Static`maxBrightness

`Static`minBrightness

`Static`updateCooldownDuration

`Readonly`shipStatus

`Readonly`systemType