MovingPlatformSystem

Represents a system for doors that must be manually opened.

See MovingPlatformSystemEvents for events to listen to.

Type parameters

RoomType: Hostable

Hierarchy

SystemStatus<MovingPlatformSystemData, MovingPlatformSystemEvents, RoomType>
- MovingPlatformSystem

Implements

MovingPlatformSystemData

Index

Methods

Constructors

constructor

Accessors

Properties

Methods

Deserialize

Deserialize(reader: HazelReader, spawn: boolean): void

Overrides SystemStatus.Deserialize
- Defined in core/lib/systems/MovingPlatformSystem.ts:70
Parameters
- reader: HazelReader
- spawn: boolean
Returns void

Detoriorate

Detoriorate(delta: number): void

Inherited from SystemStatus.Detoriorate
- Defined in core/lib/systems/SystemStatus.ts:103
Parameters
- delta: number
Returns void

HandleRepair

HandleRepair(player: undefined | PlayerData<Hostable<any>>, amount: number, rpc: undefined | RepairSystemMessage): Promise<void>

Inherited from SystemStatus.HandleRepair
- Defined in core/lib/systems/SystemStatus.ts:99
Parameters
- player: undefined | PlayerData<Hostable<any>>
- amount: number
- rpc: undefined | RepairSystemMessage
Returns Promise<void>

HandleSabotage

HandleSabotage(player: undefined | PlayerData<Hostable<any>>, rpc: undefined | RepairSystemMessage): Promise<void>

Inherited from SystemStatus.HandleSabotage
- Defined in core/lib/systems/SystemStatus.ts:107
Parameters
- player: undefined | PlayerData<Hostable<any>>
- rpc: undefined | RepairSystemMessage
Returns Promise<void>

Serialize

Serialize(writer: HazelWriter, spawn: boolean): void

Overrides SystemStatus.Serialize
- Defined in core/lib/systems/MovingPlatformSystem.ts:98
Parameters
- writer: HazelWriter
- spawn: boolean
Returns void

emit

emit<Event>(event: Event): Promise<Event>

Inherited from SystemStatus.emit
- Defined in core/lib/systems/SystemStatus.ts:67
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSerial

emitSerial<Event>(event: Event): Promise<Event>

Inherited from SystemStatus.emitSerial
- Defined in core/lib/systems/SystemStatus.ts:75
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSync

emitSync<Event>(event: Event): Event

Inherited from SystemStatus.emitSync
- Defined in core/lib/systems/SystemStatus.ts:83
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Event

getListeners

getListeners<Event>(event: string): Listener<Event>[]

Inherited from SystemStatus.getListeners
- Defined in events/lib/EventEmitter.ts:138
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: string
Returns Listener<Event>[]

getOn

getOn(): Promise<void>

- Defined in core/lib/systems/MovingPlatformSystem.ts:170
Get on the moving platform as the client's player.

Returns Promise<void>

off

off<EventName>(event: EventName, listener: Listener<MovingPlatformSystemEvents<Hostable<any>>[EventName]>): void
off<K>(event: string, listener: Listener<K>): void

Inherited from SystemStatus.off
- Defined in events/lib/EventEmitter.ts:125
Type parameters
- EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "movingplatform.updateplayer"
Parameters
- event: EventName
- listener: Listener<MovingPlatformSystemEvents<Hostable<any>>[EventName]>
Returns void
Inherited from SystemStatus.off
- Defined in events/lib/EventEmitter.ts:129
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns void

on

on<EventName>(event: EventName, listener: Listener<MovingPlatformSystemEvents<Hostable<any>>[EventName]>): () => void
on<K>(event: string, listener: Listener<K>): () => void

Inherited from SystemStatus.on
- Defined in events/lib/EventEmitter.ts:74
Type parameters
- EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "movingplatform.updateplayer"
Parameters
- event: EventName
- listener: Listener<MovingPlatformSystemEvents<Hostable<any>>[EventName]>
Returns () => void
- - (): void
  - Returns void
Inherited from SystemStatus.on
- Defined in events/lib/EventEmitter.ts:78
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns () => void
- - (): void
  - Returns void

once

once<EventName>(event: EventName, listener: Listener<MovingPlatformSystemEvents<Hostable<any>>[EventName]>): () => void
once<K>(event: string, listener: Listener<K>): () => void

Inherited from SystemStatus.once
- Defined in events/lib/EventEmitter.ts:86
Type parameters
- EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "movingplatform.updateplayer"
Parameters
- event: EventName
- listener: Listener<MovingPlatformSystemEvents<Hostable<any>>[EventName]>
Returns () => void
- - (): void
  - Returns void
Inherited from SystemStatus.once
- Defined in events/lib/EventEmitter.ts:90
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns () => void
- - (): void
  - Returns void

removeAllListeners

removeAllListeners(): void

