View difference between Paste ID: XQ3T0djE and 5tDZENLW
SHOW: | | - or go back to the newest paste.
1
<?xml version="1.0"?>
2-
<ArrayOfSection xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
2+
<Sections xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
3
  <Section Name="Basic globals:">
4
    <Functions>
5
      <Function Name="UI.Context">
6
        <Documentation>Creates a new UI context. A UI context must be created in order to create any frames.
7
context = UI.CreateContext(name)   -- Context &lt;- string
8
</Documentation>
9
        <Parameters>
10
          <Parameter Name="name">
11
            <Documentation>A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.</Documentation>
12
          </Parameter>
13
        </Parameters>
14
        <ReturnValues>
15
          <ReturnValue Name="context">
16
            <Documentation>A new context. Contexts are guaranteed to have at least the capabilities of a Frame.</Documentation>
17
          </ReturnValue>
18
        </ReturnValues>
19
        <ReturnedMembers />
20
      </Function>
21
      <Function Name="UI.CreateFrame">
22
        <Documentation>Creates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames must have a parent, you'll need to create a Context before any frames. See UI.CreateContext.
23
List of valid frame types:
24
Frame: The base type. No special capabilities. Useful for spacing, organization, input handling, and solid color squares.
25
Mask: Obscures the contents of child frames that do not fall within the mask boundaries.
26
Text: Displays text.
27
Texture: Displays a static texture image.
28
RiftButton: A standard Rift button widget.
29
RiftCheckbox: A standard Rift checkbox widget.
30
RiftScrollbar: A standard Rift scrollbar widget.
31
RiftSlider: A standard Rift slider widget.
32
RiftTextfield: A standard Rift textfield widget.
33
RiftWindow: A standard Rift window widget.
34
frame = UI.CreateFrame(type, name, parent)   -- Frame &lt;- string, string, Element
35
</Documentation>
36
        <Parameters>
37
          <Parameter Name="name">
38
            <Documentation>A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.</Documentation>
39
          </Parameter>
40
          <Parameter Name="parent">
41
            <Documentation>The new parent for this frame.</Documentation>
42
          </Parameter>
43
          <Parameter Name="type">
44
            <Documentation>The type of your new frame. Current supported types</Documentation>
45
          </Parameter>
46
        </Parameters>
47
        <ReturnValues>
48
          <ReturnValue Name="frame">
49
            <Documentation>Your new frame.</Documentation>
50
          </ReturnValue>
51
        </ReturnValues>
52
        <ReturnedMembers />
53
      </Function>
54
      <Function Name="UI.Frame">
55
        <Documentation>Lists all frames that have been created. Organizes them under [addonIdentifier][contextIdentifier][constructionOrder]. As an example, if TestAddon created four frames named UIElement, the second would be UI.Frame.TestAddon.UIElement[2].
56
UI.Frame
57
</Documentation>
58
        <Parameters />
59
        <ReturnValues />
60
        <ReturnedMembers />
61
      </Function>
62
      <Function Name="UIParent.Event.Size">
63
        <Parameters />
64
        <ReturnValues />
65
        <ReturnedMembers />
66
      </Function>
67
      <Function Name="_VERSION">
68
        <Parameters />
69
        <ReturnValues />
70
        <ReturnedMembers />
71
      </Function>
72
      <Function Name="assert">
73
        <Parameters />
74
        <ReturnValues />
75
        <ReturnedMembers />
76
      </Function>
77
      <Function Name="bit.arshift">
78
        <Parameters />
79
        <ReturnValues />
80
        <ReturnedMembers />
81
      </Function>
82
      <Function Name="bit.band">
83
        <Parameters />
84
        <ReturnValues />
85
        <ReturnedMembers />
86
      </Function>
87
      <Function Name="bit.bnot">
88
        <Parameters />
89
        <ReturnValues />
90
        <ReturnedMembers />
91
      </Function>
92
      <Function Name="bit.bor">
93
        <Parameters />
94
        <ReturnValues />
95
        <ReturnedMembers />
96
      </Function>
97
      <Function Name="bit.bswap">
98
        <Parameters />
99
        <ReturnValues />
100
        <ReturnedMembers />
101
      </Function>
102
      <Function Name="bit.bxor">
103
        <Parameters />
104
        <ReturnValues />
105
        <ReturnedMembers />
106
      </Function>
107
      <Function Name="bit.lshift">
108
        <Parameters />
109
        <ReturnValues />
110
        <ReturnedMembers />
111
      </Function>
112
      <Function Name="bit.rol">
113
        <Parameters />
114
        <ReturnValues />
115
        <ReturnedMembers />
116
      </Function>
117
      <Function Name="bit.ror">
118
        <Parameters />
119
        <ReturnValues />
120
        <ReturnedMembers />
121
      </Function>
122
      <Function Name="bit.rshift">
123
        <Parameters />
124
        <ReturnValues />
125
        <ReturnedMembers />
126
      </Function>
127
      <Function Name="bit.tobit">
128
        <Parameters />
129
        <ReturnValues />
130
        <ReturnedMembers />
131
      </Function>
132
      <Function Name="bit.tohex">
133
        <Parameters />
134
        <ReturnValues />
135
        <ReturnedMembers />
136
      </Function>
137
      <Function Name="collectgarbage">
138
        <Parameters />
139
        <ReturnValues />
140
        <ReturnedMembers />
141
      </Function>
142
      <Function Name="coroutine.create">
143
        <Parameters />
144
        <ReturnValues />
145
        <ReturnedMembers />
146
      </Function>
147
      <Function Name="coroutine.resume">
148
        <Parameters />
149
        <ReturnValues />
150
        <ReturnedMembers />
151
      </Function>
152
      <Function Name="coroutine.running">
153
        <Parameters />
154
        <ReturnValues />
155
        <ReturnedMembers />
156
      </Function>
157
      <Function Name="coroutine.status">
158
        <Parameters />
159
        <ReturnValues />
160
        <ReturnedMembers />
161
      </Function>
162
      <Function Name="coroutine.wrap">
163
        <Parameters />
164
        <ReturnValues />
165
        <ReturnedMembers />
166
      </Function>
167
      <Function Name="coroutine.yield">
168
        <Parameters />
169
        <ReturnValues />
170
        <ReturnedMembers />
171
      </Function>
172
      <Function Name="debug.traceback">
173
        <Parameters />
174
        <ReturnValues />
175
        <ReturnedMembers />
176
      </Function>
177
      <Function Name="dump">
178
        <Documentation>Debug utility function. Similar to print(), but serializes any table parameters before outputting.
179
dump(...)   -- ...
180
</Documentation>
181
        <Parameters>
182
          <Parameter Name="...">
183
            <Documentation>Takes any number of any parameter type.</Documentation>
184
          </Parameter>
185
        </Parameters>
186
        <ReturnValues />
187
        <ReturnedMembers />
188
      </Function>
189
      <Function Name="error">
190
        <Parameters />
191
        <ReturnValues />
192
        <ReturnedMembers />
193
      </Function>
194
      <Function Name="gcinfo">
195
        <Parameters />
196
        <ReturnValues />
197
        <ReturnedMembers />
198
      </Function>
199
      <Function Name="getfenv">
200
        <Parameters />
201
        <ReturnValues />
202
        <ReturnedMembers />
203
      </Function>
204
      <Function Name="getmetatable">
205
        <Parameters />
206
        <ReturnValues />
207
        <ReturnedMembers />
208
      </Function>
209
      <Function Name="ipairs">
210
        <Parameters />
211
        <ReturnValues />
212
        <ReturnedMembers />
213
      </Function>
214
      <Function Name="load">
215
        <Parameters />
216
        <ReturnValues />
217
        <ReturnedMembers />
218
      </Function>
219
      <Function Name="loadstring">
220
        <Parameters />
221
        <ReturnValues />
222
        <ReturnedMembers />
223
      </Function>
224
      <Function Name="math.abs">
225
        <Parameters />
226
        <ReturnValues />
227
        <ReturnedMembers />
228
      </Function>
229
      <Function Name="math.acos">
230
        <Parameters />
231
        <ReturnValues />
232
        <ReturnedMembers />
233
      </Function>
234
      <Function Name="math.asin">
235
        <Parameters />
236
        <ReturnValues />
237
        <ReturnedMembers />
238
      </Function>
239
      <Function Name="math.atan">
240
        <Parameters />
241
        <ReturnValues />
242
        <ReturnedMembers />
243
      </Function>
244
      <Function Name="math.atan2">
245
        <Parameters />
246
        <ReturnValues />
247
        <ReturnedMembers />
248
      </Function>
249
      <Function Name="math.ceil">
250
        <Parameters />
251
        <ReturnValues />
252
        <ReturnedMembers />
253
      </Function>
254
      <Function Name="math.cos">
255
        <Parameters />
256
        <ReturnValues />
257
        <ReturnedMembers />
258
      </Function>
259
      <Function Name="math.cosh">
260
        <Parameters />
261
        <ReturnValues />
262
        <ReturnedMembers />
263
      </Function>
264
      <Function Name="math.deg">
265
        <Parameters />
266
        <ReturnValues />
267
        <ReturnedMembers />
268
      </Function>
269
      <Function Name="math.exp">
270
        <Parameters />
271
        <ReturnValues />
272
        <ReturnedMembers />
273
      </Function>
274
      <Function Name="math.floor">
275
        <Parameters />
276
        <ReturnValues />
277
        <ReturnedMembers />
278
      </Function>
279
      <Function Name="math.fmod">
280
        <Parameters />
281
        <ReturnValues />
282
        <ReturnedMembers />
283
      </Function>
284
      <Function Name="math.frexp">
285
        <Parameters />
286
        <ReturnValues />
287
        <ReturnedMembers />
288
      </Function>
289
      <Function Name="math.huge">
290
        <Parameters />
291
        <ReturnValues />
292
        <ReturnedMembers />
293
      </Function>
294
      <Function Name="math.ldexp">
295
        <Parameters />
296
        <ReturnValues />
297
        <ReturnedMembers />
298
      </Function>
299
      <Function Name="math.log">
300
        <Parameters />
301
        <ReturnValues />
302
        <ReturnedMembers />
303
      </Function>
304
      <Function Name="math.log10">
305
        <Parameters />
306
        <ReturnValues />
307
        <ReturnedMembers />
308
      </Function>
309
      <Function Name="math.max">
310
        <Parameters />
311
        <ReturnValues />
312
        <ReturnedMembers />
313
      </Function>
314
      <Function Name="math.min">
315
        <Parameters />
316
        <ReturnValues />
317
        <ReturnedMembers />
318
      </Function>
319
      <Function Name="math.mod">
320
        <Parameters />
321
        <ReturnValues />
322
        <ReturnedMembers />
323
      </Function>
324
      <Function Name="math.modf">
325
        <Parameters />
326
        <ReturnValues />
327
        <ReturnedMembers />
328
      </Function>
329
      <Function Name="math.pi">
330
        <Parameters />
331
        <ReturnValues />
332
        <ReturnedMembers />
333
      </Function>
334
      <Function Name="math.pow">
335
        <Parameters />
336
        <ReturnValues />
337
        <ReturnedMembers />
338
      </Function>
339
      <Function Name="math.rad">
340
        <Parameters />
341
        <ReturnValues />
342
        <ReturnedMembers />
343
      </Function>
344
      <Function Name="math.random">
345
        <Parameters />
346
        <ReturnValues />
347
        <ReturnedMembers />
348
      </Function>
349
      <Function Name="math.randomseed">
350
        <Parameters />
351
        <ReturnValues />
352
        <ReturnedMembers />
353
      </Function>
354
      <Function Name="math.sin">
355
        <Parameters />
356
        <ReturnValues />
357
        <ReturnedMembers />
358
      </Function>
359
      <Function Name="math.sinh">
360
        <Parameters />
361
        <ReturnValues />
362
        <ReturnedMembers />
363
      </Function>
364
      <Function Name="math.sqrt">
365
        <Parameters />
366
        <ReturnValues />
367
        <ReturnedMembers />
368
      </Function>
369
      <Function Name="math.tan">
370
        <Parameters />
371
        <ReturnValues />
372
        <ReturnedMembers />
373
      </Function>
374
      <Function Name="math.tanh">
375
        <Parameters />
376
        <ReturnValues />
377
        <ReturnedMembers />
378
      </Function>
379
      <Function Name="math.tau">
380
        <Parameters />
381
        <ReturnValues />
382
        <ReturnedMembers />
383
      </Function>
384
      <Function Name="newproxy">
385
        <Parameters />
386
        <ReturnValues />
387
        <ReturnedMembers />
388
      </Function>
389
      <Function Name="next">
390
        <Parameters />
391
        <ReturnValues />
392
        <ReturnedMembers />
393
      </Function>
394
      <Function Name="os.date">
395
        <Parameters />
396
        <ReturnValues />
397
        <ReturnedMembers />
398
      </Function>
399
      <Function Name="os.difftime">
400
        <Parameters />
401
        <ReturnValues />
402
        <ReturnedMembers />
403
      </Function>
404
      <Function Name="os.time">
405
        <Parameters />
406
        <ReturnValues />
407
        <ReturnedMembers />
408
      </Function>
409
      <Function Name="pairs">
410
        <Parameters />
411
        <ReturnValues />
412
        <ReturnedMembers />
413
      </Function>
414
      <Function Name="pcall">
415
        <Parameters />
416
        <ReturnValues />
417
        <ReturnedMembers />
418
      </Function>
419
      <Function Name="print">
420
        <Parameters />
421
        <ReturnValues />
422
        <ReturnedMembers />
423
      </Function>
424
      <Function Name="print_raw">
425
        <Parameters />
426
        <ReturnValues />
427
        <ReturnedMembers />
428
      </Function>
429
      <Function Name="rawequal">
430
        <Parameters />
431
        <ReturnValues />
432
        <ReturnedMembers />
433
      </Function>
434
      <Function Name="rawget">
435
        <Parameters />
436
        <ReturnValues />
437
        <ReturnedMembers />
438
      </Function>
439
      <Function Name="rawset">
440
        <Parameters />
441
        <ReturnValues />
442
        <ReturnedMembers />
443
      </Function>
444
      <Function Name="select">
445
        <Parameters />
446
        <ReturnValues />
447
        <ReturnedMembers />
448
      </Function>
449
      <Function Name="setfenv">
450
        <Parameters />
451
        <ReturnValues />
452
        <ReturnedMembers />
453
      </Function>
454
      <Function Name="setmetatable">
455
        <Parameters />
456
        <ReturnValues />
457
        <ReturnedMembers />
458
      </Function>
459
      <Function Name="string.byte">
460
        <Parameters />
461
        <ReturnValues />
462
        <ReturnedMembers />
463
      </Function>
464
      <Function Name="string.char">
465
        <Parameters />
466
        <ReturnValues />
467
        <ReturnedMembers />
468
      </Function>
469
      <Function Name="string.find">
470
        <Parameters />
471
        <ReturnValues />
472
        <ReturnedMembers />
473
      </Function>
474
      <Function Name="string.format">
475
        <Parameters />
476
        <ReturnValues />
477
        <ReturnedMembers />
478
      </Function>
479
      <Function Name="string.gfind">
480
        <Parameters />
481
        <ReturnValues />
482
        <ReturnedMembers />
483
      </Function>
484
      <Function Name="string.gmatch">
485
        <Parameters />
486
        <ReturnValues />
487
        <ReturnedMembers />
488
      </Function>
489
      <Function Name="string.gsub">
490
        <Parameters />
491
        <ReturnValues />
492
        <ReturnedMembers />
493
      </Function>
494
      <Function Name="string.len">
495
        <Parameters />
496
        <ReturnValues />
497
        <ReturnedMembers />
498
      </Function>
499
      <Function Name="string.lower">
500
        <Parameters />
501
        <ReturnValues />
502
        <ReturnedMembers />
503
      </Function>
504
      <Function Name="string.match">
505
        <Parameters />
506
        <ReturnValues />
507
        <ReturnedMembers />
508
      </Function>
509
      <Function Name="string.rep">
510
        <Parameters />
511
        <ReturnValues />
512
        <ReturnedMembers />
513
      </Function>
514
      <Function Name="string.reverse">
515
        <Parameters />
516
        <ReturnValues />
517
        <ReturnedMembers />
518
      </Function>
519
      <Function Name="string.sub">
520
        <Parameters />
521
        <ReturnValues />
522
        <ReturnedMembers />
523
      </Function>
524
      <Function Name="string.upper">
525
        <Parameters />
526
        <ReturnValues />
527
        <ReturnedMembers />
528
      </Function>
529
      <Function Name="table.concat">
530
        <Parameters />
531
        <ReturnValues />
532
        <ReturnedMembers />
533
      </Function>
534
      <Function Name="table.foreach">
535
        <Parameters />
536
        <ReturnValues />
537
        <ReturnedMembers />
538
      </Function>
539
      <Function Name="table.foreachi">
540
        <Parameters />
541
        <ReturnValues />
542
        <ReturnedMembers />
543
      </Function>
544
      <Function Name="table.getn">
545
        <Parameters />
546
        <ReturnValues />
547
        <ReturnedMembers />
548
      </Function>
549
      <Function Name="table.insert">
550
        <Parameters />
551
        <ReturnValues />
552
        <ReturnedMembers />
553
      </Function>
554
      <Function Name="table.maxn">
555
        <Parameters />
556
        <ReturnValues />
557
        <ReturnedMembers />
558
      </Function>
559
      <Function Name="table.remove">
560
        <Parameters />
561
        <ReturnValues />
562
        <ReturnedMembers />
563
      </Function>
564
      <Function Name="table.sort">
565
        <Parameters />
566
        <ReturnValues />
567
        <ReturnedMembers />
568
      </Function>
569
      <Function Name="table.unpack">
570
        <Parameters />
571
        <ReturnValues />
572
        <ReturnedMembers />
573
      </Function>
574
      <Function Name="tonumber">
575
        <Parameters />
576
        <ReturnValues />
577
        <ReturnedMembers />
578
      </Function>
579
      <Function Name="tostring">
580
        <Parameters />
581
        <ReturnValues />
582
        <ReturnedMembers />
583
      </Function>
584
      <Function Name="type">
585
        <Parameters />
586
        <ReturnValues />
587
        <ReturnedMembers />
588
      </Function>
589
      <Function Name="unpack">
590
        <Parameters />
591
        <ReturnValues />
592
        <ReturnedMembers />
593
      </Function>
594
      <Function Name="xpcall">
595
        <Parameters />
596
        <ReturnValues />
597
        <ReturnedMembers />
598
      </Function>
599
      <Function Name="zlib.BEST_COMPRESSION">
600
        <Parameters />
601
        <ReturnValues />
602
        <ReturnedMembers />
603
      </Function>
604
      <Function Name="zlib.BEST_SPEED">
605
        <Parameters />
606
        <ReturnValues />
607
        <ReturnedMembers />
608
      </Function>
609
      <Function Name="zlib._COPYRIGHT">
610
        <Parameters />
611
        <ReturnValues />
612
        <ReturnedMembers />
613
      </Function>
614
      <Function Name="zlib._DESCRIPTION">
615
        <Parameters />
616
        <ReturnValues />
617
        <ReturnedMembers />
618
      </Function>
619
      <Function Name="zlib._VERSION">
620
        <Parameters />
621
        <ReturnValues />
622
        <ReturnedMembers />
623
      </Function>
624
      <Function Name="zlib.deflate">
625
        <Parameters />
626
        <ReturnValues />
627
        <ReturnedMembers />
628
      </Function>
629
      <Function Name="zlib.inflate">
630
        <Parameters />
631
        <ReturnValues />
632
        <ReturnedMembers />
633
      </Function>
634
    </Functions>
635
  </Section>
636
  <Section Name="Inspectors:">
637
    <Functions>
638
      <Function Name="Inspect.Ability.Detail">
639
        <Documentation>Provides detailed information about abilities.
640
detail = Inspect.Ability.Detail(ability)   -- table &lt;- ability
641
details = Inspect.Ability.Detail(abilities)   -- table &lt;- table
642
</Documentation>
643
        <Parameters>
644
          <Parameter Name="abilities">
645
            <Documentation>A lookup table of identifiers of abilities to retrieve detail for.</Documentation>
646
          </Parameter>
647
          <Parameter Name="ability">
648
            <Documentation>The identifier of the ability to retrieve detail for.</Documentation>
649
          </Parameter>
650
        </Parameters>
651
        <ReturnValues>
652
          <ReturnValue Name="detail">
653
            <Documentation>Detail table for a single ability.</Documentation>
654
          </ReturnValue>
655
          <ReturnValue Name="details">
656
            <Documentation>Detail tables for all requested abilities. The key is the ability ID, the value is the ability's detail table.</Documentation>
657
          </ReturnValue>
658
        </ReturnValues>
659
        <ReturnedMembers>
660
          <ReturnedMember Name="autoattack">
661
            <Documentation>Autoattack mode of the ability.</Documentation>
662
          </ReturnedMember>
663
          <ReturnedMember Name="castingTime">
664
            <Documentation>Casting time of the ability, in seconds.</Documentation>
665
          </ReturnedMember>
666
          <ReturnedMember Name="channeled">
667
            <Documentation>Signals that the ability is channeled.</Documentation>
668
          </ReturnedMember>
669
          <ReturnedMember Name="continuous">
670
            <Documentation>Signals that the ability is continuous.</Documentation>
671
          </ReturnedMember>
672
          <ReturnedMember Name="cooldown">
673
            <Documentation>Cooldown of the ability, in seconds.</Documentation>
674
          </ReturnedMember>
675
          <ReturnedMember Name="costCharge">
676
            <Documentation>The amount of charge this ability consumes on use.</Documentation>
677
          </ReturnedMember>
678
          <ReturnedMember Name="costEnergy">
679
            <Documentation>The amount of energy this ability consumes on use.</Documentation>
680
          </ReturnedMember>
681
          <ReturnedMember Name="costMana">
682
            <Documentation>The amount of mana this ability consumes on use.</Documentation>
683
          </ReturnedMember>
684
          <ReturnedMember Name="costPlanarCharge">
685
            <Documentation>The amount of planar charges this ability consumes on use.</Documentation>
686
          </ReturnedMember>
687
          <ReturnedMember Name="costPower">
688
            <Documentation>The amount of power this ability consumes on use.</Documentation>
689
          </ReturnedMember>
690
          <ReturnedMember Name="currentCooldownBegin">
691
            <Documentation>The time the current cooldown started, in the context of Inspect.Time.Frame.</Documentation>
692
          </ReturnedMember>
693
          <ReturnedMember Name="currentCooldownDuration">
694
            <Documentation>Duration of the current cooldown the ability is influenced by, in seconds.</Documentation>
695
          </ReturnedMember>
696
          <ReturnedMember Name="currentCooldownExpired">
697
            <Documentation>Number of seconds the current cooldown is past its expiration time. Generally indicates lag.</Documentation>
698
          </ReturnedMember>
699
          <ReturnedMember Name="currentCooldownPaused">
700
            <Documentation>Indicates that this ability's cooldown is paused.</Documentation>
701
          </ReturnedMember>
702
          <ReturnedMember Name="currentCooldownRemaining">
703
            <Documentation>Time remaining in the ability's current cooldown, in seconds.</Documentation>
704
          </ReturnedMember>
705
          <ReturnedMember Name="description">
706
            <Documentation>Description for the ability.</Documentation>
707
          </ReturnedMember>
708
          <ReturnedMember Name="gainCharge">
709
            <Documentation>Amount of charge gained by using the ability.</Documentation>
710
          </ReturnedMember>
711
          <ReturnedMember Name="icon">
712
            <Documentation>Resource filename of the ability's icon.</Documentation>
713
          </ReturnedMember>
714
          <ReturnedMember Name="id">
715
            <Documentation>The ID of the requested element.</Documentation>
716
          </ReturnedMember>
717
          <ReturnedMember Name="name">
718
            <Documentation>Name of the ability.</Documentation>
719
          </ReturnedMember>
720
          <ReturnedMember Name="outOfRange">
721
            <Documentation>Signals that the ability is out of range.</Documentation>
722
          </ReturnedMember>
723
          <ReturnedMember Name="passive">
724
            <Documentation>Signals that the ability is passive.</Documentation>
725
          </ReturnedMember>
726
          <ReturnedMember Name="positioned">
727
            <Documentation>Signals that the ability's effect is manually positioned by the user.</Documentation>
728
          </ReturnedMember>
729
          <ReturnedMember Name="racial">
730
            <Documentation>Signals that the ability is a racial ability.</Documentation>
731
          </ReturnedMember>
732
          <ReturnedMember Name="rangeMax">
733
            <Documentation>The maximum range of the ability.</Documentation>
734
          </ReturnedMember>
735
          <ReturnedMember Name="rangeMin">
736
            <Documentation>The minimum range of the ability.</Documentation>
737
          </ReturnedMember>
738
          <ReturnedMember Name="stealthRequired">
739
            <Documentation>Signals that the ability requires the user to be in stealth.</Documentation>
740
          </ReturnedMember>
741
          <ReturnedMember Name="target">
742
            <Documentation>The Unit ID of the unit that this ability will be used on if triggered at this moment.</Documentation>
743
          </ReturnedMember>
744
          <ReturnedMember Name="unusable">
745
            <Documentation>Signals that this ability is unusable.</Documentation>
746
          </ReturnedMember>
747
          <ReturnedMember Name="weapon">
748
            <Documentation>The required equipped weapon for this ability. May be "any", "melee", or "ranged".</Documentation>
749
          </ReturnedMember>
750
        </ReturnedMembers>
751
      </Function>
752
      <Function Name="Inspect.Ability.List">
753
        <Documentation>List available abilities.
754
abilities = Inspect.Ability.List()   -- table &lt;- void
755
</Documentation>
756
        <Parameters />
757
        <ReturnValues>
758
          <ReturnValue Name="abilities">
759
            <Documentation>A lookup table of IDs of the available abilities.</Documentation>
760
          </ReturnValue>
761
        </ReturnValues>
762
        <ReturnedMembers />
763
      </Function>
764
      <Function Name="Inspect.Achievement.Category.Detail">
765
        <Documentation>Returns information about achievement categories.
766
detail = Inspect.Achievement.Category.Detail(category)   -- table &lt;- achievementcategory
767
details = Inspect.Achievement.Category.Detail(categories)   -- table &lt;- table
768
</Documentation>
769
        <Parameters>
