Class SkeldShipStatus<RoomType>

Represents a room object for the The Skeld map.

See ShipStatusEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

ShipStatus<RoomType>
- SkeldShipStatus

Constructors

constructor

new SkeldShipStatus<RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>>(
    room: RoomType,
    spawnType: SpawnType,
    netId: number,
    ownerId: number,
    flags: number,
): SkeldShipStatus<RoomType>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerId: number
- flags: number
Returns SkeldShipStatus<RoomType>
Inherited from ShipStatus.constructor
- Defined in packages/core/lib/NetworkedObject.ts:55

Properties

`Static`roomDoors

roomDoors: Partial<Record<SystemType, number[]>> = ...

components

components: NetworkedObject<RoomType, any>[]

`Readonly`flags

flags: number

initialSpawnCenter

initialSpawnCenter: Vector2 = ...

meetingSpawnCenter

meetingSpawnCenter: Vector2 = ...

`Readonly`netId

netId: number

`Readonly`ownerId

ownerId: number

pendingDataState

pendingDataState: DataState

player

player: undefined | Player<RoomType>

The player that this component belongs to.

`Readonly`room

room: RoomType

spawnRadius

spawnRadius: number = 1.55

`Readonly`spawnType

spawnType: SpawnType

systems

systems: AllSystems<RoomType> = ...

Accessors

owner

get owner(): RoomType
Returns RoomType
Inherited from ShipStatus.owner
- Defined in packages/core/lib/objects/ShipStatus.ts:95

Methods

anySystemsSabotaged

anySystemsSabotaged(): boolean
Returns boolean
Inherited from ShipStatus.anySystemsSabotaged
- Defined in packages/core/lib/objects/ShipStatus.ts:334

assignTasks

assignTasks(): Promise<void>
Randomly assign tasks to all players, using data from @skeldjs/data.

Returns Promise<void>
Inherited from ShipStatus.assignTasks
- Defined in packages/core/lib/objects/ShipStatus.ts:246

cancelDataState

cancelDataState(state: DataState): void
Parameters
- state: DataState
Returns void
Inherited from ShipStatus.cancelDataState
- Defined in packages/core/lib/NetworkedObject.ts:121

closeDoorsOfType

closeDoorsOfType(systemType: SystemType): Promise<void>
Parameters
- systemType: SystemType
Returns Promise<void>
Inherited from ShipStatus.closeDoorsOfType
- Defined in packages/core/lib/objects/ShipStatus.ts:188

closeDoorsOfTypeRequest

closeDoorsOfTypeRequest(systemType: SystemType): Promise<void>
Parameters
- systemType: SystemType
Returns Promise<void>
Inherited from ShipStatus.closeDoorsOfTypeRequest
- Defined in packages/core/lib/objects/ShipStatus.ts:175

closeDoorsOfTypeWithAuth

closeDoorsOfTypeWithAuth(systemType: SystemType): Promise<void>
Parameters
- systemType: SystemType
Returns Promise<void>
Inherited from ShipStatus.closeDoorsOfTypeWithAuth
- Defined in packages/core/lib/objects/ShipStatus.ts:169

createData

createData(state: DataState): undefined | BaseSystemMessage
Parameters
- state: DataState
Returns undefined | BaseSystemMessage
Inherited from ShipStatus.createData
- Defined in packages/core/lib/objects/ShipStatus.ts:128

emit

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

emitSerial

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

emitSync

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

getComponentSafe

getComponentSafe<T>(
index: number,
ComponentType: NetworkedObjectConstructor<T>,
): undefined | T
Get a certain component from the object.
Type Parameters
- T
Parameters
- index: number
- ComponentType: NetworkedObjectConstructor<T>
  The component class to get.
Returns undefined | T
Inherited from ShipStatus.getComponentSafe
- Defined in packages/core/lib/NetworkedObject.ts:135

getListeners

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

getSpawnPosition

getSpawnPosition(
player: number | Player<RoomType>,
initialSpawn: boolean,
): Vector2
Get the spawn position of a player whether they are about to spawn after starting or whether they are about to spawn after a meeting.
Parameters
- player: number | Player<RoomType>
  The player or player ID to determine the position of.
- initialSpawn: boolean
  Whther or not this is a spawn after starting the game.
Returns Vector2
The spawn position of the player.
Inherited from ShipStatus.getSpawnPosition
- Defined in packages/core/lib/objects/ShipStatus.ts:304

getStartWaitSeconds

getStartWaitSeconds(): number
Returns number
Overrides ShipStatus.getStartWaitSeconds
- Defined in packages/core/lib/objects/SkeldShipStatus.ts:77

getSystemSafe

