annotate classes/BagButton.lua @ 231:158c9299185b

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