Class PlayerSetPetEvent<RoomType>

Emitted when a player has their player pet updated.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetPetEvent

Implements

Properties

eventName eventName message newPetId oldPetId player room

Accessors

alteredPetId

Constructors

constructor

Methods

revert setPet

Properties

Static eventName

eventName: "player.setpet"

eventName

eventName: "player.setpet"

Readonly message

message: undefined | SetPetMessage

The message that this event originated from.

Readonly newPetId

newPetId: string

The new pet that the player has.

Readonly oldPetId

oldPetId: string

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

alteredPetId

  • get alteredPetId(): string

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

    Returns string

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | SetPetMessage
    • oldPetId: string

      The pet that the player had before.

    • newPetId: string

      The new pet that the player has.

    Returns PlayerSetPetEvent<RoomType>

Methods

revert

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

    Returns void

setPet

  • Change the pet that the player had set.

    Parameters

    • pet: string

      The pet to set.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc