annotate ObjectiveUI.lua @ 5:e9b61fd5f607

- use IsQuestWatched as the determinant for setting action button updates - check for block match-up in deferred action button updates
author Nenue
date Thu, 31 Mar 2016 15:58:08 -0400
parents 3397aae1f44d
children 589de8ea05b9
rev   line source
Nenue@0 1 --- ${PACKAGE_NAME}
Nenue@0 2 -- @file-author@
Nenue@0 3 -- @project-revision@ @project-hash@
Nenue@0 4 -- @file-revision@ @file-hash@
Nenue@0 5 -- Created: 3/29/2016 7:07 PM
Nenue@0 6 local B = select(2,...).frame
Nenue@0 7 local mod = B:RegisterModule("ObjectiveTracker", _G.VeneerObjectiveWrapper, 'BuffFrame')
Nenue@0 8 local print = B.print('Objectives')
Nenue@0 9 local Tracker, AutoQuest, Quest, Cheevs = mod.Tracker, mod.AutoQuest, mod.Quest, mod.Cheevs
Nenue@0 10
Nenue@0 11 --------------------------------------------------------------------
Nenue@3 12 --- Tracker-specific widgets and their handlers
Nenue@0 13 --------------------------------------------------------------------
Nenue@0 14
Nenue@0 15 Tracker.Select = function(self) end
Nenue@0 16 Tracker.Open = function(self) end
Nenue@0 17 Tracker.Remove = function(self) end
Nenue@0 18 Tracker.Report = function(self)
Nenue@0 19 print('Stats:', self.numWatched,'items tracked,', self.numBlocks,'blocks assigned.')
Nenue@0 20 end
Nenue@0 21
Nenue@0 22 Tracker.OnMouseUp = function(self, button)
Nenue@1 23
Nenue@1 24 if self.initialButton == 'LeftButton' then
Nenue@0 25 self:Select()
Nenue@0 26 mod.UpdateWrapper()
Nenue@1 27 if self.modShift then
Nenue@1 28 self:Remove()
Nenue@1 29 end
Nenue@0 30 elseif button == 'RightButton' then
Nenue@0 31 self:Open()
Nenue@0 32 end
Nenue@1 33 self.initialButton = nil
Nenue@1 34 self.modShift = nil
Nenue@0 35 print('|cFFFF8800'..tostring(self:GetName())..':MouseUp()|r ->',self.info.trackingID)
Nenue@0 36 end
Nenue@0 37
Nenue@0 38 Tracker.OnMouseDown = function(self, button)
Nenue@1 39 self.initialButton = button
Nenue@1 40 self.modShift = IsShiftKeyDown()
Nenue@0 41 if button == 'LeftButton' then
Nenue@0 42 self:SetStyle('Active')
Nenue@0 43 end
Nenue@0 44 print(self.info.title)
Nenue@0 45 end
Nenue@0 46
Nenue@0 47 -----------------------------
Nenue@0 48 --- AUTO_QUEST
Nenue@0 49 AutoQuest.name = "Remote Quests"
Nenue@0 50 AutoQuest.GetNumWatched = GetNumAutoQuestPopUps
Nenue@0 51
Nenue@0 52 -----------------------------
Nenue@0 53 --- QUEST
Nenue@0 54 Quest.name = "Quests"
Nenue@0 55 Quest.Select = function(self)
Nenue@0 56 SetSuperTrackedQuestID(self.info.questID)
Nenue@0 57 end
Nenue@0 58 Quest.Open = function(self)
Nenue@1 59 QuestMapFrame_OpenToQuestDetails(self.info.questID)
Nenue@1 60 end
Nenue@1 61
Nenue@1 62 Quest.Remove = function(self)
Nenue@5 63 print('removing', self.info.questLogIndex, 'from watcher')
Nenue@5 64 RemoveQuestWatch(self.info.questLogIndex)
Nenue@5 65
Nenue@5 66 mod.Quest.LogBlock[self.info.questLogIndex] = nil
Nenue@5 67 mod.Quest.QuestBlock[self.info.questID] = nil
Nenue@1 68 QuestPOIUpdateIcons()
Nenue@5 69 mod.UpdateWrapper()
Nenue@0 70 end
Nenue@0 71
Nenue@0 72
Nenue@0 73 -----------------------------
Nenue@0 74 --- CHEEVS
Nenue@0 75 Cheevs.Select = function(self)
Nenue@0 76 end
Nenue@0 77
Nenue@0 78 Cheevs.Open = function(self)
Nenue@3 79 if ( not AchievementFrame ) then
Nenue@3 80 AchievementFrame_LoadUI();
Nenue@3 81 end
Nenue@3 82 if ( not AchievementFrame:IsShown() ) then
Nenue@3 83 AchievementFrame_ToggleAchievementFrame();
Nenue@3 84 end
Nenue@3 85 AchievementFrame_SelectAchievement(self.info.cheevID);
Nenue@0 86 end
Nenue@0 87
Nenue@1 88 ----------------------------------------------------------------------------------------
Nenue@1 89 --- frame template and scripts lifted from "QuestKing 2" by Barjack
Nenue@1 90 --- url: http://mods.curse.com/addons/wow/questking
Nenue@1 91 ----------------------------------------------------------------------------------------
Nenue@1 92 local usedButtons = mod.Quest.itemButtons
Nenue@1 93 local freeButtons = mod.Quest.freeButtons
Nenue@1 94 mod.SetItemButton = function(block, info)
Nenue@1 95 local itemInfo = info.specialItem
Nenue@1 96 if not itemInfo then
Nenue@1 97 return
Nenue@1 98 end
Nenue@1 99 --- .specialItem :: {link = link, charges = charges, icon = icon, start = start, duration = duration, enable = enable}
Nenue@1 100
Nenue@1 101
Nenue@1 102 local itemButton
Nenue@1 103 if not info.itemButton then
Nenue@1 104 if #freeButtons >= 1 then
Nenue@2 105 print(' |cFF00FFFFfound a free button')
Nenue@1 106 itemButton = freeButtons[#freeButtons]
Nenue@1 107 freeButtons[#freeButtons] = nil
Nenue@2 108 if itemButton.block then
Nenue@2 109 itemButton.block.itemButton = nil
Nenue@2 110 itemButton.block = nil
Nenue@2 111 end
Nenue@1 112 else
Nenue@1 113 local buttonIndex = mod.Quest.numButtons + #freeButtons + 1
Nenue@1 114 itemButton = CreateFrame('Button', 'VeneerQuestItemButton' .. buttonIndex, UIParent, 'VeneerItemButtonTemplate')
Nenue@1 115 itemButton.buttonIndex = buttonIndex
Nenue@1 116 itemButton:SetSize(48, 48)
Nenue@1 117 itemButton:GetNormalTexture():SetSize(80,80)
Nenue@5 118 print(' |cFFFF4400starting new button', itemButton:GetName())
Nenue@1 119 end
Nenue@1 120 mod.Quest.numButtons = mod.Quest.numButtons + 1
Nenue@1 121 else
Nenue@1 122 itemButton = info.itemButton
Nenue@5 123 print(' |cFF00FF00found assigned button', itemButton:GetName())
Nenue@2 124
Nenue@1 125 end
Nenue@1 126 -- set values
Nenue@2 127
Nenue@5 128 info.itemButton = itemButton
Nenue@5 129 usedButtons[info.questID] = itemButton
Nenue@5 130 print(' |cFF8800FFassigning|r', itemButton:GetName(), 'to quest|cFF00FF00', info.questID, '|rat|cFFFFFF00', block:GetName(),'|r')
Nenue@2 131
Nenue@5 132 for k,v in pairs(usedButtons) do
Nenue@5 133 print('|cFFFF44DD'..k..'|r', v:GetName())
Nenue@5 134 end
Nenue@1 135
Nenue@1 136 itemButton:SetAttribute("type", "item")
Nenue@1 137 itemButton:SetAttribute("item", itemInfo.link)
Nenue@1 138
Nenue@2 139 itemButton.questID = info.questID
Nenue@1 140 itemButton.questLogIndex = info.questLogIndex
Nenue@1 141 itemButton.charges = itemInfo.charges
Nenue@1 142 itemButton.rangeTimer = -1
Nenue@1 143 itemButton.block = block
Nenue@1 144
Nenue@1 145 SetItemButtonTexture(itemButton, itemInfo.icon)
Nenue@1 146 SetItemButtonCount(itemButton, itemInfo.charges)
Nenue@1 147 Veneer_QuestObjectiveItem_UpdateCooldown(itemButton);
Nenue@1 148
Nenue@1 149 return itemButton
Nenue@1 150 end
Nenue@1 151 --- Clear an itemButton from the given block
Nenue@2 152 mod.FreeItemButtons = function(block)
Nenue@2 153
Nenue@2 154 if block.itemButton then
Nenue@2 155 local itemButton = block.itemButton
Nenue@5 156 if itemButton.questID ~= block.info.questID then
Nenue@5 157 block.itemButton = nil
Nenue@5 158 itemButton.block = mod.Quest.InfoBlock[itemButton.questID]
Nenue@5 159 else
Nenue@5 160 itemButton.block = nil
Nenue@5 161 itemButton:Hide()
Nenue@2 162
Nenue@5 163 usedButtons[itemButton.questID] = nil
Nenue@5 164 freeButtons[#freeButtons + 1] = itemButton
Nenue@5 165 mod.Quest.numButtons = mod.Quest.numButtons - 1
Nenue@5 166 print('|cFFFF0088released', itemButton:GetName(),'and', block:GetName())
Nenue@5 167 end
Nenue@1 168 end
Nenue@1 169 end
Nenue@1 170
Nenue@1 171 function Veneer_QuestObjectiveItem_OnUpdate (self, elapsed)
Nenue@1 172 -- Handle range indicator
Nenue@1 173 local rangeTimer = self.rangeTimer
Nenue@1 174 if (rangeTimer) then
Nenue@1 175 rangeTimer = rangeTimer - elapsed
Nenue@1 176 if (rangeTimer <= 0) then
Nenue@1 177 local link, item, charges, showItemWhenComplete = GetQuestLogSpecialItemInfo(self.questLogIndex)
Nenue@1 178 if ((not charges) or (charges ~= self.charges)) then
Nenue@2 179 mod.UpdateWrapper()
Nenue@1 180 return
Nenue@1 181 end
Nenue@1 182
Nenue@1 183 local count = self.HotKey
Nenue@1 184 local valid = IsQuestLogSpecialItemInRange(self.questLogIndex)
Nenue@1 185 if (valid == 0) then
Nenue@1 186 count:Show()
Nenue@1 187 count:SetVertexColor(1.0, 0.1, 0.1)
Nenue@1 188 elseif (valid == 1) then
Nenue@1 189 count:Show()
Nenue@1 190 count:SetVertexColor(0.6, 0.6, 0.6)
Nenue@1 191 else
Nenue@1 192 count:Hide()
Nenue@1 193 end
Nenue@1 194 rangeTimer = TOOLTIP_UPDATE_TIME
Nenue@1 195 end
Nenue@1 196
Nenue@1 197 self.rangeTimer = rangeTimer
Nenue@1 198 end
Nenue@1 199 end
Nenue@1 200
Nenue@1 201 function Veneer_QuestObjectiveItem_UpdateCooldown (itemButton)
Nenue@1 202 local start, duration, enable = GetQuestLogSpecialItemCooldown(itemButton.questLogIndex)
Nenue@1 203 if (start) then
Nenue@1 204 CooldownFrame_SetTimer(itemButton.Cooldown, start, duration, enable)
Nenue@1 205 if (duration > 0 and enable == 0) then
Nenue@1 206 SetItemButtonTextureVertexColor(itemButton, 0.4, 0.4, 0.4)
Nenue@1 207 else
Nenue@1 208 SetItemButtonTextureVertexColor(itemButton, 1, 1, 1)
Nenue@1 209 end
Nenue@1 210 end
Nenue@3 211 end
Nenue@3 212
Nenue@3 213 -----------------------------------------
Nenue@3 214 -- Progress slider for achievements, and area objecitves
Nenue@3 215 -- Stored by criteria ID to account for multiple bars in one cheev
Nenue@3 216 Tracker.SetProgress = function(criteria, info)
Nenue@3 217 end
Nenue@3 218
Nenue@3 219 mod.WidgetRegistry = {}
Nenue@3 220 local wr = mod.WidgetRegistry
Nenue@3 221 mod.SetWidget = function(criteria, info)
Nenue@3 222 local widget
Nenue@3 223 if not wr[criteria.type] then
Nenue@3 224 print('|cFFFF4400[[WidgetTemplate]]|r', criteria.type)
Nenue@3 225 wr[criteria.type] = { free = {}, used = {}, }
Nenue@3 226 end
Nenue@3 227 if #wr[criteria.type].free == 0 then
Nenue@3 228
Nenue@3 229 local frameID = #wr[criteria.type].free + #wr[criteria.type].used
Nenue@3 230 widget = CreateFrame('Frame', 'VeneerCriteria' .. criteria.type .. frameID, VeneerObjectiveWrapper, 'VeneerObjectiveCriteria' .. criteria.type)
Nenue@3 231 end
Nenue@3 232 end
Nenue@3 233 mod.RegisterWidget = function(frame)
Nenue@3 234 tinsert(wr[frame.widgetType].free, frame)
Nenue@3 235 end
Nenue@3 236 mod.InitializeWidget = function(frame)
Nenue@3 237
Nenue@3 238 end
Nenue@3 239 mod.ReleaseWidget = function(frame)
Nenue@3 240
Nenue@3 241 if tContains(wr[frame.widgetType], frame) then
Nenue@3 242 end
Nenue@1 243 end