Class PlayerUseZiplineEvent<RoomType>

Emitted when a player has their player pet updated.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerUseZiplineEvent

Implements

PlayerEvent<RoomType>
ProtocolEvent

Index

Constructors

Properties

eventName eventName fromTop message player room

Constructors

constructor

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

Properties

`Static`eventName

eventName: "player.usezipline" = ...

eventName

eventName: "player.usezipline" = ...

`Readonly`fromTop

fromTop: boolean

`Readonly`message

message: undefined | UseZiplineMessage

The message that this event originated from.

`Readonly`player

player: Player<RoomType>

`Readonly`room