770
          <Parameter Name="categories">
771
            <Documentation>A lookup table of identifiers of achievement categories to retrieve detail for.</Documentation>
772
          </Parameter>
773
          <Parameter Name="category">
774
            <Documentation>The identifier of the achievement category to retrieve detail for.</Documentation>
775
          </Parameter>
776
        </Parameters>
777
        <ReturnValues>
778
          <ReturnValue Name="detail">
779
            <Documentation>Detail table for a single achievement category.</Documentation>
780
          </ReturnValue>
781
          <ReturnValue Name="details">
782
            <Documentation>Detail tables for all requested achievement categories. The key is the category ID, the value is the category's detail table.</Documentation>
783
          </ReturnValue>
784
        </ReturnValues>
785
        <ReturnedMembers>
786
          <ReturnedMember Name="id">
787
            <Documentation>The ID of the requested element.</Documentation>
788
          </ReturnedMember>
789
          <ReturnedMember Name="name">
790
            <Documentation>The name of the achievement category.</Documentation>
791
          </ReturnedMember>
792
          <ReturnedMember Name="parent">
793
            <Documentation>The category's parent, if it has one.</Documentation>
794
          </ReturnedMember>
795
        </ReturnedMembers>
796
      </Function>
797
      <Function Name="Inspect.Achievement.Category.List">
798
        <Documentation>Returns a lookup table of valid achievement categories.
799
categories = Inspect.Achievement.Category.List()   -- table &lt;- void
800
</Documentation>
801
        <Parameters />
802
        <ReturnValues>
803
          <ReturnValue Name="categories">
804
            <Documentation>Valid achievement categories, in {id = true} format.</Documentation>
805
          </ReturnValue>
806
        </ReturnValues>
807
        <ReturnedMembers />
808
      </Function>
809
      <Function Name="Inspect.Achievement.Detail">
810
        <Documentation>Provides detailed information about achievements.
811
detail = Inspect.Achievement.Detail(achievement)   -- table &lt;- achievement
812
details = Inspect.Achievement.Detail(achievements)   -- table &lt;- table
813
</Documentation>
814
        <Parameters>
815
          <Parameter Name="achievement">
816
            <Documentation>The identifier of the achievement to retrieve detail for.</Documentation>
817
          </Parameter>
818
          <Parameter Name="achievements">
819
            <Documentation>A lookup table of identifiers of achievements to retrieve detail for.</Documentation>
820
          </Parameter>
821
        </Parameters>
822
        <ReturnValues>
823
          <ReturnValue Name="detail">
824
            <Documentation>Detail table for a single achievement.</Documentation>
825
          </ReturnValue>
826
          <ReturnValue Name="details">
827
            <Documentation>Detail tables for all requested achievements. The key is the achievement ID, the value is the achievement's detail table.</Documentation>
828
          </ReturnValue>
829
        </ReturnValues>
830
        <ReturnedMembers>
831
          <ReturnedMember Name="alliance">
832
            <Documentation>The alliance that this achievement requires, either "guardian", "defiant", or nil.</Documentation>
833
          </ReturnedMember>
834
          <ReturnedMember Name="category">
835
            <Documentation>ID of the achievement's category.</Documentation>
836
          </ReturnedMember>
837
          <ReturnedMember Name="complete">
838
            <Documentation>true is the achievement is completed by this character. If the achievement has been completed by another of the player's characters, gives that character's name.</Documentation>
839
          </ReturnedMember>
840
          <ReturnedMember Name="description">
841
            <Documentation>The achievement's description.</Documentation>
842
          </ReturnedMember>
843
          <ReturnedMember Name="icon">
844
            <Documentation>Internal name of the achievement's icon.</Documentation>
845
          </ReturnedMember>
846
          <ReturnedMember Name="id">
847
            <Documentation>The ID of the requested element.</Documentation>
848
          </ReturnedMember>
849
          <ReturnedMember Name="name">
850
            <Documentation>The achievement's name.</Documentation>
851
          </ReturnedMember>
852
          <ReturnedMember Name="previous">
853
            <Documentation>The ID of the achievement immediately previous to this in a chain.</Documentation>
854
          </ReturnedMember>
855
          <ReturnedMember Name="requirement">
856
            <Documentation>Table listing the requirements for this achievement. Each item may include multiple members.</Documentation>
857
          </ReturnedMember>
858
          <ReturnedMember Name="type">
859
            <Documentation> The type of the requirement. Valid values include "achievement", "artifactset", "discover", "event", "quest", and "tradeskill".</Documentation>
860
          </ReturnedMember>
861
          <ReturnedMember Name="name">
862
            <Documentation> The name of the requirement.</Documentation>
863
          </ReturnedMember>
864
          <ReturnedMember Name="count">
865
            <Documentation> The count required for completion.</Documentation>
866
          </ReturnedMember>
867
          <ReturnedMember Name="countDone">
868
            <Documentation> The count already completed.</Documentation>
869
          </ReturnedMember>
870
          <ReturnedMember Name="complete">
871
            <Documentation> Signals that this requirement is complete.</Documentation>
872
          </ReturnedMember>
873
          <ReturnedMember Name="id">
874
            <Documentation> The id of whatever this requires.</Documentation>
875
          </ReturnedMember>
876
          <ReturnedMember Name="score">
877
            <Documentation>The number of points this achievement awards for completion.</Documentation>
878
          </ReturnedMember>
879
          <ReturnedMember Name="sort">
880
            <Documentation>A number indicating the order that this achievement should be sorted in.</Documentation>
881
          </ReturnedMember>
882
          <ReturnedMember Name="title">
883
            <Documentation>The ID of the title this achievement awards.</Documentation>
884
          </ReturnedMember>
885
        </ReturnedMembers>
886
      </Function>
887
      <Function Name="Inspect.Achievement.List">
888
        <Documentation>Returns a lookup table of all known achievements.
889
achievements = Inspect.Achievement.List()   -- table &lt;- void
890
</Documentation>
891
        <Parameters />
892
        <ReturnValues>
893
          <ReturnValue Name="achievements">
894
            <Documentation>All known achievements, in {id = true} format.</Documentation>
895
          </ReturnValue>
896
        </ReturnValues>
897
        <ReturnedMembers />
898
      </Function>
899
      <Function Name="Inspect.Addon.Cpu">
900
        <Documentation>Returns recent CPU usage information. This is calculated using an exponential-falloff method.
901
data = Inspect.Addon.Cpu()   -- table &lt;- void
902
</Documentation>
903
        <Parameters />
904
        <ReturnValues>
905
          <ReturnValue Name="data">
906
            <Documentation>Recent CPU usage. This takes the format { AddonIdentifier = { SubIdentifier = cpu_used_as_a_fraction_of_one } }. SubIdentifiers are generated by Rift and the format may change without notice.</Documentation>
907
          </ReturnValue>
908
        </ReturnValues>
909
        <ReturnedMembers />
910
      </Function>
911
      <Function Name="Inspect.Addon.Current">
912
        <Documentation>Returns the current addon. This information is used internally for counting CPU usage and determining frame ownership.
913
addonIdentifier = Inspect.Addon.Current()   -- string &lt;- void
914
</Documentation>
915
        <Parameters />
916
        <ReturnValues>
917
          <ReturnValue Name="addonIdentifier">
918
            <Documentation>The addon's identifier, as written in its TOC file.</Documentation>
919
          </ReturnValue>
920
        </ReturnValues>
921
        <ReturnedMembers />
922
      </Function>
923
      <Function Name="Inspect.Addon.Detail">
924
        <Documentation>Provides detailed information about loaded addons.
925
detail = Inspect.Addon.Detail(addon)   -- table &lt;- string
926
details = Inspect.Addon.Detail(addons)   -- table &lt;- table
927
</Documentation>
928
        <Parameters>
929
          <Parameter Name="addon">
930
            <Documentation>An addon identifier.</Documentation>
931
          </Parameter>
932
          <Parameter Name="addons">
933
            <Documentation>A lookup table containing addon identifiers.</Documentation>
934
          </Parameter>
935
        </Parameters>
936
        <ReturnValues>
937
          <ReturnValue Name="detail">
938
            <Documentation>Detail table for a single addon.</Documentation>
939
          </ReturnValue>
940
          <ReturnValue Name="details">
941
            <Documentation>Detail tables for all requested addons. The key is the addon identifier, the value is the addon's detail table.</Documentation>
942
          </ReturnValue>
943
        </ReturnValues>
944
        <ReturnedMembers>
945
          <ReturnedMember Name="data">
946
            <Documentation>The "data" table provided to the addon at load time.</Documentation>
947
          </ReturnedMember>
948
          <ReturnedMember Name="id">
949
            <Documentation>The ID of the requested element.</Documentation>
950
          </ReturnedMember>
951
          <ReturnedMember Name="identifier">
952
            <Documentation>The addon's identifier.</Documentation>
953
          </ReturnedMember>
954
          <ReturnedMember Name="toc">
955
            <Documentation>The addon's RiftAddon.toc file, parsed and in table form.</Documentation>
956
          </ReturnedMember>
957
        </ReturnedMembers>
958
      </Function>
959
      <Function Name="Inspect.Addon.List">
960
        <Documentation>Lists all the addons that the client has loaded.
961
addons = Inspect.Addon.List()   -- table &lt;- void
962
</Documentation>
963
        <Parameters />
964
        <ReturnValues>
965
          <ReturnValue Name="addons">
966
            <Documentation>Map of addon identifier to addon version, or "true" if no version is provided.</Documentation>
967
          </ReturnValue>
968
        </ReturnValues>
969
        <ReturnedMembers />
970
      </Function>
971
      <Function Name="Inspect.Auction.Detail">
972
        <Documentation>Provides detailed information about auctions.
973
Requires the "auction" interaction flag to be set.
974
detail = Inspect.Auction.Detail(auction)   -- table &lt;- auction
975
details = Inspect.Auction.Detail(auctions)   -- table &lt;- table
976
</Documentation>
977
        <Parameters>
978
          <Parameter Name="auction">
979
            <Documentation>An identifier for the auction to retrieve detail for.</Documentation>
980
          </Parameter>
981
          <Parameter Name="auctions">
982
            <Documentation>A lookup table containing auction identifiers to retrieve details for. The value is the sort order.</Documentation>
983
          </Parameter>
984
        </Parameters>
985
        <ReturnValues>
986
          <ReturnValue Name="detail">
987
            <Documentation>Detail table for a single auction.</Documentation>
988
          </ReturnValue>
989
          <ReturnValue Name="details">
990
            <Documentation>Detail tables for all requested auctions. The key is the auction ID, the value is the auction's detail table.</Documentation>
991
          </ReturnValue>
992
        </ReturnValues>
993
        <ReturnedMembers>
994
          <ReturnedMember Name="bid">
995
            <Documentation>The current bid on this auction, in silver.</Documentation>
996
          </ReturnedMember>
997
          <ReturnedMember Name="bidder">
998
            <Documentation>Current high bidder on this auction. Available only if your current character is the bidder or the seller.</Documentation>
999
          </ReturnedMember>
1000
          <ReturnedMember Name="buyout">
1001
            <Documentation>The buyout amount for this auction, in silver.</Documentation>
1002
          </ReturnedMember>
1003
          <ReturnedMember Name="id">
1004
            <Documentation>The ID of the requested element.</Documentation>
1005
          </ReturnedMember>
1006
          <ReturnedMember Name="item">
1007
            <Documentation>ID of the item involved in the auction.</Documentation>
1008
          </ReturnedMember>
1009
          <ReturnedMember Name="itemStack">
1010
            <Documentation>The size of this item stack.</Documentation>
1011
          </ReturnedMember>
1012
          <ReturnedMember Name="itemType">
1013
            <Documentation>The item's type specifier.</Documentation>
1014
          </ReturnedMember>
1015
          <ReturnedMember Name="seller">
1016
            <Documentation>The name of the auction's seller.</Documentation>
1017
          </ReturnedMember>
1018
          <ReturnedMember Name="time">
1019
            <Documentation>Time remaining in the auction, as a string. Either "short", "medium", or "long".</Documentation>
1020
          </ReturnedMember>
1021
        </ReturnedMembers>
1022
      </Function>
1023
      <Function Name="Inspect.Buff.Detail">
1024
        <Documentation>Provides detailed information about the buffs on a unit.
1025
detail = Inspect.Buff.Detail(unit, buff)   -- table &lt;- unit, buff
1026
details = Inspect.Buff.Detail(unit, buffs)   -- table &lt;- unit, table
1027
</Documentation>
1028
        <Parameters>
1029
          <Parameter Name="buff">
1030
            <Documentation>An identifier for the buff to retrieve detail for.</Documentation>
1031
          </Parameter>
1032
          <Parameter Name="buffs">
1033
            <Documentation>A lookup table containing buff identifiers to retrieve details for.</Documentation>
1034
          </Parameter>
1035
          <Parameter Name="unit">
1036
            <Documentation>The unit to inspect.</Documentation>
1037
          </Parameter>
1038
        </Parameters>
1039
        <ReturnValues>
1040
          <ReturnValue Name="detail">
1041
            <Documentation>Detail table for a single buff.</Documentation>
1042
          </ReturnValue>
1043
          <ReturnValue Name="details">
1044
            <Documentation>Detail tables for all requested buffs. The key is the buff ID, the value is the buff's detail table.</Documentation>
1045
          </ReturnValue>
1046
        </ReturnValues>
1047
        <ReturnedMembers>
1048
          <ReturnedMember Name="ability">
1049
            <Documentation>The ID of the ability that created this buff. Not guaranteed to exist.</Documentation>
1050
          </ReturnedMember>
1051
          <ReturnedMember Name="begin">
1052
            <Documentation>The time the buff started, in the context of Inspect.Time.Frame.</Documentation>
1053
          </ReturnedMember>
1054
          <ReturnedMember Name="caster">
1055
            <Documentation>Unit ID of the buff's caster.</Documentation>
1056
          </ReturnedMember>
1057
          <ReturnedMember Name="curse">
1058
            <Documentation>Signals that the buff is a curse.</Documentation>
1059
          </ReturnedMember>
1060
          <ReturnedMember Name="debuff">
1061
            <Documentation>Signals that the buff is a debuff. If this is missing, then it's an actual buff.</Documentation>
1062
          </ReturnedMember>
1063
          <ReturnedMember Name="description">
1064
            <Documentation>Description for the buff. Numbers may not be accurate - see Command.Buff.Describe().</Documentation>
1065
          </ReturnedMember>
1066
          <ReturnedMember Name="descriptionComplete">
1067
            <Documentation>Signals that the buff description is complete.</Documentation>
1068
          </ReturnedMember>
1069
          <ReturnedMember Name="disease">
1070
            <Documentation>Signals that the buff is a disease.</Documentation>
1071
          </ReturnedMember>
1072
          <ReturnedMember Name="duration">
1073
            <Documentation>Duration of the buff in seconds.</Documentation>
1074
          </ReturnedMember>
1075
          <ReturnedMember Name="expired">
1076
            <Documentation>Number of seconds the buff is past its expiration time. Generally indicates lag.</Documentation>
1077
          </ReturnedMember>
1078
          <ReturnedMember Name="icon">
1079
            <Documentation>Resource filename of the buff's icon.</Documentation>
1080
          </ReturnedMember>
1081
          <ReturnedMember Name="id">
1082
            <Documentation>The ID of the requested element.</Documentation>
1083
          </ReturnedMember>
1084
          <ReturnedMember Name="name">
1085
            <Documentation>Name of the buff.</Documentation>
1086
          </ReturnedMember>
1087
          <ReturnedMember Name="noncancelable">
1088
            <Documentation>Signals that the buff cannot be voluntarily canceled. Does not show up for debuffs.</Documentation>
1089
          </ReturnedMember>
1090
          <ReturnedMember Name="poison">
1091
            <Documentation>Signals that the buff is a poison.</Documentation>
1092
          </ReturnedMember>
1093
          <ReturnedMember Name="remaining">
1094
            <Documentation>Time remaining on the buff, in seconds.</Documentation>
1095
          </ReturnedMember>
1096
          <ReturnedMember Name="rune">
1097
            <Documentation>If this buff is created by a rune, the ID of the rune causing it.</Documentation>
1098
          </ReturnedMember>
1099
          <ReturnedMember Name="stack">
1100
            <Documentation>Number of stacks on the buff.</Documentation>
1101
          </ReturnedMember>
1102
          <ReturnedMember Name="type">
1103
            <Documentation>The buff type ID.</Documentation>
1104
          </ReturnedMember>
1105
        </ReturnedMembers>
1106
      </Function>
1107
      <Function Name="Inspect.Buff.List">
1108
        <Documentation>List buffs on a unit.
1109
buffs = Inspect.Buff.List(unit)   -- table &lt;- unit
1110
</Documentation>
1111
        <Parameters>
1112
          <Parameter Name="unit">
1113
            <Documentation>The unit to inspect.</Documentation>
1114
          </Parameter>
1115
        </Parameters>
1116
        <ReturnValues>
1117
          <ReturnValue Name="buffs">
1118
            <Documentation>A lookup table of the IDs of the buffs on the unit.</Documentation>
1119
          </ReturnValue>
1120
        </ReturnValues>
1121
        <ReturnedMembers />
1122
      </Function>
1123
      <Function Name="Inspect.Currency.Category.Detail">
1124
        <Documentation>Returns information about currency categories.
1125
detail = Inspect.Currency.Category.Detail(category)   -- table &lt;- currencycategory
1126
details = Inspect.Currency.Category.Detail(categories)   -- table &lt;- table
1127
</Documentation>
1128
        <Parameters>
1129
          <Parameter Name="categories">
1130
            <Documentation>A lookup table of identifiers of currency categories to retrieve detail for.</Documentation>
1131
          </Parameter>
1132
          <Parameter Name="category">
1133
            <Documentation>The identifier of the currency category to retrieve detail for.</Documentation>
1134
          </Parameter>
1135
        </Parameters>
1136
        <ReturnValues>
1137
          <ReturnValue Name="detail">
1138
            <Documentation>Detail table for a single currency category.</Documentation>
1139
          </ReturnValue>
1140
          <ReturnValue Name="details">
1141
            <Documentation>Detail tables for all requested currency categories. The key is the category ID, the value is the category's detail table.</Documentation>
1142
          </ReturnValue>
1143
        </ReturnValues>
1144
        <ReturnedMembers>
1145
          <ReturnedMember Name="id">
1146
            <Documentation>The ID of the requested element.</Documentation>
1147
          </ReturnedMember>
1148
          <ReturnedMember Name="name">
1149
            <Documentation>The name of the currency category.</Documentation>
1150
          </ReturnedMember>
1151
        </ReturnedMembers>
1152
      </Function>
1153
      <Function Name="Inspect.Currency.Category.List">
1154
        <Documentation>Returns a lookup table of valid currency categories.
1155
categories = Inspect.Currency.Category.List()   -- table &lt;- void
1156
</Documentation>
1157
        <Parameters />
1158
        <ReturnValues>
1159
          <ReturnValue Name="categories">
1160
            <Documentation>Valid currency categories, in {id = true} format.</Documentation>
1161
          </ReturnValue>
1162
        </ReturnValues>
1163
        <ReturnedMembers />
1164
      </Function>
1165
      <Function Name="Inspect.Currency.Detail">
1166
        <Documentation>Provides detailed information about currencies.
1167
detail = Inspect.Currency.Detail(coin)   -- table &lt;- string
1168
detail = Inspect.Currency.Detail(currency)   -- table &lt;- itemtype
1169
details = Inspect.Currency.Detail(currencies)   -- table &lt;- table
1170
</Documentation>
1171
        <Parameters>
1172
          <Parameter Name="coin">
1173
            <Documentation>The string "coin", used as a value to request the player's money.</Documentation>
1174
          </Parameter>
1175
          <Parameter Name="currencies">
1176
            <Documentation>A lookup table of identifiers of currencies to retrieve detail for.</Documentation>
1177
          </Parameter>
1178
          <Parameter Name="currency">
1179
            <Documentation>The identifier of the currency to retrieve detail for.</Documentation>
1180
          </Parameter>
1181
        </Parameters>
1182
        <ReturnValues>
1183
          <ReturnValue Name="detail">
1184
            <Documentation>Detail table for a single currency.</Documentation>
1185
          </ReturnValue>
1186
          <ReturnValue Name="details">
1187
            <Documentation>Detail tables for all requested currencies. The key is the currency ID, the value is the currency's detail table.</Documentation>
1188
          </ReturnValue>
1189
        </ReturnValues>
1190
        <ReturnedMembers>
1191
          <ReturnedMember Name="category">
1192
            <Documentation>ID of the currency's category.</Documentation>
1193
          </ReturnedMember>
1194
          <ReturnedMember Name="icon">
1195
            <Documentation>Internal name of the currency's icon.</Documentation>
1196
          </ReturnedMember>
1197
          <ReturnedMember Name="id">
1198
            <Documentation>The ID of the requested element.</Documentation>
1199
          </ReturnedMember>
1200
          <ReturnedMember Name="name">
1201
            <Documentation>The currency's name.</Documentation>
1202
          </ReturnedMember>
1203
          <ReturnedMember Name="stack">
1204
            <Documentation>The number of this currency that you have.</Documentation>
1205
          </ReturnedMember>
1206
          <ReturnedMember Name="stackMax">
1207
            <Documentation>The maximum number of this currency that you can have.</Documentation>
1208
          </ReturnedMember>
1209
        </ReturnedMembers>
1210
      </Function>
1211
      <Function Name="Inspect.Currency.List">
1212
        <Documentation>Returns a lookup table of all known currencies.
1213
currencies = Inspect.Currency.List()   -- table &lt;- void
1214
</Documentation>
1215
        <Parameters />
1216
        <ReturnValues>
1217
          <ReturnValue Name="currencies">
1218
            <Documentation>All known currencies, in {id = amount} format.</Documentation>
1219
          </ReturnValue>
1220
        </ReturnValues>
1221
        <ReturnedMembers />
1222
      </Function>
1223
      <Function Name="Inspect.Cursor">
1224
        <Documentation>Returns the current contents of the cursor.
1225
type, held = Inspect.Cursor()   -- nil, nil &lt;- void
1226
type, held = Inspect.Cursor()   -- string, variant &lt;- void
1227
</Documentation>
1228
        <Parameters />
1229
        <ReturnValues>
1230
          <ReturnValue Name="held">
1231
            <Documentation>The blob describing what is currently held. Generally, some kind of identifier used in another part of the addon system.</Documentation>
1232
          </ReturnValue>
1233
          <ReturnValue Name="type">
1234
            <Documentation>The current cursor type. Valid values include "ability", "item", and "itemtype".</Documentation>
1235
          </ReturnValue>
1236
        </ReturnValues>
1237
        <ReturnedMembers />
1238
      </Function>
1239
      <Function Name="Inspect.Documentation">
1240
        <Documentation>Provide documentation on items in the addon environment. Called with no parameters, it returns a table listing all documentation. Can provide both human-readable and computer-readable documentation.
1241
documentables = Inspect.Documentation()   -- table &lt;- void
1242
documentation = Inspect.Documentation(item)   -- string &lt;- variant
1243
documentation = Inspect.Documentation(item, parseable)   -- string &lt;- variant, boolean
1244
documentationTable = Inspect.Documentation(item, parseable)   -- table &lt;- variant, boolean
1245
</Documentation>
1246
        <Parameters>
1247
          <Parameter Name="item">
1248
            <Documentation>The item to get documentation on. May be either the item itself or a string identifier.</Documentation>
1249
          </Parameter>
1250
          <Parameter Name="parseable">
1251
            <Documentation>Whether to return in a computer-readable format, as opposed to the normal human-readable format.</Documentation>
1252
          </Parameter>
1253
        </Parameters>
1254
        <ReturnValues>
1255
          <ReturnValue Name="documentables">
1256
            <Documentation>List of all items that documentation can be retrieved for. In {["itemname"] = true} format.</Documentation>
1257
          </ReturnValue>
1258
          <ReturnValue Name="documentation">
1259
            <Documentation>Documentation for the requested item.</Documentation>
1260
          </ReturnValue>
1261
          <ReturnValue Name="documentationTable">
1262
            <Documentation>Computer-readable documentation for the requested item. Format may change without warning.</Documentation>
1263
          </ReturnValue>
1264
        </ReturnValues>
1265
        <ReturnedMembers />
1266
      </Function>
1267
      <Function Name="Inspect.Faction.Detail">
1268
        <Documentation>Provides detailed information about factions.
1269
detail = Inspect.Faction.Detail(faction)   -- table &lt;- faction
1270
details = Inspect.Faction.Detail(factions)   -- table &lt;- table
1271
</Documentation>
1272
        <Parameters>
1273
          <Parameter Name="faction">
1274
            <Documentation>The identifier of the faction to retrieve detail for.</Documentation>
1275
          </Parameter>
1276
          <Parameter Name="factions">
1277
            <Documentation>A lookup table of identifiers of factions to retrieve detail for.</Documentation>
1278
          </Parameter>
1279
        </Parameters>
1280
        <ReturnValues>
1281
          <ReturnValue Name="detail">
1282
            <Documentation>Detail table for a single faction.</Documentation>
1283
          </ReturnValue>
1284
          <ReturnValue Name="details">
1285
            <Documentation>Detail tables for all requested factions. The key is the faction ID, the value is the faction's detail table.</Documentation>
1286
          </ReturnValue>
1287
        </ReturnValues>
1288
        <ReturnedMembers>
1289
          <ReturnedMember Name="categoryName">
1290
            <Documentation>Name of the faction's category.</Documentation>
1291
          </ReturnedMember>
1292
          <ReturnedMember Name="id">
1293
            <Documentation>The ID of the requested element.</Documentation>
1294
          </ReturnedMember>
1295
          <ReturnedMember Name="name">
1296
            <Documentation>The faction's name.</Documentation>
1297
          </ReturnedMember>
1298
          <ReturnedMember Name="notoriety">
1299
            <Documentation>The current notoriety you have with this faction.</Documentation>
1300
          </ReturnedMember>
1301
        </ReturnedMembers>
1302
      </Function>
1303
      <Function Name="Inspect.Faction.List">
1304
        <Documentation>Returns a lookup table of all known factions.
1305
factions = Inspect.Faction.List()   -- table &lt;- void
1306
</Documentation>
1307
        <Parameters />
1308
        <ReturnValues>
1309
          <ReturnValue Name="factions">
1310
            <Documentation>All known factions, in {id = notoriety} format.</Documentation>
1311
          </ReturnValue>
1312
        </ReturnValues>
1313
        <ReturnedMembers />
1314
      </Function>
1315
      <Function Name="Inspect.Interaction">
1316
        <Documentation>Provides information about what types of interaction are available.
1317
interactions = Inspect.Interaction()   -- table &lt;- void
1318
status = Inspect.Interaction(interaction)   -- boolean &lt;- string
1319
</Documentation>
1320
        <Parameters>
1321
          <Parameter Name="interaction">
1322
            <Documentation>Optional name of the interaction type to query. Valid values include "auction", "bank", "guildbank", and "mail".</Documentation>
1323
          </Parameter>
1324
        </Parameters>
1325
        <ReturnValues>
1326
          <ReturnValue Name="interactions">
1327
            <Documentation>Lookup table from interaction type to indicator of whether that interaction is available.</Documentation>
1328
          </ReturnValue>
1329
          <ReturnValue Name="status">
1330
            <Documentation>Whether or not that interaction type is available.</Documentation>
1331
          </ReturnValue>
1332
        </ReturnValues>
1333
        <ReturnedMembers />
1334
      </Function>
1335
      <Function Name="Inspect.Item.Detail">
1336
        <Documentation>Provides detailed information about items.
1337
item = Inspect.Item.Detail(item)   -- table &lt;- item
1338
item = Inspect.Item.Detail(itemtype)   -- table &lt;- itemtype
1339
item = Inspect.Item.Detail(slot)   -- table &lt;- slot
1340
items = Inspect.Item.Detail(slot)   -- table &lt;- slot
1341
items = Inspect.Item.Detail(elements)   -- table &lt;- table
1342
</Documentation>
1343
        <Parameters>
1344
          <Parameter Name="elements">
1345
            <Documentation>A lookup table of slot specifiers, item IDs, or item types.</Documentation>
1346
          </Parameter>
1347
          <Parameter Name="item">
1348
            <Documentation>A single item ID.</Documentation>
1349
          </Parameter>
1350
          <Parameter Name="itemtype">
1351
            <Documentation>A single item type.</Documentation>
1352
          </Parameter>
1353
          <Parameter Name="slot">
1354
            <Documentation>A single slot specifier.</Documentation>
1355
          </Parameter>
1356
        </Parameters>
1357
        <ReturnValues>
1358
          <ReturnValue Name="item">
1359
            <Documentation>Detail table for a single item.</Documentation>
1360
          </ReturnValue>
1361
          <ReturnValue Name="items">
1362
            <Documentation>Detail tables for all requested items. The key is the string used to lookup, the value is the item's detail table.</Documentation>
1363
          </ReturnValue>
1364
        </ReturnValues>
1365
        <ReturnedMembers>
1366
          <ReturnedMember Name="bind">
1367
            <Documentation>The item's binding type. May be "equip", "use", "pickup", or "account".</Documentation>
1368
          </ReturnedMember>
1369
          <ReturnedMember Name="bound">
1370
            <Documentation>The item's bound flag.</Documentation>
1371
          </ReturnedMember>
1372
          <ReturnedMember Name="category">
1373
            <Documentation>The item's type category.</Documentation>
1374
          </ReturnedMember>
1375
          <ReturnedMember Name="coin">
1376
            <Documentation>The amount of silver this item represents.</Documentation>
1377
          </ReturnedMember>
1378
          <ReturnedMember Name="cooldown">
1379
            <Documentation>The cooldown for using this item.</Documentation>
1380
          </ReturnedMember>
1381
          <ReturnedMember Name="cooldownBegin">
1382
            <Documentation>The time the current cooldown started, in the context of Inspect.Time.Frame.</Documentation>
1383
          </ReturnedMember>
1384
          <ReturnedMember Name="cooldownDuration">
1385
            <Documentation>Duration of the current cooldown the item is influenced by, in seconds.</Documentation>
1386
          </ReturnedMember>
1387
          <ReturnedMember Name="cooldownExpired">
1388
            <Documentation>Number of seconds the current cooldown is past its expiration time. Generally indicates lag.</Documentation>
1389
          </ReturnedMember>
1390
          <ReturnedMember Name="cooldownRemaining">
1391
            <Documentation>Time remaining in the item's current cooldown, in seconds.</Documentation>
1392
          </ReturnedMember>
1393
          <ReturnedMember Name="crafter">
1394
            <Documentation>The name of the player who crafted this item.</Documentation>
1395
          </ReturnedMember>
1396
          <ReturnedMember Name="damageDelay">
1397
            <Documentation>If a weapon, the delay between autoattacks using this weapon.</Documentation>
1398
          </ReturnedMember>
1399
          <ReturnedMember Name="damageMax">
1400
            <Documentation>If a weapon, the maximum damage done by a single hit with this item.</Documentation>
1401
          </ReturnedMember>
1402
          <ReturnedMember Name="damageMin">
1403
            <Documentation>If a weapon, the minimum damage done by a single hit with this item.</Documentation>
1404
          </ReturnedMember>
1405
          <ReturnedMember Name="damageType">
1406
            <Documentation>If a weapon, the damage type done by autoattacks. Values include "life", "death", "air", "earth", "fire", and "water".</Documentation>
1407
          </ReturnedMember>
1408
          <ReturnedMember Name="description">
1409
            <Documentation>The description of this item.</Documentation>
1410
          </ReturnedMember>
1411
          <ReturnedMember Name="flavor">
1412
            <Documentation>The flavor text for this item.</Documentation>
1413
          </ReturnedMember>
1414
          <ReturnedMember Name="icon">
1415
            <Documentation>Resource filename of the item's icon.</Documentation>
1416
          </ReturnedMember>
1417
          <ReturnedMember Name="id">
1418
            <Documentation>The ID of the requested element.</Documentation>
1419
          </ReturnedMember>
1420
          <ReturnedMember Name="lootable">
1421
            <Documentation>Indicates that the item contains loot.</Documentation>
1422
          </ReturnedMember>
1423
          <ReturnedMember Name="name">
1424
            <Documentation>The item's name.</Documentation>
1425
          </ReturnedMember>
1426
          <ReturnedMember Name="range">
1427
            <Documentation>If a ranged weapon, the maximum range of this item.</Documentation>
1428
          </ReturnedMember>
1429
          <ReturnedMember Name="rarity">
1430
            <Documentation>The item's rarity. Values include "sellable", "uncommon", "rare", "epic", "relic", "transcendant", or "quest". Common items have a rarity of nil.</Documentation>
1431
          </ReturnedMember>
1432
          <ReturnedMember Name="requiredCalling">
1433
            <Documentation>Space-delimited list of the required callings to use this item.</Documentation>
1434
          </ReturnedMember>
1435
          <ReturnedMember Name="requiredFaction">
1436
            <Documentation>The ID of the faction required to use this item.</Documentation>
1437
          </ReturnedMember>
1438
          <ReturnedMember Name="requiredFactionLevel">
1439
            <Documentation>The faction notoriety required to use this item.</Documentation>
1440
          </ReturnedMember>
1441
          <ReturnedMember Name="requiredLevel">
1442
            <Documentation>The level required to use this item.</Documentation>
1443
          </ReturnedMember>
1444
          <ReturnedMember Name="requiredPrestige">
1445
            <Documentation>The prestige rank required to use this item.</Documentation>
1446
          </ReturnedMember>
1447
          <ReturnedMember Name="requiredSkill">
1448
            <Documentation>The skill required to use this item.</Documentation>
1449
          </ReturnedMember>
1450
          <ReturnedMember Name="requiredSkillLevel">
1451
            <Documentation>The skill level required to use this item.</Documentation>
1452
          </ReturnedMember>
1453
          <ReturnedMember Name="sell">
1454
            <Documentation>The sell value of this item, in silver.</Documentation>
1455
          </ReturnedMember>
1456
          <ReturnedMember Name="slots">
1457
            <Documentation>If a container, the number of slots that this item can contain.</Documentation>
1458
          </ReturnedMember>
1459
          <ReturnedMember Name="stack">
1460
            <Documentation>The size of this item stack.</Documentation>
1461
          </ReturnedMember>
1462
          <ReturnedMember Name="stackMax">
1463
            <Documentation>The maximum size of this item stack.</Documentation>
1464
          </ReturnedMember>
1465
          <ReturnedMember Name="stats">
1466
            <Documentation>The base stats of this item. Members may include "block", "critAttack", "critSpell", "deflect", "dexterity", "dodge", "endurance", "energyMax", "energyRegen", "focus", "hit", "intelligence", "manaMax", "manaRegen", "movement", "parry", "powerAttack", "powerMax", "powerRegen", "powerSpell", "resistAir", "resistDeath", "resistEarth", "resistFire", "resistLife", "resistWater", "stealth", "stealthDetect", "strength", "wisdom", "xp", "valor", "toughness", and "vengeance".</Documentation>
1467
          </ReturnedMember>
1468
          <ReturnedMember Name="statsRune">
1469
            <Documentation>The added rune stats of this item. May contain the same members as stats.</Documentation>
1470
          </ReturnedMember>
1471
          <ReturnedMember Name="statsRuneTemporary">
1472
            <Documentation>The added temporary rune stats of this item. May contain the same members as stats.</Documentation>
1473
          </ReturnedMember>
1474
          <ReturnedMember Name="type">
1475
            <Documentation>The item's type specifier.</Documentation>
1476
          </ReturnedMember>
1477
        </ReturnedMembers>
1478
      </Function>
1479
      <Function Name="Inspect.Item.Find">
1480
        <Documentation>Finds a slot specifier based on an item ID.
1481
slot = Inspect.Item.Find(item)   -- slot &lt;- item
1482
slots = Inspect.Item.Find(items)   -- table &lt;- table
1483
</Documentation>
1484
        <Parameters>
1485
          <Parameter Name="item">
1486
            <Documentation>A single item ID.</Documentation>
1487
          </Parameter>
1488
          <Parameter Name="items">
1489
            <Documentation>A lookup table of item IDs.</Documentation>
1490
          </Parameter>
1491
        </Parameters>
1492
        <ReturnValues>
1493
          <ReturnValue Name="slot">
1494
            <Documentation>A slot specifier for that item.</Documentation>
1495
          </ReturnValue>
1496
          <ReturnValue Name="slots">
1497
            <Documentation>Slot specifiers for all requested items. The key is the string used to lookup, the value is the slot specifier.</Documentation>
1498
          </ReturnValue>
1499
        </ReturnValues>
1500
        <ReturnedMembers />
1501
      </Function>
1502
      <Function Name="Inspect.Item.List">
1503
        <Documentation>Generate a list of item IDs from a slot specifier or set of slot specifiers.
1504
items = Inspect.Item.List()   -- table &lt;- void
1505
item = Inspect.Item.List(slot)   -- item &lt;- slot
1506
items = Inspect.Item.List(slot)   -- table &lt;- slot
1507
items = Inspect.Item.List(slots)   -- table &lt;- table
1508
</Documentation>
1509
        <Parameters>
1510
          <Parameter Name="slot">
1511
            <Documentation>A single slot specifier.</Documentation>
1512
          </Parameter>
1513
          <Parameter Name="slots">
1514
            <Documentation>A table of slot specifiers.</Documentation>
1515
          </Parameter>
1516
        </Parameters>
1517
        <ReturnValues>
1518
          <ReturnValue Name="item">
1519
            <Documentation>A single item ID. This will be returned only if the input is a single fully-specified slot specifier.</Documentation>
1520
          </ReturnValue>
1521
          <ReturnValue Name="items">
1522
            <Documentation>A lookup table of item IDs. The key is the slot specifier, the value is the item ID.</Documentation>
1523
          </ReturnValue>
1524
        </ReturnValues>
1525
        <ReturnedMembers />
1526
      </Function>
1527
      <Function Name="Inspect.Mail.Detail">
1528
        <Documentation>Returns information about mail.
1529
Requires the "mail" interaction flag to be set.
1530
detail = Inspect.Mail.Detail(mail)   -- table &lt;- mail
1531
details = Inspect.Mail.Detail(mails)   -- table &lt;- table
1532
</Documentation>
1533
        <Parameters>
1534
          <Parameter Name="mail">
1535
            <Documentation>The identifier of the mail to retrieve detail for.</Documentation>
1536
          </Parameter>
1537
          <Parameter Name="mails">
1538
            <Documentation>A lookup table of identifiers of mail to retrieve detail for.</Documentation>
1539
          </Parameter>
1540
        </Parameters>
1541
        <ReturnValues>
1542
          <ReturnValue Name="detail">
1543
            <Documentation>Detail table for a single mail.</Documentation>
1544
          </ReturnValue>
1545
          <ReturnValue Name="details">
1546
            <Documentation>Detail tables for all requested mail. The key is the mail ID, the value is the mail's detail table.</Documentation>
1547
          </ReturnValue>
1548
        </ReturnValues>
1549
        <ReturnedMembers>
1550
          <ReturnedMember Name="attachments">
1551
            <Documentation>The attachments available on this mail. A number if this mail has basic information, or a table of item IDs if this mail has detailed information.</Documentation>
1552
          </ReturnedMember>
1553
          <ReturnedMember Name="body">
1554
            <Documentation>The body of this mail. Available only if detailed information on the mail has been retrieved.</Documentation>
1555
          </ReturnedMember>
1556
          <ReturnedMember Name="cod">
1557
            <Documentation>The Cash on Delivery required to retrieve attachments out of this mail message.</Documentation>
1558
          </ReturnedMember>
1559
          <ReturnedMember Name="expire">
1560
            <Documentation>The time this mail will expire, in Unix timestamp form.</Documentation>
1561
          </ReturnedMember>
1562
          <ReturnedMember Name="from">
1563
            <Documentation>The name of the character this mail was sent from.</Documentation>
1564
          </ReturnedMember>
1565
          <ReturnedMember Name="id">
1566
            <Documentation>The ID of the requested element.</Documentation>
1567
          </ReturnedMember>
1568
          <ReturnedMember Name="read">
1569
            <Documentation>"true" if you have already opened this mail.</Documentation>
1570
          </ReturnedMember>
1571
          <ReturnedMember Name="spam">
1572
            <Documentation>"true" if this mail is considered spam.</Documentation>
1573
          </ReturnedMember>
1574
          <ReturnedMember Name="subject">
1575
            <Documentation>The subject line for this mail.</Documentation>
1576
          </ReturnedMember>
1577
        </ReturnedMembers>
1578
      </Function>
1579
      <Function Name="Inspect.Mail.List">
1580
        <Documentation>Returns a lookup table of valid mail and its status.
1581
Requires the "mail" interaction flag to be set.
1582
mails = Inspect.Mail.List()   -- table &lt;- void
1583
</Documentation>
1584
        <Parameters />
1585
        <ReturnValues>
1586
          <ReturnValue Name="mails">
1587
            <Documentation>Valid mail, in {id = "type"} format. The type may be either "basic" or "detail", indicating whether the mail has been opened and its detailed information is available.</Documentation>
1588
          </ReturnValue>
1589
        </ReturnValues>
1590
        <ReturnedMembers />
1591
      </Function>
1592
      <Function Name="Inspect.Map.Detail">
1593
        <Documentation>Returns information about map locations.
1594
detail = Inspect.Map.Detail(location)   -- table &lt;- location
1595
details = Inspect.Map.Detail(locations)   -- table &lt;- table
1596
</Documentation>
1597
        <Parameters>
1598
          <Parameter Name="location">
1599
            <Documentation>The identifier of the location to retrieve detail for.</Documentation>
1600
          </Parameter>
1601
          <Parameter Name="locations">
1602
            <Documentation>A lookup table of identifiers of locations to retrieve detail for.</Documentation>
1603
          </Parameter>
1604
        </Parameters>
1605
        <ReturnValues>
1606
          <ReturnValue Name="detail">
1607
            <Documentation>Detail table for a single location.</Documentation>
1608
          </ReturnValue>
1609
          <ReturnValue Name="details">
1610
            <Documentation>Detail tables for all requested locations. The key is the location ID, the value is the location's detail table.</Documentation>
1611
          </ReturnValue>
1612
        </ReturnValues>
1613
        <ReturnedMembers>
1614
          <ReturnedMember Name="coordX">
1615
            <Documentation>The map location's current X coordinate.</Documentation>
1616
          </ReturnedMember>
1617
          <ReturnedMember Name="coordY">
1618
            <Documentation>The map location's current Y coordinate.</Documentation>
1619
          </ReturnedMember>
1620
          <ReturnedMember Name="coordZ">
1621
            <Documentation>The map location's current Z coordinate.</Documentation>
1622
          </ReturnedMember>
1623
          <ReturnedMember Name="description">
1624
            <Documentation>The description of this map location, if it has one.</Documentation>
1625
          </ReturnedMember>
1626
          <ReturnedMember Name="id">
1627
            <Documentation>The ID of the requested element.</Documentation>
1628
          </ReturnedMember>
1629
          <ReturnedMember Name="title">
1630
            <Documentation>The title of this map location, if it has one.</Documentation>
1631
          </ReturnedMember>
1632
        </ReturnedMembers>
1633
      </Function>
1634
      <Function Name="Inspect.Map.List">
1635
        <Documentation>Returns a lookup table of map locations.
1636
list = Inspect.Map.List()   -- table &lt;- void
1637
</Documentation>
1638
        <Parameters />
1639
        <ReturnValues>
1640
          <ReturnValue Name="list">
1641
            <Documentation>Valid locations, in {id = true} format.</Documentation>
1642
          </ReturnValue>
1643
        </ReturnValues>
1644
        <ReturnedMembers />
1645
      </Function>
1646
      <Function Name="Inspect.Map.Monitor">
1647
        <Documentation>Inspects the state of the map monitor flag. See Command.Map.Monitor() for details.
1648
monitor = Inspect.Map.Monitor()   -- boolean &lt;- void
1649
</Documentation>
1650
        <Parameters />
1651
        <ReturnValues>
1652
          <ReturnValue Name="monitor">
1653
            <Documentation>The current state of the map monitor flag.</Documentation>
1654
          </ReturnValue>
1655
        </ReturnValues>
1656
        <ReturnedMembers />
1657
      </Function>
1658
      <Function Name="Inspect.Message.Accept.Check">
1659
        <Documentation>Checks whether a given message type would be accepted if it were sent to you. Parameters can be replaced by "nil" to check for wildcard acceptance.
1660
accepted = Inspect.Message.Accept.Check(type, identifier)   -- boolean &lt;- string/nil, string/nil
1661
</Documentation>
1662
        <Parameters>
1663
          <Parameter Name="identifier">
1664
            <Documentation>The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.</Documentation>
1665
          </Parameter>
1666
          <Parameter Name="type">
1667
            <Documentation>The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".</Documentation>
1668
          </Parameter>
1669
        </Parameters>
1670
        <ReturnValues>
1671
          <ReturnValue Name="accepted">
1672
            <Documentation>True if the message would be transferred to this client.</Documentation>
1673
          </ReturnValue>
1674
        </ReturnValues>
1675
        <ReturnedMembers />
1676
      </Function>
1677
      <Function Name="Inspect.Message.Accept.List">
1678
        <Documentation>Retrieves the list of accepted message types and identifiers.
1679
accepts = Inspect.Message.Accept.List()   -- table &lt;- void
1680
</Documentation>
1681
        <Parameters />
1682
        <ReturnValues>
1683
          <ReturnValue Name="accepts">
1684
            <Documentation>List of all accepted message types. Takes the form of a key/value table. The key is a table containing {type, identifier}, where either element may be nil to indicate a wildcard. The value is the number of times this type has been accepted.</Documentation>
1685
          </ReturnValue>
1686
        </ReturnValues>
1687
        <ReturnedMembers />
1688
      </Function>
1689
      <Function Name="Inspect.Mouse">
1690
        <Documentation>Returns information about the current mouse position and button state.
1691
results = Inspect.Mouse()   -- table &lt;- void
1692
</Documentation>
1693
        <Parameters />
1694
        <ReturnValues>
1695
          <ReturnValue Name="results">
1696
            <Documentation>Table containing the current mouse state. May include members x, y, Left, Right, Middle, Mouse4, Mouse5.</Documentation>
1697
          </ReturnValue>
1698
        </ReturnValues>
1699
        <ReturnedMembers />
1700
      </Function>
1701
      <Function Name="Inspect.Quest.Complete">
1702
        <Documentation>Returns a lookup table of all quests completed.
1703
quests = Inspect.Quest.Complete()   -- table &lt;- void
1704
</Documentation>
1705
        <Parameters />
1706
        <ReturnValues>
1707
          <ReturnValue Name="quests">
1708
            <Documentation>A lookup table where the key is the incomplete quest identifier. Identifiers returned by this function may not include all characters - the last eight characters may be replaced by "xxxxxxxx". These elements can still be compared against standard quest IDs by comparing only the first nine characters (including the 'q' prefix).</Documentation>
1709
          </ReturnValue>
1710
        </ReturnValues>
1711
        <ReturnedMembers />
1712
      </Function>
1713
      <Function Name="Inspect.Quest.Detail">
1714
        <Documentation>Provides detailed information about a quest.
1715
detail = Inspect.Quest.Detail(quest)   -- table &lt;- quest
1716
details = Inspect.Quest.Detail(quests)   -- table &lt;- table
1717
</Documentation>
1718
        <Parameters>
1719
          <Parameter Name="quest">
1720
            <Documentation>The quest to be affected.</Documentation>
1721
          </Parameter>
1722
          <Parameter Name="quests">
1723
            <Documentation>A lookup table of quests to retrieve detail for.</Documentation>
1724
          </Parameter>
1725
        </Parameters>
1726
        <ReturnValues>
1727
          <ReturnValue Name="detail">
1728
            <Documentation>Detail table for a single quest.</Documentation>
1729
          </ReturnValue>
1730
          <ReturnValue Name="details">
1731
            <Documentation>Detail tables for all requested quests.</Documentation>
1732
          </ReturnValue>
1733
        </ReturnValues>
1734
        <ReturnedMembers>
1735
          <ReturnedMember Name="categoryName">
1736
            <Documentation>The name of the category this quest is placed under.</Documentation>
1737
          </ReturnedMember>
1738
          <ReturnedMember Name="complete">
1739
            <Documentation>Signals that this quest is complete.</Documentation>
1740
          </ReturnedMember>
1741
          <ReturnedMember Name="description">
1742
            <Documentation>The long description for this quest.</Documentation>
1743
          </ReturnedMember>
1744
          <ReturnedMember Name="domain">
1745
            <Documentation>The quest's domain. May be "area", "guild", "instant", or "zone". Personal quests are signaled with nil.</Documentation>
1746
          </ReturnedMember>
1747
          <ReturnedMember Name="failed">
1748
            <Documentation>Signals that this quest has failed.</Documentation>
1749
          </ReturnedMember>
1750
          <ReturnedMember Name="id">
1751
            <Documentation>The ID of the requested element.</Documentation>
1752
          </ReturnedMember>
1753
          <ReturnedMember Name="mode">
1754
            <Documentation>This quest's mode, if it has a special mode. May be "story" or "soul".</Documentation>
1755
          </ReturnedMember>
1756
          <ReturnedMember Name="name">
1757
            <Documentation>The name of this quest.</Documentation>
1758
          </ReturnedMember>
1759
          <ReturnedMember Name="objective">
1760
            <Documentation>A table of objectives. Each objective is a table that may contain the following members</Documentation>
1761
          </ReturnedMember>
1762
          <ReturnedMember Name="rewardChoose">
1763
            <Documentation>Lists the possible reward choices for the player. The key is the item type, the value is the count.</Documentation>
1764
          </ReturnedMember>
1765
          <ReturnedMember Name="rewardCoin">
1766
            <Documentation>The amount of silver this quest's completion will award.</Documentation>
1767
          </ReturnedMember>
1768
          <ReturnedMember Name="rewardExperience">
1769
            <Documentation>The amount of experience this quest's completion will award.</Documentation>
1770
          </ReturnedMember>
1771
          <ReturnedMember Name="rewardExperienceGuild">
1772
            <Documentation>The amount of guild experience this quest's completion will award.</Documentation>
1773
          </ReturnedMember>
1774
          <ReturnedMember Name="rewardFavor">
1775
            <Documentation>The amount of favor this quest's completion will award.</Documentation>
1776
          </ReturnedMember>
1777
          <ReturnedMember Name="rewardGuaranteed">
1778
            <Documentation>Lists the guaranteed rewards for the player. The key is the item type, the value is the count.</Documentation>
1779
          </ReturnedMember>
1780
          <ReturnedMember Name="rewardNotoriety">
1781
            <Documentation>The amount of notoriety this quest's completion will award, represented as a table. The key is the faction ID, the value is the amount.</Documentation>
1782
          </ReturnedMember>
1783
          <ReturnedMember Name="rewardPrestige">
1784
            <Documentation>The amount of prestige this quest's completion will award.</Documentation>
1785
          </ReturnedMember>
1786
          <ReturnedMember Name="summary">
1787
            <Documentation>The short summary for this quest.</Documentation>
1788
          </ReturnedMember>
1789
          <ReturnedMember Name="tag">
1790
            <Documentation>The quest's tags, space-separated.</Documentation>
1791
          </ReturnedMember>
1792
          <ReturnedMember Name="tagName">
1793
            <Documentation>The quest's tags, localized.</Documentation>
1794
          </ReturnedMember>
1795
          <ReturnedMember Name="track">
1796
            <Documentation>Signals that this quest is being manually tracked.</Documentation>
1797
          </ReturnedMember>
1798
          <ReturnedMember Name="watch">
1799
            <Documentation>Signals that this quest is being watched.</Documentation>
1800
          </ReturnedMember>
1801
        </ReturnedMembers>
1802
      </Function>
1803
      <Function Name="Inspect.Quest.List">
1804
        <Documentation>Lists the player's current active quests.
1805
quests = Inspect.Quest.List()   -- table &lt;- void
1806
</Documentation>
1807
        <Parameters />
1808
        <ReturnValues>
1809
          <ReturnValue Name="quests">
1810
            <Documentation>A lookup table containing the player's current quests.</Documentation>
1811
          </ReturnValue>
1812
        </ReturnValues>
1813
        <ReturnedMembers />
1814
      </Function>
1815
      <Function Name="Inspect.Queue.Handler">
1816
        <Documentation>Returns the current queue handler function.
1817
handler, owner = Inspect.Queue.Handler()   -- function, string &lt;- void
1818
</Documentation>
1819
        <Parameters />
1820
        <ReturnValues>
1821
          <ReturnValue Name="handler">
1822
            <Documentation>The current queue handler function.</Documentation>
1823
          </ReturnValue>
1824
          <ReturnValue Name="owner">
1825
            <Documentation>The owner of the current queue handler function.</Documentation>
1826
          </ReturnValue>
1827
        </ReturnValues>
1828
        <ReturnedMembers />
1829
      </Function>
1830
      <Function Name="Inspect.Queue.Status">
1831
        <Documentation>Inspects the current queue status. Omit the first parameter to get a table containing information on all queues.
1832
results = Inspect.Queue.Status()   -- table &lt;- void
1833
result = Inspect.Queue.Status(queue)   -- boolean &lt;- string
1834
results = Inspect.Queue.Status(queue, size)   -- table &lt;- string, number
1835
</Documentation>
1836
        <Parameters>
1837
          <Parameter Name="queue">
1838
            <Documentation>Optional identifier of the queue to query. Valid values include "global" and "auctionfullscan".</Documentation>
1839
          </Parameter>
1840
          <Parameter Name="size">
1841
            <Documentation>The size of the element to test in this queue. Defaults to 1 if no size is provided.</Documentation>
1842
          </Parameter>
1843
        </Parameters>
1844
        <ReturnValues>
1845
          <ReturnValue Name="result">
1846
            <Documentation>false if this queue is throttled, non-false otherwise.</Documentation>
1847
          </ReturnValue>
1848
          <ReturnValue Name="results">
1849
            <Documentation>A key/value table. The first parameter is the name of the queue. The second parameter is false if the queue is throttled, or a number representing the queue size available otherwise.</Documentation>
1850
          </ReturnValue>
1851
        </ReturnValues>
1852
        <ReturnedMembers />
1853
      </Function>
1854
      <Function Name="Inspect.Shard">
1855
        <Documentation>Returns information about the current shard.
1856
shard = Inspect.Shard()   -- table &lt;- void
1857
</Documentation>
1858
        <Parameters />
1859
        <ReturnValues>
1860
          <ReturnValue Name="shard">
1861
            <Documentation>Table containing requested data.</Documentation>
1862
          </ReturnValue>
1863
        </ReturnValues>
1864
        <ReturnedMembers>
1865
          <ReturnedMember Name="name">
1866
            <Documentation>The shard's name.</Documentation>
1867
          </ReturnedMember>
1868
          <ReturnedMember Name="pvp">
1869
            <Documentation>Signals that the shard is a PvP shard.</Documentation>
1870
          </ReturnedMember>
1871
          <ReturnedMember Name="rp">
1872
            <Documentation>Signals that the shard is a roleplaying shard.</Documentation>
1873
          </ReturnedMember>
1874
        </ReturnedMembers>
1875
      </Function>
1876
      <Function Name="Inspect.Stat">
1877
        <Documentation>Returns information about the player's stats.
1878
results = Inspect.Stat()   -- table &lt;- void
1879
result = Inspect.Stat(stat)   -- number &lt;- string
1880
</Documentation>
1881
        <Parameters>
1882
          <Parameter Name="stat">
1883
            <Documentation>Optional parameter identifying the stat desired. May be any of strength, dexterity, intelligence, wisdom, endurance, valor, toughness, resistLife, resistDeath, resistFire, resistWater, resistEarth, resistAir, armor, powerAttack, critAttack, hit, powerSpell, critSpell, focus, block, parry, dodge, vengeance, deflect, or any of the previous with "Unbuffed" appended.</Documentation>
1884
          </Parameter>
1885
        </Parameters>
1886
        <ReturnValues>
1887
          <ReturnValue Name="result">
1888
            <Documentation>The current value of that stat.</Documentation>
1889
          </ReturnValue>
1890
          <ReturnValue Name="results">
1891
            <Documentation>A lookup table from stat ID to stat value, containing all the player's stats.</Documentation>
1892
          </ReturnValue>
1893
        </ReturnValues>
1894
        <ReturnedMembers />
1895
      </Function>
1896
      <Function Name="Inspect.Storage.Used">
1897
        <Documentation>Returns the storage space currently used for a given segment.
1898
current, maximum = Inspect.Storage.Used(segment)   -- number, number &lt;- string
1899
</Documentation>
1900
        <Parameters>
1901
          <Parameter Name="segment">
1902
            <Documentation>The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.</Documentation>
1903
          </Parameter>
1904
        </Parameters>
1905
        <ReturnValues>
1906
          <ReturnValue Name="current">
1907
            <Documentation>Current storage space used.</Documentation>
1908
          </ReturnValue>
1909
          <ReturnValue Name="maximum">
1910
            <Documentation>Maximum storage space available.</Documentation>
1911
          </ReturnValue>
1912
        </ReturnValues>
1913
        <ReturnedMembers />
1914
      </Function>
1915
      <Function Name="Inspect.System.Language">
1916
        <Documentation>Returns the client's current language.
1917
language = Inspect.System.Language()   -- string &lt;- void
1918
</Documentation>
1919
        <Parameters />
1920
        <ReturnValues>
1921
          <ReturnValue Name="language">
1922
            <Documentation>Current language. Valid values include "English", "French", "German", "Korean", "Russian".</Documentation>
1923
          </ReturnValue>
1924
        </ReturnValues>
1925
        <ReturnedMembers />
1926
      </Function>
1927
      <Function Name="Inspect.System.Secure">
1928
        <Documentation>Returns the client's current secure mode.
1929
secure = Inspect.System.Secure()   -- boolean &lt;- void
1930
</Documentation>
1931
        <Parameters />
1932
        <ReturnValues>
1933
          <ReturnValue Name="secure">
1934
            <Documentation>The current secure mode.</Documentation>
1935
          </ReturnValue>
1936
        </ReturnValues>
1937
        <ReturnedMembers />
1938
      </Function>
1939
      <Function Name="Inspect.System.Version">
1940
        <Documentation>Returns information on the client version.
1941
version = Inspect.System.Version()   -- table &lt;- void
1942
</Documentation>
1943
        <Parameters />
1944
        <ReturnValues>
1945
          <ReturnValue Name="version">
1946
            <Documentation>A table containing detailed version information.</Documentation>
1947
          </ReturnValue>
1948
        </ReturnValues>
1949
        <ReturnedMembers>
1950
          <ReturnedMember Name="build">
1951
            <Documentation>Client build information.</Documentation>
1952
          </ReturnedMember>
1953
          <ReturnedMember Name="external">
1954
            <Documentation>Client external version.</Documentation>
1955
          </ReturnedMember>
1956
          <ReturnedMember Name="internal">
1957
            <Documentation>Client internal version.</Documentation>
1958
          </ReturnedMember>
1959
        </ReturnedMembers>
1960
      </Function>
1961
      <Function Name="Inspect.TEMPORARY.Role">
1962
        <Documentation>Returns the ID of the player's current role.
1963
This function will be removed in the future.
1964
role = Inspect.TEMPORARY.Role()   -- number &lt;- void
1965
</Documentation>
1966
        <Parameters />
1967
        <ReturnValues>
1968
          <ReturnValue Name="role">
1969
            <Documentation>The ID of the player's current role.</Documentation>
1970
          </ReturnValue>
1971
        </ReturnValues>
1972
        <ReturnedMembers />
1973
      </Function>
1974
      <Function Name="Inspect.Time.Frame">
1975
        <Documentation>The game time of the last frame. This function's return value will not change until the next frame.
1976
time = Inspect.Time.Frame()   -- number &lt;- void
1977
</Documentation>
1978
        <Parameters />
1979
        <ReturnValues>
1980
          <ReturnValue Name="time">
1981
            <Documentation>Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.</Documentation>
1982
          </ReturnValue>
1983
        </ReturnValues>
1984
        <ReturnedMembers />
1985
      </Function>
1986
      <Function Name="Inspect.Time.Real">
1987
        <Documentation>A high-resolution realtime timer. Not measured in the same timespace as Inspect.Time.Frame.
1988
time = Inspect.Time.Real()   -- number &lt;- void
1989
</Documentation>
1990
        <Parameters />
1991
        <ReturnValues>
1992
          <ReturnValue Name="time">
1993
            <Documentation>Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.</Documentation>
1994
          </ReturnValue>
1995
        </ReturnValues>
1996
        <ReturnedMembers />
1997
      </Function>
1998
      <Function Name="Inspect.Tooltip">
1999
        <Documentation>Returns the current contents of the tooltip.
2000
type, shown = Inspect.Tooltip()   -- nil, nil &lt;- void
2001
type, shown = Inspect.Tooltip()   -- string, variant &lt;- void
2002
type, unit, buff = Inspect.Tooltip()   -- string, unit, buff &lt;- void
2003
</Documentation>
2004
        <Parameters />
2005
        <ReturnValues>
2006
          <ReturnValue Name="buff">
2007
            <Documentation>The ID of the tooltip's buff.</Documentation>
2008
          </ReturnValue>
2009
          <ReturnValue Name="shown">
2010
            <Documentation>The blob describing what is currently shown. Generally, some kind of identifier used in another part of the addon system.</Documentation>
2011
          </ReturnValue>
2012
          <ReturnValue Name="type">
2013
            <Documentation>The current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".</Documentation>
2014
          </ReturnValue>
2015
          <ReturnValue Name="unit">
2016
            <Documentation>The unit that the buff is attached to.</Documentation>
2017
          </ReturnValue>
2018
        </ReturnValues>
2019
        <ReturnedMembers />
2020
      </Function>
2021
      <Function Name="Inspect.Unit.Castbar">
2022
        <Documentation>Provides detailed information about a unit's castbar.
2023
detail = Inspect.Unit.Castbar(unit)   -- table &lt;- unit
2024
details = Inspect.Unit.Castbar(units)   -- table &lt;- table
2025
</Documentation>
2026
        <Parameters>
2027
          <Parameter Name="unit">
2028
            <Documentation>A unit, in either unit ID or unit specifier format.</Documentation>
2029
          </Parameter>
2030
          <Parameter Name="units">
2031
            <Documentation>A lookup table containing units to inspect.</Documentation>
2032
          </Parameter>
2033
        </Parameters>
2034
        <ReturnValues>
2035
          <ReturnValue Name="detail">
2036
            <Documentation>Detail table for a single castbar.</Documentation>
2037
          </ReturnValue>
2038
          <ReturnValue Name="details">
2039
            <Documentation>Detail tables for all requested castbars. The key is the unit ID or unit specifier, the value is the castbar's detail table.</Documentation>
2040
          </ReturnValue>
2041
        </ReturnValues>
2042
        <ReturnedMembers>
2043
          <ReturnedMember Name="ability">
2044
            <Documentation>ID of the ability being cast, if available.</Documentation>
2045
          </ReturnedMember>
2046
          <ReturnedMember Name="abilityName">
2047
            <Documentation>Name of the ability being cast.</Documentation>
2048
          </ReturnedMember>
2049
          <ReturnedMember Name="begin">
2050
            <Documentation>The time the cast started, in the context of Inspect.Time.Frame.</Documentation>
2051
          </ReturnedMember>
2052
          <ReturnedMember Name="channeled">
2053
            <Documentation>True if this ability is channeled.</Documentation>
2054
          </ReturnedMember>
2055
          <ReturnedMember Name="duration">
2056
            <Documentation>Duration of the cast in seconds.</Documentation>
2057
          </ReturnedMember>
2058
          <ReturnedMember Name="expired">
2059
            <Documentation>Number of the seconds the cast is past its completion time. Generally indicates lag.</Documentation>
2060
          </ReturnedMember>
2061
          <ReturnedMember Name="remaining">
2062
            <Documentation>Time remaining on the cast, in seconds.</Documentation>
2063
          </ReturnedMember>
2064
          <ReturnedMember Name="uninterruptible">
2065
            <Documentation>Signals that the cast is not interruptible.</Documentation>
2066
          </ReturnedMember>
2067
        </ReturnedMembers>
2068
      </Function>
2069
      <Function Name="Inspect.Unit.Detail">
2070
        <Documentation>Provides detailed information about a unit.
2071
detail = Inspect.Unit.Detail(unit)   -- table &lt;- unit
2072
details = Inspect.Unit.Detail(units)   -- table &lt;- table
2073
</Documentation>
2074
        <Parameters>
2075
          <Parameter Name="unit">
2076
            <Documentation>A unit, in either unit ID or unit specifier format.</Documentation>
2077
          </Parameter>
2078
          <Parameter Name="units">
2079
            <Documentation>A lookup table containing units to inspect.</Documentation>
2080
          </Parameter>
2081
        </Parameters>
2082
        <ReturnValues>
2083
          <ReturnValue Name="detail">
2084
            <Documentation>Detail table for a single unit.</Documentation>
2085
          </ReturnValue>
2086
          <ReturnValue Name="details">
2087
            <Documentation>Detail tables for all requested units. The key is the unit ID or unit specifier, the value is the unit's detail table.</Documentation>
2088
          </ReturnValue>
2089
        </ReturnValues>
2090
        <ReturnedMembers>
2091
          <ReturnedMember Name="afk">
2092
            <Documentation>Signals that the unit is AFK. Provided only for the player and the player's groupmembers.</Documentation>
2093
          </ReturnedMember>
2094
          <ReturnedMember Name="aggro">
2095
            <Documentation>Signals that this unit is being attacked. Provided only for groupmembers.</Documentation>
2096
          </ReturnedMember>
2097
          <ReturnedMember Name="alliance">
2098
            <Documentation>The unit's alliance. "defiant", "guardian", or nil.</Documentation>
2099
          </ReturnedMember>
2100
          <ReturnedMember Name="blocked">
2101
            <Documentation>Signals that this unit is not in line of sight. Provided only for groupmembers.</Documentation>
2102
          </ReturnedMember>
2103
          <ReturnedMember Name="calling">
2104
            <Documentation>The unit's calling. May be "mage", "rogue", "cleric", or "warrior".</Documentation>
2105
          </ReturnedMember>
2106
          <ReturnedMember Name="charge">
2107
            <Documentation>The unit's charge. Provided only for the player.</Documentation>
2108
          </ReturnedMember>
2109
          <ReturnedMember Name="chargeMax">
2110
            <Documentation>The unit's maximum charge. Provided only for the player.</Documentation>
2111
          </ReturnedMember>
2112
          <ReturnedMember Name="combat">
2113
            <Documentation>The unit's combat status.</Documentation>
2114
          </ReturnedMember>
2115
          <ReturnedMember Name="combo">
2116
            <Documentation>The unit's combo points. Provided only for the player.</Documentation>
2117
          </ReturnedMember>
2118
          <ReturnedMember Name="comboUnit">
2119
            <Documentation>The Unit ID of the unit that the combo points have been placed on. Provided only for the player.</Documentation>
2120
          </ReturnedMember>
2121
          <ReturnedMember Name="coordX">
2122
            <Documentation>The unit's current X coordinate.</Documentation>
2123
          </ReturnedMember>
2124
          <ReturnedMember Name="coordY">
2125
            <Documentation>The unit's current Y coordinate.</Documentation>
2126
          </ReturnedMember>
2127
          <ReturnedMember Name="coordZ">
2128
            <Documentation>The unit's current Z coordinate.</Documentation>
2129
          </ReturnedMember>
2130
          <ReturnedMember Name="energy">
2131
            <Documentation>The unit's energy.</Documentation>
2132
          </ReturnedMember>
2133
          <ReturnedMember Name="energyMax">
2134
            <Documentation>The unit's maximum energy.</Documentation>
2135
          </ReturnedMember>
2136
          <ReturnedMember Name="factionId">
2137
            <Documentation>The unit's faction ID.</Documentation>
2138
          </ReturnedMember>
2139
          <ReturnedMember Name="guaranteedLoot">
2140
            <Documentation>Signals that this unit guarantees loot on death. Shown in the user interface as a diamond above the portrait.</Documentation>
2141
          </ReturnedMember>
2142
          <ReturnedMember Name="guild">
2143
            <Documentation>The unit's guild.</Documentation>
2144
          </ReturnedMember>
2145
          <ReturnedMember Name="health">
2146
            <Documentation>The unit's health.</Documentation>
2147
          </ReturnedMember>
2148
          <ReturnedMember Name="healthCap">
2149
            <Documentation>The unit's capped maximum health.</Documentation>
2150
          </ReturnedMember>
2151
          <ReturnedMember Name="healthMax">
2152
            <Documentation>The unit's maximum health.</Documentation>
2153
          </ReturnedMember>
2154
          <ReturnedMember Name="id">
2155
            <Documentation>The ID of the requested element.</Documentation>
2156
          </ReturnedMember>
2157
          <ReturnedMember Name="level">
2158
            <Documentation>The unit's level. May be "??" if the unit is hostile and very high-level.</Documentation>
2159
          </ReturnedMember>
2160
          <ReturnedMember Name="locationName">
2161
            <Documentation>The name of the unit's location. Provided only for friendly players.</Documentation>
2162
          </ReturnedMember>
2163
          <ReturnedMember Name="loot">
2164
            <Documentation>The Unit ID that has looting rights to this corpse.</Documentation>
2165
          </ReturnedMember>
2166
          <ReturnedMember Name="mana">
2167
            <Documentation>The unit's mana.</Documentation>
2168
          </ReturnedMember>
2169
          <ReturnedMember Name="manaMax">
2170
            <Documentation>The unit's maximum mana.</Documentation>
2171
          </ReturnedMember>
2172
          <ReturnedMember Name="mark">
2173
            <Documentation>The mark on this unit.</Documentation>
2174
          </ReturnedMember>
2175
          <ReturnedMember Name="name">
2176
            <Documentation>The unit's name.</Documentation>
2177
          </ReturnedMember>
2178
          <ReturnedMember Name="nameSecondary">
2179
            <Documentation>The unit's secondary name.</Documentation>
2180
          </ReturnedMember>
2181
          <ReturnedMember Name="offline">
2182
            <Documentation>Signals that the unit is offline. Provided only for the player's groupmembers.</Documentation>
2183
          </ReturnedMember>
2184
          <ReturnedMember Name="planar">
2185
            <Documentation>The unit's available planar charges. Provided only for the player or groupmembers.</Documentation>
2186
          </ReturnedMember>
2187
          <ReturnedMember Name="planarMax">
2188
            <Documentation>The unit's maximum planar charges. Provided only for the player or groupmembers.</Documentation>
2189
          </ReturnedMember>
2190
          <ReturnedMember Name="player">
2191
            <Documentation>Signals that the unit is a player, not an NPC.</Documentation>
2192
          </ReturnedMember>
2193
          <ReturnedMember Name="power">
2194
            <Documentation>The unit's power.</Documentation>
2195
          </ReturnedMember>
2196
          <ReturnedMember Name="publicSize">
2197
            <Documentation>The unit's current public group size. nil if the group is not public. Provided only for friendly players.</Documentation>
2198
          </ReturnedMember>
2199
          <ReturnedMember Name="pvp">
2200
            <Documentation>The unit's PvP flag.</Documentation>
2201
          </ReturnedMember>
2202
          <ReturnedMember Name="race">
2203
            <Documentation>The unit's race. Provided only for players.</Documentation>
2204
          </ReturnedMember>
2205
          <ReturnedMember Name="raceName">
2206
            <Documentation>The unit's race, localized. Provided only for players.</Documentation>
2207
          </ReturnedMember>
2208
          <ReturnedMember Name="radius">
2209
            <Documentation>The unit's radius.</Documentation>
2210
          </ReturnedMember>
2211
          <ReturnedMember Name="ready">
2212
            <Documentation>The unit's readycheck status.</Documentation>
2213
          </ReturnedMember>
2214
          <ReturnedMember Name="relation">
2215
            <Documentation>The unit's relation to you. May be "hostile" or "friendly". Neutral targets will not have this member.</Documentation>
2216
          </ReturnedMember>
2217
          <ReturnedMember Name="role">
2218
            <Documentation>The unit's role. May be "tank", "heal", "dps", "support", or nil. Provided only for the player and the player's groupmembers.</Documentation>
2219
          </ReturnedMember>
2220
          <ReturnedMember Name="tag">
2221
            <Documentation>The unit's tags, space-separated.</Documentation>
2222
          </ReturnedMember>
2223
          <ReturnedMember Name="tagName">
2224
            <Documentation>The unit's tags, localized.</Documentation>
2225
          </ReturnedMember>
2226
          <ReturnedMember Name="tagged">
2227
            <Documentation>The unit's tagged status. true if the unit has been tagged by you, "other" if the unit has been tagged by someone else.</Documentation>
2228
          </ReturnedMember>
2229
          <ReturnedMember Name="tier">
2230
            <Documentation>The unit's difficulty tier. nil, "group", or "raid".</Documentation>
2231
          </ReturnedMember>
2232
          <ReturnedMember Name="titlePrefixId">
2233
            <Documentation>The unit's title prefix ID.</Documentation>
2234
          </ReturnedMember>
2235
          <ReturnedMember Name="titlePrefixName">
2236
            <Documentation>The unit's localized title prefix.</Documentation>
2237
          </ReturnedMember>
2238
          <ReturnedMember Name="titleSuffixId">
2239
            <Documentation>The unit's title suffix ID.</Documentation>
2240
          </ReturnedMember>
2241
          <ReturnedMember Name="titleSuffixName">
2242
            <Documentation>The unit's localized title suffix.</Documentation>
2243
          </ReturnedMember>
2244
          <ReturnedMember Name="type">
2245
            <Documentation>The unit type ID.</Documentation>
2246
          </ReturnedMember>
2247
          <ReturnedMember Name="vitality">
2248
            <Documentation>The unit's vitality. Provided only for the player or groupmembers.</Documentation>
2249
          </ReturnedMember>
2250
          <ReturnedMember Name="warfront">
2251
            <Documentation>Signals that the unit has temporarily left the group to join a warfront. Provided only for groupmembers.</Documentation>
2252
          </ReturnedMember>
2253
          <ReturnedMember Name="zone">
2254
            <Documentation>The ID of the unit's current zone.</Documentation>
2255
          </ReturnedMember>
2256
        </ReturnedMembers>
2257
      </Function>
2258
      <Function Name="Inspect.Unit.List">
2259
        <Documentation>Lists all the units that the client can see.
2260
list = Inspect.Unit.List()   -- table &lt;- void
2261
</Documentation>
2262
        <Parameters />
2263
        <ReturnValues>
2264
          <ReturnValue Name="list">
2265
            <Documentation>Map of unit ID to unit specifier. Units with multiple valid specifiers will have one chosen at random.</Documentation>
2266
          </ReturnValue>
2267
        </ReturnValues>
2268
        <ReturnedMembers />
2269
      </Function>
2270
      <Function Name="Inspect.Unit.Lookup">
2271
        <Documentation>Converts unit IDs to unit specifiers and vice-versa.
2272
unit = Inspect.Unit.Lookup(unit)   -- unit &lt;- unit
2273
units = Inspect.Unit.Lookup(units)   -- table &lt;- table
2274
</Documentation>
2275
        <Parameters>
2276
          <Parameter Name="unit">
2277
            <Documentation>A single unit ID or unit specifier.</Documentation>
2278
          </Parameter>
2279
          <Parameter Name="units">
2280
            <Documentation>A lookup table containing unit IDs and unit specifiers.</Documentation>
2281
          </Parameter>
2282
        </Parameters>
2283
        <ReturnValues>
2284
          <ReturnValue Name="unit">
2285
            <Documentation>A unit ID or unit specifier, whichever is the opposite of the parameter given. May be nil.</Documentation>
2286
          </ReturnValue>
2287
          <ReturnValue Name="units">
2288
            <Documentation>A lookup table of unit IDs and unit specifiers. The key is the input, the value is the result. Invalid inputs will not result in output entries.</Documentation>
2289
          </ReturnValue>
2290
        </ReturnValues>
2291
        <ReturnedMembers />
2292
      </Function>
2293
      <Function Name="Inspect.Zone.Detail">
2294
        <Documentation>Returns information about zones.
2295
detail = Inspect.Zone.Detail(zone)   -- table &lt;- zone
2296
details = Inspect.Zone.Detail(zones)   -- table &lt;- table
2297
</Documentation>
2298
        <Parameters>
2299
          <Parameter Name="zone">
2300
            <Documentation>The identifier of the zone to retrieve detail for.</Documentation>
2301
          </Parameter>
2302
          <Parameter Name="zones">
2303
            <Documentation>A lookup table of identifiers of zones to retrieve detail for.</Documentation>
2304
          </Parameter>
2305
        </Parameters>
2306
        <ReturnValues>
2307
          <ReturnValue Name="detail">
2308
            <Documentation>Detail table for a single zone.</Documentation>
2309
          </ReturnValue>
2310
          <ReturnValue Name="details">
2311
            <Documentation>Detail tables for all requested zones. The key is the zone ID, the value is the zone's detail table.</Documentation>
2312
          </ReturnValue>
2313
        </ReturnValues>
2314
        <ReturnedMembers>
2315
          <ReturnedMember Name="id">
2316
            <Documentation>The ID of the requested element.</Documentation>
2317
          </ReturnedMember>
2318
          <ReturnedMember Name="name">
2319
            <Documentation>The name of the zone.</Documentation>
2320
          </ReturnedMember>
2321
          <ReturnedMember Name="type">
2322
            <Documentation>The type of this zone. May be either "instance", "warfront", or nil.</Documentation>
2323
          </ReturnedMember>
2324
        </ReturnedMembers>
2325
      </Function>
2326
    </Functions>
2327
  </Section>
2328
  <Section Name="Commands:">
2329
    <Functions>
2330
      <Function Name="Command.Auction.Bid">
2331
        <Documentation>Bids on an auction.
2332
This function consumes a hardware event to function. Hardware events include MouseDown, MouseUp, and Wheel operations.
2333
Requires the "auction" interaction flag to be set.
2334
Command.Auction.Bid(auction, bid)   -- auction, number
2335
Command.Auction.Bid(auction, bid, callback)   -- auction, number, callbackfunction
2336
</Documentation>
2337
        <Parameters>
2338
          <Parameter Name="auction">
2339
            <Documentation>The auction to be targeted.</Documentation>
2340
          </Parameter>
2341
          <Parameter Name="bid">
2342
            <Documentation>The amount to bid. To place a buyout, simply bid the buyout value.</Documentation>
2343
          </Parameter>
2344
          <Parameter Name="callback">
2345
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2346
          </Parameter>
2347
        </Parameters>
2348
        <ReturnValues />
2349
        <ReturnedMembers />
2350
      </Function>
2351
      <Function Name="Command.Auction.Cancel">
2352
        <Documentation>Cancels an auction.
2353
This function consumes a hardware event to function. Hardware events include MouseDown, MouseUp, and Wheel operations.
2354
Requires the "auction" interaction flag to be set.
2355
Command.Auction.Cancel(auction)   -- auction
2356
Command.Auction.Cancel(auction, callback)   -- auction, callbackfunction
2357
</Documentation>
2358
        <Parameters>
2359
          <Parameter Name="auction">
2360
            <Documentation>The auction to be targeted.</Documentation>
2361
          </Parameter>
2362
          <Parameter Name="callback">
2363
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2364
          </Parameter>
2365
        </Parameters>
2366
        <ReturnValues />
2367
        <ReturnedMembers />
2368
      </Function>
2369
      <Function Name="Command.Auction.Post">
2370
        <Documentation>Posts a new auction.
2371
Requires the "auction" interaction flag to be set.
2372
This function is subject to the "global" command queue.
2373
Command.Auction.Post(item, time, bid, buyout)   -- item, number, number, number/nil
2374
Command.Auction.Post(item, time, bid, buyout, callback)   -- item, number, number, number/nil, callbackfunction
2375
</Documentation>
2376
        <Parameters>
2377
          <Parameter Name="bid">
2378
            <Documentation>The minimum bid for the new auction, in silver.</Documentation>
2379
          </Parameter>
2380
          <Parameter Name="buyout">
2381
            <Documentation>The buyout for the new auction, in silver. nil if no buyout is desired.</Documentation>
2382
          </Parameter>
2383
          <Parameter Name="callback">
2384
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2385
          </Parameter>
2386
          <Parameter Name="item">
2387
            <Documentation>The ID of the item to be auctioned.</Documentation>
2388
          </Parameter>
2389
          <Parameter Name="time">
2390
            <Documentation>The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.</Documentation>
2391
          </Parameter>
2392
        </Parameters>
2393
        <ReturnValues />
2394
        <ReturnedMembers />
2395
      </Function>
2396
      <Function Name="Command.Auction.Scan">
2397
        <Documentation>Requests an auction house scan. If "index" is omitted then this function will error if the "auctionfullscan" queue is not ready. Otherwise, this function is subject to the "global" command queue.
2398
This function consumes a hardware event to function. Hardware events include MouseDown, MouseUp, and Wheel operations.
2399
Requires the "auction" interaction flag to be set.
2400
Command.Auction.Scan(parameters)   -- table
2401
</Documentation>
2402
        <Parameters>
2403
          <Parameter Name="parameters">
2404
            <Documentation>Table containing data about the requested scan.</Documentation>
2405
          </Parameter>
2406
          <Parameter Name="category">
2407
            <Documentation> Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional.</Documentation>
2408
          </Parameter>
2409
          <Parameter Name="index">
2410
            <Documentation> Numeric item index to start the scan at. If provided, the auction scan will return the first 50 items immediately following this index.</Documentation>
2411
          </Parameter>
2412
          <Parameter Name="levelMax">
2413
            <Documentation> Maximum level the item must require. Optional.</Documentation>
2414
          </Parameter>
2415
          <Parameter Name="levelMin">
2416
            <Documentation> Minimum level the item must require. Optional.</Documentation>
2417
          </Parameter>
2418
          <Parameter Name="priceMax">
2419
            <Documentation> Maximum price of the item. Optional.</Documentation>
2420
          </Parameter>
2421
          <Parameter Name="priceMin">
2422
            <Documentation> Minimum price of the item. Optional.</Documentation>
2423
          </Parameter>
2424
          <Parameter Name="rarity">
2425
            <Documentation> The minimum rarity to search for. Same as the "rarity" member returned by Inspect.Item.Detail(). Optional.</Documentation>
2426
          </Parameter>
2427
          <Parameter Name="role">
2428
            <Documentation> The role that the item must be compatible with. One of "mage", "rogue", "cleric", or "warrior". Optional.</Documentation>
2429
          </Parameter>
2430
          <Parameter Name="sort">
2431
            <Documentation> Which column the requested items should be sorted based on. One of "rarity", "name", "level", "time", "seller", "pricePerUnit", "bid", "buyout", "stack". Optional.</Documentation>
2432
          </Parameter>
2433
          <Parameter Name="sortOrder">
2434
            <Documentation> What order to sort in. One of "ascending" or "descending". Optional.</Documentation>
2435
          </Parameter>
2436
          <Parameter Name="text">
2437
            <Documentation> A string to search for in the item name. Optional.</Documentation>
2438
          </Parameter>
2439
          <Parameter Name="type">
2440
            <Documentation> Type of scan to perform. One of "search", "mine", or "bids". If "mine" or "bids", must be the only member in the table.</Documentation>
2441
          </Parameter>
2442
        </Parameters>
2443
        <ReturnValues />
2444
        <ReturnedMembers />
2445
      </Function>
2446
      <Function Name="Command.Buff.Cancel">
2447
        <Documentation>Cancels a buff on the player. Not all buffs are cancelable.
2448
This function is subject to the "global" command queue.
2449
Command.Buff.Cancel(buff)   -- buff
2450
</Documentation>
2451
        <Parameters>
2452
          <Parameter Name="buff">
2453
            <Documentation>The ID of the buff to cancel.</Documentation>
2454
          </Parameter>
2455
        </Parameters>
2456
        <ReturnValues />
2457
        <ReturnedMembers />
2458
      </Function>
2459
      <Function Name="Command.Buff.Describe">
2460
        <Documentation>Requests a detailed description for a given buff.
2461
This function is subject to the "global" command queue.
2462
Command.Buff.Describe(unit, buff)   -- unit, buff
2463
</Documentation>
2464
        <Parameters>
2465
          <Parameter Name="buff">
2466
            <Documentation>The ID of the buff to describe.</Documentation>
2467
          </Parameter>
2468
          <Parameter Name="unit">
2469
            <Documentation>The ID of the unit that the buff is on.</Documentation>
2470
          </Parameter>
2471
        </Parameters>
2472
        <ReturnValues />
2473
        <ReturnedMembers />
2474
      </Function>
2475
      <Function Name="Command.Cursor">
2476
        <Documentation>Changes the contents of the cursor. Ability cursors may be set only if the environment is not in secure mode.
2477
Command.Cursor(hold)   -- variant
2478
</Documentation>
2479
        <Parameters>
2480
          <Parameter Name="hold">
2481
            <Documentation>The new cursor. Currently accepts ability, item, or itemtype IDs. Pass nil to clear the cursor.</Documentation>
2482
          </Parameter>
2483
        </Parameters>
2484
        <ReturnValues />
2485
        <ReturnedMembers />
2486
      </Function>
2487
      <Function Name="Command.Item.Destroy">
2488
        <Documentation>Destroys an item. Be careful: this really does destroy an item. There is no confirmation dialog and the process is irreversible. This cannot destroy items directly out of the guild bank.
2489
If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
2490
This function is subject to the "global" command queue.
2491
Command.Item.Destroy(target)   -- item
2492
</Documentation>
2493
        <Parameters>
2494
          <Parameter Name="target">
2495
            <Documentation>The item ID of the item to destroy.</Documentation>
2496
          </Parameter>
2497
        </Parameters>
2498
        <ReturnValues />
2499
        <ReturnedMembers />
2500
      </Function>
2501
      <Function Name="Command.Item.Move">
2502
        <Documentation>Moves an item from one location to another. This cannot move items directly between equipment, wardrobe, or guild bank - you'll have to stop off in the inventory first.
2503
If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
2504
This function is subject to the "global" command queue.
2505
Command.Item.Move(source, destination)   -- item, slot
2506
Command.Item.Move(source, destination)   -- slot, slot
2507
</Documentation>
2508
        <Parameters>
2509
          <Parameter Name="destination">
2510
            <Documentation>The location to move the item. May attempt to stack or swap if there is already an item here.</Documentation>
2511
          </Parameter>
2512
          <Parameter Name="source">
2513
            <Documentation>The item to move. Must be a slot specifier that refers to an actual item.</Documentation>
2514
          </Parameter>
2515
        </Parameters>
2516
        <ReturnValues />
2517
        <ReturnedMembers />
2518
      </Function>
2519
      <Function Name="Command.Item.Split">
2520
        <Documentation>Splits a number of items off a stack.
2521
If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
2522
This function is subject to the "global" command queue.
2523
Command.Item.Split(source, stack)   -- item, number
2524
Command.Item.Split(source, stack)   -- slot, number
2525
</Documentation>
2526
        <Parameters>
2527
          <Parameter Name="source">
2528
            <Documentation>The item to split. May be a slot specifier or an item ID.</Documentation>
2529
          </Parameter>
2530
          <Parameter Name="stack">
2531
            <Documentation>The number of items to move into the new stack. Must be a positive integer.</Documentation>
2532
          </Parameter>
2533
        </Parameters>
2534
        <ReturnValues />
2535
        <ReturnedMembers />
2536
      </Function>
2537
      <Function Name="Command.Mail.Delete">
2538
        <Documentation>Deletes a mail.
2539
Requires the "mail" interaction flag to be set.
2540
This function is subject to the "global" command queue.
2541
Command.Mail.Delete(mail)   -- mail
2542
Command.Mail.Delete(mail, callback)   -- mail, callbackfunction
2543
</Documentation>
2544
        <Parameters>
2545
          <Parameter Name="callback">
2546
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2547
          </Parameter>
2548
          <Parameter Name="mail">
2549
            <Documentation>The ID of the mail to be targeted.</Documentation>
2550
          </Parameter>
2551
        </Parameters>
2552
        <ReturnValues />
2553
        <ReturnedMembers />
2554
      </Function>
2555
      <Function Name="Command.Mail.Open">
2556
        <Documentation>Opens a mail, retrieving detailed information for it.
2557
Requires the "mail" interaction flag to be set.
2558
This function is subject to the "global" command queue.
2559
Command.Mail.Open(mail)   -- mail
2560
Command.Mail.Open(mail, callback)   -- mail, callbackfunction
2561
</Documentation>
2562
        <Parameters>
2563
          <Parameter Name="callback">
2564
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2565
          </Parameter>
2566
          <Parameter Name="mail">
2567
            <Documentation>The ID of the mail to be targeted.</Documentation>
2568
          </Parameter>
2569
        </Parameters>
2570
        <ReturnValues />
2571
        <ReturnedMembers />
2572
      </Function>
2573
      <Function Name="Command.Mail.Pay">
2574
        <Documentation>Pays the COD fee on a mail.
2575
Requires the "mail" interaction flag to be set.
2576
This function is subject to the "global" command queue.
2577
Command.Mail.Pay(mail)   -- mail
2578
Command.Mail.Pay(mail, callback)   -- mail, callbackfunction
2579
</Documentation>
2580
        <Parameters>
2581
          <Parameter Name="callback">
2582
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2583
          </Parameter>
2584
          <Parameter Name="mail">
2585
            <Documentation>The ID of the mail to be targeted.</Documentation>
2586
          </Parameter>
2587
        </Parameters>
2588
        <ReturnValues />
2589
        <ReturnedMembers />
2590
      </Function>
2591
      <Function Name="Command.Mail.Return">
2592
        <Documentation>Returns a mail to its sender.
2593
Requires the "mail" interaction flag to be set.
2594
This function is subject to the "global" command queue.
2595
Command.Mail.Return(mail)   -- mail
2596
Command.Mail.Return(mail, callback)   -- mail, callbackfunction
2597
</Documentation>
2598
        <Parameters>
2599
          <Parameter Name="callback">
2600
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2601
          </Parameter>
2602
          <Parameter Name="mail">
2603
            <Documentation>The ID of the mail to be targeted.</Documentation>
2604
          </Parameter>
2605
        </Parameters>
2606
        <ReturnValues />
2607
        <ReturnedMembers />
2608
      </Function>
2609
      <Function Name="Command.Mail.Send">
2610
        <Documentation>Sends mail.
2611
This function consumes a hardware event to function. Hardware events include MouseDown, MouseUp, and Wheel operations.
2612
Requires the "mail" interaction flag to be set.
2613
Command.Mail.Send(mail)   -- table
2614
Command.Mail.Send(mail, callback)   -- table, callbackfunction
2615
</Documentation>
2616
        <Parameters>
2617
          <Parameter Name="callback">
2618
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2619
          </Parameter>
2620
          <Parameter Name="mail">
2621
            <Documentation>Table containing data about the mail to send.</Documentation>
2622
          </Parameter>
2623
          <Parameter Name="to">
2624
            <Documentation> The name of the player to send mail to. Required.</Documentation>
2625
          </Parameter>
2626
          <Parameter Name="subject">
2627
            <Documentation> The mail's subject. Required.</Documentation>
2628
          </Parameter>
2629
          <Parameter Name="body">
2630
            <Documentation> The mail's body.</Documentation>
2631
          </Parameter>
2632
          <Parameter Name="cod">
2633
            <Documentation> The money required for the recipient to remove attachments. Mutually exclusive with "coin", requires non-empty "attachments".</Documentation>
2634
          </Parameter>
2635
          <Parameter Name="coin">
2636
            <Documentation> The amount of money attached to this message. Mutually exclusive with "cod".</Documentation>
2637
          </Parameter>
2638
          <Parameter Name="attachments">
2639
            <Documentation> A table listing the item IDs of the items you wish to attach. Maximum of 6.</Documentation>
2640
          </Parameter>
2641
        </Parameters>
2642
        <ReturnValues />
2643
        <ReturnedMembers />
2644
      </Function>
2645
      <Function Name="Command.Mail.Spam">
2646
        <Documentation>Marks mail as spam.
2647
Requires the "mail" interaction flag to be set.
2648
This function is subject to the "global" command queue.
2649
Command.Mail.Spam(mail)   -- mail
2650
Command.Mail.Spam(mail, callback)   -- mail, callbackfunction
2651
</Documentation>
2652
        <Parameters>
2653
          <Parameter Name="callback">
2654
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2655
          </Parameter>
2656
          <Parameter Name="mail">
2657
            <Documentation>The ID of the mail to be targeted.</Documentation>
2658
          </Parameter>
2659
        </Parameters>
2660
        <ReturnValues />
2661
        <ReturnedMembers />
2662
      </Function>
2663
      <Function Name="Command.Mail.Take">
2664
        <Documentation>Takes an attached item from mail.
2665
Requires the "mail" interaction flag to be set.
2666
This function is subject to the "global" command queue.
2667
Command.Mail.Take(mail, item)   -- mail, item
2668
Command.Mail.Take(mail, item, callback)   -- mail, item, callbackfunction
2669
</Documentation>
2670
        <Parameters>
2671
          <Parameter Name="callback">
2672
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2673
          </Parameter>
2674
          <Parameter Name="item">
2675
            <Documentation>The ID of the item to be taken.</Documentation>
2676
          </Parameter>
2677
          <Parameter Name="mail">
2678
            <Documentation>The ID of the mail to be targeted.</Documentation>
2679
          </Parameter>
2680
        </Parameters>
2681
        <ReturnValues />
2682
        <ReturnedMembers />
2683
      </Function>
2684
      <Function Name="Command.Map.Monitor">
2685
        <Documentation>Controls the state of the map monitor flag. When enabled, mainmap data will be received, updating every sixty seconds. When disabled, mainmap data will be received only when the built-in map window is open.
2686
Command.Map.Monitor(monitor)   -- boolean
2687
</Documentation>
2688
        <Parameters>
2689
          <Parameter Name="monitor">
2690
            <Documentation>The new state of the map monitor flag.</Documentation>
2691
          </Parameter>
2692
        </Parameters>
2693
        <ReturnValues />
2694
        <ReturnedMembers />
2695
      </Function>
2696
      <Function Name="Command.Message.Accept">
2697
        <Documentation>Sets the environment to accept a given type and identifier of message. Parameters can be replaced with "nil" to act as a wildcard.
2698
Command.Message.Accept(type, identifier)   -- string/nil, string/nil
2699
</Documentation>
2700
        <Parameters>
2701
          <Parameter Name="identifier">
2702
            <Documentation>The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.</Documentation>
2703
          </Parameter>
2704
          <Parameter Name="type">
2705
            <Documentation>The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".</Documentation>
2706
          </Parameter>
2707
        </Parameters>
2708
        <ReturnValues />
2709
        <ReturnedMembers />
2710
      </Function>
2711
      <Function Name="Command.Message.Broadcast">
2712
        <Documentation>Broadcast an unreliable addon message to some number of targets. This message will be dropped silently if the targets do not have the available bandwidth to receive it. The callback will respond with failure only if the message's target is invalid. "tell" messages are subject to the same restrictions as Command.Message.Send(). This command is throttled by the "message" throttle type.
2713
Command.Message.Broadcast(type, target, identifier, data)   -- string, string/nil, string, string
2714
Command.Message.Broadcast(type, target, identifier, data, callback)   -- string, string/nil, string, string, callbackfunction
2715
</Documentation>
2716
        <Parameters>
2717
          <Parameter Name="callback">
2718
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2719
          </Parameter>
2720
          <Parameter Name="data">
2721
            <Documentation>The data to send. This parameter is binary-safe.</Documentation>
2722
          </Parameter>
2723
          <Parameter Name="identifier">
2724
            <Documentation>The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.</Documentation>
2725
          </Parameter>
2726
          <Parameter Name="target">
2727
            <Documentation>The target of this message. Required for "channel" or "tell" message types, must be nil otherwise.</Documentation>
2728
          </Parameter>
2729
          <Parameter Name="type">
2730
            <Documentation>The type of message to send. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell".</Documentation>
2731
          </Parameter>
2732
        </Parameters>
2733
        <ReturnValues />
2734
        <ReturnedMembers />
2735
      </Function>
2736
      <Function Name="Command.Message.Reject">
2737
        <Documentation>Sets the environment to reject a given type and identifier of message. Directly cancels out single calls to Command.Message.Accept.
2738
Command.Message.Reject(type, identifier)   -- string/nil, string/nil
2739
</Documentation>
2740
        <Parameters>
2741
          <Parameter Name="identifier">
2742
            <Documentation>The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.</Documentation>
2743
          </Parameter>
2744
          <Parameter Name="type">
2745
            <Documentation>The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".</Documentation>
2746
          </Parameter>
2747
        </Parameters>
2748
        <ReturnValues />
2749
        <ReturnedMembers />
2750
      </Function>
2751
      <Function Name="Command.Message.Send">
2752
        <Documentation>Send an reliable addon message to a single target.  The callback will respond with success only once the server has accepted the message for processing and queueing. Failure may occur if the target is invalid or if the target's receive queue is full. Messages may be sent only to players that are nearby, in your guild, in your party or raid, or that have sent you a message or tell during this session. This command is throttled by the "message" throttle type.
2753
Command.Message.Send(target, identifier, data, callback)   -- string, string, string, callbackfunction
2754
</Documentation>
2755
        <Parameters>
2756
          <Parameter Name="callback">
2757
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2758
          </Parameter>
2759
          <Parameter Name="data">
2760
            <Documentation>The data to send. This parameter is binary-safe.</Documentation>
2761
          </Parameter>
2762
          <Parameter Name="identifier">
2763
            <Documentation>The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.</Documentation>
2764
          </Parameter>
2765
          <Parameter Name="target">
2766
            <Documentation>The name of the player to send the message to.</Documentation>
2767
          </Parameter>
2768
        </Parameters>
2769
        <ReturnValues />
2770
        <ReturnedMembers />
2771
      </Function>
2772
      <Function Name="Command.Quest.Abandon">
2773
        <Documentation>Abandons the given quest. Permitted only on personal quests.
2774
This function is subject to the "global" command queue.
2775
Command.Quest.Abandon(quest)   -- quest
2776
</Documentation>
2777
        <Parameters>
2778
          <Parameter Name="quest">
2779
            <Documentation>The quest to be affected.</Documentation>
2780
          </Parameter>
2781
        </Parameters>
2782
        <ReturnValues />
2783
        <ReturnedMembers />
2784
      </Function>
2785
      <Function Name="Command.Quest.Share">
2786
        <Documentation>Shares the given quest. Permitted only on personal quests.
2787
This function consumes a hardware event to function. Hardware events include MouseDown, MouseUp, and Wheel operations.
2788
Command.Quest.Share(quest)   -- quest
2789
</Documentation>
2790
        <Parameters>
2791
          <Parameter Name="quest">
2792
            <Documentation>The quest to be affected.</Documentation>
2793
          </Parameter>
2794
        </Parameters>
2795
        <ReturnValues />
2796
        <ReturnedMembers />
2797
      </Function>
2798
      <Function Name="Command.Quest.Track">
2799
        <Documentation>Tracks the current quest, un-tracking any other quest that may be tracked. Pass in "nil" to cancel all tracking. Permitted only on personal quests.
2800
Command.Quest.Track(quest)   -- quest
2801
Command.Quest.Track(nil)   -- nil
2802
</Documentation>
2803
        <Parameters>
2804
          <Parameter Name="nil">
2805
            <Documentation>The value "nil".</Documentation>
2806
          </Parameter>
2807
          <Parameter Name="quest">
2808
            <Documentation>The quest to be affected.</Documentation>
2809
          </Parameter>
2810
        </Parameters>
2811
        <ReturnValues />
2812
        <ReturnedMembers />
2813
      </Function>
2814
      <Function Name="Command.Quest.Watch">
2815
        <Documentation>Watches a quest, possibly unwatching another quest if the player is already watching the maximum quest count. Permitted only on personal quests.
2816
Command.Quest.Watch(quest, flag)   -- quest, boolean
2817
</Documentation>
2818
        <Parameters>
2819
          <Parameter Name="flag">
2820
            <Documentation>The new watch status.</Documentation>
2821
          </Parameter>
2822
          <Parameter Name="quest">
2823
            <Documentation>The quest to be affected.</Documentation>
2824
          </Parameter>
2825
        </Parameters>
2826
        <ReturnValues />
2827
        <ReturnedMembers />
2828
      </Function>
2829
      <Function Name="Command.Queue.Handler">
2830
        <Documentation>Sets the queue handler function. The queue handler function will be called when a Command.* function is called which relies on a queue for throttling and that queue is full. This function will be passed (queue, owner, func, ...). queue: The identifier of the queue that this function call will wait on. owner: The identifier of the addon that made the function call. func: The function call that has been queued. ...: The argument list that must be passed to func.
2831
Command.Queue.Handler(handler)   -- function
2832
</Documentation>
2833
        <Parameters>
2834
          <Parameter Name="handler">
2835
            <Documentation>The new queue handler.</Documentation>
2836
          </Parameter>
2837
        </Parameters>
2838
        <ReturnValues />
2839
        <ReturnedMembers />
2840
      </Function>
2841
      <Function Name="Command.Slash.Register">
2842
        <Documentation>Registers a new chat slash command, inserts a new event table into the Event.Slash hierarchy, and returns that table. If called multiple times with the same slash command, will return the same table each time.
2843
eventTable = Command.Slash.Register(slashCommand)   -- table &lt;- string
2844
</Documentation>
2845
        <Parameters>
2846
          <Parameter Name="slashCommand">
2847
            <Documentation>The name of the slash command to register.</Documentation>
2848
          </Parameter>
2849
        </Parameters>
2850
        <ReturnValues>
2851
          <ReturnValue Name="eventTable">
2852
            <Documentation>The event table for your slash command. nil if the slash command could not be registered (usually because it conflicts with a built-in slash command.) Will return the same event table if used twice to register the same slash command.</Documentation>
2853
          </ReturnValue>
2854
        </ReturnValues>
2855
        <ReturnedMembers />
2856
      </Function>
2857
      <Function Name="Command.Storage.Clear">
2858
        <Documentation>Remove an element from a storage segment. If accessing guild storage, you will need write access to that element, as well as the Delete from Guild Addon Storage permission. This command is throttled by the "storage" throttle type.
2859
Command.Storage.Clear(segment, identifier, callback)   -- string, string, callbackfunction
2860
</Documentation>
2861
        <Parameters>
2862
          <Parameter Name="callback">
2863
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2864
          </Parameter>
2865
          <Parameter Name="identifier">
2866
            <Documentation>The identifier of the storage bucket. Must be at least three characters long.</Documentation>
2867
          </Parameter>
2868
          <Parameter Name="segment">
2869
            <Documentation>The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.</Documentation>
2870
          </Parameter>
2871
        </Parameters>
2872
        <ReturnValues />
2873
        <ReturnedMembers />
2874
      </Function>
2875
      <Function Name="Command.Storage.Get">
2876
        <Documentation>Gets a specific element from a target's storage. The result will be sent to Event.Storage.Get. This command is throttled by the "storage" throttle type on both the client and server.
2877
Command.Storage.Get(target, segment, identifier, callback)   -- string, string, string, callbackfunction
2878
</Documentation>
2879
        <Parameters>
2880
          <Parameter Name="callback">
2881
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2882
          </Parameter>
2883
          <Parameter Name="identifier">
2884
            <Documentation>The identifier of the storage bucket. Must be at least three characters long.</Documentation>
2885
          </Parameter>
2886
          <Parameter Name="segment">
2887
            <Documentation>The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.</Documentation>
2888
          </Parameter>
2889
          <Parameter Name="target">
2890
            <Documentation>The name of the player whose storage should be accessed. Will work only on players in your guild, players in your group, or players that the addon unit system is aware of.</Documentation>
2891
          </Parameter>
2892
        </Parameters>
2893
        <ReturnValues />
2894
        <ReturnedMembers />
2895
      </Function>
2896
      <Function Name="Command.Storage.List">
2897
        <Documentation>Lists the visible elements in a target's storage. The results will be sent to Event.Storage.List. This command is throttled by the "storage" throttle type.
2898
Command.Storage.List(target, segment, callback)   -- string, string, callbackfunction
2899
</Documentation>
2900
        <Parameters>
2901
          <Parameter Name="callback">
2902
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2903
          </Parameter>
2904
          <Parameter Name="segment">
