Class ElectricalSwitchFlipEvent<RoomType>

Emitted when a player flips a switch while Electrical is sabotaged.

Type Parameters

Hierarchy

  • RevertableEvent
    • ElectricalSwitchFlipEvent

Implements

Properties

eventName eventName flipped message player reverted room switchId switchsystem

Accessors

alteredFlipped alteredSwitchId

Constructors

constructor

Methods

revert setFlipped setSwitchId

Properties

Static eventName

eventName: "electrical.switchflip"

eventName

eventName: "electrical.switchflip"

Readonly flipped

flipped: boolean

Whether this switch is flipped.

Readonly message

message: undefined | RepairSystemMessage

The message that this event originated from.

Readonly player

player: undefined | PlayerData<RoomType>

The player that flipped the switch. Only available if the client is the host.

reverted

reverted: boolean

Readonly room

room: RoomType

The room or client that the event came from.

Readonly switchId

switchId: number

The ID of the switch that was flipped (from left-to-right, starting at 0).

Readonly switchsystem

switchsystem: SwitchSystem<RoomType>

The electrical system that the event is for.

Accessors

alteredFlipped

  • get alteredFlipped(): boolean

  • The alternate value of the switch, if changed.

    Returns boolean

alteredSwitchId

  • get alteredSwitchId(): number

  • The ID of the alternate switch to flip, if changed.

    Returns number

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • switchsystem: SwitchSystem<RoomType>
    • message: undefined | RepairSystemMessage
    • player: undefined | PlayerData<RoomType>

      The player that flipped the switch. Only available if the client is the host.

    • switchId: number

      The ID of the switch that was flipped (from left-to-right, starting at 0).

    • flipped: boolean

      Whether this switch is flipped.

    Returns ElectricalSwitchFlipEvent<RoomType>

Methods

revert

  • Returns void

setFlipped

  • Set whether the switch is flipped.

    Parameters

    • flipped: boolean

      Whether the switch is flipped.

    Returns void

setSwitchId

  • Change the switch that was flipped.

    Parameters

    • switchId: number

      The ID of the switch to flip (from left-to-right, starting at 0).

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc