Class SecurityCameraSystem<RoomType>

Represents a system responsible for handling players entering and leaving security cameras.

See SecurityCameraSystemEvents for events to listen to.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

SystemStatus<SecurityCameraSystemData, SecurityCameraSystemEvents, RoomType>
- SecurityCameraSystem

Implements

SecurityCameraSystemData

Index

Methods

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/SecurityCameraSystem.d.ts:26

Detoriorate

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

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/SecurityCameraSystem.d.ts:50

HandleSabotage

HandleSabotage(player: undefined | PlayerData<Hostable<any>>, rpc: undefined | RepairSystemMessage): Promise<void>
Parameters
- player: undefined | PlayerData<Hostable<any>>
- rpc: undefined | RepairSystemMessage
Returns Promise<void>
Inherited from SystemStatus.HandleSabotage
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:32

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/SecurityCameraSystem.d.ts:27

addPlayer

addPlayer(player: PlayerData<Hostable<any>>): Promise<void>
Add a player to the security cameras.

Example
```
security.addPlayer(client.me);
```
Parameters
- player: PlayerData<Hostable<any>>
  
  The player to add.
Returns Promise<void>
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SecurityCameraSystem.d.ts:37

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

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

join

join(): Promise<void>
Returns Promise<void>
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SecurityCameraSystem.d.ts:38

leave

leave(): Promise<void>
Returns Promise<void>
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SecurityCameraSystem.d.ts:49

off

off<EventName>(event: EventName, listener: Listener<SecurityCameraSystemEvents<Hostable<any>>[EventName]>): void
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "security.cameras.join" | "security.cameras.leave"
Parameters
- event: EventName
- listener: Listener<SecurityCameraSystemEvents<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<SecurityCameraSystemEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "security.cameras.join" | "security.cameras.leave"
Parameters
- event: EventName
- listener: Listener<SecurityCameraSystemEvents<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<SecurityCameraSystemEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "security.cameras.join" | "security.cameras.leave"
Parameters
- event: EventName
- listener: Listener<SecurityCameraSystemEvents<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

removePlayer

removePlayer(player: PlayerData<Hostable<any>>): Promise<void>
Remove a player from the security cameras.

Example
```
security.removePlayer(client.me);
```
Parameters
- player: PlayerData<Hostable<any>>
  
  The player to remove.
Returns Promise<void>
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SecurityCameraSystem.d.ts:48

repair

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

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

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

wait

wait<EventName>(event: EventName): Promise<SecurityCameraSystemEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "security.cameras.join" | "security.cameras.leave"
Parameters
- event: EventName
Returns Promise<SecurityCameraSystemEvents<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: SecurityCameraSystemEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)): Promise<SecurityCameraSystemEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "security.cameras.join" | "security.cameras.leave"
Parameters
- event: EventName
- filter: ((ev: SecurityCameraSystemEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)
  - - (ev: SecurityCameraSystemEvents<Hostable<any>>[EventName]): boolean | Promise<boolean>
    - Parameters
      
      ev: SecurityCameraSystemEvents<Hostable<any>>[EventName]
      
      Returns boolean | Promise<boolean>
Returns Promise<SecurityCameraSystemEvents<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

Constructors

constructor

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

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
Inherited from SystemStatus.sabotaged
- Defined in node_modules/@skeldjs/core/dist/lib/systems/SystemStatus.d.ts:20

Properties

players

players: Set<PlayerData<Hostable<any>>>

The players currently looking at cameras.

systemType

systemType: SystemType

Class SecurityCameraSystem<RoomType>

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

Implements

Index

Methods

Constructors

Accessors

Properties

Methods

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<Hostable<any>>

rpc: undefined | RepairSystemMessage

Returns Promise<void>

Serialize

Parameters

writer: HazelWriter

spawn: boolean

Returns void

addPlayer

Example

Parameters

player: PlayerData<Hostable<any>>

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

getListeners

Type Parameters

Event extends BasicEvent<Event> = BasicEvent

Parameters

event: string

Returns Listener<Event>[]

join

Returns Promise<void>

leave

Returns Promise<void>

off

Type Parameters

EventName extends "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "security.cameras.join" | "security.cameras.leave"

Parameters

event: EventName

listener: Listener<SecurityCameraSystemEvents<Hostable<any>>[EventName]>

Returns void

Type Parameters

K extends BasicEvent<K>

Parameters

event: string