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