Class PlayerSetStartCounterEvent<RoomType>

Emitted when a player (i.e. the host of the room) sets the starting counter located above the game code while in the lobby.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetStartCounterEvent

Implements

Properties

eventName eventName message newCounter oldCounter player room

Accessors

alteredCounter

Constructors

constructor

Methods

revert setCounter

Properties

Static eventName

eventName: "player.setstartcounter"

eventName

eventName: "player.setstartcounter"

Readonly message

message: undefined | SetStartCounterMessage

The message that this event originated from.

Readonly newCounter

newCounter: number

The new value of the counter.

Readonly oldCounter

oldCounter: number

The old value of the counter.

Readonly player

player: PlayerData<RoomType>

The player that this event is for.

Readonly room

room: RoomType

The room or client that the event came from.

Accessors

alteredCounter

  • get alteredCounter(): number

  • The altered value of the counter that will be set instead, if changed,

    Returns number

Constructors

constructor

Methods

revert

  • Revert the counter to its old value.

    Returns void

setCounter

  • Change the value of the counter that was set.

    Parameters

    • counter: number

      The value of the counter to set.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc