annotate classes/PetActionButton.lua @ 222:d08a74e86c96

un-namespace totem, pet, stance, vehicle exit
author Flick <flickerstreak@gmail.com>
date Sun, 21 Nov 2010 14:42:38 -0800
parents e63aefb8a555
children c4b134512c50
rev   line source
flickerstreak@175 1 local addonName, addonTable = ...
flickerstreak@175 2 local ReAction = addonTable.ReAction
flickerstreak@130 3 local L = ReAction.L
flickerstreak@130 4 local _G = _G
flickerstreak@130 5 local CreateFrame = CreateFrame
flickerstreak@130 6 local format = string.format
flickerstreak@130 7 local GetCVar = GetCVar
flickerstreak@130 8 local InCombatLockdown = InCombatLockdown
flickerstreak@130 9 local GetPetActionInfo = GetPetActionInfo
flickerstreak@130 10 local GetPetActionSlotUsable = GetPetActionSlotUsable
flickerstreak@130 11 local GetPetActionCooldown = GetPetActionCooldown
flickerstreak@130 12 local AutoCastShine_AutoCastStart = AutoCastShine_AutoCastStart
flickerstreak@130 13 local AutoCastShine_AutoCastStop = AutoCastShine_AutoCastStop
flickerstreak@130 14 local SetDesaturation = SetDesaturation
flickerstreak@130 15 local CooldownFrame_SetTimer = CooldownFrame_SetTimer
flickerstreak@130 16 local GameTooltip_SetDefaultAnchor = GameTooltip_SetDefaultAnchor
flickerstreak@130 17
flickerstreak@130 18 --
flickerstreak@130 19 -- Secure snippets
flickerstreak@130 20 -- These are run within the context of the bar's sandbox, as the
flickerstreak@130 21 -- buttons themselves do not have their own sandbox.
flickerstreak@130 22 --
flickerstreak@130 23 local _onDragStart = -- function(self, button, kind, value, ...)
flickerstreak@130 24 [[
flickerstreak@130 25 if lockButtons and (PlayerInCombat() or not lockButtonsCombat) and not IsModifiedClick("PICKUPACTION") then
flickerstreak@130 26 return kind, value, ...
flickerstreak@130 27 else
flickerstreak@130 28 return "petaction", self:GetAttribute("action")
flickerstreak@130 29 end
flickerstreak@130 30 ]]
flickerstreak@130 31
flickerstreak@130 32 local _onReceiveDrag = -- function(self, button, kind, value, ...)
flickerstreak@130 33 [[
flickerstreak@130 34 if kind then -- pet spells on the cursor return nil from GetCursorInfo(), which is very strange
flickerstreak@130 35 return kind, value, ...
flickerstreak@130 36 end
flickerstreak@130 37 return "petaction", self:GetAttribute("action")
flickerstreak@130 38 ]]
flickerstreak@130 39
flickerstreak@130 40 --
flickerstreak@130 41 -- private
flickerstreak@130 42 --
flickerstreak@130 43 local eventList = {
flickerstreak@130 44 "PLAYER_CONTROL_LOST",
flickerstreak@130 45 "PLAYER_CONTROL_GAINED",
flickerstreak@130 46 "PLAYER_FARSIGHT_FOCUS_CHANGED",
flickerstreak@130 47 "UNIT_PET",
flickerstreak@130 48 "UNIT_FLAGS",
flickerstreak@130 49 "UNIT_AURA",
flickerstreak@130 50 "PET_BAR_UPDATE",
flickerstreak@130 51 "PET_BAR_UPDATE_COOLDOWN",
flickerstreak@165 52 "PET_BAR_UPDATE_USABLE",
flickerstreak@130 53 "UPDATE_BINDINGS",
flickerstreak@130 54 }
flickerstreak@130 55
flickerstreak@130 56 --
flickerstreak@130 57 -- Pet Action Button class
flickerstreak@130 58 --
flickerstreak@218 59 local buttonTypeID = "PetAction"
flickerstreak@130 60 local Super = ReAction.Button
flickerstreak@218 61 local Pet = setmetatable(
flickerstreak@218 62 {
flickerstreak@218 63 defaultBarConfig = {
flickerstreak@218 64 type = buttonTypeID,
flickerstreak@218 65 btnWidth = 30,
flickerstreak@218 66 btnHeight = 30,
flickerstreak@218 67 btnRows = 1,
flickerstreak@218 68 btnColumns = 10,
flickerstreak@222 69 spacing = 8,
flickerstreak@222 70 buttons = { }
flickerstreak@218 71 },
flickerstreak@218 72
flickerstreak@218 73 barType = L["Pet Action Bar"],
flickerstreak@218 74 },
flickerstreak@218 75 { __index = Super } )
flickerstreak@130 76 ReAction.Button.PetAction = Pet
flickerstreak@130 77
flickerstreak@130 78 function Pet:New( idx, config, bar, idHint )
flickerstreak@130 79 local name = format("ReAction_%s_PetAction_%d",bar:GetName(),idx)
flickerstreak@130 80
flickerstreak@130 81 self = Super.New(self, name, config, bar, idx, "SecureActionButtonTemplate, ActionButtonTemplate" )
flickerstreak@130 82
flickerstreak@130 83 local f = self:GetFrame()
flickerstreak@130 84 if not f.autoCastTexture then
flickerstreak@131 85 -- store autocast stuff with the frame for recycling
flickerstreak@130 86 local tex = f:CreateTexture(nil,"OVERLAY")
flickerstreak@130 87 tex:SetTexture([[Interface\Buttons\UI-AutoCastableOverlay]])
flickerstreak@130 88 tex:SetHeight(58)
flickerstreak@130 89 tex:SetWidth(58)
flickerstreak@130 90 tex:SetPoint("CENTER")
flickerstreak@130 91 f.autoCastTexture = tex
flickerstreak@158 92 f.autoCastShine = CreateFrame("Frame",name.."Shine",f,"AutoCastShineTemplate") -- create after autocast texture so it's on top
flickerstreak@131 93 -- move the cooldown around
flickerstreak@131 94 local cd = self.frames.cooldown
flickerstreak@131 95 cd:ClearAllPoints()
flickerstreak@131 96 cd:SetWidth(33)
flickerstreak@131 97 cd:SetHeight(33)
flickerstreak@131 98 cd:SetPoint("CENTER", f, "CENTER", -2, -1)
flickerstreak@131 99 -- resize to 30x30
flickerstreak@131 100 f:SetHeight(30)
flickerstreak@131 101 f:SetWidth(30)
flickerstreak@142 102 local nt = _G[name.."NormalTexture"]
flickerstreak@142 103 nt:SetHeight(54)
flickerstreak@142 104 nt:SetWidth(54)
flickerstreak@130 105 end
flickerstreak@130 106 local barFrame = bar:GetFrame()
flickerstreak@130 107
flickerstreak@130 108 -- set up the base action ID
flickerstreak@130 109 self:SetActionIDPool("pet",10)
flickerstreak@130 110 config.actionID = self:AcquireActionID(config.actionID, idHint, true)
flickerstreak@130 111
flickerstreak@130 112 -- attribute setup
flickerstreak@131 113 -- There's no secure way to do PetAutoCastToggle by actionID, so use
flickerstreak@131 114 -- a click-through proxy to the Blizzard pet buttons for right-click
flickerstreak@131 115 -- Note that technically this doesn't do PetStopAttack() when
flickerstreak@131 116 -- IsPetAttackActive() is true: however that's only true when using
flickerstreak@131 117 -- Eyes of the Beast and appears not to really do anything (at least
flickerstreak@131 118 -- I can't find any difference)
flickerstreak@130 119 f:SetAttribute("type","pet")
flickerstreak@130 120 f:SetAttribute("type2","click")
flickerstreak@130 121 f:SetAttribute("clickbutton2",_G["PetActionButton"..config.actionID])
flickerstreak@130 122 f:SetAttribute("action",config.actionID)
flickerstreak@130 123 f:SetAttribute("checkselfcast", true)
flickerstreak@130 124 f:SetAttribute("checkfocuscast", true)
flickerstreak@130 125
flickerstreak@130 126 -- non secure scripts
flickerstreak@130 127 f:SetScript("OnEvent", function(frame, ...) self:OnEvent(...) end)
flickerstreak@130 128 f:SetScript("OnEnter", function(frame) self:OnEnter() end)
flickerstreak@130 129 f:SetScript("OnLeave", function(frame) self:OnLeave() end)
flickerstreak@130 130 f:SetScript("OnAttributeChanged", function(frame, attr, value) self:OnAttributeChanged(attr, value) end)
flickerstreak@130 131 f:SetScript("PreClick", function(frame) self:PreClick() end)
flickerstreak@130 132 f:SetScript("OnDragStart", function(frame) self:OnDragStart() end)
flickerstreak@130 133 f:SetScript("OnReceiveDrag", function(frame) self:OnReceiveDrag() end)
flickerstreak@130 134
flickerstreak@130 135 -- secure handlers
flickerstreak@130 136 barFrame:WrapScript(f, "OnDragStart", _onDragStart)
flickerstreak@130 137 barFrame:WrapScript(f, "OnReceiveDrag", _onReceiveDrag)
flickerstreak@130 138
flickerstreak@130 139 -- event registration
flickerstreak@130 140 f:EnableMouse(true)
flickerstreak@130 141 f:RegisterForDrag("LeftButton", "RightButton")
flickerstreak@130 142 f:RegisterForClicks("AnyUp")
flickerstreak@130 143 for _, evt in pairs(eventList) do
flickerstreak@130 144 f:RegisterEvent(evt)
flickerstreak@130 145 end
flickerstreak@130 146
flickerstreak@130 147 -- attach to skinner
flickerstreak@130 148 bar:SkinButton(self,
flickerstreak@130 149 {
flickerstreak@130 150 AutoCast = f.autoCastShine,
flickerstreak@130 151 AutoCastable = f.autoCastTexture
flickerstreak@130 152 })
flickerstreak@130 153
flickerstreak@130 154 self:Refresh()
flickerstreak@130 155 f:Show()
flickerstreak@130 156
flickerstreak@130 157 return self
flickerstreak@130 158 end
flickerstreak@130 159
flickerstreak@130 160 function Pet:Refresh()
flickerstreak@130 161 Super.Refresh(self)
flickerstreak@130 162 self:Update()
flickerstreak@130 163 self:UpdateHotkey()
flickerstreak@130 164 end
flickerstreak@130 165
flickerstreak@130 166 function Pet:GetActionID()
flickerstreak@130 167 return self.config.actionID
flickerstreak@130 168 end
flickerstreak@130 169
flickerstreak@130 170 function Pet:SetActionID(id)
flickerstreak@130 171 if not InCombatLockdown() then
flickerstreak@130 172 if id < 0 or id > 10 then
flickerstreak@130 173 ReAction:UserError(L["Pet action ID range is 1-10"])
flickerstreak@130 174 return
flickerstreak@130 175 end
flickerstreak@130 176 self.config.actionID = id
flickerstreak@130 177 f:SetAttribute("clickbutton2",_G["PetActionButton"..id])
flickerstreak@130 178 f:SetAttribute("action",id)
flickerstreak@130 179 self:Update()
flickerstreak@130 180 self:UpdateHotkey()
flickerstreak@130 181 end
flickerstreak@130 182 end
flickerstreak@130 183
flickerstreak@130 184 function Pet:Update()
flickerstreak@130 185 local action = self.config.actionID
flickerstreak@130 186 local name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(action)
flickerstreak@130 187 local f = self:GetFrame()
flickerstreak@130 188 local icon = self.frames.icon
flickerstreak@130 189
flickerstreak@130 190 if isToken then
flickerstreak@130 191 icon:SetTexture(_G[texture])
flickerstreak@130 192 self.tooltipName = _G[name]
flickerstreak@130 193 else
flickerstreak@130 194 icon:SetTexture(texture)
flickerstreak@130 195 self.tooltipName = name
flickerstreak@130 196 end
flickerstreak@130 197
flickerstreak@130 198 self.isToken = isToken
flickerstreak@130 199 self.tooltipSubtext = subtext
flickerstreak@130 200 f:SetChecked( isActive and 1 or 0 )
flickerstreak@130 201
flickerstreak@130 202 if autoCastAllowed then
flickerstreak@130 203 f.autoCastTexture:Show()
flickerstreak@130 204 else
flickerstreak@130 205 f.autoCastTexture:Hide()
flickerstreak@130 206 end
flickerstreak@130 207
flickerstreak@130 208 if autoCastEnabled then
flickerstreak@130 209 AutoCastShine_AutoCastStart(f.autoCastShine)
flickerstreak@130 210 else
flickerstreak@130 211 AutoCastShine_AutoCastStop(f.autoCastShine)
flickerstreak@130 212 end
flickerstreak@130 213
flickerstreak@130 214 if texture then
flickerstreak@130 215 if GetPetActionSlotUsable(action) then
flickerstreak@130 216 SetDesaturation(icon,nil)
flickerstreak@130 217 else
flickerstreak@130 218 SetDesaturation(icon,1)
flickerstreak@130 219 end
flickerstreak@130 220 icon:Show()
flickerstreak@130 221 f:SetNormalTexture("Interface\\Buttons\\UI-Quickslot2")
flickerstreak@130 222 else
flickerstreak@130 223 icon:Hide()
flickerstreak@130 224 f:SetNormalTexture("Interface\\Buttons\\UI-Quickslot")
flickerstreak@130 225 end
flickerstreak@130 226
flickerstreak@130 227 self:UpdateCooldown()
flickerstreak@130 228 end
flickerstreak@130 229
flickerstreak@130 230 function Pet:UpdateCooldown()
flickerstreak@130 231 CooldownFrame_SetTimer(self.frames.cooldown, GetPetActionCooldown(self.config.actionID))
flickerstreak@130 232 end
flickerstreak@130 233
flickerstreak@130 234 function Pet:SetTooltip()
flickerstreak@130 235 if self.tooltipName then
flickerstreak@130 236 local f = self:GetFrame()
flickerstreak@130 237 local uber = GetCVar("UberTooltips")
flickerstreak@130 238 if self.isToken or (uber == "0") then
flickerstreak@130 239 if uber == "0" then
flickerstreak@130 240 GameTooltip:SetOwner(f, "ANCHOR_RIGHT")
flickerstreak@130 241 else
flickerstreak@130 242 GameTooltip_SetDefaultAnchor(GameTooltip, f)
flickerstreak@130 243 end
flickerstreak@130 244 GameTooltip:SetText(self.tooltipName)
flickerstreak@130 245 if self.tooltipSubtext then
flickerstreak@130 246 GameTooltip:AddLine(self.tooltipSubtext, "", 0.5, 0.5, 0.5)
flickerstreak@130 247 end
flickerstreak@130 248 GameTooltip:Show()
flickerstreak@130 249 else
flickerstreak@130 250 GameTooltip_SetDefaultAnchor(GameTooltip, f)
flickerstreak@130 251 GameTooltip:SetPetAction(self.config.actionID)
flickerstreak@130 252 end
flickerstreak@130 253 else
flickerstreak@130 254 GameTooltip:Hide()
flickerstreak@130 255 end
flickerstreak@130 256 end
flickerstreak@130 257
flickerstreak@130 258 function Pet:OnEvent(event, unit)
flickerstreak@130 259 if event =="PET_BAR_UPDATE_COOLDOWN" then
flickerstreak@130 260 self:UpdateCooldown()
flickerstreak@130 261 elseif event == "UPDATE_BINDINGS" then
flickerstreak@130 262 self:UpdateHotkey()
flickerstreak@130 263 elseif event == "UNIT_PET" then
flickerstreak@130 264 if unit == "player" then
flickerstreak@130 265 self:Update()
flickerstreak@130 266 end
flickerstreak@130 267 elseif event == "UNIT_FLAGS" or event == "UNIT_AURA" then
flickerstreak@130 268 if unit == "pet" then
flickerstreak@130 269 self:Update()
flickerstreak@130 270 end
flickerstreak@130 271 else
flickerstreak@130 272 self:Update()
flickerstreak@130 273 end
flickerstreak@130 274 end
flickerstreak@130 275
flickerstreak@130 276 function Pet:OnEnter()
flickerstreak@130 277 self:SetTooltip()
flickerstreak@130 278 end
flickerstreak@130 279
flickerstreak@130 280 function Pet:OnLeave()
flickerstreak@130 281 GameTooltip:Hide()
flickerstreak@130 282 end
flickerstreak@130 283
flickerstreak@130 284 function Pet:OnAttributeChanged(attr,value)
flickerstreak@130 285 self:Update()
flickerstreak@130 286 end
flickerstreak@130 287
flickerstreak@130 288 function Pet:PreClick()
flickerstreak@130 289 self:GetFrame():SetChecked(0)
flickerstreak@130 290 end
flickerstreak@130 291
flickerstreak@130 292 function Pet:OnDragStart()
flickerstreak@130 293 self:SetChecked(0)
flickerstreak@130 294 self:Update()
flickerstreak@130 295 end
flickerstreak@130 296
flickerstreak@130 297 function Pet:OnReceiveDrag()
flickerstreak@130 298 self:SetChecked(0)
flickerstreak@130 299 self:Update()
flickerstreak@130 300 end
flickerstreak@130 301