Class PlayerCompleteTaskEvent<RoomType>

Emitted when a player completes one of their tasks.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

BasicEvent
- PlayerCompleteTaskEvent

Implements

Index

Properties

eventName eventName message player room task

Constructors

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: PlayerData<RoomType>

The player that this event is for.

`Readonly` room

room: RoomType

The room or client that the event came from.

`Readonly` task

task: TaskState

The state of the task that the player completed.

Constructors

constructor

new PlayerCompleteTaskEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | CompleteTaskMessage, task: TaskState): PlayerCompleteTaskEvent<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | CompleteTaskMessage
- task: TaskState
  
  The state of the task that the player completed.
Returns PlayerCompleteTaskEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/CompleteTask.d.ts:22

Generated using TypeDoc