annotate classes/BagButton.lua @ 223:c4b134512c50

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