Class PlayerAppearEvent<RoomType>

Emitted when a player (e.g. a phantom) appears.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

CancelableEvent
- PlayerAppearEvent

Implements

PlayerEvent<RoomType>
ProtocolEvent

Index

Constructors

Properties

eventName canceled eventName message player room

Methods

Constructors

constructor

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

Properties

`Static`eventName

eventName: "player.appear" = ...

canceled

canceled: boolean

eventName

eventName: "player.appear" = ...

`Readonly`message

message: undefined | AppearMessage

The message that this event originated from.

`Readonly`player

player: Player<RoomType>

`Readonly`room

Methods

cancel

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