2905
            <Documentation>The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.</Documentation>
2906
          </Parameter>
2907
          <Parameter Name="target">
2908
            <Documentation>The name of the player whose storage should be accessed. Will work only on players in your guild, players in your group, or players that the addon unit system is aware of.</Documentation>
2909
          </Parameter>
2910
        </Parameters>
2911
        <ReturnValues />
2912
        <ReturnedMembers />
2913
      </Function>
2914
      <Function Name="Command.Storage.Set">
2915
        <Documentation>Sets a storage element.  If accessing guild storage, you will need the Write to Guild Addon Storage permission. If replacing an existing element, you will also need write access to that element as well as the Delete from Guild Addon Storage permission. You cannot create an element that you cannot read, nor can you create an element with Officer write permissions if you are not an Officer. This command is throttled by the "storage" throttle type.
2916
Command.Storage.Set(segment, identifier, read, write, data, callback)   -- string, string, string, string, string, callbackfunction
2917
</Documentation>
2918
        <Parameters>
2919
          <Parameter Name="callback">
2920
            <Documentation>A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.</Documentation>
2921
          </Parameter>
2922
          <Parameter Name="data">
2923
            <Documentation>The data to store. This parameter is binary-safe.</Documentation>
2924
          </Parameter>
2925
          <Parameter Name="identifier">
2926
            <Documentation>The identifier of the storage bucket. Must be at least three characters long.</Documentation>
2927
          </Parameter>
2928
          <Parameter Name="read">
2929
            <Documentation>Read permissions for this element. If the segment is "player", this may be "public", "guild", or "private", where public is readable by anyone, guild is readable by your guildmembers only, and private is readable by the player only. If the segment is "guild", this may be "public", "guild", or "officer", where public is readable by anyone, guild is readable by guildmembers with the Listen permission, and officer is readable by guildmembers with the Officer Chat permission.</Documentation>
2930
          </Parameter>
2931
          <Parameter Name="segment">
2932
            <Documentation>The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.</Documentation>
2933
          </Parameter>
2934
          <Parameter Name="write">
2935
            <Documentation>Write permissions for this element. If the segment is "player", this must be "private", as only you may modify your own storage. If the segment is "guild", this may be "guild" or "officer", where guild is changeable by guildmembers with the Delete from Guild Addon Storage permission, and officer is changeable by guildmembers with the Delete from Guild Addon Storage permission and the Officer Chat permission. The write permission must be "officer" if the read permission is "officer".</Documentation>
2936
          </Parameter>
2937
        </Parameters>
2938
        <ReturnValues />
2939
        <ReturnedMembers />
2940
      </Function>
2941
      <Function Name="Command.System.Flash">
2942
        <Documentation>Controls the flashing of the Rift taskbar icon.
2943
Command.System.Flash(flash)   -- boolean
2944
</Documentation>
2945
        <Parameters>
2946
          <Parameter Name="flash">
2947
            <Documentation>Whether the taskbar icon should flash or not.</Documentation>
2948
          </Parameter>
2949
        </Parameters>
2950
        <ReturnValues />
2951
        <ReturnedMembers />
2952
      </Function>
2953
      <Function Name="Command.System.Strict">
2954
        <Documentation>Changes the displayed tooltip.
2955
Command.Tooltip(target)   -- variant
2956
Command.Tooltip(target, nil)   -- variant, nil
2957
Command.Tooltip(owner, buff)   -- unit, buff
2958
</Documentation>
2959
        <Parameters>
2960
          <Parameter Name="buff">
2961
            <Documentation>The ID of a buff for the new tooltip.</Documentation>
2962
          </Parameter>
2963
          <Parameter Name="nil">
2964
            <Documentation>Optional placeholder nil.</Documentation>
2965
          </Parameter>
2966
          <Parameter Name="owner">
2967
            <Documentation>The ID of the owner of the buff.</Documentation>
2968
          </Parameter>
2969
          <Parameter Name="target">
2970
            <Documentation>The new tooltip. Currently accepts ability, item, itemtype, or unit IDs. Pass nil to clear the tooltip.</Documentation>
2971
          </Parameter>
2972
        </Parameters>
2973
        <ReturnValues />
2974
        <ReturnedMembers />
2975
      </Function>
2976
      <Function Name="Command.Unit.Menu">
2977
        <Documentation>Creates a standard context menu targeted at the unit of choice.
2978
Command.Unit.Menu(target)   -- unit
2979
</Documentation>
2980
        <Parameters>
2981
          <Parameter Name="target">
2982
            <Documentation>The unit to generate a context menu for.</Documentation>
2983
          </Parameter>
2984
        </Parameters>
2985
        <ReturnValues />
2986
        <ReturnedMembers />
2987
      </Function>
2988
    </Functions>
2989
  </Section>
2990
  <Section Name="Utilities:">
2991
    <Functions>
2992
      <Function Name="Utility.Auction.Cost">
2993
        <Documentation>Returns the amount of silver it will cost to post a given auction.
2994
cost = Utility.Auction.Cost(item, time, bid, buyout)   -- number &lt;- item, number, number, number/nil
2995
</Documentation>
2996
        <Parameters>
2997
          <Parameter Name="bid">
2998
            <Documentation>The minimum bid for the new auction, in silver.</Documentation>
2999
          </Parameter>
3000
          <Parameter Name="buyout">
3001
            <Documentation>The buyout for the new auction, in silver. nil if no buyout is desired.</Documentation>
3002
          </Parameter>
3003
          <Parameter Name="item">
3004
            <Documentation>The ID of the item to be auctioned.</Documentation>
3005
          </Parameter>
3006
          <Parameter Name="time">
3007
            <Documentation>The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.</Documentation>
3008
          </Parameter>
3009
        </Parameters>
3010
        <ReturnValues>
3011
          <ReturnValue Name="cost">
3012
            <Documentation>The cost of posting this auction, in silver.</Documentation>
3013
          </ReturnValue>
3014
        </ReturnValues>
3015
        <ReturnedMembers />
3016
      </Function>
3017
      <Function Name="Utility.Dispatch">
3018
        <Documentation>Calls a function, crediting that function's execution and errors to a specific addon. Errors will be handled by the standard error handler and not relayed to the caller. Does not return anything.
3019
Utility.Dispatch(func, identifier, info)   -- function, string, string
3020
</Documentation>
3021
        <Parameters>
3022
          <Parameter Name="func">
3023
            <Documentation>The function to call.</Documentation>
3024
          </Parameter>
3025
          <Parameter Name="identifier">
3026
            <Documentation>The identifier of the addon to credit execution time towards.</Documentation>
3027
          </Parameter>
3028
          <Parameter Name="info">
3029
            <Documentation>An info string to be included in error reports.</Documentation>
3030
          </Parameter>
3031
        </Parameters>
3032
        <ReturnValues />
3033
        <ReturnedMembers />
3034
      </Function>
3035
      <Function Name="Utility.Event.Create">
3036
        <Documentation>Creates a custom event. Takes an identifier and an event path as parameters. Called with Create("Identifier", "The.Event.Path") the event table will end up at Event.Identifier.The.Event.Path, and will behave like a standard Rift event table in every way. Undefined behavior if given an identifier or a path that conflicts with a built-in Rift event or an existing addon event.
3037
handle, event = Utility.Event.Create(identifier, event)   -- function, table &lt;- string, string
3038
</Documentation>
3039
        <Parameters>
3040
          <Parameter Name="event">
3041
            <Documentation>The event's name. "." characters will be treated as hierarchy delimeters.</Documentation>
3042
          </Parameter>
3043
          <Parameter Name="identifier">
3044
            <Documentation>The identifier of the addon creating this event.</Documentation>
3045
          </Parameter>
3046
        </Parameters>
3047
        <ReturnValues>
3048
          <ReturnValue Name="event">
3049
            <Documentation>The resulting event table.</Documentation>
3050
          </ReturnValue>
3051
          <ReturnValue Name="handle">
3052
            <Documentation>A handle used to trigger the event. Called with any selection of parameters, it will pass those parameters through to properly registered event handlers in order. Any errors caused by those event handlers will be caught and handled.</Documentation>
3053
          </ReturnValue>
3054
        </ReturnValues>
3055
        <ReturnedMembers />
3056
      </Function>
3057
      <Function Name="Utility.Item.Slot.All">
3058
        <Documentation>Generates a slot specifier for all known items.
3059
slot = Utility.Item.Slot.All()   -- slot &lt;- void
3060
</Documentation>
3061
        <Parameters />
3062
        <ReturnValues>
3063
          <ReturnValue Name="slot">
3064
            <Documentation>The requested slot specifier.</Documentation>
3065
          </ReturnValue>
3066
        </ReturnValues>
3067
        <ReturnedMembers />
3068
      </Function>
3069
      <Function Name="Utility.Item.Slot.Bank">
3070
        <Documentation>Generates a slot specifier for the player's bank.
3071
slot = Utility.Item.Slot.Bank()   -- slot &lt;- void
3072
slot = Utility.Item.Slot.Bank(segment)   -- slot &lt;- string
3073
slot = Utility.Item.Slot.Bank(segment)   -- slot &lt;- number
3074
slot = Utility.Item.Slot.Bank(segment, slot)   -- slot &lt;- string, number
3075
slot = Utility.Item.Slot.Bank(segment, slot)   -- slot &lt;- number, number
3076
</Documentation>
3077
        <Parameters>
3078
          <Parameter Name="segment">
3079
            <Documentation>Segment to inspect. Use "main" for the main bank area, "bag" for the bank bags, or a number starting at 1 for the contents of a specific bank bag.</Documentation>
3080
          </Parameter>
3081
          <Parameter Name="slot">
3082
            <Documentation>The slot ID, starting at 1.</Documentation>
3083
          </Parameter>
3084
        </Parameters>
3085
        <ReturnValues>
3086
          <ReturnValue Name="slot">
3087
            <Documentation>The requested slot specifier.</Documentation>
3088
          </ReturnValue>
3089
        </ReturnValues>
3090
        <ReturnedMembers />
3091
      </Function>
3092
      <Function Name="Utility.Item.Slot.Equipment">
3093
        <Documentation>Generates a slot specifier for the player's equipment.
3094
slot = Utility.Item.Slot.Equipment()   -- slot &lt;- void
3095
slot = Utility.Item.Slot.Equipment(slot)   -- slot &lt;- string
3096
</Documentation>
3097
        <Parameters>
3098
          <Parameter Name="slot">
3099
            <Documentation>The equipment slot to be used. Can be any of the following</Documentation>
3100
          </Parameter>
3101
        </Parameters>
3102
        <ReturnValues>
3103
          <ReturnValue Name="slot">
3104
            <Documentation>The requested slot specifier.</Documentation>
3105
          </ReturnValue>
3106
        </ReturnValues>
3107
        <ReturnedMembers />
3108
      </Function>
3109
      <Function Name="Utility.Item.Slot.Guild">
3110
        <Documentation>Generates a slot specifier for the player's guild bank.
3111
slot = Utility.Item.Slot.Guild()   -- slot &lt;- void
3112
slot = Utility.Item.Slot.Guild(vault)   -- slot &lt;- number
3113
slot = Utility.Item.Slot.Guild(vault, slot)   -- slot &lt;- number, number
3114
</Documentation>
3115
        <Parameters>
3116
          <Parameter Name="slot">
3117
            <Documentation>The slot ID, starting at 1.</Documentation>
3118
          </Parameter>
3119
          <Parameter Name="vault">
3120
            <Documentation>The vault ID to inspect. Starts at 1.</Documentation>
3121
          </Parameter>
3122
        </Parameters>
3123
        <ReturnValues>
3124
          <ReturnValue Name="slot">
3125
            <Documentation>The requested slot specifier.</Documentation>
3126
          </ReturnValue>
3127
        </ReturnValues>
3128
        <ReturnedMembers />
3129
      </Function>
3130
      <Function Name="Utility.Item.Slot.Inventory">
3131
        <Documentation>Generates a slot specifier for the player's inventory.
3132
slot = Utility.Item.Slot.Inventory()   -- slot &lt;- void
3133
slot = Utility.Item.Slot.Inventory(bag)   -- slot &lt;- string
3134
slot = Utility.Item.Slot.Inventory(bag)   -- slot &lt;- number
3135
slot = Utility.Item.Slot.Inventory(bag, slot)   -- slot &lt;- string, number
3136
slot = Utility.Item.Slot.Inventory(bag, slot)   -- slot &lt;- number, number
3137
</Documentation>
3138
        <Parameters>
3139
          <Parameter Name="bag">
3140
            <Documentation>The number of the bag whose contents should be inspected, starting at 1, or "bag" to inspect the actual inventory bags.</Documentation>
3141
          </Parameter>
3142
          <Parameter Name="slot">
3143
            <Documentation>The slot ID, starting at 1.</Documentation>
3144
          </Parameter>
3145
        </Parameters>
3146
        <ReturnValues>
3147
          <ReturnValue Name="slot">
3148
            <Documentation>The requested slot specifier.</Documentation>
3149
          </ReturnValue>
3150
        </ReturnValues>
3151
        <ReturnedMembers />
3152
      </Function>
3153
      <Function Name="Utility.Item.Slot.Parse">
3154
        <Documentation>Parses a slot specifier, returning information on what it represents.
3155
type, parameter, parameter = Utility.Item.Slot.Parse(slot)   -- string, variant, variant &lt;- slot
3156
type, parameter = Utility.Item.Slot.Parse(slot)   -- string, variant &lt;- slot
3157
type = Utility.Item.Slot.Parse(slot)   -- string &lt;- slot
3158
Utility.Item.Slot.Parse(slot)   -- slot
3159
</Documentation>
3160
        <Parameters>
3161
          <Parameter Name="slot">
3162
            <Documentation>The slot ID, starting at 1.</Documentation>
3163
          </Parameter>
3164
        </Parameters>
3165
        <ReturnValues>
3166
          <ReturnValue Name="parameter">
3167
            <Documentation>A parameter for this slot type. Actual meaning depends on the type.</Documentation>
3168
          </ReturnValue>
3169
          <ReturnValue Name="type">
3170
            <Documentation>The type of this element.</Documentation>
3171
          </ReturnValue>
3172
        </ReturnValues>
3173
        <ReturnedMembers />
3174
      </Function>
3175
      <Function Name="Utility.Item.Slot.Quest">
3176
        <Documentation>Generates a slot specifier for the player's quest bag.
3177
slot = Utility.Item.Slot.Quest()   -- slot &lt;- void
3178
slot = Utility.Item.Slot.Quest(slot)   -- slot &lt;- number
3179
</Documentation>
3180
        <Parameters>
3181
          <Parameter Name="slot">
3182
            <Documentation>The slot ID, starting at 1.</Documentation>
3183
          </Parameter>
3184
        </Parameters>
3185
        <ReturnValues>
3186
          <ReturnValue Name="slot">
3187
            <Documentation>The requested slot specifier.</Documentation>
3188
          </ReturnValue>
3189
        </ReturnValues>
3190
        <ReturnedMembers />
3191
      </Function>
3192
      <Function Name="Utility.Item.Slot.Wardrobe">
3193
        <Documentation>Generates a slot specifier for the player's wardrobe.
3194
slot = Utility.Item.Slot.Wardrobe()   -- slot &lt;- void
3195
slot = Utility.Item.Slot.Wardrobe(costume)   -- slot &lt;- number
3196
slot = Utility.Item.Slot.Wardrobe(costume, slot)   -- slot &lt;- number, string
3197
</Documentation>
3198
        <Parameters>
3199
          <Parameter Name="costume">
3200
            <Documentation>The number of the wardrobe costume to inspect, starting at 1.</Documentation>
3201
          </Parameter>
3202
          <Parameter Name="slot">
3203
            <Documentation>The equipment slot to be used. Can be any of the following</Documentation>
3204
          </Parameter>
3205
        </Parameters>
3206
        <ReturnValues>
3207
          <ReturnValue Name="slot">
3208
            <Documentation>The requested slot specifier.</Documentation>
3209
          </ReturnValue>
3210
        </ReturnValues>
3211
        <ReturnedMembers />
3212
      </Function>
3213
      <Function Name="Utility.Mail.Cost">
3214
        <Documentation>Returns the amount of silver it will cost to send a given mail.
3215
cost = Utility.Mail.Cost(mail)   -- number &lt;- table
3216
</Documentation>
3217
        <Parameters>
3218
          <Parameter Name="mail">
3219
            <Documentation>The mail to check. In the same format as the parameter of Command.Mail.Send.</Documentation>
3220
          </Parameter>
3221
        </Parameters>
3222
        <ReturnValues>
3223
          <ReturnValue Name="cost">
3224
            <Documentation>The cost of sending this mail, in silver.</Documentation>
3225
          </ReturnValue>
3226
        </ReturnValues>
3227
        <ReturnedMembers />
3228
      </Function>
3229
      <Function Name="Utility.Message.Limits">
3230
        <Documentation>Returns information on the message bandwidth limits.
3231
data = Utility.Message.Limits()   -- table &lt;- void
3232
</Documentation>
3233
        <Parameters />
3234
        <ReturnValues>
3235
          <ReturnValue Name="data">
3236
            <Documentation>The requested data.</Documentation>
3237
          </ReturnValue>
3238
        </ReturnValues>
3239
        <ReturnedMembers>
3240
          <ReturnedMember Name="burst">
3241
            <Documentation>The amount of data that can be sent or received without being subject to throttling.</Documentation>
3242
          </ReturnedMember>
3243
          <ReturnedMember Name="maximum">
3244
            <Documentation>Maximum allowed message size.</Documentation>
3245
          </ReturnedMember>
3246
          <ReturnedMember Name="sustained">
3247
            <Documentation>Amount of data that can be transferred per second without dropping messages.</Documentation>
3248
          </ReturnedMember>
3249
        </ReturnedMembers>
3250
      </Function>
3251
      <Function Name="Utility.Message.Size">
3252
        <Documentation>Returns the size of a message, as used for bandwidth control.
3253
size = Utility.Message.Size(to, identifier, data)   -- number &lt;- string/nil, string, string
3254
</Documentation>
3255
        <Parameters>
3256
          <Parameter Name="data">
3257
            <Documentation>The data to send. This parameter is binary-safe.</Documentation>
3258
          </Parameter>
3259
          <Parameter Name="identifier">
3260
            <Documentation>The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.</Documentation>
3261
          </Parameter>
3262
          <Parameter Name="to">
3263
            <Documentation>The name of the player or channel to send to. nil if this is not targeted at a specific player or channel.</Documentation>
3264
          </Parameter>
3265
        </Parameters>
3266
        <ReturnValues>
3267
          <ReturnValue Name="size">
3268
            <Documentation>The calculated size of the message.</Documentation>
3269
          </ReturnValue>
3270
        </ReturnValues>
3271
        <ReturnedMembers />
3272
      </Function>
3273
      <Function Name="Utility.Serialize.Full">
3274
        <Documentation>Serializes a table of parameters. Results in a string suitable for feeding directly into loadstring(). Deals properly with table cycles and non-tree structures.
3275
serialized = Utility.Serialize.Full(elements)   -- string &lt;- table
3276
serialized = Utility.Serialize.Full(elements, exists)   -- string &lt;- table, table
3277
</Documentation>
3278
        <Parameters>
3279
          <Parameter Name="elements">
3280
            <Documentation>Table of elements to serialize.</Documentation>
3281
          </Parameter>
3282
          <Parameter Name="exists">
3283
            <Documentation>Optional parameter containing a lookup table of elements that should be included even in the case that they are nil.</Documentation>
3284
          </Parameter>
3285
        </Parameters>
3286
        <ReturnValues>
3287
          <ReturnValue Name="serialized">
3288
            <Documentation>String containing serialized output. May be nil if there was an error with the input.</Documentation>
3289
          </ReturnValue>
3290
        </ReturnValues>
3291
        <ReturnedMembers />
3292
      </Function>
3293
      <Function Name="Utility.Serialize.Inline">
3294
        <Documentation>Serializes a single parameter. Results in a string suitable for use as a parameter in Lua code. If the input is a table, it must not contain table cycles or non-tree structures.
3295
serialized = Utility.Serialize.Inline(element)   -- string &lt;- variant
3296
</Documentation>
3297
        <Parameters>
3298
          <Parameter Name="element">
3299
            <Documentation>Element to serialize.</Documentation>
3300
          </Parameter>
3301
        </Parameters>
3302
        <ReturnValues>
3303
          <ReturnValue Name="serialized">
3304
            <Documentation>String containing serialized output. May be nil if there was an error with the input.</Documentation>
3305
          </ReturnValue>
3306
        </ReturnValues>
3307
        <ReturnedMembers />
3308
      </Function>
3309
      <Function Name="Utility.Storage.Checksum">
3310
        <Documentation>Calculates the storage checksum of a string.
3311
checksum = Utility.Storage.Checksum(data)   -- string &lt;- string
3312
</Documentation>
3313
        <Parameters>
3314
          <Parameter Name="data">
3315
            <Documentation>The data to store. This parameter is binary-safe.</Documentation>
3316
          </Parameter>
3317
        </Parameters>
3318
        <ReturnValues>
3319
          <ReturnValue Name="checksum">
3320
            <Documentation>An opaque string representing the storage checksum.</Documentation>
3321
          </ReturnValue>
3322
        </ReturnValues>
3323
        <ReturnedMembers />
3324
      </Function>
3325
      <Function Name="Utility.Storage.Limits">
3326
        <Documentation>Returns information on the storage bandwidth limits.
3327
data = Utility.Storage.Limits()   -- table &lt;- void
3328
</Documentation>
3329
        <Parameters />
3330
        <ReturnValues>
3331
          <ReturnValue Name="data">
3332
            <Documentation>The requested data.</Documentation>
3333
          </ReturnValue>
3334
        </ReturnValues>
3335
        <ReturnedMembers>
3336
          <ReturnedMember Name="burst">
3337
            <Documentation>The amount of data that can be sent or received without being subject to throttling.</Documentation>
3338
          </ReturnedMember>
3339
          <ReturnedMember Name="sustained">
3340
            <Documentation>Amount of data that can be transferred per second without dropping messages.</Documentation>
3341
          </ReturnedMember>
3342
        </ReturnedMembers>
3343
      </Function>
3344
      <Function Name="Utility.Storage.Size">
3345
        <Documentation>Returns the size of a stored element, as used for storage quota and bandwidth control.
3346
size = Utility.Storage.Size(identifier, data)   -- number &lt;- string, string
3347
</Documentation>
3348
        <Parameters>
3349
          <Parameter Name="data">
3350
            <Documentation>The data to store. This parameter is binary-safe.</Documentation>
3351
          </Parameter>
3352
          <Parameter Name="identifier">
3353
            <Documentation>The identifier of the storage bucket. Must be at least three characters long.</Documentation>
3354
          </Parameter>
3355
        </Parameters>
3356
        <ReturnValues>
3357
          <ReturnValue Name="size">
3358
            <Documentation>The calculated size of the storage bucket.</Documentation>
3359
          </ReturnValue>
3360
        </ReturnValues>
3361
        <ReturnedMembers />
3362
      </Function>
3363
      <Function Name="Utility.Type">
3364
        <Documentation>Determines the type of a given item. Understands Rift-specific identifiers.
3365
type = Utility.Type(element)   -- string &lt;- variant
3366
</Documentation>
3367
        <Parameters>
3368
          <Parameter Name="element">
3369
            <Documentation>The element to check.</Documentation>
3370
          </Parameter>
3371
        </Parameters>
3372
        <ReturnValues>
3373
          <ReturnValue Name="type">
3374
            <Documentation>The type of this element.</Documentation>
3375
          </ReturnValue>
3376
        </ReturnValues>
3377
        <ReturnedMembers />
3378
      </Function>
3379
    </Functions>
3380
  </Section>
3381
  <Section Name="Native frames:">
3382
    <Functions>
3383
      <Function Name="UI.Native.Ability">
3384
        <Documentation>The World Event dialog.
3385
UI.Native.World
3386
</Documentation>
3387
        <Parameters />
3388
        <ReturnValues />
3389
        <ReturnedMembers />
3390
      </Function>
3391
    </Functions>
3392
  </Section>
3393
  <Section Name="Events:">
3394
    <Functions>
3395
      <Function Name="Event.Ability.Add">
3396
        <Documentation>Signals the addition of a player ability.
3397
Event.Ability.Add(abilities)
3398
</Documentation>
3399
        <Parameters>
3400
          <Parameter Name="abilities">
3401
            <Documentation> Lists the abilities that were added. Lookup table from ability ID to "true".</Documentation>
3402
          </Parameter>
3403
        </Parameters>
3404
        <ReturnValues />
3405
        <ReturnedMembers />
3406
      </Function>
3407
      <Function Name="Event.Ability.Cooldown.Begin">
3408
        <Documentation>Signals the start of an ability's cooldown.
3409
Event.Ability.Cooldown.Begin(cooldowns)
3410
</Documentation>
3411
        <Parameters>
3412
          <Parameter Name="cooldowns">
3413
            <Documentation> The abilities whose cooldown has been changed. The key is the ability ID, the value is the new cooldown. 0 indicates that the cooldown has finished.</Documentation>
3414
          </Parameter>
3415
        </Parameters>
3416
        <ReturnValues />
3417
        <ReturnedMembers />
3418
      </Function>
3419
      <Function Name="Event.Ability.Cooldown.End">
3420
        <Documentation>Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.
3421
Event.Ability.Cooldown.End(cooldowns)
3422
</Documentation>
3423
        <Parameters>
3424
          <Parameter Name="cooldowns">
3425
            <Documentation> The abilities whose cooldown has been changed. The key is the ability ID, the value is the new cooldown. 0 indicates that the cooldown has finished.</Documentation>
3426
          </Parameter>
3427
        </Parameters>
3428
        <ReturnValues />
3429
        <ReturnedMembers />
3430
      </Function>
3431
      <Function Name="Event.Ability.Range.False">
3432
        <Documentation>Signals a player ability exiting range from its current target.
3433
Event.Ability.Range.False(abilities)
3434
</Documentation>
3435
        <Parameters>
3436
          <Parameter Name="abilities">
3437
            <Documentation> The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.</Documentation>
3438
          </Parameter>
3439
        </Parameters>
3440
        <ReturnValues />
3441
        <ReturnedMembers />
3442
      </Function>
3443
      <Function Name="Event.Ability.Range.True">
3444
        <Documentation>Signals a player ability entering range from its current target.
3445
Event.Ability.Range.True(abilities)
3446
</Documentation>
3447
        <Parameters>
3448
          <Parameter Name="abilities">
3449
            <Documentation> The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.</Documentation>
3450
          </Parameter>
3451
        </Parameters>
3452
        <ReturnValues />
3453
        <ReturnedMembers />
3454
      </Function>
3455
      <Function Name="Event.Ability.Remove">
3456
        <Documentation>Signals the removal of a player ability.
3457
Event.Ability.Remove(abilities)
3458
</Documentation>
3459
        <Parameters>
3460
          <Parameter Name="abilities">
3461
            <Documentation> Lists the abilities that were removed. Lookup table from ability ID to "false".</Documentation>
3462
          </Parameter>
3463
        </Parameters>
3464
        <ReturnValues />
3465
        <ReturnedMembers />
3466
      </Function>
3467
      <Function Name="Event.Ability.Target">
3468
        <Documentation>Signals a player ability changing its current target.
3469
Event.Ability.Target(abilities)
3470
</Documentation>
3471
        <Parameters>
3472
          <Parameter Name="abilities">
3473
            <Documentation> The abilities whose target has changed. The key is the ability ID, the value is the new target.</Documentation>
3474
          </Parameter>
3475
        </Parameters>
3476
        <ReturnValues />
3477
        <ReturnedMembers />
3478
      </Function>
3479
      <Function Name="Event.Ability.Usable.False">
3480
        <Documentation>Signals a player ability becoming unusable.
3481
Event.Ability.Usable.False(abilities)
3482
</Documentation>
3483
        <Parameters>
3484
          <Parameter Name="abilities">
3485
            <Documentation> The abilities whose usability has changed. The key is the ability ID, the value is the new usability.</Documentation>
3486
          </Parameter>
3487
        </Parameters>
3488
        <ReturnValues />
3489
        <ReturnedMembers />
3490
      </Function>
3491
      <Function Name="Event.Ability.Usable.True">
3492
        <Documentation>Signals a player ability becoming usable.
3493
Event.Ability.Usable.True(abilities)
3494
</Documentation>
3495
        <Parameters>
3496
          <Parameter Name="abilities">
3497
            <Documentation> The abilities whose usability has changed. The key is the ability ID, the value is the new usability.</Documentation>
3498
          </Parameter>
3499
        </Parameters>
3500
        <ReturnValues />
3501
        <ReturnedMembers />
3502
      </Function>
3503
      <Function Name="Event.Achievement.Complete">
3504
        <Documentation>Signals an achievement completing.
3505
Event.Achievement.Complete(achievement)
3506
</Documentation>
3507
        <Parameters>
3508
          <Parameter Name="achievement">
3509
            <Documentation> The ID of the achievement.</Documentation>
3510
          </Parameter>
3511
        </Parameters>
3512
        <ReturnValues />
3513
        <ReturnedMembers />
3514
      </Function>
3515
      <Function Name="Event.Achievement.Update">
3516
        <Documentation>Signals a change in an achievement's information.
3517
Event.Achievement.Update(achievements)
3518
</Documentation>
3519
        <Parameters>
3520
          <Parameter Name="achievements">
3521
            <Documentation> A lookup table of the achievements, in {id = true} format.</Documentation>
3522
          </Parameter>
3523
        </Parameters>
3524
        <ReturnValues />
3525
        <ReturnedMembers />
3526
      </Function>
3527
      <Function Name="Event.Addon.Load.Begin">
3528
        <Documentation>Signals the beginning of an addon's loading sequence.
3529
Event.Addon.Load.Begin(addonidentifier)
3530
</Documentation>
3531
        <Parameters>
3532
          <Parameter Name="addonidentifier">
3533
            <Documentation> The addon's identifier.</Documentation>
3534
          </Parameter>
3535
        </Parameters>
3536
        <ReturnValues />
3537
        <ReturnedMembers />
3538
      </Function>
3539
      <Function Name="Event.Addon.Load.End">
3540
        <Documentation>Signals the end of an addon's loading sequence. At this point, that addon is fully loaded and initialized.
3541
Event.Addon.Load.End(addonidentifier)
3542
</Documentation>
3543
        <Parameters>
3544
          <Parameter Name="addonidentifier">
3545
            <Documentation> The addon's identifier.</Documentation>
3546
          </Parameter>
3547
        </Parameters>
3548
        <ReturnValues />
3549
        <ReturnedMembers />
3550
      </Function>
3551
      <Function Name="Event.Addon.SavedVariables.Load.Begin">
3552
        <Documentation>Signals the beginning of an addon's saved variable loading.
3553
Event.Addon.SavedVariables.Load.Begin(addonidentifier)
3554
</Documentation>
3555
        <Parameters>
3556
          <Parameter Name="addonidentifier">
3557
            <Documentation> The addon's identifier.</Documentation>
3558
          </Parameter>
3559
        </Parameters>
3560
        <ReturnValues />
3561
        <ReturnedMembers />
3562
      </Function>
3563
      <Function Name="Event.Addon.SavedVariables.Load.End">
3564
        <Documentation>Signals the end of an addon's saved variable load.
3565
Event.Addon.SavedVariables.Load.End(addonidentifier)
3566
</Documentation>
3567
        <Parameters>
3568
          <Parameter Name="addonidentifier">
3569
            <Documentation> The addon's identifier.</Documentation>
3570
          </Parameter>
3571
        </Parameters>
3572
        <ReturnValues />
3573
        <ReturnedMembers />
3574
      </Function>
3575
      <Function Name="Event.Addon.SavedVariables.Save.Begin">
3576
        <Documentation>Signals the beginning of an addon's saved variable saving.
3577
Event.Addon.SavedVariables.Save.Begin(addonidentifier)
3578
</Documentation>
3579
        <Parameters>
3580
          <Parameter Name="addonidentifier">
3581
            <Documentation> The addon's identifier.</Documentation>
3582
          </Parameter>
3583
        </Parameters>
3584
        <ReturnValues />
3585
        <ReturnedMembers />
3586
      </Function>
3587
      <Function Name="Event.Addon.SavedVariables.Save.End">
3588
        <Documentation>Signals the end of an addon's saved variable saving.
3589
Event.Addon.SavedVariables.Save.End(addonidentifier)
3590
</Documentation>
3591
        <Parameters>
3592
          <Parameter Name="addonidentifier">
3593
            <Documentation> The addon's identifier.</Documentation>
3594
          </Parameter>
3595
        </Parameters>
3596
        <ReturnValues />
3597
        <ReturnedMembers />
3598
      </Function>
3599
      <Function Name="Event.Addon.Shutdown.Begin">
3600
        <Documentation>Signals incoming auction data.
3601
Event.Auction.Scan(type, auctions)
3602
</Documentation>
3603
        <Parameters>
3604
          <Parameter Name="type">
3605
            <Documentation> A table containing information on this scan. In the same format as the parameter to Command.Auction.Scan().</Documentation>
3606
          </Parameter>
3607
          <Parameter Name="auctions">
3608
            <Documentation> A lookup table of the auctions returned from this scan.</Documentation>
3609
          </Parameter>
3610
        </Parameters>
3611
        <ReturnValues />
3612
        <ReturnedMembers />
3613
      </Function>
3614
      <Function Name="Event.Buff.Add">
3615
        <Documentation>Signals new buffs on a unit.
3616
Event.Buff.Add(unit, buffs)
3617
</Documentation>
3618
        <Parameters>
3619
          <Parameter Name="unit">
3620
            <Documentation> The Unit ID of the unit involved.</Documentation>
3621
          </Parameter>
3622
          <Parameter Name="buffs">
3623
            <Documentation> A lookup table containing the buffs involved.</Documentation>
3624
          </Parameter>
3625
        </Parameters>
3626
        <ReturnValues />
3627
        <ReturnedMembers />
3628
      </Function>
3629
      <Function Name="Event.Buff.Change">
3630
        <Documentation>Signals a change in existing buffs on a unit.
3631
Event.Buff.Change(unit, buffs)
3632
</Documentation>
3633
        <Parameters>
3634
          <Parameter Name="unit">
3635
            <Documentation> The Unit ID of the unit involved.</Documentation>
3636
          </Parameter>
3637
          <Parameter Name="buffs">
3638
            <Documentation> A lookup table containing the buffs involved.</Documentation>
3639
          </Parameter>
3640
        </Parameters>
3641
        <ReturnValues />
3642
        <ReturnedMembers />
3643
      </Function>
3644
      <Function Name="Event.Buff.Description">
3645
        <Documentation>Signals a change in an existing buff's detailed description. Value of the key is "true" if detail is now available, "false" if it is no longer available.
3646
Event.Buff.Description(unit, buffs)
3647
</Documentation>
3648
        <Parameters>
3649
          <Parameter Name="unit">
3650
            <Documentation> The Unit ID of the unit involved.</Documentation>
3651
          </Parameter>
3652
          <Parameter Name="buffs">
3653
            <Documentation> A lookup table containing the buffs involved.</Documentation>
3654
          </Parameter>
3655
        </Parameters>
3656
        <ReturnValues />
3657
        <ReturnedMembers />
3658
      </Function>
3659
      <Function Name="Event.Buff.Remove">
3660
        <Documentation>Signals removal of buffs from a unit.
3661
Event.Buff.Remove(unit, buffs)
3662
</Documentation>
3663
        <Parameters>
3664
          <Parameter Name="unit">
3665
            <Documentation> The Unit ID of the unit involved.</Documentation>
3666
          </Parameter>
3667
          <Parameter Name="buffs">
3668
            <Documentation> A lookup table containing the buffs involved.</Documentation>
3669
          </Parameter>
3670
        </Parameters>
3671
        <ReturnValues />
3672
        <ReturnedMembers />
3673
      </Function>
3674
      <Function Name="Event.Chat.Notify">
3675
        <Documentation>Signals a screen notification. This is generally used as a warning mechanism during boss fights.
3676
Event.Chat.Notify(info)
3677
</Documentation>
3678
        <Parameters>
3679
          <Parameter Name="info">
3680
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3681
          </Parameter>
3682
        </Parameters>
3683
        <ReturnValues />
3684
        <ReturnedMembers />
3685
      </Function>
3686
      <Function Name="Event.Chat.Npc">
3687
        <Documentation>Signals an NPC speaking a line of text.
3688
Event.Chat.Npc(info)
3689
</Documentation>
3690
        <Parameters>
3691
          <Parameter Name="info">
3692
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3693
          </Parameter>
3694
        </Parameters>
3695
        <ReturnValues />
3696
        <ReturnedMembers />
3697
      </Function>
3698
      <Function Name="Event.Combat.Damage">
3699
        <Documentation>Signals damage done to a unit.
3700
Event.Combat.Damage(info)
3701
</Documentation>
3702
        <Parameters>
3703
          <Parameter Name="info">
3704
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3705
          </Parameter>
3706
        </Parameters>
3707
        <ReturnValues />
3708
        <ReturnedMembers />
3709
      </Function>
3710
      <Function Name="Event.Combat.Death">
3711
        <Documentation>Signals the death of a unit.
3712
Event.Combat.Death(info)
3713
</Documentation>
3714
        <Parameters>
3715
          <Parameter Name="info">
3716
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3717
          </Parameter>
3718
        </Parameters>
3719
        <ReturnValues />
3720
        <ReturnedMembers />
3721
      </Function>
3722
      <Function Name="Event.Combat.Dodge">
3723
        <Documentation>Signals a unit dodging an ability.
3724
Event.Combat.Dodge(info)
3725
</Documentation>
3726
        <Parameters>
3727
          <Parameter Name="info">
3728
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3729
          </Parameter>
3730
        </Parameters>
3731
        <ReturnValues />
3732
        <ReturnedMembers />
3733
      </Function>
3734
      <Function Name="Event.Combat.Heal">
3735
        <Documentation>Signals healing done to a unit.
3736
Event.Combat.Heal(info)
3737
</Documentation>
3738
        <Parameters>
3739
          <Parameter Name="info">
3740
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3741
          </Parameter>
3742
        </Parameters>
3743
        <ReturnValues />
3744
        <ReturnedMembers />
3745
      </Function>
3746
      <Function Name="Event.Combat.Immune">
3747
        <Documentation>Signals a unit resisting an ability through immunity.
3748
Event.Combat.Immune(info)
3749
</Documentation>
3750
        <Parameters>
3751
          <Parameter Name="info">
3752
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3753
          </Parameter>
3754
        </Parameters>
3755
        <ReturnValues />
3756
        <ReturnedMembers />
3757
      </Function>
3758
      <Function Name="Event.Combat.Miss">
3759
        <Documentation>Signals an ability's effect missing a unit.
3760
Event.Combat.Miss(info)
3761
</Documentation>
3762
        <Parameters>
3763
          <Parameter Name="info">
3764
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3765
          </Parameter>
3766
        </Parameters>
3767
        <ReturnValues />
3768
        <ReturnedMembers />
3769
      </Function>
3770
      <Function Name="Event.Combat.Parry">
3771
        <Documentation>Signals a unit parrying an ability.
3772
Event.Combat.Parry(info)
3773
</Documentation>
3774
        <Parameters>
3775
          <Parameter Name="info">
3776
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3777
          </Parameter>
3778
        </Parameters>
3779
        <ReturnValues />
3780
        <ReturnedMembers />
3781
      </Function>
3782
      <Function Name="Event.Combat.Resist">
3783
        <Documentation>Signals a unit resisting an ability.
3784
Event.Combat.Resist(info)
3785
</Documentation>
3786
        <Parameters>
3787
          <Parameter Name="info">
3788
            <Documentation> Detailed information table about this event, containing several named parameters.</Documentation>
3789
          </Parameter>
3790
        </Parameters>
3791
        <ReturnValues />
3792
        <ReturnedMembers />
3793
      </Function>
3794
      <Function Name="Event.Currency">
3795
        <Documentation>Signals a change in the player's available currency.
3796
Event.Currency(currencies)
3797
</Documentation>
3798
        <Parameters>
3799
          <Parameter Name="currencies">
3800
            <Documentation> New currency counts, in key/value form.</Documentation>
3801
          </Parameter>
3802
        </Parameters>
3803
        <ReturnValues />
3804
        <ReturnedMembers />
3805
      </Function>
3806
      <Function Name="Event.Cursor">
3807
        <Documentation>Signals that the cursor has changed.
3808
Event.Cursor(type, held)
3809
</Documentation>
3810
        <Parameters>
3811
          <Parameter Name="type">
3812
            <Documentation> The current cursor type. Valid values include "ability", "item", and "itemtype".</Documentation>
3813
          </Parameter>
3814
          <Parameter Name="held">
3815
            <Documentation> The blob describing the new element held. Generally, some kind of identifier used in another part of the addon system.</Documentation>
3816
          </Parameter>
3817
        </Parameters>
3818
        <ReturnValues />
3819
        <ReturnedMembers />
3820
      </Function>
3821
      <Function Name="Event.Faction.Notoriety">
3822
        <Documentation>Signals a change in the player's faction notoriety.
3823
Event.Faction.Notoriety(notoriety)
3824
</Documentation>
3825
        <Parameters>
3826
          <Parameter Name="notoriety">
3827
            <Documentation> New notoriety values, in key/value form.</Documentation>
3828
          </Parameter>
3829
        </Parameters>
3830
        <ReturnValues />
3831
        <ReturnedMembers />
3832
      </Function>
3833
      <Function Name="Event.Interaction">
3834
        <Documentation>Signals a change in available interaction types.
3835
Event.Interaction(interaction, state)
3836
</Documentation>
3837
        <Parameters>
3838
          <Parameter Name="interaction">
3839
            <Documentation> The identifier of the interaction type. May be any of "auction", "bank", "guildbank", or "mail".</Documentation>
3840
          </Parameter>
3841
          <Parameter Name="state">
3842
            <Documentation> Boolean indicating whether or not that interaction is available.</Documentation>
3843
          </Parameter>
3844
        </Parameters>
3845
        <ReturnValues />
3846
        <ReturnedMembers />
3847
      </Function>
3848
      <Function Name="Event.Item.Slot">
3849
        <Documentation>Signals that the contents of an item slot have changed.
3850
Event.Item.Slot(updates)
3851
</Documentation>
3852
        <Parameters>
3853
          <Parameter Name="updates">
3854
            <Documentation> Lookup table of changes. Key is the slot identifier, value is an item ID, false if the slot is now empty, or the string "nil" if the slot no longer exists.</Documentation>
3855
          </Parameter>
3856
        </Parameters>
3857
        <ReturnValues />
3858
        <ReturnedMembers />
3859
      </Function>
3860
      <Function Name="Event.Item.Update">
3861
        <Documentation>Signals that an item has changed.
3862
Event.Item.Update(updates)
3863
</Documentation>
3864
        <Parameters>
3865
          <Parameter Name="updates">
3866
            <Documentation> Lookup table of changes. Key is the slot identifier, value is an item ID, false if the slot is now empty, or the string "nil" if the slot no longer exists.</Documentation>
3867
          </Parameter>
3868
        </Parameters>
3869
        <ReturnValues />
3870
        <ReturnedMembers />
3871
      </Function>
3872
      <Function Name="Event.Mail">
3873
        <Documentation>Signals a change in the available mail messages.
3874
Event.Mail(mail)
3875
</Documentation>
3876
        <Parameters>
3877
          <Parameter Name="mail">
3878
            <Documentation> The changed mail messages. Takes the form of a lookup table. The key is the mail ID, the value is "basic" to indicate basic information available about a piece of mail, "detail" to indicate detailed information available, or false to indicate no information available.</Documentation>
3879
          </Parameter>
3880
        </Parameters>
3881
        <ReturnValues />
3882
        <ReturnedMembers />
3883
      </Function>
3884
      <Function Name="Event.Map.Add">
3885
        <Documentation>Signals the addition of a map element.
3886
Event.Map.Add(elements)
3887
</Documentation>
3888
        <Parameters>
3889
          <Parameter Name="elements">
3890
            <Documentation> The changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
3891
          </Parameter>
3892
        </Parameters>
3893
        <ReturnValues />
3894
        <ReturnedMembers />
3895
      </Function>
3896
      <Function Name="Event.Map.Change">
3897
        <Documentation>Signals the change of a map element, in some manner besides coordinates.
3898
Event.Map.Change(elements)
3899
</Documentation>
3900
        <Parameters>
3901
          <Parameter Name="elements">
3902
            <Documentation> The changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
3903
          </Parameter>
3904
        </Parameters>
3905
        <ReturnValues />
3906
        <ReturnedMembers />
3907
      </Function>
3908
      <Function Name="Event.Map.Detail.Coord">
3909
        <Documentation>Signals the coordinate change of a map element.
3910
Event.Map.Detail.Coord(x, y, z)
3911
</Documentation>
3912
        <Parameters>
3913
          <Parameter Name="x">
3914
            <Documentation> The new X coordinate of the changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
3915
          </Parameter>
3916
          <Parameter Name="y">
3917
            <Documentation> The new Y coordinate of the changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
3918
          </Parameter>
3919
          <Parameter Name="z">
3920
            <Documentation> The new Z coordinate of the changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
3921
          </Parameter>
3922
        </Parameters>
3923
        <ReturnValues />
3924
        <ReturnedMembers />
3925
      </Function>
3926
      <Function Name="Event.Map.Remove">
3927
        <Documentation>Signals the removal of a map element.
3928
Event.Map.Remove(elements)
3929
</Documentation>
3930
        <Parameters>
3931
          <Parameter Name="elements">
3932
            <Documentation> The changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
3933
          </Parameter>
3934
        </Parameters>
3935
        <ReturnValues />
3936
        <ReturnedMembers />
3937
      </Function>
3938
      <Function Name="Event.Message.Receive">
3939
        <Documentation>Signals the receipt of an addon message.
3940
Event.Message.Receive(from, type, channel, identifier, data)
3941
</Documentation>
3942
        <Parameters>
3943
          <Parameter Name="from">
3944
            <Documentation> The name of the player this message is from.</Documentation>
3945
          </Parameter>
3946
          <Parameter Name="type">
3947
            <Documentation> The type of this message. May be any of "send", "tell", "channel", "guild", "officer", "party", "raid", "say", or "yell".</Documentation>
3948
          </Parameter>
3949
          <Parameter Name="channel">
3950
            <Documentation> If type is "channel", the channel that this message was sent to. Otherwise, nil.</Documentation>
3951
          </Parameter>
3952
          <Parameter Name="identifier">
3953
            <Documentation> The identifier for this message.</Documentation>
3954
          </Parameter>
3955
          <Parameter Name="data">
3956
            <Documentation> The data payload for this message type.</Documentation>
3957
          </Parameter>
3958
        </Parameters>
3959
        <ReturnValues />
3960
        <ReturnedMembers />
3961
      </Function>
3962
      <Function Name="Event.Mouse.Move">
3963
        <Documentation>Signals the mouse moving.
3964
Event.Mouse.Move(x, y)
3965
</Documentation>
3966
        <Parameters>
3967
          <Parameter Name="x">
3968
            <Documentation> The mouse's new X position.</Documentation>
3969
          </Parameter>
3970
          <Parameter Name="y">
3971
            <Documentation> The mouse's new Y position.</Documentation>
3972
          </Parameter>
3973
        </Parameters>
3974
        <ReturnValues />
3975
        <ReturnedMembers />
3976
      </Function>
3977
      <Function Name="Event.Quest.Abandon">
3978
        <Documentation>Signals that a quest has been abandoned.
3979
Event.Quest.Abandon(elements)
3980
</Documentation>
3981
        <Parameters>
3982
          <Parameter Name="elements">
3983
            <Documentation> The changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
3984
          </Parameter>
3985
        </Parameters>
3986
        <ReturnValues />
3987
        <ReturnedMembers />
3988
      </Function>
3989
      <Function Name="Event.Quest.Accept">
3990
        <Documentation>Signals that a quest has been accepted.
3991
Event.Quest.Accept(elements)
3992
</Documentation>
3993
        <Parameters>
3994
          <Parameter Name="elements">
3995
            <Documentation> The changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
3996
          </Parameter>
3997
        </Parameters>
3998
        <ReturnValues />
3999
        <ReturnedMembers />
4000
      </Function>
4001
      <Function Name="Event.Quest.Change">
4002
        <Documentation>Signals that a quest has been changed in some manner, most likely progress in an objective.
4003
Event.Quest.Change(elements)
4004
</Documentation>
4005
        <Parameters>
4006
          <Parameter Name="elements">
4007
            <Documentation> The changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
4008
          </Parameter>
4009
        </Parameters>
4010
        <ReturnValues />
4011
        <ReturnedMembers />
4012
      </Function>
4013
      <Function Name="Event.Quest.Complete">
4014
        <Documentation>Signals that a quest has been completed.
4015
Event.Quest.Complete(elements)
4016
</Documentation>
4017
        <Parameters>
4018
          <Parameter Name="elements">
4019
            <Documentation> The changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
4020
          </Parameter>
4021
        </Parameters>
4022
        <ReturnValues />
4023
        <ReturnedMembers />
4024
      </Function>
4025
      <Function Name="Event.Queue.Status">
4026
        <Documentation>Signals that a queue may have left or entered the throttled state.
4027
Event.Queue.Status(id)
4028
</Documentation>
4029
        <Parameters>
4030
          <Parameter Name="id">
4031
            <Documentation> The ID of the queue affected. To get the actual new state, use Inspect.Queue.Status().</Documentation>
4032
          </Parameter>
4033
        </Parameters>
4034
        <ReturnValues />
4035
        <ReturnedMembers />
4036
      </Function>
4037
      <Function Name="Event.Slash	(category for dynamically-created events)">
4038
        <Parameters />
4039
        <ReturnValues />
4040
        <ReturnedMembers />
4041
      </Function>
4042
      <Function Name="Event.Slash.dump">
4043
        <Parameters />
4044
        <ReturnValues />
4045
        <ReturnedMembers />
4046
      </Function>
4047
      <Function Name="Event.Slash.eventlog">
4048
        <Parameters />
4049
        <ReturnValues />
4050
        <ReturnedMembers />
4051
      </Function>
4052
      <Function Name="Event.Slash.framecap">
4053
        <Parameters />
4054
        <ReturnValues />
4055
        <ReturnedMembers />
4056
      </Function>
4057
      <Function Name="Event.Slash.layout">
4058
        <Parameters />
4059
        <ReturnValues />
4060
        <ReturnedMembers />
4061
      </Function>
4062
      <Function Name="Event.Stat">
4063
        <Documentation>Signals a change in the player's stats.
4064
Event.Stat(stats)
4065
</Documentation>
4066
        <Parameters>
4067
          <Parameter Name="stats">
4068
            <Documentation> A lookup table from stat ID to stat value, containing the stats that changed.</Documentation>
4069
          </Parameter>
4070
        </Parameters>
4071
        <ReturnValues />
4072
        <ReturnedMembers />
4073
      </Function>
4074
      <Function Name="Event.Storage.Get">
4075
        <Documentation>Signals receiving storage data from a target.
4076
Event.Storage.Get(target, segment, identifier, read, write, data)
4077
</Documentation>
4078
        <Parameters>
4079
          <Parameter Name="target">
4080
            <Documentation> The name of the player that has been inspected.</Documentation>
4081
          </Parameter>
4082
          <Parameter Name="segment">
4083
            <Documentation> The segment that has been inspected, either "player" or "guild".</Documentation>
4084
          </Parameter>
4085
          <Parameter Name="identifier">
4086
            <Documentation> The identifier that was inspected.</Documentation>
4087
          </Parameter>
4088
          <Parameter Name="read">
4089
            <Documentation> The read permissions of this element. See Command.Storage.Set() for details.</Documentation>
4090
          </Parameter>
4091
          <Parameter Name="write">
4092
            <Documentation> The write permissions of this element. See Command.Storage.Set() for details.</Documentation>
4093
          </Parameter>
4094
          <Parameter Name="data">
4095
            <Documentation> The data contained in the requested element.</Documentation>
4096
          </Parameter>
4097
        </Parameters>
4098
        <ReturnValues />
4099
        <ReturnedMembers />
4100
      </Function>
4101
      <Function Name="Event.Storage.List">
4102
        <Documentation>Signals receiving a list of storage elements from a target.
