Advertisement
Guest User

Untitled

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