annotate classes/BagButton.lua @ 178:2e2abdaad2e5

refix shadow dance and demon form states
author Flick <flickerstreak@gmail.com>
date Wed, 20 Oct 2010 18:58:36 +0000
parents df68b5a40490
children e63aefb8a555
rev   line source
flickerstreak@175 1 local addonName, addonTable = ...
flickerstreak@175 2 local ReAction = addonTable.ReAction
flickerstreak@146 3 local L = ReAction.L
flickerstreak@146 4 local _G = _G
flickerstreak@146 5 local CreateFrame = CreateFrame
flickerstreak@146 6 local format = string.format
flickerstreak@146 7 local GetCVar = GetCVar
flickerstreak@146 8 local ContainerIDToInventoryID = ContainerIDToInventoryID
flickerstreak@146 9 local NUM_CONTAINER_FRAMES = NUM_CONTAINER_FRAMES
flickerstreak@146 10 local IsModifiedClick = IsModifiedClick
flickerstreak@146 11 local CursorHasItem = CursorHasItem
flickerstreak@146 12 local GetInventoryItemTexture = GetInventoryItemTexture
flickerstreak@146 13 local GetInventorySlotInfo = GetInventorySlotInfo
flickerstreak@146 14 local PickupBagFromSlot = PickupBagFromSlot
flickerstreak@146 15 local CursorCanGoInSlot = CursorCanGoInSlot
flickerstreak@146 16
flickerstreak@146 17 -- class declarations
flickerstreak@146 18 local Super = ReAction.Button
flickerstreak@146 19 local BagBase = setmetatable( { }, { __index = Super } )
flickerstreak@146 20 local Bag = setmetatable( { }, { __index = BagBase } )
flickerstreak@146 21 local Backpack = setmetatable( { }, { __index = BagBase } )
flickerstreak@146 22 local Keyring = setmetatable( { }, { __index = BagBase } )
flickerstreak@146 23
flickerstreak@146 24 ReAction.Button.Bag = BagBase
flickerstreak@146 25
flickerstreak@146 26 --
flickerstreak@146 27 -- Bag Button base class
flickerstreak@146 28 --
flickerstreak@146 29
flickerstreak@146 30 function BagBase:New( idx, moduleConfig, bar, idHint )
flickerstreak@146 31 local name = format("ReAction_%s_Bag_%d",bar:GetName(),idx)
flickerstreak@146 32
flickerstreak@146 33 -- use a variable private leaf implementation class
flickerstreak@146 34 -- unlike traditional OO programming, we can initialize the leaf
flickerstreak@146 35 -- class before initializing its derived class
flickerstreak@146 36 local class = Bag
flickerstreak@146 37 if idx == 1 then
flickerstreak@146 38 class = Backpack
flickerstreak@146 39 elseif idx == 6 then
flickerstreak@146 40 class = Keyring
flickerstreak@146 41 end
flickerstreak@146 42 self = class:New(name,moduleConfig.buttons[bar:GetName()][idx], bar, idx)
flickerstreak@146 43 self.moduleConfig = moduleConfig
flickerstreak@146 44
flickerstreak@146 45 local f = self:GetFrame()
flickerstreak@146 46 local config = self:GetConfig()
flickerstreak@146 47
flickerstreak@146 48 -- set up the bag ID pool
flickerstreak@146 49 self:SetActionIDPool("bag",6)
flickerstreak@146 50 config.bagID = self:AcquireActionID(config.bagID, idHint, true)
flickerstreak@146 51
flickerstreak@146 52 -- non secure scripts
flickerstreak@146 53 f:SetScript("OnEvent", function(frame, ...) self:OnEvent(...) end)
flickerstreak@146 54 f:SetScript("OnEnter", function(frame) self:OnEnter() end)
flickerstreak@146 55 f:SetScript("OnLeave", function(frame) self:OnLeave() end)
flickerstreak@146 56 f:SetScript("OnReceiveDrag", function(frame, ...) self:OnReceiveDrag(...) end)
flickerstreak@146 57 f:SetScript("OnClick", function(frame, ...) self:OnClick(...) end)
flickerstreak@146 58
flickerstreak@146 59 -- secure handlers
flickerstreak@146 60 -- (none)
flickerstreak@146 61
flickerstreak@146 62 -- event registration
flickerstreak@146 63 f:EnableMouse(true)
flickerstreak@146 64 f:RegisterForClicks("LeftButtonUp","RightButtonUp")
flickerstreak@146 65 f:RegisterEvent("UPDATE_BINDINGS")
flickerstreak@146 66
flickerstreak@146 67 -- frame setup
flickerstreak@146 68 f:SetID(self:GetBagID())
flickerstreak@146 69
flickerstreak@146 70 if not f.hotkey then
flickerstreak@146 71 local h = f:CreateFontString(name.."HotKey","ARTWORK","NumberFontNormalSmallGray")
flickerstreak@152 72 h:SetWidth(30)
flickerstreak@146 73 h:SetHeight(10)
flickerstreak@146 74 h:SetJustifyH("RIGHT")
flickerstreak@146 75 h:SetPoint("TOPLEFT",f,"TOPLEFT",-2,-2)
flickerstreak@146 76 h:Show()
flickerstreak@146 77 f.hotkey = h
flickerstreak@146 78 end
flickerstreak@146 79
flickerstreak@146 80 if not _G[name.."ItemAnim"] then
flickerstreak@146 81 local anim = CreateFrame("Model",name.."ItemAnim",f,"ItemAnimTemplate")
flickerstreak@146 82 anim:SetPoint("BOTTOMRIGHT",f,"BOTTOMRIGHT",-10,0)
flickerstreak@146 83 anim:Hide()
flickerstreak@146 84 end
flickerstreak@146 85
flickerstreak@152 86 if not f.border then
flickerstreak@152 87 local b = f:CreateTexture(name.."Border","OVERLAY")
flickerstreak@152 88 b:SetAllPoints()
flickerstreak@152 89 b:SetWidth(f:GetWidth()*(62/36))
flickerstreak@152 90 b:SetHeight(f:GetHeight()*(62/36))
flickerstreak@152 91 b:SetTexture("Interface\\Buttons\UI-ActionButton-Border")
flickerstreak@152 92 b:SetBlendMode("ADD")
flickerstreak@152 93 b:Hide()
flickerstreak@152 94 f.border = b
flickerstreak@152 95 end
flickerstreak@152 96
flickerstreak@146 97 self.frames.count:SetDrawLayer("ARTWORK")
flickerstreak@146 98
flickerstreak@146 99 self.frames.hotkey = f.hotkey
flickerstreak@152 100 self.frames.border = _G[name.."Border"]
flickerstreak@146 101 self.frames.icon = _G[name.."IconTexture"]
flickerstreak@146 102 self.frames.anim = _G[name.."ItemAnim"]
flickerstreak@146 103
flickerstreak@146 104 -- initial display
flickerstreak@146 105 if ReAction:GetConfigMode() then
flickerstreak@146 106 self:GetFrame():Show()
flickerstreak@146 107 end
flickerstreak@146 108
flickerstreak@146 109 self:Refresh()
flickerstreak@146 110
flickerstreak@146 111 return self
flickerstreak@146 112 end
flickerstreak@146 113
flickerstreak@146 114 function BagBase:GetModuleConfig()
flickerstreak@146 115 -- this is the Bag module config structure,
flickerstreak@146 116 -- not the config structure of the bar itself
flickerstreak@146 117 return self.moduleConfig
flickerstreak@146 118 end
flickerstreak@146 119
flickerstreak@146 120 function BagBase:GetActionID()
flickerstreak@146 121 return self.config.bagID
flickerstreak@146 122 end
flickerstreak@146 123
flickerstreak@146 124 function BagBase:GetBagID()
flickerstreak@146 125 return self:GetActionID() - 1
flickerstreak@146 126 end
flickerstreak@146 127
flickerstreak@146 128 function BagBase:Refresh()
flickerstreak@146 129 Super.Refresh(self)
flickerstreak@146 130 self:UpdateHotkey()
flickerstreak@146 131 self:Update()
flickerstreak@146 132 end
flickerstreak@146 133
flickerstreak@146 134 function BagBase:Update()
flickerstreak@146 135 self:UpdateChecked()
flickerstreak@146 136 end
flickerstreak@146 137
flickerstreak@146 138 function BagBase:UpdateChecked(force)
flickerstreak@146 139 if force == nil then
flickerstreak@146 140 for i=1, NUM_CONTAINER_FRAMES do
flickerstreak@146 141 local c = _G["ContainerFrame"..i]
flickerstreak@146 142 if c:GetID() == self:GetBagID() and c:IsShown() then
flickerstreak@146 143 self:GetFrame():SetChecked(1)
flickerstreak@146 144 return
flickerstreak@146 145 end
flickerstreak@146 146 end
flickerstreak@146 147 self:GetFrame():SetChecked(0)
flickerstreak@146 148 end
flickerstreak@146 149 self:GetFrame():SetChecked(force)
flickerstreak@146 150 end
flickerstreak@146 151
flickerstreak@146 152 function BagBase:OnEvent(evt, ...)
flickerstreak@146 153 if self[evt] then
flickerstreak@146 154 self[evt](self, ...)
flickerstreak@146 155 end
flickerstreak@146 156 end
flickerstreak@146 157
flickerstreak@146 158 function BagBase:OnEnter()
flickerstreak@146 159 self:SetTooltip()
flickerstreak@146 160 end
flickerstreak@146 161
flickerstreak@146 162 function BagBase:OnLeave()
flickerstreak@146 163 GameTooltip:Hide()
flickerstreak@146 164 end
flickerstreak@146 165
flickerstreak@146 166 function BagBase:UPDATE_BINDINGS()
flickerstreak@146 167 self:UpdateHotkey()
flickerstreak@146 168 end
flickerstreak@146 169
flickerstreak@146 170
flickerstreak@146 171 --
flickerstreak@146 172 -- Bag Button class
flickerstreak@146 173 --
flickerstreak@146 174 function Bag:New(name, cfg, bar, idx)
flickerstreak@146 175 self = Super.New(self, name, cfg, bar, idx, "ItemButtonTemplate" )
flickerstreak@146 176
flickerstreak@146 177 local f = self:GetFrame()
flickerstreak@146 178
flickerstreak@146 179 f:SetCheckedTexture("Interface\\Buttons\\CheckButtonHilight")
flickerstreak@146 180
flickerstreak@146 181 f:RegisterEvent("CURSOR_UPDATE")
flickerstreak@151 182 f:RegisterEvent("BAG_UPDATE")
flickerstreak@146 183 f:RegisterEvent("BAG_CLOSED")
flickerstreak@146 184 f:SetScript("OnDragStart", function(frame, ...) self:OnDragStart(...) end)
flickerstreak@146 185 f:RegisterForDrag("LeftButton")
flickerstreak@146 186
flickerstreak@146 187 -- attach to skinner
flickerstreak@146 188 bar:SkinButton(self,
flickerstreak@146 189 {
flickerstreak@146 190 Icon = _G[name.."IconTexture"]
flickerstreak@146 191 }
flickerstreak@146 192 )
flickerstreak@146 193
flickerstreak@146 194 return self
flickerstreak@146 195 end
flickerstreak@146 196
flickerstreak@146 197 function Bag:GetInventorySlot()
flickerstreak@146 198 return ContainerIDToInventoryID(self:GetBagID())
flickerstreak@146 199 end
flickerstreak@146 200
flickerstreak@146 201 function Bag:GetInventorySlotName()
flickerstreak@146 202 return "Bag"..(self:GetBagID()-1).."Slot"
flickerstreak@146 203 end
flickerstreak@146 204
flickerstreak@146 205 function Bag:SetTooltip()
flickerstreak@146 206 GameTooltip:SetOwner(self:GetFrame(), "ANCHOR_LEFT")
flickerstreak@146 207 if not GameTooltip:SetInventoryItem("player", self:GetInventorySlot()) then
flickerstreak@146 208 GameTooltip:SetText(EQUIP_CONTAINER, 1.0, 1.0, 1.0)
flickerstreak@146 209 end
flickerstreak@146 210 end
flickerstreak@146 211
flickerstreak@146 212 function Bag:Update()
flickerstreak@146 213 local texture = GetInventoryItemTexture("player", self:GetInventorySlot())
flickerstreak@146 214 if texture then
flickerstreak@146 215 self.frames.icon:SetTexture(texture)
flickerstreak@146 216 self.frames.icon:Show()
flickerstreak@146 217 self:GetFrame():SetNormalTexture("Interface\\Buttons\\UI-Quickslot2")
flickerstreak@146 218 else
flickerstreak@146 219 local _, bgTex = GetInventorySlotInfo(self:GetInventorySlotName())
flickerstreak@146 220 self.frames.icon:SetTexture(bgTex)
flickerstreak@146 221 self:GetFrame():SetNormalTexture("Interface\\Buttons\\UI-Quickslot")
flickerstreak@146 222 end
flickerstreak@146 223 self:UpdateChecked()
flickerstreak@146 224 end
flickerstreak@146 225
flickerstreak@146 226 function Bag:OnClick()
flickerstreak@146 227 if IsModifiedClick("OPENALLBAGS") then
flickerstreak@146 228 OpenAllBags()
flickerstreak@146 229 else
flickerstreak@146 230 if not PutItemInBag(self:GetInventorySlot()) then
flickerstreak@146 231 ToggleBag(self:GetBagID())
flickerstreak@146 232 end
flickerstreak@146 233 end
flickerstreak@146 234 self:UpdateChecked()
flickerstreak@146 235 end
flickerstreak@146 236
flickerstreak@146 237 function Bag:OnReceiveDrag()
flickerstreak@146 238 if CursorHasItem() then
flickerstreak@146 239 PutItemInBag(self:GetInventorySlot())
flickerstreak@146 240 end
flickerstreak@146 241 end
flickerstreak@146 242
flickerstreak@146 243 function Bag:OnDragStart()
flickerstreak@146 244 PickupBagFromSlot(self:GetInventorySlot())
flickerstreak@146 245 self:Update()
flickerstreak@146 246 end
flickerstreak@146 247
flickerstreak@151 248 function Bag:BAG_UPDATE(bag)
flickerstreak@151 249 if bag == self:GetBagID() then
flickerstreak@146 250 self:Update()
flickerstreak@146 251 end
flickerstreak@146 252 end
flickerstreak@146 253
flickerstreak@146 254 function Bag:CURSOR_UPDATE()
flickerstreak@146 255 if CursorCanGoInSlot(self:GetInventorySlot()) then
flickerstreak@146 256 self:GetFrame():LockHighlight()
flickerstreak@146 257 else
flickerstreak@146 258 self:GetFrame():UnlockHighlight()
flickerstreak@146 259 end
flickerstreak@146 260 end
flickerstreak@146 261
flickerstreak@146 262 function Bag:BAG_CLOSED(bag)
flickerstreak@146 263 if bag == self:GetBagID() then
flickerstreak@146 264 self:Update()
flickerstreak@146 265 end
flickerstreak@146 266 end
flickerstreak@146 267
flickerstreak@146 268
flickerstreak@146 269 --
flickerstreak@146 270 -- Backpack Button class
flickerstreak@146 271 --
flickerstreak@146 272 function Backpack:New(name, cfg, bar, idx)
flickerstreak@146 273 self = Super.New(self, name, cfg, bar, idx, "ItemButtonTemplate" )
flickerstreak@146 274
flickerstreak@146 275 local f = self:GetFrame()
flickerstreak@146 276 local icon = _G[name.."IconTexture"]
flickerstreak@146 277 icon:SetTexture("Interface\\Buttons\\Button-Backpack-Up")
flickerstreak@146 278 icon:Show()
flickerstreak@146 279 f:SetCheckedTexture("Interface\\Buttons\\CheckButtonHilight")
flickerstreak@146 280 f:RegisterEvent("PLAYER_ENTERING_WORLD");
flickerstreak@146 281 f:RegisterEvent("CVAR_UPDATE");
flickerstreak@146 282 f:SetScript("OnShow", function(frame, ...) self:OnShow(...) end)
flickerstreak@146 283
flickerstreak@146 284 -- attach to skinner
flickerstreak@146 285 bar:SkinButton(self,
flickerstreak@146 286 {
flickerstreak@146 287 Icon = _G[name.."IconTexture"]
flickerstreak@146 288 }
flickerstreak@146 289 )
flickerstreak@146 290
flickerstreak@146 291 return self
flickerstreak@146 292 end
flickerstreak@146 293
flickerstreak@146 294 function Backpack:Update()
flickerstreak@146 295 self:UpdateFreeSlots()
flickerstreak@146 296 self:UpdateChecked()
flickerstreak@146 297 end
flickerstreak@146 298
flickerstreak@146 299 function Backpack:UpdateFreeSlots()
flickerstreak@146 300 if GetCVar("displayFreeBagSlots") == "1" then
flickerstreak@146 301 local total = 0
flickerstreak@146 302 for i = BACKPACK_CONTAINER, NUM_BAG_SLOTS do
flickerstreak@146 303 local free, family = GetContainerNumFreeSlots(i)
flickerstreak@146 304 if family == 0 then
flickerstreak@146 305 total = total + free
flickerstreak@146 306 end
flickerstreak@146 307 end
flickerstreak@146 308
flickerstreak@146 309 self.freeSlots = total
flickerstreak@146 310 self.frames.count:SetText(format("(%s)", self.freeSlots))
flickerstreak@146 311 self.frames.count:Show()
flickerstreak@146 312 elseif self.frames.count:IsShown() then
flickerstreak@146 313 self.frames.count:Hide()
flickerstreak@146 314 end
flickerstreak@146 315 end
flickerstreak@146 316
flickerstreak@146 317 function Backpack:SetTooltip()
flickerstreak@146 318 GameTooltip:SetOwner(self:GetFrame(), "ANCHOR_LEFT")
flickerstreak@146 319 GameTooltip:SetText(BACKPACK_TOOLTIP, 1.0, 1.0, 1.0)
flickerstreak@146 320 GameTooltip:AddLine(string.format(NUM_FREE_SLOTS, (self.freeSlots or 0)))
flickerstreak@146 321 GameTooltip:Show();
flickerstreak@146 322 end
flickerstreak@146 323
flickerstreak@146 324 function Backpack:OnShow()
flickerstreak@146 325 self:UpdateFreeSlots()
flickerstreak@146 326 end
flickerstreak@146 327
flickerstreak@146 328 function Backpack:OnClick()
flickerstreak@146 329 if IsModifiedClick("OPENALLBAGS") then
flickerstreak@146 330 OpenAllBags()
flickerstreak@146 331 else
flickerstreak@146 332 if not PutItemInBackpack() then
flickerstreak@146 333 ToggleBackpack()
flickerstreak@146 334 end
flickerstreak@146 335 end
flickerstreak@146 336 self:UpdateChecked()
flickerstreak@146 337 end
flickerstreak@146 338
flickerstreak@146 339 function Backpack:OnReceiveDrag()
flickerstreak@146 340 if CursorHasItem() then
flickerstreak@146 341 PutItemInBackpack()
flickerstreak@146 342 end
flickerstreak@146 343 end
flickerstreak@146 344
flickerstreak@146 345 function Backpack:PLAYER_ENTERING_WORLD()
flickerstreak@146 346 self:CVAR_UPDATE("DISPLAY_FREE_BAG_SLOTS", GetCVar("displayFreeBagSlots"))
flickerstreak@146 347 end
flickerstreak@146 348
flickerstreak@146 349 function Backpack:CVAR_UPDATE( cvar, value )
flickerstreak@146 350 if cvar == "DISPLAY_FREE_BAG_SLOTS" then
flickerstreak@146 351 if value == "1" then
flickerstreak@146 352 self:GetFrame():RegisterEvent("BAG_UPDATE")
flickerstreak@146 353 else
flickerstreak@146 354 self:GetFrame():UnregisterEvent("BAG_UPDATE")
flickerstreak@146 355 end
flickerstreak@146 356 self:UpdateFreeSlots()
flickerstreak@146 357 end
flickerstreak@146 358 end
flickerstreak@146 359
flickerstreak@146 360 function Backpack:BAG_UPDATE(bag)
flickerstreak@146 361 if bag >= BACKPACK_CONTAINER and bag <= NUM_BAG_SLOTS then
flickerstreak@146 362 self:UpdateFreeSlots()
flickerstreak@146 363 end
flickerstreak@146 364 end
flickerstreak@146 365
flickerstreak@146 366
flickerstreak@146 367 --
flickerstreak@146 368 -- Keyring Button class
flickerstreak@146 369 --
flickerstreak@146 370 function Keyring:New(name, cfg, bar, idx)
flickerstreak@146 371 self = Super.New(self, name, cfg, bar, idx, "ItemButtonTemplate" )
flickerstreak@146 372
flickerstreak@146 373 local f = self:GetFrame()
flickerstreak@146 374
flickerstreak@146 375 f:SetWidth(18)
flickerstreak@146 376 f:SetHeight(39)
flickerstreak@146 377
flickerstreak@146 378 local tex = f:GetNormalTexture()
flickerstreak@146 379 tex:ClearAllPoints()
flickerstreak@152 380 tex:SetAllPoints()
flickerstreak@146 381
flickerstreak@146 382 f:SetNormalTexture("Interface\\Buttons\\UI-Button-KeyRing")
flickerstreak@146 383 f:SetHighlightTexture("Interface\\Buttons\\UI-Button-KeyRing-Highlight")
flickerstreak@146 384 f:SetPushedTexture("Interface\\Buttons\\UI-Button-KeyRing-Down")
flickerstreak@146 385 f:GetNormalTexture():SetTexCoord(0,0.5625,0,0.609375)
flickerstreak@146 386 f:GetHighlightTexture():SetTexCoord(0,0.5625,0,0.609375)
flickerstreak@146 387 f:GetPushedTexture():SetTexCoord(0,0.5625,0,0.609375)
flickerstreak@146 388
flickerstreak@146 389 if not HasKey() then
flickerstreak@146 390 f:Hide()
flickerstreak@146 391 end
flickerstreak@146 392
flickerstreak@146 393 -- DO NOT attach to skinner
flickerstreak@146 394
flickerstreak@146 395 return self
flickerstreak@146 396 end
flickerstreak@146 397
flickerstreak@146 398 function Keyring:GetBagID()
flickerstreak@146 399 return KEYRING_CONTAINER
flickerstreak@146 400 end
flickerstreak@146 401
flickerstreak@146 402 function Keyring:Refresh()
flickerstreak@146 403 local f = self:GetFrame()
flickerstreak@146 404 self.bar:PlaceButton( self, f:GetHeight(), f:GetHeight() ) -- use height x height since it's an odd size
flickerstreak@146 405 self:UpdateHotkey()
flickerstreak@146 406 self:Update()
flickerstreak@146 407 end
flickerstreak@146 408
flickerstreak@146 409 function Keyring:SetTooltip()
flickerstreak@146 410 GameTooltip:SetOwner(self:GetFrame(), "ANCHOR_RIGHT");
flickerstreak@146 411 GameTooltip:SetText(KEYRING, HIGHLIGHT_FONT_COLOR.r, HIGHLIGHT_FONT_COLOR.g, HIGHLIGHT_FONT_COLOR.b);
flickerstreak@146 412 GameTooltip:AddLine();
flickerstreak@146 413 end
flickerstreak@146 414
flickerstreak@146 415 function Keyring:OnReceiveDrag()
flickerstreak@146 416 if CursorHasItem() then
flickerstreak@146 417 PutKeyInKeyRing()
flickerstreak@146 418 end
flickerstreak@146 419 end
flickerstreak@146 420
flickerstreak@146 421 function Keyring:OnClick()
flickerstreak@146 422 if CursorHasItem() then
flickerstreak@146 423 PutKeyInKeyRing()
flickerstreak@146 424 else
flickerstreak@146 425 ToggleKeyRing()
flickerstreak@146 426 end
flickerstreak@146 427 self:UpdateChecked()
flickerstreak@146 428 end
flickerstreak@146 429
flickerstreak@146 430 function Keyring:ShowGridTemp(show)
flickerstreak@146 431 if not HasKey() then
flickerstreak@146 432 if show then
flickerstreak@146 433 self:GetFrame():Show()
flickerstreak@146 434 else
flickerstreak@146 435 self:GetFrame():Hide()
flickerstreak@146 436 end
flickerstreak@146 437 end
flickerstreak@146 438 end
flickerstreak@146 439