Class PlayerReadyEvent<RoomType>

Emitted when a player readies up to start the game.

If a player fails to ready up within a specified time, they are kicked from the game.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerReadyEvent

Implements

Properties

eventName eventName player room

Constructors

constructor

Properties

Static eventName

eventName: "player.ready"

eventName

eventName: "player.ready"

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.

Constructors

constructor

  • Type Parameters

    Parameters

    Returns PlayerReadyEvent<RoomType>

Settings

Member Visibility

Theme

Generated using TypeDoc