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