flickerstreak@24
|
1 --[[
|
flickerstreak@53
|
2 ReAction Action button module.
|
flickerstreak@24
|
3
|
flickerstreak@24
|
4 The button module implements standard action button functionality by wrapping Blizzard's
|
flickerstreak@24
|
5 ActionButton frame and associated functions. It also provides some button layout
|
flickerstreak@24
|
6 modification tools.
|
flickerstreak@24
|
7
|
flickerstreak@24
|
8 --]]
|
flickerstreak@24
|
9
|
flickerstreak@24
|
10 -- local imports
|
flickerstreak@24
|
11 local ReAction = ReAction
|
flickerstreak@24
|
12 local L = ReAction.L
|
flickerstreak@24
|
13 local _G = _G
|
flickerstreak@24
|
14 local CreateFrame = CreateFrame
|
flickerstreak@24
|
15
|
flickerstreak@24
|
16 -- module declaration
|
flickerstreak@24
|
17 local moduleID = "Action"
|
flickerstreak@28
|
18 local module = ReAction:NewModule( moduleID )
|
flickerstreak@24
|
19
|
flickerstreak@24
|
20 -- module methods
|
flickerstreak@24
|
21 function module:OnInitialize()
|
flickerstreak@28
|
22 self.db = ReAction.db:RegisterNamespace( moduleID,
|
flickerstreak@24
|
23 {
|
flickerstreak@28
|
24 profile = {
|
flickerstreak@28
|
25 buttons = { }
|
flickerstreak@28
|
26 }
|
flickerstreak@24
|
27 }
|
flickerstreak@24
|
28 )
|
flickerstreak@24
|
29 self.buttons = { }
|
flickerstreak@49
|
30
|
flickerstreak@49
|
31 ReAction:RegisterOptions("global", self, {
|
flickerstreak@49
|
32 hideEmpty = {
|
flickerstreak@49
|
33 type = "toggle",
|
flickerstreak@49
|
34 name = L["Hide Empty Buttons"],
|
flickerstreak@49
|
35 get = function() return self.db.profile.hideEmptyButtons end,
|
flickerstreak@49
|
36 set = function(info, val) module:SetHideEmptyButtons(val) end,
|
flickerstreak@49
|
37 }
|
flickerstreak@49
|
38 })
|
flickerstreak@24
|
39 end
|
flickerstreak@24
|
40
|
flickerstreak@24
|
41 function module:OnEnable()
|
flickerstreak@53
|
42 ReAction:RegisterBarType(L["Action Bar"],
|
flickerstreak@53
|
43 {
|
flickerstreak@53
|
44 type = moduleID,
|
flickerstreak@53
|
45 defaultButtonSize = 36,
|
flickerstreak@53
|
46 defaultBarRows = 1,
|
flickerstreak@53
|
47 defaultBarCols = 12,
|
flickerstreak@53
|
48 defaultBarSpacing = 3
|
flickerstreak@53
|
49 }, true)
|
flickerstreak@24
|
50 end
|
flickerstreak@24
|
51
|
flickerstreak@24
|
52 function module:OnDisable()
|
flickerstreak@53
|
53 ReAction:UnregisterBarType(L["Action Bar"])
|
flickerstreak@24
|
54 end
|
flickerstreak@24
|
55
|
flickerstreak@24
|
56 function module:ApplyToBar(bar)
|
flickerstreak@52
|
57 self:RefreshBar(bar)
|
flickerstreak@24
|
58 end
|
flickerstreak@24
|
59
|
flickerstreak@24
|
60 function module:RefreshBar(bar)
|
flickerstreak@53
|
61 if bar.config.type == moduleID then
|
flickerstreak@48
|
62 if self.buttons[bar] == nil then
|
flickerstreak@48
|
63 self.buttons[bar] = { }
|
flickerstreak@48
|
64 end
|
flickerstreak@48
|
65 local btns = self.buttons[bar]
|
flickerstreak@48
|
66 local profile = self.db.profile
|
flickerstreak@48
|
67 local barName = bar:GetName()
|
flickerstreak@48
|
68 if profile.buttons[barName] == nil then
|
flickerstreak@48
|
69 profile.buttons[barName] = {}
|
flickerstreak@48
|
70 end
|
flickerstreak@48
|
71 local btnCfg = profile.buttons[barName]
|
flickerstreak@24
|
72
|
flickerstreak@48
|
73 local r, c = bar:GetButtonGrid()
|
flickerstreak@48
|
74 local n = r*c
|
flickerstreak@48
|
75 for i = 1, n do
|
flickerstreak@48
|
76 if btnCfg[i] == nil then
|
flickerstreak@48
|
77 btnCfg[i] = {}
|
flickerstreak@48
|
78 end
|
flickerstreak@48
|
79 if btns[i] == nil then
|
flickerstreak@52
|
80 local ok, b = pcall(self.BtnClass.new, self.BtnClass, bar, i, btnCfg[i])
|
flickerstreak@52
|
81 if ok and b then
|
flickerstreak@52
|
82 btns[i] = b
|
flickerstreak@52
|
83 end
|
flickerstreak@48
|
84 else
|
flickerstreak@48
|
85 btns[i]:Refresh(bar,i)
|
flickerstreak@48
|
86 end
|
flickerstreak@24
|
87 end
|
flickerstreak@48
|
88 for i = n+1, #btns do
|
flickerstreak@52
|
89 if btns[i] then
|
flickerstreak@52
|
90 btns[i] = btns[i]:Destroy()
|
flickerstreak@52
|
91 if btnCfg[i] then
|
flickerstreak@52
|
92 btnCfg[i] = nil
|
flickerstreak@52
|
93 end
|
flickerstreak@48
|
94 end
|
flickerstreak@24
|
95 end
|
flickerstreak@24
|
96 end
|
flickerstreak@24
|
97 end
|
flickerstreak@24
|
98
|
flickerstreak@24
|
99 function module:RemoveFromBar(bar)
|
flickerstreak@24
|
100 if self.buttons[bar] then
|
flickerstreak@24
|
101 local btns = self.buttons[bar]
|
flickerstreak@24
|
102 for _,b in pairs(btns) do
|
flickerstreak@24
|
103 if b then
|
flickerstreak@24
|
104 b:Destroy()
|
flickerstreak@24
|
105 end
|
flickerstreak@24
|
106 end
|
flickerstreak@24
|
107 self.buttons[bar] = nil
|
flickerstreak@24
|
108 end
|
flickerstreak@24
|
109 end
|
flickerstreak@24
|
110
|
flickerstreak@24
|
111 function module:EraseBarConfig(barName)
|
flickerstreak@24
|
112 self.db.profile.buttons[barName] = nil
|
flickerstreak@24
|
113 end
|
flickerstreak@24
|
114
|
flickerstreak@48
|
115 function module:RenameBarConfig(oldname, newname)
|
flickerstreak@48
|
116 local b = self.db.profile.buttons
|
flickerstreak@48
|
117 b[newname], b[oldname] = b[oldname], nil
|
flickerstreak@48
|
118 end
|
flickerstreak@48
|
119
|
flickerstreak@49
|
120 function module:SetHideEmptyButtons(hide)
|
flickerstreak@49
|
121 if hide ~= self.db.profile.hideEmptyButtons then
|
flickerstreak@49
|
122 for _, bar in pairs(self.buttons) do
|
flickerstreak@49
|
123 for _, b in pairs(bar) do
|
flickerstreak@49
|
124 if hide then
|
flickerstreak@49
|
125 ActionButton_HideGrid(b.frame)
|
flickerstreak@49
|
126 else
|
flickerstreak@49
|
127 ActionButton_ShowGrid(b.frame)
|
flickerstreak@49
|
128 end
|
flickerstreak@49
|
129 end
|
flickerstreak@49
|
130 end
|
flickerstreak@49
|
131 self.db.profile.hideEmptyButtons = hide
|
flickerstreak@49
|
132 end
|
flickerstreak@49
|
133 end
|
flickerstreak@49
|
134
|
flickerstreak@24
|
135 function module:ApplyConfigMode(mode,bars)
|
flickerstreak@49
|
136 for _, bar in pairs(bars) do
|
flickerstreak@49
|
137 if bar and self.buttons[bar] then
|
flickerstreak@49
|
138 for _, b in pairs(self.buttons[bar]) do
|
flickerstreak@24
|
139 if b then
|
flickerstreak@24
|
140 if mode then
|
flickerstreak@49
|
141 ActionButton_ShowGrid(b.frame)
|
flickerstreak@50
|
142 self:showActionIDLabel(b)
|
flickerstreak@49
|
143 else
|
flickerstreak@49
|
144 ActionButton_HideGrid(b.frame)
|
flickerstreak@50
|
145 self:hideActionIDLabel(b)
|
flickerstreak@24
|
146 end
|
flickerstreak@24
|
147 end
|
flickerstreak@24
|
148 end
|
flickerstreak@24
|
149 end
|
flickerstreak@24
|
150 end
|
flickerstreak@24
|
151 end
|
flickerstreak@24
|
152
|
flickerstreak@50
|
153 function module:showActionIDLabel(button)
|
flickerstreak@52
|
154 if not button.actionIDLabel and button:GetActionID() then
|
flickerstreak@50
|
155 local label = button:GetFrame():CreateFontString(nil,"OVERLAY","GameFontNormalLarge")
|
flickerstreak@50
|
156 label:SetAllPoints()
|
flickerstreak@50
|
157 label:SetJustifyH("CENTER")
|
flickerstreak@50
|
158 label:SetShadowColor(0,0,0,1)
|
flickerstreak@50
|
159 label:SetShadowOffset(2,-2)
|
flickerstreak@50
|
160 label:SetText(tostring(button:GetActionID()))
|
flickerstreak@50
|
161 button.actionIDLabel = label
|
flickerstreak@50
|
162 end
|
flickerstreak@50
|
163 button.actionIDLabel:Show()
|
flickerstreak@50
|
164 end
|
flickerstreak@50
|
165
|
flickerstreak@50
|
166 function module:hideActionIDLabel(button)
|
flickerstreak@50
|
167 if button.actionIDLabel then
|
flickerstreak@50
|
168 button.actionIDLabel:Hide()
|
flickerstreak@50
|
169 end
|
flickerstreak@50
|
170 end
|
flickerstreak@50
|
171
|
flickerstreak@50
|
172
|
flickerstreak@50
|
173
|
flickerstreak@24
|
174 -- use-count of action IDs
|
flickerstreak@53
|
175 local nActionIDs = 120
|
flickerstreak@24
|
176 local ActionIDList = setmetatable( {}, {
|
flickerstreak@24
|
177 __index = function(self, idx)
|
flickerstreak@24
|
178 if idx == nil then
|
flickerstreak@53
|
179 for i = 1, nActionIDs do
|
flickerstreak@24
|
180 if rawget(self,i) == nil then
|
flickerstreak@24
|
181 rawset(self,i,1)
|
flickerstreak@24
|
182 return i
|
flickerstreak@24
|
183 end
|
flickerstreak@24
|
184 end
|
flickerstreak@52
|
185 error("ran out of action IDs")
|
flickerstreak@24
|
186 else
|
flickerstreak@24
|
187 local c = rawget(self,idx) or 0
|
flickerstreak@24
|
188 rawset(self,idx,c+1)
|
flickerstreak@24
|
189 return idx
|
flickerstreak@24
|
190 end
|
flickerstreak@24
|
191 end,
|
flickerstreak@24
|
192 __newindex = function(self,idx,value)
|
flickerstreak@24
|
193 if value == nil then
|
flickerstreak@24
|
194 value = rawget(self,idx)
|
flickerstreak@24
|
195 if value == 1 then
|
flickerstreak@24
|
196 value = nil
|
flickerstreak@24
|
197 elseif value then
|
flickerstreak@24
|
198 value = value - 1
|
flickerstreak@24
|
199 end
|
flickerstreak@24
|
200 end
|
flickerstreak@24
|
201 rawset(self,idx,value)
|
flickerstreak@24
|
202 end
|
flickerstreak@24
|
203 })
|
flickerstreak@24
|
204
|
flickerstreak@24
|
205
|
flickerstreak@24
|
206
|
flickerstreak@28
|
207
|
flickerstreak@28
|
208 ------ Button class ------
|
flickerstreak@28
|
209 local Button = { }
|
flickerstreak@28
|
210
|
flickerstreak@28
|
211 local function Constructor( self, bar, idx, config )
|
flickerstreak@24
|
212 self.bar, self.idx, self.config = bar, idx, config
|
flickerstreak@24
|
213
|
flickerstreak@24
|
214 local barFrame = bar:GetFrame()
|
flickerstreak@24
|
215
|
flickerstreak@56
|
216 config.name = config.name or ("ReAction_%s_%d"):format(bar:GetName(),idx)
|
flickerstreak@49
|
217 self.name = config.name
|
flickerstreak@24
|
218 config.actionID = ActionIDList[config.actionID] -- gets a free one if none configured
|
flickerstreak@24
|
219
|
flickerstreak@24
|
220 local f = CreateFrame("CheckButton", self.name, barFrame, "ActionBarButtonTemplate")
|
flickerstreak@49
|
221
|
flickerstreak@24
|
222 -- TODO: re-implement ActionButton event handlers that don't do secure stuff
|
flickerstreak@24
|
223
|
flickerstreak@24
|
224 -- this will probably cause taint, using right now for display/debugging purposes
|
flickerstreak@30
|
225 f:SetScript("OnAttributeChanged", ActionButton_UpdateAction)
|
flickerstreak@24
|
226 f:SetAttribute("action", config.actionID)
|
flickerstreak@49
|
227
|
flickerstreak@24
|
228 barFrame:SetAttribute("addchild",f)
|
flickerstreak@49
|
229
|
flickerstreak@24
|
230 self.frame = f
|
flickerstreak@24
|
231 self:Refresh(bar,idx)
|
flickerstreak@49
|
232
|
flickerstreak@49
|
233 if not module.db.profile.hideEmptyButtons then
|
flickerstreak@49
|
234 ActionButton_ShowGrid(self.frame)
|
flickerstreak@49
|
235 end
|
flickerstreak@50
|
236
|
flickerstreak@50
|
237 if ReAction.configMode then
|
flickerstreak@50
|
238 ActionButton_ShowGrid(self.frame)
|
flickerstreak@50
|
239 module:showActionIDLabel(self)
|
flickerstreak@50
|
240 end
|
flickerstreak@24
|
241 end
|
flickerstreak@24
|
242
|
flickerstreak@24
|
243 function Button:Destroy()
|
flickerstreak@24
|
244 local f = self.frame
|
flickerstreak@24
|
245 f:UnregisterAllEvents()
|
flickerstreak@24
|
246 f:Hide()
|
flickerstreak@24
|
247 f:SetParent(UIParent)
|
flickerstreak@24
|
248 f:ClearAllPoints()
|
flickerstreak@28
|
249 if self.name then
|
flickerstreak@28
|
250 _G[self.name] = nil
|
flickerstreak@24
|
251 end
|
flickerstreak@52
|
252 if self.config.actionID then
|
flickerstreak@52
|
253 ActionIDList[self.config.actionID] = nil
|
flickerstreak@52
|
254 end
|
flickerstreak@24
|
255 self.frame = nil
|
flickerstreak@24
|
256 self.config = nil
|
flickerstreak@24
|
257 self.bar = nil
|
flickerstreak@24
|
258 end
|
flickerstreak@24
|
259
|
flickerstreak@24
|
260 function Button:Refresh(bar,idx)
|
flickerstreak@24
|
261 bar:PlaceButton(self.frame, idx, 36, 36)
|
flickerstreak@24
|
262 end
|
flickerstreak@24
|
263
|
flickerstreak@24
|
264 function Button:GetFrame()
|
flickerstreak@24
|
265 return self.frame
|
flickerstreak@24
|
266 end
|
flickerstreak@24
|
267
|
flickerstreak@24
|
268 function Button:GetName()
|
flickerstreak@24
|
269 return self.name
|
flickerstreak@24
|
270 end
|
flickerstreak@24
|
271
|
flickerstreak@24
|
272 function Button:GetActionID()
|
flickerstreak@24
|
273 return self.config.actionID
|
flickerstreak@24
|
274 end
|
flickerstreak@28
|
275
|
flickerstreak@28
|
276
|
flickerstreak@28
|
277 -- export as a class-factory to module
|
flickerstreak@28
|
278 module.BtnClass = {
|
flickerstreak@28
|
279 new = function(self, ...)
|
flickerstreak@28
|
280 local x = { }
|
flickerstreak@28
|
281 for k,v in pairs(Button) do
|
flickerstreak@28
|
282 x[k] = v
|
flickerstreak@28
|
283 end
|
flickerstreak@28
|
284 Constructor(x, ...)
|
flickerstreak@28
|
285 return x
|
flickerstreak@28
|
286 end
|
flickerstreak@28
|
287 }
|