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)

InnerShipStatus<RoomType>
- SkeldShipStatus

Constructors

constructor

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

Properties

components

components: NetworkedObject<RoomType, any>[]

dirtyBit

dirtyBit: number = 0

The dirty state of this component.

flags

flags: number

Flags for this object, see SpawnFlag.

initialSpawnCenter

initialSpawnCenter: Vector2 = ...

meetingSpawnCenter

meetingSpawnCenter: Vector2 = ...

netId

netId: number

The net ID of this component.

ownerId

ownerId: number

The ID of the owner of this component.

`Optional`player

player?: Player<RoomType>

The player that this component belongs to.

room

room: RoomType

The room that this component belongs to.

spawnRadius

spawnRadius: number

spawnType

spawnType: SpawnType

The type of object that this component belongs to.

systems

systems: AllSystems<RoomType>

`Static`roomDoors

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

Accessors

owner

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

Methods

`Protected`_handleCloseDoorsOfType

_handleCloseDoorsOfType(rpc: CloseDoorsOfTypeMessage): Promise<void>
Parameters
- rpc: CloseDoorsOfTypeMessage
Returns Promise<void>
Inherited from InnerShipStatus._handleCloseDoorsOfType
- Defined in packages/core/lib/objects/InnerShipStatus.ts:152

`Protected`_handleRepairSystem

_handleRepairSystem(rpc: RepairSystemMessage): Promise<void>
Parameters
- rpc: RepairSystemMessage
Returns Promise<void>
Inherited from InnerShipStatus._handleRepairSystem
- Defined in packages/core/lib/objects/InnerShipStatus.ts:170

`Protected`addTasksFromList

addTasksFromList(
    start: number,
    count: number,
    tasks: number[],
    usedTaskTypes: Set<TaskType>,
    unusedTasks: TaskInfo[],
): number
Parameters
- start: number
- count: number
- tasks: number[]
- usedTaskTypes: Set<TaskType>
- unusedTasks: TaskInfo[]
Returns number
Inherited from InnerShipStatus.addTasksFromList
- Defined in packages/core/lib/objects/InnerShipStatus.ts:179

assignTasks

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

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

deserializeFromReader

deserializeFromReader(reader: HazelReader, spawn?: boolean): void
Parameters
- reader: HazelReader
- spawn: boolean = false
Returns void
Inherited from InnerShipStatus.deserializeFromReader
- Defined in packages/core/lib/objects/InnerShipStatus.ts:111

Destroy

Destroy(): void
Returns void
Inherited from InnerShipStatus.Destroy
- Defined in packages/core/lib/NetworkedObject.ts:136

emit

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

emitSerial

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

emitSync

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

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 InnerShipStatus.getComponentSafe
- Defined in packages/core/lib/NetworkedObject.ts:142

getDoorsInRoom

getDoorsInRoom(room: SystemType): number[]
Get the door IDs used to connect to a room.
Parameters
- room: SystemType
  The room to get the door IDs for.
Returns number[]
The door IDs that connect to the room.
Overrides InnerShipStatus.getDoorsInRoom
- Defined in packages/core/lib/objects/SkeldShipStatus.ts:73

getListeners

getListeners<Event extends BasicEvent = BasicEvent>(
event: string,
): Listener<Event>[]
Type Parameters
- Event extends BasicEvent = BasicEvent
Parameters
- event: string
Returns Listener<Event>[]
Inherited from InnerShipStatus.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 InnerShipStatus.getSpawnPosition
- Defined in packages/core/lib/objects/InnerShipStatus.ts:271

getTasks

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

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

handleRemoteCall

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

off

off<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "decon.doors.close"
        | "decon.doors.open"
        | "decon.enter"
        | "decon.exit"
        | "component.spawn"
        | "component.despawn"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete"
        | "heli.consoles.open"
        | "heli.consoles.reset"
        | "heli.consoles.close"
        | "heli.consoles.complete"
        | "o2.consoles.clear"
        | "o2.consoles.complete"
        | "medscan.joinqueue"
        | "medscan.leavequeue"
        | "movingplatform.updateplayer"
        | "reactor.consoles.add"
        | "reactor.consoles.remove"
        | "reactor.consoles.reset"
        | "security.cameras.join"
        | "security.cameras.leave"
        | "electrical.switchflip"
        | "room.assignroles",
>(
    event: EventName,
    listener: Listener<ShipStatusEvents<RoomType>[EventName]>,
): void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "decon.doors.close"
      | "decon.doors.open"
      | "decon.enter"
      | "decon.exit"
      | "component.spawn"
      | "component.despawn"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
      | "heli.consoles.open"
      | "heli.consoles.reset"
      | "heli.consoles.close"
      | "heli.consoles.complete"
      | "o2.consoles.clear"
      | "o2.consoles.complete"
      | "medscan.joinqueue"
      | "medscan.leavequeue"
      | "movingplatform.updateplayer"
      | "reactor.consoles.add"
      | "reactor.consoles.remove"
      | "reactor.consoles.reset"
      | "security.cameras.join"
      | "security.cameras.leave"
      | "electrical.switchflip"
      | "room.assignroles"
