Mercurial > wow > buffalo2

annotate ObjectiveTracker/Quests.lua @ 35:69d03f8e293e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- separated layout and data logic between Frame.lua and Update.lua - solved disappearing tracker mystery
author Nenue
date Sun, 17 Apr 2016 11:07:48 -0400
parents 9856ebc63fa4
children e84d645c8ab8
rev   line source
Nenue@28 1 local B = select(2,...).frame
Nenue@28 2 local T = B:RegisterModule("ObjectiveTracker", _G.VeneerObjectiveWrapper, 'BuffFrame')
Nenue@28 3 local _G, ipairs, max, min, unpack, floor, pairs, tostring, type, band = _G, ipairs, max, min, unpack, floor, pairs, tostring, type, bit.band
Nenue@30 4 local GetQuestWatchInfo, GetQuestLogCompletionText = GetQuestWatchInfo, GetQuestLogCompletionText
Nenue@30 5 local GetQuestLogLeaderBoard, GetNumQuestLogEntries, GetQuestLogTitle = GetQuestLogLeaderBoard, GetNumQuestLogEntries, GetQuestLogTitle
Nenue@30 6 local GetQuestLogSpecialItemInfo, GetQuestLogSpecialItemCooldown = GetQuestLogSpecialItemInfo, GetQuestLogSpecialItemCooldown
Nenue@30 7 local GetSuperTrackedQuestID, GetMoney, C_Scenario, GetCVarBool, GetNumQuestWatches = GetSuperTrackedQuestID, GetMoney, C_Scenario, GetCVarBool, GetNumQuestWatches
Nenue@30 8 local GetQuestTagInfo, GetMoneyString, GetDistanceSqToQuest, GetQuestFactionGroup = GetQuestTagInfo, GetMoneyString, GetDistanceSqToQuest, GetQuestFactionGroup
Nenue@30 9 local QUEST_TAG_ACCOUNT, LE_QUEST_FACTION_HORDE, LE_QUEST_FREQUENCY_DAILY, LE_QUEST_FREQUENCY_WEEKLY = QUEST_TAG_ACCOUNT, LE_QUEST_FACTION_HORDE, LE_QUEST_FREQUENCY_DAILY, LE_QUEST_FREQUENCY_WEEKLY
Nenue@30 10 local QUEST_TAG_TCOORDS, IsQuestSequenced = QUEST_TAG_TCOORDS, IsQuestSequenced
Nenue@28 11 local Default, Quest = T.DefaultHandler, T.Quest
Nenue@28 12 local format = format
Nenue@28 13 local print = B.print('Tracker')
Nenue@28 14 local lprint = B.print('Line')
Nenue@28 15 local iprint = B.print('Info')
Nenue@29 16 local colors = T.colors
Nenue@29 17 local tprint = B.print('Tracker')
Nenue@28 18
Nenue@30 19 local superTrackQuestID, playerMoney, inScenario, showPOIs
Nenue@28 20 Quest.Update = function(self, reason, ...)
Nenue@28 21 local print = tprint
Nenue@28 22 print('QuestTracker:Update() received')
Nenue@28 23 T.UpdateActionButtons()
Nenue@28 24 Default.Update(self, reason, ...)
Nenue@28 25 end
Nenue@28 26
Nenue@28 27 T.Quest.numButtons = 0
Nenue@28 28 local usedButtons = T.Quest.itemButtons
Nenue@28 29 local freeButtons = T.Quest.freeButtons
Nenue@28 30
Nenue@28 31 Quest.UpdateObjectives = function(handler, block)
Nenue@28 32 local print = lprint
Nenue@28 33 print('|cFF00FFFFUpdateObjectives()')
Nenue@28 34 local info = block.info
Nenue@28 35
Nenue@28 36 print((info.isAccount and 'isAccount' or ''), (info.isFaction and 'isFaction' or ''), (info.isDaily and 'isDaily' or ''), (info.isWeekly and 'isWeekly' or ''), info.tagID, info.tagName)
Nenue@28 37
Nenue@34 38 local block_schema = 'default'
Nenue@28 39 if info.isAccount then
Nenue@28 40 if info.isFaction then
Nenue@28 41 print(' faction', info.tagID)
Nenue@34 42 block_schema = 'faction_'..info.tagID
Nenue@28 43 else
Nenue@28 44 print(' account', info.isAccount, info.isFaction)
Nenue@34 45 block_schema = 'account'
Nenue@28 46 end
Nenue@28 47 elseif info.isDaily then
Nenue@28 48 print(' daily', info.frequency)
Nenue@34 49 block_schema = 'daily'
Nenue@28 50 elseif info.isWeekly then
Nenue@28 51 print(' weekly', info.frequency)
Nenue@34 52 block_schema = 'weekly'
Nenue@28 53 end
Nenue@28 54 local completionText
Nenue@28 55 if info.isComplete then
Nenue@28 56 if info.isAutoComplete then
Nenue@34 57 local questID, popupType = GetAutoQuestPopUp(info.logIndex)
Nenue@28 58 if popupType == 'COMPLETE' then
Nenue@28 59 print(' :: auto-complete quest :: set the message')
Nenue@28 60 info.completionText = T.strings.CLICK_TO_COMPLETE
Nenue@28 61 end
Nenue@28 62 else
Nenue@28 63 if not completionText or info.completionText then
Nenue@34 64 info.completionText = GetQuestLogCompletionText(info.logIndex)
Nenue@28 65 end
Nenue@28 66 end
Nenue@28 67 print(' :: complete quest :: show instruction: "'.. tostring(info.completionText) .. '"')
Nenue@28 68 end
Nenue@28 69
Nenue@34 70 Default.UpdateObjectives(handler, block, block_schema)
Nenue@34 71 return block_schema
Nenue@28 72 end
Nenue@28 73
Nenue@28 74 Quest.UpdateLine = function(handler, block, line, data)
Nenue@28 75 local print = lprint
Nenue@28 76 local objectiveType = data.type
Nenue@31 77 return data.text, nil, objectiveType
Nenue@28 78 end
Nenue@28 79
Nenue@28 80 -----------------------------
Nenue@28 81 --- QUEST
Nenue@28 82 Quest.QuestBlock = {}
Nenue@28 83 Quest.LogBlock = {}
Nenue@28 84 Quest.LogInfo = {}
Nenue@28 85
Nenue@28 86 function Quest:GetNumWatched ()
Nenue@30 87 superTrackQuestID = GetSuperTrackedQuestID()
Nenue@30 88 playerMoney = GetMoney();
Nenue@30 89 inScenario = C_Scenario.IsInScenario();
Nenue@30 90 showPOIs = GetCVarBool("questPOI");
Nenue@28 91 self.numAll = GetNumQuestLogEntries()
Nenue@28 92 self.numWatched = GetNumQuestWatches()
Nenue@28 93 return self.numWatched, self.numAll
Nenue@28 94 end
Nenue@30 95
Nenue@30 96 --- Returns an iterable table from which tracker blocks can be filled out. Data includes:
Nenue@30 97 -- All entry-layer GetXInfo return values
Nenue@30 98 -- Manifest of line data to be displayed in relation to the tracked object
Nenue@28 99 Quest.GetInfo = function (self, watchIndex)
Nenue@28 100 local print = iprint
Nenue@28 101
Nenue@30 102 local questID, title, questLogIndex, numObjectives, requiredMoney, isComplete, startEvent, isAutoComplete,
Nenue@30 103 failureTime, timeElapsed, questType, isTask, isStory, isOnMap, hasLocalPOI = GetQuestWatchInfo(watchIndex)
Nenue@30 104 if ( not questID ) then
Nenue@28 105 return
Nenue@28 106 end
Nenue@28 107
Nenue@35 108 tprint(' |cFFFFBB00GetInfo:|r', watchIndex, '|cFFFF2299'..title..'|r')
Nenue@30 109 local _, level, suggestedGroup, isHeader, isCollapsed, isComplete, frequency, _, startEvent, displayQuestID, isOnMap, hasLocalPOI, isTask, isStory = GetQuestLogTitle(questLogIndex)
Nenue@28 110
Nenue@28 111 Quest.Info[questID] = Quest.Info[questID] or {}
Nenue@28 112
Nenue@30 113
Nenue@28 114 local q = Quest.Info[questID]
Nenue@32 115 q.type = 'Quest'
Nenue@32 116 q.title = title
Nenue@32 117 q.level = level
Nenue@32 118 q.displayQuestID = displayQuestID
Nenue@32 119 q.suggestedGroup = suggestedGroup
Nenue@32 120
Nenue@30 121 -- re-use Blizzard logic for consistency
Nenue@32 122 local showQuest = true
Nenue@32 123 if isTask then showQuest = false end
Nenue@30 124 local watchMoney = false;
Nenue@30 125 local tagID, typeTag, frequencyTag, completionTag, completionText
Nenue@30 126 local isAccount, isFaction, isWeekly, isDaily = false, false, false, false
Nenue@30 127 local isBreadcrumb = false
Nenue@30 128 local questFailed = false
Nenue@30 129 local watchMoney = false
Nenue@30 130 local timerInfo, moneyInfo = false, false
Nenue@30 131 local objectives = q.objectives or {}
Nenue@30 132
Nenue@30 133
Nenue@30 134 -- Case 1: completed quest or "go to thing" breadcrumb
Nenue@30 135 -- * 1 line containing the completion text
Nenue@30 136 if ( isComplete and isComplete < 0 ) then
Nenue@30 137 isComplete = false
Nenue@30 138 questFailed = true
Nenue@30 139 elseif ( numObjectives == 0 and playerMoney >= requiredMoney and not startEvent ) then
Nenue@30 140 isComplete = true;
Nenue@30 141 questFailed = false
Nenue@30 142 if ( requiredMoney == 0 ) then
Nenue@30 143 isBreadcrumb = true;
Nenue@30 144 end
Nenue@30 145 end
Nenue@30 146 print('|cFF0088FFflags:|r', (isComplete and 'isComplete' or ''), (questFailed and 'questFailed' or ''), (isBreadcrumb and 'isBreadcrumb' or ''))
Nenue@30 147
Nenue@30 148 -- completion message?
Nenue@30 149 local isSequenced = IsQuestSequenced(questID)
Nenue@30 150 local temp_status = ''
Nenue@30 151 if ( isComplete ) then
Nenue@30 152 temp_status = 'COMPLETED_OBJECTIVES'
Nenue@30 153 objectives = Quest.GetObjectives(questLogIndex, numObjectives, true, isSequenced, isStory)
Nenue@30 154 if ( isAutoComplete ) then
Nenue@30 155 temp_status = 'AUTOCOMPLETE_OBJECTIVES'
Nenue@30 156 completionText = _G.QUEST_WATCH_CLICK_TO_COMPLETE
Nenue@30 157 else
Nenue@30 158 if ( isBreadcrumb ) then
Nenue@30 159 temp_status = 'COMPLETE_BREADCRUMB'
Nenue@30 160 completionText = GetQuestLogCompletionText(questLogIndex)
Nenue@30 161 else
Nenue@30 162 temp_status = 'COMPLETE_READY_FOR_TURN_IN'
Nenue@30 163 completionText = _G.QUEST_WATCH_QUEST_READY
Nenue@30 164 end
Nenue@30 165 end
Nenue@30 166 elseif ( questFailed ) then
Nenue@30 167 temp_status = 'FAILED'
Nenue@30 168 -- Case 2: failed quest
Nenue@30 169 -- * 1 status line; hide other info
Nenue@30 170 completionText = _G.FAILED
Nenue@30 171 else
Nenue@30 172
Nenue@30 173 temp_status = 'PROGRESS_OBJECTIVES'
Nenue@30 174 -- Case 3: quest in progress
Nenue@30 175 -- * Multiple objective lines
Nenue@30 176 -- * Possible extra lines for money and timer data respectively
Nenue@30 177 objectives = Quest.GetObjectives(questLogIndex, numObjectives, false, isSequenced, isStory)
Nenue@30 178 q.objectives = objectives
Nenue@30 179
Nenue@30 180 --- anything past here gets appended to existing objectives
Nenue@30 181
Nenue@30 182 -- money
Nenue@30 183 if ( requiredMoney > playerMoney ) then
Nenue@30 184
Nenue@30 185 temp_status = temp_status .. '_MONEY'
Nenue@30 186 local text = GetMoneyString(playerMoney).." / "..GetMoneyString(requiredMoney);
Nenue@30 187 moneyInfo = {
Nenue@30 188 type = 'money',
Nenue@30 189 text = text,
Nenue@30 190 finished = false,
Nenue@30 191 requiredMoney = requiredMoney,
Nenue@30 192 playerMoney = playerMoney,
Nenue@30 193 }
Nenue@31 194 tinsert(objectives, moneyInfo)
Nenue@30 195 end
Nenue@30 196
Nenue@30 197 -- time limit
Nenue@30 198 if ( failureTime ) then
Nenue@30 199 temp_status = temp_status .. '_TIMED'
Nenue@30 200 if ( timeElapsed and timeElapsed <= failureTime ) then
Nenue@30 201 timerInfo = {
Nenue@30 202 type = 'timer',
Nenue@30 203 finished = false,
Nenue@30 204 timeElapsed = timeElapsed,
Nenue@30 205 failureTime = failureTime,
Nenue@30 206 }
Nenue@31 207 tinsert(objectives, timerInfo)
Nenue@30 208 end
Nenue@30 209 end
Nenue@30 210 end
Nenue@30 211 q.numObjectives = numObjectives
Nenue@30 212 q.objectives = objectives
Nenue@32 213 q.requiredMoney = requiredMoney
Nenue@30 214 q.moneyInfo = moneyInfo
Nenue@30 215 q.timerInfo = timerInfo
Nenue@32 216 q.failureTime = failureTime
Nenue@32 217 q.timeElapsed = timeElapsed
Nenue@30 218 q.completionText = completionText
Nenue@30 219
Nenue@30 220 -- POI data
Nenue@30 221 local POI = false
Nenue@30 222 if ( showPOIs ) then
Nenue@30 223 POI = {
Nenue@30 224 questID = questID,
Nenue@30 225 questLogIndex = questLogIndex,
Nenue@30 226 }
Nenue@30 227 local poiButton;
Nenue@30 228 if ( hasLocalPOI ) then
Nenue@30 229
Nenue@30 230 if ( isComplete ) then
Nenue@30 231 POI.type = 'normal'
Nenue@30 232 else
Nenue@30 233 POI.type = 'numeric'
Nenue@30 234 end
Nenue@30 235 elseif ( isComplete ) then
Nenue@30 236 POI.type = 'remote'
Nenue@30 237 end
Nenue@30 238
Nenue@30 239 local distance, onContinent = GetDistanceSqToQuest(questLogIndex)
Nenue@30 240 if distance ~= nil and distance > 0 then
Nenue@30 241 POI.distance = distance
Nenue@30 242 POI.onContinent = onContinent
Nenue@30 243 end
Nenue@30 244 end
Nenue@30 245 q.POI = POI
Nenue@30 246
Nenue@30 247 --- Block Tags
Nenue@30 248 -- completionTag - in progres, complete, failed, autocomplete
Nenue@30 249 -- typeTag - account, faction, pvp, dungeon, group
Nenue@30 250 -- frequencyTag - daily/weekly
Nenue@30 251 local questTagID, tagName = GetQuestTagInfo(questID)
Nenue@30 252 local tagInfo = {}
Nenue@30 253 local tagCoords = {}
Nenue@30 254 local factionGroup = GetQuestFactionGroup(questID);
Nenue@30 255 if( questTagID and questTagID == QUEST_TAG_ACCOUNT ) then
Nenue@30 256 if( factionGroup ) then
Nenue@30 257 tagID = "ALLIANCE"
Nenue@30 258 if ( factionGroup == LE_QUEST_FACTION_HORDE ) then
Nenue@30 259 tagID = "HORDE"
Nenue@30 260 end
Nenue@30 261 isFaction = true
Nenue@30 262 else
Nenue@30 263 tagID = QUEST_TAG_ACCOUNT
Nenue@30 264 isAccount = true
Nenue@30 265 end
Nenue@30 266 tagInfo['typeTag'] = tagID
Nenue@30 267 tagCoords['typeTag'] = QUEST_TAG_TCOORDS[tagID]
Nenue@30 268 elseif ( factionGroup) then
Nenue@30 269 tagID = "ALLIANCE"
Nenue@30 270 if ( factionGroup == LE_QUEST_FACTION_HORDE ) then
Nenue@30 271 tagID = "HORDE"
Nenue@30 272 end
Nenue@30 273 isFaction = true
Nenue@30 274 tagInfo['typeTag'] = tagID
Nenue@30 275 tagCoords['typeTag'] = QUEST_TAG_TCOORDS[tagID]
Nenue@30 276 end
Nenue@30 277
Nenue@30 278 if( frequency == LE_QUEST_FREQUENCY_DAILY and (not isComplete or isComplete == 0) ) then
Nenue@30 279 tagID = 'DAILY'
Nenue@30 280 tagInfo['frequencyTag'] = tagID
Nenue@30 281 tagCoords['frequencyTag'] = QUEST_TAG_TCOORDS[tagID]
Nenue@30 282 isDaily = true
Nenue@30 283 elseif( frequency == LE_QUEST_FREQUENCY_WEEKLY and (not isComplete or isComplete == 0) )then
Nenue@30 284 tagID = 'WEEKLY'
Nenue@30 285 tagInfo['frequencyTag'] = tagID
Nenue@30 286 tagCoords['frequencyTag'] = QUEST_TAG_TCOORDS[tagID]
Nenue@30 287 isWeekly = true
Nenue@30 288 elseif( questTagID ) then
Nenue@30 289 tagID = questTagID
Nenue@30 290 end
Nenue@30 291
Nenue@30 292 if( isComplete ) then
Nenue@30 293 tagInfo['completionTag'] = 'COMPLETED'
Nenue@30 294 elseif ( questFailed ) then
Nenue@30 295 tagInfo['completionTag'] = 'FAILED'
Nenue@30 296 end
Nenue@30 297 tagCoords['completionTag'] = QUEST_TAG_TCOORDS[tagInfo['completionTag']]
Nenue@30 298
Nenue@30 299 q.tagInfo = tagInfo
Nenue@30 300 q.tagCoords = tagCoords
Nenue@30 301 -- establishes the primary block tag for view compacting
Nenue@30 302 q.tagID = tagID
Nenue@30 303 q.tagName = tagName
Nenue@30 304
Nenue@30 305 -- action button information
Nenue@30 306 local link, icon, charges = GetQuestLogSpecialItemInfo(questLogIndex)
Nenue@30 307 local start, duration, enable = GetQuestLogSpecialItemCooldown(questLogIndex)
Nenue@30 308 if link or icon or charges then
Nenue@30 309 q.specialItem = {
Nenue@30 310 questID = questID,
Nenue@30 311 questLogIndex = questLogIndex,
Nenue@30 312 link = link,
Nenue@30 313 charges = charges,
Nenue@30 314 icon = icon,
Nenue@30 315 start = start,
Nenue@30 316 duration = duration,
Nenue@30 317 enable = enable,
Nenue@30 318 }
Nenue@30 319 end
Nenue@30 320
Nenue@32 321 if moneyInfo or timerInfo then
Nenue@32 322 numObjectives = #objectives
Nenue@32 323 end
Nenue@30 324
Nenue@30 325 -- raw data
Nenue@28 326 q.isComplete = isComplete
Nenue@28 327 q.startEvent = startEvent
Nenue@28 328 q.isAutoComplete = isAutoComplete
Nenue@28 329 q.questType = questType
Nenue@28 330 q.isTask = isTask
Nenue@28 331 q.isStory = isStory
Nenue@28 332 q.isOnMap = isOnMap
Nenue@28 333 q.hasLocalPOI = hasLocalPOI
Nenue@28 334 q.frequency = frequency
Nenue@28 335 q.isComplete = isComplete
Nenue@28 336 q.isStory = isStory
Nenue@28 337 q.isTask = isTask
Nenue@31 338 q.statusKey = temp_status
Nenue@32 339 q.selected = (questID == superTrackQuestID)
Nenue@28 340
Nenue@32 341 T.SetRewards(q, questID)
Nenue@32 342
Nenue@34 343 q.questID = questID
Nenue@34 344 q.logIndex = questLogIndex
Nenue@34 345 q.watchIndex = watchIndex
Nenue@34 346 q.id = questID
Nenue@30 347 self.WatchInfo[watchIndex] = q
Nenue@30 348 self.LogInfo[questLogIndex] = q
Nenue@28 349
Nenue@30 350 if Devian and Devian.InWorkspace() then
Nenue@34 351 print('|cFF00DDFFstatus:|r', temp_status, '|cFF00FF00questLogIndex|r:', questLogIndex, title)
Nenue@30 352 local temp ={}
Nenue@30 353 local data_txt = '|cFFFF4400values:|r'
Nenue@30 354 for k,v in pairs(q) do
Nenue@30 355 if type(v) =='number' then
Nenue@30 356 data_txt = data_txt .. ' |cFFFFFF00'..k..'|r: ' .. tostring(v)
Nenue@30 357 elseif type(v) == 'table' then
Nenue@30 358 tinsert(temp, k)
Nenue@28 359 end
Nenue@28 360 end
Nenue@30 361 print(data_txt)
Nenue@30 362 sort(temp, function(a,b) return a < b end)
Nenue@30 363 for i, k in ipairs(temp) do
Nenue@30 364 print('|cFF00FF00'..k..'|r')
Nenue@30 365 for kk,v in pairs(q[k]) do
Nenue@30 366 print(' ', kk, '=', v)
Nenue@30 367 end
Nenue@28 368 end
Nenue@28 369 end
Nenue@28 370
Nenue@30 371 return q
Nenue@30 372 end
Nenue@28 373
Nenue@30 374 Quest.GetObjectives = function(questLogIndex, numObjectives, isComplete, isSequenced, isStory)
Nenue@30 375 local objectives = {}
Nenue@30 376 for i = 1, numObjectives do
Nenue@30 377 local text, type, finished = GetQuestLogLeaderBoard(i, questLogIndex)
Nenue@34 378 print(format(' |cFFFF4400GetObjectives:|r #%d %s %s %s', i, tostring(type), tostring(text), tostring(finished)))
Nenue@30 379 objectives[i] = {
Nenue@28 380 index = i,
Nenue@28 381 type = type,
Nenue@28 382 text = text,
Nenue@28 383 finished = finished
Nenue@28 384 }
Nenue@28 385 end
Nenue@30 386 return objectives
Nenue@28 387 end
Nenue@28 388
Nenue@30 389 local huge, sqrt = math.huge, math.sqrt
Nenue@28 390 Quest.GetClosest = function()
Nenue@28 391 local minID, minTitle
Nenue@30 392 local minDist = huge
Nenue@28 393 local numQuests = GetNumQuestLogEntries()
Nenue@28 394 for questIndex = 1, numQuests do
Nenue@28 395 local distance, onContinent = GetDistanceSqToQuest(questIndex)
Nenue@28 396 local title, level, _, _, _, _, _, _, questID = GetQuestLogTitle(questIndex)
Nenue@28 397 if onContinent and distance < minDist then
Nenue@28 398 minDist = distance
Nenue@28 399 minTitle = title
Nenue@28 400 minID = questID
Nenue@28 401 end
Nenue@28 402 end
Nenue@28 403
Nenue@30 404 print('nearest quest is', minTitle, 'by', sqrt(minDist))
Nenue@28 405 return minID, minTitle, minDist
Nenue@28 406 end
Nenue@28 407
Nenue@28 408 Quest.OnTurnIn = function(self, questID, xp, money)
Nenue@28 409 end
Nenue@28 410
Nenue@29 411 Quest.Select = function (handler, block)
Nenue@29 412 if block.info.isAutoComplete and block.info.isComplete then
Nenue@34 413 ShowQuestComplete(block.info.logIndex)
Nenue@28 414 else
Nenue@29 415 SetSuperTrackedQuestID(block.info.questID)
Nenue@28 416 end
Nenue@28 417 end
Nenue@28 418
Nenue@29 419 Quest.Link = function(handler, block)
Nenue@34 420 local questLink = GetQuestLink(block.info.logIndex);
Nenue@28 421 if ( questLink ) then
Nenue@28 422 ChatEdit_InsertLink(questLink);
Nenue@28 423 end
Nenue@28 424 end
Nenue@28 425
Nenue@29 426 Quest.Open = function(handler, block)
Nenue@29 427 QuestMapFrame_OpenToQuestDetails(block.info.questID)
Nenue@28 428 end
Nenue@28 429
Nenue@29 430 Quest.Remove = function(handler, block)
Nenue@34 431 print('removing', block.info.logIndex, 'from watcher')
Nenue@34 432 RemoveQuestWatch(block.info.logIndex)
Nenue@29 433 end