Class ElectricalSwitchFlipEvent<RoomType>

constructor

• new ElectricalSwitchFlipEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      switchsystem: SwitchSystem<RoomType>,
      message: undefined | RepairSystemMessage,
      player: undefined | Player<RoomType>,
      switchId: number,
      flipped: boolean,
  ): ElectricalSwitchFlipEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

  • room: RoomType
  • switchsystem: SwitchSystem<RoomType>
  • message: undefined | RepairSystemMessage
  • player: undefined | Player<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>

eventName

Readonlyflipped

Readonlymessage

Readonlyplayer

Readonlyroom

ReadonlyswitchId

Readonlyswitchsystem

StaticeventName

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

setFlipped

• setFlipped(flipped: boolean): void

  Set whether the switch is flipped.

  Parameters

  • flipped: boolean

    Whether the switch is flipped.

  Returns void

setSwitchId

• setSwitchId(switchId: number): void

  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