annotate MultiCastButton.lua @ 292:276165a0e860 1.1 beta 10

Don't stash CooldownFrame_SetTimer, to support mods such as 'Cooldowns' which hook it in an event handler.
author Flick
date Fri, 05 Aug 2011 16:25:41 -0700
parents 7a9e82c0df15
children
rev   line source
Flick@276 1 local _, ns = ...
Flick@276 2 local ReAction = ns.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 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
Flick@276 23 --@do-not-package@
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 ]]--
Flick@276 93 --@end-do-not-package@
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
Flick@234 116 -- these are set up in bar:SetupBar()
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@218 303 local buttonTypeID = "Totem"
flickerstreak@161 304 local Super = ReAction.Button
flickerstreak@161 305 local Action = ReAction.Button.Action
flickerstreak@218 306 local MultiCast = setmetatable(
flickerstreak@218 307 {
flickerstreak@218 308 defaultBarConfig = {
flickerstreak@218 309 type = buttonTypeID,
flickerstreak@218 310 btnWidth = 36,
flickerstreak@218 311 btnHeight = 36,
flickerstreak@218 312 btnRows = 1,
flickerstreak@218 313 btnColumns = 6,
flickerstreak@222 314 spacing = 3,
flickerstreak@222 315 buttons = { }
flickerstreak@218 316 },
flickerstreak@218 317
flickerstreak@218 318 barType = L["Totem Bar"],
Flick@231 319 buttonTypeID = buttonTypeID
flickerstreak@218 320 },
flickerstreak@218 321 { __index = Action } )
flickerstreak@223 322
flickerstreak@161 323 ReAction.Button.MultiCast = MultiCast
flickerstreak@223 324 ReAction:RegisterBarType(MultiCast)
flickerstreak@161 325
Flick@234 326 function MultiCast:New( btnConfig, bar, idx )
Flick@282 327 if idx < 1 or idx > NUM_MULTI_CAST_BUTTONS_PER_PAGE + 2 then
Flick@282 328 ReAction:UserError(L["All %s buttons are in use for this bar, cannot create any more buttons"]:format(self.barType))
Flick@282 329 error(nil)
flickerstreak@167 330 end
flickerstreak@167 331
Flick@277 332 self = Super.New(self, btnConfig, bar, idx, "SecureActionButtonTemplate, ActionButtonTemplate" )
flickerstreak@161 333
Flick@282 334 if not bar.hasMulticast or idx > bar.maxIndex then
Flick@282 335 -- Not enough multicast capability to use this button
Flick@282 336 self:Refresh()
Flick@282 337 return self
Flick@282 338 end
Flick@282 339
flickerstreak@161 340 local barFrame = bar:GetFrame()
flickerstreak@161 341 local f = self:GetFrame()
flickerstreak@161 342
flickerstreak@161 343 -- attributes
flickerstreak@167 344 local page = (idx == bar.recallSlot) and 1 or bar:GetConfig().lastSummon or 1
flickerstreak@167 345 if idx == bar.recallSlot or idx == bar.summonSlot then
flickerstreak@161 346 f:SetAttribute("type","spell")
flickerstreak@167 347 local spells = (idx == bar.summonSlot) and TOTEM_MULTI_CAST_SUMMON_SPELLS or TOTEM_MULTI_CAST_RECALL_SPELLS
flickerstreak@163 348 f:SetAttribute("spell",spells[page])
flickerstreak@161 349 for i, spell in ipairs(spells) do
flickerstreak@161 350 if spell and IsSpellKnown(spell) then
flickerstreak@161 351 f:SetAttribute("spell-page"..i, spell)
flickerstreak@161 352 end
flickerstreak@161 353 end
flickerstreak@161 354 else
flickerstreak@167 355 local offset = bar.summonSlot and 1 or 0
flickerstreak@167 356 local slot = SHAMAN_TOTEM_PRIORITIES[idx - offset]
flickerstreak@167 357 local baseAction = barFrame:GetAttribute("baseActionID") + slot
flickerstreak@174 358 self.totemSlot = slot
flickerstreak@161 359 f:SetAttribute("type","action")
flickerstreak@163 360 f:SetAttribute("action", baseAction + (page - 1) * NUM_MULTI_CAST_BUTTONS_PER_PAGE)
flickerstreak@161 361 for i = 1, NUM_MULTI_CAST_PAGES do
flickerstreak@161 362 f:SetAttribute("action-page"..i, baseAction + (i-1) * NUM_MULTI_CAST_BUTTONS_PER_PAGE)
flickerstreak@161 363 end
flickerstreak@174 364 if not f.overlayTex then
flickerstreak@174 365 local tx = f:CreateTexture("OVERLAY")
flickerstreak@174 366 tx:SetTexture(TOTEM_TEXTURE)
flickerstreak@174 367 tx:SetTexCoord(unpack(SLOT_OVERLAY_TCOORDS[self.totemSlot]))
flickerstreak@174 368 tx:SetWidth(34)
flickerstreak@174 369 tx:SetHeight(34)
flickerstreak@174 370 tx:SetPoint("CENTER")
flickerstreak@174 371 tx:Show()
flickerstreak@174 372 f.overlayTex = tx
flickerstreak@174 373 end
flickerstreak@161 374 end
flickerstreak@161 375 f:SetAttribute("bar-idx",idx)
flickerstreak@161 376
flickerstreak@161 377 -- non secure scripts
flickerstreak@161 378 f:SetScript("OnEvent", function(frame, ...) self:OnEvent(...) end)
flickerstreak@161 379 f:SetScript("OnEnter", function(frame) self:OnEnter() end)
flickerstreak@161 380 f:SetScript("OnLeave", function(frame) self:OnLeave() end)
flickerstreak@161 381 f:SetScript("OnAttributeChanged", function(frame, attr, value) self:OnAttributeChanged(attr, value) end)
flickerstreak@161 382 f:SetScript("PostClick", function(frame, ...) self:PostClick(...) end)
flickerstreak@161 383
flickerstreak@161 384 -- secure handlers
flickerstreak@167 385 if idx ~= bar.recallSlot then
flickerstreak@161 386 f:SetAttribute("_childupdate",_childupdate)
flickerstreak@161 387 end
flickerstreak@161 388 barFrame:WrapScript(f, "OnEnter", _onEnter)
flickerstreak@161 389
flickerstreak@161 390 -- event registration
flickerstreak@161 391 for _, evt in pairs(eventList) do
flickerstreak@161 392 f:RegisterEvent(evt)
flickerstreak@161 393 end
flickerstreak@161 394
flickerstreak@162 395 -- Set up a proxy for the icon texture for use with ButtonFacade
flickerstreak@174 396 local SetTexCoordRaw = self.frames.icon.SetTexCoord
flickerstreak@162 397 self.frames.icon.SetTexCoord = function( tx, ... )
flickerstreak@162 398 if self:GetIconTexture() == TOTEM_TEXTURE then
flickerstreak@174 399 SetTexCoordRaw(tx,select(2,self:GetIconTexture()))
flickerstreak@162 400 else
flickerstreak@174 401 SetTexCoordRaw(tx,...)
flickerstreak@162 402 end
flickerstreak@162 403 end
flickerstreak@162 404
flickerstreak@161 405 -- attach to skinner
flickerstreak@161 406 bar:SkinButton(self)
flickerstreak@161 407
flickerstreak@161 408 f:Show()
flickerstreak@161 409
flickerstreak@174 410 -- open arrow and flyout background textures
flickerstreak@167 411 if idx ~= bar.recallSlot then
flickerstreak@174 412 local arrow = f._arrowFrame or CreateFrame("Button", nil, f, "SecureFrameTemplate")
flickerstreak@174 413 f._arrowFrame = arrow
flickerstreak@161 414 arrow:SetWidth(28)
flickerstreak@174 415 arrow:SetHeight(18)
flickerstreak@161 416 arrow:SetPoint("BOTTOM",self:GetFrame(),"TOP",0,0) -- TODO: better anchoring
flickerstreak@161 417 arrow:SetNormalTexture(TOTEM_TEXTURE)
flickerstreak@174 418 local slot = self.totemSlot or "summon"
flickerstreak@174 419 arrow:GetNormalTexture():SetTexCoord( unpack(FLYOUT_UP_BUTTON_TCOORDS[slot]) )
flickerstreak@161 420 arrow:SetHighlightTexture(TOTEM_TEXTURE)
flickerstreak@161 421 arrow:GetHighlightTexture():SetTexCoord( unpack(FLYOUT_UP_BUTTON_HL_TCOORDS) )
flickerstreak@161 422 arrow:SetAttribute("bar-idx",idx)
flickerstreak@161 423 arrow:Hide()
flickerstreak@161 424 barFrame:WrapScript(arrow, "OnClick", _arrow_openFlyout)
flickerstreak@167 425 barFrame:SetFrameRef("arrow-"..idx,arrow)
flickerstreak@161 426 end
flickerstreak@161 427
flickerstreak@161 428 self:Refresh()
flickerstreak@161 429
flickerstreak@161 430 return self
flickerstreak@161 431 end
flickerstreak@161 432
flickerstreak@161 433 function MultiCast:Destroy()
flickerstreak@174 434 local barFrame = self.bar:GetFrame()
flickerstreak@174 435 local f = self:GetFrame()
flickerstreak@174 436 pcall( barFrame.UnwrapScript, barFrame, f, "OnEnter" ) -- ignore errors
flickerstreak@174 437 if f._arrowFrame then
flickerstreak@174 438 pcall( barFrame.UnwrapScript, barFrame, f._arrowFrame,"OnClick" ) -- ignore errors
flickerstreak@174 439 end
flickerstreak@161 440 Super.Destroy(self)
flickerstreak@161 441 end
flickerstreak@161 442
flickerstreak@161 443 function MultiCast:Refresh()
flickerstreak@161 444 Super.Refresh(self)
flickerstreak@161 445 self:UpdateAction()
Flick@282 446
Flick@282 447 local bar = self.bar
Flick@282 448 if bar.hasMulticast == true and self.idx <= bar.maxIndex or ReAction:GetConfigMode() then
Flick@282 449 self:GetFrame():Show()
Flick@282 450 else
Flick@282 451 self:GetFrame():Hide()
Flick@282 452 end
flickerstreak@161 453 end
flickerstreak@161 454
flickerstreak@161 455 function MultiCast:ShowGrid( show )
flickerstreak@161 456 end
flickerstreak@161 457
flickerstreak@161 458 function MultiCast:ShowGridTemp( show )
flickerstreak@161 459 end
flickerstreak@161 460
flickerstreak@161 461 function MultiCast:AcquireActionID()
flickerstreak@161 462 end
flickerstreak@161 463
flickerstreak@161 464 function MultiCast:ReleaseActionID()
flickerstreak@161 465 end
flickerstreak@161 466
flickerstreak@161 467 function MultiCast:UpdateShowGrid()
flickerstreak@161 468 end
flickerstreak@161 469
flickerstreak@161 470 function MultiCast:UpdateBorder()
flickerstreak@161 471 end
flickerstreak@161 472
flickerstreak@161 473 function MultiCast:UpdateMacroText()
flickerstreak@161 474 end
flickerstreak@161 475
flickerstreak@161 476 function MultiCast:UpdateCount()
flickerstreak@161 477 end
flickerstreak@161 478
flickerstreak@161 479 function MultiCast:UpdateCheckedState()
flickerstreak@161 480 local action = self:GetActionID()
flickerstreak@161 481 if action and IsCurrentAction(action) then
flickerstreak@161 482 self:GetFrame():SetChecked(1)
flickerstreak@161 483 else
flickerstreak@161 484 self:GetFrame():SetChecked(0)
flickerstreak@161 485 end
flickerstreak@161 486 end
flickerstreak@161 487
flickerstreak@161 488 function MultiCast:RefreshHasActionAttributes()
flickerstreak@161 489 end
flickerstreak@161 490
flickerstreak@161 491 function MultiCast:UpdateFlash()
flickerstreak@161 492 end
flickerstreak@161 493
flickerstreak@161 494 function MultiCast:GetIconTexture()
flickerstreak@161 495 local tx
flickerstreak@161 496 if self.spellID then
flickerstreak@161 497 tx = GetSpellTexture(GetSpellInfo(self.spellID))
flickerstreak@161 498 elseif self.actionID then
flickerstreak@161 499 tx = GetActionTexture(self.actionID)
flickerstreak@161 500 end
flickerstreak@161 501 if tx then
flickerstreak@161 502 return tx
flickerstreak@161 503 else
flickerstreak@174 504 return TOTEM_TEXTURE, unpack(SLOT_EMPTY_TCOORDS[self.totemSlot or 1])
flickerstreak@161 505 end
flickerstreak@161 506 end
flickerstreak@161 507
flickerstreak@161 508 function MultiCast:UpdateAction()
flickerstreak@161 509 local action = self:GetActionID()
flickerstreak@161 510 if action then
flickerstreak@161 511 if action ~= self.actionID then
flickerstreak@161 512 self.actionID = action
flickerstreak@161 513 self:UpdateAll()
flickerstreak@161 514 end
flickerstreak@161 515 else
flickerstreak@161 516 local spellID = self:GetSpellID()
flickerstreak@161 517 if spellID ~= self.spellID then
flickerstreak@161 518 self.spellID = spellID
flickerstreak@161 519 self:UpdateAll()
flickerstreak@161 520 end
flickerstreak@161 521 end
flickerstreak@161 522 end
flickerstreak@161 523
flickerstreak@161 524 function MultiCast:GetActionID(page)
flickerstreak@161 525 return self:GetFrame():GetAttribute("action")
flickerstreak@161 526 end
flickerstreak@161 527
flickerstreak@161 528 function MultiCast:GetSpellID(page)
flickerstreak@161 529 return self:GetFrame():GetAttribute("spell")
flickerstreak@161 530 end
flickerstreak@161 531
flickerstreak@161 532 function MultiCast:SetActionID( id )
flickerstreak@161 533 error("Can not set action ID of multicast buttons")
flickerstreak@161 534 end
flickerstreak@161 535
flickerstreak@161 536 function MultiCast:SetTooltip()
flickerstreak@161 537 local barFrame = self:GetFrame()
flickerstreak@161 538 if GetCVar("UberTooltips") == "1" then
flickerstreak@161 539 GameTooltip_SetDefaultAnchor(GameTooltip, barFrame)
flickerstreak@161 540 else
flickerstreak@161 541 GameTooltip:SetOwner(barFrame)
flickerstreak@161 542 end
flickerstreak@161 543 if self.spellID then
flickerstreak@161 544 GameTooltip:SetSpellByID(self.spellID,false,true)
flickerstreak@161 545 elseif self.actionID then
flickerstreak@161 546 GameTooltip:SetAction(self.actionID)
flickerstreak@161 547 end
flickerstreak@161 548 end
flickerstreak@161 549
flickerstreak@161 550 function MultiCast:GetUsable()
flickerstreak@161 551 if self.spellID then
flickerstreak@161 552 return IsUsableSpell((GetSpellInfo(self.spellID)))
flickerstreak@161 553 elseif self.actionID then
flickerstreak@161 554 return IsUsableAction(self.actionID)
flickerstreak@161 555 end
flickerstreak@161 556 end
flickerstreak@161 557
flickerstreak@161 558 function MultiCast:GetInRange()
flickerstreak@161 559 if self.spellID then
flickerstreak@161 560 return IsSpellInRange((GetSpellInfo(self.spellID))) == 0
flickerstreak@161 561 elseif self.actionID then
flickerstreak@161 562 return IsActionInRange(self.actionID) == 0
flickerstreak@161 563 end
flickerstreak@161 564 end
flickerstreak@161 565
flickerstreak@161 566 function MultiCast:GetCooldown()
flickerstreak@161 567 if self.spellID then
flickerstreak@161 568 return GetSpellCooldown((GetSpellInfo(self.spellID)))
flickerstreak@161 569 elseif self.actionID then
flickerstreak@161 570 return GetActionCooldown(self.actionID)
flickerstreak@161 571 else
flickerstreak@161 572 return 0, 0, 0
flickerstreak@161 573 end
flickerstreak@161 574 end
flickerstreak@161 575
flickerstreak@161 576 function MultiCast:UPDATE_MULTI_CAST_ACTIONBAR()
flickerstreak@161 577 self:UpdateAll()
flickerstreak@161 578 end
flickerstreak@161 579
flickerstreak@161 580
flickerstreak@161 581 --
flickerstreak@161 582 -- flyout setup
flickerstreak@161 583 --
flickerstreak@167 584 local function ShowFlyoutTooltip(frame)
flickerstreak@161 585 if GetCVar("UberTooltips") == "1" then
flickerstreak@167 586 GameTooltip_SetDefaultAnchor(GameTooltip, frame)
flickerstreak@161 587 else
flickerstreak@167 588 GameTooltip:SetOwner(frame)
flickerstreak@161 589 end
flickerstreak@167 590 local spell = frame:GetAttribute("spell")
flickerstreak@167 591 if spell == nil or spell == 0 then
flickerstreak@161 592 GameTooltip:SetText(MULTI_CAST_TOOLTIP_NO_TOTEM, HIGHLIGHT_FONT_COLOR.r, HIGHLIGHT_FONT_COLOR.g, HIGHLIGHT_FONT_COLOR.b)
flickerstreak@161 593 else
flickerstreak@167 594 GameTooltip:SetSpellByID(spell,false,true)
flickerstreak@161 595 end
flickerstreak@161 596 end
flickerstreak@161 597
flickerstreak@161 598 local function HideFlyoutTooltip()
flickerstreak@161 599 GameTooltip:Hide()
flickerstreak@161 600 end
flickerstreak@161 601
flickerstreak@161 602 local function UpdateFlyoutIcon(frame)
flickerstreak@161 603 local spellID = frame:GetAttribute("spell")
flickerstreak@167 604 if spellID == 0 or spellID == nil then
flickerstreak@161 605 frame.icon:SetTexture(TOTEM_TEXTURE)
flickerstreak@174 606 local slot = tonumber(frame:GetAttribute("totemSlot")) or 1
flickerstreak@174 607 frame.icon:SetTexCoord( unpack(SLOT_EMPTY_TCOORDS[slot]) )
flickerstreak@167 608 else
flickerstreak@161 609 frame.icon:SetTexture(GetSpellTexture(GetSpellInfo(spellID)))
flickerstreak@161 610 frame.icon:SetTexCoord(0,1,0,1)
flickerstreak@161 611 end
flickerstreak@161 612 end
flickerstreak@161 613
Flick@234 614 function MultiCast:SetupBar( bar )
flickerstreak@167 615 local slot = 0
flickerstreak@167 616 local nTotemSlots = 0
flickerstreak@167 617 local summonSlot = nil
flickerstreak@167 618 local recallSlot = nil
flickerstreak@161 619
flickerstreak@167 620 -- figure out the capabilities of the character
flickerstreak@167 621 for i, spell in ipairs(TOTEM_MULTI_CAST_SUMMON_SPELLS) do
flickerstreak@161 622 if spell and IsSpellKnown(spell) then
flickerstreak@167 623 slot = 1
flickerstreak@167 624 summonSlot = 1
flickerstreak@161 625 end
flickerstreak@161 626 end
flickerstreak@161 627
flickerstreak@167 628 for i = 1, NUM_MULTI_CAST_BUTTONS_PER_PAGE do
flickerstreak@167 629 local totem = SHAMAN_TOTEM_PRIORITIES[i];
flickerstreak@167 630 if GetTotemInfo(totem) and GetMultiCastTotemSpells(totem) then
flickerstreak@167 631 nTotemSlots = nTotemSlots + 1
flickerstreak@167 632 slot = slot + 1
flickerstreak@167 633 end
flickerstreak@167 634 end
flickerstreak@167 635
flickerstreak@167 636 slot = slot + 1
flickerstreak@167 637 for i, spell in ipairs(TOTEM_MULTI_CAST_RECALL_SPELLS) do
flickerstreak@161 638 if spell and IsSpellKnown(spell) then
flickerstreak@167 639 recallSlot = slot
flickerstreak@161 640 end
flickerstreak@161 641 end
flickerstreak@161 642
Flick@282 643 local maxIndex = nTotemSlots
Flick@282 644 if summonSlot then
Flick@282 645 maxIndex = maxIndex + 1
Flick@282 646 end
Flick@282 647 if recallSlot then
Flick@282 648 maxIndex = maxIndex + 1
flickerstreak@161 649 end
flickerstreak@161 650
Flick@282 651 bar.hasMulticast = nTotemSlots > 0
flickerstreak@167 652 bar.summonSlot = summonSlot
flickerstreak@167 653 bar.recallSlot = recallSlot
flickerstreak@167 654 bar.nTotemSlots = nTotemSlots
Flick@282 655 bar.maxIndex = maxIndex
flickerstreak@161 656
Flick@282 657 if bar.hasMulticast == false then
Flick@282 658 Super.SetupBar(self,bar)
Flick@282 659 return -- no multicast capability
Flick@282 660 end
flickerstreak@161 661
flickerstreak@167 662 local f = bar:GetFrame()
flickerstreak@161 663
flickerstreak@161 664 -- init bar secure environment
flickerstreak@167 665 f:SetAttribute("lastSummon", bar:GetConfig().lastSummon)
flickerstreak@167 666 f:SetAttribute("summonSlot", summonSlot)
flickerstreak@167 667 f:SetAttribute("recallSlot", recallSlot)
flickerstreak@167 668 f:SetAttribute("slotsPerPage", NUM_MULTI_CAST_BUTTONS_PER_PAGE)
flickerstreak@167 669 f:SetAttribute("baseActionID", (NUM_ACTIONBAR_PAGES + GetMultiCastBarOffset() - 1)*NUM_ACTIONBAR_BUTTONS)
flickerstreak@167 670 for i, p in ipairs(SHAMAN_TOTEM_PRIORITIES) do
flickerstreak@167 671 f:SetAttribute("TOTEM_PRIORITY_"..i,p)
flickerstreak@167 672 end
flickerstreak@167 673 f:SetAttribute("_onstate-multispellpage", _onstate_multispellpage)
flickerstreak@161 674
flickerstreak@167 675 function f:UpdateLastSummon(value)
flickerstreak@163 676 bar:GetConfig().lastSummon = value
flickerstreak@163 677 end
flickerstreak@163 678
flickerstreak@161 679 -- create flyout container frame and close arrow
flickerstreak@161 680 local flyout = bar._flyoutFrame
flickerstreak@161 681 if not flyout then
flickerstreak@167 682 flyout = CreateFrame("Frame", nil, f, "SecureFrameTemplate")
flickerstreak@161 683 bar._flyoutFrame = flyout
flickerstreak@167 684 f:SetFrameRef("flyout",flyout)
flickerstreak@161 685 flyout.buttons = { }
flickerstreak@161 686 flyout:Hide()
flickerstreak@161 687 flyout:SetWidth(24)
flickerstreak@161 688 flyout:SetHeight(1)
flickerstreak@167 689 flyout:SetPoint("BOTTOM",f,"TOP",0,0)
flickerstreak@161 690
flickerstreak@161 691 local close = CreateFrame("Button", nil, flyout, "SecureFrameTemplate")
flickerstreak@161 692 close:SetWidth(28)
flickerstreak@174 693 close:SetHeight(18)
flickerstreak@174 694 close:SetPoint("BOTTOM",flyout,"TOP")
flickerstreak@161 695 close:SetNormalTexture(TOTEM_TEXTURE)
flickerstreak@174 696 close:GetNormalTexture():SetTexCoord(unpack(FLYOUT_DOWN_BUTTON_TCOORDS["summon"]))
flickerstreak@161 697 close:SetHighlightTexture(TOTEM_TEXTURE)
flickerstreak@161 698 close:GetHighlightTexture():SetTexCoord( unpack(FLYOUT_DOWN_BUTTON_HL_TCOORDS) )
flickerstreak@167 699 f:SetFrameRef("close",close)
flickerstreak@167 700 f:WrapScript(close, "OnClick", _closeFlyout)
flickerstreak@174 701 close:Show()
flickerstreak@174 702
flickerstreak@174 703 local midTx = flyout:CreateTexture("BACKGROUND")
flickerstreak@174 704 midTx:SetWidth(32)
flickerstreak@174 705 midTx:SetHeight(20)
flickerstreak@174 706 midTx:SetPoint("BOTTOM")
flickerstreak@174 707 midTx:SetTexture(TOTEM_TEXTURE)
flickerstreak@174 708 midTx:SetTexCoord(unpack(FLYOUT_MIDDLE_TCOORDS["summon"]))
flickerstreak@174 709 midTx:Show()
flickerstreak@174 710
flickerstreak@174 711 local topTx = flyout:CreateTexture("BACKGROUND")
flickerstreak@174 712 topTx:SetWidth(32)
flickerstreak@174 713 topTx:SetHeight(20)
flickerstreak@174 714 topTx:SetTexture(TOTEM_TEXTURE)
flickerstreak@174 715 midTx:SetTexCoord(unpack(FLYOUT_TOP_TCOORDS["summon"]))
flickerstreak@174 716 topTx:SetPoint("BOTTOM",midTx,"TOP",0,-10)
flickerstreak@174 717 topTx:Show()
flickerstreak@174 718
flickerstreak@174 719 function flyout:UpdateTextures(slot)
flickerstreak@174 720 slot = slot or "summon"
flickerstreak@174 721 close:GetNormalTexture():SetTexCoord(unpack(FLYOUT_DOWN_BUTTON_TCOORDS[slot]))
flickerstreak@174 722 midTx:ClearAllPoints()
flickerstreak@174 723 midTx:SetPoint("BOTTOM")
flickerstreak@174 724 midTx:SetPoint("TOP",close,"BOTTOM",0,0)
flickerstreak@174 725 midTx:SetTexCoord(unpack(FLYOUT_MIDDLE_TCOORDS[slot]))
flickerstreak@174 726 topTx:SetTexCoord(unpack(FLYOUT_TOP_TCOORDS[slot]))
flickerstreak@174 727 end
flickerstreak@161 728
flickerstreak@167 729 -- create flyout buttons
flickerstreak@167 730 for i = 1, 10 do -- maximum 9 spells + 1 empty slot
flickerstreak@167 731 local b = CreateFrame("Button",nil,flyout,"SecureActionButtonTemplate")
flickerstreak@167 732 b:SetWidth(24)
flickerstreak@167 733 b:SetHeight(24)
flickerstreak@167 734 local prev = flyout.buttons[i-1]
flickerstreak@167 735 b:SetPoint("BOTTOM", prev or flyout, prev and "TOP" or "BOTTOM", 0, 3) -- TODO: better anchoring
flickerstreak@167 736 b.icon = b:CreateTexture("BACKGROUND")
flickerstreak@167 737 b.icon:SetAllPoints()
flickerstreak@167 738 b.icon:Show()
flickerstreak@167 739 b:SetHighlightTexture("Interface\\Buttons\\ButtonHilight-Square")
flickerstreak@167 740 b:GetHighlightTexture():SetBlendMode("ADD")
Flick@259 741 b:EnableMouse(true)
Flick@259 742 b:RegisterForClicks(bar:GetConfig().clickDown and "AnyDown" or "AnyUp")
flickerstreak@167 743 b:SetScript("OnShow",UpdateFlyoutIcon)
flickerstreak@167 744 b:SetScript("OnEnter",ShowFlyoutTooltip)
flickerstreak@167 745 b:SetScript("OnLeave",HideFlyoutTooltip)
flickerstreak@167 746 b:SetAttribute("index",i)
flickerstreak@167 747 f:SetAttribute("flyout-child-idx",i)
flickerstreak@167 748 f:SetFrameRef("flyout-child",b)
flickerstreak@167 749 f:Execute([[
flickerstreak@167 750 flyoutChildren = flyoutChildren or newtable()
flickerstreak@167 751 flyoutChildren[self:GetAttribute("flyout-child-idx")] = self:GetFrameRef("flyout-child")
flickerstreak@161 752 ]])
flickerstreak@167 753 f:WrapScript(b, "OnClick", _flyout_child_preClick, _flyout_child_postClick)
flickerstreak@167 754 b:Show()
flickerstreak@167 755 flyout.buttons[i] = b
flickerstreak@161 756 end
flickerstreak@161 757 end
flickerstreak@161 758
flickerstreak@196 759 -- scale flyout frame
flickerstreak@196 760 local scale = bar:GetButtonSize() / 36
flickerstreak@196 761 flyout:SetScale(scale)
flickerstreak@196 762
flickerstreak@174 763 function f:UpdateFlyoutTextures(slot)
flickerstreak@174 764 flyout:UpdateTextures(slot)
flickerstreak@174 765 end
flickerstreak@174 766
Flick@234 767 -- re-execute setup when new spells are loaded
Flick@234 768 if not f.events_registered then
Flick@234 769 f:RegisterEvent("UPDATE_MULTI_CAST_ACTIONBAR")
Flick@234 770 f:RegisterEvent("PLAYER_ENTERING_WORLD")
Flick@234 771 -- Bar.frame does not use OnEvent
Flick@234 772 f:SetScript("OnEvent",
Flick@234 773 function()
Flick@234 774 if not InCombatLockdown() then
Flick@234 775 self:SetupBar(bar)
Flick@234 776 end
Flick@234 777 end)
Flick@234 778 f.events_registered = true
Flick@234 779 end
Flick@234 780
Flick@282 781 f:Execute(_bar_init)
Flick@234 782
Flick@282 783 Super.SetupBar(self,bar) -- create buttons after this is done
flickerstreak@161 784 end
flickerstreak@161 785