Class PlayerSetSkinEvent<RoomType>

constructor

• new PlayerSetSkinEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SetSkinMessage,
      oldSkinId: string,
      newSkinId: string,
  ): PlayerSetSkinEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

  • room: RoomType
  • player: Player<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>

eventName

Readonlymessage

ReadonlynewSkinId

ReadonlyoldSkinId

Readonlyplayer

Readonlyroom

StaticeventName

alteredSkin

• get alteredSkin(): string

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

  Returns string

revert

• revert(): void

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

  Returns void

setSkin

• setSkin(skin: string): void

  Change the skin that the player had set.

  Parameters

  • skin: string

    The skin to set.

  Returns void