Class PlayerCancelPetEvent<RoomType>

Emitted when a player stops petting their or another player's pet.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerCancelPetEvent

Implements

PlayerEvent<RoomType>
ProtocolEvent

Index

Constructors

Properties

eventName eventName message player room

Constructors

constructor

new PlayerCancelPetEvent<
    RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
>(
    room: RoomType,
    player: Player<RoomType>,
    message: undefined | CancelPetMessage,
): PlayerCancelPetEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
Parameters
- room: RoomType
- player: Player<RoomType>
- message: undefined | CancelPetMessage
Returns PlayerCancelPetEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/player/CancelPet.ts:16

Properties

`Static`eventName

eventName: "player.cancelpet" = ...

eventName

eventName: "player.cancelpet" = ...

`Readonly`message

message: undefined | CancelPetMessage

The message that this event originated from.

`Readonly`player

player: Player<RoomType>

`Readonly`room