Class PlayerSetSkinEvent<RoomType>

Emitted when a player has their player skin updated.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerSetSkinEvent

Implements

Index

Properties

Accessors

alteredSkin

Constructors

constructor

Methods

Properties

Static eventName

eventName: "player.setskin" = ...

eventName

eventName: "player.setskin" = ...

Readonly message

message: undefined | SetSkinMessage

The message that this event originated from.

Readonly newSkinId

newSkinId: string

Readonly oldSkinId

oldSkinId: string

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

alteredSkin

get alteredSkin(): string

- Defined in core/lib/events/player/SetSkin.ts:40
The altered skin that the player will have set instead, if changed.

Returns string

Constructors

constructor

new PlayerSetSkinEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SetSkinMessage, oldSkinId: string, newSkinId: string): PlayerSetSkinEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/SetSkin.ts:19
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | SetSkinMessage
- oldSkinId: string
- newSkinId: string
Returns PlayerSetSkinEvent<RoomType>

Methods

revert

revert(): void

- Defined in core/lib/events/player/SetSkin.ts:47
Revert the player's skin back to their old skin.

Returns void

setSkin

setSkin(skin: string): void

- Defined in core/lib/events/player/SetSkin.ts:55
Change the skin that the player had set.

Parameters
- skin: string
  
  The skin to set.
Returns void

Generated using TypeDoc