Class AutoDoorsSystem<RoomType>

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

See AutoDoorsSystemEvents for events to listen to.

Type Parameters

Hierarchy

Methods

  • Parameters

    Returns void

  • Parameters

    • delta: number

    Returns void

  • Parameters

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

  • Type Parameters

    • Event extends BasicEvent<Event>

    Parameters

    • event: Event

    Returns Promise<Event>

  • Type Parameters

    • Event extends BasicEvent<Event>

    Parameters

    • event: Event

    Returns Promise<Event>

  • Type Parameters

    • Event extends BasicEvent<Event>

    Parameters

    • event: Event

    Returns Event

  • Type Parameters

    • Event extends BasicEvent<Event> = BasicEvent

    Parameters

    • event: string

    Returns Listener<Event>[]

  • Type Parameters

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

    Parameters

    Returns void

  • Type Parameters

    • K extends BasicEvent<K>

    Parameters

    • event: string
    • listener: Listener<K>

    Returns void

  • Type Parameters

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

    Parameters

    Returns (() => void)

      • (): void
      • Returns void

  • Type Parameters

    • K extends BasicEvent<K>

    Parameters

    • event: string
    • listener: Listener<K>

    Returns (() => void)

      • (): void
      • Returns void

  • Type Parameters

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

    Parameters

    Returns (() => void)

      • (): void
      • Returns void

  • Type Parameters

    • K extends BasicEvent<K>

    Parameters

    • event: string
    • listener: Listener<K>

    Returns (() => void)

      • (): void
      • Returns 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>

  • Returns void

  • Parameters

    • event: string

    Returns void

  • Fully repair this system.

    Returns Promise<void>

  • Sabotage this system.

    Returns Promise<void>

  • Type Parameters

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

    Parameters

    • event: EventName

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

  • Parameters

    • event: string

    Returns Promise<BasicEvent>

  • Type Parameters

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

    Parameters

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

  • 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>

Constructors

Accessors

  • get dirty(): boolean
  • Returns boolean

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

    • isDirty: boolean

    Returns void

  • get room(): RoomType
  • Return the room that this system belongs to.

    Returns RoomType

  • get sabotaged(): boolean
  • Whether or not this system is sabotaged.

    Returns boolean

Properties

dirtyBit: number

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

doors: AutoOpenDoor<RoomType>[]

The doors in the map.

systemType: SystemType

Generated using TypeDoc