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