getSystemSafe<T>(
systemType: SystemType,
SystemClass: SystemConstructor<T>,
): undefined | T
Type Parameters
- T
Parameters
- systemType: SystemType
- SystemClass: SystemConstructor<T>
Returns undefined | T
Inherited from ShipStatus.getSystemSafe
- Defined in packages/core/lib/objects/ShipStatus.ts:342

getTasks

getTasks(): TaskInfo[]
Get all tasks for this map.

Returns TaskInfo[]
A list of tasks for this map.
Overrides ShipStatus.getTasks
- Defined in packages/core/lib/objects/SkeldShipStatus.ts:73

handleData

handleData(data: BaseSystemMessage): Promise<void>
Parameters
- data: BaseSystemMessage
Returns Promise<void>
Inherited from ShipStatus.handleData
- Defined in packages/core/lib/objects/ShipStatus.ts:111

handleRemoteCall

handleRemoteCall(rpc: BaseRpcMessage): Promise<void>
Parameters
- rpc: BaseRpcMessage
Returns Promise<void>
Inherited from ShipStatus.handleRemoteCall
- Defined in packages/core/lib/objects/ShipStatus.ts:154

off

off<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "system.sabotage"
        | "system.repair",
>(
    event: EventName,
    listener: Listener<
        (
            NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
                RoomType,
            > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
                RoomType,
            > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
                RoomType,
            > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
                RoomType,
            > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
                RoomType,
            >
        )[EventName],
    >,
): void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "system.sabotage" | "system.repair"
Parameters
- event: EventName
- listener: Listener<
      (
          NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
              RoomType,
          > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
              RoomType,
          > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
              RoomType,
          > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
              RoomType,
          > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
              RoomType,
          >
      )[EventName],
  >
Returns void
Inherited from ShipStatus.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 ShipStatus.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

on<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "system.sabotage"
        | "system.repair",
>(
    event: EventName,
    listener: Listener<
        (
            NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
                RoomType,
            > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
                RoomType,
            > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
                RoomType,
            > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
                RoomType,
            > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
                RoomType,
            >
        )[EventName],
    >,
): () => void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "system.sabotage" | "system.repair"
Parameters
- event: EventName
- listener: Listener<
      (
          NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
              RoomType,
          > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
              RoomType,
          > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
              RoomType,
          > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
              RoomType,
          > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
              RoomType,
          >
      )[EventName],
  >
Returns () => void
Inherited from ShipStatus.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 ShipStatus.on
- Defined in packages/events/lib/EventEmitter.ts:90

once

once<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "system.sabotage"
        | "system.repair",
>(
    event: EventName,
    listener: Listener<
        (
            NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
                RoomType,
            > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
                RoomType,
            > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
                RoomType,
            > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
                RoomType,
            > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
                RoomType,
            >
        )[EventName],
    >,
): () => void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "system.sabotage" | "system.repair"
Parameters
- event: EventName
- listener: Listener<
      (
          NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
              RoomType,
          > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
              RoomType,
          > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
              RoomType,
          > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
              RoomType,
          > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
              RoomType,
          >
      )[EventName],
  >
Returns () => void
Inherited from ShipStatus.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 ShipStatus.once
- Defined in packages/events/lib/EventEmitter.ts:102

parseData

parseData(state: DataState, reader: HazelReader): undefined | BaseSystemMessage
Parameters
- state: DataState
- reader: HazelReader
Returns undefined | BaseSystemMessage
Inherited from ShipStatus.parseData
- Defined in packages/core/lib/objects/ShipStatus.ts:103

parseRemoteCall

parseRemoteCall(
rpcTag: RpcMessageTag,
reader: HazelReader,
): undefined | BaseRpcMessage
Parameters
- rpcTag: RpcMessageTag
- reader: HazelReader
Returns undefined | BaseRpcMessage
Inherited from ShipStatus.parseRemoteCall
- Defined in packages/core/lib/objects/ShipStatus.ts:147

positionPlayerAtSpawn

positionPlayerAtSpawn(
    player: Player<RoomType>,
    initialSpawn: boolean,
    broadcast: boolean,
): Promise<void>
Teleport a player to their spawn position, calculated using ShipStatus.getSpawnPosition.
Parameters
- player: Player<RoomType>
  The player to determine the position of.
- initialSpawn: boolean
  Whether or not this is a spawn after starting the game.
- broadcast: boolean
  Whether or not to broadcast the updates.
Returns Promise<void>
Inherited from ShipStatus.positionPlayerAtSpawn
- Defined in packages/core/lib/objects/ShipStatus.ts:325

processAwake

processAwake(): Promise<void>
Returns Promise<void>
Inherited from ShipStatus.processAwake
- Defined in packages/core/lib/objects/ShipStatus.ts:99

