Class Door<RoomType>

Represents a manual door for the DoorsSystem or ElectricalDoorsSystem.

See DoorEvents for events to listen to.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

EventEmitter<DoorEvents>
- Door
  - AutoOpenDoor

Index

Methods

Deserialize

Deserialize(reader: HazelReader, spawn: boolean): void
Parameters
- reader: HazelReader
- spawn: boolean
Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:23

Serialize

Serialize(writer: HazelWriter, spawn: boolean): void
Parameters
- writer: HazelWriter
- spawn: boolean
Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:24

close

close(): Promise<void>
Force the door to close.

Returns Promise<void>
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:33

emit

emit<Event>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>
Overrides EventEmitter.emit
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:20

emitSerial

emitSerial<Event>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>
Overrides EventEmitter.emitSerial
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:21

emitSync

emitSync<Event>(event: Event): Event
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Event
Overrides EventEmitter.emitSync
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:22

getListeners

getListeners<Event>(event: string): Listener<Event>[]
Type Parameters
- Event extends BasicEvent<Event> = BasicEvent
Parameters
- event: string
Returns Listener<Event>[]
Inherited from EventEmitter.getListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:32

off

off<EventName>(event: EventName, listener: Listener<DoorEvents<Hostable<any>>[EventName]>): void
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
- listener: Listener<DoorEvents<Hostable<any>>[EventName]>
Returns void
Inherited from EventEmitter.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 EventEmitter.off
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:31

on

on<EventName>(event: EventName, listener: Listener<DoorEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
- listener: Listener<DoorEvents<Hostable<any>>[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventEmitter.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 EventEmitter.on
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:23

once

once<EventName>(event: EventName, listener: Listener<DoorEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
- listener: Listener<DoorEvents<Hostable<any>>[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventEmitter.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 EventEmitter.once
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:25

open

open(): Promise<void>
Force the door open.

Returns Promise<void>
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:29

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from EventEmitter.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 EventEmitter.removeListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:33

setOpen

setOpen(isOpen: boolean): Promise<void>
Parameters
- isOpen: boolean
Returns Promise<void>
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:25

wait

wait<EventName>(event: EventName): Promise<DoorEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
Returns Promise<DoorEvents<Hostable<any>>[EventName]>
Inherited from EventEmitter.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 EventEmitter.wait
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:27

waitf

waitf<EventName>(event: EventName, filter: ((ev: DoorEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)): Promise<DoorEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
- filter: ((ev: DoorEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)
  - - (ev: DoorEvents<Hostable<any>>[EventName]): boolean | Promise<boolean>
    - Parameters
      
      ev: DoorEvents<Hostable<any>>[EventName]
      
      Returns boolean | Promise<boolean>
Returns Promise<DoorEvents<Hostable<any>>[EventName]>
Inherited from EventEmitter.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 EventEmitter.waitf
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:29

Constructors

constructor

new Door<RoomType>(system: AutoDoorsSystem<RoomType> | DoorsSystem<RoomType> | ElectricalDoorsSystem<RoomType>, doorId: number, isOpen: boolean): Door<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- system: AutoDoorsSystem<RoomType> | DoorsSystem<RoomType> | ElectricalDoorsSystem<RoomType>
- doorId: number
- isOpen: boolean
Returns Door<RoomType>
Overrides EventEmitter<DoorEvents>.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/misc/Door.d.ts:19

Properties

`Readonly` doorId

doorId: number

isOpen

isOpen: boolean

Class Door<RoomType>

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

Index

Methods

Constructors

Properties

Methods

Deserialize

Parameters

reader: HazelReader

spawn: boolean

Returns void

Serialize

Parameters

writer: HazelWriter

spawn: boolean

Returns void

close

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>[]

off

Type Parameters

EventName extends "doors.open" | "doors.close"

Parameters

event: EventName

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

Returns void

Type Parameters

K extends BasicEvent<K>

Parameters

event: string

listener: Listener<K>

Returns void

on

Type Parameters

EventName extends "doors.open" | "doors.close"

Parameters

event: EventName

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

Returns (() => void)

Returns void

Type Parameters

K extends BasicEvent<K>

Parameters

event: string

listener: Listener<K>

Returns (() => void)

Returns void

once

Type Parameters

EventName extends "doors.open" | "doors.close"

Parameters

event: EventName

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

Returns (() => void)

`Readonly` doorId