Class GameDataSetTasksEvent<RoomType>

Emitted when a player's tasks are set.

Type Parameters

Hierarchy

  • BasicEvent
    • GameDataSetTasksEvent

Implements

Properties

eventName eventName gamedata newTasks oldTasks player room

Accessors

alteredTasks

Constructors

constructor

Methods

revert setTasks

Properties

Static eventName

eventName: "gamedata.settasks"

eventName

eventName: "gamedata.settasks"

Readonly gamedata

gamedata: GameData<RoomType>

The gamedata object that this event is for.

Readonly newTasks

newTasks: TaskState[]

The player's new tasks that were just set.

Readonly oldTasks

oldTasks: TaskState[]

The player's old tasks.

Readonly player

player: PlayerInfo<RoomType>

Information about the player that had their tasks set.

Readonly room

room: RoomType

The room or client that the event came from.

Accessors

alteredTasks

  • get alteredTasks(): TaskState[]

  • The alternate tasks to set the player, if changed.

    Returns TaskState[]

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • gamedata: GameData<RoomType>
    • player: PlayerInfo<RoomType>

      Information about the player that had their tasks set.

    • oldTasks: TaskState[]

      The player's old tasks.

    • newTasks: TaskState[]

      The player's new tasks that were just set.

    Returns GameDataSetTasksEvent<RoomType>

Methods

revert

  • Set the tasks to the tasks that the player had before this event.

    Returns void

setTasks

  • Change the tasks of the player that were set.

    Parameters

    • tasks: number[]

      Each TaskType to set the player.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc