Class PlayerSetPetEvent<RoomType>

constructor

• new PlayerSetPetEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SetPetMessage,
      oldPetId: string,
      newPetId: string,
  ): PlayerSetPetEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

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

eventName

Readonlymessage

ReadonlynewPetId

ReadonlyoldPetId

Readonlyplayer

Readonlyroom

StaticeventName

alteredPetId

• get alteredPetId(): string

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

  Returns string

revert

• revert(): void

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

  Returns void

setPet

• setPet(pet: string): void

  Change the pet that the player had set.

  Parameters

  • pet: string

    The pet to set.

  Returns void