Class DoorsDoorCloseEvent<RoomType>

Emitted when a player closes a specific door.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

RevertableEvent
- DoorsDoorCloseEvent

Implements

Index

Constructors

Properties

door doorsystem eventName message player reverted room eventName

Accessors

Methods

Constructors

constructor

new DoorsDoorCloseEvent<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    doorsystem:
        | AutoDoorsSystem<RoomType>
        | DoorsSystem<RoomType>
        | ElectricalDoorsSystem<RoomType>,
    message: undefined | RepairSystemMessage,
    player: undefined | Player<RoomType>,
    door: Door<RoomType>,
): DoorsDoorCloseEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- doorsystem:
      | AutoDoorsSystem<RoomType>
      | DoorsSystem<RoomType>
      | ElectricalDoorsSystem<RoomType>
- message: undefined | RepairSystemMessage
- player: undefined | Player<RoomType>
  The player that closed the door. Only available if the client is the host.
- door: Door<RoomType>
  The door that the player closed.
Returns DoorsDoorCloseEvent<RoomType>
Overrides RevertableEvent.constructor
- Defined in packages/core/lib/events/doors/Close.ts:21

Properties

`Readonly`door

door: Door<RoomType>

The door that the player closed.

`Readonly`doorsystem

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

The door system that the door is in.

eventName

eventName: "doors.close" = ...

`Readonly`message

message: undefined | RepairSystemMessage

The message that this event originated from.

`Readonly`player

player: undefined | Player<RoomType>

The player that closed the door. Only available if the client is the host.

reverted

reverted: boolean

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "doors.close" = ...

Accessors

alteredDoor

get alteredDoor(): Door<RoomType>
The alternate door that will be closed, if changed.

Returns Door<RoomType>
- Defined in packages/core/lib/events/doors/Close.ts:43

Methods

revert

revert(): void
Returns void
Inherited from RevertableEvent.revert
- Defined in packages/events/lib/RevertableEvent.ts:12

setDoor

setDoor(door: number | Door<RoomType>): void
Change the door that was closed.
Parameters
- door: number | Door<RoomType>
  The door to close.
Returns void
- Defined in packages/core/lib/events/doors/Close.ts:51