Class DoorsDoorCloseEvent<RoomType>

Emitted when a player closes a specific door.

Type Parameters

Hierarchy

  • RevertableEvent
    • DoorsDoorCloseEvent

Implements

Properties

eventName door doorsystem eventName message player reverted room

Accessors

alteredDoor

Constructors

constructor

Methods

revert setDoor

Properties

Static eventName

eventName: "doors.close"

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 | PlayerData<RoomType>

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

reverted

reverted: boolean

Readonly room

room: RoomType

The room or client that the event came from.

Accessors

alteredDoor

  • get alteredDoor(): Door<RoomType>

  • The alternate door that will be closed, if changed.

    Returns Door<RoomType>

Constructors

constructor

Methods

revert

  • Returns void

setDoor

  • Change the door that was closed.

    Parameters

    • door: number | Door<RoomType>

      The door to close.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc