WoW:API GetQuestLogTitle: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (clarified daily quest handling to not confuse the tag displayed in the questlog with the questTag returnvalue of this function)
No edit summary
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
Returns information about a quest in your quest log.
Returns information about a quest in your quest log.
questTitle, level, questTag, suggestedGroup, isHeader, isCollapsed, isComplete, isDaily, questID = GetQuestLogTitle(questLogID);
*title, level, suggestedGroup, isHeader, isCollapsed, isComplete, frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI, isTask, isStory = GetQuestLogTitle(questLogID);


==Parameters==
==Parameters==
===Arguments===
===Arguments===
:;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|QuestStrings]].)
:;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===
===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", "Heroic" 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 the quest tag in the QuestLogFrame will be displayed using DAILY_QUEST_TAG_TEMPLATE.
:: Boolean - 1 if the entry is not a quest, but a header, eg. "Mulgore" nil otherwise.
:;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)
:;isCollapsed
 
:: Boolean - 1 if the entry is a collapsed header, nil otherwise.
<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, GROUP and PLAYER_DIFFICULTY2 respectively.
:;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==
==Example==
   local i = 1
   local i = 1
   while GetQuestLogTitle(i) do
   while GetQuestLogTitle(i) do
   local questTitle, level, questTag, suggestedGroup, isHeader, isCollapsed, isComplete, isDaily, questID = GetQuestLogTitle(i)
   local title, level, suggestedGroup, isHeader, isCollapsed, isComplete,
  frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI,
  isTask, isStory = GetQuestLogTitle(i);
   if ( not isHeader ) then
   if ( not isHeader ) then
     DEFAULT_CHAT_FRAME:AddMessage(questTitle .. " [" .. level .. "] " .. questID)
     DEFAULT_CHAT_FRAME:AddMessage(title.. " [" .. level .. "] " .. questID)
   end
   end
   i = i + 1
   i = i + 1
Line 31: Line 44:
===Result===
===Result===
Prints the name, level, and Quest ID 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.

Revision as of 23:35, 24 July 2019

← WoW API < GetQuestLogTitle

Returns information about a quest in your quest log.

  • title, level, suggestedGroup, isHeader, isCollapsed, isComplete, frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI, isTask, isStory = GetQuestLogTitle(questLogID);

Parameters

Arguments

questLogID
Integer - The index of the quest you wish to get information about, between 1 and GetNumQuestLogEntries()'s first return value. (This is not the ID as used in QuestStrings.)

Returns

title
String - The title of the quest, or nil if the index is out of range.
level
Integer - The level of the quest
suggestedGroup
Integer - if questTag is GROUP, the positive number of players suggested for the quest or nil (added in 2.0.3)
isHeader
Boolean - 1 if the entry is not a quest, but a header, eg. "Mulgore" nil otherwise.
isCollapsed
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: Rest and Relaxation) (added in 3.3.0)
startEvent
displayQuestID
isOnMap
hasLocalPOI
isTask
isStory

Example

 local i = 1
 while GetQuestLogTitle(i) do
  local title, level, suggestedGroup, isHeader, isCollapsed, isComplete,
  frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI,
  isTask, isStory = GetQuestLogTitle(i);
  if ( not isHeader ) then
   DEFAULT_CHAT_FRAME:AddMessage(title.. " [" .. level .. "] " .. questID)
  end
  i = i + 1
 end

Result

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.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetQuestLogTitle&oldid=4581"