annotate classes/StanceButton.lua @ 218:e63aefb8a555

Demodularization of buttons - register class instead of config
author Flick <flickerstreak@gmail.com>
date Fri, 19 Nov 2010 23:06:24 -0800
parents bf64e71701e2
children d08a74e86c96
rev   line source
flickerstreak@175 1 local addonName, addonTable = ...
flickerstreak@175 2 local ReAction = addonTable.ReAction
flickerstreak@134 3 local L = ReAction.L
flickerstreak@134 4 local _G = _G
flickerstreak@134 5 local CreateFrame = CreateFrame
flickerstreak@134 6 local format = string.format
flickerstreak@134 7 local GetCVar = GetCVar
flickerstreak@134 8 local GameTooltip_SetDefaultAnchor = GameTooltip_SetDefaultAnchor
flickerstreak@134 9 local CooldownFrame_SetTimer = CooldownFrame_SetTimer
flickerstreak@134 10 local InCombatLockdown = InCombatLockdown
flickerstreak@134 11 local GetNumShapeshiftForms = GetNumShapeshiftForms
flickerstreak@134 12 local GetShapeshiftFormInfo = GetShapeshiftFormInfo
flickerstreak@134 13 local IsUsableSpell = IsUsableSpell
flickerstreak@134 14 local GetSpellInfo = GetSpellInfo
flickerstreak@134 15
flickerstreak@134 16 --
flickerstreak@134 17 -- private
flickerstreak@134 18 --
flickerstreak@134 19 local playerClass = select(2,UnitClass("player"))
flickerstreak@134 20
flickerstreak@134 21 local eventList = {
flickerstreak@134 22 "PLAYER_REGEN_ENABLED",
flickerstreak@134 23 "PLAYER_ENTERING_WORLD",
flickerstreak@134 24 "UPDATE_SHAPESHIFT_FORM",
flickerstreak@134 25 "UPDATE_SHAPESHIFT_FORMS",
flickerstreak@134 26 "UPDATE_SHAPESHIFT_USABLE",
flickerstreak@134 27 "UPDATE_SHAPESHIFT_COOLDOWN",
flickerstreak@137 28 "UPDATE_BINDINGS",
flickerstreak@134 29 }
flickerstreak@134 30
flickerstreak@134 31 --
flickerstreak@134 32 -- Stance Button class
flickerstreak@134 33 --
flickerstreak@218 34 local buttonTypeID = "Stance"
flickerstreak@134 35 local Super = ReAction.Button
flickerstreak@218 36 local Stance = setmetatable(
flickerstreak@218 37 {
flickerstreak@218 38 defaultConfig = {
flickerstreak@218 39 type = buttonTypeID,
flickerstreak@218 40 btnHeight = 36,
flickerstreak@218 41 btnWidth = 36,
flickerstreak@218 42 btnRows = 1,
flickerstreak@218 43 btnColumns = 6,
flickerstreak@218 44 spacing = 3
flickerstreak@218 45 },
flickerstreak@218 46
flickerstreak@218 47 barType = L["Stance Bar"],
flickerstreak@218 48 },
flickerstreak@218 49 { __index = Super } )
flickerstreak@134 50 ReAction.Button.Stance = Stance
flickerstreak@134 51
flickerstreak@134 52 function Stance:New( idx, moduleConfig, bar, idHint )
flickerstreak@134 53 local name = format("ReAction_%s_Stance_%d",bar:GetName(),idx)
flickerstreak@134 54
flickerstreak@134 55 self = Super.New(self, name, moduleConfig.buttons[bar:GetName()][idx], bar, idx, "SecureActionButtonTemplate, ActionButtonTemplate" )
flickerstreak@134 56 self.moduleConfig = moduleConfig
flickerstreak@134 57
flickerstreak@134 58 local f = self:GetFrame()
flickerstreak@134 59 local barFrame = bar:GetFrame()
flickerstreak@134 60 local config = self:GetConfig()
flickerstreak@134 61
flickerstreak@134 62 -- set up the base stance ID
flickerstreak@134 63 self:SetActionIDPool("stance",8)
flickerstreak@134 64 config.stanceID = self:AcquireActionID(config.stanceID, idHint, true)
flickerstreak@134 65
flickerstreak@134 66 -- attribute setup
flickerstreak@134 67 f:SetAttribute("type","spell")
flickerstreak@134 68
flickerstreak@134 69 -- non secure scripts
flickerstreak@134 70 f:SetScript("OnEvent", function(frame, ...) self:OnEvent(...) end)
flickerstreak@134 71 f:SetScript("OnEnter", function(frame) self:OnEnter() end)
flickerstreak@134 72 f:SetScript("OnLeave", function(frame) self:OnLeave() end)
flickerstreak@134 73 f:SetScript("PreClick", function(frame, ...) self:PreClick(...) end)
flickerstreak@134 74
flickerstreak@134 75 -- secure handlers
flickerstreak@134 76 -- (none)
flickerstreak@134 77
flickerstreak@134 78 -- event registration
flickerstreak@134 79 f:EnableMouse(true)
flickerstreak@134 80 f:RegisterForClicks("AnyUp")
flickerstreak@134 81 for _, evt in pairs(eventList) do
flickerstreak@134 82 f:RegisterEvent(evt)
flickerstreak@134 83 end
flickerstreak@134 84
flickerstreak@134 85 -- attach to skinner
flickerstreak@134 86 bar:SkinButton(self)
flickerstreak@134 87
flickerstreak@134 88 -- initial display
flickerstreak@134 89 if ReAction:GetConfigMode() then
flickerstreak@134 90 self:GetFrame():Show()
flickerstreak@134 91 end
flickerstreak@134 92
flickerstreak@134 93 self:Refresh()
flickerstreak@134 94
flickerstreak@134 95 return self
flickerstreak@134 96 end
flickerstreak@134 97
flickerstreak@134 98 function Stance:GetActionID()
flickerstreak@134 99 return self.config.stanceID
flickerstreak@134 100 end
flickerstreak@134 101
flickerstreak@134 102 function Stance:UpdateAction()
flickerstreak@134 103 if InCombatLockdown() then
flickerstreak@134 104 self.updatePending = true
flickerstreak@134 105 else
flickerstreak@134 106 self.updatePending = false
flickerstreak@134 107 local idx = self:GetActionID()
flickerstreak@134 108 local f = self:GetFrame()
flickerstreak@179 109 if idx > GetNumShapeshiftForms() then
flickerstreak@134 110 f:Hide()
flickerstreak@134 111 else
flickerstreak@134 112 f:SetAttribute("spell", select(2,GetShapeshiftFormInfo(idx)))
flickerstreak@134 113 f:Show()
flickerstreak@134 114 self:Update()
flickerstreak@134 115 end
flickerstreak@134 116 end
flickerstreak@134 117 end
flickerstreak@134 118
flickerstreak@134 119 function Stance:Refresh()
flickerstreak@134 120 Super.Refresh(self)
flickerstreak@137 121 self:UpdateHotkey()
flickerstreak@136 122 self:UpdateAction()
flickerstreak@134 123 end
flickerstreak@134 124
flickerstreak@134 125 function Stance:Update()
flickerstreak@179 126 local texture, _, isActive, isCastable = GetShapeshiftFormInfo(self:GetActionID())
flickerstreak@134 127
flickerstreak@134 128 local icon = self.frames.icon
flickerstreak@134 129 icon:SetTexture(texture)
flickerstreak@134 130 self:GetFrame():SetChecked( isActive and 1 or 0 )
flickerstreak@134 131 if isCastable then
flickerstreak@137 132 self.frames.hotkey:Show()
flickerstreak@134 133 icon:SetVertexColor(1.0, 1.0, 1.0)
flickerstreak@134 134 else
flickerstreak@134 135 icon:SetVertexColor(0.4, 0.4, 0.4)
flickerstreak@134 136 end
flickerstreak@134 137
flickerstreak@134 138 self:UpdateCooldown()
flickerstreak@134 139 end
flickerstreak@134 140
flickerstreak@134 141 function Stance:UpdateCooldown()
flickerstreak@179 142 local start, duration, enabled = GetShapeshiftFormCooldown(self:GetActionID())
flickerstreak@134 143 if start then
flickerstreak@134 144 CooldownFrame_SetTimer(self.frames.cooldown, start, duration, enabled)
flickerstreak@134 145 end
flickerstreak@134 146 end
flickerstreak@134 147
flickerstreak@134 148 function Stance:SetTooltip()
flickerstreak@134 149 if GetCVar("UberTooltips") == "1" then
flickerstreak@134 150 GameTooltip_SetDefaultAnchor(GameTooltip, self:GetFrame())
flickerstreak@134 151 else
flickerstreak@134 152 GameTooltip:SetOwner(self:GetFrame(), "ANCHOR_RIGHT")
flickerstreak@134 153 end
flickerstreak@179 154 GameTooltip:SetShapeshift(self:GetActionID())
flickerstreak@134 155 end
flickerstreak@134 156
flickerstreak@134 157 function Stance:OnEnter()
flickerstreak@134 158 self:SetTooltip()
flickerstreak@134 159 end
flickerstreak@134 160
flickerstreak@134 161 function Stance:OnLeave()
flickerstreak@134 162 GameTooltip:Hide()
flickerstreak@134 163 end
flickerstreak@134 164
flickerstreak@134 165 function Stance:PreClick()
flickerstreak@134 166 local f = self:GetFrame()
flickerstreak@134 167 f:SetChecked( not f:GetChecked() )
flickerstreak@134 168 end
flickerstreak@134 169
flickerstreak@134 170 function Stance:OnEvent(event, arg)
flickerstreak@134 171 if event == "PLAYER_REGEN_ENABLED" then
flickerstreak@134 172 if self.updatePending then
flickerstreak@134 173 self:UpdateAction()
flickerstreak@134 174 end
flickerstreak@134 175 elseif event == "UPDATE_SHAPESHIFT_COOLDOWN" then
flickerstreak@134 176 self:UpdateCooldown()
flickerstreak@179 177 elseif event == "UPDATE_SHAPESHIFT_FORMS" then
flickerstreak@134 178 self:UpdateAction()
flickerstreak@134 179 elseif event == "UNIT_AURA" then
flickerstreak@134 180 if arg == "player" then
flickerstreak@134 181 self:Update()
flickerstreak@134 182 end
flickerstreak@137 183 elseif event == "UPDATE_BINDINGS" then
flickerstreak@137 184 self:UpdateHotkey()
flickerstreak@134 185 else
flickerstreak@134 186 self:Update()
flickerstreak@134 187 end
flickerstreak@134 188 end
flickerstreak@134 189
flickerstreak@134 190 function Stance:ShowGridTemp(show)
flickerstreak@134 191 if show then
flickerstreak@134 192 self:GetFrame():Show()
flickerstreak@134 193 else
flickerstreak@134 194 self:UpdateAction()
flickerstreak@134 195 end
flickerstreak@134 196 end