Class PlayerSetSkinEvent<RoomType>

Emitted when a player has their player skin updated.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetSkinEvent

Implements

Properties

eventName eventName message newSkinId oldSkinId player room

Accessors

alteredSkin

Constructors

constructor

Methods

revert setSkin

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

The new skin that the player has.

Readonly oldSkinId

oldSkinId: string

The skin 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

alteredSkin

  • get alteredSkin(): string

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

    Returns string

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | SetSkinMessage
    • oldSkinId: string

      The skin that the player had before.

    • newSkinId: string

      The new skin that the player has.

    Returns PlayerSetSkinEvent<RoomType>

Methods

revert

  • Revert the player's skin back to their old skin.

    Returns void

setSkin

  • Change the skin that the player had set.

    Parameters

    • skin: string

      The skin to set.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc