Changes: API GetTaskInfo

Revision as of 08:01, 17 November 2014

Returns information about a bonus objective.

isInArea, isOnMap, numObjectives = GetTaskInfo(questID)

Arguments

questID: Integer - Unique identifier for the quest.

Returns

All returns are nil if IsQuestTask() returns false for the quest.

isInArea: Boolean - True if player is in the location where the task activates.
isOnMap: Boolean - True if task is active and visible on the player's map.
numObjectives: Integer - Number of objectives for the task.

Details

The bonus objectives system allows players to progress quests that are activated based on location, rather than a quest-giving NPC. While these player is in the appropriate area and these quests are active, they are invisible entries the quest log. After the player leaves the area, the quest is removed from the quest log and thus has no longer has a usable quest index. Bonus objectives (known in the API as "tasks") have a quest ID and information about them can be queried by all functions that accept a quest ID.

Until the player enters the task area for the first time per session, all tasks return false with IsQuestTask() (and thus return nil values with GetTaskInfo()). Quest IDs for tasks will become unusable again if the player logs out.

Patch changes

Patch 6.0.2 (2014-10-14): Added.

@@ Line 13: / Line 13: @@
 == Details ==
-The bonus objectives system allows players to progress quests that are activated based on location, rather than a quest-giving NPC.  Since these quests are never in the quest log, all quest API functions that require a quest log index parameter are unusable.  Bonus objectives (known in the API as "tasks") have a quest ID and information about them can be queried by all functions that accept a quest ID.
+The bonus objectives system allows players to progress quests that are activated based on location, rather than a quest-giving NPC.  While these player is in the appropriate area and these quests are active, they are invisible entries the quest log. After the player leaves the area, the quest is removed from the quest log and thus has no longer has a usable quest index.  Bonus objectives (known in the API as "tasks") have a quest ID and information about them can be queried by all functions that accept a quest ID.
-Until the player enters the task area for the first time per session, all tasks return false with <tt>IsQuestTask()</tt> (and thus return nil values with <tt>GetTaskInfo()</tt>).  This status is reset when the character logs out.
+Until the player enters the task area for the first time per session, all tasks return false with <tt>IsQuestTask()</tt> (and thus return nil values with <tt>GetTaskInfo()</tt>).  Quest IDs for tasks will become unusable again if the player logs out.
 == See also ==