Inherited from SystemStatus.removeAllListeners
- Defined in events/lib/EventEmitter.ts:152
Returns void

removeListeners

removeListeners(event: string): void

Inherited from SystemStatus.removeListeners
- Defined in events/lib/EventEmitter.ts:147
Parameters
- event: string
Returns void

repair

repair(): Promise<void>

Inherited from SystemStatus.repair
- Defined in core/lib/systems/SystemStatus.ts:114
Fully repair this system.

Returns Promise<void>

sabotage

sabotage(): Promise<void>

Inherited from SystemStatus.sabotage
- Defined in core/lib/systems/SystemStatus.ts:119
Sabotage this system.

Returns Promise<void>

setSide

setSide(side: MovingPlatformSide): void

- Defined in core/lib/systems/MovingPlatformSystem.ts:177
Parameters
- side: MovingPlatformSide
Returns void

setTarget

setTarget(player: PlayerDataResolvable, side: MovingPlatformSide, sendRpc: boolean): Promise<void>

- Defined in core/lib/systems/MovingPlatformSystem.ts:143
Update the target of the moving platform.

Parameters
- player: PlayerDataResolvable
  
  The player to set.
- side: MovingPlatformSide
  
  The direction to move the moving platform in.
- sendRpc: boolean
Returns Promise<void>

wait

wait<EventName>(event: EventName): Promise<MovingPlatformSystemEvents<Hostable<any>>[EventName]>
wait(event: string): Promise<BasicEvent>

Inherited from SystemStatus.wait
- Defined in events/lib/EventEmitter.ts:99
Type parameters
- EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "movingplatform.updateplayer"
Parameters
- event: EventName
Returns Promise<MovingPlatformSystemEvents<Hostable<any>>[EventName]>
Inherited from SystemStatus.wait
- Defined in events/lib/EventEmitter.ts:102
Parameters
- event: string
Returns Promise<BasicEvent>

waitf

waitf<EventName>(event: EventName, filter: (ev: MovingPlatformSystemEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>): Promise<MovingPlatformSystemEvents<Hostable<any>>[EventName]>
waitf<K>(event: string, filter: (ev: K) => boolean | Promise<boolean>): Promise<BasicEvent>

Inherited from SystemStatus.waitf
- Defined in events/lib/EventEmitter.ts:109
Type parameters
- EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "movingplatform.updateplayer"
Parameters
- event: EventName
- filter: (ev: MovingPlatformSystemEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>
  - - (ev: MovingPlatformSystemEvents<Hostable<any>>[EventName]): boolean | Promise<boolean>
    - Parameters
      - ev: MovingPlatformSystemEvents<Hostable<any>>[EventName]
      Returns boolean | Promise<boolean>
Returns Promise<MovingPlatformSystemEvents<Hostable<any>>[EventName]>
Inherited from SystemStatus.waitf
- Defined in events/lib/EventEmitter.ts:113
Type parameters
- K: 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>

Constructors

constructor

new MovingPlatformSystem<RoomType>(ship: InnerShipStatus<RoomType>, systemType: SystemType, data?: HazelReader | MovingPlatformSystemData): MovingPlatformSystem<RoomType>

Overrides SystemStatus.constructor
- Defined in core/lib/systems/MovingPlatformSystem.ts:48
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- ship: InnerShipStatus<RoomType>
- systemType: SystemType
- Optional data: HazelReader | MovingPlatformSystemData
Returns MovingPlatformSystem<RoomType>

Accessors

dirty

get dirty(): boolean
set dirty(isDirty: boolean): void

- Defined in core/lib/systems/SystemStatus.ts:40
Returns boolean
- Defined in core/lib/systems/SystemStatus.ts:44
Parameters
- isDirty: boolean
Returns void

oppositeSide

get oppositeSide(): MovingPlatformSide

- Defined in core/lib/systems/MovingPlatformSystem.ts:63
The opposite side of the moving platform to move in.

Returns MovingPlatformSide

room

get room(): RoomType

- Defined in core/lib/systems/SystemStatus.ts:63
Return the room that this system belongs to.

Returns RoomType

sabotaged

get sabotaged(): boolean

- Defined in core/lib/systems/SystemStatus.ts:56
Whether or not this system is sabotaged.

Returns boolean

Properties

side

side: MovingPlatformSide

systemType

systemType: SystemType

target

target: undefined | PlayerData<RoomType>

useId

useId: number

Type parameters

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

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

emit

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSerial

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSync

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Event

getListeners

Type parameters

Event: BasicEvent<Event>

Parameters

event: string

Returns Listener<Event>[]

getOn

Returns Promise<void>

off

Type parameters

EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "movingplatform.updateplayer"

Parameters

event: EventName

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

Returns void

Type parameters

K: BasicEvent<K>

Parameters

event: string

listener: Listener<K>

Returns void

on

Type parameters

EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair" | "movingplatform.updateplayer"

Parameters

event: EventName

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