Class System<RoomType, T>`Abstract`

Type Parameters

RoomType extends StatefulRoom
T extends EventData = {}

Hierarchy (View Summary)

EventEmitter<SystemEvents<RoomType> & T>
- System

Index

Constructors

constructor

new System<
    RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
    T extends EventData = {},
>(
    shipStatus: ShipStatus<RoomType>,
    systemType: SystemType,
): System<RoomType, T>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
- T extends EventData = {}
Parameters
- shipStatus: ShipStatus<RoomType>
- systemType: SystemType
Returns System<RoomType, T>
Overrides EventEmitter.constructor
- Defined in packages/core/lib/systems/System.ts:18

Properties

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
- Defined in packages/core/lib/systems/System.ts:28

Methods

canBeSabotaged

canBeSabotaged(): this is SabotagableSystem<RoomType, T>
Returns this is SabotagableSystem<RoomType, T>
- Defined in packages/core/lib/systems/System.ts:78

cancelDataUpdate

cancelDataUpdate(): void
Returns void
- Defined in packages/core/lib/systems/System.ts:61

`Abstract`createData

createData(dataState: DataState): undefined | BaseSystemMessage
Parameters
- dataState: DataState
Returns undefined | BaseSystemMessage
- Defined in packages/core/lib/systems/System.ts:67

emit

emit<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Overrides EventEmitter.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>
Overrides EventEmitter.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
Overrides EventEmitter.emitSync
- Defined in packages/core/lib/systems/System.ts:48

getListeners

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

`Abstract`handleData

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

`Abstract`handleUpdate

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

off

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

on

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

once

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

`Abstract`parseData

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

`Abstract`parseUpdate

parseUpdate(reader: HazelReader): undefined | BaseSystemMessage
Parameters
- reader: HazelReader
Returns undefined | BaseSystemMessage
- Defined in packages/core/lib/systems/System.ts:69

`Abstract`processFixedUpdate

processFixedUpdate(deltaSeconds: number): Promise<void>
Parameters
- deltaSeconds: number
Returns Promise<void>
- Defined in packages/core/lib/systems/System.ts:72

pushDataUpdate

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

removeAllListeners

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

removeListeners

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

sendUpdateSystem

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

wait

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

waitf

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

Class System<RoomType, T>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns System<RoomType, T>

Properties

isDirty

ReadonlyshipStatus

ReadonlysystemType

Accessors

room

Returns RoomType

Methods

canBeSabotaged

Returns this is SabotagableSystem<RoomType, T>

cancelDataUpdate

Returns void

AbstractcreateData

Parameters

Returns undefined | BaseSystemMessage

emit

Type Parameters

Parameters

Returns Promise<Event>

emitSerial

Type Parameters

Parameters

Returns Promise<Event>

emitSync

Type Parameters

Parameters

Returns Event

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

AbstracthandleData

Parameters

Returns Promise<void>

AbstracthandleUpdate

Parameters

Returns Promise<void>

off

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

Type Parameters

Parameters

Returns () => void

AbstractparseData

Parameters

Returns undefined | BaseSystemMessage

AbstractparseUpdate

Parameters

Returns undefined | BaseSystemMessage

AbstractprocessFixedUpdate

Parameters

Returns Promise<void>

Class System<RoomType, T>`Abstract`

`Readonly`shipStatus

`Readonly`systemType

`Abstract`createData

`Abstract`handleData

`Abstract`handleUpdate

`Abstract`parseData

`Abstract`parseUpdate

`Abstract`processFixedUpdate