processFixedUpdate

processFixedUpdate(deltaSeconds: number): Promise<void>
Parameters
- deltaSeconds: number
Returns Promise<void>
Inherited from ShipStatus.processFixedUpdate
- Defined in packages/core/lib/objects/ShipStatus.ts:159

pushDataState

pushDataState(state: DataState): void
Parameters
- state: DataState
Returns void
Inherited from ShipStatus.pushDataState
- Defined in packages/core/lib/NetworkedObject.ts:115

removeAllListeners

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

removeListeners

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

repairAllSystemsWithAuth

repairAllSystemsWithAuth(): Promise<void>
Returns Promise<void>
Inherited from ShipStatus.repairAllSystemsWithAuth
- Defined in packages/core/lib/objects/ShipStatus.ts:356

repairCriticalSystemsWithAuth

repairCriticalSystemsWithAuth(): Promise<void>
Returns Promise<void>
Inherited from ShipStatus.repairCriticalSystemsWithAuth
- Defined in packages/core/lib/objects/ShipStatus.ts:348

resetDataState

resetDataState(): void
Returns void
Inherited from ShipStatus.resetDataState
- Defined in packages/core/lib/NetworkedObject.ts:127

setupSystems

setupSystems(): Promise<void>
Returns Promise<void>
Overrides ShipStatus.setupSystems
- Defined in packages/core/lib/objects/SkeldShipStatus.ts:41

wait

wait<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "system.sabotage"
        | "system.repair",
>(
    event: EventName,
): Promise<
    (
        NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
            RoomType,
        > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
            RoomType,
        > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
            RoomType,
        > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
            RoomType,
        > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
            RoomType,
        >
    )[EventName],
>
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "system.sabotage" | "system.repair"
Parameters
- event: EventName
Returns Promise<
    (
        NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
            RoomType,
        > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
            RoomType,
        > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
            RoomType,
        > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
            RoomType,
        > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
            RoomType,
        >
    )[EventName],
>
Inherited from ShipStatus.wait
- Defined in packages/events/lib/EventEmitter.ts:111
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from ShipStatus.wait
- Defined in packages/events/lib/EventEmitter.ts:114

waitf

waitf<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "system.sabotage"
        | "system.repair",
>(
    event: EventName,
    filter: (
        ev: (
            NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
                RoomType,
            > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
                RoomType,
            > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
                RoomType,
            > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
                RoomType,
            > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
                RoomType,
            >
        )[EventName],
    ) => boolean
    | Promise<boolean>,
): Promise<
    (
        NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
            RoomType,
        > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
            RoomType,
        > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
            RoomType,
        > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
            RoomType,
        > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
            RoomType,
        >
    )[EventName],
>
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "system.sabotage" | "system.repair"
Parameters
- event: EventName
- filter: (
      ev: (
          NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
              RoomType,
          > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
              RoomType,
          > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
              RoomType,
          > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
              RoomType,
          > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
              RoomType,
          >
      )[EventName],
  ) => boolean
  | Promise<boolean>
Returns Promise<
    (
        NetworkedObjectEvents<RoomType> & SystemEvents<RoomType> & SabotagableSystemEvents<
            RoomType,
        > & DoorEvents<RoomType> & ExtractEventTypes<[]> & DeconSystemEvents<
            RoomType,
        > & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<
            RoomType,
        > & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<
            RoomType,
        > & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<
            RoomType,
        >
    )[EventName],
>
Inherited from ShipStatus.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 ShipStatus.waitf
- Defined in packages/events/lib/EventEmitter.ts:125

Class SkeldShipStatus<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SkeldShipStatus<RoomType>

Properties

StaticroomDoors

components

Readonlyflags

initialSpawnCenter

meetingSpawnCenter

ReadonlynetId

ReadonlyownerId

pendingDataState

player

Readonlyroom

spawnRadius

ReadonlyspawnType

systems

Accessors

owner

Returns RoomType

Methods

anySystemsSabotaged

Returns boolean

assignTasks

Returns Promise<void>

cancelDataState

Parameters

Returns void

closeDoorsOfType

Parameters

Returns Promise<void>

closeDoorsOfTypeRequest

Parameters

Returns Promise<void>

closeDoorsOfTypeWithAuth

Parameters

Returns Promise<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

getComponentSafe

Type Parameters

Parameters

Returns undefined | T

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

getSpawnPosition

Parameters

Returns Vector2

getStartWaitSeconds

Returns number

getSystemSafe

Type Parameters

Parameters

Returns undefined | T

getTasks

`Static`roomDoors

`Readonly`flags

`Readonly`netId

`Readonly`ownerId

`Readonly`room

`Readonly`spawnType