Class PlayerSetPetEvent<RoomType>

Emitted when a player has their player pet updated.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerSetPetEvent

Implements

Index

Properties

Accessors

alteredPetId

Constructors

constructor

Methods

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

Readonly oldPetId

oldPetId: string

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

- Defined in core/lib/events/player/SetPet.ts:40
The altered pet that the player will have set instead, if changed.

Returns string

Constructors

constructor

new PlayerSetPetEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SetPetMessage, oldPetId: string, newPetId: string): PlayerSetPetEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/SetPet.ts:19
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | SetPetMessage
- oldPetId: string
- newPetId: string
Returns PlayerSetPetEvent<RoomType>

Methods

revert

revert(): void

- Defined in core/lib/events/player/SetPet.ts:47
Revert the player's pet back to their old pet.

Returns void

setPet

setPet(pet: string): void

- Defined in core/lib/events/player/SetPet.ts:55
Change the pet that the player had set.

Parameters
- pet: string
  
  The pet to set.
Returns void

Generated using TypeDoc