Class PlayerSetHatEvent<RoomType>

Emitted when a player has their player hat updated.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetHatEvent

Implements

Properties

eventName eventName message newHatId oldHatId player room

Accessors

alteredHatId

Constructors

constructor

Methods

revert setHat

Properties

Static eventName

eventName: "player.sethat"

eventName

eventName: "player.sethat"

Readonly message

message: undefined | SetHatMessage

The message that this event originated from.

Readonly newHatId

newHatId: string

The new hat that the player has.

Readonly oldHatId

oldHatId: string

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

alteredHatId

  • get alteredHatId(): string

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

    Returns string

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | SetHatMessage
    • oldHatId: string

      The hat that the player had before.

    • newHatId: string

      The new hat that the player has.

    Returns PlayerSetHatEvent<RoomType>

Methods

revert

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

    Returns void

setHat

  • Change the hat that the player had set.

    Parameters

    • hatId: string

      The hat to set.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc