WoW:API GetQuestLogTitle: Difference between revisions

← Older edit

WoW:API GetQuestLogTitle (source)

Revision as of 04:46, 15 August 2023

918 bytes added , 15 August 2023

m

Move page script moved page API GetQuestLogTitle to WoW:API GetQuestLogTitle without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
 Returns information about a quest in your quest log.
- questTitle, level, questTag, suggestedGroup, isHeader, isCollapsed, isComplete, isDaily = GetQuestLogTitle(questID);
+*title, level, suggestedGroup, isHeader, isCollapsed, isComplete, frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI, isTask, isStory = GetQuestLogTitle(questLogID);
 ==Parameters==
 ===Arguments===
-:;questID : Integer - The index of the quest you wish to get information about.
+:;questLogID
+:: Integer - The index of the quest you wish to get information about, between 1 and [[API_GetNumQuestLogEntries|GetNumQuestLogEntries()]]'s first return value. (This is not the ID as used in [[QuestString]]s.)
 ===Returns===
-:;questTitle : String - The title of the quest, or nil if the index is out of range.
+:;title
-:;level : Integer - The level of the quest
+:: String - The title of the quest, or nil if the index is out of range.
-:;questTag : String - Should be "Elite", "Dungeon", "PVP", "Raid", "Group" or nil  (return value is [[#questTag]]).
+:;level
-:;suggestedGroup : Integer - if questTag is GROUP, the positive number of players suggested for the quest or nil (added in 2.0.3)
+:: Integer - The level of the quest
-:;isHeader : Boolean - 1 if the entry is a header, nil otherwise.
+:;suggestedGroup
-:;isCollapsed : Boolean - 1 if the entry is a collapsed header, nil otherwise.
+:: Integer - if questTag is GROUP, the positive number of players suggested for the quest or nil (added in 2.0.3)
-:;isComplete : Integer - -1 if quest is (FAILED), +1 if quest is (COMPLETED), nil otherwise.
+:;isHeader
-:;isDaily : Integer - 1 if the quest is daily. (Added in 2.1.0). If questTag is not nil and isDaily is true, then questTag will be format with DAILY_QUEST_TAG_TEMPLATE and displayed in QuestLogFrame.
+:: Boolean - 1 if the entry is not a quest, but a header, eg. "Mulgore" nil otherwise.
+:;isCollapsed
-<div id="questTag">questTag localization: </div>while the value of questTag is localized, it is stored in GlobalStrings.lua as ELITE, LFG_TYPE_DUNGEON, PVP, RAID and GROUP respectively.
+:: Boolean - 1 if the entry is a collapsed header, nil otherwise.
+:;isComplete
+:: Integer - -1 if quest is (FAILED), +1 if quest is (COMPLETED), nil otherwise.
+:;frequency
+:;questID
+:: Integer - The quest identification number. This is the number found in GetQuestsCompleted() after it has been completed. It is also the number used to identify quests on sites such as Wowhead.com (Example: [http://www.wowhead.com/?quest=2158 Rest and Relaxation]) (added in 3.3.0)
+:;startEvent
+:;displayQuestID
+:;isOnMap
+:;hasLocalPOI
+:;isTask
+:;isStory
 ==Example==
- local i=0;
+  local i = 1
- while (GetQuestLogTitle(i+1) ~= nil) do
+  while GetQuestLogTitle(i) do
-  i = i + 1;
+   local title, level, suggestedGroup, isHeader, isCollapsed, isComplete,
-  local questTitle, level, questTag, suggestedGroup, isHeader, isCollapsed, isComplete, isDaily = GetQuestLogTitle(i);
+   frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI,
-  if (not header) then
+   isTask, isStory = GetQuestLogTitle(i);
-   DEFAULT_CHAT_FRAME:AddMessage(questTitle .. " [" .. level .. "]");
+   if ( not isHeader ) then
-    return;
+    DEFAULT_CHAT_FRAME:AddMessage(title.. " [" .. level .. "] " .. questID)
+    end
+   i = i + 1
    end
- end
 ===Result===
-Prints the name and the level of all quests in your quest log.
+Prints the name, level, and Quest ID of all quests in your quest log.
+==Before patch 6.0.1:==
+ questTitle, level, questTag, suggestedGroup, isHeader, isCollapsed, isComplete, isDaily, questID = GetQuestLogTitle(questLogID);
+;===Deprecated Returns:===
+;
+;questTag
+: String - Should be "Elite", "Dungeon", "PVP", "Raid", "Group", "Heroic" or nil (return value is [[#questTag]]). Removed in 6.0.1
+;
+;isDaily
+: Integer - 1 if the quest is daily. (Added in 2.1.0). If questTag is not nil and isDaily is true, then the quest tag in the QuestLogFrame will be displayed using DAILY_QUEST_TAG_TEMPLATE. Removed in 6.0.1
+;
+: questTag localization:
+: while the value of questTag is localized, it is stored in GlobalStrings.lua as ELITE, LFG_TYPE_DUNGEON, PVP, RAID, GROUP and PLAYER_DIFFICULTY2 respectively.