Class PlayerSetColorEvent<RoomType>

constructor

• new PlayerSetColorEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SetColorMessage,
      oldColor: Color,
      newColor: Color,
  ): PlayerSetColorEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | SetColorMessage
  • oldColor: Color

    The color that the player had before.

  • newColor: Color

    The new color that the player has.

  Returns PlayerSetColorEvent<RoomType>

eventName

Readonlymessage

ReadonlynewColor

ReadonlyoldColor

Readonlyplayer

Readonlyroom

StaticeventName

alteredColor

• get alteredColor(): Color

  The altered color that the player will have set instead, if changed.

  Returns Color

revert

• revert(): void

  Revert the player's color back to their old color.

  Returns void

setColor

• setColor(color: Color): void

  Change the color that the player had set.

  Parameters

  • color: Color

    The color to set.

  Returns void