Class O2ConsolesCompleteEvent<RoomType>

Emitted when a oxygen console is completed.

Type parameters

RoomType: Hostable

Hierarchy

RevertableEvent
- O2ConsolesCompleteEvent

Implements

Index

Properties

Accessors

alteredConsoleId

Constructors

constructor

Methods

Properties

Static eventName

eventName: "o2.consoles.complete" = ...

Readonly consoleId

consoleId: number

eventName

eventName: "o2.consoles.complete" = ...

Readonly message

message: undefined | RepairSystemMessage

The message that this event originated from.

Readonly oxygen

oxygen: LifeSuppSystem<RoomType>

The oxygen system that this event is for.

Readonly player

player: undefined | PlayerData<RoomType>

reverted

reverted: boolean

Readonly room

room: RoomType

The room or client that the event came from.

Accessors

alteredConsoleId

get alteredConsoleId(): number

- Defined in core/lib/events/oxygen/ConsoleComplete.ts:40
The ID of the altered console that will be completed instead, if changed.

Returns number

Constructors

constructor

new O2ConsolesCompleteEvent<RoomType>(room: RoomType, oxygen: LifeSuppSystem<RoomType>, message: undefined | RepairSystemMessage, player: undefined | PlayerData<RoomType>, consoleId: number): O2ConsolesCompleteEvent<RoomType>

Overrides RevertableEvent.constructor
- Defined in core/lib/events/oxygen/ConsoleComplete.ts:19
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- oxygen: LifeSuppSystem<RoomType>
- message: undefined | RepairSystemMessage
- player: undefined | PlayerData<RoomType>
- consoleId: number
Returns O2ConsolesCompleteEvent<RoomType>

Methods

revert

revert(): void

Inherited from RevertableEvent.revert
- Defined in events/lib/RevertableEvent.ts:12
Returns void

setConsole

setConsole(consoleId: number): void

- Defined in core/lib/events/oxygen/ConsoleComplete.ts:48
Change the console that was completed.

Parameters
- consoleId: number
  
  The ID of the console to complete.
Returns void

Generated using TypeDoc