Class PlayerPetEvent<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
- PlayerPetEvent

Implements

PlayerEvent<RoomType>
ProtocolEvent

Index

Constructors

Properties

eventName canceled eventName message petPos player playerPos room

Methods

Constructors

constructor

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

Properties

`Static`eventName

eventName: "player.pet" = ...

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>

`Readonly`playerPos

playerPos: Vector2

`Readonly`room

Methods

cancel

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