Class PlayerCheckColorEvent<RoomType>

Emitted when a player requests to have their color set. Only emitted if the client is the host.

Type Parameters

Hierarchy

  • CancelableEvent
    • PlayerCheckColorEvent

Implements

Properties

eventName alteredColor canceled eventName message originalColor player room

Methods

cancel setColor

Constructors

constructor

Properties

Static eventName

eventName: "player.checkcolor"

alteredColor

alteredColor: Color

The altered color, i.e. the original color was taken.

canceled

canceled: boolean

eventName

eventName: "player.checkcolor"

Readonly message

message: undefined | CheckColorMessage

The message that this event originated from.

Readonly originalColor

originalColor: Color

The original color that the player asked for.

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.

Methods

cancel

  • Returns void

setColor

  • Change the altered color for the player to have set.

    Parameters

    • color: Color

      The color to set.

    Returns void

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | CheckColorMessage
    • originalColor: Color

      The original color that the player asked for.

    • alteredColor: Color

      The altered color, i.e. the original color was taken.

    Returns PlayerCheckColorEvent<RoomType>

Settings

Member Visibility

Theme

Generated using TypeDoc