Class PlayerCompleteTaskEvent<RoomType>

Emitted when a player completes one of their tasks.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerCompleteTaskEvent

Implements

PlayerEvent<RoomType>
ProtocolEvent

Index

Constructors

Properties

eventName eventName message player room task

Constructors

constructor

new PlayerCompleteTaskEvent<
    RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
>(
    room: RoomType,
    player: Player<RoomType>,
    message: undefined | CompleteTaskMessage,
    task: TaskState,
): PlayerCompleteTaskEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
Parameters
- room: RoomType
- player: Player<RoomType>
- message: undefined | CompleteTaskMessage
- task: TaskState
  The state of the task that the player completed.
Returns PlayerCompleteTaskEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/player/CompleteTask.ts:17

Properties

`Static`eventName

eventName: "player.completetask" = ...

eventName

eventName: "player.completetask" = ...

`Readonly`message

message: undefined | CompleteTaskMessage

The message that this event originated from.

`Readonly`player

player: Player<RoomType>

`Readonly`room

`Readonly`task

task: TaskState

The state of the task that the player completed.