annotate classes/BagButton.lua @ 171:fe0c7be6f6ef

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