annotate classes/MultiCastButton.lua @ 176:d32c65d94009

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