4103
Event.Storage.List(target, segment, identifiers)
4104
</Documentation>
4105
        <Parameters>
4106
          <Parameter Name="target">
4107
            <Documentation> The name of the player that has been inspected.</Documentation>
4108
          </Parameter>
4109
          <Parameter Name="segment">
4110
            <Documentation> The segment that has been inspected, either "player" or "guild".</Documentation>
4111
          </Parameter>
4112
          <Parameter Name="identifiers">
4113
            <Documentation> A list of identifiers available to you, in {identifier = checksum} format.</Documentation>
4114
          </Parameter>
4115
        </Parameters>
4116
        <ReturnValues />
4117
        <ReturnedMembers />
4118
      </Function>
4119
      <Function Name="Event.System.Error">
4120
        <Documentation>Signals that an addon error has occurred. To prevent infinite loops, errors in handlers for this event may not result in further events being triggered.
4121
Event.System.Error(error)
4122
</Documentation>
4123
        <Parameters>
4124
          <Parameter Name="error">
4125
            <Documentation> Table containing error data.</Documentation>
4126
          </Parameter>
4127
        </Parameters>
4128
        <ReturnValues />
4129
        <ReturnedMembers />
4130
      </Function>
4131
      <Function Name="Event.System.Secure.Enter">
4132
        <Documentation>Signals the beginning of a frame render. This is your last chance to make UI changes for this frame.
4133
Event.System.Update.Begin()
4134
</Documentation>
4135
        <Parameters />
4136
        <ReturnValues />
4137
        <ReturnedMembers />
4138
      </Function>
4139
      <Function Name="Event.System.Update.End">
4140
        <Documentation>Signals the end of a frame render.
4141
Event.System.Update.End()
4142
</Documentation>
4143
        <Parameters />
4144
        <ReturnValues />
4145
        <ReturnedMembers />
4146
      </Function>
4147
      <Function Name="Event.TEMPORARY.Role">
4148
        <Documentation>Signals a change in the player's current role.
4149
This event will be removed in the future.
4150
Event.TEMPORARY.Role(role)
4151
</Documentation>
4152
        <Parameters>
4153
          <Parameter Name="role">
4154
            <Documentation> The ID of the new role.</Documentation>
4155
          </Parameter>
4156
        </Parameters>
4157
        <ReturnValues />
4158
        <ReturnedMembers />
4159
      </Function>
4160
      <Function Name="Event.Tooltip">
4161
        <Documentation>Signals that the tooltip has changed.
4162
Event.Tooltip(type, shown, buff)
4163
</Documentation>
4164
        <Parameters>
4165
          <Parameter Name="type">
4166
            <Documentation> The current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".</Documentation>
4167
          </Parameter>
4168
          <Parameter Name="shown">
4169
            <Documentation> The blob describing the new element shown. Generally, some kind of identifier used in another part of the addon system.</Documentation>
4170
          </Parameter>
4171
          <Parameter Name="buff">
4172
            <Documentation> The ID of the tooltip's new buff. "shown" will be a unit in this case.</Documentation>
4173
          </Parameter>
4174
        </Parameters>
4175
        <ReturnValues />
4176
        <ReturnedMembers />
4177
      </Function>
4178
      <Function Name="Event.Unit.Add">
4179
        <Documentation>Signals the addition of units to unit specifiers. Always preceded by Event.Unit.Change.Remove. Triggers for unit IDs that have been removed from the specifier tree, but may not trigger for any children of those units. You may want to use LibUnitChange instead of this event.
4180
Event.Unit.Add(units)
4181
</Documentation>
4182
        <Parameters>
4183
          <Parameter Name="units">
4184
            <Documentation> Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.</Documentation>
4185
          </Parameter>
4186
        </Parameters>
4187
        <ReturnValues />
4188
        <ReturnedMembers />
4189
      </Function>
4190
      <Function Name="Event.Unit.Available">
4191
        <Documentation>Signals the availability of Inspect.Unit.Detail.
4192
Event.Unit.Available(units)
4193
</Documentation>
4194
        <Parameters>
4195
          <Parameter Name="units">
4196
            <Documentation> Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.</Documentation>
4197
          </Parameter>
4198
        </Parameters>
4199
        <ReturnValues />
4200
        <ReturnedMembers />
4201
      </Function>
4202
      <Function Name="Event.Unit.Castbar">
4203
        <Documentation>Signals a unit's castbar changing.
4204
Event.Unit.Castbar(units)
4205
</Documentation>
4206
        <Parameters>
4207
          <Parameter Name="units">
4208
            <Documentation> Table of the units changed. Key is the unit ID, value is a castbar visibility flag.</Documentation>
4209
          </Parameter>
4210
        </Parameters>
4211
        <ReturnValues />
4212
        <ReturnedMembers />
4213
      </Function>
4214
      <Function Name="Event.Unit.Detail.Afk">
4215
        <Documentation>Signals a unit's AFK flag changing. Will trigger only for partymembers.
4216
Event.Unit.Detail.Afk(units)
4217
</Documentation>
4218
        <Parameters>
4219
          <Parameter Name="units">
4220
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4221
          </Parameter>
4222
        </Parameters>
4223
        <ReturnValues />
4224
        <ReturnedMembers />
4225
      </Function>
4226
      <Function Name="Event.Unit.Detail.Aggro">
4227
        <Documentation>Signals a unit's aggro flag changing. Will trigger only for groupmembers.
4228
Event.Unit.Detail.Aggro(units)
4229
</Documentation>
4230
        <Parameters>
4231
          <Parameter Name="units">
4232
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4233
          </Parameter>
4234
        </Parameters>
4235
        <ReturnValues />
4236
        <ReturnedMembers />
4237
      </Function>
4238
      <Function Name="Event.Unit.Detail.Blocked">
4239
        <Documentation>Signals a unit's LOS-blocked flag changing. Will trigger only for groupmembers.
4240
Event.Unit.Detail.Blocked(units)
4241
</Documentation>
4242
        <Parameters>
4243
          <Parameter Name="units">
4244
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4245
          </Parameter>
4246
        </Parameters>
4247
        <ReturnValues />
4248
        <ReturnedMembers />
4249
      </Function>
4250
      <Function Name="Event.Unit.Detail.Charge">
4251
        <Documentation>Signals a unit's charge changing. Will trigger only for the player's unit ID.
4252
Event.Unit.Detail.Charge(units)
4253
</Documentation>
4254
        <Parameters>
4255
          <Parameter Name="units">
4256
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4257
          </Parameter>
4258
        </Parameters>
4259
        <ReturnValues />
4260
        <ReturnedMembers />
4261
      </Function>
4262
      <Function Name="Event.Unit.Detail.ChargeMax">
4263
        <Documentation>Signals a unit's charge maximum changing. Will trigger only for the player's unit ID.
4264
Event.Unit.Detail.ChargeMax(units)
4265
</Documentation>
4266
        <Parameters>
4267
          <Parameter Name="units">
4268
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4269
          </Parameter>
4270
        </Parameters>
4271
        <ReturnValues />
4272
        <ReturnedMembers />
4273
      </Function>
4274
      <Function Name="Event.Unit.Detail.Combat">
4275
        <Documentation>Signals a unit's combat status changing.
4276
Event.Unit.Detail.Combat(units)
4277
</Documentation>
4278
        <Parameters>
4279
          <Parameter Name="units">
4280
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4281
          </Parameter>
4282
        </Parameters>
4283
        <ReturnValues />
4284
        <ReturnedMembers />
4285
      </Function>
4286
      <Function Name="Event.Unit.Detail.Combo">
4287
        <Documentation>Signals a unit's combo points changing. Will trigger only for the player's unit ID.
4288
Event.Unit.Detail.Combo(units)
4289
</Documentation>
4290
        <Parameters>
4291
          <Parameter Name="units">
4292
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4293
          </Parameter>
4294
        </Parameters>
4295
        <ReturnValues />
4296
        <ReturnedMembers />
4297
      </Function>
4298
      <Function Name="Event.Unit.Detail.ComboUnit">
4299
        <Documentation>Signals a unit's combo point target changing. Will trigger only for the player's unit ID.
4300
Event.Unit.Detail.ComboUnit(units)
4301
</Documentation>
4302
        <Parameters>
4303
          <Parameter Name="units">
4304
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4305
          </Parameter>
4306
        </Parameters>
4307
        <ReturnValues />
4308
        <ReturnedMembers />
4309
      </Function>
4310
      <Function Name="Event.Unit.Detail.Coord">
4311
        <Documentation>Signals a change in the unit's location.
4312
Event.Unit.Detail.Coord(x, y, z)
4313
</Documentation>
4314
        <Parameters>
4315
          <Parameter Name="x">
4316
            <Documentation> The new X coordinate of the changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
4317
          </Parameter>
4318
          <Parameter Name="y">
4319
            <Documentation> The new Y coordinate of the changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
4320
          </Parameter>
4321
          <Parameter Name="z">
4322
            <Documentation> The new Z coordinate of the changed elements. Takes the form of a lookup table. The key is the element ID.</Documentation>
4323
          </Parameter>
4324
        </Parameters>
4325
        <ReturnValues />
4326
        <ReturnedMembers />
4327
      </Function>
4328
      <Function Name="Event.Unit.Detail.Energy">
4329
        <Documentation>Signals a unit's energy changing.
4330
Event.Unit.Detail.Energy(units)
4331
</Documentation>
4332
        <Parameters>
4333
          <Parameter Name="units">
4334
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4335
          </Parameter>
4336
        </Parameters>
4337
        <ReturnValues />
4338
        <ReturnedMembers />
4339
      </Function>
4340
      <Function Name="Event.Unit.Detail.EnergyMax">
4341
        <Documentation>Signals a unit's energy maximum changing.
4342
Event.Unit.Detail.EnergyMax(units)
4343
</Documentation>
4344
        <Parameters>
4345
          <Parameter Name="units">
4346
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4347
          </Parameter>
4348
        </Parameters>
4349
        <ReturnValues />
4350
        <ReturnedMembers />
4351
      </Function>
4352
      <Function Name="Event.Unit.Detail.Guild">
4353
        <Documentation>Signals a unit's guild changing.
4354
Event.Unit.Detail.Guild(units)
4355
</Documentation>
4356
        <Parameters>
4357
          <Parameter Name="units">
4358
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4359
          </Parameter>
4360
        </Parameters>
4361
        <ReturnValues />
4362
        <ReturnedMembers />
4363
      </Function>
4364
      <Function Name="Event.Unit.Detail.Health">
4365
        <Documentation>Signals a unit's health changing.
4366
Event.Unit.Detail.Health(units)
4367
</Documentation>
4368
        <Parameters>
4369
          <Parameter Name="units">
4370
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4371
          </Parameter>
4372
        </Parameters>
4373
        <ReturnValues />
4374
        <ReturnedMembers />
4375
      </Function>
4376
      <Function Name="Event.Unit.Detail.HealthCap">
4377
        <Documentation>Signals a unit's health cap changing.
4378
Event.Unit.Detail.HealthCap(units)
4379
</Documentation>
4380
        <Parameters>
4381
          <Parameter Name="units">
4382
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4383
          </Parameter>
4384
        </Parameters>
4385
        <ReturnValues />
4386
        <ReturnedMembers />
4387
      </Function>
4388
      <Function Name="Event.Unit.Detail.HealthMax">
4389
        <Documentation>Signals a unit's health maximum changing.
4390
Event.Unit.Detail.HealthMax(units)
4391
</Documentation>
4392
        <Parameters>
4393
          <Parameter Name="units">
4394
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4395
          </Parameter>
4396
        </Parameters>
4397
        <ReturnValues />
4398
        <ReturnedMembers />
4399
      </Function>
4400
      <Function Name="Event.Unit.Detail.Level">
4401
        <Documentation>Signals a unit's level changing.
4402
Event.Unit.Detail.Level(units)
4403
</Documentation>
4404
        <Parameters>
4405
          <Parameter Name="units">
4406
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4407
          </Parameter>
4408
        </Parameters>
4409
        <ReturnValues />
4410
        <ReturnedMembers />
4411
      </Function>
4412
      <Function Name="Event.Unit.Detail.LocationName">
4413
        <Documentation>Signals a unit's location name changing.
4414
Event.Unit.Detail.LocationName(units)
4415
</Documentation>
4416
        <Parameters>
4417
          <Parameter Name="units">
4418
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4419
          </Parameter>
4420
        </Parameters>
4421
        <ReturnValues />
4422
        <ReturnedMembers />
4423
      </Function>
4424
      <Function Name="Event.Unit.Detail.Mana">
4425
        <Documentation>Signals a unit's mana changing.
4426
Event.Unit.Detail.Mana(units)
4427
</Documentation>
4428
        <Parameters>
4429
          <Parameter Name="units">
4430
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4431
          </Parameter>
4432
        </Parameters>
4433
        <ReturnValues />
4434
        <ReturnedMembers />
4435
      </Function>
4436
      <Function Name="Event.Unit.Detail.ManaMax">
4437
        <Documentation>Signals a unit's mana maximum changing.
4438
Event.Unit.Detail.ManaMax(units)
4439
</Documentation>
4440
        <Parameters>
4441
          <Parameter Name="units">
4442
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4443
          </Parameter>
4444
        </Parameters>
4445
        <ReturnValues />
4446
        <ReturnedMembers />
4447
      </Function>
4448
      <Function Name="Event.Unit.Detail.Mark">
4449
        <Documentation>Signals a unit's mark changing.
4450
Event.Unit.Detail.Mark(units)
4451
</Documentation>
4452
        <Parameters>
4453
          <Parameter Name="units">
4454
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4455
          </Parameter>
4456
        </Parameters>
4457
        <ReturnValues />
4458
        <ReturnedMembers />
4459
      </Function>
4460
      <Function Name="Event.Unit.Detail.Name">
4461
        <Documentation>Signals a unit's name changing.
4462
Event.Unit.Detail.Name(units)
4463
</Documentation>
4464
        <Parameters>
4465
          <Parameter Name="units">
4466
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4467
          </Parameter>
4468
        </Parameters>
4469
        <ReturnValues />
4470
        <ReturnedMembers />
4471
      </Function>
4472
      <Function Name="Event.Unit.Detail.Offline">
4473
        <Documentation>Signals a unit's offline flag changing. Will trigger only for partymembers.
4474
Event.Unit.Detail.Offline(units)
4475
</Documentation>
4476
        <Parameters>
4477
          <Parameter Name="units">
4478
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4479
          </Parameter>
4480
        </Parameters>
4481
        <ReturnValues />
4482
        <ReturnedMembers />
4483
      </Function>
4484
      <Function Name="Event.Unit.Detail.Planar">
4485
        <Documentation>Signals a unit's planar charges changing. Will trigger only for the player or groupmembers.
4486
Event.Unit.Detail.Planar(units)
4487
</Documentation>
4488
        <Parameters>
4489
          <Parameter Name="units">
4490
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4491
          </Parameter>
4492
        </Parameters>
4493
        <ReturnValues />
4494
        <ReturnedMembers />
4495
      </Function>
4496
      <Function Name="Event.Unit.Detail.PlanarMax">
4497
        <Documentation>Signals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers.
4498
Event.Unit.Detail.PlanarMax(units)
4499
</Documentation>
4500
        <Parameters>
4501
          <Parameter Name="units">
4502
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4503
          </Parameter>
4504
        </Parameters>
4505
        <ReturnValues />
4506
        <ReturnedMembers />
4507
      </Function>
4508
      <Function Name="Event.Unit.Detail.Power">
4509
        <Documentation>Signals a unit's power changing.
4510
Event.Unit.Detail.Power(units)
4511
</Documentation>
4512
        <Parameters>
4513
          <Parameter Name="units">
4514
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4515
          </Parameter>
4516
        </Parameters>
4517
        <ReturnValues />
4518
        <ReturnedMembers />
4519
      </Function>
4520
      <Function Name="Event.Unit.Detail.PublicSize">
4521
        <Documentation>Signals a unit's public group size or status changing.
4522
Event.Unit.Detail.PublicSize(units)
4523
</Documentation>
4524
        <Parameters>
4525
          <Parameter Name="units">
4526
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4527
          </Parameter>
4528
        </Parameters>
4529
        <ReturnValues />
4530
        <ReturnedMembers />
4531
      </Function>
4532
      <Function Name="Event.Unit.Detail.Pvp">
4533
        <Documentation>Signals a unit's PvP flag changing.
4534
Event.Unit.Detail.Pvp(units)
4535
</Documentation>
4536
        <Parameters>
4537
          <Parameter Name="units">
4538
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4539
          </Parameter>
4540
        </Parameters>
4541
        <ReturnValues />
4542
        <ReturnedMembers />
4543
      </Function>
4544
      <Function Name="Event.Unit.Detail.Ready">
4545
        <Documentation>Signals a unit's readycheck status changing.
4546
Event.Unit.Detail.Ready(units)
4547
</Documentation>
4548
        <Parameters>
4549
          <Parameter Name="units">
4550
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or the string "nil" in place of nil.</Documentation>
4551
          </Parameter>
4552
        </Parameters>
4553
        <ReturnValues />
4554
        <ReturnedMembers />
4555
      </Function>
4556
      <Function Name="Event.Unit.Detail.Role">
4557
        <Documentation>Signals a unit's role changing. Will trigger only for the player or partymembers.
4558
Event.Unit.Detail.Role(units)
4559
</Documentation>
4560
        <Parameters>
4561
          <Parameter Name="units">
4562
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4563
          </Parameter>
4564
        </Parameters>
4565
        <ReturnValues />
4566
        <ReturnedMembers />
4567
      </Function>
4568
      <Function Name="Event.Unit.Detail.Tagged">
4569
        <Documentation>Signals a unit's tagged status changing.
4570
Event.Unit.Detail.Tagged(units)
4571
</Documentation>
4572
        <Parameters>
4573
          <Parameter Name="units">
4574
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4575
          </Parameter>
4576
        </Parameters>
4577
        <ReturnValues />
4578
        <ReturnedMembers />
4579
      </Function>
4580
      <Function Name="Event.Unit.Detail.TitlePrefix">
4581
        <Documentation>Signals a unit's localized title prefix changing. This event is deprecated and should not be used.
4582
This event is deprecated and will be removed in the future. It should not be used.
4583
Event.Unit.Detail.TitlePrefix(units)
4584
</Documentation>
4585
        <Parameters>
4586
          <Parameter Name="units">
4587
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4588
          </Parameter>
4589
        </Parameters>
4590
        <ReturnValues />
4591
        <ReturnedMembers />
4592
      </Function>
4593
      <Function Name="Event.Unit.Detail.TitlePrefixId">
4594
        <Documentation>Signals a unit's title prefix ID changing.
4595
Event.Unit.Detail.TitlePrefixId(units)
4596
</Documentation>
4597
        <Parameters>
4598
          <Parameter Name="units">
4599
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4600
          </Parameter>
4601
        </Parameters>
4602
        <ReturnValues />
4603
        <ReturnedMembers />
4604
      </Function>
4605
      <Function Name="Event.Unit.Detail.TitlePrefixName">
4606
        <Documentation>Signals a unit's localized title prefix changing.
4607
Event.Unit.Detail.TitlePrefixName(units)
4608
</Documentation>
4609
        <Parameters>
4610
          <Parameter Name="units">
4611
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4612
          </Parameter>
4613
        </Parameters>
4614
        <ReturnValues />
4615
        <ReturnedMembers />
4616
      </Function>
4617
      <Function Name="Event.Unit.Detail.TitleSuffix">
4618
        <Documentation>Signals a unit's localized title suffix changing. This event is deprecated and should not be used.
4619
This event is deprecated and will be removed in the future. It should not be used.
4620
Event.Unit.Detail.TitleSuffix(units)
4621
</Documentation>
4622
        <Parameters>
4623
          <Parameter Name="units">
4624
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4625
          </Parameter>
4626
        </Parameters>
4627
        <ReturnValues />
4628
        <ReturnedMembers />
4629
      </Function>
4630
      <Function Name="Event.Unit.Detail.TitleSuffixId">
4631
        <Documentation>Signals a unit's title suffix ID changing.
4632
Event.Unit.Detail.TitleSuffixId(units)
4633
</Documentation>
4634
        <Parameters>
4635
          <Parameter Name="units">
4636
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4637
          </Parameter>
4638
        </Parameters>
4639
        <ReturnValues />
4640
        <ReturnedMembers />
4641
      </Function>
4642
      <Function Name="Event.Unit.Detail.TitleSuffixName">
4643
        <Documentation>Signals a unit's localized title suffix changing.
4644
Event.Unit.Detail.TitleSuffixName(units)
4645
</Documentation>
4646
        <Parameters>
4647
          <Parameter Name="units">
4648
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4649
          </Parameter>
4650
        </Parameters>
4651
        <ReturnValues />
4652
        <ReturnedMembers />
4653
      </Function>
4654
      <Function Name="Event.Unit.Detail.Vitality">
4655
        <Documentation>Signals a unit's vitality changing. Will trigger only for the player or groupmembers.
4656
Event.Unit.Detail.Vitality(units)
4657
</Documentation>
4658
        <Parameters>
4659
          <Parameter Name="units">
4660
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4661
          </Parameter>
4662
        </Parameters>
4663
        <ReturnValues />
4664
        <ReturnedMembers />
4665
      </Function>
4666
      <Function Name="Event.Unit.Detail.Warfront">
4667
        <Documentation>Signals a unit's warfront flag changing. Will trigger only for partymembers.
4668
Event.Unit.Detail.Warfront(units)
4669
</Documentation>
4670
        <Parameters>
4671
          <Parameter Name="units">
4672
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value.</Documentation>
4673
          </Parameter>
4674
        </Parameters>
4675
        <ReturnValues />
4676
        <ReturnedMembers />
4677
      </Function>
4678
      <Function Name="Event.Unit.Detail.Zone">
4679
        <Documentation>Signals a change in the unit's zone.
4680
Event.Unit.Detail.Zone(units)
4681
</Documentation>
4682
        <Parameters>
4683
          <Parameter Name="units">
4684
            <Documentation> Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.</Documentation>
4685
          </Parameter>
4686
        </Parameters>
4687
        <ReturnValues />
4688
        <ReturnedMembers />
4689
      </Function>
4690
      <Function Name="Event.Unit.Remove">
4691
        <Documentation>Signals the removal of units from unit specifiers. Always followed by Event.Unit.Change.Add. Triggers for unit IDs that have been removed from the specifier tree, but may not trigger for any children of those units. You may want to use LibUnitChange instead of this event.
4692
Event.Unit.Remove(units)
4693
</Documentation>
4694
        <Parameters>
4695
          <Parameter Name="units">
4696
            <Documentation> Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.</Documentation>
4697
          </Parameter>
4698
        </Parameters>
4699
        <ReturnValues />
4700
        <ReturnedMembers />
4701
      </Function>
4702
      <Function Name="Event.Unit.Unavailable">
4703
        <Documentation>Signals the unavailability of Inspect.Unit.Detail.
4704
Event.Unit.Unavailable(units)
4705
</Documentation>
4706
        <Parameters>
4707
          <Parameter Name="units">
4708
            <Documentation> Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.</Documentation>
4709
          </Parameter>
4710
        </Parameters>
4711
        <ReturnValues />
4712
        <ReturnedMembers />
4713
      </Function>
4714
    </Functions>
4715
  </Section>
4716
  <Section Name="UI:">
4717
    <Functions>
4718
      <Function Name="Layout:">
4719
        <Parameters />
4720
        <ReturnValues />
4721
        <ReturnedMembers />
4722
      </Function>
4723
      <Function Name="Native: Inherits from Layout">
4724
        <Parameters />
4725
        <ReturnValues />
4726
        <ReturnedMembers />
4727
      </Function>
4728
      <Function Name="Element: Inherits from Layout">
4729
        <Parameters />
4730
        <ReturnValues />
4731
        <ReturnedMembers />
4732
      </Function>
4733
      <Function Name="Frame: Inherits from Element">
4734
        <Parameters />
4735
        <ReturnValues />
4736
        <ReturnedMembers />
4737
      </Function>
4738
      <Function Name="Context: Inherits from Frame">
4739
        <Parameters />
4740
        <ReturnValues />
4741
        <ReturnedMembers />
4742
      </Function>
4743
      <Function Name="Mask: Inherits from Frame">
4744
        <Parameters />
4745
        <ReturnValues />
4746
        <ReturnedMembers />
4747
      </Function>
4748
      <Function Name="Text: Inherits from Frame">
4749
        <Parameters />
4750
        <ReturnValues />
4751
        <ReturnedMembers />
4752
      </Function>
4753
      <Function Name="Texture: Inherits from Frame">
4754
        <Parameters />
4755
        <ReturnValues />
4756
        <ReturnedMembers />
4757
      </Function>
4758
      <Function Name="RiftButton: Inherits from Frame">
4759
        <Parameters />
4760
        <ReturnValues />
4761
        <ReturnedMembers />
4762
      </Function>
4763
      <Function Name="RiftCheckbox: Inherits from Frame">
4764
        <Parameters />
4765
        <ReturnValues />
4766
        <ReturnedMembers />
4767
      </Function>
4768
      <Function Name="RiftScrollbar: Inherits from Frame">
4769
        <Parameters />
4770
        <ReturnValues />
4771
        <ReturnedMembers />
4772
      </Function>
4773
      <Function Name="RiftSlider: Inherits from Frame">
4774
        <Parameters />
4775
        <ReturnValues />
4776
        <ReturnedMembers />
4777
      </Function>
4778
      <Function Name="RiftTextfield: Inherits from Frame">
4779
        <Parameters />
4780
        <ReturnValues />
4781
        <ReturnedMembers />
4782
      </Function>
4783
      <Function Name="RiftWindow: Inherits from Frame">
4784
        <Parameters />
4785
        <ReturnValues />
4786
        <ReturnedMembers />
4787
      </Function>
4788
    </Functions>
4789
  </Section>
4790
  <Section Name="Parameter types:">
4791
    <Functions>
4792
      <Function Name="Context">
4793
        <Documentation>A zone, represented by a standard identifier with a 'z' prefix.
4794
zone
4795
</Documentation>
4796
        <Parameters />
4797
        <ReturnValues />
4798
        <ReturnedMembers />
4799
      </Function>
4800
    </Functions>
4801
  </Section>
4802-
</ArrayOfSection>
4802+
</Sections>