Class PlayerSetColorEvent<RoomType>

Emitted when a player has their player color updated.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

BasicEvent
- PlayerSetColorEvent

Implements

Index

Properties

eventName eventName message newColor oldColor player room

Accessors

Constructors

Methods

revert setColor

Properties

`Static` eventName

eventName: "player.setcolor"

eventName

eventName: "player.setcolor"

`Readonly` message

message: undefined | SetColorMessage

The message that this event originated from.

`Readonly` newColor

newColor: Color

The new color that the player has.

`Readonly` oldColor

oldColor: Color

The color that the player had before.

`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

alteredColor

get alteredColor(): Color
The altered color that the player will have set instead, if changed.

Returns Color
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/SetColor.d.ts:39

Constructors

constructor

new PlayerSetColorEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SetColorMessage, oldColor: Color, newColor: Color): PlayerSetColorEvent<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- player: PlayerData<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>
Overrides BasicEvent.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/SetColor.d.ts:27

Methods

revert

revert(): void
Revert the player's color back to their old color.

Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/SetColor.d.ts:43

setColor

setColor(color: Color): void
Change the color that the player had set.
Parameters
- color: Color
  
  The color to set.
Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/SetColor.d.ts:48

Generated using TypeDoc