/
oUF_AuraWatch.lua
372 lines (313 loc) · 11 KB
/
oUF_AuraWatch.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
--[[------------------------------------------------------------------------------------------------------
oUF_AuraWatch by Astromech
Please leave comments, suggestions, and bug reports on this addon's WoWInterface page
To setup, create a table named AuraWatch in your unit frame. There are several options
you can specify, as explained below.
icons
Mandatory!
A table of frames to be used as icons. oUF_Aurawatch does not position
these frames, so you must do so yourself. Each icon needs a spellID entry,
which is the spell ID of the aura to watch. Table should be set up
such that values are icon frames, but the keys can be anything.
Note each icon can have several options set as well. See below.
strictMatching
Default: false
If true, AuraWatch will only show an icon if the specific aura
with the specified spell id is on the unit. If false, AuraWatch
will show the icon if any aura with the same name and icon texture
is on the unit. Strict matching can be undesireable because most
ranks of an aura have different spell ids.
missingAlpha
Default 0.75
The alpha value for icons of auras which have faded from the unit.
presentAlpha
Default 1
The alpha value for icons or auras present on the unit.
onlyShowMissing
Default false
If this is true, oUF_AW will hide icons if they are present on the unit.
onlyShowPresent
Default false
If this is true, oUF_AW will hide icons if they have expired from the unit.
hideCooldown
Default false
If this is true, oUF_AW will not create a cooldown frame
hideCount
Default false
If this is true, oUF_AW will not create a count fontstring
fromUnits
Default {['player'] = true, ['pet'] = true, ['vehicle'] = true}
A table of units from which auras can originate. Have the units be the keys
and 'true' be the values.
anyUnit
Default false
Set to true for oUF_AW to to show an aura no matter what unit it
originates from. This will override any fromUnits setting.
PostCreateIcon
Default nil
A function to call when an icon is created to modify it, such as adding
a border or repositioning the count fontstring. Leave as nil to ignore.
The arguements are: AuraWatch table, icon, auraSpellID, auraName, unitFrame
Below are options set on a per icon basis. Set these as fields in the icon frames.
The following settings can be overridden from the AuraWatch table on a per-aura basis:
onlyShowMissing
onlyShowPresent
hideCooldown
hideCount
fromUnits
anyUnit
The following settings are unique to icons:
spellID
Mandatory!
The spell id of the aura, as explained above.
icon
Default aura texture
A texture value for this icon.
overlay
Default Blizzard aura overlay
An overlay for the icon. This is not created if a custom icon texture is created.
count
Default A fontstring
An fontstring to show the stack count of an aura.
Here is an example of how to set oUF_AW up:
local createAuraWatch = function(self, unit)
local auras = {}
-- A table of spellIDs to create icons for
-- To find spellIDs, look up a spell on www.wowhead.com and look at the URL
-- http://www.wowhead.com/?spell=SPELL_ID
local spellIDs = { ... }
auras.presentAlpha = 1
auras.missingAlpha = .7
auras.PostCreateIcon = myCustomIconSkinnerFunction
-- Set any other AuraWatch settings
auras.icons = {}
for i, sid in pairs(spellIDs) do
local icon = CreateFrame('Frame', nil, auras)
icon.spellID = sid
-- set the dimensions and positions
icon:SetWidth(24)
icon:SetHeight(24)
icon:SetPoint('BOTTOM', self, 'BOTTOM', 0, 28 * i)
auras.icons[sid] = icon
-- Set any other AuraWatch icon settings
end
self.AuraWatch = auras
end
-----------------------------------------------------------------------------------------------------------]]
local _, ns = ...
local oUF = ns.oUF or _G.oUF
assert(oUF, 'oUF_AuraWatch cannot find an instance of oUF. If your oUF is embedded into a layout, it may not be embedded properly.')
local UnitBuff, UnitDebuff, UnitGUID = UnitBuff, UnitDebuff, UnitGUID
local GUIDs = {}
local PLAYER_UNITS = {
player = true,
vehicle = true,
pet = true,
}
local setupGUID
do
local cache = setmetatable({}, {__type = 'k'})
local frame = CreateFrame('Frame')
frame:SetScript('OnEvent', function(self, event)
for k, t in pairs(GUIDs) do
GUIDs[k] = nil
for a in pairs(t) do
t[a] = nil
end
cache[t] = true
end
end)
frame:RegisterEvent'PLAYER_REGEN_ENABLED'
frame:RegisterEvent'PLAYER_ENTERING_WORLD'
function setupGUID(guid)
local t = next(cache)
if (t) then
cache[t] = nil
else
t = {}
end
GUIDs[guid] = t
end
end
local function resetIcon(icon, frame, count, duration, remaining)
if (icon.onlyShowMissing) then
icon:Hide()
else
icon:Show()
if (icon.cd) then
if (duration and duration > 0) then
icon.cd:SetCooldown(remaining - duration, duration)
icon.cd:Show()
else
icon.cd:Hide()
end
end
if (icon.count) then
icon.count:SetText((count > 1 and count))
end
if (icon.overlay) then
icon.overlay:Hide()
end
icon:SetAlpha(frame.presentAlpha)
end
end
local function expireIcon(icon, frame)
if (icon.onlyShowPresent) then
icon:Hide()
else
if (icon.cd) then
icon.cd:Hide()
end
if (icon.count) then
icon.count:SetText()
end
icon:SetAlpha(frame.missingAlpha)
if (icon.overlay) then
icon.overlay:Show()
end
icon:Show()
end
end
local found = {}
local function Update(frame, event, unit)
if (frame.unit ~= unit) then
return
end
local watch = frame.AuraWatch
local index, icons = 1, watch.watched
local _, name, texture, count, duration, remaining, caster, key, icon, spellid
local filter = 'HELPFUL'
local guid = UnitGUID(unit)
if (not guid) then
return
end
if (not GUIDs[guid]) then
setupGUID(guid)
end
for key, icon in pairs(icons) do
icon:Hide()
end
while true do
name, _, texture, count, _, duration, remaining, caster, _, _, spellid = UnitAura(unit, index, filter)
if (not name) then
if (filter == 'HELPFUL') then
filter = 'HARMFUL'
index = 1
else
break
end
else
if (watch.strictMatching) then
key = spellID
else
key = name..texture
end
icon = icons[key]
if (icon and (icon.anyUnit or (caster and icon.fromUnits[caster]))) then
resetIcon(icon, watch, count, duration, remaining)
GUIDs[guid][key] = true
found[key] = true
end
index = index + 1
end
if (caster == 'player') then
if (spellid == 33763) then
if (count == 1) then
icon.icon:SetVertexColor(0.1, 1, 0.1)
elseif (count == 2) then
icon.icon:SetVertexColor(1, 1, 0)
elseif (count >= 3) then
icon.icon:SetVertexColor(1, 0, 0)
end
end
end
end
for key in pairs(GUIDs[guid]) do
if icons[key] and not found[key] then
expireIcon(icons[key], watch)
end
end
for k in pairs(found) do
found[k] = nil
end
end
local function setupIcons(self)
local watch = self.AuraWatch
local icons = watch.icons
watch.watched = {}
if (not watch.missingAlpha) then
watch.missingAlpha = 0.75
end
if (not watch.presentAlpha) then
watch.presentAlpha = 1
end
for _,icon in pairs(icons) do
local name, _, image = GetSpellInfo(icon.spellID)
if (not name) then
error('oUF_AuraWatch error: no spell with '..tostring(icon.spellID)..' spell ID exists')
end
icon.name = name
if (not icon.cd and not (watch.hideCooldown or icon.hideCooldown)) then
local cd = CreateFrame('Cooldown', nil, icon, 'CooldownFrameTemplate')
cd:SetAllPoints(icon)
icon.cd = cd
end
if (not icon.icon) then
local tex = icon:CreateTexture(nil, 'BACKGROUND')
tex:SetAllPoints(icon)
tex:SetTexture(image)
icon.icon = tex
icon.icon:SetTexCoord(0.1, 0.9, 0.1, 0.9)
if (not icon.overlay) then
local overlay = icon:CreateTexture(nil, 'OVERLAY')
overlay:SetTexture'Interface\\Buttons\\UI-Debuff-Overlays'
overlay:SetAllPoints(icon)
overlay:SetTexCoord(.296875, .5703125, 0, .515625)
overlay:SetVertexColor(1, 0, 0)
icon.overlay = overlay
end
end
if (not icon.count and not (watch.hideCount or icon.hideCount)) then
local count = icon:CreateFontString(nil, 'OVERLAY')
count:SetFontObject(NumberFontNormal)
count:SetPoint('BOTTOMRIGHT', icon, 'BOTTOMRIGHT', -1, 0)
icon.count = count
end
if (icon.onlyShowMissing == nil) then
icon.onlyShowMissing = watch.onlyShowMissing
end
if (icon.onlyShowPresent == nil) then
icon.onlyShowPresent = watch.onlyShowPresent
end
if (icon.fromUnits == nil) then
icon.fromUnits = watch.fromUnits or PLAYER_UNITS
end
if (icon.anyUnit == nil) then
icon.anyUnit = watch.anyUnit
end
if (watch.strictMatching) then
watch.watched[icon.spellID] = icon
else
watch.watched[name..image] = icon
end
if watch.PostCreateIcon then watch:PostCreateIcon(icon, icon.spellID, name, self) end
end
end
local function Enable(self)
if (self.AuraWatch) then
self:RegisterEvent('UNIT_AURA', Update)
setupIcons(self)
return true
else
return false
end
end
local function Disable(self)
if (self.AuraWatch) then
self:UnregisterEvent('UNIT_AURA', Update)
for _,icon in pairs(self.AuraWatch.icons) do
icon:Hide()
end
end
end
oUF:AddElement('AuraWatch', Update, Enable, Disable)