annotate classes/MultiCastButton.lua @ 174:09f7af2f53f8

Pretty totem bar textures
author Flick <flickerstreak@gmail.com>
date Wed, 20 Oct 2010 00:41:10 +0000
parents 49d49063cb79
children df68b5a40490
rev   line source
flickerstreak@161 1 local ReAction = ReAction
flickerstreak@161 2 local L = ReAction.L
flickerstreak@161 3 local _G = _G
flickerstreak@161 4 local CreateFrame = CreateFrame
flickerstreak@161 5 local format = string.format
flickerstreak@161 6 local unpack = unpack
flickerstreak@161 7 local GetCVar = GetCVar
flickerstreak@161 8 local GameTooltip_SetDefaultAnchor = GameTooltip_SetDefaultAnchor
flickerstreak@161 9 local CooldownFrame_SetTimer = CooldownFrame_SetTimer
flickerstreak@161 10 local InCombatLockdown = InCombatLockdown
flickerstreak@161 11 local IsUsableSpell = IsUsableSpell
flickerstreak@161 12 local IsUsableAction = IsUsableAction
flickerstreak@161 13 local IsSpellKnown = IsSpellKnown
flickerstreak@161 14 local IsSpellInRange = IsSpellInRange
flickerstreak@161 15 local IsActionInRange = IsActionInRange
flickerstreak@161 16 local GetSpellInfo = GetSpellInfo
flickerstreak@161 17 local GetSpellCooldown = GetSpellCooldown
flickerstreak@161 18 local GetActionCooldown = GetActionCooldown
flickerstreak@161 19 local GetSpellTexture = GetSpellTexture
flickerstreak@161 20 local GetActionTexture = GetActionTexture
flickerstreak@161 21 local GetMultiCastTotemSpells = GetMultiCastTotemSpells
flickerstreak@161 22
flickerstreak@161 23 --[[
flickerstreak@161 24 Blizzard Constants:
flickerstreak@161 25 - NUM_MULTI_CAST_BUTTONS_PER_PAGE = 4
flickerstreak@161 26 - NUM_MULTI_CAST_PAGES = 3
flickerstreak@166 27 - SHAMAN_TOTEM_PRIORITIES = { } -- sets the order of the totems
flickerstreak@161 28 - TOTEM_MULTI_CAST_SUMMON_SPELLS = { } -- list of summon spellIDs
flickerstreak@161 29 - TOTEM_MULTI_CAST_RECALL_SPELLS = { } -- list of recall spellIDs
flickerstreak@161 30
flickerstreak@161 31 Blizzard Events:
flickerstreak@161 32 - UPDATE_MULTI_CAST_ACTIONBAR
flickerstreak@161 33
flickerstreak@161 34 Blizzard APIs:
flickerstreak@161 35 - GetMultiCastBarOffset() : returns 6
flickerstreak@161 36
flickerstreak@161 37 - SetMultiCastSpell(actionID, spellID) (protected) OR
flickerstreak@161 38 SetAttribute("type","multispell")
flickerstreak@161 39 SetAttribute("action",actionID)
flickerstreak@161 40 SetAttribute("spell",spellID)
flickerstreak@161 41
flickerstreak@161 42 note: multicast actionID page is NUM_ACTIONBAR_PAGES + GetMultiCastBarOffset(),
flickerstreak@161 43 so that's action ID 132-144.
flickerstreak@161 44
flickerstreak@161 45 - spell1, spell2, spell3, ... = GetMultiCastTotemSpells(slot)
flickerstreak@167 46 returns spellIDs for all known totems that fit that slot. This function is available in
flickerstreak@167 47 the secure environment.
flickerstreak@161 48
flickerstreak@161 49 Blizzard textures:
flickerstreak@161 50 All the textures for the multicast bar (arrows, empty-slot icons, etc) are part of a single
flickerstreak@161 51 texture: each texture uses SetTexCoord() to display only a slice of the textures. I suppose
flickerstreak@161 52 this is to slightly optimize texture load performance, but it makes the UI code more clumsy.
flickerstreak@161 53
flickerstreak@161 54 Each totem button and arrow has a colored border indicating its elemental type.
flickerstreak@174 55
flickerstreak@174 56 TODO:
flickerstreak@174 57 - make whether to show the colored border configurable (looks really bad with ButtonFacade:Zoomed)
flickerstreak@174 58 - apply ButtonFacade to the flyout buttons? Or at least zoom the textures slightly?
flickerstreak@174 59 - use a multiplier with SetTexCoord on totem bar texture?
flickerstreak@161 60
flickerstreak@161 61 Design Notes:
flickerstreak@161 62 - Only the header has a secure context. All other frames execute in its context.
flickerstreak@161 63
flickerstreak@161 64 - Each button is either type "spell" (summon/recall) or type "action" (totem action IDs are
flickerstreak@161 65 GetBonusBarOffset()=6, 132-144) with 3 pages of 4 buttons. The paging is controlled by
flickerstreak@161 66 the summon flyout, which is also paged with the summon spells (the recall button is not paged)
flickerstreak@161 67
flickerstreak@161 68 - A spell list is updated in the secure context at setup time (TODO: redo setup when learning new
flickerstreak@161 69 spells) with the list of spells known for each slot.
flickerstreak@161 70
flickerstreak@161 71 - Each button (except recall) has an arrow button which appears on mouseover and when clicked
flickerstreak@161 72 opens the flyout via a wrapped OnClick handler. When the flyout is open, the arrow does not
flickerstreak@161 73 appear.
flickerstreak@161 74
flickerstreak@161 75 - A single flyout with N+1 (1 slot is to select no totem for the set) flyout-buttons is a child
flickerstreak@161 76 of the bar. Each time the flyout panel is opened, the individual buttons grab their corresponding
flickerstreak@161 77 spell/type from the list, according to the slot which opened the flyout. Each button either sets
flickerstreak@161 78 the current page (summon) or sets a multispell to an actionID via type="multispell". None of them
flickerstreak@161 79 actually cast any spells (though, I suppose we could modify this so that e.g. configurable
flickerstreak@161 80 right-click casts the spell). The flyout also has a close button which closes the flyout: the
flickerstreak@161 81 flyout-open code positions the close button anchored to the last button in the flyout (which
flickerstreak@161 82 changes dynamically because each slot has a different number of items in the list).
flickerstreak@161 83
flickerstreak@161 84 - Multicast sets are not stances, there's no need (or ability) to handle swapping sets if one of
flickerstreak@167 85 the summon spells is cast from elsewhere.
flickerstreak@167 86
flickerstreak@167 87 - The default UI has Call of the Elements always selected on UI load. This module remembers the last
flickerstreak@167 88 selected one and restores it.
flickerstreak@161 89
flickerstreak@161 90
flickerstreak@161 91 ]]--
flickerstreak@161 92
flickerstreak@161 93
flickerstreak@161 94 --
flickerstreak@161 95 -- Secure snippets
flickerstreak@161 96 --
flickerstreak@161 97
flickerstreak@161 98 -- bar
flickerstreak@161 99 local _bar_init = -- function(self)
flickerstreak@161 100 [[
flickerstreak@161 101 -- set up some globals in the secure environment
flickerstreak@161 102 flyout = self:GetFrameRef("flyout")
flickerstreak@167 103 flyoutSlot = nil
flickerstreak@167 104 summonSlot = self:GetAttribute("summonSlot")
flickerstreak@167 105 recallSlot = self:GetAttribute("recallSlot")
flickerstreak@161 106 baseActionID = self:GetAttribute("baseActionID")
flickerstreak@167 107 slotsPerPage = self:GetAttribute("slotsPerPage")
flickerstreak@167 108 currentPage = currentPage or self:GetAttribute("lastSummon") or 1
flickerstreak@167 109
flickerstreak@167 110 totemIDsBySlot = newtable()
flickerstreak@167 111 for i = 1, slotsPerPage do
flickerstreak@167 112 totemIDsBySlot[i] = self:GetAttribute("TOTEM_PRIORITY_"..i)
flickerstreak@161 113 end
flickerstreak@167 114
flickerstreak@168 115 -- these are set up in bar:SetupBarHeader()
flickerstreak@168 116 flyoutChildren = flyoutChildren or newtable()
flickerstreak@168 117 summonSpells = summonSpells or newtable()
flickerstreak@161 118 ]]
flickerstreak@161 119
flickerstreak@161 120 local _onstate_multispellpage = -- function(self, stateid, newstate)
flickerstreak@161 121 [[
flickerstreak@167 122 currentPage = tonumber(newstate)
flickerstreak@167 123 control:CallMethod("UpdateLastSummon",currentPage)
flickerstreak@161 124 control:ChildUpdate()
flickerstreak@161 125 ]]
flickerstreak@161 126
flickerstreak@161 127
flickerstreak@161 128 -- buttons
flickerstreak@161 129 local _childupdate = -- function(self, snippetid, message)
flickerstreak@161 130 [[
flickerstreak@167 131 local t = self:GetAttribute("type")
flickerstreak@167 132 self:SetAttribute(t, self:GetAttribute(t.."-page"..currentPage))
flickerstreak@161 133 ]]
flickerstreak@161 134
flickerstreak@161 135 local _onEnter = -- function(self)
flickerstreak@161 136 -- for whatever reason, RegisterAutoHide is unreliable
flickerstreak@161 137 -- unless you re-anchor the frame prior to calling it.
flickerstreak@161 138 -- Even then, it's still not terribly reliable.
flickerstreak@161 139 [[
flickerstreak@167 140 local slot = self:GetAttribute("bar-idx")
flickerstreak@167 141 local arrow = owner:GetFrameRef("arrow-"..slot)
flickerstreak@167 142 if arrow and not arrow:IsShown() and not (flyout:IsVisible() and flyoutSlot == slot) then
flickerstreak@167 143 arrow:ClearAllPoints()
flickerstreak@167 144 arrow:SetPoint("BOTTOM",self,"TOP",0,0)
flickerstreak@167 145 arrow:Show()
flickerstreak@161 146 arrow:RegisterAutoHide(0)
flickerstreak@161 147 arrow:AddToAutoHide(self)
flickerstreak@161 148 end
flickerstreak@161 149 ]]
flickerstreak@161 150
flickerstreak@161 151
flickerstreak@161 152 -- flyout arrow
flickerstreak@161 153 local _arrow_openFlyout = -- function(self)
flickerstreak@161 154 [[
flickerstreak@167 155 local slot = self:GetAttribute("bar-idx")
flickerstreak@174 156 local totemID = totemIDsBySlot[slot - (summonSlot or 0)]
flickerstreak@174 157 if totemID == 0 then
flickerstreak@174 158 totemID = "summon"
flickerstreak@174 159 end
flickerstreak@174 160
flickerstreak@167 161 local lastButton, lastPage
flickerstreak@167 162 for page, b in ipairs(flyoutChildren) do
flickerstreak@167 163 b:Hide()
flickerstreak@174 164 b:SetAttribute("totemSlot",totemID)
flickerstreak@167 165 if slot == summonSlot then
flickerstreak@167 166 local spellID = self:GetParent():GetAttribute("spell-page"..page)
flickerstreak@167 167 if spellID then
flickerstreak@161 168 b:SetAttribute("type","changePage")
flickerstreak@167 169 b:SetAttribute("spell",spellID)
flickerstreak@167 170 b:Show()
flickerstreak@167 171 lastButton = b
flickerstreak@167 172 lastPage = page
flickerstreak@167 173 end
flickerstreak@167 174 else
flickerstreak@168 175 local spell = select(page, 0, GetMultiCastTotemSpells(totemID) )
flickerstreak@168 176 if spell then
flickerstreak@161 177 b:SetAttribute("type","multispell")
flickerstreak@167 178 b:SetAttribute("action", baseActionID + (currentPage - 1)*slotsPerPage + totemID)
flickerstreak@168 179 b:SetAttribute("spell", spell)
flickerstreak@167 180 b:Show()
flickerstreak@167 181 lastButton = b
flickerstreak@167 182 lastPage = page
flickerstreak@161 183 end
flickerstreak@161 184 end
flickerstreak@161 185 end
flickerstreak@161 186
flickerstreak@161 187 local close = owner:GetFrameRef("close")
flickerstreak@161 188 if lastButton and close then
flickerstreak@161 189 close:ClearAllPoints()
flickerstreak@161 190 close:SetPoint("BOTTOM",lastButton,"TOP",0,0) -- TODO: better anchoring
flickerstreak@161 191 close:Show()
flickerstreak@174 192 control:CallMethod("UpdateFlyoutTextures",totemID)
flickerstreak@161 193 end
flickerstreak@161 194
flickerstreak@161 195 flyout:ClearAllPoints()
flickerstreak@161 196 flyout:SetPoint("BOTTOM",self,"BOTTOM",0,0) -- TODO: better anchoring
flickerstreak@167 197 if lastPage then
flickerstreak@167 198 flyout:SetHeight(lastPage * 27 + (close and close:GetHeight() or 0))
flickerstreak@161 199 end
flickerstreak@161 200 flyout:Show()
flickerstreak@161 201 flyout:RegisterAutoHide(1) -- TODO: configurable
flickerstreak@161 202 flyout:AddToAutoHide(owner)
flickerstreak@167 203 flyoutSlot = slot
flickerstreak@161 204 self:Hide()
flickerstreak@161 205 ]]
flickerstreak@161 206
flickerstreak@161 207 local _closeFlyout = -- function(self)
flickerstreak@161 208 [[
flickerstreak@161 209 flyout:Hide()
flickerstreak@161 210 ]]
flickerstreak@161 211
flickerstreak@161 212
flickerstreak@161 213 -- flyout child buttons
flickerstreak@161 214 local _flyout_child_preClick = -- function(self, button, down)
flickerstreak@161 215 [[
flickerstreak@161 216 local button = button
flickerstreak@161 217 if self:GetAttribute("type") == "changePage" then
flickerstreak@161 218 owner:SetAttribute("state-multispellpage",self:GetAttribute("index"))
flickerstreak@161 219 self:GetParent():Hide()
flickerstreak@161 220 return false
flickerstreak@161 221 else
flickerstreak@161 222 return nil, "close"
flickerstreak@161 223 end
flickerstreak@161 224 ]]
flickerstreak@161 225
flickerstreak@161 226 local _flyout_child_postClick = -- function(self, message, button, down)
flickerstreak@161 227 [[
flickerstreak@161 228 if message == "close" then
flickerstreak@161 229 self:GetParent():Hide() -- hide flyout after selecting
flickerstreak@161 230 end
flickerstreak@161 231 ]]
flickerstreak@161 232
flickerstreak@161 233
flickerstreak@161 234 --
flickerstreak@161 235 -- The Blizzard totem bar textures are all actually one big texture,
flickerstreak@174 236 -- with texcoord offsets. Shamelessly stolen from FrameXML/MultiCastActionBarFrame.lua
flickerstreak@161 237 --
flickerstreak@161 238 local TOTEM_TEXTURE = "Interface\\Buttons\\UI-TotemBar"
flickerstreak@161 239 local FLYOUT_UP_BUTTON_HL_TCOORDS = { 72/128, 92/128, 88/256, 98/256 }
flickerstreak@161 240 local FLYOUT_DOWN_BUTTON_HL_TCOORDS = { 72/128, 92/128, 69/256, 79/256 }
flickerstreak@174 241
flickerstreak@174 242 local SLOT_EMPTY_TCOORDS = {
flickerstreak@174 243 [EARTH_TOTEM_SLOT] = { 66/128, 96/128, 3/256, 33/256 },
flickerstreak@174 244 [FIRE_TOTEM_SLOT] = { 67/128, 97/128, 100/256, 130/256 },
flickerstreak@174 245 [WATER_TOTEM_SLOT] = { 39/128, 69/128, 209/256, 239/256 },
flickerstreak@174 246 [AIR_TOTEM_SLOT] = { 66/128, 96/128, 36/256, 66/256 },
flickerstreak@174 247 }
flickerstreak@174 248
flickerstreak@174 249 local SLOT_OVERLAY_TCOORDS = {
flickerstreak@174 250 [EARTH_TOTEM_SLOT] = { 1/128, 35/128, 172/256, 206/256 },
flickerstreak@174 251 [FIRE_TOTEM_SLOT] = { 36/128, 70/128, 172/256, 206/256 },
flickerstreak@174 252 [WATER_TOTEM_SLOT] = { 1/128, 35/128, 207/256, 240/256 },
flickerstreak@174 253 [AIR_TOTEM_SLOT] = { 36/128, 70/128, 137/256, 171/256 },
flickerstreak@174 254 }
flickerstreak@174 255
flickerstreak@174 256 local FLYOUT_UP_BUTTON_TCOORDS = {
flickerstreak@174 257 ["summon"] = { 99/128, 127/128, 84/256, 102/256 },
flickerstreak@174 258 [EARTH_TOTEM_SLOT] = { 99/128, 127/128, 160/256, 178/256 },
flickerstreak@174 259 [FIRE_TOTEM_SLOT] = { 99/128, 127/128, 122/256, 140/256 },
flickerstreak@174 260 [WATER_TOTEM_SLOT] = { 99/128, 127/128, 199/256, 217/256 },
flickerstreak@174 261 [AIR_TOTEM_SLOT] = { 99/128, 127/128, 237/256, 255/256 },
flickerstreak@174 262 }
flickerstreak@174 263
flickerstreak@174 264 local FLYOUT_DOWN_BUTTON_TCOORDS = {
flickerstreak@174 265 ["summon"] = { 99/128, 127/128, 65/256, 83/256 },
flickerstreak@174 266 [EARTH_TOTEM_SLOT] = { 99/128, 127/128, 141/256, 159/256 },
flickerstreak@174 267 [FIRE_TOTEM_SLOT] = { 99/128, 127/128, 103/256, 121/256 },
flickerstreak@174 268 [WATER_TOTEM_SLOT] = { 99/128, 127/128, 180/256, 198/256 },
flickerstreak@174 269 [AIR_TOTEM_SLOT] = { 99/128, 127/128, 218/256, 236/256 },
flickerstreak@174 270 }
flickerstreak@174 271
flickerstreak@174 272 local FLYOUT_TOP_TCOORDS = {
flickerstreak@174 273 ["summon"] = { 33/128, 65/128, 1/256, 23/256 },
flickerstreak@174 274 [EARTH_TOTEM_SLOT] = { 0/128, 32/128, 46/256, 68/256 },
flickerstreak@174 275 [FIRE_TOTEM_SLOT] = { 33/128, 65/128, 46/256, 68/256 },
flickerstreak@174 276 [WATER_TOTEM_SLOT] = { 0/128, 32/128, 1/256, 23/256 },
flickerstreak@174 277 [AIR_TOTEM_SLOT] = { 0/128, 32/128, 91/256, 113/256 },
flickerstreak@174 278 }
flickerstreak@174 279
flickerstreak@174 280 local FLYOUT_MIDDLE_TCOORDS = {
flickerstreak@174 281 ["summon"] = { 33/128, 65/128, 23/256, 43/256 },
flickerstreak@174 282 [EARTH_TOTEM_SLOT] = { 0/128, 32/128, 68/256, 88/256 },
flickerstreak@174 283 [FIRE_TOTEM_SLOT] = { 33/128, 65/128, 68/256, 88/256 },
flickerstreak@174 284 [WATER_TOTEM_SLOT] = { 0/128, 32/128, 23/256, 43/256 },
flickerstreak@174 285 [AIR_TOTEM_SLOT] = { 0/128, 32/128, 113/256, 133/256 },
flickerstreak@174 286 }
flickerstreak@161 287
flickerstreak@161 288 local eventList = {
flickerstreak@161 289 "ACTIONBAR_SLOT_CHANGED",
flickerstreak@161 290 "ACTIONBAR_UPDATE_STATE",
flickerstreak@161 291 "ACTIONBAR_UPDATE_USABLE",
flickerstreak@161 292 "ACTIONBAR_UPDATE_COOLDOWN",
flickerstreak@162 293 "UPDATE_BINDINGS",
flickerstreak@161 294 "UPDATE_MULTI_CAST_ACTIONBAR",
flickerstreak@161 295 }
flickerstreak@161 296
flickerstreak@161 297 --
flickerstreak@161 298 -- MultiCast Button class
flickerstreak@161 299 -- Inherits implementation methods from Action button class, but circumvents the constructor
flickerstreak@161 300 -- and redefines/removes some methods.
flickerstreak@161 301 --
flickerstreak@161 302 local Super = ReAction.Button
flickerstreak@161 303 local Action = ReAction.Button.Action
flickerstreak@161 304 local MultiCast = setmetatable( { }, { __index = Action } )
flickerstreak@161 305 ReAction.Button.MultiCast = MultiCast
flickerstreak@161 306
flickerstreak@161 307 function MultiCast:New( idx, btnConfig, bar )
flickerstreak@167 308 local maxIndex = bar.nTotemSlots or 0
flickerstreak@167 309 if bar.summonSlot then
flickerstreak@167 310 maxIndex = maxIndex + 1
flickerstreak@167 311 end
flickerstreak@167 312 if bar.recallSlot then
flickerstreak@167 313 maxIndex = maxIndex + 1
flickerstreak@161 314 end
flickerstreak@161 315
flickerstreak@167 316 if not bar.hasMulticast or idx > maxIndex then
flickerstreak@163 317 return false
flickerstreak@163 318 end
flickerstreak@163 319
flickerstreak@167 320 if idx < 1 then
flickerstreak@167 321 error("invalid index")
flickerstreak@167 322 end
flickerstreak@167 323
flickerstreak@167 324 local name = format("ReAction_%s_Totem_%d",bar:GetName(),idx)
flickerstreak@161 325
flickerstreak@161 326 self = Super.New(self, name, btnConfig, bar, idx, "SecureActionButtonTemplate, ActionButtonTemplate" )
flickerstreak@161 327
flickerstreak@161 328 local barFrame = bar:GetFrame()
flickerstreak@161 329 local f = self:GetFrame()
flickerstreak@161 330
flickerstreak@161 331 -- attributes
flickerstreak@167 332 local page = (idx == bar.recallSlot) and 1 or bar:GetConfig().lastSummon or 1
flickerstreak@167 333 if idx == bar.recallSlot or idx == bar.summonSlot then
flickerstreak@161 334 f:SetAttribute("type","spell")
flickerstreak@167 335 local spells = (idx == bar.summonSlot) and TOTEM_MULTI_CAST_SUMMON_SPELLS or TOTEM_MULTI_CAST_RECALL_SPELLS
flickerstreak@163 336 f:SetAttribute("spell",spells[page])
flickerstreak@161 337 for i, spell in ipairs(spells) do
flickerstreak@161 338 if spell and IsSpellKnown(spell) then
flickerstreak@161 339 f:SetAttribute("spell-page"..i, spell)
flickerstreak@161 340 end
flickerstreak@161 341 end
flickerstreak@161 342 else
flickerstreak@167 343 local offset = bar.summonSlot and 1 or 0
flickerstreak@167 344 local slot = SHAMAN_TOTEM_PRIORITIES[idx - offset]
flickerstreak@167 345 local baseAction = barFrame:GetAttribute("baseActionID") + slot
flickerstreak@174 346 self.totemSlot = slot
flickerstreak@161 347 f:SetAttribute("type","action")
flickerstreak@163 348 f:SetAttribute("action", baseAction + (page - 1) * NUM_MULTI_CAST_BUTTONS_PER_PAGE)
flickerstreak@161 349 for i = 1, NUM_MULTI_CAST_PAGES do
flickerstreak@161 350 f:SetAttribute("action-page"..i, baseAction + (i-1) * NUM_MULTI_CAST_BUTTONS_PER_PAGE)
flickerstreak@161 351 end
flickerstreak@174 352 if not f.overlayTex then
flickerstreak@174 353 local tx = f:CreateTexture("OVERLAY")
flickerstreak@174 354 tx:SetTexture(TOTEM_TEXTURE)
flickerstreak@174 355 tx:SetTexCoord(unpack(SLOT_OVERLAY_TCOORDS[self.totemSlot]))
flickerstreak@174 356 tx:SetWidth(34)
flickerstreak@174 357 tx:SetHeight(34)
flickerstreak@174 358 tx:SetPoint("CENTER")
flickerstreak@174 359 tx:Show()
flickerstreak@174 360 f.overlayTex = tx
flickerstreak@174 361 end
flickerstreak@161 362 end
flickerstreak@161 363 f:SetAttribute("bar-idx",idx)
flickerstreak@161 364
flickerstreak@161 365 -- non secure scripts
flickerstreak@161 366 f:SetScript("OnEvent", function(frame, ...) self:OnEvent(...) end)
flickerstreak@161 367 f:SetScript("OnEnter", function(frame) self:OnEnter() end)
flickerstreak@161 368 f:SetScript("OnLeave", function(frame) self:OnLeave() end)
flickerstreak@161 369 f:SetScript("OnAttributeChanged", function(frame, attr, value) self:OnAttributeChanged(attr, value) end)
flickerstreak@161 370 f:SetScript("PostClick", function(frame, ...) self:PostClick(...) end)
flickerstreak@161 371
flickerstreak@161 372 -- secure handlers
flickerstreak@167 373 if idx ~= bar.recallSlot then
flickerstreak@161 374 f:SetAttribute("_childupdate",_childupdate)
flickerstreak@161 375 end
flickerstreak@161 376 barFrame:WrapScript(f, "OnEnter", _onEnter)
flickerstreak@161 377
flickerstreak@161 378 -- event registration
flickerstreak@161 379 f:EnableMouse(true)
flickerstreak@161 380 f:RegisterForClicks("AnyUp")
flickerstreak@161 381 for _, evt in pairs(eventList) do
flickerstreak@161 382 f:RegisterEvent(evt)
flickerstreak@161 383 end
flickerstreak@161 384
flickerstreak@162 385 -- Set up a proxy for the icon texture for use with ButtonFacade
flickerstreak@174 386 local SetTexCoordRaw = self.frames.icon.SetTexCoord
flickerstreak@162 387 self.frames.icon.SetTexCoord = function( tx, ... )
flickerstreak@162 388 if self:GetIconTexture() == TOTEM_TEXTURE then
flickerstreak@174 389 SetTexCoordRaw(tx,select(2,self:GetIconTexture()))
flickerstreak@162 390 else
flickerstreak@174 391 SetTexCoordRaw(tx,...)
flickerstreak@162 392 end
flickerstreak@162 393 end
flickerstreak@162 394
flickerstreak@161 395 -- attach to skinner
flickerstreak@161 396 bar:SkinButton(self)
flickerstreak@161 397
flickerstreak@161 398 f:Show()
flickerstreak@161 399
flickerstreak@174 400 -- open arrow and flyout background textures
flickerstreak@167 401 if idx ~= bar.recallSlot then
flickerstreak@174 402 local arrow = f._arrowFrame or CreateFrame("Button", nil, f, "SecureFrameTemplate")
flickerstreak@174 403 f._arrowFrame = arrow
flickerstreak@161 404 arrow:SetWidth(28)
flickerstreak@174 405 arrow:SetHeight(18)
flickerstreak@161 406 arrow:SetPoint("BOTTOM",self:GetFrame(),"TOP",0,0) -- TODO: better anchoring
flickerstreak@161 407 arrow:SetNormalTexture(TOTEM_TEXTURE)
flickerstreak@174 408 local slot = self.totemSlot or "summon"
flickerstreak@174 409 arrow:GetNormalTexture():SetTexCoord( unpack(FLYOUT_UP_BUTTON_TCOORDS[slot]) )
flickerstreak@161 410 arrow:SetHighlightTexture(TOTEM_TEXTURE)
flickerstreak@161 411 arrow:GetHighlightTexture():SetTexCoord( unpack(FLYOUT_UP_BUTTON_HL_TCOORDS) )
flickerstreak@161 412 arrow:SetAttribute("bar-idx",idx)
flickerstreak@161 413 arrow:Hide()
flickerstreak@161 414 barFrame:WrapScript(arrow, "OnClick", _arrow_openFlyout)
flickerstreak@167 415 barFrame:SetFrameRef("arrow-"..idx,arrow)
flickerstreak@161 416 end
flickerstreak@161 417
flickerstreak@161 418 self:Refresh()
flickerstreak@161 419
flickerstreak@161 420 return self
flickerstreak@161 421 end
flickerstreak@161 422
flickerstreak@161 423 function MultiCast:Destroy()
flickerstreak@174 424 local barFrame = self.bar:GetFrame()
flickerstreak@174 425 local f = self:GetFrame()
flickerstreak@174 426 pcall( barFrame.UnwrapScript, barFrame, f, "OnEnter" ) -- ignore errors
flickerstreak@174 427 if f._arrowFrame then
flickerstreak@174 428 pcall( barFrame.UnwrapScript, barFrame, f._arrowFrame,"OnClick" ) -- ignore errors
flickerstreak@174 429 end
flickerstreak@161 430 Super.Destroy(self)
flickerstreak@161 431 end
flickerstreak@161 432
flickerstreak@161 433 function MultiCast:Refresh()
flickerstreak@161 434 Super.Refresh(self)
flickerstreak@161 435 self:UpdateAction()
flickerstreak@161 436 end
flickerstreak@161 437
flickerstreak@161 438 function MultiCast:ShowGrid( show )
flickerstreak@161 439 end
flickerstreak@161 440
flickerstreak@161 441 function MultiCast:ShowGridTemp( show )
flickerstreak@161 442 end
flickerstreak@161 443
flickerstreak@161 444 function MultiCast:AcquireActionID()
flickerstreak@161 445 end
flickerstreak@161 446
flickerstreak@161 447 function MultiCast:ReleaseActionID()
flickerstreak@161 448 end
flickerstreak@161 449
flickerstreak@161 450 function MultiCast:UpdateShowGrid()
flickerstreak@161 451 end
flickerstreak@161 452
flickerstreak@161 453 function MultiCast:UpdateBorder()
flickerstreak@161 454 end
flickerstreak@161 455
flickerstreak@161 456 function MultiCast:UpdateMacroText()
flickerstreak@161 457 end
flickerstreak@161 458
flickerstreak@161 459 function MultiCast:UpdateCount()
flickerstreak@161 460 end
flickerstreak@161 461
flickerstreak@161 462 function MultiCast:UpdateCheckedState()
flickerstreak@161 463 local action = self:GetActionID()
flickerstreak@161 464 if action and IsCurrentAction(action) then
flickerstreak@161 465 self:GetFrame():SetChecked(1)
flickerstreak@161 466 else
flickerstreak@161 467 self:GetFrame():SetChecked(0)
flickerstreak@161 468 end
flickerstreak@161 469 end
flickerstreak@161 470
flickerstreak@161 471 function MultiCast:RefreshHasActionAttributes()
flickerstreak@161 472 end
flickerstreak@161 473
flickerstreak@161 474 function MultiCast:UpdateFlash()
flickerstreak@161 475 end
flickerstreak@161 476
flickerstreak@161 477 function MultiCast:GetIconTexture()
flickerstreak@161 478 local tx
flickerstreak@161 479 if self.spellID then
flickerstreak@161 480 tx = GetSpellTexture(GetSpellInfo(self.spellID))
flickerstreak@161 481 elseif self.actionID then
flickerstreak@161 482 tx = GetActionTexture(self.actionID)
flickerstreak@161 483 end
flickerstreak@161 484 if tx then
flickerstreak@161 485 return tx
flickerstreak@161 486 else
flickerstreak@174 487 return TOTEM_TEXTURE, unpack(SLOT_EMPTY_TCOORDS[self.totemSlot or 1])
flickerstreak@161 488 end
flickerstreak@161 489 end
flickerstreak@161 490
flickerstreak@161 491 function MultiCast:UpdateAction()
flickerstreak@161 492 local action = self:GetActionID()
flickerstreak@161 493 if action then
flickerstreak@161 494 if action ~= self.actionID then
flickerstreak@161 495 self.actionID = action
flickerstreak@161 496 self:UpdateAll()
flickerstreak@161 497 end
flickerstreak@161 498 else
flickerstreak@161 499 local spellID = self:GetSpellID()
flickerstreak@161 500 if spellID ~= self.spellID then
flickerstreak@161 501 self.spellID = spellID
flickerstreak@161 502 self:UpdateAll()
flickerstreak@161 503 end
flickerstreak@161 504 end
flickerstreak@161 505 end
flickerstreak@161 506
flickerstreak@161 507 function MultiCast:GetActionID(page)
flickerstreak@161 508 return self:GetFrame():GetAttribute("action")
flickerstreak@161 509 end
flickerstreak@161 510
flickerstreak@161 511 function MultiCast:GetSpellID(page)
flickerstreak@161 512 return self:GetFrame():GetAttribute("spell")
flickerstreak@161 513 end
flickerstreak@161 514
flickerstreak@161 515 function MultiCast:SetActionID( id )
flickerstreak@161 516 error("Can not set action ID of multicast buttons")
flickerstreak@161 517 end
flickerstreak@161 518
flickerstreak@161 519 function MultiCast:SetTooltip()
flickerstreak@161 520 local barFrame = self:GetFrame()
flickerstreak@161 521 if GetCVar("UberTooltips") == "1" then
flickerstreak@161 522 GameTooltip_SetDefaultAnchor(GameTooltip, barFrame)
flickerstreak@161 523 else
flickerstreak@161 524 GameTooltip:SetOwner(barFrame)
flickerstreak@161 525 end
flickerstreak@161 526 if self.spellID then
flickerstreak@161 527 GameTooltip:SetSpellByID(self.spellID,false,true)
flickerstreak@161 528 elseif self.actionID then
flickerstreak@161 529 GameTooltip:SetAction(self.actionID)
flickerstreak@161 530 end
flickerstreak@161 531 end
flickerstreak@161 532
flickerstreak@161 533 function MultiCast:GetUsable()
flickerstreak@161 534 if self.spellID then
flickerstreak@161 535 return IsUsableSpell((GetSpellInfo(self.spellID)))
flickerstreak@161 536 elseif self.actionID then
flickerstreak@161 537 return IsUsableAction(self.actionID)
flickerstreak@161 538 end
flickerstreak@161 539 end
flickerstreak@161 540
flickerstreak@161 541 function MultiCast:GetInRange()
flickerstreak@161 542 if self.spellID then
flickerstreak@161 543 return IsSpellInRange((GetSpellInfo(self.spellID))) == 0
flickerstreak@161 544 elseif self.actionID then
flickerstreak@161 545 return IsActionInRange(self.actionID) == 0
flickerstreak@161 546 end
flickerstreak@161 547 end
flickerstreak@161 548
flickerstreak@161 549 function MultiCast:GetCooldown()
flickerstreak@161 550 if self.spellID then
flickerstreak@161 551 return GetSpellCooldown((GetSpellInfo(self.spellID)))
flickerstreak@161 552 elseif self.actionID then
flickerstreak@161 553 return GetActionCooldown(self.actionID)
flickerstreak@161 554 else
flickerstreak@161 555 return 0, 0, 0
flickerstreak@161 556 end
flickerstreak@161 557 end
flickerstreak@161 558
flickerstreak@161 559 function MultiCast:UPDATE_MULTI_CAST_ACTIONBAR()
flickerstreak@161 560 self:UpdateAll()
flickerstreak@161 561 end
flickerstreak@161 562
flickerstreak@161 563
flickerstreak@161 564 --
flickerstreak@161 565 -- flyout setup
flickerstreak@161 566 --
flickerstreak@167 567 local function ShowFlyoutTooltip(frame)
flickerstreak@161 568 if GetCVar("UberTooltips") == "1" then
flickerstreak@167 569 GameTooltip_SetDefaultAnchor(GameTooltip, frame)
flickerstreak@161 570 else
flickerstreak@167 571 GameTooltip:SetOwner(frame)
flickerstreak@161 572 end
flickerstreak@167 573 local spell = frame:GetAttribute("spell")
flickerstreak@167 574 if spell == nil or spell == 0 then
flickerstreak@161 575 GameTooltip:SetText(MULTI_CAST_TOOLTIP_NO_TOTEM, HIGHLIGHT_FONT_COLOR.r, HIGHLIGHT_FONT_COLOR.g, HIGHLIGHT_FONT_COLOR.b)
flickerstreak@161 576 else
flickerstreak@167 577 GameTooltip:SetSpellByID(spell,false,true)
flickerstreak@161 578 end
flickerstreak@161 579 end
flickerstreak@161 580
flickerstreak@161 581 local function HideFlyoutTooltip()
flickerstreak@161 582 GameTooltip:Hide()
flickerstreak@161 583 end
flickerstreak@161 584
flickerstreak@161 585 local function UpdateFlyoutIcon(frame)
flickerstreak@161 586 local spellID = frame:GetAttribute("spell")
flickerstreak@167 587 if spellID == 0 or spellID == nil then
flickerstreak@161 588 frame.icon:SetTexture(TOTEM_TEXTURE)
flickerstreak@174 589 local slot = tonumber(frame:GetAttribute("totemSlot")) or 1
flickerstreak@174 590 frame.icon:SetTexCoord( unpack(SLOT_EMPTY_TCOORDS[slot]) )
flickerstreak@167 591 else
flickerstreak@161 592 frame.icon:SetTexture(GetSpellTexture(GetSpellInfo(spellID)))
flickerstreak@161 593 frame.icon:SetTexCoord(0,1,0,1)
flickerstreak@161 594 end
flickerstreak@161 595 end
flickerstreak@161 596
flickerstreak@161 597 function MultiCast.SetupBarHeader( bar ) -- call this as a static method
flickerstreak@167 598 local slot = 0
flickerstreak@167 599 local nTotemSlots = 0
flickerstreak@167 600 local summonSlot = nil
flickerstreak@167 601 local recallSlot = nil
flickerstreak@161 602
flickerstreak@167 603 -- figure out the capabilities of the character
flickerstreak@167 604 for i, spell in ipairs(TOTEM_MULTI_CAST_SUMMON_SPELLS) do
flickerstreak@161 605 if spell and IsSpellKnown(spell) then
flickerstreak@167 606 slot = 1
flickerstreak@167 607 summonSlot = 1
flickerstreak@161 608 end
flickerstreak@161 609 end
flickerstreak@161 610
flickerstreak@167 611 for i = 1, NUM_MULTI_CAST_BUTTONS_PER_PAGE do
flickerstreak@167 612 local totem = SHAMAN_TOTEM_PRIORITIES[i];
flickerstreak@167 613 if GetTotemInfo(totem) and GetMultiCastTotemSpells(totem) then
flickerstreak@167 614 nTotemSlots = nTotemSlots + 1
flickerstreak@167 615 slot = slot + 1
flickerstreak@167 616 end
flickerstreak@167 617 end
flickerstreak@167 618
flickerstreak@167 619 slot = slot + 1
flickerstreak@167 620 for i, spell in ipairs(TOTEM_MULTI_CAST_RECALL_SPELLS) do
flickerstreak@161 621 if spell and IsSpellKnown(spell) then
flickerstreak@167 622 recallSlot = slot
flickerstreak@161 623 end
flickerstreak@161 624 end
flickerstreak@161 625
flickerstreak@167 626 if nTotemSlots == 0 then
flickerstreak@167 627 bar.hasMulticast = false -- no multicast capability
flickerstreak@163 628 return
flickerstreak@161 629 end
flickerstreak@161 630
flickerstreak@167 631 bar.hasMulticast = true
flickerstreak@167 632 bar.summonSlot = summonSlot
flickerstreak@167 633 bar.recallSlot = recallSlot
flickerstreak@167 634 bar.nTotemSlots = nTotemSlots
flickerstreak@161 635
flickerstreak@161 636
flickerstreak@167 637 local f = bar:GetFrame()
flickerstreak@161 638
flickerstreak@161 639 -- init bar secure environment
flickerstreak@167 640 f:SetAttribute("lastSummon", bar:GetConfig().lastSummon)
flickerstreak@167 641 f:SetAttribute("summonSlot", summonSlot)
flickerstreak@167 642 f:SetAttribute("recallSlot", recallSlot)
flickerstreak@167 643 f:SetAttribute("slotsPerPage", NUM_MULTI_CAST_BUTTONS_PER_PAGE)
flickerstreak@167 644 f:SetAttribute("baseActionID", (NUM_ACTIONBAR_PAGES + GetMultiCastBarOffset() - 1)*NUM_ACTIONBAR_BUTTONS)
flickerstreak@167 645 for i, p in ipairs(SHAMAN_TOTEM_PRIORITIES) do
flickerstreak@167 646 f:SetAttribute("TOTEM_PRIORITY_"..i,p)
flickerstreak@167 647 end
flickerstreak@167 648 f:SetAttribute("_onstate-multispellpage", _onstate_multispellpage)
flickerstreak@161 649
flickerstreak@167 650 function f:UpdateLastSummon(value)
flickerstreak@163 651 bar:GetConfig().lastSummon = value
flickerstreak@163 652 end
flickerstreak@163 653
flickerstreak@161 654 -- create flyout container frame and close arrow
flickerstreak@161 655 local flyout = bar._flyoutFrame
flickerstreak@161 656 if not flyout then
flickerstreak@167 657 flyout = CreateFrame("Frame", nil, f, "SecureFrameTemplate")
flickerstreak@161 658 bar._flyoutFrame = flyout
flickerstreak@167 659 f:SetFrameRef("flyout",flyout)
flickerstreak@161 660 flyout.buttons = { }
flickerstreak@161 661 flyout:Hide()
flickerstreak@161 662 flyout:SetWidth(24)
flickerstreak@161 663 flyout:SetHeight(1)
flickerstreak@167 664 flyout:SetPoint("BOTTOM",f,"TOP",0,0)
flickerstreak@161 665
flickerstreak@161 666 local close = CreateFrame("Button", nil, flyout, "SecureFrameTemplate")
flickerstreak@161 667 close:SetWidth(28)
flickerstreak@174 668 close:SetHeight(18)
flickerstreak@174 669 close:SetPoint("BOTTOM",flyout,"TOP")
flickerstreak@161 670 close:SetNormalTexture(TOTEM_TEXTURE)
flickerstreak@174 671 close:GetNormalTexture():SetTexCoord(unpack(FLYOUT_DOWN_BUTTON_TCOORDS["summon"]))
flickerstreak@161 672 close:SetHighlightTexture(TOTEM_TEXTURE)
flickerstreak@161 673 close:GetHighlightTexture():SetTexCoord( unpack(FLYOUT_DOWN_BUTTON_HL_TCOORDS) )
flickerstreak@167 674 f:SetFrameRef("close",close)
flickerstreak@167 675 f:WrapScript(close, "OnClick", _closeFlyout)
flickerstreak@174 676 close:Show()
flickerstreak@174 677
flickerstreak@174 678 local midTx = flyout:CreateTexture("BACKGROUND")
flickerstreak@174 679 midTx:SetWidth(32)
flickerstreak@174 680 midTx:SetHeight(20)
flickerstreak@174 681 midTx:SetPoint("BOTTOM")
flickerstreak@174 682 midTx:SetTexture(TOTEM_TEXTURE)
flickerstreak@174 683 midTx:SetTexCoord(unpack(FLYOUT_MIDDLE_TCOORDS["summon"]))
flickerstreak@174 684 midTx:Show()
flickerstreak@174 685
flickerstreak@174 686 local topTx = flyout:CreateTexture("BACKGROUND")
flickerstreak@174 687 topTx:SetWidth(32)
flickerstreak@174 688 topTx:SetHeight(20)
flickerstreak@174 689 topTx:SetTexture(TOTEM_TEXTURE)
flickerstreak@174 690 midTx:SetTexCoord(unpack(FLYOUT_TOP_TCOORDS["summon"]))
flickerstreak@174 691 topTx:SetPoint("BOTTOM",midTx,"TOP",0,-10)
flickerstreak@174 692 topTx:Show()
flickerstreak@174 693
flickerstreak@174 694 function flyout:UpdateTextures(slot)
flickerstreak@174 695 slot = slot or "summon"
flickerstreak@174 696 close:GetNormalTexture():SetTexCoord(unpack(FLYOUT_DOWN_BUTTON_TCOORDS[slot]))
flickerstreak@174 697 midTx:ClearAllPoints()
flickerstreak@174 698 midTx:SetPoint("BOTTOM")
flickerstreak@174 699 midTx:SetPoint("TOP",close,"BOTTOM",0,0)
flickerstreak@174 700 midTx:SetTexCoord(unpack(FLYOUT_MIDDLE_TCOORDS[slot]))
flickerstreak@174 701 topTx:SetTexCoord(unpack(FLYOUT_TOP_TCOORDS[slot]))
flickerstreak@174 702 end
flickerstreak@161 703
flickerstreak@167 704 -- create flyout buttons
flickerstreak@167 705 for i = 1, 10 do -- maximum 9 spells + 1 empty slot
flickerstreak@167 706 local b = CreateFrame("Button",nil,flyout,"SecureActionButtonTemplate")
flickerstreak@167 707 b:SetWidth(24)
flickerstreak@167 708 b:SetHeight(24)
flickerstreak@167 709 local prev = flyout.buttons[i-1]
flickerstreak@167 710 b:SetPoint("BOTTOM", prev or flyout, prev and "TOP" or "BOTTOM", 0, 3) -- TODO: better anchoring
flickerstreak@167 711 b.icon = b:CreateTexture("BACKGROUND")
flickerstreak@167 712 b.icon:SetAllPoints()
flickerstreak@167 713 b.icon:Show()
flickerstreak@167 714 b:SetHighlightTexture("Interface\\Buttons\\ButtonHilight-Square")
flickerstreak@167 715 b:GetHighlightTexture():SetBlendMode("ADD")
flickerstreak@167 716 b:RegisterForClicks("AnyUp")
flickerstreak@167 717 b:SetScript("OnShow",UpdateFlyoutIcon)
flickerstreak@167 718 b:SetScript("OnEnter",ShowFlyoutTooltip)
flickerstreak@167 719 b:SetScript("OnLeave",HideFlyoutTooltip)
flickerstreak@167 720 b:SetAttribute("index",i)
flickerstreak@167 721 f:SetAttribute("flyout-child-idx",i)
flickerstreak@167 722 f:SetFrameRef("flyout-child",b)
flickerstreak@167 723 f:Execute([[
flickerstreak@167 724 flyoutChildren = flyoutChildren or newtable()
flickerstreak@167 725 flyoutChildren[self:GetAttribute("flyout-child-idx")] = self:GetFrameRef("flyout-child")
flickerstreak@161 726 ]])
flickerstreak@167 727 f:WrapScript(b, "OnClick", _flyout_child_preClick, _flyout_child_postClick)
flickerstreak@167 728 b:Show()
flickerstreak@167 729 flyout.buttons[i] = b
flickerstreak@161 730 end
flickerstreak@161 731 end
flickerstreak@161 732
flickerstreak@174 733 function f:UpdateFlyoutTextures(slot)
flickerstreak@174 734 flyout:UpdateTextures(slot)
flickerstreak@174 735 end
flickerstreak@174 736
flickerstreak@167 737 f:Execute(_bar_init)
flickerstreak@161 738 end
flickerstreak@161 739