-
-
Notifications
You must be signed in to change notification settings - Fork 204
/
API.txt
467 lines (324 loc) · 13.8 KB
/
API.txt
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
=== ** SpellFlashCore.FlashAction
This is used to flash an action bar spell.
<<code lua>>SpellFlashCore.FlashAction(SpellName, color, size, brightness, blink, NoMacros, texture, fixedSize, fixedBrightness)<</code>>
===== ** Arguments:
; ** SpellName
: (string or number or table) Spell name or global spell id number or table of global spell id numbers.
; ** color
: (string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
; ** size
: (number or nil) Percent for the flash size or nil for default.
; ** brightness
: (number or nil) Percent for the flash brightness or nil for default.
; ** blink
: (boolean) If true will make the action button fade in and out.
; ** NoMacros
: (boolean) If true will skip checking for macros.
; ** texture
: (string or number or nil) Path to texture (like: "Interface\\Cooldown\\starburst") or FileDataID (like: 131009) or AtlasID (like: "AftLevelup-WhiteStarBurst") or nil for default. Default: "Interface\\Cooldown\\star4"
; ** fixedSize
: (boolean or nil) If true will stop pulse animation. Default: false
; ** fixedBrightness
: (boolean or nil) If true will stop flicker animation. Default: false
\\
----
\\
=== ** SpellFlashCore.FlashItem
This is used to flash an action bar item.
<<code lua>>SpellFlashCore.FlashItem(ItemName, color, size, brightness, blink, NoMacros, texture, fixedSize, fixedBrightness)<</code>>
===== ** Arguments:
; ** ItemName
: (string or number or table) Item name or item id number or table of item id numbers.
; ** color
: (string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
; ** size
: (number or nil) Percent for the flash size or nil for default.
; ** brightness
: (number or nil) Percent for the flash brightness or nil for default.
; ** blink
: (boolean) If true will make the action button fade in and out.
; ** NoMacros
: (boolean) If true will skip checking for macros.
; ** texture
: (string or number or nil) Path to texture (like: "Interface\\Cooldown\\starburst") or FileDataID (like: 131009) or AtlasID (like: "AftLevelup-WhiteStarBurst") or nil for default. Default: "Interface\\Cooldown\\star4"
; ** fixedSize
: (boolean or nil) If true will stop pulse animation. Default: false
; ** fixedBrightness
: (boolean or nil) If true will stop flicker animation. Default: false
\\
----
\\
=== ** SpellFlashCore.FlashForm
This is used to flash a stance, form, presence, aura or aspect bar spell.
<<code lua>>SpellFlashCore.FlashForm(SpellName, color, size, brightness, blink, texture, fixedSize, fixedBrightness)<</code>>
===== ** Arguments:
; ** SpellName
: (string or number or table) Localized name or global id number of the spell or table of global id numbers.
; ** color
: (string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
; ** size
: (number or nil) Percent for the flash size or nil for default.
; ** brightness
: (number or nil) Percent for the flash brightness or nil for default.
; ** blink
: (boolean) If true will make the action button fade in and out.
; ** texture
: (string or number or nil) Path to texture (like: "Interface\\Cooldown\\starburst") or FileDataID (like: 131009) or AtlasID (like: "AftLevelup-WhiteStarBurst") or nil for default. Default: "Interface\\Cooldown\\star4"
; ** fixedSize
: (boolean or nil) If true will stop pulse animation. Default: false
; ** fixedBrightness
: (boolean or nil) If true will stop flicker animation. Default: false
\\
----
\\
=== ** SpellFlashCore.FlashPet
This is used to flash a pet bar spell.
<<code lua>>SpellFlashCore.FlashPet(SpellName, color, size, brightness, blink, texture, fixedSize, fixedBrightness)<</code>>
===== ** Arguments:
; ** SpellName
: (string or number or table) Localized name or global id number of the spell or table of global id numbers.
; ** color
: (string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
; ** size
: (number or nil) Percent for the flash size or nil for default.
; ** brightness
: (number or nil) Percent for the flash brightness or nil for default.
; ** blink
: (boolean) If true will make the action button fade in and out.
; ** texture
: (string or number or nil) Path to texture (like: "Interface\\Cooldown\\starburst") or FileDataID (like: 131009) or AtlasID (like: "AftLevelup-WhiteStarBurst") or nil for default. Default: "Interface\\Cooldown\\star4"
; ** fixedSize
: (boolean or nil) If true will stop pulse animation. Default: false
; ** fixedBrightness
: (boolean or nil) If true will stop flicker animation. Default: false
\\
----
\\
=== ** SpellFlashCore.FlashVehicle
This is used to flash a vehicle bar spell.
<<code lua>>SpellFlashCore.FlashVehicle(SpellName, color, size, brightness, blink, texture, fixedSize, fixedBrightness)<</code>>
===== ** Arguments:
; ** SpellName
: (string or number or table) Localized name or global id number of the spell or table of global id numbers.
; ** color
: (string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
; ** size
: (number or nil) Percent for the flash size or nil for default.
; ** brightness
: (number or nil) Percent for the flash brightness or nil for default.
; ** blink
: (boolean) If true will make the action button fade in and out.
; ** texture
: (string or number or nil) Path to texture (like: "Interface\\Cooldown\\starburst") or FileDataID (like: 131009) or AtlasID (like: "AftLevelup-WhiteStarBurst") or nil for default. Default: "Interface\\Cooldown\\star4"
; ** fixedSize
: (boolean or nil) If true will stop pulse animation. Default: false
; ** fixedBrightness
: (boolean or nil) If true will stop flicker animation. Default: false
\\
----
\\
=== ** SpellFlashCore.FlashTotemCall
This is used to flash the multiple totem call button.
<<code lua>>SpellFlashCore.FlashTotemCall(color, size, brightness, blink, texture, fixedSize, fixedBrightness)<</code>>
===== ** Arguments:
; ** color
: (string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
; ** size
: (number or nil) Percent for the flash size or nil for default.
; ** brightness
: (number or nil) Percent for the flash brightness or nil for default.
; ** blink
: (boolean) If true will make the action button fade in and out.
; ** texture
: (string or number or nil) Path to texture (like: "Interface\\Cooldown\\starburst") or FileDataID (like: 131009) or AtlasID (like: "AftLevelup-WhiteStarBurst") or nil for default. Default: "Interface\\Cooldown\\star4"
; ** fixedSize
: (boolean or nil) If true will stop pulse animation. Default: false
; ** fixedBrightness
: (boolean or nil) If true will stop flicker animation. Default: false
\\
----
\\
=== ** SpellFlashCore.FlashTotemRecall
This is used to flash the multiple totem recall button.
<<code lua>>SpellFlashCore.FlashTotemRecall(color, size, brightness, blink, texture, fixedSize, fixedBrightness)<</code>>
===== ** Arguments:
; ** color
: (string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
; ** size
: (number or nil) Percent for the flash size or nil for default.
; ** brightness
: (number or nil) Percent for the flash brightness or nil for default.
; ** blink
: (boolean) If true will make the action button fade in and out.
; ** texture
: (string or number or nil) Path to texture (like: "Interface\\Cooldown\\starburst") or FileDataID (like: 131009) or AtlasID (like: "AftLevelup-WhiteStarBurst") or nil for default. Default: "Interface\\Cooldown\\star4"
; ** fixedSize
: (boolean or nil) If true will stop pulse animation. Default: false
; ** fixedBrightness
: (boolean or nil) If true will stop flicker animation. Default: false
\\
----
\\
=== ** SpellFlashCore.FlashFrame
This is used to flash a frame.
<<code lua>>SpellFlashCore.FlashFrame(frame, color, size, brightness, blink, texture, fixedSize, fixedBrightness)<</code>>
===== ** Arguments:
; ** frame
: (variable) The variable assigned to a frame that you want to be flashed.
; ** color
: (string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
; ** size
: (number or nil) Percent for the flash size or nil for default.
; ** brightness
: (number or nil) Percent for the flash brightness or nil for default.
; ** blink
: (boolean) If true will make the action button fade in and out.
; ** texture
: (string or number or nil) Path to texture (like: "Interface\\Cooldown\\starburst") or FileDataID (like: 131009) or AtlasID (like: "AftLevelup-WhiteStarBurst") or nil for default. Default: "Interface\\Cooldown\\star4"
; ** fixedSize
: (boolean or nil) If true will stop pulse animation. Default: false
; ** fixedBrightness
: (boolean or nil) If true will stop flicker animation. Default: false
\\
----
\\
=== ** SpellFlashCore.Flashable
Determines if a specified spell is able to be found on the action bars to be flashed.
<<code lua>>found = SpellFlashCore.Flashable(SpellName, NoMacros)<</code>>
===== ** Arguments:
; ** SpellName
: (string or number or table) Spell name or global spell id number or table of global spell id numbers.
; ** NoMacros
: (boolean) If true will skip checking for macros.
===== ** Returns:
; ** found
: (boolean) True if a specified spell is able to be found on the action bars to be flashed.
\\
----
\\
=== ** SpellFlashCore.ItemFlashable
Determines if a specified item is able to be found on the action bars to be flashed.
<<code lua>>found = SpellFlashCore.ItemFlashable(ItemName, NoMacros)<</code>>
===== ** Arguments:
; ** ItemName
: (string or number or table) Item name or item id number or table of item id numbers.
; ** NoMacros
: (boolean) If true will skip checking for macros.
===== ** Returns:
; ** found
: (boolean) True if a specified item is able to be found on the action bars to be flashed.
\\
----
\\
=== ** SpellFlashCore.SpellName
This returns the localized spell name.
<<code lua>>name = SpellFlashCore.SpellName(SpellID, NoSubName)<</code>>
===== ** Arguments:
; ** SpellID
: (number) Global spell ID number.
; ** NoSubName
: (boolean) If true will not return the spell name with the sub name attached.
===== ** Returns:
; ** name
: (string) Localized spell name.
\\
----
\\
=== ** SpellFlashCore.ItemName
This returns the localized item name.
<<code lua>>name = SpellFlashCore.ItemName(ItemID)<</code>>
===== ** Arguments:
; ** ItemID
: (number) Global item ID number.
===== ** Returns:
; ** name
: (string) Localized item name.
\\
----
\\
=== ** SpellFlashCore.Replace
This replaces text with new text in a string.
<<code lua>>REPLACED_STRING = SpellFlashCore.Replace(STRING, FIND, REPLACE, FIND, REPLACE, ...)<</code>>
===== ** Arguments:
; ** STRING
: (string) The original string.
; ** FIND
: (string or number) The search text.
; ** REPLACE
: (string or number or nil) The replacement text.
===== ** Returns:
; ** REPLACED_STRING
: (string) The replaced string.
\\
----
\\
=== ** SpellFlashCore.CopyTable
A simple function that will copy a table.
<<code lua>>CopiedTable = SpellFlashCore.CopyTable(Table)<</code>>
===== ** Arguments:
; ** Table
: (table) The original table.
===== ** Returns:
; ** CopiedTable
: (table) The copied table.
\\
----
\\
=== ** SpellFlashCore.RegisterDebugEvent
This will register an event for debugging purposes.
Debug slash command: ** /spellflashcore debug
Debug event slash command: ** /spellflashcore register EVENT_NAME
<<code lua>>SpellFlashCore.RegisterDebugEvent(event)<</code>>
===== ** Arguments:
; ** event
: (string) Event name to register.
\\
----
\\
=== ** SpellFlashCore.UnregisterDebugEvent
This will unregister an event for debugging purposes.
Debug slash command: ** /spellflashcore debug
Debug event slash command: ** /spellflashcore unregister EVENT_NAME
<<code lua>>SpellFlashCore.UnregisterDebugEvent(event)<</code>>
===== ** Arguments:
; ** event
: (string) Event name to unregister.
\\
----
\\
=== ** SpellFlashCore.RegisterAllDebugEvents
This will register all events for debugging purposes.
Debug slash command: ** /spellflashcore debug
Debug event slash command: ** /spellflashcore register all
<<code lua>>SpellFlashCore.RegisterAllDebugEvents()<</code>>
\\
----
\\
=== ** SpellFlashCore.UnregisterAllDebugEvents
This will unregister all events for debugging purposes.
Debug slash command: ** /spellflashcore debug
Debug event slash command: ** /spellflashcore unregister all
<<code lua>>SpellFlashCore.UnregisterAllDebugEvents()<</code>>
\\
----
\\
=== ** SpellFlashCore.debug
This will dump the value of msg to the default chat window if debug mode has been enabled.
Debug slash command: ** /spellflashcore debug
<<code lua>>SpellFlashCore.debug(...)<</code>>
===== ** Arguments:
; ** ...
: (string or number or nil) String, number or array of strings and numbers that will be sent to the default chat window.
\\
----
\\
=== ** SpellFlashCore.RegisterBigLibTimer
Use this to embed BigLibTimer into your addon. Use either the argument or the return value but not both, because that would be the same as just using the argument.\\
BigLibTimer API: ** http://wow.curseforge.com/addons/biglibtimer/pages/api/
<<code lua>>handler = SpellFlashCore.RegisterBigLibTimer(handler)<</code>>
===== ** Arguments:
; ** handler
: (frame or table or nil) Table or frame to have the BigLibTimer functions saved to.
===== ** Returns:
; ** handler
: (table) Table with the BigLibTimer functions saved to it.