Class Door<RoomType>

Represents a manual door for the DoorsSystem or ElectricalDoorsSystem.

See DoorEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

EventEmitter<DoorEvents<RoomType>>
- Door
  - AutoOpenDoor

Index

Constructors

constructor

new Door<RoomType extends StatefulRoom<any>>(
    system:
        | AutoDoorsSystem<RoomType>
        | DoorsSystem<RoomType>
        | ElectricalDoorsSystem<RoomType>,
    doorId: number,
    isOpen: boolean,
): Door<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- system:
      | AutoDoorsSystem<RoomType>
      | DoorsSystem<RoomType>
      | ElectricalDoorsSystem<RoomType>
- doorId: number
- isOpen: boolean
Returns Door<RoomType>
Overrides EventEmitter.constructor
- Defined in packages/core/lib/misc/Door.ts:20

Properties

`Readonly`doorId

doorId: number

isOpen

isOpen: boolean

`Protected`system

system:
    | AutoDoorsSystem<RoomType>
    | DoorsSystem<RoomType>
    | ElectricalDoorsSystem<RoomType>

Methods

deserializeFromReader

deserializeFromReader(reader: HazelReader, spawn: boolean): void
Parameters
- reader: HazelReader
- spawn: boolean
Returns void
- Defined in packages/core/lib/misc/Door.ts:55

emit

emit<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Overrides EventEmitter.emit
- Defined in packages/core/lib/misc/Door.ts:30

emitSerial

emitSerial<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Overrides EventEmitter.emitSerial
- Defined in packages/core/lib/misc/Door.ts:38

emitSync

emitSync<Event extends BasicEvent>(event: Event): Event
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Event
Overrides EventEmitter.emitSync
- Defined in packages/core/lib/misc/Door.ts:46

getListeners

getListeners<Event extends BasicEvent = BasicEvent>(
event: string,
): Listener<Event>[]
Type Parameters
- Event extends BasicEvent = BasicEvent
Parameters
- event: string
Returns Listener<Event>[]
Inherited from EventEmitter.getListeners
- Defined in packages/events/lib/EventEmitter.ts:150

off

off<EventName extends "doors.open" | "doors.close">(
event: EventName,
listener: Listener<DoorEvents<RoomType>[EventName]>,
): void
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
- listener: Listener<DoorEvents<RoomType>[EventName]>
Returns void
Inherited from EventEmitter.off
- Defined in packages/events/lib/EventEmitter.ts:137
off<K extends BasicEvent>(event: string, listener: Listener<K>): void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns void
Inherited from EventEmitter.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

on<EventName extends "doors.open" | "doors.close">(
event: EventName,
listener: Listener<DoorEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
- listener: Listener<DoorEvents<RoomType>[EventName]>
Returns () => void
Inherited from EventEmitter.on
- Defined in packages/events/lib/EventEmitter.ts:86
on<K extends BasicEvent>(event: string, listener: Listener<K>): () => void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns () => void
Inherited from EventEmitter.on
- Defined in packages/events/lib/EventEmitter.ts:90

once

once<EventName extends "doors.open" | "doors.close">(
event: EventName,
listener: Listener<DoorEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
- listener: Listener<DoorEvents<RoomType>[EventName]>
Returns () => void
Inherited from EventEmitter.once
- Defined in packages/events/lib/EventEmitter.ts:98
once<K extends BasicEvent>(event: string, listener: Listener<K>): () => void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns () => void
Inherited from EventEmitter.once
- Defined in packages/events/lib/EventEmitter.ts:102

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from EventEmitter.removeAllListeners
- Defined in packages/events/lib/EventEmitter.ts:164

removeListeners

removeListeners(event: string): void
Parameters
- event: string
Returns void
Inherited from EventEmitter.removeListeners
- Defined in packages/events/lib/EventEmitter.ts:159

serializeToWriter

serializeToWriter(writer: HazelWriter, spawn: boolean): void
Parameters
- writer: HazelWriter
- spawn: boolean
Returns void
- Defined in packages/core/lib/misc/Door.ts:60

wait

wait<EventName extends "doors.open" | "doors.close">(
event: EventName,
): Promise<DoorEvents<RoomType>[EventName]>
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
Returns Promise<DoorEvents<RoomType>[EventName]>
Inherited from EventEmitter.wait
- Defined in packages/events/lib/EventEmitter.ts:111
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from EventEmitter.wait
- Defined in packages/events/lib/EventEmitter.ts:114

waitf

waitf<EventName extends "doors.open" | "doors.close">(
event: EventName,
filter: (ev: DoorEvents<RoomType>[EventName]) => boolean | Promise<boolean>,
): Promise<DoorEvents<RoomType>[EventName]>
Type Parameters
- EventName extends "doors.open" | "doors.close"
Parameters
- event: EventName
- filter: (ev: DoorEvents<RoomType>[EventName]) => boolean | Promise<boolean>
Returns Promise<DoorEvents<RoomType>[EventName]>
Inherited from EventEmitter.waitf
- Defined in packages/events/lib/EventEmitter.ts:121
waitf<K extends BasicEvent>(
event: string,
filter: (ev: K) => boolean | Promise<boolean>,
): Promise<BasicEvent>
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- filter: (ev: K) => boolean | Promise<boolean>
Returns Promise<BasicEvent>
Inherited from EventEmitter.waitf
- Defined in packages/events/lib/EventEmitter.ts:125

Class Door<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Door<RoomType>

Properties

ReadonlydoorId

isOpen

Protectedsystem

Methods

deserializeFromReader

Parameters

Returns void

emit

Type Parameters

Parameters

Returns Promise<Event>

emitSerial

Type Parameters

Parameters

Returns Promise<Event>

emitSync

Type Parameters

Parameters

Returns Event

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

off

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

Type Parameters

Parameters

Returns () => void

removeAllListeners

Returns void

removeListeners

Parameters

Returns void

serializeToWriter

Parameters

Returns void

wait

Type Parameters

Parameters

Returns Promise<DoorEvents<RoomType>[EventName]>

Parameters

Returns Promise<BasicEvent>

waitf

Type Parameters

Parameters

Returns Promise<DoorEvents<RoomType>[EventName]>

Type Parameters

Parameters

Returns Promise<BasicEvent>

Settings

On This Page

`Readonly`doorId

`Protected`system