Skip to content

Task

Object used to return information on a current Task.

Forms

task Task

Associated DataTypes

task

This is the type for your current task.

Members

int ID

Returns an int of the task ID

string Index

Returns the tasks' place on the tasklist

string Leader

Returns task leader's name

taskmember Member[#]

Returns specified member in task by index

taskmember Member[name]

Returns specified member in task by name

int Members

Returns number of members in task

taskobjective Objective[#]

Returns the specified objective

string Step

Returns description of current step in the task

timestamp Timer

Returns amount of time before task expires

string Title

Returns name of the shared task

string Type

Returns a string that can be one of the following:

  • Unknown
  • None
  • Deliver
  • Kill
  • Loot
  • Hail
  • Explore
  • Tradeskill
  • Fishing
  • Foraging
  • Cast
  • UseSkill
  • DZSwitch
  • DestroyObject
  • Collect
  • Dialogue

int WindowIndex

Returns the Quest Window List Index. (if the window actually has the list filled)

taskmember

Describes a member in your current task

Members

int Index

Returns task index for member (i.e., 1-6)

bool Leader

Returns true if member is leader

string Name

Returns name of the mamber

taskobjective

This is the type for your current task objective.

Members

int CurrentCount

Returns the current count of the .Type needed to complete a objective

int DZSwitchID

Returns an int of the switch used in a objective.

string Index

Returns the objective's place on the objectivelist

string Instruction

Returns a tasks' Objectives

bool Optional

Returns true or false if a objective is optional

int RequiredCount

Returns the required count of the .Type needed to complete a objective

string RequiredItem

Returns a string of the required item to complete a objective.

string RequiredSkill

Returns a string of the required skill to complete a objective.

string RequiredSpell

Returns a string of the required spell to complete a objective.

string Status

Returns the status of the objective in the format amount done Vs total IE 0/3

string Type

Returns a string that can be one of the following:

  • Unknown
  • None
  • Deliver
  • Kill
  • Loot
  • Hail
  • Explore
  • Tradeskill
  • Fishing
  • Foraging
  • Cast
  • UseSkill
  • DZSwitch
  • DestroyObject
  • Collect
  • Dialogue

string Zone

Returns the zone the objective is to be performed in

Usage

/echo ${Task[1].Title}

Will return the name of the first task, or the current shared task if one exists.

Discussions that link here

This TLO is added by MacroQuest.

Republished and possibly modified from https://docs.macroquest.org/reference/top-level-objects/tlo-task/