API GetQuestObjectiveInfo

From Wowpedia
Jump to: navigation, search

Returns information about a quest objective.

text, objectiveType, finished = GetQuestObjectiveInfo(questID, objectiveIndex, Boolean)

Arguments

questID 
Number - Unique identifier of the quest.
objectiveIndex 
Index of the quest objective to query, ascending from 1 to GetNumQuestLeaderBoards(questIndex) or to numObjectives from GetTaskInfo(questID).
Boolean 
Required to actually obtain quest text.

Return values

text 
String - Text description of the objective, e.g. "0/3 Monsters slain"
objectiveType 
String - A token describing objective type, one of "item", "object", "monster", "reputation", "log", "event", "player" or "progressbar".
finished 
Boolean - true if sub-objective is completed, false if incomplete.

Details

This function's usage is identical to GetQuestLogLeaderBoard, except it takes a QuestID instead of QuestLogIndex as an argument. Using the quest ID allows for getting information about a quest's objectives even if it's not currently in the player's log.

Use with Tasks

This function is useful when querying data for bonus objectives. Bonus objectives (known as Tasks in functions such as GetTaskInfo) are only in the quest log while the player is in the area and they are invisible in the quest log interface. This function allows keeping track of Bonus objectives even when they are not in the quest log, and thus have no quest log index.

The quest IDs of tasks differ from normal quests. They will return incorrect values if a task has not been encountered during the character's login session. This function will begin returning accurate values upon entering the task area. It's necessary to save quest objective progress to a file if accurate information about partially completed tasks is required before the player re-enters the area.

Patch changes

Warlords of Draenor Patch 6.0.2 (2014-10-14): Added.