Class PlayerPetPetEvent<RoomType>

Emitted when a player pets their pet or another player's pet.

Due to technical limitations, the actual pet that is being petted is not available.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

CancelableEvent
- PlayerPetPetEvent

Implements

Index

Constructors

Properties

canceled eventName message petPos player playerPos room eventName

Methods

Constructors

constructor

new PlayerPetPetEvent<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    player: Player<RoomType>,
    message: undefined | PetMessage,
    playerPos: Vector2,
    petPos: Vector2,
): PlayerPetPetEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- player: Player<RoomType>
- message: undefined | PetMessage
- playerPos: Vector2
- petPos: Vector2
Returns PlayerPetPetEvent<RoomType>
Overrides CancelableEvent.constructor
- Defined in packages/core/lib/events/player/PetPet.ts:19

Properties

canceled

canceled: boolean

eventName

eventName: "player.pet" = ...

`Readonly`message

message: undefined | PetMessage

The message that this event originated from.

`Readonly`petPos

petPos: Vector2

`Readonly`player

player: Player<RoomType>

The player that this event is for.

`Readonly`playerPos

playerPos: Vector2

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "player.pet" = ...

Methods

cancel

cancel(): void
Returns void
Inherited from CancelableEvent.cancel
- Defined in packages/events/lib/CancelableEvent.ts:12