Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AutoDoorsSystem<RoomType>

Represents a system for doors that open after a period of time.

See AutoDoorsSystemEvents for events to listen to.

Type parameters

  • RoomType: Hostable

Hierarchy

Index

Methods

Constructors

Accessors

Properties

Methods

Deserialize

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

Detoriorate

  • Detoriorate(delta: number): void

HandleRepair

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

HandleSabotage

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

Serialize

closeDoor

  • closeDoor(doorId: number): Promise<void>

  • Close a door by its ID. This is a host operation on official servers.

    Parameters

    • doorId: number

      The ID of the door to close.

    Returns Promise<void>

emit

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

emitSerial

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

emitSync

  • emitSync<Event>(event: Event): Event

getListeners

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

off

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

on

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

  • Type parameters

    • EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair"

    Parameters

    Returns () => void

      • (): void

      • Returns void

  • Type parameters

    Parameters

    • event: string
    • listener: Listener<K>

    Returns () => void

      • (): void

      • Returns void

once

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

  • Type parameters

    • EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair"

    Parameters

    Returns () => void

      • (): void

      • Returns void

  • Type parameters

    Parameters

    • event: string
    • listener: Listener<K>

    Returns () => void

      • (): void

      • Returns void

openDoor

  • openDoor(doorId: number): Promise<void>

  • Open a door by its ID. This is a host operation on official servers.

    Parameters

    • doorId: number

      The ID of the door to open.

    Returns Promise<void>

removeAllListeners

  • removeAllListeners(): void

removeListeners

  • removeListeners(event: string): void

repair

  • repair(): Promise<void>

sabotage

  • sabotage(): Promise<void>

wait

waitf

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

  • Type parameters

    • EventName: "doors.open" | "doors.close" | "system.sabotage" | "system.repair"

    Parameters

    Returns Promise<AutoDoorsSystemEvents<Hostable<any>>[EventName]>

  • Type parameters

    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

Accessors

dirty

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

room

  • get room(): RoomType

sabotaged

  • get sabotaged(): boolean

Properties

dirtyBit

dirtyBit: number

The dirty doors to be updated on the next fixed update.

doors

doors: AutoOpenDoor<RoomType>[]

The doors in the map.

systemType

systemType: SystemType

Generated using TypeDoc