Parameters
- event: EventName
- listener: Listener<ShipStatusEvents<RoomType>[EventName]>
Returns void
Inherited from InnerShipStatus.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 InnerShipStatus.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

on<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "decon.doors.close"
        | "decon.doors.open"
        | "decon.enter"
        | "decon.exit"
        | "component.spawn"
        | "component.despawn"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete"
        | "heli.consoles.open"
        | "heli.consoles.reset"
        | "heli.consoles.close"
        | "heli.consoles.complete"
        | "o2.consoles.clear"
        | "o2.consoles.complete"
        | "medscan.joinqueue"
        | "medscan.leavequeue"
        | "movingplatform.updateplayer"
        | "reactor.consoles.add"
        | "reactor.consoles.remove"
        | "reactor.consoles.reset"
        | "security.cameras.join"
        | "security.cameras.leave"
        | "electrical.switchflip"
        | "room.assignroles",
>(
    event: EventName,
    listener: Listener<ShipStatusEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "decon.doors.close"
      | "decon.doors.open"
      | "decon.enter"
      | "decon.exit"
      | "component.spawn"
      | "component.despawn"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
      | "heli.consoles.open"
      | "heli.consoles.reset"
      | "heli.consoles.close"
      | "heli.consoles.complete"
      | "o2.consoles.clear"
      | "o2.consoles.complete"
      | "medscan.joinqueue"
      | "medscan.leavequeue"
      | "movingplatform.updateplayer"
      | "reactor.consoles.add"
      | "reactor.consoles.remove"
      | "reactor.consoles.reset"
      | "security.cameras.join"
      | "security.cameras.leave"
      | "electrical.switchflip"
      | "room.assignroles"
Parameters
- event: EventName
- listener: Listener<ShipStatusEvents<RoomType>[EventName]>
Returns () => void
Inherited from InnerShipStatus.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 InnerShipStatus.on
- Defined in packages/events/lib/EventEmitter.ts:90

once

once<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "decon.doors.close"
        | "decon.doors.open"
        | "decon.enter"
        | "decon.exit"
        | "component.spawn"
        | "component.despawn"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete"
        | "heli.consoles.open"
        | "heli.consoles.reset"
        | "heli.consoles.close"
        | "heli.consoles.complete"
        | "o2.consoles.clear"
        | "o2.consoles.complete"
        | "medscan.joinqueue"
        | "medscan.leavequeue"
        | "movingplatform.updateplayer"
        | "reactor.consoles.add"
        | "reactor.consoles.remove"
        | "reactor.consoles.reset"
        | "security.cameras.join"
        | "security.cameras.leave"
        | "electrical.switchflip"
        | "room.assignroles",
>(
    event: EventName,
    listener: Listener<ShipStatusEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "decon.doors.close"
      | "decon.doors.open"
      | "decon.enter"
      | "decon.exit"
      | "component.spawn"
      | "component.despawn"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
      | "heli.consoles.open"
      | "heli.consoles.reset"
      | "heli.consoles.close"
      | "heli.consoles.complete"
      | "o2.consoles.clear"
      | "o2.consoles.complete"
      | "medscan.joinqueue"
      | "medscan.leavequeue"
      | "movingplatform.updateplayer"
      | "reactor.consoles.add"
      | "reactor.consoles.remove"
      | "reactor.consoles.reset"
      | "security.cameras.join"
      | "security.cameras.leave"
      | "electrical.switchflip"
      | "room.assignroles"
Parameters
- event: EventName
- listener: Listener<ShipStatusEvents<RoomType>[EventName]>
Returns () => void
Inherited from InnerShipStatus.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 InnerShipStatus.once
- Defined in packages/events/lib/EventEmitter.ts:102

processAwake

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

processFixedUpdate

processFixedUpdate(delta: number): Promise<void>
Parameters
- delta: number
Returns Promise<void>
Inherited from InnerShipStatus.processFixedUpdate
- Defined in packages/core/lib/objects/InnerShipStatus.ts:164

removeAllListeners

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

removeListeners

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

serializeToWriter

serializeToWriter(writer: HazelWriter, spawn?: boolean): boolean
Parameters
- writer: HazelWriter
- spawn: boolean = false
Returns boolean
Inherited from InnerShipStatus.serializeToWriter
- Defined in packages/core/lib/objects/InnerShipStatus.ts:128

setupSystems

setupSystems(): void
Returns void
Overrides InnerShipStatus.setupSystems
- Defined in packages/core/lib/objects/SkeldShipStatus.ts:45

spawnPlayer

spawnPlayer(
    player: Player<RoomType>,
    initialSpawn: boolean,
    broadcast: boolean,
): Promise<void>
Teleport a player to their spawn position, calculated using InnerShipStatus.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 InnerShipStatus.spawnPlayer
- Defined in packages/core/lib/objects/InnerShipStatus.ts:292

wait

wait<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "decon.doors.close"
        | "decon.doors.open"
        | "decon.enter"
        | "decon.exit"
        | "component.spawn"
        | "component.despawn"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete"
        | "heli.consoles.open"
        | "heli.consoles.reset"
        | "heli.consoles.close"
        | "heli.consoles.complete"
        | "o2.consoles.clear"
        | "o2.consoles.complete"
        | "medscan.joinqueue"
        | "medscan.leavequeue"
        | "movingplatform.updateplayer"
        | "reactor.consoles.add"
        | "reactor.consoles.remove"
        | "reactor.consoles.reset"
        | "security.cameras.join"
        | "security.cameras.leave"
        | "electrical.switchflip"
        | "room.assignroles",
>(
    event: EventName,
): Promise<ShipStatusEvents<RoomType>[EventName]>
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "decon.doors.close"
      | "decon.doors.open"
      | "decon.enter"
      | "decon.exit"
      | "component.spawn"
      | "component.despawn"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
      | "heli.consoles.open"
      | "heli.consoles.reset"
      | "heli.consoles.close"
      | "heli.consoles.complete"
      | "o2.consoles.clear"
      | "o2.consoles.complete"
      | "medscan.joinqueue"
      | "medscan.leavequeue"
      | "movingplatform.updateplayer"
      | "reactor.consoles.add"
      | "reactor.consoles.remove"
      | "reactor.consoles.reset"
      | "security.cameras.join"
      | "security.cameras.leave"
      | "electrical.switchflip"
      | "room.assignroles"
Parameters
- event: EventName
Returns Promise<ShipStatusEvents<RoomType>[EventName]>
Inherited from InnerShipStatus.wait
- Defined in packages/events/lib/EventEmitter.ts:111
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from InnerShipStatus.wait
- Defined in packages/events/lib/EventEmitter.ts:114

waitf

waitf<
    EventName extends
        | "doors.open"
        | "doors.close"
        | "system.sabotage"
        | "system.repair"
        | "decon.doors.close"
        | "decon.doors.open"
        | "decon.enter"
        | "decon.exit"
        | "component.spawn"
        | "component.despawn"
        | "hqhud.consoles.reset"
        | "hqhud.consoles.open"
        | "hqhud.consoles.close"
        | "hqhud.consoles.complete"
        | "heli.consoles.open"
        | "heli.consoles.reset"
        | "heli.consoles.close"
        | "heli.consoles.complete"
        | "o2.consoles.clear"
        | "o2.consoles.complete"
        | "medscan.joinqueue"
        | "medscan.leavequeue"
        | "movingplatform.updateplayer"
        | "reactor.consoles.add"
        | "reactor.consoles.remove"
        | "reactor.consoles.reset"
        | "security.cameras.join"
        | "security.cameras.leave"
        | "electrical.switchflip"
        | "room.assignroles",
>(
    event: EventName,
    filter: (
        ev: ShipStatusEvents<RoomType>[EventName],
    ) => boolean | Promise<boolean>,
): Promise<ShipStatusEvents<RoomType>[EventName]>
Type Parameters
- EventName extends
      | "doors.open"
      | "doors.close"
      | "system.sabotage"
      | "system.repair"
      | "decon.doors.close"
      | "decon.doors.open"
      | "decon.enter"
      | "decon.exit"
      | "component.spawn"
      | "component.despawn"
      | "hqhud.consoles.reset"
      | "hqhud.consoles.open"
      | "hqhud.consoles.close"
      | "hqhud.consoles.complete"
      | "heli.consoles.open"
      | "heli.consoles.reset"
      | "heli.consoles.close"
      | "heli.consoles.complete"
      | "o2.consoles.clear"
      | "o2.consoles.complete"
      | "medscan.joinqueue"
      | "medscan.leavequeue"
      | "movingplatform.updateplayer"
      | "reactor.consoles.add"
      | "reactor.consoles.remove"
      | "reactor.consoles.reset"
      | "security.cameras.join"
      | "security.cameras.leave"
      | "electrical.switchflip"
      | "room.assignroles"
Parameters
- event: EventName
- filter: (ev: ShipStatusEvents<RoomType>[EventName]) => boolean | Promise<boolean>
Returns Promise<ShipStatusEvents<RoomType>[EventName]>
Inherited from InnerShipStatus.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 InnerShipStatus.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

components

dirtyBit

flags

initialSpawnCenter

meetingSpawnCenter

netId

ownerId

Optionalplayer

room

spawnRadius

spawnType

systems

StaticroomDoors

Accessors

owner

Returns RoomType

Methods

Protected_handleCloseDoorsOfType

Parameters

Returns Promise<void>

Protected_handleRepairSystem

Parameters

Returns Promise<void>

ProtectedaddTasksFromList

Parameters

Returns number

assignTasks

Returns Promise<void>

deserializeFromReader

Parameters

Returns void

Destroy

Returns void

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

getDoorsInRoom

Parameters

Returns number[]

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

getSpawnPosition

Parameters

Returns Vector2

getTasks

Returns TaskInfo[]

handleRemoteCall

Parameters

Returns Promise<void>

off

Type Parameters

`Optional`player

`Static`roomDoors

`Protected`_handleCloseDoorsOfType

`Protected`_handleRepairSystem

`Protected`addTasksFromList