· 8 years ago · Jun 11, 2018, 02:20 AM
1Basic globals:
2 UI.CreateContext
3 Function documentation:
4 Creates a new UI context. A UI context must be created in order to create any frames.
5 context = UI.CreateContext(name) -- Context <- string
6 Parameters:
7 name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
8 Return values:
9 context: A new context. Contexts are guaranteed to have at least the capabilities of a Frame.
10 UI.CreateFrame
11 Function documentation:
12 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.
13 List of valid frame types:
14 Frame: The base type. No special capabilities. Useful for spacing, organization, input handling, and solid color squares.
15 Mask: Obscures the contents of child frames that do not fall within the mask boundaries.
16 Text: Displays text.
17 Texture: Displays a static texture image.
18 RiftButton: A standard Rift button widget.
19 RiftCheckbox: A standard Rift checkbox widget.
20 RiftScrollbar: A standard Rift scrollbar widget.
21 RiftSlider: A standard Rift slider widget.
22 RiftTextfield: A standard Rift textfield widget.
23 RiftWindow: A standard Rift window widget.
24 frame = UI.CreateFrame(type, name, parent) -- Frame <- string, string, Element
25 Parameters:
26 name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
27 parent: The new parent for this frame.
28 type: The type of your new frame. Current supported types: Frame, Text, Texture.
29 Return values:
30 frame: Your new frame.
31 UIParent.Event.Move
32 UIParent.Event.Size
33 _VERSION
34 assert
35 bit.arshift
36 bit.band
37 bit.bnot
38 bit.bor
39 bit.bswap
40 bit.bxor
41 bit.lshift
42 bit.rol
43 bit.ror
44 bit.rshift
45 bit.tobit
46 bit.tohex
47 collectgarbage
48 coroutine.create
49 coroutine.resume
50 coroutine.running
51 coroutine.status
52 coroutine.wrap
53 coroutine.yield
54 debug.traceback
55 dump
56 Function documentation:
57 Debug utility function. Similar to print(), but serializes any table parameters before outputting.
58 dump(...) -- ...
59 Parameters:
60 ...: Takes any number of any parameter type.
61 error
62 gcinfo
63 getfenv
64 getmetatable
65 ipairs
66 load
67 loadstring
68 math.abs
69 math.acos
70 math.asin
71 math.atan
72 math.atan2
73 math.ceil
74 math.cos
75 math.cosh
76 math.deg
77 math.exp
78 math.floor
79 math.fmod
80 math.frexp
81 math.huge
82 math.ldexp
83 math.log
84 math.log10
85 math.max
86 math.min
87 math.mod
88 math.modf
89 math.pi
90 math.pow
91 math.rad
92 math.random
93 math.randomseed
94 math.sin
95 math.sinh
96 math.sqrt
97 math.tan
98 math.tanh
99 newproxy
100 next
101 pairs
102 pcall
103 print
104 print_raw
105 rawequal
106 rawget
107 rawset
108 select
109 setfenv
110 setmetatable
111 string.byte
112 string.char
113 string.find
114 string.format
115 string.gfind
116 string.gmatch
117 string.gsub
118 string.len
119 string.lower
120 string.match
121 string.rep
122 string.reverse
123 string.sub
124 string.upper
125 table.concat
126 table.foreach
127 table.foreachi
128 table.getn
129 table.insert
130 table.maxn
131 table.remove
132 table.sort
133 table.unpack
134 tonumber
135 tostring
136 type
137 unpack
138 xpcall
139
140Inspectors:
141 Inspect.Ability.Detail
142 Function documentation:
143 Provides detailed information about abilities.
144 detail = Inspect.Ability.Detail(ability) -- table <- ability
145 details = Inspect.Ability.Detail(abilities) -- table <- table
146 Parameters:
147 abilities: A lookup table of identifiers of abilities to retrieve detail for.
148 ability: The identifier of the ability to retrieve detail for.
149 Return values:
150 detail: Detail table for a single ability.
151 details: Detail tables for all requested abilities. The key is the ability ID, the value is the ability's detail table.
152 Returned members:
153 autoattack: Autoattack mode of the ability.
154 castingTime: Casting time of the ability, in seconds.
155 channeled: Signals that the ability is channeled.
156 continuous: Signals that the ability is continuous.
157 cooldown: Cooldown of the ability, in seconds.
158 costCharge: The amount of charge this ability consumes on use.
159 costEnergy: The amount of energy this ability consumes on use.
160 costMana: The amount of mana this ability consumes on use.
161 costPlanarCharge: The amount of planar charges this ability consumes on use.
162 costPower: The amount of power this ability consumes on use.
163 currentCooldownBegin: The time the current cooldown started, in the context of Inspect.Time.Frame.
164 currentCooldownDuration: Duration of the current cooldown the ability is influenced by, in seconds.
165 currentCooldownExpired: Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
166 currentCooldownRemaining: Time remaining in the ability's current cooldown, in seconds.
167 description: Description for the ability.
168 gainCharge: Amount of charge gained by using the ability.
169 icon: Resource filename of the ability's icon.
170 name: Name of the ability.
171 outOfRange: Signals that the ability is out of range.
172 passive: Signals that the ability is passive.
173 positioned: Signals that the ability's effect is manually positioned by the user.
174 racial: Signals that the ability is a racial ability.
175 rangeMax: The maximum range of the ability.
176 rangeMin: The minimum range of the ability.
177 stealthRequired: Signals that the ability requires the user to be in stealth.
178 target: The Unit ID of the unit that this ability will be used on if triggered at this moment.
179 unusable: Signals that this ability is unusable.
180 weapon: The required equipped weapon for this ability. May be "any", "melee", or "ranged".
181 Inspect.Ability.List
182 Function documentation:
183 List available abilities.
184 abilities = Inspect.Ability.List() -- table <- void
185 Return values:
186 abilities: A lookup table of IDs of the available abilities.
187 Inspect.Achievement.Category.Detail
188 Function documentation:
189 Returns information about achievement categories.
190 detail = Inspect.Achievement.Category.Detail(category) -- table <- achievementcategory
191 details = Inspect.Achievement.Category.Detail(categories) -- table <- table
192 Parameters:
193 categories: A lookup table of identifiers of achievement categories to retrieve detail for.
194 category: The identifier of the achievement category to retrieve detail for.
195 Return values:
196 detail: Detail table for a single achievement category.
197 details: Detail tables for all requested achievement categories. The key is the category ID, the value is the category's detail table.
198 Returned members:
199 name: The name of the achievement category.
200 parent: The category's parent, if it has one.
201 Inspect.Achievement.Category.List
202 Function documentation:
203 Returns a lookup table of valid achievement categories.
204 categories = Inspect.Achievement.Category.List() -- table <- void
205 Return values:
206 categories: Valid achievement categories, in {id = true} format.
207 Inspect.Achievement.Detail
208 Function documentation:
209 Provides detailed information about achievements.
210 detail = Inspect.Achievement.Detail(achievement) -- table <- achievement
211 details = Inspect.Achievement.Detail(achievements) -- table <- table
212 Parameters:
213 achievement: The identifier of the achievement to retrieve detail for.
214 achievements: A lookup table of identifiers of achievements to retrieve detail for.
215 Return values:
216 detail: Detail table for a single achievement.
217 details: Detail tables for all requested achievements. The key is the achievement ID, the value is the achievement's detail table.
218 Returned members:
219 category: ID of the achievement's category.
220 complete: 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.
221 description: The achievement's description.
222 faction: The faction that this achievement requires, either "guardian", "defiant", or nil.
223 icon: Internal name of the achievement's icon.
224 name: The achievement's name.
225 previous: The ID of the achievement immediately previous to this in a chain.
226 requirement: Table listing the requirements for this achievement. Each item may include multiple members.
227 type: The type of the requirement. Valid values include "achievement", "artifactset", "discover", "event", "quest", and "tradeskill".
228 name: The name of the requirement.
229 count: The count required for completion.
230 countDone: The count already completed.
231 complete: Signals that this requirement is complete.
232 id: The id of whatever this requires.
233 score: The number of points this achievement awards for completion.
234 sort: A number indicating the order that this achievement should be sorted in.
235 title: The ID of the title this achievement awards.
236 Inspect.Achievement.List
237 Function documentation:
238 Returns a lookup table of all known achievements.
239 achievements = Inspect.Achievement.List() -- table <- void
240 Return values:
241 achievements: All known achievements, in {id = true} format.
242 Inspect.Addon.Cpu
243 Function documentation:
244 Returns recent CPU usage information. This is calculated using an exponential-falloff method.
245 data = Inspect.Addon.Cpu() -- table <- void
246 Return values:
247 data: 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.
248 Inspect.Addon.Current
249 Function documentation:
250 Returns the current addon. This information is used internally for counting CPU usage and determining frame ownership.
251 addonIdentifier = Inspect.Addon.Current() -- string <- void
252 Return values:
253 addonIdentifier: The addon's identifier, as written in its TOC file.
254 Inspect.Addon.Detail
255 Function documentation:
256 Provides detailed information about loaded addons.
257 detail = Inspect.Addon.Detail(addon) -- table <- string
258 details = Inspect.Addon.Detail(addons) -- table <- table
259 Parameters:
260 addon: An addon identifier.
261 addons: A lookup table containing addon identifiers.
262 Return values:
263 detail: Detail table for a single addon.
264 details: Detail tables for all requested addons. The key is the addon identifier, the value is the addon's detail table.
265 Returned members:
266 data: The "data" table provided to the addon at load time.
267 identifier: The addon's identifier.
268 toc: The addon's RiftAddon.toc file, parsed and in table form.
269 Inspect.Addon.List
270 Function documentation:
271 Lists all the addons that the client has loaded.
272 addons = Inspect.Addon.List() -- table <- void
273 Return values:
274 addons: Map of addon identifier to addon version, or "true" if no version is provided.
275 Inspect.Buff.Detail
276 Function documentation:
277 Provides detailed information about the buffs on a unit.
278 detail = Inspect.Buff.Detail(unit, buff) -- table <- unit, buff
279 details = Inspect.Buff.Detail(unit, buffs) -- table <- unit, table
280 Parameters:
281 buff: An identifier for the buff to retrieve detail for.
282 buffs: A lookup table containing buff identifiers to retrieve details for.
283 unit: The unit to inspect.
284 Return values:
285 detail: Detail table for a single buff.
286 details: Detail tables for all requested buffs. The key is the buff ID, the value is the buff's detail table.
287 Returned members:
288 ability: The ID of the ability that created this buff. Not guaranteed to exist.
289 begin: The time the buff started, in the context of Inspect.Time.Frame.
290 caster: Unit ID of the buff's caster.
291 curse: Signals that the buff is a curse.
292 debuff: Signals that the buff is a debuff. If this is missing, then it's an actual buff.
293 description: Description for the buff.
294 disease: Signals that the buff is a disease.
295 duration: Duration of the buff in seconds.
296 expired: Number of seconds the buff is past its expiration time. Generally indicates lag.
297 icon: Resource filename of the buff's icon.
298 name: Name of the buff.
299 noncancelable: Signals that the buff cannot be voluntarily canceled. Does not show up for debuffs.
300 poison: Signals that the buff is a poison.
301 remaining: Time remaining on the buff, in seconds.
302 rune: If this buff is created by a rune, the ID of the rune causing it.
303 stack: Number of stacks on the buff.
304 Inspect.Buff.List
305 Function documentation:
306 List buffs on a unit.
307 buffs = Inspect.Buff.List(unit) -- table <- unit
308 Parameters:
309 unit: The unit to inspect.
310 Return values:
311 buffs: A lookup table of the IDs of the buffs on the unit.
312 Inspect.Cursor
313 Function documentation:
314 Returns the current contents of the cursor.
315 type, held = Inspect.Cursor() -- nil, nil <- void
316 type, held = Inspect.Cursor() -- string, variant <- void
317 Return values:
318 held: The blob describing what is currently held. Generally, some kind of identifier used in another part of the addon system.
319 type: The current cursor type. Valid values include "ability", "item", and "itemtype".
320 Inspect.Documentation
321 Function documentation:
322 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.
323 documentables = Inspect.Documentation() -- table <- void
324 documentation = Inspect.Documentation(item) -- string <- variant
325 documentation = Inspect.Documentation(item, parseable = false) -- string <- variant, boolean
326 documentationTable = Inspect.Documentation(item, parseable = true) -- table <- variant, boolean
327 Parameters:
328 item: The item to get documentation on. May be either the item itself or a string identifier.
329 parseable: Whether to return in a computer-readable format, as opposed to the normal human-readable format.
330 Return values:
331 documentables: List of all items that documentation can be retrieved for. In {["itemname"] = true} format.
332 documentation: Documentation for the requested item.
333 documentationTable: Computer-readable documentation for the requested item. Format may change without warning.
334 Inspect.Item.Detail
335 Function documentation:
336 Provides detailed information about items.
337 item = Inspect.Item.Detail(item) -- table <- item
338 item = Inspect.Item.Detail(itemtype) -- table <- itemtype
339 item = Inspect.Item.Detail(slot) -- table <- slot
340 items = Inspect.Item.Detail(slot) -- table <- slot
341 items = Inspect.Item.Detail(elements) -- table <- table
342 Parameters:
343 elements: A lookup table of slot specifiers, item IDs, or item types.
344 item: A single item ID.
345 itemtype: A single item type.
346 slot: A single slot specifier.
347 Return values:
348 item: Detail table for a single item.
349 items: Detail tables for all requested items. The key is the string used to lookup, the value is the item's detail table.
350 Returned members:
351 bind: The item's binding type. May be "equip", "use", "pickup", or "account".
352 bound: The item's bound flag.
353 category: The item's type category.
354 cooldown: The cooldown for using this item.
355 cooldownBegin: The time the current cooldown started, in the context of Inspect.Time.Frame.
356 cooldownDuration: Duration of the current cooldown the item is influenced by, in seconds.
357 cooldownExpired: Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
358 cooldownRemaining: Time remaining in the item's current cooldown, in seconds.
359 crafter: The name of the player who crafted this item.
360 damageDelay: If a weapon, the delay between autoattacks using this weapon.
361 damageMax: If a weapon, the maximum damage done by a single hit with this item.
362 damageMin: If a weapon, the minimum damage done by a single hit with this item.
363 damageType: If a weapon, the damage type done by autoattacks. Values include "life", "death", "air", "earth", "fire", and "water".
364 description: The description of this item.
365 flavor: The flavor text for this item.
366 icon: Resource filename of the item's icon.
367 lootable: Indicates that the item contains loot.
368 name: The item's name.
369 range: If a ranged weapon, the maximum range of this item.
370 rarity: The item's rarity. Values include "trash", "uncommon", "rare", "epic", "relic", or "quest". Common items have a rarity of nil.
371 requiredCalling: Space-delimited list of the required callings to use this item.
372 requiredFaction: The ID of the faction required to use this item.
373 requiredFactionLevel: The faction notoriety required to use this item.
374 requiredLevel: The level required to use this item.
375 requiredPrestige: The prestige rank required to use this item.
376 requiredSkill: The skill required to use this item.
377 requiredSkillLevel: The skill level required to use this item.
378 sell: The sell value of this item, in silver.
379 slots: If a container, the number of slots that this item can contain.
380 stack: The size of this item stack.
381 stackMax: The maximum size of this item stack.
382 stats: The base stats of this item. Members may include "block", "critAttack", "critSpell", "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", and "xp".
383 statsRune: The added rune stats of this item. May contain the same members as stats.
384 statsRuneTemporary: The added temporary rune stats of this item. May contain the same members as stats.
385 type: The item's type specifier.
386 Inspect.Item.Find
387 Function documentation:
388 Finds a slot specifier based on an item ID.
389 slot = Inspect.Item.Find(item) -- slot <- item
390 slots = Inspect.Item.Find(items) -- table <- table
391 Parameters:
392 item: A single item ID.
393 items: A lookup table of item IDs.
394 Return values:
395 slot: A slot specifier for that item.
396 slots: Slot specifiers for all requested items. The key is the string used to lookup, the value is the slot specifier.
397 Inspect.Item.List
398 Function documentation:
399 Generate a list of item IDs from a slot specifier or set of slot specifiers.
400 items = Inspect.Item.List() -- table <- void
401 item = Inspect.Item.List(slot) -- item <- slot
402 items = Inspect.Item.List(slot) -- table <- slot
403 items = Inspect.Item.List(slots) -- table <- table
404 Parameters:
405 slot: A single slot specifier.
406 slots: A table of slot specifiers.
407 Return values:
408 item: A single item ID. This will be returned only if the input is a single fully-specified slot specifier.
409 items: A lookup table of item IDs. The key is the slot specifier, the value is the item ID.
410 Inspect.Mouse
411 Function documentation:
412 Returns information about the current mouse position and button state.
413 results = Inspect.Mouse() -- table <- void
414 Return values:
415 results: Table containing the current mouse state. May include members x, y, Left, Right, Middle, Mouse4, Mouse5.
416 Inspect.Shard
417 Function documentation:
418 Returns information about the current shard.
419 shard = Inspect.Shard() -- table <- void
420 Return values:
421 shard: Table containing requested data.
422 Returned members:
423 name: The shard's name.
424 Inspect.System.Language
425 Function documentation:
426 Returns the client's current language.
427 language = Inspect.System.Language() -- string <- void
428 Return values:
429 language: Current language. Valid values include "English", "French", "German", "Korean", "Russian".
430 Inspect.System.Secure
431 Function documentation:
432 Returns the client's current secure mode.
433 secure = Inspect.System.Secure() -- boolean <- void
434 Return values:
435 secure: The current secure mode.
436 Inspect.Time.Frame
437 Function documentation:
438 The game time of the last frame. This function's return value will not change until the next frame.
439 time = Inspect.Time.Frame() -- number <- void
440 Return values:
441 time: Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.
442 Inspect.Time.Real
443 Function documentation:
444 A high-resolution realtime timer. Not measured in the same timespace as Inspect.Time.Frame.
445 time = Inspect.Time.Real() -- number <- void
446 Return values:
447 time: Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.
448 Inspect.Unit.Castbar
449 Function documentation:
450 Provides detailed information about a unit's castbar.
451 detail = Inspect.Unit.Castbar(unit) -- table <- unit
452 details = Inspect.Unit.Castbar(units) -- table <- table
453 Parameters:
454 unit: A unit, in either unit ID or unit specifier format.
455 units: A lookup table containing units to inspect.
456 Return values:
457 detail: Detail table for a single castbar.
458 details: Detail tables for all requested castbars. The key is the unit ID or unit specifier, the value is the castbar's detail table.
459 Returned members:
460 ability: ID of the ability being cast, if available.
461 abilityName: Name of the ability being cast.
462 begin: The time the cast started, in the context of Inspect.Time.Frame.
463 channeled: True if this ability is channeled.
464 duration: Duration of the cast in seconds.
465 expired: Number of the seconds the cast is past its completion time. Generally indicates lag.
466 remaining: Time remaining on the cast, in seconds.
467 uninterruptible: Signals that the cast is not interruptible.
468 Inspect.Unit.Detail
469 Function documentation:
470 Provides detailed information about a unit.
471 detail = Inspect.Unit.Detail(unit) -- table <- unit
472 details = Inspect.Unit.Detail(units) -- table <- table
473 Parameters:
474 unit: A unit, in either unit ID or unit specifier format.
475 units: A lookup table containing units to inspect.
476 Return values:
477 detail: Detail table for a single unit.
478 details: Detail tables for all requested units. The key is the unit ID or unit specifier, the value is the unit's detail table.
479 Returned members:
480 afk: Signals that the unit is AFK. Provided only for the player and the player's groupmembers.
481 calling: The unit's calling. May be "mage", "rogue", "cleric", or "warrior".
482 charge: The unit's charge. Provided only for the player.
483 combat: The unit's combat status.
484 combo: The unit's combo points. Provided only for the player.
485 comboUnit: The Unit ID of the unit that the combo points have been placed on. Provided only for the player.
486 energy: The unit's energy.
487 energyMax: The unit's maximum energy.
488 faction: The unit's faction. "defiant", "guardian", or nil.
489 factionId: The unit's faction ID.
490 factionName: The unit's faction name.
491 guaranteedLoot: Signals that this unit guarantees loot on death. Shown in the user interface as a diamond above the portrait.
492 guild: The unit's guild.
493 health: The unit's health.
494 healthCap: The unit's capped maximum health.
495 healthMax: The unit's maximum health.
496 level: The unit's level. May be "??" if the unit is hostile and very high-level.
497 locationName: The name of the unit's location. Provided only for friendly players.
498 loot: The Unit ID that has looting rights to this corpse.
499 mana: The unit's mana.
500 manaMax: The unit's maximum mana.
501 mark: The mark on this unit.
502 name: The unit's name.
503 nameSecondary: The unit's secondary name.
504 offline: Signals that the unit is offline. Provided only for the player's groupmembers.
505 planar: The unit's available planar charges. Provided only for the player or groupmembers.
506 planarMax: The unit's maximum planar charges. Provided only for the player or groupmembers.
507 player: Signals that the unit is a player, not an NPC.
508 power: The unit's power.
509 publicSize: The unit's current public group size. nil if the group is not public. Provided only for friendly players.
510 pvp: The unit's PvP flag.
511 race: The unit's race. Provided only for players.
512 raceName: The unit's race, localized. Provided only for players.
513 ready: The unit's readycheck status.
514 relation: The unit's relation to you. May be "hostile" or "friendly". Neutral targets will not have this member.
515 role: The unit's role. May be "tank", "heal", "dps", "support", or nil. Provided only for the player and the player's groupmembers.
516 tag: The unit's tags, space-separated.
517 tagName: The unit's tags, localized.
518 tagged: The unit's tagged status. true if the unit has been tagged by you, "other" if the unit has been tagged by someone else.
519 tier: The unit's difficulty tier. nil, "group", or "raid".
520 titlePrefixId: The unit's title prefix ID.
521 titlePrefixName: The unit's localized title prefix.
522 titleSuffixId: The unit's title suffix ID.
523 titleSuffixName: The unit's localized title suffix.
524 type: The unit type ID.
525 vitality: The unit's vitality. Provided only for the player or groupmembers.
526 warfront: Signals that the unit has temporarily left the group to join a warfront. Provided only for groupmembers.
527 Inspect.Unit.List
528 Function documentation:
529 Lists all the units that the client can see.
530 list = Inspect.Unit.List() -- table <- void
531 Return values:
532 list: Map of unit ID to unit specifier. Units with multiple valid specs will have one chosen at random.
533 Inspect.Unit.Lookup
534 Function documentation:
535 Converts unit IDs to unit specifiers and vice-versa.
536 unit = Inspect.Unit.Lookup(unit) -- unit <- unit
537 units = Inspect.Unit.Lookup(units) -- table <- table
538 Parameters:
539 unit: A single unit ID or unit specifier.
540 units: A lookup table containing unit IDs and unit specifiers.
541 Return values:
542 unit: A unit ID or unit specifier, whichever is the opposite of the parameter given. May be nil.
543 units: 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.
544
545Commands:
546 Command.Buff.Cancel
547 Function documentation:
548 Cancels a buff on the player. Not all buffs are cancelable.
549 Command.Buff.Cancel(buff) -- buff
550 Parameters:
551 buff: The ID of the buff to cancel.
552 Command.Cursor
553 Function documentation:
554 Changes the contents of the cursor. Ability cursors may be set only if the environment is not in secure mode.
555 Command.Cursor(hold) -- variant
556 Parameters:
557 hold: The new cursor. Currently accepts ability, item, or itemtype IDs. Pass nil to clear the cursor.
558 Command.Item.Destroy
559 Function documentation:
560 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.
561 This function is subject to the global command throttle.
562 Command.Item.Destroy(target) -- item
563 Parameters:
564 target: The item ID of the item to destroy.
565 Command.Item.Move
566 Function documentation:
567 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.
568 This function is subject to the global command throttle.
569 Command.Item.Move(source, destination) -- item, slot
570 Command.Item.Move(source, destination) -- slot, slot
571 Parameters:
572 destination: The location to move the item. May attempt to stack or swap if there is already an item here.
573 source: The item to move. Must be a slot specifier that refers to an actual item.
574 Command.Item.Split
575 Function documentation:
576 Splits a number of items off a stack.
577 This function is subject to the global command throttle.
578 Command.Item.Split(source, stack) -- item, number
579 Command.Item.Split(source, stack) -- slot, number
580 Parameters:
581 source: The item to split. May be a slot specifier or an item ID.
582 stack: The number of items to move into the new stack. Must be a positive integer.
583 Command.Slash.Register
584 Function documentation:
585 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.
586 eventTable = Command.Slash.Register(slashCommand) -- table <- string
587 Parameters:
588 slashCommand: The name of the slash command to register.
589 Return values:
590 eventTable: 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.)
591 Command.System.Flash
592 Function documentation:
593 Controls the flashing of the Rift taskbar icon.
594 Command.System.Flash(flash) -- boolean
595 Parameters:
596 flash: Whether the taskbar icon should flash or not.
597 Command.Tooltip
598 Function documentation:
599 Changes the displayed tooltip.
600 Command.Tooltip(target) -- variant
601 Parameters:
602 target: The new tooltip. Currently accepts ability, item, or itemtype IDs. Pass nil to clear the tooltip.
603
604Utilities:
605 Utility.Dispatch
606 Function documentation:
607 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.
608 Utility.Dispatch(func, identifier, info) -- function, string, string
609 Parameters:
610 func: The function to call.
611 identifier: The identifier of the addon to credit execution time towards.
612 info: An info string to be included in error reports.
613 Utility.Event.Create
614 Function documentation:
615 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.
616 handle, event = Utility.Event.Create(identifier, event) -- function, table <- string, string
617 Parameters:
618 event: The event's name. "." characters will be treated as hierarchy delimeters.
619 identifier: The identifier of the addon creating this event.
620 Return values:
621 event: The resulting event table.
622 handle: 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.
623 Utility.Item.Slot.All
624 Function documentation:
625 Generates a slot specifier for all known items.
626 slot = Utility.Item.Slot.All() -- slot <- void
627 Return values:
628 slot: The requested slot specifier.
629 Utility.Item.Slot.Bank
630 Function documentation:
631 Generates a slot specifier for the player's bank.
632 slot = Utility.Item.Slot.Bank() -- slot <- void
633 slot = Utility.Item.Slot.Bank(segment) -- slot <- string
634 slot = Utility.Item.Slot.Bank(segment) -- slot <- number
635 slot = Utility.Item.Slot.Bank(segment, slot) -- slot <- string, number
636 slot = Utility.Item.Slot.Bank(segment, slot) -- slot <- number, number
637 Parameters:
638 segment: 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.
639 slot: The slot ID, starting at 1.
640 Return values:
641 slot: The requested slot specifier.
642 Utility.Item.Slot.Equipment
643 Function documentation:
644 Generates a slot specifier for the player's equipment.
645 slot = Utility.Item.Slot.Equipment() -- slot <- void
646 slot = Utility.Item.Slot.Equipment(slot) -- slot <- string
647 Parameters:
648 slot: The equipment slot to be used. Can be any of the following: "helmet", "shoulders", "chest", "gloves", "belt", "legs", "feet", "handmain", "handoff", "ranged", "neck", "trinket", "ring1", "ring2", "synergy", or "focus".
649 Return values:
650 slot: The requested slot specifier.
651 Utility.Item.Slot.Guild
652 Function documentation:
653 Generates a slot specifier for the player's guild bank.
654 slot = Utility.Item.Slot.Guild() -- slot <- void
655 slot = Utility.Item.Slot.Guild(vault) -- slot <- number
656 slot = Utility.Item.Slot.Guild(vault, slot) -- slot <- number, number
657 Parameters:
658 slot: The slot ID, starting at 1.
659 vault: The vault ID to inspect. Starts at 1.
660 Return values:
661 slot: The requested slot specifier.
662 Utility.Item.Slot.Inventory
663 Function documentation:
664 Generates a slot specifier for the player's inventory.
665 slot = Utility.Item.Slot.Inventory() -- slot <- void
666 slot = Utility.Item.Slot.Inventory(bag) -- slot <- string
667 slot = Utility.Item.Slot.Inventory(bag) -- slot <- number
668 slot = Utility.Item.Slot.Inventory(bag, slot) -- slot <- string, number
669 slot = Utility.Item.Slot.Inventory(bag, slot) -- slot <- number, number
670 Parameters:
671 bag: The number of the bag whose contents should be inspected, starting at 1, or "bag" to inspect the actual inventory bags.
672 slot: The slot ID, starting at 1.
673 Return values:
674 slot: The requested slot specifier.
675 Utility.Item.Slot.Parse
676 Incorrect function usage.
677 Function documentation:
678 Parses a slot specifier, returning information on what it represents.
679 type, parameter, parameter = Utility.Item.Slot.Parse(slot) -- string, variant, variant <- slot
680 type, parameter = Utility.Item.Slot.Parse(slot) -- string, variant <- slot
681 type = Utility.Item.Slot.Parse(slot) -- string <- slot
682 Utility.Item.Slot.Parse(slot) -- slot
683 Parameters:
684 slot: The slot ID, starting at 1.
685 Return values:
686 parameter: A parameter for this slot type. Actual meaning depends on the type.
687 type: The type of this element.
688 Utility.Item.Slot.Quest
689 Function documentation:
690 Generates a slot specifier for the player's quest bag.
691 slot = Utility.Item.Slot.Quest() -- slot <- void
692 slot = Utility.Item.Slot.Quest(slot) -- slot <- number
693 Parameters:
694 slot: The slot ID, starting at 1.
695 Return values:
696 slot: The requested slot specifier.
697 Utility.Item.Slot.Wardrobe
698 Function documentation:
699 Generates a slot specifier for the player's wardrobe.
700 slot = Utility.Item.Slot.Wardrobe() -- slot <- void
701 slot = Utility.Item.Slot.Wardrobe(costume) -- slot <- number
702 slot = Utility.Item.Slot.Wardrobe(costume, slot) -- slot <- number, string
703 Parameters:
704 costume: The number of the wardrobe costume to inspect, starting at 1.
705 slot: The equipment slot to be used. Can be any of the following: "helmet", "shoulders", "chest", "gloves", "legs", or "feet".
706 Return values:
707 slot: The requested slot specifier.
708 Utility.Serialize.Inline
709 Function documentation:
710 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.
711 serialized = Utility.Serialize.Inline(element) -- string <- variant
712 Parameters:
713 element: Element to serialize.
714 Return values:
715 serialized: String containing serialized output. May be nil if there was an error with the input.
716
717Events:
718 Event.Ability.Add
719 Event documentation:
720 Signals the addition of a player ability.
721 Event.Ability.Add(abilities)
722 Parameters:
723 abilities: Lists the abilities that were added. Lookup table from ability ID to "true".
724 Event.Ability.Cooldown.Begin
725 Event documentation:
726 Signals the start of an ability's cooldown.
727 Event.Ability.Cooldown.Begin(cooldowns)
728 Parameters:
729 cooldowns: 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.
730 Event.Ability.Cooldown.End
731 Event documentation:
732 Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.
733 Event.Ability.Cooldown.End(cooldowns)
734 Parameters:
735 cooldowns: 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.
736 Event.Ability.Range.False
737 Event documentation:
738 Signals a player ability exiting range from its current target.
739 Event.Ability.Range.False(abilities)
740 Parameters:
741 abilities: The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.
742 Event.Ability.Range.True
743 Event documentation:
744 Signals a player ability entering range from its current target.
745 Event.Ability.Range.True(abilities)
746 Parameters:
747 abilities: The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.
748 Event.Ability.Remove
749 Event documentation:
750 Signals the removal of a player ability.
751 Event.Ability.Remove(abilities)
752 Parameters:
753 abilities: Lists the abilities that were removed. Lookup table from ability ID to "false".
754 Event.Ability.Target
755 Event documentation:
756 Signals a player ability changing its current target.
757 Event.Ability.Target(abilities)
758 Parameters:
759 abilities: The abilities whose target has changed. The key is the ability ID, the value is the new target.
760 Event.Ability.Usable.False
761 Event documentation:
762 Signals a player ability becoming unusable.
763 Event.Ability.Usable.False(abilities)
764 Parameters:
765 abilities: The abilities whose usability has changed. The key is the ability ID, the value is the new usability.
766 Event.Ability.Usable.True
767 Event documentation:
768 Signals a player ability becoming usable.
769 Event.Ability.Usable.True(abilities)
770 Parameters:
771 abilities: The abilities whose usability has changed. The key is the ability ID, the value is the new usability.
772 Event.Achievement.Complete
773 Event documentation:
774 Signals an achievement completing.
775 Event.Achievement.Complete(achievement)
776 Parameters:
777 achievement: The ID of the achievement.
778 Event.Achievement.Update
779 Event documentation:
780 Signals a change in an achievement's information.
781 Event.Achievement.Update(achievements)
782 Parameters:
783 achievements: A lookup table of the achievements, in {id = true} format.
784 Event.Addon.Load.Begin
785 Event documentation:
786 Signals the beginning of an addon's loading sequence.
787 Event.Addon.Load.Begin(addonidentifier)
788 Parameters:
789 addonidentifier: The addon's identifier.
790 Event.Addon.Load.End
791 Event documentation:
792 Signals the end of an addon's loading sequence. At this point, that addon is fully loaded and initialized.
793 Event.Addon.Load.End(addonidentifier)
794 Parameters:
795 addonidentifier: The addon's identifier.
796 Event.Addon.SavedVariables.Load.Begin
797 Event documentation:
798 Signals the beginning of an addon's saved variable loading.
799 Event.Addon.SavedVariables.Load.Begin(addonidentifier)
800 Parameters:
801 addonidentifier: The addon's identifier.
802 Event.Addon.SavedVariables.Load.End
803 Event documentation:
804 Signals the end of an addon's saved variable load.
805 Event.Addon.SavedVariables.Load.End(addonidentifier)
806 Parameters:
807 addonidentifier: The addon's identifier.
808 (1 handler)
809 Event.Addon.SavedVariables.Save.Begin
810 Event documentation:
811 Signals the beginning of an addon's saved variable saving.
812 Event.Addon.SavedVariables.Save.Begin(addonidentifier)
813 Parameters:
814 addonidentifier: The addon's identifier.
815 Event.Addon.SavedVariables.Save.End
816 Event documentation:
817 Signals the end of an addon's saved variable saving.
818 Event.Addon.SavedVariables.Save.End(addonidentifier)
819 Parameters:
820 addonidentifier: The addon's identifier.
821 Event.Addon.Shutdown.Begin
822 Event documentation:
823 Signals the beginning of the shutdown sequence.
824 Event.Addon.Shutdown.Begin()
825 Event.Addon.Shutdown.End
826 Event documentation:
827 Signals the end of the shutdown sequence. This is the last event that will be sent.
828 Event.Addon.Shutdown.End()
829 Event.Addon.Startup.End
830 Event documentation:
831 Signals the end of the startup sequence. At this point, all addons are fully loaded and initialized.
832 Event.Addon.Startup.End()
833 Event.Buff.Add
834 Event documentation:
835 Signals new buffs on a unit.
836 Event.Buff.Add(unit, buffs)
837 Parameters:
838 unit: The Unit ID of the unit involved.
839 buffs: A lookup table containing the buffs involved.
840 Event.Buff.Change
841 Event documentation:
842 Signals a change in existing buffs on a unit.
843 Event.Buff.Change(unit, buffs)
844 Parameters:
845 unit: The Unit ID of the unit involved.
846 buffs: A lookup table containing the buffs involved.
847 Event.Buff.Remove
848 Event documentation:
849 Signals removal of buffs from a unit.
850 Event.Buff.Remove(unit, buffs)
851 Parameters:
852 unit: The Unit ID of the unit involved.
853 buffs: A lookup table containing the buffs involved.
854 Event.Chat.Notify
855 Event documentation:
856 Signals a screen notification. This is generally used as a warning mechanism during boss fights.
857 Event.Chat.Notify(info)
858 Parameters:
859 info: Detailed information table about this event, containing several named parameters.
860 Parameter members:
861 message: The text said.
862 Event.Chat.Npc
863 Event documentation:
864 Signals an NPC speaking a line of text.
865 Event.Chat.Npc(info)
866 Parameters:
867 info: Detailed information table about this event, containing several named parameters.
868 Parameter members:
869 from: The unit ID of the speaker, if available.
870 fromName: The name of the speaker.
871 message: The text said.
872 Event.Combat.Damage
873 Event documentation:
874 Signals damage done to a unit.
875 Event.Combat.Damage(info)
876 Parameters:
877 info: Detailed information table about this event, containing several named parameters.
878 Parameter members:
879 ability: The ability ID for the ability used, if available.
880 abilityName: The name of the ability used.
881 caster: The unit ID for this event's initiator, if one exists.
882 crit: Whether this was the result of a critical hit.
883 damage: The amount of damage actually done.
884 damageAbsorbed: The amount of damage absorbed.
885 damageBlocked: The amount of damage deflected.
886 damageDeflected: The amount of damage deflected.
887 damageIntercepted: The amount of damage intercepted.
888 damageModified: The amount of damage modified.
889 overkill: The amount of overkill done.
890 target: The unit ID for the target.
891 type: The damage type. Values include "life", "death", "air", "earth", "fire", "water".
892 Event.Combat.Death
893 Event documentation:
894 Signals the death of a unit.
895 Event.Combat.Death(info)
896 Parameters:
897 info: Detailed information table about this event, containing several named parameters.
898 Parameter members:
899 caster: The unit ID for this event's initiator, if one exists.
900 target: The unit ID for the target.
901 Event.Combat.Dodge
902 Event documentation:
903 Signals a unit dodging an ability.
904 Event.Combat.Dodge(info)
905 Parameters:
906 info: Detailed information table about this event, containing several named parameters.
907 Parameter members:
908 ability: The ability ID for the ability used, if available.
909 abilityName: The name of the ability used.
910 caster: The unit ID for this event's initiator, if one exists.
911 target: The unit ID for the target.
912 Event.Combat.Heal
913 Event documentation:
914 Signals healing done to a unit.
915 Event.Combat.Heal(info)
916 Parameters:
917 info: Detailed information table about this event, containing several named parameters.
918 Parameter members:
919 ability: The ability ID for the ability used, if available.
920 abilityName: The name of the ability used.
921 caster: The unit ID for this event's initiator, if one exists.
922 crit: Whether this was the result of a critical hit.
923 heal: The amount healed.
924 overheal: The amount of healing past maximum health wasted.
925 target: The unit ID for the target.
926 Event.Combat.Immune
927 Event documentation:
928 Signals a unit resisting an ability through immunity.
929 Event.Combat.Immune(info)
930 Parameters:
931 info: Detailed information table about this event, containing several named parameters.
932 Parameter members:
933 ability: The ability ID for the ability used, if available.
934 abilityName: The name of the ability used.
935 caster: The unit ID for this event's initiator, if one exists.
936 target: The unit ID for the target.
937 Event.Combat.Miss
938 Event documentation:
939 Signals an ability's effect missing a unit.
940 Event.Combat.Miss(info)
941 Parameters:
942 info: Detailed information table about this event, containing several named parameters.
943 Parameter members:
944 ability: The ability ID for the ability used, if available.
945 abilityName: The name of the ability used.
946 caster: The unit ID for this event's initiator, if one exists.
947 target: The unit ID for the target.
948 Event.Combat.Parry
949 Event documentation:
950 Signals a unit parrying an ability.
951 Event.Combat.Parry(info)
952 Parameters:
953 info: Detailed information table about this event, containing several named parameters.
954 Parameter members:
955 ability: The ability ID for the ability used, if available.
956 abilityName: The name of the ability used.
957 caster: The unit ID for this event's initiator, if one exists.
958 target: The unit ID for the target.
959 Event.Combat.Resist
960 Event documentation:
961 Signals a unit resisting an ability.
962 Event.Combat.Resist(info)
963 Parameters:
964 info: Detailed information table about this event, containing several named parameters.
965 Parameter members:
966 ability: The ability ID for the ability used, if available.
967 abilityName: The name of the ability used.
968 caster: The unit ID for this event's initiator, if one exists.
969 target: The unit ID for the target.
970 Event.Cursor
971 Event documentation:
972 Signals that the cursor has changed.
973 Event.Cursor(type, held)
974 Parameters:
975 type: The current cursor type. Valid values include "ability", "item", and "itemtype".
976 held: The blob describing the new element held. Generally, some kind of identifier used in another part of the addon system.
977 Event.Item.Slot
978 Event documentation:
979 Signals that the contents of an item slot have changed.
980 Event.Item.Slot(updates)
981 Parameters:
982 updates: 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.
983 Event.Item.Update
984 Event documentation:
985 Signals that an item has changed.
986 Event.Item.Update(updates)
987 Parameters:
988 updates: 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.
989 Event.Mouse.Move
990 Event documentation:
991 Signals the mouse moving.
992 Event.Mouse.Move(x, y)
993 Parameters:
994 x: The mouse's new X position.
995 y: The mouse's new Y position.
996 Event.Slash (category for dynamically-created events)
997 Event.Slash.dump
998 (Slash event documentation TBI)
999 (1 handler)
1000 Event.Slash.eventlog
1001 (Slash event documentation TBI)
1002 Event.Slash.framecap
1003 (Slash event documentation TBI)
1004 Event.System.Error
1005 Event documentation:
1006 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.
1007 Event.System.Error(error)
1008 Parameters:
1009 error: Table containing error data.
1010 Parameter members:
1011 addon: The identifier of the responsible addon. Used in error types event, frameEvent, dispatch, fileNotFound, fileLoad, and fileRun.
1012 axis: The axis influenced by the error. Used in error types layoutLoop and layoutError.
1013 error: The actual error message generated. Used in error types event, frameEvent, script, dispatch, fileLoad, and fileRun.
1014 event: The name of the event responsible. Used in error types event, frameEvent, and internal.
1015 file: The name of the file responsible. Used in error types fileNotFound, fileLoad, and fileRun.
1016 frame: The name of the frame that the event was generated on. Used in error type frameEvent.
1017 info: The info string provided as part of the event handler. Used in error types event and dispatch.
1018 script: The exact script entered by the user. Used in error type script.
1019 stacktrace: The stacktrace at the point of the error. Used in error types event, frameEvent, script, dispatch, fileRun, layoutLoop, and layoutError.
1020 type: Error type. "event" indicates an error within a global event handler. "frameEvent" indicates an error within a frame event handler. "script" indicates an error within a user-entered /script. "dispatch" indicates an error within a Utility.Dispatch handler. "internal" indicates an error within Rift's code (hopefully you'll never see this). "fileNotFound" indicates a missing file when attempting to load an addon. "fileLoad" indicates a parse failure when attempting to load an addon. "fileRun" indicates an execution error when attempting to load an addon. "layoutLoop" indicates a dependency loop found when evaluating the layout. "layoutError" indicates an invalid position found when evaluating the layout.
1021 (1 handler)
1022 Event.System.Secure.Enter
1023 Event documentation:
1024 Signals that the system is entering Secure mode. Usually this is equivalent to entering combat. Functions that may not be called in Secure mode will be locked after this event is complete.
1025 Event.System.Secure.Enter()
1026 Event.System.Secure.Leave
1027 Event documentation:
1028 Signals that the system is leaving Secure mode. Usually this is equivalent to leaving combat. Functions that may not be called in Secure mode are unlocked just before this event fires.
1029 Event.System.Secure.Leave()
1030 Event.System.Update.Begin
1031 Event documentation:
1032 Signals the beginning of a frame render. This is your last chance to make UI changes for this frame.
1033 Event.System.Update.Begin()
1034 (1 handler)
1035 Event.System.Update.End
1036 Event documentation:
1037 Signals the end of a frame render.
1038 Event.System.Update.End()
1039 (1 handler)
1040 Event.Unit.Add
1041 Event documentation:
1042 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.
1043 Event.Unit.Add(units)
1044 Parameters:
1045 units: Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.
1046 Event.Unit.Available
1047 Event documentation:
1048 Signals the availability of Inspect.Unit.Detail.
1049 Event.Unit.Available(units)
1050 Parameters:
1051 units: Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.
1052 Event.Unit.Castbar
1053 Event documentation:
1054 Signals a unit's castbar changing.
1055 Event.Unit.Castbar(units)
1056 Parameters:
1057 units: Table of the units changed. Key is the unit ID, value is a castbar visibility flag.
1058 Event.Unit.Detail.Afk
1059 Event documentation:
1060 Signals a unit's AFK flag changing. Will only trigger for partymembers.
1061 Event.Unit.Detail.Afk(units)
1062 Parameters:
1063 units: Table of the units changed. Key is the unit ID, value is the new value.
1064 Event.Unit.Detail.Charge
1065 Event documentation:
1066 Signals a unit's charge changing. Will only trigger for the player's unit ID.
1067 Event.Unit.Detail.Charge(units)
1068 Parameters:
1069 units: Table of the units changed. Key is the unit ID, value is the new value.
1070 Event.Unit.Detail.Combat
1071 Event documentation:
1072 Signals a unit's combat status changing.
1073 Event.Unit.Detail.Combat(units)
1074 Parameters:
1075 units: Table of the units changed. Key is the unit ID, value is the new value.
1076 Event.Unit.Detail.Combo
1077 Event documentation:
1078 Signals a unit's combo points changing. Will only trigger for the player's unit ID.
1079 Event.Unit.Detail.Combo(units)
1080 Parameters:
1081 units: Table of the units changed. Key is the unit ID, value is the new value.
1082 Event.Unit.Detail.ComboUnit
1083 Event documentation:
1084 Signals a unit's combo point target changing. Will only trigger for the player's unit ID.
1085 Event.Unit.Detail.ComboUnit(units)
1086 Parameters:
1087 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1088 Event.Unit.Detail.Energy
1089 Event documentation:
1090 Signals a unit's energy changing.
1091 Event.Unit.Detail.Energy(units)
1092 Parameters:
1093 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1094 Event.Unit.Detail.EnergyMax
1095 Event documentation:
1096 Signals a unit's energy maximum changing.
1097 Event.Unit.Detail.EnergyMax(units)
1098 Parameters:
1099 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1100 Event.Unit.Detail.Guild
1101 Event documentation:
1102 Signals a unit's guild changing.
1103 Event.Unit.Detail.Guild(units)
1104 Parameters:
1105 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1106 Event.Unit.Detail.Health
1107 Event documentation:
1108 Signals a unit's health changing.
1109 Event.Unit.Detail.Health(units)
1110 Parameters:
1111 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1112 Event.Unit.Detail.HealthCap
1113 Event documentation:
1114 Signals a unit's health cap changing.
1115 Event.Unit.Detail.HealthCap(units)
1116 Parameters:
1117 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1118 Event.Unit.Detail.HealthMax
1119 Event documentation:
1120 Signals a unit's health maximum changing.
1121 Event.Unit.Detail.HealthMax(units)
1122 Parameters:
1123 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1124 Event.Unit.Detail.Level
1125 Event documentation:
1126 Signals a unit's level changing.
1127 Event.Unit.Detail.Level(units)
1128 Parameters:
1129 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1130 Event.Unit.Detail.LocationName
1131 Event documentation:
1132 Signals a unit's location name changing.
1133 Event.Unit.Detail.LocationName(units)
1134 Parameters:
1135 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1136 Event.Unit.Detail.Mana
1137 Event documentation:
1138 Signals a unit's mana changing.
1139 Event.Unit.Detail.Mana(units)
1140 Parameters:
1141 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1142 Event.Unit.Detail.ManaMax
1143 Event documentation:
1144 Signals a unit's mana maximum changing.
1145 Event.Unit.Detail.ManaMax(units)
1146 Parameters:
1147 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1148 Event.Unit.Detail.Mark
1149 Event documentation:
1150 Signals a unit's mark changing.
1151 Event.Unit.Detail.Mark(units)
1152 Parameters:
1153 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1154 Event.Unit.Detail.Name
1155 Event documentation:
1156 Signals a unit's name changing.
1157 Event.Unit.Detail.Name(units)
1158 Parameters:
1159 units: Table of the units changed. Key is the unit ID, value is the new value.
1160 Event.Unit.Detail.Offline
1161 Event documentation:
1162 Signals a unit's offline flag changing. Will only trigger for partymembers.
1163 Event.Unit.Detail.Offline(units)
1164 Parameters:
1165 units: Table of the units changed. Key is the unit ID, value is the new value.
1166 Event.Unit.Detail.Planar
1167 Event documentation:
1168 Signals a unit's planar charges changing. Will only trigger for the player or groupmembers.
1169 Event.Unit.Detail.Planar(units)
1170 Parameters:
1171 units: Table of the units changed. Key is the unit ID, value is the new value.
1172 Event.Unit.Detail.PlanarMax
1173 Event documentation:
1174 Signals a unit's maximum planar charges changing. Will only trigger for the player or groupmembers.
1175 Event.Unit.Detail.PlanarMax(units)
1176 Parameters:
1177 units: Table of the units changed. Key is the unit ID, value is the new value.
1178 Event.Unit.Detail.Power
1179 Event documentation:
1180 Signals a unit's power changing.
1181 Event.Unit.Detail.Power(units)
1182 Parameters:
1183 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1184 Event.Unit.Detail.PublicSize
1185 Event documentation:
1186 Signals a unit's public group size or status changing.
1187 Event.Unit.Detail.PublicSize(units)
1188 Parameters:
1189 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1190 Event.Unit.Detail.Pvp
1191 Event documentation:
1192 Signals a unit's PvP flag changing.
1193 Event.Unit.Detail.Pvp(units)
1194 Parameters:
1195 units: Table of the units changed. Key is the unit ID, value is the new value.
1196 Event.Unit.Detail.Ready
1197 Event documentation:
1198 Signals a unit's readycheck status changing.
1199 Event.Unit.Detail.Ready(units)
1200 Parameters:
1201 units: Table of the units changed. Key is the unit ID, value is the new value, or the string "nil" in place of nil.
1202 Event.Unit.Detail.Role
1203 Event documentation:
1204 Signals a unit's role changing. Will only trigger for the player or partymembers.
1205 Event.Unit.Detail.Role(units)
1206 Parameters:
1207 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1208 Event.Unit.Detail.Tagged
1209 Event documentation:
1210 Signals a unit's tagged status changing.
1211 Event.Unit.Detail.Tagged(units)
1212 Parameters:
1213 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1214 Event.Unit.Detail.TitlePrefix
1215 Event documentation:
1216 Signals a unit's localized title prefix changing. This event is deprecated and should not be used.
1217 This event is deprecated and will be removed in the future. It should not be used.
1218 Event.Unit.Detail.TitlePrefix(units)
1219 Parameters:
1220 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1221 Event.Unit.Detail.TitlePrefixId
1222 Event documentation:
1223 Signals a unit's title prefix ID changing.
1224 Event.Unit.Detail.TitlePrefixId(units)
1225 Parameters:
1226 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1227 Event.Unit.Detail.TitlePrefixName
1228 Event documentation:
1229 Signals a unit's localized title prefix changing.
1230 Event.Unit.Detail.TitlePrefixName(units)
1231 Parameters:
1232 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1233 Event.Unit.Detail.TitleSuffix
1234 Event documentation:
1235 Signals a unit's localized title suffix changing. This event is deprecated and should not be used.
1236 This event is deprecated and will be removed in the future. It should not be used.
1237 Event.Unit.Detail.TitleSuffix(units)
1238 Parameters:
1239 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1240 Event.Unit.Detail.TitleSuffixId
1241 Event documentation:
1242 Signals a unit's title suffix ID changing.
1243 Event.Unit.Detail.TitleSuffixId(units)
1244 Parameters:
1245 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1246 Event.Unit.Detail.TitleSuffixName
1247 Event documentation:
1248 Signals a unit's localized title suffix changing.
1249 Event.Unit.Detail.TitleSuffixName(units)
1250 Parameters:
1251 units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
1252 Event.Unit.Detail.Vitality
1253 Event documentation:
1254 Signals a unit's vitality changing. Will only trigger for the player or groupmembers.
1255 Event.Unit.Detail.Vitality(units)
1256 Parameters:
1257 units: Table of the units changed. Key is the unit ID, value is the new value.
1258 Event.Unit.Detail.Warfront
1259 Event documentation:
1260 Signals a unit's warfront flag changing. Will only trigger for partymembers.
1261 Event.Unit.Detail.Warfront(units)
1262 Parameters:
1263 units: Table of the units changed. Key is the unit ID, value is the new value.
1264 Event.Unit.Remove
1265 Event documentation:
1266 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.
1267 Event.Unit.Remove(units)
1268 Parameters:
1269 units: Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.
1270 Event.Unit.Unavailable
1271 Event documentation:
1272 Signals the unavailability of Inspect.Unit.Detail.
1273 Event.Unit.Unavailable(units)
1274 Parameters:
1275 units: Table of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.
1276
1277UI:
1278 Layout:
1279 Members:
1280 GetBottom
1281 Function documentation:
1282 Retrieves the Y position of the bottom edge of this element.
1283 bottom = Layout:GetBottom() -- number <- void
1284 Return values:
1285 bottom: The Y position of the bottom edge of this element.
1286 GetBounds
1287 Function documentation:
1288 Retrieves the complete bounds of this element.
1289 left, top, right, bottom = Layout:GetBounds() -- number, number, number, number <- void
1290 Return values:
1291 bottom: The Y position of the bottom edge of this element.
1292 left: The X position of the left edge of this element.
1293 right: The X position of the right edge of this element.
1294 top: The Y position of the top edge of this element.
1295 GetEventTable
1296 Function documentation:
1297 Retrieves the event table of this element. By default, this value is also stored in "this.Event".
1298 eventTable = Layout:GetEventTable() -- table <- void
1299 Return values:
1300 eventTable: The event table of this element.
1301 GetHeight
1302 Function documentation:
1303 Retrieves the height of this element.
1304 height = Layout:GetHeight() -- number <- void
1305 Return values:
1306 height: The height of this element.
1307 GetLeft
1308 Function documentation:
1309 Retrieves the X position of the left edge of this element.
1310 left = Layout:GetLeft() -- number <- void
1311 Return values:
1312 left: The X position of the left edge of this element.
1313 GetName
1314 Function documentation:
1315 Retrieves the name of this element.
1316 name = Layout:GetName() -- string <- void
1317 Return values:
1318 name: The name of this element, as provided by the addon that created it.
1319 GetOwner
1320 Function documentation:
1321 Retrieves the owner of this element.
1322 owner = Layout:GetOwner() -- string <- void
1323 Return values:
1324 owner: The owner of this element. Given as an addon identifier.
1325 GetRight
1326 Function documentation:
1327 Retrieves the X position of the right edge of this element.
1328 right = Layout:GetRight() -- number <- void
1329 Return values:
1330 right: The X position of the right edge of this element.
1331 GetTop
1332 Function documentation:
1333 Retrieves the Y position of the top edge of this element.
1334 top = Layout:GetTop() -- number <- void
1335 Return values:
1336 top: The Y position of the top edge of this element.
1337 GetType
1338 Function documentation:
1339 Retrieves the type of this element.
1340 type = Layout:GetType() -- string <- void
1341 Return values:
1342 type: The type of this element.
1343 GetWidth
1344 Function documentation:
1345 Retrieves the width of this element.
1346 width = Layout:GetWidth() -- number <- void
1347 Return values:
1348 width: The width of this element.
1349 ReadAll
1350 Function documentation:
1351 Read all set points and sizes from this frame.
1352 results = Layout:ReadAll() -- table <- void
1353 Return values:
1354 results: Result table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.
1355 ReadHeight
1356 Function documentation:
1357 Read a set height from this frame.
1358 height = Layout:ReadHeight() -- number <- void
1359 Return values:
1360 height: The parameter passed to SetHeight(), or nil if no such parameter has been passed.
1361 ReadPoint
1362 Function documentation:
1363 Read a set point from this frame. Must be given a single-axis coordinate.
1364 layout, position, offset = Layout:ReadPoint(coordinate) -- Layout, number, number <- string
1365 layout, position, offset = Layout:ReadPoint(x, y) -- Layout, number, number <- number/nil, number/nil
1366 origin, offset = Layout:ReadPoint(coordinate) -- string, number <- string
1367 origin, offset = Layout:ReadPoint(x, y) -- string, number <- number/nil, number/nil
1368 Parameters:
1369 coordinate: Named coordinate. Must be a one-axis coordinate.
1370 x: X coordinate of the point. Either this or Y must be nil.
1371 y: Y coordinate of the point. Either this or X must be nil.
1372 Return values:
1373 layout: The table that this point is pinned to.
1374 offset: The offset in pixels from the source location to the actual location.
1375 origin: The string "origin".
1376 position: The position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.
1377 ReadWidth
1378 Function documentation:
1379 Read a set width from this frame.
1380 width = Layout:ReadWidth() -- number <- void
1381 Return values:
1382 width: The parameter passed to SetWidth(), or nil if no such parameter has been passed.
1383 Events:
1384 Move
1385 Frame event documentation:
1386 Signals that the frame's vertices have moved.
1387 Layout.Event:Move()
1388 Size
1389 Frame event documentation:
1390 Signals that the frame's size has changed.
1391 Layout.Event:Size()
1392 Element: Inherits from Layout
1393 Members:
1394 GetAlpha
1395 Function documentation:
1396 Gets the alpha multiplier of this frame.
1397 alpha = Element:GetAlpha() -- number <- void
1398 Return values:
1399 alpha: The alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.
1400 GetBackgroundColor
1401 Function documentation:
1402 Retrieves the background color of this frame.
1403 r, g, b, a = Element:GetBackgroundColor() -- number, number, number, number <- void
1404 Return values:
1405 a: Alpha. 1 is fully opaque, 0 is fully transparent.
1406 b: Blue.
1407 g: Green.
1408 r: Red.
1409 GetKeyFocus
1410 Function documentation:
1411 Gets the key focus status.
1412 focus = Element:GetKeyFocus() -- boolean <- void
1413 Return values:
1414 focus: Whether this frame is the current key focus.
1415 GetMouseMasking
1416 Function documentation:
1417 Get the current mouse masking mode. See SetMouseMasking for details.
1418 mask = Element:GetMouseMasking() -- string <- void
1419 Return values:
1420 mask: The current mouse masking mode.
1421 GetVisible
1422 Function documentation:
1423 Gets the visibility flag for this frame.
1424 visible = Element:GetVisible() -- boolean <- void
1425 Return values:
1426 visible: This frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.
1427 SetAlpha
1428 Function documentation:
1429 Sets the alpha transparency multiplier for this frame and its children.
1430 Element:SetAlpha(alpha) -- number
1431 Parameters:
1432 alpha: The new alpha multiplier. 1 is fully opaque, 0 is fully transparent.
1433 SetBackgroundColor
1434 Function documentation:
1435 Sets the background color of this frame.
1436 Frame:SetBackgroundColor(r, g, b) -- number, number, number
1437 Frame:SetBackgroundColor(r, g, b, a) -- number, number, number, number
1438 Parameters:
1439 a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
1440 b: Blue.
1441 g: Green.
1442 r: Red.
1443 SetKeyFocus
1444 Function documentation:
1445 Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on another frame will automatically unset the current focus.
1446 Element:SetKeyFocus(focus) -- boolean
1447 Parameters:
1448 focus: The new key focus setting.
1449 SetMouseMasking
1450 Function documentation:
1451 Sets the frame's mouse masking mode.
1452 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1453 Element:SetMouseMasking(mask) -- string
1454 Parameters:
1455 mask: The new mouse masking mode. "full" is the standard mode, and means that creating any Left, Right, or movement-related mouse event will cause the frame to accept and consume any event from any of those types. "limited" causes the frame to accept and consume only events for buttons that have been hooked, so that hooking "LeftDown" will still pass Right mouse events through the frame. Note that hooking any keypress event will still consume MouseMove/In/Out events.
1456 SetVisible
1457 Function documentation:
1458 Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.
1459 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1460 Element:SetVisible(visible) -- boolean
1461 Parameters:
1462 visible: The new visibility flag.
1463 Events:
1464 KeyDown
1465 KeyFocusGain
1466 KeyFocusLoss
1467 KeyType
1468 KeyUp
1469 LeftClick
1470 LeftDown
1471 LeftUp
1472 LeftUpoutside
1473 MiddleClick
1474 MiddleDown
1475 MiddleUp
1476 MiddleUpoutside
1477 Mouse4Click
1478 Mouse4Down
1479 Mouse4Up
1480 Mouse4Upoutside
1481 Mouse5Click
1482 Mouse5Down
1483 Mouse5Up
1484 Mouse5Upoutside
1485 MouseIn
1486 MouseMove
1487 MouseOut
1488 RightClick
1489 RightDown
1490 RightUp
1491 RightUpoutside
1492 WheelBack
1493 WheelForward
1494 Frame: Inherits from Element
1495 Members:
1496 ClearAll
1497 Function documentation:
1498 Clear all set points and sizes from this frame.
1499 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1500 Frame:ClearAll() -- void
1501 ClearHeight
1502 Function documentation:
1503 Clear a set height from this frame.
1504 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1505 Frame:ClearHeight() -- void
1506 ClearPoint
1507 Function documentation:
1508 Clear a set point from this frame.
1509 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1510 Frame:ClearPoint(coordinate) -- string
1511 Frame:ClearPoint(x, y) -- number/nil, number/nil
1512 Parameters:
1513 coordinate: Named coordinate.
1514 x: X coordinate of the point.
1515 y: Y coordinate of the point.
1516 ClearWidth
1517 Function documentation:
1518 Clear a set width from this frame.
1519 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1520 Frame:ClearWidth() -- void
1521 GetLayer
1522 Function documentation:
1523 Gets the frame's layer order.
1524 layer = Frame:GetLayer() -- number <- void
1525 Return values:
1526 layer: The render layer of this frame. See Frame:SetLayer for details.
1527 GetMouseoverUnit
1528 Function documentation:
1529 Gets the unit that is being represented by this frame.
1530 unit = Frame:GetMouseoverUnit() -- string <- void
1531 Return values:
1532 unit: The current mouseover unit. May be nil if there is no mouseover unit.
1533 GetParent
1534 Function documentation:
1535 Gets the parent of this frame.
1536 parent = Frame:GetParent() -- Element <- void
1537 Return values:
1538 parent: The parent element of this frame.
1539 GetSecureMode
1540 Function documentation:
1541 Get the current secure mode. See SetSecureMode for details.
1542 secure = Frame:GetSecureMode() -- string <- void
1543 Return values:
1544 secure: The current secure mode.
1545 SetAllPoints
1546 Function documentation:
1547 Pins all the edges of this frame to the edges of a different frame. If no target is given, defaults to this frame's parent.
1548 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1549 Frame:SetAllPoints() -- void
1550 Frame:SetAllPoints(target) -- Layout
1551 Parameters:
1552 target: Target Layout to pin this frame's edges to.
1553 SetHeight
1554 Function documentation:
1555 Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
1556 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1557 Frame:SetHeight(height) -- number
1558 Parameters:
1559 height: The new height of this frame.
1560 SetLayer
1561 Function documentation:
1562 Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but stable during a single play session. Frames are always drawn after their parents.
1563 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1564 Frame:SetLayer(layer) -- number
1565 Parameters:
1566 layer: The new layer for this frame.
1567 SetMouseoverUnit
1568 Function documentation:
1569 Sets the unit that will be represented by this frame.
1570 Permitted only on a frame with "restricted" SecureMode while the addon environment is not secured.
1571 Frame:SetMouseoverUnit(unit) -- string
1572 Frame:SetMouseoverUnit(unit) -- nil
1573 Parameters:
1574 unit: The new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
1575 SetParent
1576 Function documentation:
1577 Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame's secure mode is "restricted", then its parent must also have a secure mode of "restricted".
1578 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1579 Frame:SetParent(parent) -- Element
1580 Parameters:
1581 parent: The new parent for this frame.
1582 SetPoint
1583 Function documentation:
1584 Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it.
1585 This function can take many different forms. In general, it looks like this: SetPoint(point_on_this_frame, target_frame, point_on_target_frame [, x_offset, y_offset]).
1586 The first part is the point on this frame that will be attached. Usually, these are string identifiers. "TOPLEFT", "TOPCENTER", "TOPRIGHT", "CENTERLEFT", "CENTER", "CENTERRIGHT", "BOTTOMLEFT", "BOTTOMCENTER", "BOTTOMRIGHT". You may also use a string identifier that refers to a single axis - "TOP", "BOTTOM", "LEFT", "RIGHT", "CENTERX", "CENTERY". If you want more direct numeric control you can use number pairs. 0,0 is equivalent to "TOPLEFT", 1,1 is equivalent to "BOTTOMRIGHT", 0.5,nil is equivalent to "CENTERX".
1587 The second part is the frame to attach to, as well as the point on that frame to attach to. The frame is simply passing in the frame table. The point is the same identifier or number pair as the first parameter.
1588 Optionally, you may include an X or Y offset to the point.
1589 This connection is permanent, and if the target frame moves, this frame will move along with it.
1590 Caveat: If the target is a frame set to the "restricted" SecureMode, and the client is currently in "secure" mode, then unexpected behavior may occur.
1591 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1592 Frame:SetPoint(...) -- ...
1593 Parameters:
1594 ...: This function's parameters are complicated. More details will be forthcoming.
1595 SetSecureMode
1596 Function documentation:
1597 Sets the frame's secure mode.
1598 "normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
1599 If you are not planning to use any restricted functions, your frame should remain in normal mode.
1600 Frame:SetSecureMode(secure) -- string
1601 Parameters:
1602 secure: The new secure mode. Valid inputs are "normal" and "restricted".
1603 SetWidth
1604 Function documentation:
1605 Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
1606 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1607 Frame:SetWidth(width) -- number
1608 Parameters:
1609 width: The new width of this frame.
1610 Events:
1611 (No extra events)
1612 Context: Inherits from Frame
1613 Members:
1614 (No extra members)
1615 Events:
1616 (No extra events)
1617 Mask: Inherits from Frame
1618 Members:
1619 (No extra members)
1620 Events:
1621 (No extra events)
1622 Text: Inherits from Frame
1623 Members:
1624 GetFont
1625 Function documentation:
1626 Gets the current font used for this element.
1627 source, font = Text:GetFont() -- string, string <- void
1628 Return values:
1629 font: The actual font identifier. Either a resource identifier or a filename.
1630 source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
1631 GetFontColor
1632 Function documentation:
1633 Gets the current font color for this element.
1634 r, g, b, a = Text:GetFontColor() -- number, number, number, number <- void
1635 Return values:
1636 a: Alpha. 1 is fully opaque, 0 is fully transparent.
1637 b: Blue.
1638 g: Green.
1639 r: Red.
1640 GetFontSize
1641 Function documentation:
1642 Gets the font size of the current element.
1643 fontsize = Text:GetFontSize() -- number <- void
1644 Return values:
1645 fontsize: The current font size of this element.
1646 GetFullHeight
1647 Function documentation:
1648 Get the height that would be required for this element to display all lines of text.
1649 This function is deprecated and will be removed in the future. It should not be used.
1650 height = Text:GetFullHeight() -- number <- void
1651 Return values:
1652 height: The element height needed to display all lines of text.
1653 GetFullWidth
1654 Function documentation:
1655 Get the width that would be required for this element to avoid word wrapping or truncation.
1656 This function is deprecated and will be removed in the future. It should not be used.
1657 width = Text:GetFullWidth() -- number <- void
1658 Return values:
1659 width: The element width needed to avoid word wrapping or truncation.
1660 GetText
1661 Function documentation:
1662 Get the current text for this element.
1663 text = Text:GetText() -- string <- void
1664 Return values:
1665 text: The current text of the element.
1666 GetWordwrap
1667 Function documentation:
1668 Gets the wordwrap flag for this element.
1669 wordwrap = Text:GetWordwrap() -- boolean <- void
1670 Return values:
1671 wordwrap: The current wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
1672 ResizeToText
1673 Function documentation:
1674 Sets the element's width and height to display all text without wordwrapping or truncation.
1675 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1676 This function is deprecated and will be removed in the future. It should not be used.
1677 Text:ResizeToText() -- void
1678 SetFont
1679 Function documentation:
1680 Sets the current font used for this element.
1681 Text:SetFont(source, font) -- string, string
1682 Parameters:
1683 font: The actual font identifier. Either a resource identifier or a filename.
1684 source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
1685 SetFontColor
1686 Function documentation:
1687 Sets the current font color for this element.
1688 Text:SetFontColor(r, g, b) -- number, number, number
1689 Text:SetFontColor(r, g, b, a) -- number, number, number, number
1690 Parameters:
1691 a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
1692 b: Blue.
1693 g: Green.
1694 r: Red.
1695 SetFontSize
1696 Function documentation:
1697 Sets the current font size of this element.
1698 Text:SetFontSize(fontsize) -- number
1699 Parameters:
1700 fontsize: The new font size of this element.
1701 SetText
1702 Function documentation:
1703 Sets the current text for this element.
1704 Text:SetText(text) -- string
1705 Parameters:
1706 text: The new text for the element.
1707 SetWordwrap
1708 Function documentation:
1709 Sets the wordwrap flag for this element.
1710 Text:SetWordwrap(wordwrap) -- boolean
1711 Parameters:
1712 wordwrap: The new wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
1713 Events:
1714 (No extra events)
1715 Texture: Inherits from Frame
1716 Members:
1717 GetTexture
1718 Function documentation:
1719 Gets the current texture used for this element.
1720 source, texture = Texture:GetTexture() -- string, string <- void
1721 Return values:
1722 source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
1723 texture: The actual texture identifier. Either a resource identifier or a filename.
1724 GetTextureHeight
1725 Function documentation:
1726 Returns the actual pixel height of the current texture.
1727 height = Texture:GetTextureHeight() -- number <- void
1728 Return values:
1729 height: The height of the current texture in pixels.
1730 GetTextureWidth
1731 Function documentation:
1732 Returns the actual pixel width of the current texture.
1733 width = Texture:GetTextureWidth() -- number <- void
1734 Return values:
1735 width: The width of the current texture in pixels.
1736 ResizeToTexture
1737 Function documentation:
1738 Sets the element's width and height to the exact pixel size of the texture.
1739 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1740 This function is deprecated and will be removed in the future. It should not be used.
1741 Texture:ResizeToTexture() -- void
1742 SetTexture
1743 Function documentation:
1744 Sets the current texture used for this element.
1745 Texture:SetTexture(source, texture) -- string, string
1746 Parameters:
1747 source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
1748 texture: The actual texture identifier. Either a resource identifier or a filename.
1749 Events:
1750 (No extra events)
1751 RiftButton: Inherits from Frame
1752 Members:
1753 GetDefaultHeight
1754 Function documentation:
1755 Returns the default height of Rift buttons.
1756 This function is deprecated and will be removed in the future. It should not be used.
1757 height = RiftButton:GetDefaultHeight() -- number <- void
1758 Return values:
1759 height: Default button height.
1760 GetDefaultWidth
1761 Function documentation:
1762 Returns the default width of Rift buttons.
1763 This function is deprecated and will be removed in the future. It should not be used.
1764 width = RiftButton:GetDefaultWidth() -- number <- void
1765 Return values:
1766 width: Default button width.
1767 GetEnabled
1768 Function documentation:
1769 Gets whether the button is enabled or grayed out.
1770 enabled = RiftButton:GetEnabled() -- boolean <- void
1771 Return values:
1772 enabled: The current enable state of this item.
1773 GetSkin
1774 Function documentation:
1775 Gets the current skin of this item.
1776 skin = RiftButton:GetSkin() -- string <- void
1777 Return values:
1778 skin: The current skin. Possible results include "default" and "close".
1779 GetText
1780 Function documentation:
1781 Gets this button's text.
1782 text = RiftButton:GetText() -- string <- void
1783 Return values:
1784 text: The current text of the element.
1785 ResizeToDefault
1786 Function documentation:
1787 Resizes this button to its default width and height.
1788 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1789 This function is deprecated and will be removed in the future. It should not be used.
1790 RiftButton:ResizeToDefault() -- void
1791 SetEnabled
1792 Function documentation:
1793 Sets whether the button is enabled or grayed out.
1794 RiftButton:SetEnabled(enabled) -- boolean
1795 Parameters:
1796 enabled: The new enable state of this item.
1797 SetSkin
1798 Function documentation:
1799 Sets the current skin of this item.
1800 RiftButton:SetSkin(skin) -- string
1801 Parameters:
1802 skin: The new skin. Possible values are "default" and "close".
1803 SetText
1804 Function documentation:
1805 Sets this button's text.
1806 RiftButton:SetText(text) -- string
1807 Parameters:
1808 text: The new text for the element.
1809 Events:
1810 LeftPress
1811 Frame event documentation:
1812 Signals that the button has been pressed. Equivalent to LeftClick, but only triggered while the button is enabled.
1813 RiftButton.Event:LeftPress()
1814 RiftCheckbox: Inherits from Frame
1815 Members:
1816 GetChecked
1817 Function documentation:
1818 Gets whether the button is checked or not.
1819 checked = RiftCheckbox:GetChecked() -- boolean <- void
1820 Return values:
1821 checked: The current checked state of this item.
1822 GetDefaultHeight
1823 Function documentation:
1824 Returns the default height of Rift checkboxes.
1825 This function is deprecated and will be removed in the future. It should not be used.
1826 height = RiftCheckbox:GetDefaultHeight() -- number <- void
1827 Return values:
1828 height: Default button height.
1829 GetDefaultWidth
1830 Function documentation:
1831 Returns the default width of Rift checkboxes.
1832 This function is deprecated and will be removed in the future. It should not be used.
1833 width = RiftCheckbox:GetDefaultWidth() -- number <- void
1834 Return values:
1835 width: Default button width.
1836 GetEnabled
1837 Function documentation:
1838 Gets whether the checkbox is enabled or grayed out.
1839 enabled = RiftCheckbox:GetEnabled() -- boolean <- void
1840 Return values:
1841 enabled: The current enable state of this item.
1842 ResizeToDefault
1843 Function documentation:
1844 Resizes this checkbox to its default width and height.
1845 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1846 This function is deprecated and will be removed in the future. It should not be used.
1847 RiftCheckbox:ResizeToDefault() -- void
1848 SetChecked
1849 Function documentation:
1850 Sets whether the checkbox is checked or not.
1851 RiftCheckbox:SetChecked(checked) -- boolean
1852 Parameters:
1853 checked: The new checked state of this item.
1854 SetEnabled
1855 Function documentation:
1856 Sets whether the checkbox is enabled or grayed out.
1857 RiftCheckbox:SetEnabled(enabled) -- boolean
1858 Parameters:
1859 enabled: The new enable state of this item.
1860 Events:
1861 CheckboxChange
1862 Frame event documentation:
1863 Signals that the checkbox's checked state has changed.
1864 RiftCheckbox.Event:CheckboxChange()
1865 RiftScrollbar: Inherits from Frame
1866 Members:
1867 GetEnabled
1868 Function documentation:
1869 Gets whether the scrollbar is enabled or disabled.
1870 enabled = RiftScrollbar:GetEnabled() -- boolean <- void
1871 Return values:
1872 enabled: The current enable state of this item.
1873 GetOrientation
1874 Function documentation:
1875 Gets the current orientation of the scrollbar.
1876 orientation = RiftScrollbar:GetOrientation() -- string <- void
1877 Return values:
1878 orientation: The current orientation. Valid results include "vertical" and "horizontal".
1879 GetPosition
1880 Function documentation:
1881 Returns the current position of the scrollbar.
1882 position = RiftScrollbar:GetPosition() -- number <- void
1883 Return values:
1884 position: The current position of this scrollbar.
1885 GetRange
1886 Function documentation:
1887 Returns the current range of the scrollbar.
1888 minimum, maximum = RiftScrollbar:GetRange() -- number, number <- void
1889 Return values:
1890 maximum: The maximum value for the position of this slider.
1891 minimum: The minimum value for the position of this slider.
1892 GetThickness
1893 Function documentation:
1894 Returns the thickness of the scrollbar handle. Size is relative to the range.
1895 thickness = RiftScrollbar:GetThickness() -- number <- void
1896 Return values:
1897 thickness: The thickness of the handle.
1898 Nudge
1899 Function documentation:
1900 Modify the scrollbar position, clamped to the current bounds.
1901 RiftScrollbar:Nudge(offset) -- number
1902 Parameters:
1903 offset: The amount to nudge.
1904 NudgeDown
1905 Function documentation:
1906 Shift the scrollbar down (i.e. away from zero) by a standard amount.
1907 RiftScrollbar:NudgeDown() -- void
1908 NudgeUp
1909 Function documentation:
1910 Shift the scrollbar up (i.e. towards zero) by a standard amount.
1911 RiftScrollbar:NudgeUp() -- void
1912 SetEnabled
1913 Function documentation:
1914 Sets whether the scrollbar is enabled or disabled.
1915 RiftScrollbar:SetEnabled(enabled) -- boolean
1916 Parameters:
1917 enabled: The new enable state of this item.
1918 SetOrientation
1919 Function documentation:
1920 Sets the orientation of the scrollbar.
1921 RiftScrollbar:SetOrientation(orientation) -- string
1922 Parameters:
1923 orientation: The new orientation. Must be either "vertical" or "horizontal".
1924 SetPosition
1925 Function documentation:
1926 Changes the current position of the scrollbar.
1927 RiftScrollbar:SetPosition(position) -- number
1928 Parameters:
1929 position: The new position of this scrollbar. Must be within the current range.
1930 SetRange
1931 Function documentation:
1932 Changes the current range of the scrollbar.
1933 RiftScrollbar:SetRange(minimum, maximum) -- number, number
1934 Parameters:
1935 maximum: The new maximum value for the position of this slider. Must be an integer and larger than "minimum".
1936 minimum: The new minimum value for the position of this slider. Must be an integer and smaller than "maximum".
1937 SetThickness
1938 Function documentation:
1939 Sets the current thickness of the scrollbar handle. Size is relative to the range.
1940 RiftScrollbar:SetThickness(thickness) -- number
1941 Parameters:
1942 thickness: The new thickness of the handle.
1943 Events:
1944 ScrollbarChange
1945 Frame event documentation:
1946 Signals a change in the scrollbar position.
1947 RiftScrollbar.Event:ScrollbarChange()
1948 ScrollbarGrab
1949 Frame event documentation:
1950 Signals the user grabbing the scrollbar with the mouse.
1951 RiftScrollbar.Event:ScrollbarGrab()
1952 ScrollbarRelease
1953 Frame event documentation:
1954 Signals the user releasing the scrollbar.
1955 RiftScrollbar.Event:ScrollbarRelease()
1956 RiftSlider: Inherits from Frame
1957 Members:
1958 GetDefaultHeight
1959 Function documentation:
1960 Returns the default height of Rift sliders.
1961 This function is deprecated and will be removed in the future. It should not be used.
1962 height = RiftSlider:GetDefaultHeight() -- number <- void
1963 Return values:
1964 height: Default button height.
1965 GetDefaultWidth
1966 Function documentation:
1967 Returns the default width of Rift sliders.
1968 This function is deprecated and will be removed in the future. It should not be used.
1969 width = RiftSlider:GetDefaultWidth() -- number <- void
1970 Return values:
1971 width: Default button width.
1972 GetEnabled
1973 Function documentation:
1974 Gets whether the slider is enabled or grayed out.
1975 enabled = RiftSlider:GetEnabled() -- boolean <- void
1976 Return values:
1977 enabled: The current enable state of this item.
1978 GetPosition
1979 Function documentation:
1980 Returns the current position of the slider.
1981 position = RiftSlider:GetPosition() -- number <- void
1982 Return values:
1983 position: The current position of this slider.
1984 GetRange
1985 Function documentation:
1986 Returns the current range of the slider.
1987 minimum, maximum = RiftSlider:GetRange() -- number, number <- void
1988 Return values:
1989 maximum: The maximum value for the position of this slider.
1990 minimum: The minimum value for the position of this slider.
1991 ResizeToDefault
1992 Function documentation:
1993 Resizes this slider to its default width and height.
1994 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
1995 This function is deprecated and will be removed in the future. It should not be used.
1996 RiftSlider:ResizeToDefault() -- void
1997 SetEnabled
1998 Function documentation:
1999 Sets whether the slider is enabled or grayed out.
2000 RiftSlider:SetEnabled(enabled) -- boolean
2001 Parameters:
2002 enabled: The new enable state of this item.
2003 SetPosition
2004 Function documentation:
2005 Changes the current position of the slider.
2006 RiftSlider:SetPosition(position) -- number
2007 Parameters:
2008 position: The new position of this slider. Must be within the current range.
2009 SetRange
2010 Function documentation:
2011 Sets the current range of the slider.
2012 RiftSlider:SetRange(minimum, maximum) -- number, number
2013 Parameters:
2014 maximum: The new maximum value for the position of this slider. Must be an integer and larger than "minimum".
2015 minimum: The new minimum value for the position of this slider. Must be an integer and smaller than "maximum".
2016 Events:
2017 SliderChange
2018 Frame event documentation:
2019 Signals a change in the slider position.
2020 RiftSlider.Event:SliderChange()
2021 SliderGrab
2022 Frame event documentation:
2023 Signals the user grabbing the slider with the mouse.
2024 RiftSlider.Event:SliderGrab()
2025 SliderRelease
2026 Frame event documentation:
2027 Signals the user releasing the slider.
2028 RiftSlider.Event:SliderRelease()
2029 RiftTextfield: Inherits from Frame
2030 Members:
2031 GetCursor
2032 Function documentation:
2033 Returns the current position of the cursor.
2034 cursor = RiftTextfield:GetCursor() -- number <- void
2035 Return values:
2036 cursor: The current position of this cursor. 0 indicates a cursor placed before any text.
2037 GetDefaultHeight
2038 Function documentation:
2039 Returns the default height of Rift textfields.
2040 This function is deprecated and will be removed in the future. It should not be used.
2041 height = RiftTextfield:GetDefaultHeight() -- number <- void
2042 Return values:
2043 height: Default textfield height.
2044 GetDefaultWidth
2045 Function documentation:
2046 Returns the default width of Rift textfields.
2047 This function is deprecated and will be removed in the future. It should not be used.
2048 width = RiftTextfield:GetDefaultWidth() -- number <- void
2049 Return values:
2050 width: Default textfield width.
2051 GetSelection
2052 Function documentation:
2053 Returns the current bounds of the selected text.
2054 begin, end = RiftTextfield:GetSelection() -- number, number <- void
2055 Return values:
2056 begin: The beginning of the selected text, in the same format GetCursor uses. nil if there is no text selected.
2057 end: The end of the selected text, in the same format GetCursor uses. nil if there is no text selected.
2058 GetSelectionText
2059 Function documentation:
2060 Get the current selected text for this element. Returns nil if no text has been selected.
2061 text = RiftTextfield:GetSelectionText() -- string <- void
2062 Return values:
2063 text: The current text of the element.
2064 GetText
2065 Function documentation:
2066 Get the current text for this element.
2067 text = RiftTextfield:GetText() -- string <- void
2068 Return values:
2069 text: The current text of the element.
2070 SetCursor
2071 Function documentation:
2072 Changes the current position of the cursor.
2073 RiftTextfield:SetCursor(cursor) -- number
2074 Parameters:
2075 cursor: The new position of this cursor. Must be within the valid range.
2076 SetSelection
2077 Function documentation:
2078 Sets the current bounds of the selected text. Call with no arguments to remove the current selection.
2079 RiftTextfield:SetSelection() -- void
2080 RiftTextfield:SetSelection(begin, end) -- number, number
2081 Parameters:
2082 begin: The new beginning of the selected text, in the same format SetCursor uses. Must be an integer and smaller than "end".
2083 end: The new end of the selected text, in the same format SetCursor uses. Must be an integer and larger than "begin".
2084 SetText
2085 Function documentation:
2086 Set the current text for this element.
2087 RiftTextfield:SetText(text) -- string
2088 Parameters:
2089 text: The new text for the element.
2090 Events:
2091 TextfieldChange
2092 Frame event documentation:
2093 Signals that the textfield's text has changed.
2094 RiftTextfield.Event:TextfieldChange()
2095 TextfieldSelect
2096 Frame event documentation:
2097 Signals that the textfield's selection has changed.
2098 RiftTextfield.Event:TextfieldSelect()
2099 RiftWindow: Inherits from Frame
2100 Members:
2101 GetBorder
2102 Function documentation:
2103 Gets the element representing the window border.
2104 border = RiftWindow:GetBorder() -- Element <- void
2105 Return values:
2106 border: The window border.
2107 GetContent
2108 Function documentation:
2109 Gets the element representing the window content area.
2110 content = RiftWindow:GetContent() -- Element <- void
2111 Return values:
2112 content: The window content area.
2113 GetController
2114 Function documentation:
2115 Gets the ID of the current controller for this window.
2116 controller = RiftWindow:GetController() -- string <- void
2117 Return values:
2118 controller: "border" or "content", whichever dictates the dimensions of the other.
2119 GetDefaultHeight
2120 Function documentation:
2121 Returns the default height of Rift windows.
2122 This function is deprecated and will be removed in the future. It should not be used.
2123 height = RiftWindow:GetDefaultHeight() -- number <- void
2124 Return values:
2125 height: Default window height.
2126 GetDefaultWidth
2127 Function documentation:
2128 Returns the default width of Rift windows.
2129 This function is deprecated and will be removed in the future. It should not be used.
2130 width = RiftWindow:GetDefaultWidth() -- number <- void
2131 Return values:
2132 width: Default window width.
2133 GetTitle
2134 Function documentation:
2135 Get the current title for this element.
2136 title = RiftWindow:GetTitle() -- string <- void
2137 Return values:
2138 title: The current title of the element.
2139 GetTrimDimensions
2140 Function documentation:
2141 Gets the thicknesses of the border's visual trim.
2142 left, top, right, bottom = RiftWindow:GetTrimDimensions() -- number, number, number, number <- void
2143 Return values:
2144 bottom: The thickness of the bottom window border.
2145 left: The thickness of the left window border.
2146 right: The thickness of the right window border.
2147 top: The thickness of the top window border.
2148 SetController
2149 Function documentation:
2150 Sets the current controller for this window. The controller will take on the exact dimensions of the RiftWindow object, and the other element will adjust accordingly.
2151 Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
2152 RiftWindow:SetController(controller) -- string
2153 Parameters:
2154 controller: The new controller ID. May be either "border" or "content".
2155 SetTitle
2156 Function documentation:
2157 Set the current title for this element.
2158 RiftWindow:SetTitle(title) -- string
2159 Parameters:
2160 title: The new title for the element.
2161 Events:
2162 (No extra events)