Class AutoOpenDoor<RoomType>

Represents an auto opening door for the AutoDoorsSystem.

See DoorEvents for events to listen to.

Type parameters

RoomType: Hostable

Hierarchy

Door
- AutoOpenDoor

Index

Methods

Constructors

constructor

Properties

Methods

Deserialize

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

Inherited from Door.Deserialize
- Defined in core/lib/misc/Door.ts:55
Parameters
- reader: HazelReader
- spawn: boolean
Returns void

DoUpdate

DoUpdate(delta: number): boolean

- Defined in core/lib/misc/AutoOpenDoor.ts:23
Parameters
- delta: number
Returns boolean

Serialize

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

Inherited from Door.Serialize
- Defined in core/lib/misc/Door.ts:60
Parameters
- writer: HazelWriter
- spawn: boolean
Returns void

close

close(): Promise<void>

Inherited from Door.close
- Defined in core/lib/misc/Door.ts:85
Force the door to close.

Returns Promise<void>

emit

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

Inherited from Door.emit
- Defined in core/lib/misc/Door.ts:30
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSerial

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

Inherited from Door.emitSerial
- Defined in core/lib/misc/Door.ts:38
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSync

emitSync<Event>(event: Event): Event

Inherited from Door.emitSync
- Defined in core/lib/misc/Door.ts:46
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Event

getListeners

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

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

off

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

Inherited from Door.off
- Defined in events/lib/EventEmitter.ts:125
Type parameters
- EventName: "doors.open" | "doors.close"
Parameters
- event: EventName
- listener: Listener<DoorEvents<Hostable<any>>[EventName]>
Returns void
Inherited from Door.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<DoorEvents<Hostable<any>>[EventName]>): () => void
on<K>(event: string, listener: Listener<K>): () => void

Inherited from Door.on
- Defined in events/lib/EventEmitter.ts:74
Type parameters
- EventName: "doors.open" | "doors.close"
Parameters
- event: EventName
- listener: Listener<DoorEvents<Hostable<any>>[EventName]>
Returns () => void
- - (): void
  - Returns void
Inherited from Door.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<DoorEvents<Hostable<any>>[EventName]>): () => void
once<K>(event: string, listener: Listener<K>): () => void

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

open

open(): Promise<void>

Inherited from Door.open
- Defined in core/lib/misc/Door.ts:78
Force the door open.

Returns Promise<void>

removeAllListeners

removeAllListeners(): void

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

removeListeners

removeListeners(event: string): void

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

setOpen

setOpen(isOpen: boolean): Promise<void>

Inherited from Door.setOpen
- Defined in core/lib/misc/Door.ts:64
Parameters
- isOpen: boolean
Returns Promise<void>

wait

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

Inherited from Door.wait
- Defined in events/lib/EventEmitter.ts:99
Type parameters
- EventName: "doors.open" | "doors.close"
Parameters
- event: EventName
Returns Promise<DoorEvents<Hostable<any>>[EventName]>
Inherited from Door.wait
- Defined in events/lib/EventEmitter.ts:102
Parameters
- event: string
Returns Promise<BasicEvent>

waitf

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

Inherited from Door.waitf
- Defined in events/lib/EventEmitter.ts:109
Type parameters
- EventName: "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 Door.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 AutoOpenDoor<RoomType>(system: AutoDoorsSystem<RoomType>, doorId: number, isOpen: boolean): AutoOpenDoor<RoomType>

Overrides Door.constructor
- Defined in core/lib/misc/AutoOpenDoor.ts:13
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- system: AutoDoorsSystem<RoomType>
- doorId: number
- isOpen: boolean
Returns AutoOpenDoor<RoomType>

Properties

Readonly doorId

doorId: number

isOpen

isOpen: boolean

timer

timer: number

Generated using TypeDoc