ZorbaTHut

Rift PTS detail documentation

Jan 12th, 2012
1,621
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
  1. Basic globals:
  2. UI.Context
  3. Lists all contexts that have been created. Organizes them under [addonIdentifier][contextIdentifier][constructionOrder]. As an example, if TestAddon created four contexts named UIElement, the second would be UI.Context.TestAddon.UIElement[2].
  4. UI.CreateContext
  5. Function documentation:
  6. Creates a new UI context. A UI context must be created in order to create any frames.
  7. context = UI.CreateContext(name) -- Context <- string
  8. Parameters:
  9. name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
  10. Return values:
  11. context: A new context. Contexts are guaranteed to have at least the capabilities of a Frame.
  12. UI.CreateFrame
  13. Function documentation:
  14. 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.
  15. List of valid frame types:
  16. Frame: The base type. No special capabilities. Useful for spacing, organization, input handling, and solid color squares.
  17. Mask: Obscures the contents of child frames that do not fall within the mask boundaries.
  18. Text: Displays text.
  19. Texture: Displays a static texture image.
  20. RiftButton: A standard Rift button widget.
  21. RiftCheckbox: A standard Rift checkbox widget.
  22. RiftScrollbar: A standard Rift scrollbar widget.
  23. RiftSlider: A standard Rift slider widget.
  24. RiftTextfield: A standard Rift textfield widget.
  25. RiftWindow: A standard Rift window widget.
  26. frame = UI.CreateFrame(type, name, parent) -- Frame <- string, string, Element
  27. Parameters:
  28. name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
  29. parent: The new parent for this frame.
  30. type: The type of your new frame. Current supported types: Frame, Text, Texture.
  31. Return values:
  32. frame: Your new frame.
  33. UI.Frame
  34. Lists all frames that have been created. Organizes them under [addonIdentifier][contextIdentifier][constructionOrder]. As an example, if TestAddon created four frames named UIElement, the second would be UI.Frame.TestAddon.UIElement[2].
  35. UIParent.Event.Move
  36. UIParent.Event.Size
  37. _VERSION
  38. assert
  39. bit.arshift
  40. bit.band
  41. bit.bnot
  42. bit.bor
  43. bit.bswap
  44. bit.bxor
  45. bit.lshift
  46. bit.rol
  47. bit.ror
  48. bit.rshift
  49. bit.tobit
  50. bit.tohex
  51. collectgarbage
  52. coroutine.create
  53. coroutine.resume
  54. coroutine.running
  55. coroutine.status
  56. coroutine.wrap
  57. coroutine.yield
  58. debug.traceback
  59. dump
  60. Function documentation:
  61. Debug utility function. Similar to print(), but serializes any table parameters before outputting.
  62. dump(...) -- ...
  63. Parameters:
  64. ...: Takes any number of any parameter type.
  65. error
  66. An error, represented by a standard ID with an 'x' prefix.
  67. gcinfo
  68. getfenv
  69. getmetatable
  70. ipairs
  71. load
  72. loadstring
  73. math.abs
  74. math.acos
  75. math.asin
  76. math.atan
  77. math.atan2
  78. math.ceil
  79. math.cos
  80. math.cosh
  81. math.deg
  82. math.exp
  83. math.floor
  84. math.fmod
  85. math.frexp
  86. math.huge
  87. math.ldexp
  88. math.log
  89. math.log10
  90. math.max
  91. math.min
  92. math.modf
  93. math.pi
  94. math.pow
  95. math.rad
  96. math.random
  97. math.randomseed
  98. math.sin
  99. math.sinh
  100. math.sqrt
  101. math.tan
  102. math.tanh
  103. math.tau
  104. newproxy
  105. next
  106. os.date
  107. os.difftime
  108. os.time
  109. pairs
  110. pcall
  111. print
  112. rawequal
  113. rawget
  114. rawlen
  115. rawset
  116. select
  117. setfenv
  118. setmetatable
  119. string.byte
  120. string.char
  121. string.find
  122. string.format
  123. string.gmatch
  124. string.gsub
  125. string.len
  126. string.lower
  127. string.match
  128. string.rep
  129. string.reverse
  130. string.sub
  131. string.upper
  132. table.concat
  133. table.foreach
  134. table.foreachi
  135. table.getn
  136. table.insert
  137. table.maxn
  138. table.pack
  139. table.remove
  140. table.sort
  141. table.unpack
  142. tonumber
  143. tostring
  144. type
  145. unpack
  146. xpcall
  147. zlib.BEST_COMPRESSION
  148. zlib.BEST_SPEED
  149. zlib._COPYRIGHT
  150. zlib._DESCRIPTION
  151. zlib._VERSION
  152. zlib.deflate
  153. zlib.inflate
  154.  
  155. Inspectors:
  156. Inspect.Ability.New.Detail
  157. Function documentation:
  158. Provides detailed information about abilities.
  159. detail = Inspect.Ability.New.Detail(ability) -- table <- ability
  160. details = Inspect.Ability.New.Detail(abilities) -- table <- table
  161. Parameters:
  162. abilities: A table of identifiers of abilities to retrieve detail for.
  163. ability: The identifier of the ability to retrieve detail for.
  164. Return values:
  165. detail: Detail table for a single ability.
  166. details: Detail tables for all requested abilities. The key is the ability ID, the value is the ability's detail table.
  167. Returned members:
  168. autoattack: Autoattack mode of the ability.
  169. castingTime: Casting time of the ability, in seconds.
  170. channeled: Signals that the ability is channeled.
  171. continuous: Signals that the ability is continuous.
  172. cooldown: Cooldown of the ability, in seconds.
  173. costCharge: The amount of charge this ability consumes on use.
  174. costEnergy: The amount of energy this ability consumes on use.
  175. costMana: The amount of mana this ability consumes on use.
  176. costPlanarCharge: The amount of planar charges this ability consumes on use.
  177. costPower: The amount of power this ability consumes on use.
  178. currentCooldownBegin: The time the current cooldown started, in the context of Inspect.Time.Frame.
  179. currentCooldownDuration: Duration of the current cooldown the ability is influenced by, in seconds.
  180. currentCooldownExpired: Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
  181. currentCooldownPaused: Indicates that this ability's cooldown is paused.
  182. currentCooldownRemaining: Time remaining in the ability's current cooldown, in seconds.
  183. description: Description for the ability.
  184. gainCharge: Amount of charge gained by using the ability.
  185. icon: Resource filename of the ability's icon.
  186. id: The ID of the requested element.
  187. idNew: The new ability ID.
  188. name: Name of the ability.
  189. outOfRange: Signals that the ability is out of range.
  190. passive: Signals that the ability is passive.
  191. positioned: Signals that the ability's effect is manually positioned by the user.
  192. racial: Signals that the ability is a racial ability.
  193. rangeMax: The maximum range of the ability.
  194. rangeMin: The minimum range of the ability.
  195. stealthRequired: Signals that the ability requires the user to be in stealth.
  196. target: The Unit ID of the unit that this ability will be used on if triggered at this moment.
  197. unusable: Signals that this ability is unusable.
  198. weapon: The required equipped weapon for this ability. May be "any", "melee", or "ranged".
  199. Inspect.Ability.New.List
  200. Function documentation:
  201. List available abilities.
  202. abilities = Inspect.Ability.New.List() -- table <- void
  203. Return values:
  204. abilities: A table of IDs of the available abilities.
  205. Inspect.Achievement.Category.Detail
  206. Function documentation:
  207. Returns information about achievement categories.
  208. detail = Inspect.Achievement.Category.Detail(category) -- table <- achievementcategory
  209. details = Inspect.Achievement.Category.Detail(categories) -- table <- table
  210. Parameters:
  211. categories: A table of identifiers of achievement categories to retrieve detail for.
  212. category: The identifier of the achievement category to retrieve detail for.
  213. Return values:
  214. detail: Detail table for a single achievement category.
  215. details: Detail tables for all requested achievement categories. The key is the category ID, the value is the category's detail table.
  216. Returned members:
  217. id: The ID of the requested element.
  218. name: The name of the achievement category.
  219. parent: The category's parent, if it has one.
  220. Inspect.Achievement.Category.List
  221. Function documentation:
  222. Returns a table of valid achievement categories.
  223. categories = Inspect.Achievement.Category.List() -- table <- void
  224. Return values:
  225. categories: Valid achievement categories, in {id = true} format.
  226. Inspect.Achievement.Detail
  227. Function documentation:
  228. Provides detailed information about achievements.
  229. detail = Inspect.Achievement.Detail(achievement) -- table <- achievement
  230. details = Inspect.Achievement.Detail(achievements) -- table <- table
  231. Parameters:
  232. achievement: The identifier of the achievement to retrieve detail for.
  233. achievements: A table of identifiers of achievements to retrieve detail for.
  234. Return values:
  235. detail: Detail table for a single achievement.
  236. details: Detail tables for all requested achievements. The key is the achievement ID, the value is the achievement's detail table.
  237. Returned members:
  238. alliance: The alliance that this achievement requires, either "guardian", "defiant", or nil.
  239. category: ID of the achievement's category.
  240. complete: true is the achievement is completed by this character. If the achievement has been completed by another of the player's characters, gives that character's name.
  241. description: The achievement's description.
  242. icon: Internal name of the achievement's icon.
  243. id: The ID of the requested element.
  244. name: The achievement's name.
  245. previous: The ID of the achievement immediately previous to this in a chain.
  246. requirement: Table listing the requirements for this achievement. Each item may include multiple members.
  247. type: The type of the requirement. Valid values include "achievement", "artifactset", "discover", "event", "quest", and "tradeskill".
  248. name: The name of the requirement.
  249. count: The count required for completion.
  250. countDone: The count already completed.
  251. complete: Signals that this requirement is complete.
  252. id: The id of whatever this requires.
  253. score: The number of points this achievement awards for completion.
  254. sort: A number indicating the order that this achievement should be sorted in.
  255. title: The ID of the title this achievement awards.
  256. watch: Signals that this achievement is being watched.
  257. Inspect.Achievement.List
  258. Function documentation:
  259. Returns a table of all known achievements.
  260. achievements = Inspect.Achievement.List() -- table <- void
  261. Return values:
  262. achievements: All known achievements, in {id = true} format.
  263. Inspect.Addon.Cpu
  264. Function documentation:
  265. Returns recent CPU usage information. This is calculated using an exponential-falloff method.
  266. data = Inspect.Addon.Cpu() -- table <- void
  267. Return values:
  268. 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.
  269. Inspect.Addon.Current
  270. Function documentation:
  271. Returns the current addon. This information is used internally for counting CPU usage and determining frame ownership.
  272. addonIdentifier = Inspect.Addon.Current() -- string <- void
  273. Return values:
  274. addonIdentifier: The addon's identifier, as written in its TOC file.
  275. Inspect.Addon.Detail
  276. Function documentation:
  277. Provides detailed information about loaded addons.
  278. detail = Inspect.Addon.Detail(addon) -- table <- string
  279. details = Inspect.Addon.Detail(addons) -- table <- table
  280. Parameters:
  281. addon: An addon identifier.
  282. addons: A table containing addon identifiers.
  283. Return values:
  284. detail: Detail table for a single addon.
  285. details: Detail tables for all requested addons. The key is the addon identifier, the value is the addon's detail table.
  286. Returned members:
  287. data: The "data" table provided to the addon at load time.
  288. description: The chosen localization of the TOC Description field.
  289. id: The ID of the requested element.
  290. identifier: The addon's identifier.
  291. name: The chosen localization of the TOC Name field.
  292. nameShort: The chosen localization of the TOC NameShort field.
  293. toc: The addon's RiftAddon.toc file, parsed and in table form.
  294. Inspect.Addon.List
  295. Function documentation:
  296. Lists all the addons that the client has loaded.
  297. addons = Inspect.Addon.List() -- table <- void
  298. Return values:
  299. addons: Map of addon identifier to addon version, or "true" if no version is provided.
  300. Inspect.Attunement.Progress
  301. Function documentation:
  302. Returns information on your current attunement progress.
  303. result = Inspect.Attunement.Progress() -- table <- void
  304. Return values:
  305. result: Table containing information on attunement progress.
  306. Returned members:
  307. accumulated: Attunement experience accumulated so far in this attunement level.
  308. available: Number of unused attunement ranks.
  309. needed: Quantity of attunement experience needed to gain a level.
  310. rested: Quantity of available attunement rested experience.
  311. spent: Number of spent attunement ranks.
  312. Inspect.Auction.Detail
  313. Function documentation:
  314. Provides detailed information about auctions.
  315. Requires the "auction" interaction flag to be set.
  316. detail = Inspect.Auction.Detail(auction) -- table <- auction
  317. details = Inspect.Auction.Detail(auctions) -- table <- table
  318. Parameters:
  319. auction: An identifier for the auction to retrieve detail for.
  320. auctions: A table containing auction identifiers to retrieve details for. The value is the sort order.
  321. Return values:
  322. detail: Detail table for a single auction.
  323. details: Detail tables for all requested auctions. The key is the auction ID, the value is the auction's detail table.
  324. Returned members:
  325. bid: The current bid on this auction, in silver.
  326. bidder: Current high bidder on this auction. Available only if your current character is the bidder or the seller.
  327. buyout: The buyout amount for this auction, in silver.
  328. id: The ID of the requested element.
  329. item: ID of the item involved in the auction.
  330. itemStack: The size of this item stack.
  331. itemType: The item's type specifier.
  332. partial: Whether partial buyouts are permitted.
  333. remaining: Time remaining in the auction, as a number of seconds.
  334. seller: The name of the auction's seller.
  335. Inspect.Buff.Detail
  336. Function documentation:
  337. Provides detailed information about the buffs on a unit.
  338. detail = Inspect.Buff.Detail(unit, buff) -- table <- unit, buff
  339. details = Inspect.Buff.Detail(unit, buffs) -- table <- unit, table
  340. Parameters:
  341. buff: An identifier for the buff to retrieve detail for.
  342. buffs: A table containing buff identifiers to retrieve details for.
  343. unit: The unit to inspect.
  344. Return values:
  345. detail: Detail table for a single buff.
  346. details: Detail tables for all requested buffs. The key is the buff ID, the value is the buff's detail table.
  347. Returned members:
  348. ability: The ID of the ability that created this buff. Not guaranteed to exist.
  349. begin: The time the buff started, in the context of Inspect.Time.Frame.
  350. caster: Unit ID of the buff's caster.
  351. curse: Signals that the buff is a curse.
  352. debuff: Signals that the buff is a debuff. If this is missing, then it's an actual buff.
  353. description: Description for the buff. Numbers may not be accurate - see Command.Buff.Describe().
  354. descriptionComplete: Signals that the buff description is complete.
  355. disease: Signals that the buff is a disease.
  356. duration: Duration of the buff in seconds.
  357. expired: Number of seconds the buff is past its expiration time. Generally indicates lag.
  358. icon: Resource filename of the buff's icon.
  359. id: The ID of the requested element.
  360. name: Name of the buff.
  361. noncancelable: Signals that the buff cannot be voluntarily canceled. Does not show up for debuffs.
  362. poison: Signals that the buff is a poison.
  363. remaining: Time remaining on the buff, in seconds.
  364. rune: If this buff is created by a rune, the ID of the rune causing it.
  365. stack: Number of stacks on the buff.
  366. type: The buff type ID.
  367. Inspect.Buff.List
  368. Function documentation:
  369. List buffs on a unit.
  370. buffs = Inspect.Buff.List(unit) -- table <- unit
  371. Parameters:
  372. unit: The unit to inspect.
  373. Return values:
  374. buffs: A table of the IDs of the buffs on the unit.
  375. Inspect.Console.Detail
  376. Function documentation:
  377. Provides detailed information about consoles.
  378. detail = Inspect.Console.Detail(console) -- table <- console
  379. details = Inspect.Console.Detail(consoles) -- table <- table
  380. Parameters:
  381. console: The identifier of the console to retrieve information for. May also be "general" or "combat".
  382. consoles: A table of consoles to retrieve detail for.
  383. Return values:
  384. detail: Detail table for a single console.
  385. details: Detail tables for all requested consoles.
  386. Returned members:
  387. accolade: Indicates that this console displays Accolade messages.
  388. achievement: Indicates that this console displays Achievement messages.
  389. channel: May contain a table of public channels that this console will display. nil if the console does not display any public channels.
  390. combatBad: Indicates that this console displays Combat Bad messages.
  391. combatGood: Indicates that this console displays Combat Good messages.
  392. combatNeutral: Indicates that this console displays Combat Neutral messages.
  393. combatOther: Indicates that this console displays Combat Other messages.
  394. combatSpecial: Indicates that this console displays Combat Special messages.
  395. craftingOther: Indicates that this console displays Crafting Others messages.
  396. craftingSelf: Indicates that this console displays Crafting Self messages.
  397. emote: Indicates that this console displays Emote messages.
  398. experience: Indicates that this console displays Experience messages.
  399. guild: Indicates that this console displays Guild messages.
  400. id: The ID of the requested element.
  401. lootGroup: Indicates that this console displays Group Loot messages.
  402. lootItem: Indicates that this console displays Item Loot messages.
  403. lootMoney: Indicates that this console displays Money Loot messages.
  404. name: The player-chosen name of the console.
  405. notoriety: Indicates that this console displays Notoriety messages.
  406. npc: Indicates that this console displays NPC messages.
  407. officer: Indicates that this console displays Officer messages.
  408. party: Indicates that this console displays Party messages.
  409. purchase: Indicates that this console displays Purchase messages.
  410. raid: Indicates that this console displays Raid messages.
  411. raidWarning: Indicates that this console displays Raid Warning messages.
  412. say: Indicates that this console displays Say messages.
  413. skill: Indicates that this console displays Skill messages.
  414. system: Indicates that this console displays System messages.
  415. tell: Indicates that this console displays Tell messages.
  416. twitter: Indicates that this console displays Twitter messages.
  417. yell: Indicates that this console displays Yell messages.
  418. Inspect.Console.List
  419. Function documentation:
  420. Returns a table of the current open text consoles.
  421. consoles = Inspect.Console.List() -- table <- void
  422. Return values:
  423. consoles: A table containing the IDs of the available consoles.
  424. Inspect.Currency.Category.Detail
  425. Function documentation:
  426. Returns information about currency categories.
  427. detail = Inspect.Currency.Category.Detail(category) -- table <- currencycategory
  428. details = Inspect.Currency.Category.Detail(categories) -- table <- table
  429. Parameters:
  430. categories: A table of identifiers of currency categories to retrieve detail for.
  431. category: The identifier of the currency category to retrieve detail for.
  432. Return values:
  433. detail: Detail table for a single currency category.
  434. details: Detail tables for all requested currency categories. The key is the category ID, the value is the category's detail table.
  435. Returned members:
  436. id: The ID of the requested element.
  437. name: The name of the currency category.
  438. Inspect.Currency.Category.List
  439. Function documentation:
  440. Returns a table of valid currency categories.
  441. categories = Inspect.Currency.Category.List() -- table <- void
  442. Return values:
  443. categories: Valid currency categories, in {id = true} format.
  444. Inspect.Currency.Detail
  445. Function documentation:
  446. Provides detailed information about currencies.
  447. detail = Inspect.Currency.Detail(coin) -- table <- string
  448. detail = Inspect.Currency.Detail(currency) -- table <- itemtype
  449. details = Inspect.Currency.Detail(currencies) -- table <- table
  450. Parameters:
  451. coin: The string "coin", used as a value to request the player's money.
  452. currencies: A table of identifiers of currencies to retrieve detail for.
  453. currency: The identifier of the currency to retrieve detail for.
  454. Return values:
  455. detail: Detail table for a single currency.
  456. details: Detail tables for all requested currencies. The key is the currency ID, the value is the currency's detail table.
  457. Returned members:
  458. category: ID of the currency's category.
  459. icon: Internal name of the currency's icon.
  460. id: The ID of the requested element.
  461. name: The currency's name.
  462. stack: The number of this currency that you have.
  463. stackMax: The maximum number of this currency that you can have.
  464. Inspect.Currency.List
  465. Function documentation:
  466. Returns a table of all known currencies.
  467. currencies = Inspect.Currency.List() -- table <- void
  468. Return values:
  469. currencies: All known currencies, in {id = amount} format.
  470. Inspect.Cursor
  471. Function documentation:
  472. Returns the current contents of the cursor.
  473. type, held = Inspect.Cursor() -- nil, nil <- void
  474. type, held = Inspect.Cursor() -- string, variant <- void
  475. Return values:
  476. held: The blob describing what is currently held. Generally, some kind of identifier used in another part of the addon system.
  477. type: The current cursor type. Valid values include "ability", "item", "itemtype", and nil.
  478. Inspect.Dimension.Layout.Detail
  479. Function documentation:
  480. Returns details about the specified dimension item.
  481. detail = Inspect.Dimension.Layout.Details(dimensionitem) -- table <- dimensionitem
  482. details = Inspect.Dimension.Layout.Details(dimensionitems) -- table <- table
  483. Parameters:
  484. dimensionitem: The identifier of the dimension item to retrieve detail for.
  485. dimensionitems: A table of identifiers of dimension items to retrieve detail for.
  486. Return values:
  487. detail: Table of details about the dimension item specified.
  488. details: Detail table for all requsted dimension items. The key is the dimension item ID, the value is the dimension item's detail table.
  489. Returned members:
  490. coordX: The X coordinate of the item.
  491. coordY: The Y coordinate of the item.
  492. coordZ: The Z coordinate of the item.
  493. crated: Indicates that the item is crated.
  494. icon: Resource filename of the item's icon.
  495. id: The item's id.
  496. name: The name of the item.
  497. pitch: The pitch of the item.
  498. roll: The roll of the item.
  499. scale: The scale of the item.
  500. selected: Indicates that the item is selected.
  501. type: The type of the item.
  502. yaw: The yaw of the item.
  503. Inspect.Dimension.Layout.List
  504. Function documentation:
  505. Returns a list of dimension items in the dimension you're currently in, and whether or not they are crated.
  506. list = Inspect.Dimension.Layout.List() -- table <- void
  507. Return values:
  508. list: The list of detail results.
  509. Inspect.Documentation
  510. Function documentation:
  511. 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.
  512. documentables = Inspect.Documentation() -- table <- void
  513. documentation = Inspect.Documentation(item) -- string <- variant
  514. documentation = Inspect.Documentation(item, parseable) -- string <- variant, boolean
  515. documentationTable = Inspect.Documentation(item, parseable) -- table <- variant, boolean
  516. Parameters:
  517. item: The item to get documentation on. May be either the item itself or a string identifier.
  518. parseable: Whether to return in a computer-readable format, as opposed to the normal human-readable format.
  519. Return values:
  520. documentables: List of all items that documentation can be retrieved for. In {["itemname"] = true} format.
  521. documentation: Documentation for the requested item.
  522. documentationTable: Computer-readable documentation for the requested item. Format may change without warning.
  523. Returned members:
  524. (other): May include many other parameters. These parameters are not yet documented.
  525. disabled: Boolean that indicates whether this function is disabled for deprecation reasons.
  526. readable: Human-readable string version of this documentation.
  527. Inspect.Event.List
  528. Function documentation:
  529. Lists the current event handlers for an event.
  530. result = Inspect.Event.List(event) -- table <- eventGlobal
  531. Parameters:
  532. event: A global event handle, usually pulled out of the "Event." hierarchy.
  533. Return values:
  534. result: A table of event handlers for this event.
  535. Returned members:
  536. handler: The handler that will be called when the event fires.
  537. label: Label assigned to the event handler at creation.
  538. owner: Owner addon for the event handler.
  539. priority: Priority for the event handler.
  540. Inspect.Experience
  541. Function documentation:
  542. Returns information on your experience.
  543. result = Inspect.Experience() -- table <- void
  544. Return values:
  545. result: Table containing information on experience.
  546. Returned members:
  547. accumulated: Experience accumulated so far in this character level.
  548. needed: Quantity of experience needed to gain a level.
  549. rested: Quantity of available rested experience.
  550. Inspect.Faction.Detail
  551. Function documentation:
  552. Provides detailed information about factions.
  553. detail = Inspect.Faction.Detail(faction) -- table <- faction
  554. details = Inspect.Faction.Detail(factions) -- table <- table
  555. Parameters:
  556. faction: The identifier of the faction to retrieve detail for.
  557. factions: A table of identifiers of factions to retrieve detail for.
  558. Return values:
  559. detail: Detail table for a single faction.
  560. details: Detail tables for all requested factions. The key is the faction ID, the value is the faction's detail table.
  561. Returned members:
  562. categoryName: Name of the faction's category.
  563. id: The ID of the requested element.
  564. name: The faction's name.
  565. notoriety: The current notoriety you have with this faction.
  566. Inspect.Faction.List
  567. Function documentation:
  568. Returns a table of all known factions.
  569. factions = Inspect.Faction.List() -- table <- void
  570. Return values:
  571. factions: All known factions, in {id = notoriety} format.
  572. Inspect.Guild.Bank.Coin
  573. Function documentation:
  574. Returns the amount of money contained within the guild bank.
  575. Requires the "guildbank" interaction flag to be set.
  576. coin = Inspect.Guild.Bank.Coin() -- number <- void
  577. Return values:
  578. coin: The current money in the guild bank, in silver.
  579. Inspect.Guild.Bank.Detail
  580. Function documentation:
  581. Provides detailed information about guild bank vaults.
  582. detail = Inspect.Guild.Bank.Detail(guildvault) -- table <- slot
  583. details = Inspect.Guild.Bank.Detail(guildvaults) -- table <- table
  584. Parameters:
  585. guildvault: A slot specifier representing the entire guild bank vault to retrieve information for.
  586. guildvaults: A table of slot specifiers, each representing an entire guild bank vault, to retrieve information for.
  587. Return values:
  588. detail: Detail table for a guild bank vault.
  589. details: Detail tables for all requested guild bank vault. The key is the vault specifier, the value is the vault's detail table.
  590. Returned members:
  591. id: The ID of the requested element.
  592. name: The name of the vault.
  593. Inspect.Guild.Bank.List
  594. Function documentation:
  595. Returns a table of all available guild bank vaults.
  596. list = Inspect.Guild.Bank.List() -- table <- void
  597. Return values:
  598. list: All available guild vaults, in {id = name} format.
  599. Inspect.Guild.Motd
  600. Function documentation:
  601. Returns the current guild Message of the Day.
  602. motd = Inspect.Guild.Motd() -- string <- void
  603. Return values:
  604. motd: The current Message of the Day.
  605. Inspect.Guild.Rank.Detail
  606. Function documentation:
  607. Provides detailed information about guild ranks.
  608. detail = Inspect.Guild.Rank.Detail(guildrank) -- table <- guildrank
  609. details = Inspect.Guild.Rank.Detail(guildranks) -- table <- table
  610. Parameters:
  611. guildrank: The identifier of the rank to retrieve detail for.
  612. guildranks: A table of identifiers of ranks to retrieve detail for.
  613. Return values:
  614. detail: Detail table for a single rank.
  615. details: Detail table for all requested ranks. The key is the rank ID, the value is the rank's detail table.
  616. Returned members:
  617. addonStorageDelete: Signals that this rank has permission to modify or delete addon storage elements.
  618. addonStorageWrite: Signals that this rank has permission to non-destructively write addon storage elements.
  619. demote: Signals that this rank has permission to demote guildmembers.
  620. finderEdit: Signals that this rank has permission to edit the Guild Finder settings.
  621. finderReceive: Signals that this rank has permission to receive Guild Finder messages.
  622. id: The ID of the requested element.
  623. invite: Signals that this rank has permission to invite new guildmembers.
  624. kick: Signals that this rank has permission to kick guildmembers.
  625. listen: Signals that this rank has permission to listen to guild chat.
  626. motd: Signals that this rank has permission to change the guild Message of the Day.
  627. name: The name of this rank.
  628. noteOfficer: Signals that this rank has permission to view and edit Officer Notes.
  629. officer: Signals that this rank has permission to listen to and speak in officer chat.
  630. perk: Signals that this rank has permission to choose guild perks.
  631. promote: Signals that this rank has permission to promote guildmembers.
  632. questAbandon: Signals that this rank has permission to abandon guild quests.
  633. questAccept: Signals that this rank has permission to accept guild quests.
  634. questComplete: Signals that this rank has permission to complete guild quests.
  635. rally: Signals that this rank has permission to set the guild rally point.
  636. rankEdit: Signals that this rank has permission to edit rank permissions.
  637. rename: Signals that this rank has permission to rename the guild.
  638. speak: Signals that this rank has permission to speak in guild chat.
  639. vaultAccess: A table containing information on vault access permissions. The key is the vault ID in slot format. The value is a table containing two members, "access" which may be nil, "deposit", or "full", and "withdrawLimit" which gives the number of stacks that may be withdrawn daily.
  640. vaultBuy: Signals that this rank has permission to buy guild vaults.
  641. vaultRename: Signals that this rank has permission to rename guild vaults.
  642. wallDelete: Signals that this rank has permission to delete entries off the Guild Wall.
  643. wallPost: Signals that this rank has permission to post to the Guild Wall.
  644. Inspect.Guild.Rank.List
  645. Function documentation:
  646. Lists available guild ranks.
  647. list = Inspect.Guild.Rank.List() -- table <- void
  648. Return values:
  649. list: A table of the IDs of the available ranks. The value is the rank's name.
  650. Inspect.Guild.Roster.Detail
  651. Function documentation:
  652. Provides detailed information about guildmembers.
  653. detail = Inspect.Guild.Roster.Detail(guildmember) -- table <- string
  654. details = Inspect.Guild.Roster.Detail(guildmembers) -- table <- table
  655. Parameters:
  656. guildmember: The name of the guildmember to retrieve data for.
  657. guildmembers: A table of names of guildmembers to retrieve data for.
  658. Return values:
  659. detail: Detail table for a single guildmember.
  660. details: Detail tables for all requested guildmembers. The key is the guildmember's name, the value is the guildmember's detail table.
  661. Returned members:
  662. id: The ID of the requested element.
  663. level: The guildmember's level.
  664. logout: The guildmember's last logout time, in UNIX time.
  665. name: The guildmember's name.
  666. note: The guildmember's public note.
  667. noteOfficer: The guildmember's officer note.
  668. rank: The guildmember's rank.
  669. score: The guildmember's achievement score.
  670. status: The guildmember's current status. May include "online" or "mobile". nil if the guildmember is offline.
  671. zone: The guildmember's current zone, if online.
  672. Inspect.Guild.Roster.List
  673. Function documentation:
  674. Lists guildmembers.
  675. list = Inspect.Guild.Roster.List() -- table <- void
  676. Return values:
  677. list: A table listing all your guildmembers. The key is the guildmember's name, the value is the guildmember's status.
  678. Inspect.Interaction
  679. Function documentation:
  680. Provides information about what types of interaction are available.
  681. interactions = Inspect.Interaction() -- table <- void
  682. status = Inspect.Interaction(interaction) -- boolean <- string
  683. Parameters:
  684. interaction: Optional name of the interaction type to query. Valid values include "auction", "bank", "guildbank", and "mail".
  685. Return values:
  686. interactions: Table from interaction type to indicator of whether that interaction is available.
  687. status: Whether or not that interaction type is available.
  688. Inspect.Item.Detail
  689. Function documentation:
  690. Provides detailed information about items.
  691. item = Inspect.Item.Detail(item) -- table <- item
  692. item = Inspect.Item.Detail(itemtype) -- table <- itemtype
  693. item = Inspect.Item.Detail(slot) -- table <- slot
  694. items = Inspect.Item.Detail(slot) -- table <- slot
  695. items = Inspect.Item.Detail(elements) -- table <- table
  696. Parameters:
  697. elements: A table of slot specifiers, item IDs, or item types.
  698. item: A single item ID.
  699. itemtype: A single item type.
  700. slot: A single slot specifier.
  701. Return values:
  702. item: Detail table for a single item.
  703. items: Detail tables for all requested items. The key is the string used to lookup, the value is the item's detail table.
  704. Returned members:
  705. bind: The item's binding type. May be "equip", "use", "pickup", or "account".
  706. bound: The item's bound flag.
  707. category: The item's type category.
  708. coin: The amount of silver this item represents.
  709. cooldown: The cooldown for using this item.
  710. cooldownBegin: The time the current cooldown started, in the context of Inspect.Time.Frame.
  711. cooldownDuration: Duration of the current cooldown the item is influenced by, in seconds.
  712. cooldownExpired: Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
  713. cooldownRemaining: Time remaining in the item's current cooldown, in seconds.
  714. crafter: The name of the player who crafted this item.
  715. damageDelay: If a weapon, the delay between autoattacks using this weapon.
  716. damageMax: If a weapon, the maximum damage done by a single hit with this item.
  717. damageMin: If a weapon, the minimum damage done by a single hit with this item.
  718. damageType: If a weapon, the damage type done by autoattacks. Values include "life", "death", "air", "earth", "fire", and "water".
  719. description: The description of this item.
  720. flavor: The flavor text for this item.
  721. icon: Resource filename of the item's icon.
  722. id: The ID of the requested element.
  723. lootable: Indicates that the item contains loot.
  724. name: The item's name.
  725. range: If a ranged weapon, the maximum range of this item.
  726. rarity: The item's rarity. Values include "sellable", "uncommon", "rare", "epic", "relic", "transcendent", or "quest". Common items have a rarity of nil.
  727. requiredCalling: Space-delimited list of the required callings to use this item.
  728. requiredFaction: The ID of the faction required to use this item.
  729. requiredFactionLevel: The faction notoriety required to use this item.
  730. requiredLevel: The level required to use this item.
  731. requiredPrestige: The prestige rank required to use this item.
  732. requiredSkill: The skill required to use this item.
  733. requiredSkillLevel: The skill level required to use this item.
  734. sell: The sell value of this item, in silver.
  735. slots: If a container, the number of slots that this item can contain.
  736. stack: The size of this item stack.
  737. stackMax: The maximum size of this item stack.
  738. stats: The base stats of this item. Members may include "armor", "block", "critAttack", "critPower", "critSpell", "deflect", "dexterity", "dodge", "endurance", "energyMax", "energyRegen", "hit", "intelligence", "manaMax", "manaRegen", "movement", "parry", "powerAttack", "powerMax", "powerRegen", "powerSpell", "resistAir", "resistAll", "resistDeath", "resistEarth", "resistFire", "resistLife", "resistWater", "stealth", "stealthDetect", "strength", "wisdom", "valor", "toughness", and "vengeance".
  739. statsRune: The added rune stats of this item. May contain the same members as stats.
  740. statsRuneTemporary: The added temporary rune stats of this item. May contain the same members as stats.
  741. type: The item's type specifier.
  742. Inspect.Item.Find
  743. Function documentation:
  744. Finds a slot specifier based on an item ID.
  745. slot = Inspect.Item.Find(item) -- slot <- item
  746. slots = Inspect.Item.Find(items) -- table <- table
  747. Parameters:
  748. item: A single item ID.
  749. items: A table of item IDs.
  750. Return values:
  751. slot: A slot specifier for that item.
  752. slots: Slot specifiers for all requested items. The key is the string used to lookup, the value is the slot specifier.
  753. Inspect.Item.List
  754. Function documentation:
  755. Generate a list of item IDs from a slot specifier or set of slot specifiers.
  756. items = Inspect.Item.List() -- table <- void
  757. item = Inspect.Item.List(slot) -- item <- slot
  758. items = Inspect.Item.List(slot) -- table <- slot
  759. items = Inspect.Item.List(slots) -- table <- table
  760. Parameters:
  761. slot: A single slot specifier.
  762. slots: A table of slot specifiers.
  763. Return values:
  764. item: A single item ID. This will be returned only if the input is a single fully-specified slot specifier.
  765. items: A table of item IDs. The key is the slot specifier, the value is the item ID.
  766. Inspect.Mail.Detail
  767. Function documentation:
  768. Returns information about mail.
  769. Requires the "mail" interaction flag to be set.
  770. detail = Inspect.Mail.Detail(mail) -- table <- mail
  771. details = Inspect.Mail.Detail(mails) -- table <- table
  772. Parameters:
  773. mail: The identifier of the mail to retrieve detail for.
  774. mails: A table of identifiers of mail to retrieve detail for.
  775. Return values:
  776. detail: Detail table for a single mail.
  777. details: Detail tables for all requested mail. The key is the mail ID, the value is the mail's detail table.
  778. Returned members:
  779. attachments: The attachments available on this mail. A number if this mail has basic information, or a table of item IDs if this mail has detailed information.
  780. body: The body of this mail. Available only if detailed information on the mail has been retrieved.
  781. cod: The Cash on Delivery required to retrieve attachments out of this mail message.
  782. expire: The time this mail will expire, in Unix timestamp form.
  783. from: The name of the character this mail was sent from.
  784. id: The ID of the requested element.
  785. read: "true" if you have already opened this mail.
  786. spam: "true" if this mail is considered spam.
  787. subject: The subject line for this mail.
  788. Inspect.Mail.List
  789. Function documentation:
  790. Returns a table of valid mail and its status.
  791. Requires the "mail" interaction flag to be set.
  792. mails = Inspect.Mail.List() -- table <- void
  793. Return values:
  794. mails: Valid mail, in {id = "type"} format. The type may be either "basic" or "detail", indicating whether the mail has been opened and its detailed information is available.
  795. Inspect.Map.Detail
  796. Function documentation:
  797. Returns information about map locations.
  798. detail = Inspect.Map.Detail(location) -- table <- location
  799. details = Inspect.Map.Detail(locations) -- table <- table
  800. Parameters:
  801. location: The identifier of the location to retrieve detail for.
  802. locations: A table of identifiers of locations to retrieve detail for.
  803. Return values:
  804. detail: Detail table for a single location.
  805. details: Detail tables for all requested locations. The key is the location ID, the value is the location's detail table.
  806. Returned members:
  807. coordX: The map location's current X coordinate.
  808. coordY: The map location's current Y coordinate.
  809. coordZ: The map location's current Z coordinate.
  810. description: The description of this map location, if it has one.
  811. id: The ID of the requested element.
  812. title: The title of this map location, if it has one.
  813. Inspect.Map.List
  814. Function documentation:
  815. Returns a table of map locations.
  816. list = Inspect.Map.List() -- table <- void
  817. Return values:
  818. list: Valid locations, in {id = true} format.
  819. Inspect.Map.Monitor
  820. Function documentation:
  821. Inspects the state of the map monitor flag. See Command.Map.Monitor() for details.
  822. monitor = Inspect.Map.Monitor() -- boolean <- void
  823. Return values:
  824. monitor: The current state of the map monitor flag.
  825. Inspect.Map.Waypoint.Get
  826. Function documentation:
  827. Gets a unit's current waypoint.
  828. x, z = Inspect.Map.Waypoint.Get(unit) -- number, number <- unit
  829. Parameters:
  830. unit: A unit, in either unit ID or unit specifier format.
  831. Return values:
  832. x: The x coordinate of the waypoint.
  833. z: The z coordinate of the waypoint.
  834. Inspect.Message.Accept.Check
  835. Function documentation:
  836. Checks whether a given message type would be accepted if it were sent to you. Parameters can be replaced by "nil" to check for wildcard acceptance.
  837. accepted = Inspect.Message.Accept.Check(type, identifier) -- boolean <- string/nil, string/nil
  838. Parameters:
  839. identifier: The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
  840. type: The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
  841. Return values:
  842. accepted: True if the message would be transferred to this client.
  843. Inspect.Message.Accept.List
  844. Function documentation:
  845. Retrieves the list of accepted message types and identifiers.
  846. accepts = Inspect.Message.Accept.List() -- table <- void
  847. Return values:
  848. accepts: List of all accepted message types. Takes the form of a key/value table. The key is a table containing {type, identifier}, where either element may be nil to indicate a wildcard. The value is the number of times this type has been accepted.
  849. Inspect.Mouse
  850. Function documentation:
  851. Returns information about the current mouse position and button state.
  852. results = Inspect.Mouse() -- table <- void
  853. Return values:
  854. results: Table containing the current mouse state. May include members x, y, Left, Right, Middle, Mouse4, Mouse5.
  855. Inspect.Pvp.History
  856. Function documentation:
  857. Returns information on your PVP history.
  858. result = Inspect.Pvp.History() -- table <- void
  859. Return values:
  860. result: Table containing information on PVP history.
  861. Returned members:
  862. favorLifetime: Amount of lifetime favor accumulated.
  863. killLifetime: Amount of kills made on this character.
  864. killMonth: Amount of kills made on this character within the last month.
  865. killToday: Amount of kills made on this character within the last day.
  866. killWeek: Amount of kills made on this character within the last week.
  867. Inspect.Pvp.Prestige
  868. Function documentation:
  869. Returns information on your PVP prestige.
  870. result = Inspect.Pvp.Prestige() -- table <- void
  871. Return values:
  872. result: Table containing information on prestige.
  873. Returned members:
  874. accumulated: Prestige accumulated so far in this rank.
  875. needed: Quantity of prestige needed to gain a rank.
  876. rank: Current prestige rank.
  877. Inspect.Quest.Complete
  878. Function documentation:
  879. Returns a table of all quests completed.
  880. quests = Inspect.Quest.Complete() -- table <- void
  881. Return values:
  882. quests: A table where the key is the incomplete quest identifier. Identifiers returned by this function may not include all characters - the last eight characters may be replaced by "xxxxxxxx". These elements can still be compared against standard quest IDs by comparing only the first nine characters (including the 'q' prefix).
  883. Inspect.Quest.Detail
  884. Function documentation:
  885. Provides detailed information about a quest.
  886. detail = Inspect.Quest.Detail(quest) -- table <- quest
  887. details = Inspect.Quest.Detail(quests) -- table <- table
  888. Parameters:
  889. quest: The quest to retrieve detail for.
  890. quests: A table of quests to retrieve detail for.
  891. Return values:
  892. detail: Detail table for a single quest.
  893. details: Detail tables for all requested quests.
  894. Returned members:
  895. categoryName: The name of the category this quest is placed under.
  896. complete: Signals that this quest is complete.
  897. description: The long description for this quest.
  898. domain: The quest's domain. May be "area", "guild", "instant", or "zone". Personal quests are signaled with nil.
  899. failed: Signals that this quest has failed.
  900. id: The ID of the requested element.
  901. mode: This quest's mode, if it has a special mode. May be "story" or "soul".
  902. name: The name of this quest.
  903. objective: A table of objectives. Each objective is a table that may contain the following members: "description", representing the quest's full description. "count", representing how many elements must be completed to finish this quest. "countDone", representing how many elements have been completed. "complete", indicating that this objective is complete. "indicator", listing all the map indicators that can be used to complete this quest.
  904. rewardChoose: Lists the possible reward choices for the player. The key is the item type, the value is the count.
  905. rewardCoin: The amount of silver this quest's completion will award.
  906. rewardExperience: The amount of experience this quest's completion will award.
  907. rewardExperienceGuild: The amount of guild experience this quest's completion will award.
  908. rewardFavor: The amount of favor this quest's completion will award.
  909. rewardGuaranteed: Lists the guaranteed rewards for the player. The key is the item type, the value is the count.
  910. rewardNotoriety: The amount of notoriety this quest's completion will award, represented as a table. The key is the faction ID, the value is the amount.
  911. rewardPrestige: The amount of prestige this quest's completion will award.
  912. summary: The short summary for this quest.
  913. tag: The quest's tags, space-separated.
  914. tagName: The quest's tags, localized.
  915. track: Signals that this quest is being manually tracked.
  916. watch: Signals that this quest is being watched.
  917. Inspect.Quest.List
  918. Function documentation:
  919. Lists the player's current active quests.
  920. quests = Inspect.Quest.List() -- table <- void
  921. Return values:
  922. quests: A table containing the player's current quests.
  923. Inspect.Queue.Handler
  924. Function documentation:
  925. Returns the current queue handler function.
  926. handler, owner = Inspect.Queue.Handler() -- function, string <- void
  927. Return values:
  928. handler: The current queue handler function.
  929. owner: The owner of the current queue handler function.
  930. Inspect.Queue.Status
  931. Function documentation:
  932. Inspects the current queue status. Omit the first parameter to get a table containing information on all queues.
  933. results = Inspect.Queue.Status() -- table <- void
  934. result = Inspect.Queue.Status(queue) -- boolean <- string
  935. results = Inspect.Queue.Status(queue, size) -- table <- string, number
  936. Parameters:
  937. queue: Optional identifier of the queue to query. Valid values include "global" and "auctionfullscan".
  938. size: The size of the element to test in this queue. Defaults to 1 if no size is provided.
  939. Return values:
  940. result: false if this queue is throttled, non-false otherwise.
  941. results: A key/value table. The first parameter is the name of the queue. The second parameter is false if the queue is throttled, or a number representing the queue size available otherwise.
  942. Inspect.Role.List
  943. Function documentation:
  944. Lists the player's roles.
  945. roles = Inspect.Role.List() -- table <- void
  946. Return values:
  947. roles: A table containing the player's roles. The key is the role ID, the value is the role name.
  948. Inspect.Setting.Detail
  949. Function documentation:
  950. Provides detailed information about a setting.
  951. detail = Inspect.Setting.Detail(setting) -- table <- string
  952. details = Inspect.Setting.Detail(settings) -- table <- table
  953. Parameters:
  954. setting: The setting to retrieve detail for.
  955. settings: A table of settings to retrieve detail for.
  956. Return values:
  957. detail: Detail table for a single setting.
  958. details: Detail tables for all requested settings.
  959. Returned members:
  960. id: The ID of the requested element.
  961. value: The value of the requested element.
  962. Inspect.Setting.List
  963. Function documentation:
  964. Lists the player's current settings.
  965. settings = Inspect.Setting.List() -- table <- void
  966. Return values:
  967. settings: A table containing the player's current settings.
  968. Inspect.Shard
  969. Function documentation:
  970. Returns information about the current shard.
  971. shard = Inspect.Shard() -- table <- void
  972. Return values:
  973. shard: Table containing requested data.
  974. Returned members:
  975. name: The shard's name.
  976. pvp: Signals that the shard is a PvP shard.
  977. rp: Signals that the shard is a roleplaying shard.
  978. Inspect.Social.Friend.Detail
  979. Function documentation:
  980. Provides detailed information about a friend.
  981. detail = Inspect.Social.Friend.Detail(friend) -- table <- string
  982. details = Inspect.Social.Friend.Detail(friends) -- table <- table
  983. Parameters:
  984. friend: The name of a friend to retrieve detail for.
  985. friends: A table of names of friends to retrieve detail for.
  986. Return values:
  987. detail: Detail table for a single friend.
  988. details: Detail tables for all requested friends.
  989. Returned members:
  990. calling: The friend's calling, if known.
  991. guild: The friend's current guild.
  992. id: The ID of the requested element.
  993. level: The friend's current level, if known.
  994. name: The friend's name.
  995. note: The friend's personal note.
  996. race: The friend's race, if known.
  997. status: The friend's status. Either "online", "afk", or nil.
  998. zone: The friend's current zone, if known.
  999. Inspect.Social.Friend.List
  1000. Function documentation:
  1001. Lists the player's current friends.
  1002. friends = Inspect.Social.Friend.List() -- table <- void
  1003. Return values:
  1004. friends: A table containing the player's current friends.
  1005. Inspect.Social.Ignore.Detail
  1006. Function documentation:
  1007. Provides detailed information about an ignored player.
  1008. detail = Inspect.Social.Ignore.Detail(ignore) -- table <- string
  1009. details = Inspect.Social.Ignore.Detail(ignores) -- table <- table
  1010. Parameters:
  1011. ignore: The name of an ignored player to retrieve detail for.
  1012. ignores: A table of names of ignored players to retrieve detail for.
  1013. Return values:
  1014. detail: Detail table for a single ignored player.
  1015. details: Detail tables for all requested ignored players.
  1016. Returned members:
  1017. id: The ID of the requested element.
  1018. name: The ignored player's name.
  1019. note: The ignored player's personal note.
  1020. Inspect.Social.Ignore.List
  1021. Function documentation:
  1022. Lists the player's current ignored players.
  1023. ignores = Inspect.Social.Ignore.List() -- table <- void
  1024. Return values:
  1025. ignores: A table containing the player's current ignored players.
  1026. Inspect.Stat
  1027. Function documentation:
  1028. Returns information about the player's stats.
  1029. results = Inspect.Stat() -- table <- void
  1030. result = Inspect.Stat(stat) -- number <- string
  1031. Parameters:
  1032. stat: Optional parameter identifying the stat desired. May be any of strength, dexterity, intelligence, wisdom, endurance, valor, toughness, resistLife, resistDeath, resistFire, resistWater, resistEarth, resistAir, armor, powerAttack, critAttack, hit, powerSpell, critSpell, critPower, block, parry, dodge, vengeance, deflect, or any of the previous with "Unbuffed" appended.
  1033. Return values:
  1034. result: The current value of that stat.
  1035. results: A table from stat ID to stat value, containing all the player's stats.
  1036. Inspect.Storage.Used
  1037. Function documentation:
  1038. Returns the storage space currently used for a given segment.
  1039. current, maximum = Inspect.Storage.Used(segment) -- number, number <- string
  1040. Parameters:
  1041. segment: The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.
  1042. Return values:
  1043. current: Current storage space used.
  1044. maximum: Maximum storage space available.
  1045. Inspect.System.Error.Detail
  1046. Function documentation:
  1047. Provides detailed information about an addon error.
  1048. detail = Inspect.System.Error.Detail(error) -- table <- error
  1049. details = Inspect.System.Error.Detail(errors) -- table <- table
  1050. Parameters:
  1051. error: The error to be inspected.
  1052. errors: A table of errors to retrieve detail for.
  1053. Return values:
  1054. detail: Detail table for a single error. Member documentation can be found in Event.System.Error.
  1055. details: Detail tables for all requested errors.
  1056. Inspect.System.Language
  1057. Function documentation:
  1058. Returns the client's current language.
  1059. language = Inspect.System.Language() -- string <- void
  1060. Return values:
  1061. language: Current language. Valid values include "English", "French", "German", "Korean", "Russian", "Chinese", and "Taiwanese".
  1062. Inspect.System.Secure
  1063. Function documentation:
  1064. Returns the client's current secure mode.
  1065. secure = Inspect.System.Secure() -- boolean <- void
  1066. Return values:
  1067. secure: The current secure mode.
  1068. Inspect.System.Version
  1069. Function documentation:
  1070. Returns information on the client version.
  1071. version = Inspect.System.Version() -- table <- void
  1072. Return values:
  1073. version: A table containing detailed version information.
  1074. Returned members:
  1075. build: Client build information.
  1076. external: Client external version.
  1077. internal: Client internal version.
  1078. Inspect.System.Watchdog
  1079. Function documentation:
  1080. Returns the number of seconds until the system watchdog may begin generating warnings.
  1081. time = Inspect.System.Watchdog() -- number <- void
  1082. Return values:
  1083. time: Time left in seconds.
  1084. Inspect.TEMPORARY.Experience
  1085. Function documentation:
  1086. Returns information about the player's experience.
  1087. This function is deprecated and will be removed in the future. It should not be used.
  1088. accumulated, rested, needed = Inspect.TEMPORARY.Experience() -- number, number, number <- void
  1089. Return values:
  1090. accumulated: The amount of experience that has accumulated towards the next level.
  1091. needed: The amonut of experience required to reach the next level.
  1092. rested: The amount of rested experience that has accumulated.
  1093. Inspect.TEMPORARY.Role
  1094. Function documentation:
  1095. Returns the ID of the player's current role.
  1096. This function will be removed in the future.
  1097. role = Inspect.TEMPORARY.Role() -- number <- void
  1098. Return values:
  1099. role: The ID of the player's current role.
  1100. Inspect.Time.Frame
  1101. Function documentation:
  1102. The game time of the last frame. This function's return value will not change until the next frame.
  1103. time = Inspect.Time.Frame() -- number <- void
  1104. Return values:
  1105. time: Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.
  1106. Inspect.Time.Real
  1107. Function documentation:
  1108. A high-resolution realtime timer. Not measured in the same timespace as Inspect.Time.Frame.
  1109. time = Inspect.Time.Real() -- number <- void
  1110. Return values:
  1111. time: Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.
  1112. Inspect.Time.Server
  1113. Function documentation:
  1114. Returns the current server time.
  1115. time = Inspect.Time.Server() -- number <- void
  1116. Return values:
  1117. time: Server time, as seconds from the Unix epoch.
  1118. Inspect.Title.Category.Detail
  1119. Function documentation:
  1120. Provides detailed information about a title category.
  1121. detail = Inspect.Title.Category.Detail(titlecategory) -- table <- titlecategory
  1122. details = Inspect.Title.Category.Detail(titlecategories) -- table <- table
  1123. Parameters:
  1124. titlecategories: A table of title categories to retrieve details for.
  1125. titlecategory: The title category to retrieve detail for.
  1126. Return values:
  1127. detail: Detail table for a single title category.
  1128. details: Detail tables for all requested title categories.
  1129. Returned members:
  1130. id: The ID of the required element.
  1131. name: The name of the title category.
  1132. Inspect.Title.Category.List
  1133. Function documentation:
  1134. Lists known title categories.
  1135. titlecategories = Inspect.Title.Category.List() -- table <- void
  1136. Return values:
  1137. titlecategories: A lookup table of known title categories.
  1138. Inspect.Title.Detail
  1139. Function documentation:
  1140. Provides detailed information about a title.
  1141. detail = Inspect.Title.Detail(title) -- table <- title
  1142. details = Inspect.Title.Detail(titles) -- table <- table
  1143. Parameters:
  1144. title: The title ID to retrieve detail for.
  1145. titles: A table of title IDs to retrieve detail for.
  1146. Return values:
  1147. detail: Detail table for a single title.
  1148. details: Detail tables for all requested titles.
  1149. Returned members:
  1150. gameFemale: The title as seen ingame and applied to female characters.
  1151. gameMale: The title as seen ingame and applied to male characters.
  1152. id: The ID of the requested element.
  1153. nameFemale: The title as seen in menus and applied to female characters.
  1154. nameMale: The title as seen in menus and applied to male characters.
  1155. prefix: Signals that the title is a prefix title.
  1156. Inspect.Title.List
  1157. Function documentation:
  1158. Lists the player's currently available titles.
  1159. titles = Inspect.Title.List() -- table <- void
  1160. Return values:
  1161. titles: A lookup table of all available titles.
  1162. Inspect.Tooltip
  1163. Function documentation:
  1164. Returns the current contents of the tooltip.
  1165. type, shown = Inspect.Tooltip() -- nil, nil <- void
  1166. type, shown = Inspect.Tooltip() -- string, variant <- void
  1167. type, unit, buff = Inspect.Tooltip() -- string, unit, buff <- void
  1168. Return values:
  1169. buff: The ID of the tooltip's buff.
  1170. shown: The blob describing what is currently shown. Generally, some kind of identifier used in another part of the addon system.
  1171. type: The current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".
  1172. unit: The unit that the buff is attached to.
  1173. Inspect.Unit.Castbar
  1174. Function documentation:
  1175. Provides detailed information about a unit's castbar.
  1176. detail = Inspect.Unit.Castbar(unit) -- table <- unit
  1177. details = Inspect.Unit.Castbar(units) -- table <- table
  1178. Parameters:
  1179. unit: A unit, in either unit ID or unit specifier format.
  1180. units: A table containing units to inspect.
  1181. Return values:
  1182. detail: Detail table for a single castbar.
  1183. details: Detail tables for all requested castbars. The key is the unit ID or unit specifier, the value is the castbar's detail table.
  1184. Returned members:
  1185. ability: ID of the ability being cast, if available.
  1186. abilityName: Name of the ability being cast.
  1187. begin: The time the cast started, in the context of Inspect.Time.Frame.
  1188. channeled: True if this ability is channeled.
  1189. duration: Duration of the cast in seconds.
  1190. expired: Number of the seconds the cast is past its completion time. Generally indicates lag.
  1191. remaining: Time remaining on the cast, in seconds.
  1192. uninterruptible: Signals that the cast is not interruptible.
  1193. Inspect.Unit.Detail
  1194. Function documentation:
  1195. Provides detailed information about a unit.
  1196. detail = Inspect.Unit.Detail(unit) -- table <- unit
  1197. details = Inspect.Unit.Detail(units) -- table <- table
  1198. Parameters:
  1199. unit: A unit, in either unit ID or unit specifier format.
  1200. units: A table containing units to inspect.
  1201. Return values:
  1202. detail: Detail table for a single unit.
  1203. details: Detail tables for all requested units. The key is the unit ID or unit specifier, the value is the unit's detail table.
  1204. Returned members:
  1205. absorb: The unit's damage absorption.
  1206. afk: Signals that the unit is AFK. Provided only for the player and the player's groupmembers.
  1207. aggro: Signals that this unit is being attacked. Provided only for groupmembers.
  1208. alliance: The unit's alliance. "defiant", "guardian", or nil.
  1209. availability: The unit's current availability. See Utility.Unit.Availability() for details.
  1210. blocked: Signals that this unit is not in line of sight. Provided only for groupmembers.
  1211. calling: The unit's calling. May be "mage", "rogue", "cleric", or "warrior".
  1212. charge: The unit's charge. Provided only for the player.
  1213. chargeMax: The unit's maximum charge. Provided only for the player.
  1214. combat: The unit's combat status.
  1215. combo: The unit's combo points. Provided only for the player.
  1216. coordX: The unit's current X coordinate.
  1217. coordY: The unit's current Y coordinate.
  1218. coordZ: The unit's current Z coordinate.
  1219. energy: The unit's energy.
  1220. energyMax: The unit's maximum energy.
  1221. factionId: The unit's faction ID.
  1222. guaranteedLoot: Signals that this unit guarantees loot on death. Shown in the user interface as a diamond above the portrait.
  1223. guild: The unit's guild.
  1224. health: The unit's health.
  1225. healthCap: The unit's capped maximum health.
  1226. healthMax: The unit's maximum health.
  1227. id: The ID of the requested element.
  1228. level: The unit's level. May be "??" if the unit is hostile and very high-level.
  1229. locationName: The name of the unit's location. Provided only for friendly players.
  1230. loot: The Unit ID that has looting rights to this corpse.
  1231. mana: The unit's mana.
  1232. manaMax: The unit's maximum mana.
  1233. mark: The mark on this unit.
  1234. mentoring: The unit's mentoring status.
  1235. name: The unit's name.
  1236. nameSecondary: The unit's secondary name.
  1237. offline: Signals that the unit is offline. Provided only for the player's groupmembers.
  1238. planar: The unit's available planar charges. Provided only for the player or groupmembers.
  1239. planarMax: The unit's maximum planar charges. Provided only for the player or groupmembers.
  1240. player: Signals that the unit is a player, not an NPC.
  1241. power: The unit's power.
  1242. publicSize: The unit's current public group size. nil if the group is not public. Provided only for friendly players.
  1243. pvp: The unit's PvP flag.
  1244. race: The unit's race. Provided only for players.
  1245. raceName: The unit's race, localized. Provided only for players.
  1246. radius: The unit's radius.
  1247. ready: The unit's readycheck status.
  1248. relation: The unit's relation to you. May be "hostile" or "friendly". Neutral targets will not have this member.
  1249. role: The unit's role. May be "tank", "heal", "dps", "support", or nil. Provided only for the player and the player's groupmembers.
  1250. tag: The unit's tags, space-separated.
  1251. tagName: The unit's tags, localized.
  1252. tagged: The unit's tagged status. true if the unit has been tagged by you, "other" if the unit has been tagged by someone else.
  1253. tier: The unit's difficulty tier. nil, "group", or "raid".
  1254. titlePrefixId: The unit's title prefix ID.
  1255. titlePrefixName: The unit's localized title prefix.
  1256. titleSuffixId: The unit's title suffix ID.
  1257. titleSuffixName: The unit's localized title suffix.
  1258. type: The unit type ID.
  1259. vitality: The unit's vitality. Provided only for the player or groupmembers.
  1260. warfront: Signals that the unit has temporarily left the group to join a warfront. Provided only for groupmembers.
  1261. zone: The ID of the unit's current zone.
  1262. Inspect.Unit.List
  1263. Function documentation:
  1264. Lists all the units that the client can see.
  1265. list = Inspect.Unit.List() -- table <- void
  1266. Return values:
  1267. list: Map of unit ID to unit specifier. Units with multiple valid specifiers will have one chosen at random.
  1268. Inspect.Unit.Lookup
  1269. Function documentation:
  1270. Converts unit IDs to unit specifiers and vice-versa.
  1271. unit = Inspect.Unit.Lookup(unit) -- unit <- unit
  1272. units = Inspect.Unit.Lookup(units) -- table <- table
  1273. Parameters:
  1274. unit: A single unit ID or unit specifier.
  1275. units: A table containing unit IDs and unit specifiers.
  1276. Return values:
  1277. unit: A unit ID or unit specifier, whichever is the opposite of the parameter given. May be nil.
  1278. units: A 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.
  1279. Inspect.Zone.Detail
  1280. Function documentation:
  1281. Returns information about zones.
  1282. detail = Inspect.Zone.Detail(zone) -- table <- zone
  1283. details = Inspect.Zone.Detail(zones) -- table <- table
  1284. Parameters:
  1285. zone: The identifier of the zone to retrieve detail for.
  1286. zones: A table of identifiers of zones to retrieve detail for.
  1287. Return values:
  1288. detail: Detail table for a single zone.
  1289. details: Detail tables for all requested zones. The key is the zone ID, the value is the zone's detail table.
  1290. Returned members:
  1291. id: The ID of the requested element.
  1292. name: The name of the zone.
  1293. type: The type of this zone. May be either "instance", "warfront", or nil.
  1294.  
  1295. Commands:
  1296. Command.Achievement.Watch
  1297. Function documentation:
  1298. Watches an achievement, possibly unwatching another item if the player is already watching the maximum item count. Permitted only on unfinished achievements.
  1299. Command.Achievement.Watch(achievement, flag) -- achievement, boolean
  1300. Parameters:
  1301. achievement: The achievement to be affected.
  1302. flag: The new watch status.
  1303. Command.Auction.Analyze
  1304. Function documentation:
  1305. Requests auction statistics from the server. The results will be sent to Event.Auction.Statistics. This command is throttled by the "auctionanalyze" throttle type, proportional to the number of days requested.
  1306. Requires the "auction" interaction flag to be set.
  1307. Command.Auction.Analyze(itemtype, begin, end) -- itemtype, number, number
  1308. Command.Auction.Analyze(itemtype, begin, end, callback) -- itemtype, number, number, callbackfunction
  1309. Parameters:
  1310. begin: UNIX timestamp to begin analysis at.
  1311. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1312. end: UNIX timestamp to end analysis at.
  1313. itemtype: Item type to analyze.
  1314. Command.Auction.Bid
  1315. Function documentation:
  1316. Bids or buys out an auction.
  1317. Requires the "auction" interaction flag to be set.
  1318. This function is subject to the "global" command queue.
  1319. Command.Auction.Bid(auction, bid) -- auction, number
  1320. Command.Auction.Bid(auction, bid, quantity) -- auction, number, number
  1321. Command.Auction.Bid(auction, bid, callback) -- auction, number, callbackfunction
  1322. Command.Auction.Bid(auction, bid, quantity, callback) -- auction, number, number, callbackfunction
  1323. Parameters:
  1324. auction: The auction to be targeted.
  1325. bid: The amount to bid. To place a buyout, simply bid the buyout value.
  1326. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1327. quantity: How many items to purchase. If omitted, defaults to the entire auction quantity.
  1328. Command.Auction.Cancel
  1329. Function documentation:
  1330. Cancels an auction.
  1331. Requires the "auction" interaction flag to be set.
  1332. This function is subject to the "global" command queue.
  1333. Command.Auction.Cancel(auction) -- auction
  1334. Command.Auction.Cancel(auction, callback) -- auction, callbackfunction
  1335. Parameters:
  1336. auction: The auction to be targeted.
  1337. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1338. Command.Auction.Fulfill
  1339. Function documentation:
  1340. Fulfills an existing buy order.
  1341. Requires the "auction" interaction flag to be set.
  1342. This function is subject to the "global" command queue.
  1343. Command.Auction.Fulfill(auction, item, quantity) -- auction, item, number
  1344. Command.Auction.Fulfill(auction, item, quantity, callback) -- auction, item, number, callbackfunction
  1345. Parameters:
  1346. auction: The auction to be targeted.
  1347. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1348. item: The ID of the item to be taken.
  1349. quantity: Stack size to fulfill.
  1350. Command.Auction.Order
  1351. Function documentation:
  1352. Posts a new buy order.
  1353. Requires the "auction" interaction flag to be set.
  1354. This function is subject to the "global" command queue.
  1355. Command.Auction.Order(itemtype, quantity, time, buyout) -- itemtype, number, number, number
  1356. Command.Auction.Order(itemtype, quantity, time, buyout, callback) -- itemtype, number, number, number, callbackfunction
  1357. Parameters:
  1358. buyout: The total buyout for the new auction, in silver. Must be evenly divisible by quantity.
  1359. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1360. itemtype: The item type to be ordered.
  1361. quantity: The number of items to be ordered.
  1362. time: The duration that the order should last, in hours. Valid values are limited to 12, 24, and 48.
  1363. Command.Auction.Post
  1364. Function documentation:
  1365. Posts a new auction.
  1366. Requires the "auction" interaction flag to be set.
  1367. This function is subject to the "global" command queue.
  1368. Command.Auction.Post(item, time, bid, buyout) -- item, number, number/nil, number/nil
  1369. Command.Auction.Post(item, time, bid, buyout, partial) -- item, number, number/nil, number/nil, boolean
  1370. Command.Auction.Post(item, time, bid, buyout, callback) -- item, number, number/nil, number/nil, callbackfunction
  1371. Command.Auction.Post(item, time, bid, buyout, partial, callback) -- item, number, number/nil, number/nil, boolean, callbackfunction
  1372. Parameters:
  1373. bid: The minimum bid for the new auction, in silver. nil if no bid is desired.
  1374. buyout: The buyout for the new auction, in silver. nil if no buyout is desired.
  1375. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1376. item: The ID of the item to be auctioned.
  1377. partial: Whether partial buyouts should be permitted. Must be "false" if a buyout is not provided or if a bid is provided that is different from the buyout. If this parameter is omitted, will default to "true" when possible, or "false" otherwise.
  1378. time: The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.
  1379. Command.Auction.Scan
  1380. Function documentation:
  1381. Requests an auction house scan. For type "search", if "index" is omitted then this function will error if the "auctionfullscan" queue is not ready. Type "search" with "index" will throttle on the "auction" command queue. Other types throttle on the "global" command queue.
  1382. This function consumes a hardware event to function. Hardware events include Event.UI.Input.Mouse.*.Down, Event.UI.Input.Mouse.*.Up, and Event.UI.Input.Mouse.Wheel.*.
  1383. Requires the "auction" interaction flag to be set.
  1384. Command.Auction.Scan(parameters) -- table
  1385. Parameters:
  1386. parameters: Table containing data about the requested scan.
  1387. type: Type of scan to perform. One of "bids", "buy", "mine", "orders", or "search".
  1388. If type is "bids", "mine", or "orders", no other parameters are allowed.
  1389. If type is "search":
  1390. category: Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional.
  1391. index: Numeric item index to start the scan at. If provided, the auction scan will return the first 50 items immediately following this index.
  1392. levelMax: Maximum level the item must require. Optional.
  1393. levelMin: Minimum level the item must require. Optional.
  1394. priceMax: Maximum price of the item. Optional.
  1395. priceMin: Minimum price of the item. Optional.
  1396. rarity: The minimum rarity to search for. Same as the "rarity" member returned by Inspect.Item.Detail(). Optional.
  1397. role: The role that the item must be compatible with. One of "mage", "rogue", "cleric", or "warrior". Optional.
  1398. statType: Which stat to filter based on. One of "armor", "block", "critPower", "critSpell", "deflect", "dexterity", "dodge", "endurance", "health", "hit", "intelligence", "mana", "parry", "powerAttack", "powerSpell", "resistAir", "resistDeath", "resistEarth", "resistFire", "resistLife", "resistWater", "strength", "toughness", "valor", "vengeance", or "wisdom". Optional. If provided, statMin and statMax must also be provided.
  1399. statMax: Maximum allowed value for the filter stat. Optional. If provided, statType and statMin must also be provided.
  1400. statMin: Minimum allowed value for the filter stat. Optional. If provided, statType and statMax must also be provided.
  1401. sort: Which column the requested items should be sorted based on. One of "rarity", "name", "level", "time", "seller", "pricePerUnit", "bid", "buyout", "stack". Optional.
  1402. sortOrder: What order to sort in. One of "ascending" or "descending". Optional.
  1403. text: A string to search for in the item name. Optional.
  1404. type: Type of scan to perform. One of "search", "buy", "mine", or "bids". If "mine" or "bids", must be the only member in the table.
  1405. If type is "buy":
  1406. category: Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional.
  1407. text: A string to search for in the item name. Optional.
  1408. Command.Buff.Cancel
  1409. Function documentation:
  1410. Cancels a buff on the player. Not all buffs are cancelable.
  1411. This function is subject to the "global" command queue.
  1412. Command.Buff.Cancel(buff) -- buff
  1413. Parameters:
  1414. buff: The ID of the buff to cancel.
  1415. Command.Buff.Describe
  1416. Function documentation:
  1417. Requests a detailed description for a given buff.
  1418. This function is subject to the "global" command queue.
  1419. Command.Buff.Describe(unit, buff) -- unit, buff
  1420. Parameters:
  1421. buff: The ID of the buff to describe.
  1422. unit: The ID of the unit that the buff is on.
  1423. Command.Console.Display
  1424. Function documentation:
  1425. Prints a line of text in a console window of your choice. Note that the line length is limited, including HTML tags.
  1426. Command.Console.Display(console, suppressPrefix, text, html) -- console, boolean, string, boolean
  1427. Parameters:
  1428. console: The console to display text into. May be "general", "combat", or a console ID.
  1429. html: Enables HTML mode. In HTML mode, a limited number of formatting tags are available: <u>, <font color="#rrggbb">, and <a lua="print('This is a lua script.')">.
  1430. suppressPrefix: Suppress the automatic addon shortname prefix.
  1431. text: The text to be printed.
  1432. Command.Cursor
  1433. Function documentation:
  1434. Changes the contents of the cursor. Ability cursors may be set only if the environment is not in secure mode.
  1435. Command.Cursor(hold) -- variant
  1436. Parameters:
  1437. hold: The new cursor. Currently accepts ability, item, itemtype, or non-empty non-wildcard slot IDs. Pass nil to clear the cursor.
  1438. Command.Dimension.Layout.Pickup
  1439. Function documentation:
  1440. Pick up the specified dimension item from the world to your inventory.
  1441. Command.Dimension.Layout.Pickup(dimensionItem) -- dimensionitem
  1442. Parameters:
  1443. dimensionItem: The ID of the dimension item to operate on.
  1444. Command.Dimension.Layout.Place
  1445. Function documentation:
  1446. Places the item (dimension or inventory) in your current dimension and modifies the details specified by the values parameter.
  1447. Command.Dimension.Layout.Place(item, values) -- item, table
  1448. Command.Dimension.Layout.Place(dimensionItem, values) -- dimensionitem, table
  1449. Parameters:
  1450. dimensionItem: The ID of the dimension item to operate on.
  1451. item: The inventory item to operate on.
  1452. values: Table containing data to set on the dimension item. All parameters are optional and will default to current or default values.
  1453. coordX: The X coordinate of the item.
  1454. coordY: The Y coordinate of the item.
  1455. coordZ: The Z coordinate of the item.
  1456. pitch: The pitch rotation of the item.
  1457. roll: The roll rotation of the item.
  1458. scale: The scale of the item.
  1459. yaw: The yaw rotation of the item.
  1460. Command.Dimension.Layout.Select
  1461. Function documentation:
  1462. Selects or deselects the specified dimension item.
  1463. Command.Dimension.Layout.Select(dimensionItem, selected) -- dimensionitem, boolean
  1464. Parameters:
  1465. dimensionItem: The ID of the dimension item to operate on.
  1466. selected: Indicates if the dimension item should be selected or deselected.
  1467. Command.Event.Attach
  1468. Function documentation:
  1469. Attaches an event handler to an event.
  1470. Command.Event.Attach(event, handler, label) -- eventGlobal, function, string
  1471. Command.Event.Attach(event, handler, label, priority) -- eventGlobal, function, string, number
  1472. Parameters:
  1473. event: A global event handle, usually pulled out of the "Event." hierarchy.
  1474. handler: A global event handler function. This will be called when the event fires. The first parameter will be the standard global event handle, any other parameters will follow that.
  1475. label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
  1476. priority: Priority of the event handler. Higher numbers trigger first.
  1477. Command.Event.Detach
  1478. Function documentation:
  1479. Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a wildcard. If multiple events match the constraints, only one will be detached.
  1480. Command.Event.Detach(event, handler) -- eventGlobal, function/nil
  1481. Command.Event.Detach(event, handler, label) -- eventGlobal, function/nil, string/nil
  1482. Command.Event.Detach(event, handler, label, priority) -- eventGlobal, function/nil, string/nil, number/nil
  1483. Command.Event.Detach(event, handler, label, priority, owner) -- eventGlobal, function/nil, string/nil, number/nil, string/nil
  1484. Parameters:
  1485. event: A global event handle, usually pulled out of the "Event." hierarchy.
  1486. handler: A global event handler function. This will be called when the event fires. The first parameter will be the standard global event handle, any other parameters will follow that.
  1487. label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
  1488. owner: Owner to search for.
  1489. priority: Priority of the event handler. Higher numbers trigger first.
  1490. Command.Guild.Bank.Deposit
  1491. Function documentation:
  1492. Deposits money into the guild bank.
  1493. Requires the "guildbank" interaction flag to be set.
  1494. This function is subject to the "global" command queue.
  1495. Command.Guild.Bank.Deposit(coin) -- number
  1496. Command.Guild.Bank.Deposit(coin, callback) -- number, callbackfunction
  1497. Parameters:
  1498. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1499. coin: The string "coin", used as a value to request the player's money.
  1500. Command.Guild.Bank.Purchase
  1501. Function documentation:
  1502. Purchases a new guild bank vault.
  1503. Requires the "guildbank" interaction flag to be set.
  1504. This function is subject to the "global" command queue.
  1505. Command.Guild.Bank.Purchase() -- void
  1506. Command.Guild.Bank.Purchase(callback) -- callbackfunction
  1507. Parameters:
  1508. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1509. Command.Guild.Bank.Withdraw
  1510. Function documentation:
  1511. Withdraws money from the guild bank.
  1512. Requires the "guildbank" interaction flag to be set.
  1513. This function is subject to the "global" command queue.
  1514. Command.Guild.Bank.Withdraw(coin) -- number
  1515. Command.Guild.Bank.Withdraw(coin, callback) -- number, callbackfunction
  1516. Parameters:
  1517. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1518. coin: The string "coin", used as a value to request the player's money.
  1519. Command.Guild.Log.Request
  1520. Function documentation:
  1521. Requests a guild log event.
  1522. This function is subject to the "bulk" command queue, and will error if the command queue is not ready to send.
  1523. Command.Guild.Log.Request() -- void
  1524. Command.Guild.Log.Request(callback) -- callbackfunction
  1525. Parameters:
  1526. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1527. Command.Guild.Motd
  1528. Function documentation:
  1529. Changes the guild's Message of the Day.
  1530. This function is subject to the "global" command queue.
  1531. Command.Guild.Motd(motd) -- string
  1532. Command.Guild.Motd(motd, callback) -- string, callbackfunction
  1533. Parameters:
  1534. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1535. motd: The new Message of the Day.
  1536. Command.Guild.Roster.Demote
  1537. Function documentation:
  1538. Demotes a guildmember by one rank.
  1539. This function is subject to the "global" command queue.
  1540. Command.Guild.Roster.Demote(member) -- string
  1541. Command.Guild.Roster.Demote(member, callback) -- string, callbackfunction
  1542. Parameters:
  1543. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1544. member: The guildmember to target.
  1545. Command.Guild.Roster.Kick
  1546. Function documentation:
  1547. Kicks a guildmember from the guild.
  1548. This function is subject to the "global" command queue.
  1549. Command.Guild.Roster.Kick(member) -- string
  1550. Command.Guild.Roster.Kick(member, callback) -- string, callbackfunction
  1551. Parameters:
  1552. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1553. member: The guildmember to target.
  1554. Command.Guild.Roster.Note
  1555. Function documentation:
  1556. Changes your guild note.
  1557. This function is subject to the "global" command queue.
  1558. Command.Guild.Roster.Note(note) -- string
  1559. Command.Guild.Roster.Note(note, callback) -- string, callbackfunction
  1560. Parameters:
  1561. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1562. note: The new note.
  1563. Command.Guild.Roster.NoteOfficer
  1564. Function documentation:
  1565. Changes a guildmember's officer note.
  1566. This function is subject to the "global" command queue.
  1567. Command.Guild.Roster.NoteOfficer(member, note) -- string, string
  1568. Command.Guild.Roster.NoteOfficer(member, note, callback) -- string, string, callbackfunction
  1569. Parameters:
  1570. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1571. member: The guildmember to target.
  1572. note: The new note.
  1573. Command.Guild.Roster.Promote
  1574. Function documentation:
  1575. Promotes a guildmember by one rank.
  1576. This function is subject to the "global" command queue.
  1577. Command.Guild.Roster.Promote(member) -- string
  1578. Command.Guild.Roster.Promote(member, callback) -- string, callbackfunction
  1579. Parameters:
  1580. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1581. member: The guildmember to target.
  1582. Command.Guild.Wall.Delete
  1583. Function documentation:
  1584. Deletes an entry from the guild wall.
  1585. This function is subject to the "global" command queue.
  1586. Command.Guild.Wall.Delete(wall) -- guildwall
  1587. Command.Guild.Wall.Delete(wall, callback) -- guildwall, callbackfunction
  1588. Parameters:
  1589. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1590. wall: The ID of the target wall post.
  1591. Command.Guild.Wall.Post
  1592. Function documentation:
  1593. Posts an entry to the guild wall.
  1594. This function is subject to the "global" command queue.
  1595. Command.Guild.Wall.Post(post) -- string
  1596. Command.Guild.Wall.Post(post, callback) -- string, callbackfunction
  1597. Parameters:
  1598. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1599. post: The item to post.
  1600. Command.Guild.Wall.Request
  1601. Function documentation:
  1602. Requests a guild wall event.
  1603. This function is subject to the "bulk" command queue, and will error if the command queue is not ready to send.
  1604. Command.Guild.Wall.Request() -- void
  1605. Command.Guild.Wall.Request(callback) -- callbackfunction
  1606. Parameters:
  1607. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1608. Command.Item.Destroy
  1609. Function documentation:
  1610. Destroys an item. Be careful: this really does destroy an item. There is no confirmation dialog and the process is irreversible. This cannot destroy items directly out of the guild bank.
  1611. If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
  1612. This function is subject to the "global" command queue.
  1613. Command.Item.Destroy(target) -- item
  1614. Parameters:
  1615. target: The item ID of the item to destroy.
  1616. Command.Item.Move
  1617. Function documentation:
  1618. Moves an item from one location to another. This cannot move items directly between equipment, wardrobe, or guild bank - you'll have to stop off in the inventory first.
  1619. If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
  1620. This function is subject to the "global" command queue.
  1621. Command.Item.Move(source, destination) -- item, slot
  1622. Command.Item.Move(source, destination) -- slot, slot
  1623. Parameters:
  1624. destination: The location to move the item. May attempt to stack or swap if there is already an item here.
  1625. source: The item to move. Must be a slot specifier that refers to an actual item.
  1626. Command.Item.Split
  1627. Function documentation:
  1628. Splits a number of items off a stack.
  1629. If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
  1630. This function is subject to the "global" command queue.
  1631. Command.Item.Split(source, stack) -- item, number
  1632. Command.Item.Split(source, stack) -- slot, number
  1633. Parameters:
  1634. source: The item to split. May be a slot specifier or an item ID.
  1635. stack: The number of items to move into the new stack. Must be a positive integer.
  1636. Command.Item.Standard.Drag
  1637. Function documentation:
  1638. Behaves in the same way that the addon system does when an inventory icon is dragged.
  1639. If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
  1640. Command.Item.Standard.Drag(target) -- slot
  1641. Command.Item.Standard.Drag(target) -- item
  1642. Parameters:
  1643. target: The item or slot to be targeted.
  1644. Command.Item.Standard.Drop
  1645. Function documentation:
  1646. Behaves in the same way that the addon system does when an inventory icon is dropped.
  1647. This function consumes a hardware event to function. Hardware events include Event.UI.Input.Mouse.*.Down, Event.UI.Input.Mouse.*.Up, and Event.UI.Input.Mouse.Wheel.*.
  1648. If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
  1649. Command.Item.Standard.Drop(target) -- slot
  1650. Command.Item.Standard.Drop(target) -- item
  1651. Parameters:
  1652. target: The item or slot to be targeted.
  1653. Command.Item.Standard.Left
  1654. Function documentation:
  1655. Behaves in the same way that the addon system does when an inventory icon is left-clicked.
  1656. This function consumes a hardware event to function. Hardware events include Event.UI.Input.Mouse.*.Down, Event.UI.Input.Mouse.*.Up, and Event.UI.Input.Mouse.Wheel.*.
  1657. If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
  1658. Command.Item.Standard.Left(target) -- slot
  1659. Command.Item.Standard.Left(target) -- item
  1660. Parameters:
  1661. target: The item or slot to be targeted.
  1662. Command.Item.Standard.Right
  1663. Function documentation:
  1664. Behaves in the same way that the addon system does when an inventory icon is right-clicked.
  1665. This function consumes a hardware event to function. Hardware events include Event.UI.Input.Mouse.*.Down, Event.UI.Input.Mouse.*.Up, and Event.UI.Input.Mouse.Wheel.*.
  1666. If interacting with an item in the player bank, requires the "bank" interaction flag to be set. If interacting with an item in the guild bank, requires the "guildbank" interaction flag to be set.
  1667. Command.Item.Standard.Right(target) -- slot
  1668. Command.Item.Standard.Right(target) -- item
  1669. Parameters:
  1670. target: The item or slot to be targeted.
  1671. Command.Mail.Delete
  1672. Function documentation:
  1673. Deletes a mail.
  1674. Requires the "mail" interaction flag to be set.
  1675. This function is subject to the "global" command queue.
  1676. Command.Mail.Delete(mail) -- mail
  1677. Command.Mail.Delete(mail, callback) -- mail, callbackfunction
  1678. Parameters:
  1679. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1680. mail: The ID of the mail to be targeted.
  1681. Command.Mail.Open
  1682. Function documentation:
  1683. Opens a mail, retrieving detailed information for it.
  1684. Requires the "mail" interaction flag to be set.
  1685. This function is subject to the "global" command queue.
  1686. Command.Mail.Open(mail) -- mail
  1687. Command.Mail.Open(mail, callback) -- mail, callbackfunction
  1688. Parameters:
  1689. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1690. mail: The ID of the mail to be targeted.
  1691. Command.Mail.Pay
  1692. Function documentation:
  1693. Pays the COD fee on a mail.
  1694. Requires the "mail" interaction flag to be set.
  1695. This function is subject to the "global" command queue.
  1696. Command.Mail.Pay(mail) -- mail
  1697. Command.Mail.Pay(mail, callback) -- mail, callbackfunction
  1698. Parameters:
  1699. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1700. mail: The ID of the mail to be targeted.
  1701. Command.Mail.Return
  1702. Function documentation:
  1703. Returns a mail to its sender.
  1704. Requires the "mail" interaction flag to be set.
  1705. This function is subject to the "global" command queue.
  1706. Command.Mail.Return(mail) -- mail
  1707. Command.Mail.Return(mail, callback) -- mail, callbackfunction
  1708. Parameters:
  1709. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1710. mail: The ID of the mail to be targeted.
  1711. Command.Mail.Send
  1712. Function documentation:
  1713. Sends mail.
  1714. This function consumes a hardware event to function. Hardware events include Event.UI.Input.Mouse.*.Down, Event.UI.Input.Mouse.*.Up, and Event.UI.Input.Mouse.Wheel.*.
  1715. Requires the "mail" interaction flag to be set.
  1716. Command.Mail.Send(mail) -- table
  1717. Command.Mail.Send(mail, callback) -- table, callbackfunction
  1718. Parameters:
  1719. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1720. mail: Table containing data about the mail to send.
  1721. to: The name of the player to send mail to. Required.
  1722. subject: The mail's subject. Required.
  1723. body: The mail's body.
  1724. cod: The money required for the recipient to remove attachments. Mutually exclusive with "coin", requires non-empty "attachments".
  1725. coin: The amount of money attached to this message. Mutually exclusive with "cod".
  1726. attachments: A table listing the item IDs of the items you wish to attach. Maximum of 6.
  1727. Command.Mail.Spam
  1728. Function documentation:
  1729. Marks mail as spam.
  1730. Requires the "mail" interaction flag to be set.
  1731. This function is subject to the "global" command queue.
  1732. Command.Mail.Spam(mail) -- mail
  1733. Command.Mail.Spam(mail, callback) -- mail, callbackfunction
  1734. Parameters:
  1735. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1736. mail: The ID of the mail to be targeted.
  1737. Command.Mail.Take
  1738. Function documentation:
  1739. Takes an attached item from mail.
  1740. Requires the "mail" interaction flag to be set.
  1741. This function is subject to the "global" command queue.
  1742. Command.Mail.Take(mail, item) -- mail, item
  1743. Command.Mail.Take(mail, items) -- mail, table
  1744. Command.Mail.Take(mail, item, callback) -- mail, item, callbackfunction
  1745. Command.Mail.Take(mail, items, callback) -- mail, table, callbackfunction
  1746. Parameters:
  1747. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1748. item: The ID of the item to be taken.
  1749. items: A table containing a list of the items to be taken.
  1750. mail: The ID of the mail to be targeted.
  1751. Command.Map.Monitor
  1752. Function documentation:
  1753. Controls the state of the map monitor flag. When enabled, mainmap data will be received, updating every sixty seconds. When disabled, mainmap data will be received only when the built-in map window is open.
  1754. Command.Map.Monitor(monitor) -- boolean
  1755. Parameters:
  1756. monitor: The new state of the map monitor flag.
  1757. Command.Map.Waypoint.Clear
  1758. Function documentation:
  1759. Clears the player's current waypoint.
  1760. Command.Map.Waypoint.Clear() -- void
  1761. Command.Map.Waypoint.Set
  1762. Function documentation:
  1763. Sets the player's waypoint.
  1764. Command.Map.Waypoint.Set(x, z) -- number, number
  1765. Parameters:
  1766. x: The x coordinate of the waypoint.
  1767. z: The z coordinate of the waypoint.
  1768. Command.Message.Accept
  1769. Function documentation:
  1770. Sets the environment to accept a given type and identifier of message. Parameters can be replaced with "nil" to act as a wildcard.
  1771. Command.Message.Accept(type, identifier) -- string/nil, string/nil
  1772. Parameters:
  1773. identifier: The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
  1774. type: The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
  1775. Command.Message.Broadcast
  1776. Function documentation:
  1777. Broadcast an unreliable addon message to some number of targets. This message will be dropped silently if the targets do not have the available bandwidth to receive it. The callback will respond with failure only if the message's target is invalid. "tell" messages are subject to the same restrictions as Command.Message.Send(). This command is throttled by the "message" throttle type.
  1778. Command.Message.Broadcast(type, target, identifier, data) -- string, string/nil, string, string
  1779. Command.Message.Broadcast(type, target, identifier, data, callback) -- string, string/nil, string, string, callbackfunction
  1780. Parameters:
  1781. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1782. data: The data to send. This parameter is binary-safe.
  1783. identifier: The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
  1784. target: The target of this message. Required for "channel" or "tell" message types, must be nil otherwise.
  1785. type: The type of message to send. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell".
  1786. Command.Message.Reject
  1787. Function documentation:
  1788. Sets the environment to reject a given type and identifier of message. Directly cancels out single calls to Command.Message.Accept.
  1789. Command.Message.Reject(type, identifier) -- string/nil, string/nil
  1790. Parameters:
  1791. identifier: The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
  1792. type: The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
  1793. Command.Message.Send
  1794. Function documentation:
  1795. Send an reliable addon message to a single target. The callback will respond with success only once the server has accepted the message for processing and queueing. Failure may occur if the target is invalid or if the target's receive queue is full. Messages may be sent only to players that are nearby, in your guild, in your party or raid, or that have sent you a message or tell during this session. This command is throttled by the "message" throttle type.
  1796. Command.Message.Send(target, identifier, data, callback) -- string, string, string, callbackfunction
  1797. Parameters:
  1798. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1799. data: The data to send. This parameter is binary-safe.
  1800. identifier: The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
  1801. target: The name of the player to send the message to.
  1802. Command.Quest.Abandon
  1803. Function documentation:
  1804. Abandons the given quest. Permitted only on personal quests.
  1805. This function is subject to the "global" command queue.
  1806. Command.Quest.Abandon(quest) -- quest
  1807. Parameters:
  1808. quest: The quest to be affected.
  1809. Command.Quest.Share
  1810. Function documentation:
  1811. Shares the given quest. Permitted only on personal quests.
  1812. This function consumes a hardware event to function. Hardware events include Event.UI.Input.Mouse.*.Down, Event.UI.Input.Mouse.*.Up, and Event.UI.Input.Mouse.Wheel.*.
  1813. Command.Quest.Share(quest) -- quest
  1814. Parameters:
  1815. quest: The quest to be affected.
  1816. Command.Quest.Track
  1817. Function documentation:
  1818. Tracks the current quest, un-tracking any other quest that may be tracked. Pass in "nil" to cancel all tracking. Permitted only on personal quests.
  1819. Command.Quest.Track(quest) -- quest
  1820. Command.Quest.Track(nil) -- nil
  1821. Parameters:
  1822. nil: The value "nil".
  1823. quest: The quest to be affected.
  1824. Command.Quest.Watch
  1825. Function documentation:
  1826. Watches a quest, possibly unwatching another item if the player is already watching the maximum item count. Permitted only on personal quests.
  1827. Command.Quest.Watch(quest, flag) -- quest, boolean
  1828. Parameters:
  1829. flag: The new watch status.
  1830. quest: The quest to be affected.
  1831. Command.Queue.Handler
  1832. Function documentation:
  1833. Sets the queue handler function. The queue handler function will be called when a Command.* function is called which relies on a queue for throttling and that queue is full. This function will be passed (queue, owner, func, ...). queue: The identifier of the queue that this function call will wait on. owner: The identifier of the addon that made the function call. func: The function call that has been queued. ...: The argument list that must be passed to func.
  1834. Command.Queue.Handler(handler) -- function
  1835. Parameters:
  1836. handler: The new queue handler.
  1837. Command.Slash.Register
  1838. Function documentation:
  1839. Registers a new chat slash command, inserts a new event handle into the Event.Slash hierarchy, and returns that handle. If called multiple times with the same slash command, will return the same handle each time.
  1840. eventTable = Command.Slash.Register(slashCommand) -- table <- string
  1841. Parameters:
  1842. slashCommand: The name of the slash command to register.
  1843. Return values:
  1844. 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.) Will return the same event table if used twice to register the same slash command.
  1845. Command.Social.Friend.Add
  1846. Function documentation:
  1847. Adds a player to your friend list.
  1848. This function is subject to the "global" command queue.
  1849. Command.Social.Friend.Add(name) -- string
  1850. Parameters:
  1851. name: The name of the friend.
  1852. Command.Social.Friend.Note
  1853. Function documentation:
  1854. Changes a friend's personal note.
  1855. This function is subject to the "global" command queue.
  1856. Command.Social.Friend.Note(name, note) -- string, string
  1857. Parameters:
  1858. name: The name of the friend.
  1859. note: The new personal note.
  1860. Command.Social.Friend.Remove
  1861. Function documentation:
  1862. Removes a player from your friend list.
  1863. This function is subject to the "global" command queue.
  1864. Command.Social.Friend.Remove(name) -- string
  1865. Parameters:
  1866. name: The name of the friend.
  1867. Command.Social.Ignore.Add
  1868. Function documentation:
  1869. Adds an player to your ignore list.
  1870. This function is subject to the "global" command queue.
  1871. Command.Social.Ignore.Add(name) -- string
  1872. Parameters:
  1873. name: The name of the ignored player.
  1874. Command.Social.Ignore.Note
  1875. Function documentation:
  1876. Changes an ignored player's personal note.
  1877. This function is subject to the "global" command queue.
  1878. Command.Social.Ignore.Note(name, note) -- string, string
  1879. Parameters:
  1880. name: The name of the ignored player.
  1881. note: The new personal note.
  1882. Command.Social.Ignore.Remove
  1883. Function documentation:
  1884. Removes a player from your ignore list.
  1885. This function is subject to the "global" command queue.
  1886. Command.Social.Ignore.Remove(name) -- string
  1887. Parameters:
  1888. name: The name of the ignored player.
  1889. Command.Storage.Clear
  1890. Function documentation:
  1891. Remove an element from a storage segment. If accessing guild storage, you will need write access to that element, as well as the Delete from Guild Addon Storage permission. This command is throttled by the "storage" throttle type.
  1892. Command.Storage.Clear(segment, identifier, callback) -- string, string, callbackfunction
  1893. Parameters:
  1894. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1895. identifier: The identifier of the storage bucket. Must be at least three characters long.
  1896. segment: The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.
  1897. Command.Storage.Get
  1898. Function documentation:
  1899. Gets a specific element from a target's storage. The result will be sent to Event.Storage.Get. This command is throttled by the "storage" throttle type on both the client and server.
  1900. Command.Storage.Get(target, segment, identifier, callback) -- string, string, string, callbackfunction
  1901. Parameters:
  1902. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1903. identifier: The identifier of the storage bucket. Must be at least three characters long.
  1904. segment: The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.
  1905. target: The name of the player whose storage should be accessed. Will work only on players in your guild, players in your group, or players that the addon unit system is aware of.
  1906. Command.Storage.List
  1907. Function documentation:
  1908. Lists the visible elements in a target's storage. The results will be sent to Event.Storage.List. This command is throttled by the "storage" throttle type.
  1909. Command.Storage.List(target, segment, callback) -- string, string, callbackfunction
  1910. Parameters:
  1911. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1912. segment: The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.
  1913. target: The name of the player whose storage should be accessed. Will work only on players in your guild, players in your group, or players that the addon unit system is aware of.
  1914. Command.Storage.Set
  1915. Function documentation:
  1916. Sets a storage element. If accessing guild storage, you will need the Write to Guild Addon Storage permission. If replacing an existing element, you will also need write access to that element as well as the Delete from Guild Addon Storage permission. You cannot create an element that you cannot read, nor can you create an element with Officer write permissions if you are not an Officer. This command is throttled by the "storage" throttle type.
  1917. Command.Storage.Set(segment, identifier, read, write, data, callback) -- string, string, string, string, string, callbackfunction
  1918. Parameters:
  1919. callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
  1920. data: The data to store. This parameter is binary-safe.
  1921. identifier: The identifier of the storage bucket. Must be at least three characters long.
  1922. read: Read permissions for this element. If the segment is "player", this may be "public", "guild", or "private", where public is readable by anyone, guild is readable by your guildmembers only, and private is readable by the player only. If the segment is "guild", this may be "public", "guild", or "officer", where public is readable by anyone, guild is readable by guildmembers with the Listen permission, and officer is readable by guildmembers with the Officer Chat permission.
  1923. segment: The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.
  1924. write: Write permissions for this element. If the segment is "player", this must be "private", as only you may modify your own storage. If the segment is "guild", this may be "guild" or "officer", where guild is changeable by guildmembers with the Delete from Guild Addon Storage permission, and officer is changeable by guildmembers with the Delete from Guild Addon Storage permission and the Officer Chat permission. The write permission must be "officer" if the read permission is "officer".
  1925. Command.System.Flash
  1926. Function documentation:
  1927. Controls the flashing of the Rift taskbar icon.
  1928. Command.System.Flash(flash) -- boolean
  1929. Parameters:
  1930. flash: Whether the taskbar icon should flash or not.
  1931. Command.System.Strict
  1932. Function documentation:
  1933. Puts the environment into Strict mode. In Strict mode, deprecated functions and events will throw errors instead of functioning normally.
  1934. Command.System.Strict() -- void
  1935. Command.System.Texture.Record
  1936. Function documentation:
  1937. Begin recording Rift UI textures. The texture list will be transmitted via Event.System.Texture during the logout sequence. Note that this flag persists through character selection and cannot be disabled without restarting the client.
  1938. Command.System.Texture.Record() -- void
  1939. Command.System.Watchdog.Quiet
  1940. Function documentation:
  1941. Significantly increases the time required for the watchdog to generate warnings. Intended for bootup processes or similar long startup sequences that will not adversely affect the player experience. This function may not be called in combat.
  1942. Command.System.Watchdog.Quiet() -- void
  1943. Command.Title.Prefix
  1944. Function documentation:
  1945. Changes the player's prefix title.
  1946. This function is subject to the "global" command queue.
  1947. Command.Title.Prefix(title) -- title
  1948. Command.Title.Prefix(title) -- nil
  1949. Parameters:
  1950. title: The ID of the new title to set, or "nil" for no title.
  1951. Command.Title.Suffix
  1952. Function documentation:
  1953. Changes the player's suffix title.
  1954. This function is subject to the "global" command queue.
  1955. Command.Title.Suffix(title) -- title
  1956. Command.Title.Suffix(title) -- nil
  1957. Parameters:
  1958. title: The ID of the new title to set, or "nil" for no title.
  1959. Command.Tooltip
  1960. Function documentation:
  1961. Changes the displayed tooltip.
  1962. Command.Tooltip(target) -- variant
  1963. Command.Tooltip(target, nil) -- variant, nil
  1964. Command.Tooltip(owner, buff) -- unit, buff
  1965. Parameters:
  1966. buff: The ID of a buff for the new tooltip.
  1967. nil: Optional placeholder nil.
  1968. owner: The ID of the owner of the buff.
  1969. target: The new tooltip. Currently accepts ability, item, itemtype, or unit IDs. Pass nil to clear the tooltip.
  1970. Command.UI.Error
  1971. Function documentation:
  1972. Display the addon error dialog.
  1973. Command.UI.Error(id) -- error
  1974. Parameters:
  1975. id: The ID of the error to be displayed.
  1976. Command.Unit.Menu
  1977. Function documentation:
  1978. Creates a standard context menu targeted at the unit of choice.
  1979. Command.Unit.Menu(target) -- unit
  1980. Parameters:
  1981. target: The unit to generate a context menu for.
  1982.  
  1983. Utilities:
  1984. Utility.Auction.Cost
  1985. Function documentation:
  1986. Returns the amount of silver it will cost to post a given auction.
  1987. This function is deprecated and will be removed in the future. It should not be used.
  1988. cost = Utility.Auction.Cost(item, time, bid, buyout) -- number <- item, number, number/nil, number/nil
  1989. cost = Utility.Auction.Cost(item, time, bid, buyout, partial) -- number <- item, number, number/nil, number/nil, boolean
  1990. Parameters:
  1991. bid: The minimum bid for the new auction, in silver. nil if no bid is desired.
  1992. buyout: The buyout for the new auction, in silver. nil if no buyout is desired.
  1993. item: The ID of the item to be auctioned.
  1994. partial: Whether partial buyouts should be permitted. Must be "false" if a buyout is not provided or if a bid is provided that is different from the buyout. If this parameter is omitted, will default to "true" when possible, or "false" otherwise.
  1995. time: The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.
  1996. Return values:
  1997. cost: The cost of posting this auction, in silver.
  1998. Utility.Auction.CostOrder
  1999. Function documentation:
  2000. Returns the amount of silver it will cost to post a given order.
  2001. cost = Utility.Auction.CostOrder(itemtype, quantity, time, buyout) -- number <- itemtype, number, number, number
  2002. Parameters:
  2003. buyout: The total buyout for the new auction, in silver. Must be evenly divisible by quantity.
  2004. itemtype: The item type to be ordered.
  2005. quantity: The number of items to be ordered.
  2006. time: The duration that the order should last, in hours. Valid values are limited to 12, 24, and 48.
  2007. Return values:
  2008. cost: The cost of posting this order, in silver. Includes the full deposit for the items.
  2009. Utility.Auction.CostPost
  2010. Function documentation:
  2011. Returns the amount of silver it will cost to post a given auction.
  2012. cost = Utility.Auction.CostPost(item, time, bid, buyout) -- number <- item, number, number/nil, number/nil
  2013. cost = Utility.Auction.CostPost(item, time, bid, buyout, partial) -- number <- item, number, number/nil, number/nil, boolean
  2014. Parameters:
  2015. bid: The minimum bid for the new auction, in silver. nil if no bid is desired.
  2016. buyout: The buyout for the new auction, in silver. nil if no buyout is desired.
  2017. item: The ID of the item to be auctioned.
  2018. partial: Whether partial buyouts should be permitted. Must be "false" if a buyout is not provided or if a bid is provided that is different from the buyout. If this parameter is omitted, will default to "true" when possible, or "false" otherwise.
  2019. time: The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.
  2020. Return values:
  2021. cost: The cost of posting this auction, in silver.
  2022. Utility.Dispatch
  2023. Function documentation:
  2024. 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.
  2025. Utility.Dispatch(func, identifier, info) -- function, string, string
  2026. Parameters:
  2027. func: The function to call.
  2028. identifier: The identifier of the addon to credit execution time towards.
  2029. info: An info string to be included in error reports.
  2030. Utility.Event.Create
  2031. Function documentation:
  2032. 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.
  2033. caller, handle = Utility.Event.Create(identifier, event) -- function, table <- string, string
  2034. Parameters:
  2035. event: The event's name. "." characters will be treated as hierarchy delimeters.
  2036. identifier: The identifier of the addon creating this event.
  2037. Return values:
  2038. caller: A function 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.
  2039. handle: The resulting event handle.
  2040. Utility.Item.Slot.All
  2041. Function documentation:
  2042. Generates a slot specifier for all known items.
  2043. slot = Utility.Item.Slot.All() -- slot <- void
  2044. Return values:
  2045. slot: The requested slot specifier.
  2046. Utility.Item.Slot.Bank
  2047. Function documentation:
  2048. Generates a slot specifier for the player's bank.
  2049. slot = Utility.Item.Slot.Bank() -- slot <- void
  2050. slot = Utility.Item.Slot.Bank(segment) -- slot <- string
  2051. slot = Utility.Item.Slot.Bank(segment) -- slot <- number
  2052. slot = Utility.Item.Slot.Bank(segment, slot) -- slot <- string, number
  2053. slot = Utility.Item.Slot.Bank(segment, slot) -- slot <- number, number
  2054. Parameters:
  2055. segment: Segment to inspect. Use "main" for the main bank area, "bag" for the bank bags, or a number starting at 1 for the contents of a specific bank bag.
  2056. slot: The slot ID, starting at 1.
  2057. Return values:
  2058. slot: The requested slot specifier.
  2059. Utility.Item.Slot.Equipment
  2060. Function documentation:
  2061. Generates a slot specifier for the player's equipment.
  2062. slot = Utility.Item.Slot.Equipment() -- slot <- void
  2063. slot = Utility.Item.Slot.Equipment(slot) -- slot <- string
  2064. Parameters:
  2065. slot: The equipment slot to be used. Can be any of the following: "helmet", "cape", "shoulders", "chest", "gloves", "belt", "legs", "feet", "handmain", "handoff", "ranged", "neck", "trinket", "ring1", "ring2", "synergy", "focus", or "seal".
  2066. Return values:
  2067. slot: The requested slot specifier.
  2068. Utility.Item.Slot.Guild
  2069. Function documentation:
  2070. Generates a slot specifier for the player's guild bank.
  2071. slot = Utility.Item.Slot.Guild() -- slot <- void
  2072. slot = Utility.Item.Slot.Guild(vault) -- slot <- number
  2073. slot = Utility.Item.Slot.Guild(vault, slot) -- slot <- number, number
  2074. Parameters:
  2075. slot: The slot ID, starting at 1.
  2076. vault: The vault ID to inspect. Starts at 1.
  2077. Return values:
  2078. slot: The requested slot specifier.
  2079. Utility.Item.Slot.Inventory
  2080. Function documentation:
  2081. Generates a slot specifier for the player's inventory.
  2082. slot = Utility.Item.Slot.Inventory() -- slot <- void
  2083. slot = Utility.Item.Slot.Inventory(bag) -- slot <- string
  2084. slot = Utility.Item.Slot.Inventory(bag) -- slot <- number
  2085. slot = Utility.Item.Slot.Inventory(bag, slot) -- slot <- string, number
  2086. slot = Utility.Item.Slot.Inventory(bag, slot) -- slot <- number, number
  2087. Parameters:
  2088. bag: The number of the bag whose contents should be inspected, starting at 1, or "bag" to inspect the actual inventory bags.
  2089. slot: The slot ID, starting at 1.
  2090. Return values:
  2091. slot: The requested slot specifier.
  2092. Utility.Item.Slot.Parse
  2093. Function documentation:
  2094. Parses a slot specifier, returning information on what it represents.
  2095. type, parameter, parameter = Utility.Item.Slot.Parse(slot) -- string, variant, variant <- slot
  2096. type, parameter = Utility.Item.Slot.Parse(slot) -- string, variant <- slot
  2097. type = Utility.Item.Slot.Parse(slot) -- string <- slot
  2098. Utility.Item.Slot.Parse(slot) -- slot
  2099. Parameters:
  2100. slot: The slot ID, starting at 1.
  2101. Return values:
  2102. parameter: A parameter for this slot type. Actual meaning depends on the type.
  2103. type: The type of this element.
  2104. Utility.Item.Slot.Quest
  2105. Function documentation:
  2106. Generates a slot specifier for the player's quest bag.
  2107. slot = Utility.Item.Slot.Quest() -- slot <- void
  2108. slot = Utility.Item.Slot.Quest(slot) -- slot <- number
  2109. Parameters:
  2110. slot: The slot ID, starting at 1.
  2111. Return values:
  2112. slot: The requested slot specifier.
  2113. Utility.Item.Slot.Vault
  2114. Function documentation:
  2115. Generates a slot specifier for the player's bank vaults.
  2116. slot = Utility.Item.Slot.Vault() -- slot <- void
  2117. slot = Utility.Item.Slot.Vault(vault) -- slot <- number
  2118. slot = Utility.Item.Slot.Vault(vault, slot) -- slot <- number, number
  2119. Parameters:
  2120. slot: The slot ID, starting at 1.
  2121. vault: The vault ID, starting at 1.
  2122. Return values:
  2123. slot: The requested slot specifier.
  2124. Utility.Item.Slot.Wardrobe
  2125. Function documentation:
  2126. Generates a slot specifier for the player's wardrobe.
  2127. slot = Utility.Item.Slot.Wardrobe() -- slot <- void
  2128. slot = Utility.Item.Slot.Wardrobe(costume) -- slot <- number
  2129. slot = Utility.Item.Slot.Wardrobe(costume, slot) -- slot <- number, string
  2130. Parameters:
  2131. costume: The number of the wardrobe costume to inspect, starting at 1.
  2132. slot: The equipment slot to be used. Can be any of the following: "helmet", "cape", "shoulders", "chest", "gloves", "legs", or "feet".
  2133. Return values:
  2134. slot: The requested slot specifier.
  2135. Utility.Mail.Cost
  2136. Function documentation:
  2137. Returns the amount of silver it will cost to send a given mail.
  2138. cost = Utility.Mail.Cost(mail) -- number <- table
  2139. Parameters:
  2140. mail: The mail to check. In the same format as the parameter of Command.Mail.Send.
  2141. Return values:
  2142. cost: The cost of sending this mail, in silver.
  2143. Utility.Matrix.Create
  2144. Function documentation:
  2145. Creates a transformation matrix table. These can also be created by hand; this is simply a convenience routine. Applies scaling first, then rotation, then translation.
  2146. matrix = Utility.Matrix.Create(scaleX, scaleY, rotate, translateX, translateY) -- table <- number/nil, number/nil, number/nil, number/nil, number/nil
  2147. Parameters:
  2148. rotate: Rotation amount in radians. Defaults to 0.
  2149. scaleX: Scaling along the X axis. Defaults to 1.
  2150. scaleY: Scaling along the Y axis. Defaults to 1.
  2151. translateX: Translation along the X axis. Defaults to 0.
  2152. translateY: Translation along the Y axis. Defaults to 0.
  2153. Return values:
  2154. matrix: Matrix table suitable for "transform" members.
  2155. Utility.Message.Limits
  2156. Function documentation:
  2157. Returns information on the message bandwidth limits.
  2158. data = Utility.Message.Limits() -- table <- void
  2159. Return values:
  2160. data: The requested data.
  2161. Returned members:
  2162. burst: The amount of data that can be sent or received without being subject to throttling.
  2163. maximum: Maximum allowed message size.
  2164. sustained: Amount of data that can be transferred per second without dropping messages.
  2165. Utility.Message.Size
  2166. Function documentation:
  2167. Returns the size of a message, as used for bandwidth control.
  2168. size = Utility.Message.Size(to, identifier, data) -- number <- string/nil, string, string
  2169. Parameters:
  2170. data: The data to send. This parameter is binary-safe.
  2171. identifier: The identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
  2172. to: The name of the player or channel to send to. nil if this is not targeted at a specific player or channel.
  2173. Return values:
  2174. size: The calculated size of the message.
  2175. Utility.Serialize.Full
  2176. Function documentation:
  2177. Serializes a table of parameters. Results in a string suitable for feeding directly into loadstring(). Deals properly with table cycles and non-tree structures.
  2178. serialized = Utility.Serialize.Full(elements) -- string <- table
  2179. serialized = Utility.Serialize.Full(elements, exists) -- string <- table, table
  2180. Parameters:
  2181. elements: Table of elements to serialize.
  2182. exists: Optional parameter containing a table of elements that should be included even in the case that they are nil.
  2183. Return values:
  2184. serialized: String containing serialized output. May be nil if there was an error with the input.
  2185. Utility.Serialize.Inline
  2186. Function documentation:
  2187. 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.
  2188. serialized = Utility.Serialize.Inline(element) -- string <- variant
  2189. Parameters:
  2190. element: Element to serialize.
  2191. Return values:
  2192. serialized: String containing serialized output. May be nil if there was an error with the input.
  2193. Utility.Storage.Checksum
  2194. Function documentation:
  2195. Calculates the storage checksum of a string.
  2196. checksum = Utility.Storage.Checksum(data) -- string <- string
  2197. Parameters:
  2198. data: The data to store. This parameter is binary-safe.
  2199. Return values:
  2200. checksum: An opaque string representing the storage checksum.
  2201. Utility.Storage.Limits
  2202. Function documentation:
  2203. Returns information on the storage bandwidth limits.
  2204. data = Utility.Storage.Limits() -- table <- void
  2205. Return values:
  2206. data: The requested data.
  2207. Returned members:
  2208. burst: The amount of data that can be sent or received without being subject to throttling.
  2209. sustained: Amount of data that can be transferred per second without dropping messages.
  2210. Utility.Storage.Size
  2211. Function documentation:
  2212. Returns the size of a stored element, as used for storage quota and bandwidth control.
  2213. size = Utility.Storage.Size(identifier, data) -- number <- string, string
  2214. Parameters:
  2215. data: The data to store. This parameter is binary-safe.
  2216. identifier: The identifier of the storage bucket. Must be at least three characters long.
  2217. Return values:
  2218. size: The calculated size of the storage bucket.
  2219. Utility.Type
  2220. Function documentation:
  2221. Determines the type of a given item. Understands Rift-specific identifiers.
  2222. type = Utility.Type(element) -- string <- variant
  2223. Parameters:
  2224. element: The element to check.
  2225. Return values:
  2226. type: The type of this element.
  2227. Utility.Unit.Availability
  2228. Function documentation:
  2229. Returns information on which detail members are available in which availability mode.
  2230. lookup = Utility.Unit.Availability() -- table <- void
  2231. Return values:
  2232. lookup: Lookup table for which members are available in which availability mode. To check if "full" availability contains "level", check "lookup.full.level".
  2233.  
  2234. Native frames:
  2235. UI.Native.Ability
  2236. The Ability dialog.
  2237. UI.Native.Accolade
  2238. The Warfront accolade HUD.
  2239. UI.Native.Achievement
  2240. The Achievement dialog.
  2241. UI.Native.AchievementPopup
  2242. The "Achievement Complete" popup.
  2243. UI.Native.Adventure
  2244. The Instant Adventure dialog.
  2245. UI.Native.Ascend
  2246. The Ascend-a-Friend dialog.
  2247. UI.Native.Attunement
  2248. The Planar Attunement dialog.
  2249. UI.Native.Auction
  2250. The Auction dialog.
  2251. UI.Native.Bag
  2252. The bag and currency HUD.
  2253. UI.Native.BagBank1
  2254. The first bank inventory bag.
  2255. UI.Native.BagBank2
  2256. The second bank inventory bag.
  2257. UI.Native.BagBank3
  2258. The third bank inventory bag.
  2259. UI.Native.BagBank4
  2260. The fourth bank inventory bag.
  2261. UI.Native.BagBank5
  2262. The fifth bank inventory bag.
  2263. UI.Native.BagBank6
  2264. The sixth bank inventory bag.
  2265. UI.Native.BagBank7
  2266. The seventh bank inventory bag.
  2267. UI.Native.BagBank8
  2268. The eighth bank inventory bag.
  2269. UI.Native.BagInventory1
  2270. The first main inventory bag.
  2271. UI.Native.BagInventory2
  2272. The second main inventory bag.
  2273. UI.Native.BagInventory3
  2274. The third main inventory bag.
  2275. UI.Native.BagInventory4
  2276. The fourth main inventory bag.
  2277. UI.Native.BagInventory5
  2278. The fifth main inventory bag.
  2279. UI.Native.BagInventory6
  2280. The sixth main inventory bag.
  2281. UI.Native.BagInventory7
  2282. The seventh main inventory bag.
  2283. UI.Native.Bank
  2284. The Bank dialog.
  2285. UI.Native.BankGuild
  2286. The Guild Bank dialog.
  2287. UI.Native.BarBottom1
  2288. The first extra bottom action bar.
  2289. UI.Native.BarBottom2
  2290. The second extra bottom action bar.
  2291. UI.Native.BarBottom3
  2292. The third extra bottom action bar.
  2293. UI.Native.BarBottom4
  2294. The fourth extra bottom action bar.
  2295. UI.Native.BarBottom5
  2296. The fifth extra bottom action bar.
  2297. UI.Native.BarBottom6
  2298. The sixth extra bottom action bar.
  2299. UI.Native.BarMain
  2300. The main action bar.
  2301. UI.Native.BarPet
  2302. The pet action bar.
  2303. UI.Native.BarSide1
  2304. The first extra side action bar.
  2305. UI.Native.BarSide2
  2306. The second extra side action bar.
  2307. UI.Native.BarSide3
  2308. The third extra side action bar.
  2309. UI.Native.BarSide4
  2310. The fourth extra side action bar.
  2311. UI.Native.BarTemporary
  2312. The action bar used for temporary abilities.
  2313. UI.Native.Breath
  2314. The breath/fatigue bar.
  2315. UI.Native.Buffbar
  2316. The player's buff bar.
  2317. UI.Native.Castbar
  2318. The player's cast bar.
  2319. UI.Native.Character
  2320. The Character dialog.
  2321. UI.Native.Chronicle
  2322. The Chronicles dialog.
  2323. UI.Native.Coinlock
  2324. The Coin Lock button.
  2325. UI.Native.Console1
  2326. The first console window.
  2327. UI.Native.Console2
  2328. The second console window.
  2329. UI.Native.Console3
  2330. The third console window.
  2331. UI.Native.Console4
  2332. The fourth console window.
  2333. UI.Native.Console5
  2334. The fifth console window.
  2335. UI.Native.Console6
  2336. The sixth console window.
  2337. UI.Native.Console7
  2338. The seventh console window.
  2339. UI.Native.ConsoleSetting
  2340. The console settings dialog.
  2341. UI.Native.Crafting
  2342. The Crafting dialog.
  2343. UI.Native.Ctf
  2344. The Capture-the-Flag status indicator.
  2345. UI.Native.Guest
  2346. The guest invite dialog for weddings.
  2347. UI.Native.Guild
  2348. The Guild dialog.
  2349. UI.Native.GuildCharter
  2350. The Guild Charter dialog.
  2351. UI.Native.GuildFinder
  2352. The Guild Finder dialog.
  2353. UI.Native.Import
  2354. The Import dialog, as reached from the escape menu.
  2355. UI.Native.Keybind
  2356. The Keybind dialog.
  2357. UI.Native.Layout
  2358. The UI Layout dialog.
  2359. UI.Native.Leaderboard
  2360. The Leaderboard dialog.
  2361. UI.Native.Lfg
  2362. The Looking-for-Group dialog.
  2363. UI.Native.Loot
  2364. The Loot dialog.
  2365. UI.Native.Macro
  2366. The Macro dialog.
  2367. UI.Native.MacroIcon
  2368. The Macro icons list.
  2369. UI.Native.MacroSlash
  2370. The Macro slash commands list.
  2371. UI.Native.Mail
  2372. The Mail dialog.
  2373. UI.Native.MailRead
  2374. The currently-being-read Mail dialog.
  2375. UI.Native.MapMain
  2376. The main map.
  2377. UI.Native.MapMini
  2378. The minimap.
  2379. UI.Native.MechanicPlayer
  2380. The player-focused class-specific-mechanic HUD element.
  2381. UI.Native.MechanicTarget
  2382. The target-focused class-specific-mechanic HUD element.
  2383. UI.Native.Mentor
  2384. The Mentoring popup.
  2385. UI.Native.Menu
  2386. The main menu HUD element.
  2387. UI.Native.MessageEvent
  2388. The event-related message popup.
  2389. UI.Native.MessageStandard
  2390. The generic message popup.
  2391. UI.Native.MessageText
  2392. The generic text popup.
  2393. UI.Native.MessageWarfront
  2394. The warfront-related message popup.
  2395. UI.Native.MessageZone
  2396. The zone-related message popup.
  2397. UI.Native.Notification
  2398. The notification message popup.
  2399. UI.Native.Notify
  2400. The public-group/return-to-graveyard popup button.
  2401. UI.Native.PortraitFocus
  2402. The portrait of your focus target.
  2403. UI.Native.PortraitParty1
  2404. The portrait of your first partymember.
  2405. UI.Native.PortraitParty1Pet
  2406. The portrait of your first partymember's pet.
  2407. UI.Native.PortraitParty2
  2408. The portrait of your second partymember.
  2409. UI.Native.PortraitParty2Pet
  2410. The portrait of your second partymember's pet.
  2411. UI.Native.PortraitParty3
  2412. The portrait of your third partymember.
  2413. UI.Native.PortraitParty3Pet
  2414. The portrait of your third partymember's pet.
  2415. UI.Native.PortraitParty4
  2416. The portrait of your fourth partymember.
  2417. UI.Native.PortraitParty4Pet
  2418. The portrait of your fourth partymember's pet.
  2419. UI.Native.PortraitPet
  2420. The portrait of your pet.
  2421. UI.Native.PortraitPlayer
  2422. Your portrait.
  2423. UI.Native.PortraitTarget
  2424. The portrait of your target.
  2425. UI.Native.PortraitTargetTarget
  2426. The portrait of your target's target.
  2427. UI.Native.Quest
  2428. The Quest dialog.
  2429. UI.Native.QuestStickies
  2430. The Quest sticky HUD.
  2431. UI.Native.Question
  2432. The general-purpose question popup.
  2433. UI.Native.Raid
  2434. The Raid dialog.
  2435. UI.Native.RaidGroup1
  2436. The raid frame for your raid's first group.
  2437. UI.Native.RaidGroup1Pet
  2438. The raid frame for your raid's first group's pets.
  2439. UI.Native.RaidGroup2
  2440. The raid frame for your raid's second group.
  2441. UI.Native.RaidGroup2Pet
  2442. The raid frame for your raid's second group's pets.
  2443. UI.Native.RaidGroup3
  2444. The raid frame for your raid's third group.
  2445. UI.Native.RaidGroup3Pet
  2446. The raid frame for your raid's third group's pets.
  2447. UI.Native.RaidGroup4
  2448. The raid frame for your raid's fourth group.
  2449. UI.Native.RaidGroup4Pet
  2450. The raid frame for your raid's fourth group's pets.
  2451. UI.Native.RaidParty
  2452. The raid frame used for displaying your party as a raid.
  2453. UI.Native.RaidPartyPet
  2454. The raid frame used for displaying your party's pets as a raid.
  2455. UI.Native.Reactive
  2456. The reactive-ability popup.
  2457. UI.Native.Recall
  2458. The set-recall-point dialog.
  2459. UI.Native.Respec
  2460. The respec dialog.
  2461. UI.Native.Rift
  2462. The Rift meter HUD.
  2463. UI.Native.Roll1
  2464. The first loot-roll popup.
  2465. UI.Native.Roll2
  2466. The second loot-roll popup.
  2467. UI.Native.Roll3
  2468. The third loot-roll popup.
  2469. UI.Native.Roll4
  2470. The fourth loot-roll popup.
  2471. UI.Native.Setting
  2472. The Settings dialog.
  2473. UI.Native.Social
  2474. The Social dialog.
  2475. UI.Native.Soul
  2476. The Soul Tree dialog.
  2477. UI.Native.Split
  2478. The stack split popup.
  2479. UI.Native.Streaming
  2480. The icon that indicates your current streaming download status.
  2481. UI.Native.Ticket
  2482. The Customer Service Ticket dialog.
  2483. UI.Native.Tip
  2484. The Game Tip dialog.
  2485. UI.Native.TipAlert
  2486. The Game Tip notification popup.
  2487. UI.Native.Tooltip
  2488. The tooltip.
  2489. UI.Native.TooltipAnchor
  2490. The location that tooltips are anchored to by default.
  2491. UI.Native.Trade
  2492. The Trade dialog.
  2493. UI.Native.Tray
  2494. The icon tray used for the clock, mail notification, and similar elements.
  2495. UI.Native.TraySocial
  2496. The icon tray used for social notifications.
  2497. UI.Native.Treasure
  2498. The Treasure popup used to claim dungeon loot.
  2499. UI.Native.Trial
  2500. The Trial dialog.
  2501. UI.Native.Upgrade
  2502. The Upgrade portrait, used for targets that are upgradeable.
  2503. UI.Native.Warfront
  2504. The Warfront dialog.
  2505. UI.Native.WarfrontLeaderboard
  2506. The Warfront Leaderboard dialog.
  2507. UI.Native.World
  2508. The World Event dialog.
  2509.  
  2510. Global events:
  2511. Event.Ability.New.Add
  2512. Event documentation:
  2513. Signals the addition of a player ability.
  2514. Event.Ability.New.Add(abilities)
  2515. Parameters:
  2516. abilities: Lists the abilities that were added. Table from ability ID to "true".
  2517. Event.Ability.New.Cooldown.Begin
  2518. Event documentation:
  2519. Signals the start of an ability's cooldown.
  2520. Event.Ability.New.Cooldown.Begin(cooldowns)
  2521. Parameters:
  2522. 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.
  2523. Event.Ability.New.Cooldown.End
  2524. Event documentation:
  2525. Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.
  2526. Event.Ability.New.Cooldown.End(cooldowns)
  2527. Parameters:
  2528. 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.
  2529. Event.Ability.New.Range.False
  2530. Event documentation:
  2531. Signals a player ability exiting range from its current target.
  2532. Event.Ability.New.Range.False(abilities)
  2533. Parameters:
  2534. abilities: The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.
  2535. Event.Ability.New.Range.True
  2536. Event documentation:
  2537. Signals a player ability entering range from its current target.
  2538. Event.Ability.New.Range.True(abilities)
  2539. Parameters:
  2540. abilities: The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.
  2541. Event.Ability.New.Remove
  2542. Event documentation:
  2543. Signals the removal of a player ability.
  2544. Event.Ability.New.Remove(abilities)
  2545. Parameters:
  2546. abilities: Lists the abilities that were removed. Table from ability ID to "false".
  2547. Event.Ability.New.Target
  2548. Event documentation:
  2549. Signals a player ability changing its current target.
  2550. Event.Ability.New.Target(abilities)
  2551. Parameters:
  2552. abilities: The abilities whose target has changed. The key is the ability ID, the value is the new target.
  2553. Event.Ability.New.Usable.False
  2554. Event documentation:
  2555. Signals a player ability becoming unusable.
  2556. Event.Ability.New.Usable.False(abilities)
  2557. Parameters:
  2558. abilities: The abilities whose usability has changed. The key is the ability ID, the value is the new usability.
  2559. Event.Ability.New.Usable.True
  2560. Event documentation:
  2561. Signals a player ability becoming usable.
  2562. Event.Ability.New.Usable.True(abilities)
  2563. Parameters:
  2564. abilities: The abilities whose usability has changed. The key is the ability ID, the value is the new usability.
  2565. Event.Achievement.Complete
  2566. Event documentation:
  2567. Signals an achievement completing.
  2568. Event.Achievement.Complete(achievement)
  2569. Parameters:
  2570. achievement: The ID of the achievement.
  2571. Event.Achievement.Update
  2572. Event documentation:
  2573. Signals a change in an achievement's information.
  2574. Event.Achievement.Update(achievements)
  2575. Parameters:
  2576. achievements: A table of the achievements, in {id = true} format.
  2577. Event.Addon.Load.Begin
  2578. Event documentation:
  2579. Signals the beginning of an addon's loading sequence.
  2580. Event.Addon.Load.Begin(addonidentifier)
  2581. Parameters:
  2582. addonidentifier: The addon's identifier.
  2583. Event.Addon.Load.End
  2584. Event documentation:
  2585. Signals the end of an addon's loading sequence. At this point, that addon is fully loaded and initialized.
  2586. Event.Addon.Load.End(addonidentifier)
  2587. Parameters:
  2588. addonidentifier: The addon's identifier.
  2589. Event.Addon.SavedVariables.Load.Begin
  2590. Event documentation:
  2591. Signals the beginning of an addon's saved variable loading.
  2592. Event.Addon.SavedVariables.Load.Begin(addonidentifier)
  2593. Parameters:
  2594. addonidentifier: The addon's identifier.
  2595. Event.Addon.SavedVariables.Load.End
  2596. Event documentation:
  2597. Signals the end of an addon's saved variable load.
  2598. Event.Addon.SavedVariables.Load.End(addonidentifier)
  2599. Parameters:
  2600. addonidentifier: The addon's identifier.
  2601. Event.Addon.SavedVariables.Save.Begin
  2602. Event documentation:
  2603. Signals the beginning of an addon's saved variable saving.
  2604. Event.Addon.SavedVariables.Save.Begin(addonidentifier)
  2605. Parameters:
  2606. addonidentifier: The addon's identifier.
  2607. Event.Addon.SavedVariables.Save.End
  2608. Event documentation:
  2609. Signals the end of an addon's saved variable saving.
  2610. Event.Addon.SavedVariables.Save.End(addonidentifier)
  2611. Parameters:
  2612. addonidentifier: The addon's identifier.
  2613. Event.Addon.Shutdown.Begin
  2614. Event documentation:
  2615. Signals the beginning of the shutdown sequence.
  2616. Event.Addon.Shutdown.Begin()
  2617. Event.Addon.Shutdown.End
  2618. Event documentation:
  2619. Signals the end of the shutdown sequence. This is the last event that will be sent.
  2620. Event.Addon.Shutdown.End()
  2621. Event.Addon.Startup.End
  2622. Event documentation:
  2623. Signals the end of the startup sequence. At this point, all addons are fully loaded and initialized.
  2624. Event.Addon.Startup.End()
  2625. Event.Attunement.Progress.Accumulated
  2626. Event documentation:
  2627. Signals your accumulated attunement experience changing.
  2628. Event.Attunement.Progress.Accumulated(accumulated)
  2629. Parameters:
  2630. accumulated: Total quantity of accumulated attunement experience in this level.
  2631. Event.Attunement.Progress.Available
  2632. Event documentation:
  2633. Signals your available attunement points changing.
  2634. Event.Attunement.Progress.Available(available)
  2635. Parameters:
  2636. available: Number of unused attunement ranks.
  2637. Event.Attunement.Progress.Rested
  2638. Event documentation:
  2639. Signals your available attunement rested experience changing.
  2640. Event.Attunement.Progress.Rested(rested)
  2641. Parameters:
  2642. rested: Quantity of available attunement rested experience.
  2643. Event.Attunement.Progress.Spent
  2644. Event documentation:
  2645. Signals your spent attunement points changing.
  2646. Event.Attunement.Progress.Spent(spent)
  2647. Parameters:
  2648. spent: Number of spent attunement ranks.
  2649. Event.Auction.Scan
  2650. Event documentation:
  2651. Signals incoming auction data.
  2652. Event.Auction.Scan(type, auctions)
  2653. Parameters:
  2654. type: A table containing information on this scan. In the same format as the parameter to Command.Auction.Scan().
  2655. auctions: A table of the auctions returned from this scan.
  2656. Event.Auction.Statistics
  2657. Event documentation:
  2658. Signals receipt of auction statistics.
  2659. Event.Auction.Statistics(itemtype, data)
  2660. Parameters:
  2661. itemtype: Item type that the attached statistics refer to.
  2662. data: Table containing a series of tables with different timestamps, each containing data for a single day.
  2663. Parameter members:
  2664. priceAverage: Average item price during this day.
  2665. priceMax: Maximum item price during this day.
  2666. priceMin: Minimum item price during this day.
  2667. priceVariance: Variance in item price during this day.
  2668. time: UNIX timestamp of the day.
  2669. volume: Quantity of items traded during this day.
  2670. Event.Buff.Add
  2671. Event documentation:
  2672. Signals new buffs on a unit.
  2673. Event.Buff.Add(unit, buffs)
  2674. Parameters:
  2675. unit: The Unit ID of the unit involved.
  2676. buffs: A table containing the buffs involved. The key is the buff ID, the value is the buff type ID or 'true' if the buff has no type.
  2677. Event.Buff.Change
  2678. Event documentation:
  2679. Signals a change in existing buffs on a unit.
  2680. Event.Buff.Change(unit, buffs)
  2681. Parameters:
  2682. unit: The Unit ID of the unit involved.
  2683. buffs: A table containing the buffs involved.
  2684. Event.Buff.Description
  2685. Event documentation:
  2686. Signals a change in an existing buff's detailed description. Value of the key is "true" if detail is now available, "false" if it is no longer available.
  2687. Event.Buff.Description(unit, buffs)
  2688. Parameters:
  2689. unit: The Unit ID of the unit involved.
  2690. buffs: A table containing the buffs involved.
  2691. Event.Buff.Remove
  2692. Event documentation:
  2693. Signals removal of buffs from a unit.
  2694. Event.Buff.Remove(unit, buffs)
  2695. Parameters:
  2696. unit: The Unit ID of the unit involved.
  2697. buffs: A table containing the buffs involved.
  2698. Event.Chat.Notify
  2699. Event documentation:
  2700. Signals a screen notification. This is generally used as a warning mechanism during boss fights.
  2701. Event.Chat.Notify(info)
  2702. Parameters:
  2703. info: Detailed information table about this event, containing several named parameters.
  2704. Parameter members:
  2705. message: The text said.
  2706. Event.Chat.Npc
  2707. Event documentation:
  2708. Signals an NPC speaking a line of text.
  2709. Event.Chat.Npc(info)
  2710. Parameters:
  2711. info: Detailed information table about this event, containing several named parameters.
  2712. Parameter members:
  2713. from: The unit ID of the speaker, if available.
  2714. fromName: The name of the speaker.
  2715. message: The text said.
  2716. Event.Combat.Damage
  2717. Event documentation:
  2718. Signals damage done to a unit. All units referenced by this event will be accessible within this event's handlers.
  2719. Event.Combat.Damage(info)
  2720. Parameters:
  2721. info: Detailed information table about this event, containing several named parameters.
  2722. Parameter members:
  2723. ability: The ability ID for the ability used, if available.
  2724. abilityName: The name of the ability used.
  2725. caster: The unit ID for this event's initiator, if one exists.
  2726. casterName: The name of this event's initiator, if available.
  2727. crit: Whether this was the result of a critical hit.
  2728. damage: The amount of damage actually done.
  2729. damageAbsorbed: The amount of damage absorbed.
  2730. damageBlocked: The amount of damage blocked.
  2731. damageDeflected: The amount of damage deflected.
  2732. damageIntercepted: The amount of damage intercepted.
  2733. damageModified: The amount of damage modified.
  2734. overkill: The amount of overkill done.
  2735. target: The unit ID for the target.
  2736. targetName: The name of the target, if available.
  2737. type: The damage type. Values include "life", "death", "air", "earth", "fire", "water".
  2738. Event.Combat.Death
  2739. Event documentation:
  2740. Signals the death of a unit. All units referenced by this event will be accessible within this event's handlers.
  2741. Event.Combat.Death(info)
  2742. Parameters:
  2743. info: Detailed information table about this event, containing several named parameters.
  2744. Parameter members:
  2745. caster: The unit ID for this event's initiator, if one exists.
  2746. casterName: The name of this event's initiator, if available.
  2747. target: The unit ID for the target.
  2748. targetName: The name of the target, if available.
  2749. Event.Combat.Dodge
  2750. Event documentation:
  2751. Signals a unit dodging an ability. All units referenced by this event will be accessible within this event's handlers.
  2752. Event.Combat.Dodge(info)
  2753. Parameters:
  2754. info: Detailed information table about this event, containing several named parameters.
  2755. Parameter members:
  2756. ability: The ability ID for the ability used, if available.
  2757. abilityName: The name of the ability used.
  2758. caster: The unit ID for this event's initiator, if one exists.
  2759. casterName: The name of this event's initiator, if available.
  2760. target: The unit ID for the target.
  2761. targetName: The name of the target, if available.
  2762. Event.Combat.Heal
  2763. Event documentation:
  2764. Signals healing done to a unit. All units referenced by this event will be accessible within this event's handlers.
  2765. Event.Combat.Heal(info)
  2766. Parameters:
  2767. info: Detailed information table about this event, containing several named parameters.
  2768. Parameter members:
  2769. ability: The ability ID for the ability used, if available.
  2770. abilityName: The name of the ability used.
  2771. caster: The unit ID for this event's initiator, if one exists.
  2772. casterName: The name of this event's initiator, if available.
  2773. crit: Whether this was the result of a critical hit.
  2774. heal: The amount healed.
  2775. overheal: The amount of healing past maximum health wasted.
  2776. target: The unit ID for the target.
  2777. targetName: The name of the target, if available.
  2778. Event.Combat.Immune
  2779. Event documentation:
  2780. Signals a unit resisting an ability through immunity. All units referenced by this event will be accessible within this event's handlers.
  2781. Event.Combat.Immune(info)
  2782. Parameters:
  2783. info: Detailed information table about this event, containing several named parameters.
  2784. Parameter members:
  2785. ability: The ability ID for the ability used, if available.
  2786. abilityName: The name of the ability used.
  2787. caster: The unit ID for this event's initiator, if one exists.
  2788. casterName: The name of this event's initiator, if available.
  2789. target: The unit ID for the target.
  2790. targetName: The name of the target, if available.
  2791. Event.Combat.Miss
  2792. Event documentation:
  2793. Signals an ability's effect missing a unit. All units referenced by this event will be accessible within this event's handlers.
  2794. Event.Combat.Miss(info)
  2795. Parameters:
  2796. info: Detailed information table about this event, containing several named parameters.
  2797. Parameter members:
  2798. ability: The ability ID for the ability used, if available.
  2799. abilityName: The name of the ability used.
  2800. caster: The unit ID for this event's initiator, if one exists.
  2801. casterName: The name of this event's initiator, if available.
  2802. target: The unit ID for the target.
  2803. targetName: The name of the target, if available.
  2804. Event.Combat.Parry
  2805. Event documentation:
  2806. Signals a unit parrying an ability. All units referenced by this event will be accessible within this event's handlers.
  2807. Event.Combat.Parry(info)
  2808. Parameters:
  2809. info: Detailed information table about this event, containing several named parameters.
  2810. Parameter members:
  2811. ability: The ability ID for the ability used, if available.
  2812. abilityName: The name of the ability used.
  2813. caster: The unit ID for this event's initiator, if one exists.
  2814. casterName: The name of this event's initiator, if available.
  2815. target: The unit ID for the target.
  2816. targetName: The name of the target, if available.
  2817. Event.Combat.Resist
  2818. Event documentation:
  2819. Signals a unit resisting an ability. All units referenced by this event will be accessible within this event's handlers.
  2820. Event.Combat.Resist(info)
  2821. Parameters:
  2822. info: Detailed information table about this event, containing several named parameters.
  2823. Parameter members:
  2824. ability: The ability ID for the ability used, if available.
  2825. abilityName: The name of the ability used.
  2826. caster: The unit ID for this event's initiator, if one exists.
  2827. casterName: The name of this event's initiator, if available.
  2828. target: The unit ID for the target.
  2829. targetName: The name of the target, if available.
  2830. Event.Currency
  2831. Event documentation:
  2832. Signals a change in the player's available currency.
  2833. Event.Currency(currencies)
  2834. Parameters:
  2835. currencies: New currency counts, in key/value form.
  2836. Event.Cursor
  2837. Event documentation:
  2838. Signals that the cursor has changed.
  2839. Event.Cursor(type, held)
  2840. Parameters:
  2841. type: The current cursor type. Valid values include "ability", "item", and "itemtype".
  2842. held: The blob describing the new element held. Generally, some kind of identifier used in another part of the addon system.
  2843. Event.Dimension.Layout.Add
  2844. Event documentation:
  2845. Signals that a dimension item has been added.
  2846. Event.Dimension.Layout.Add(addedItem)
  2847. Parameters:
  2848. addedItem: The dimension item that has been added.
  2849. Event.Dimension.Layout.Remove
  2850. Event documentation:
  2851. Signals that a dimension item has been removed.
  2852. Event.Dimension.Layout.Remove(removedItem)
  2853. Parameters:
  2854. removedItem: The dimension item that has been removed.
  2855. Event.Dimension.Layout.Update
  2856. Event documentation:
  2857. Signals that a dimension item has been updated.
  2858. Event.Dimension.Layout.Update(updatedItem)
  2859. Parameters:
  2860. updatedItem: The dimension item that has been updated.
  2861. Event.Experience.Accumulated
  2862. Event documentation:
  2863. Signals your accumulated experience changing.
  2864. Event.Experience.Accumulated(accumulated)
  2865. Parameters:
  2866. accumulated: Total quantity of accumulated experience in this level.
  2867. Event.Experience.Rested
  2868. Event documentation:
  2869. Signals your available rested experience changing.
  2870. Event.Experience.Rested(rested)
  2871. Parameters:
  2872. rested: Quantity of available rested experience.
  2873. Event.Faction.Notoriety
  2874. Event documentation:
  2875. Signals a change in the player's faction notoriety.
  2876. Event.Faction.Notoriety(notoriety)
  2877. Parameters:
  2878. notoriety: New notoriety values, in key/value form.
  2879. Event.Guild.Bank.Change
  2880. Event documentation:
  2881. Signals a change in a guild bank vault's information.
  2882. Event.Guild.Bank.Change(vaults)
  2883. Parameters:
  2884. vaults: A lookup table of vaults that have changed.
  2885. Event.Guild.Bank.Coin
  2886. Event documentation:
  2887. Signals a change in the guild bank's money.
  2888. Event.Guild.Bank.Coin(coin)
  2889. Parameters:
  2890. coin: The new amount of money in the guild bank.
  2891. Event.Guild.Log
  2892. Event documentation:
  2893. Signals incoming guild log data. Can be triggered manually with Command.Guild.Log.Request().
  2894. Event.Guild.Log(log)
  2895. Parameters:
  2896. log: An array containing the refreshed guild log items, in order.
  2897. Parameter members:
  2898. achievement: The achievement involved.
  2899. coin: The amount of silver involved.
  2900. count: The number of items involved.
  2901. item: The item type involved.
  2902. level: The level involved.
  2903. rank: The rank involved.
  2904. source: The source of the log event.
  2905. target: The target of the log event.
  2906. type: The type of the log message. May be any of achievement, bankCoinDeposit, bankCoinHeal, bankCoinTithe, bankCoinWithdraw, bankItemDeposit, bankItemWithdraw, bankVault, charterSign, charterUnsign, demote, demoteTrial, dimensionBuy, finder, firstAchievement, firstCollection, firstItem, firstKill, firstQuest, form, found, invite, kick, leave, level, motd, promote, rankEdit, rename, transferred, unlearnActive, unlearnPassive, wallDelete, wallModify, xp, or xpQuest.
  2907. xp: The amount of XP involved.
  2908. Event.Guild.Motd
  2909. Event documentation:
  2910. Signals a change in the guild Message of the Day.
  2911. Event.Guild.Motd(motd)
  2912. Parameters:
  2913. motd: The new Message of the Day.
  2914. Event.Guild.Rank
  2915. Event documentation:
  2916. Signals a change in one of your guild's ranks.
  2917. Event.Guild.Rank(ranks)
  2918. Parameters:
  2919. ranks: A lookup table of ranks that have changed.
  2920. Event.Guild.Roster.Add
  2921. Event documentation:
  2922. Signals a new player added to the guild roster.
  2923. Event.Guild.Roster.Add(add)
  2924. Parameters:
  2925. add: The name of the added guildmember.
  2926. Event.Guild.Roster.Detail.Level
  2927. Event documentation:
  2928. Signals a change in a guildmember's level.
  2929. Event.Guild.Roster.Detail.Level(units)
  2930. Parameters:
  2931. units: Table of the units changed. Key is the unit ID, value is the new value.
  2932. Event.Guild.Roster.Detail.Note
  2933. Event documentation:
  2934. Signals a change in a guildmember's note.
  2935. Event.Guild.Roster.Detail.Note(units)
  2936. Parameters:
  2937. units: Table of the units changed. Key is the unit ID, value is the new value.
  2938. Event.Guild.Roster.Detail.NoteOfficer
  2939. Event documentation:
  2940. Signals a change in a guildmember's officer note.
  2941. Event.Guild.Roster.Detail.NoteOfficer(units)
  2942. Parameters:
  2943. units: Table of the units changed. Key is the unit ID, value is the new value.
  2944. Event.Guild.Roster.Detail.Rank
  2945. Event documentation:
  2946. Signals a change in a guildmember's rank.
  2947. Event.Guild.Roster.Detail.Rank(units)
  2948. Parameters:
  2949. units: Table of the units changed. Key is the unit ID, value is the new value.
  2950. Event.Guild.Roster.Detail.Status
  2951. Event documentation:
  2952. Signals a change in a guildmember's status.
  2953. Event.Guild.Roster.Detail.Status(units)
  2954. Parameters:
  2955. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  2956. Event.Guild.Roster.Detail.Zone
  2957. Event documentation:
  2958. Signals a change in a guildmember's zone.
  2959. Event.Guild.Roster.Detail.Zone(units)
  2960. Parameters:
  2961. units: Table of the units changed. Key is the unit ID, value is the new value.
  2962. Event.Guild.Roster.Remove
  2963. Event documentation:
  2964. Signals a player removed from the guild roster.
  2965. Event.Guild.Roster.Remove(remove)
  2966. Parameters:
  2967. remove: The name of the removed guildmember.
  2968. Event.Guild.Wall
  2969. Event documentation:
  2970. Signals incoming guild wall data. Can be triggered manually with Command.Guild.Wall.Request().
  2971. Event.Guild.Wall(wall)
  2972. Parameters:
  2973. wall: An array containing the refreshed guild wall items, in order.
  2974. Parameter members:
  2975. id: The ID of the guild wall entry.
  2976. poster: The poster of the guild wall entry.
  2977. text: The text of the guild wall entry.
  2978. time: The time the wall entry was posted, in UNIX time.
  2979. Event.Interaction
  2980. Event documentation:
  2981. Signals a change in available interaction types.
  2982. Event.Interaction(interaction, state)
  2983. Parameters:
  2984. interaction: The identifier of the interaction type. May be any of "auction", "bank", "guildbank", or "mail".
  2985. state: Boolean indicating whether or not that interaction is available.
  2986. Event.Item.Slot
  2987. Event documentation:
  2988. Signals that the contents of an item slot have changed.
  2989. Event.Item.Slot(updates)
  2990. Parameters:
  2991. updates: Table of changes. Key is the slot identifier, value is an item ID, false if the slot is now empty, or the string "nil" if the slot no longer exists.
  2992. Event.Item.Update
  2993. Event documentation:
  2994. Signals that an item has changed.
  2995. Event.Item.Update(updates)
  2996. Parameters:
  2997. updates: Table of changes. Key is the slot identifier, value is an item ID, false if the slot is now empty, or the string "nil" if the slot no longer exists.
  2998. Event.Mail
  2999. Event documentation:
  3000. Signals a change in the available mail messages.
  3001. Event.Mail(mail)
  3002. Parameters:
  3003. mail: The changed mail messages. Takes the form of a table. The key is the mail ID, the value is "basic" to indicate basic information available about a piece of mail, "detail" to indicate detailed information available, or false to indicate no information available.
  3004. Event.Map.Add
  3005. Event documentation:
  3006. Signals the addition of a map element.
  3007. Event.Map.Add(elements)
  3008. Parameters:
  3009. elements: The changed elements. Takes the form of a table. The key is the element ID.
  3010. Event.Map.Change
  3011. Event documentation:
  3012. Signals the change of a map element, in some manner besides coordinates.
  3013. Event.Map.Change(elements)
  3014. Parameters:
  3015. elements: The changed elements. Takes the form of a table. The key is the element ID.
  3016. Event.Map.Detail.Coord
  3017. Event documentation:
  3018. Signals the coordinate change of a map element.
  3019. Event.Map.Detail.Coord(x, y, z)
  3020. Parameters:
  3021. x: The new X coordinate of the changed elements. Takes the form of a table. The key is the element ID.
  3022. y: The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID.
  3023. z: The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID.
  3024. Event.Map.Remove
  3025. Event documentation:
  3026. Signals the removal of a map element.
  3027. Event.Map.Remove(elements)
  3028. Parameters:
  3029. elements: The changed elements. Takes the form of a table. The key is the element ID.
  3030. Event.Map.Waypoint.Update
  3031. Event documentation:
  3032. Signals the change of a player's waypoint.
  3033. Event.Map.Waypoint.Update(units)
  3034. Parameters:
  3035. units: The unit whose waypoint has changed. Takes the form of a table. The key is the element ID.
  3036. Event.Message.Receive
  3037. Event documentation:
  3038. Signals the receipt of an addon message.
  3039. Event.Message.Receive(from, type, channel, identifier, data)
  3040. Parameters:
  3041. from: The name of the player this message is from.
  3042. type: The type of this message. May be any of "send", "tell", "channel", "guild", "officer", "party", "raid", "say", or "yell".
  3043. channel: If type is "channel", the channel that this message was sent to. Otherwise, nil.
  3044. identifier: The identifier for this message.
  3045. data: The data payload for this message type.
  3046. Event.Mouse.Move
  3047. Event documentation:
  3048. Signals the mouse moving.
  3049. Event.Mouse.Move(x, y)
  3050. Parameters:
  3051. x: The mouse's new X position.
  3052. y: The mouse's new Y position.
  3053. Event.Pvp.History.Favor
  3054. Event documentation:
  3055. Signals your historical favor changing.
  3056. Event.Pvp.History.Favor(favor)
  3057. Parameters:
  3058. favor: Amount of lifetime favor accumulated.
  3059. Event.Pvp.History.Kill.Today
  3060. Event documentation:
  3061. Signals your daily kill count changing.
  3062. Event.Pvp.History.Kill.Today(kill)
  3063. Parameters:
  3064. kill: Amount of kills made in this time period.
  3065. Event.Pvp.Prestige.Accumulated
  3066. Event documentation:
  3067. Signals your accumulated prestige changing.
  3068. Event.Pvp.Prestige.Accumulated(accumulated)
  3069. Parameters:
  3070. accumulated: Total quantity of accumulated prestige in this rank.
  3071. Event.Pvp.Prestige.Rank
  3072. Event documentation:
  3073. Signals your prestige rank changing.
  3074. Event.Pvp.Prestige.Rank(rank)
  3075. Parameters:
  3076. rank: Current prestige rank.
  3077. Event.Quest.Abandon
  3078. Event documentation:
  3079. Signals that a quest has been abandoned.
  3080. Event.Quest.Abandon(elements)
  3081. Parameters:
  3082. elements: The changed elements. Takes the form of a table. The key is the element ID.
  3083. Event.Quest.Accept
  3084. Event documentation:
  3085. Signals that a quest has been accepted.
  3086. Event.Quest.Accept(elements)
  3087. Parameters:
  3088. elements: The changed elements. Takes the form of a table. The key is the element ID.
  3089. Event.Quest.Change
  3090. Event documentation:
  3091. Signals that a quest has been changed in some manner, most likely progress in an objective.
  3092. Event.Quest.Change(elements)
  3093. Parameters:
  3094. elements: The changed elements. Takes the form of a table. The key is the element ID.
  3095. Event.Quest.Complete
  3096. Event documentation:
  3097. Signals that a quest has been completed.
  3098. Event.Quest.Complete(elements)
  3099. Parameters:
  3100. elements: The changed elements. Takes the form of a table. The key is the element ID.
  3101. Event.Queue.Status
  3102. Event documentation:
  3103. Signals that a queue may have left or entered the throttled state.
  3104. Event.Queue.Status(id)
  3105. Parameters:
  3106. id: The ID of the queue affected. To get the actual new state, use Inspect.Queue.Status().
  3107. Event.Slash (category for dynamically-created events)
  3108. Event.Slash.addonerror
  3109. Frame event documentation:
  3110. Addon-created event. No documentation available.
  3111. Event.Slash.addonerror(handle, ...)
  3112. Event.Slash.dump
  3113. Frame event documentation:
  3114. Addon-created event. No documentation available.
  3115. Event.Slash.dump(handle, ...)
  3116. Event.Slash.eventlog
  3117. Frame event documentation:
  3118. Addon-created event. No documentation available.
  3119. Event.Slash.eventlog(handle, ...)
  3120. Event.Slash.framecap
  3121. Frame event documentation:
  3122. Addon-created event. No documentation available.
  3123. Event.Slash.framecap(handle, ...)
  3124. Event.Slash.layout
  3125. Frame event documentation:
  3126. Addon-created event. No documentation available.
  3127. Event.Slash.layout(handle, ...)
  3128. Event.Social.Friend
  3129. Event documentation:
  3130. Signals a change in your friend list.
  3131. Event.Social.Friend(friends)
  3132. Parameters:
  3133. friends: A lookup table containing the changed friends.
  3134. Event.Social.Ignore
  3135. Event documentation:
  3136. Signals a change in your ignore list.
  3137. Event.Social.Ignore(ignores)
  3138. Parameters:
  3139. ignores: A lookup table containing the changed ignored players.
  3140. Event.Stat
  3141. Event documentation:
  3142. Signals a change in the player's stats.
  3143. Event.Stat(stats)
  3144. Parameters:
  3145. stats: A table from stat ID to stat value, containing the stats that changed.
  3146. Event.Storage.Get
  3147. Event documentation:
  3148. Signals receiving storage data from a target.
  3149. Event.Storage.Get(target, segment, identifier, read, write, data)
  3150. Parameters:
  3151. target: The name of the player that has been inspected.
  3152. segment: The segment that has been inspected, either "player" or "guild".
  3153. identifier: The identifier that was inspected.
  3154. read: The read permissions of this element. See Command.Storage.Set() for details.
  3155. write: The write permissions of this element. See Command.Storage.Set() for details.
  3156. data: The data contained in the requested element.
  3157. Event.Storage.List
  3158. Event documentation:
  3159. Signals receiving a list of storage elements from a target.
  3160. Event.Storage.List(target, segment, identifiers)
  3161. Parameters:
  3162. target: The name of the player that has been inspected.
  3163. segment: The segment that has been inspected, either "player" or "guild".
  3164. identifiers: A list of identifiers available to you, in {identifier = checksum} format.
  3165. Event.System.Error
  3166. Event documentation:
  3167. 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.
  3168. Event.System.Error(error)
  3169. Parameters:
  3170. error: Table containing error data.
  3171. Parameter members:
  3172. addon: The identifier of the responsible addon. Used in error types event, frameEvent, dispatch, fileNotFound, fileLoad, fileRun, perfWarning, perfError, text, and requirement.
  3173. axis: The axis influenced by the error. Used in error types layoutLoop and layoutError.
  3174. deprecation: Indicates that the error was caused by attempted use of deprecated functionality. May appear in error types event, frameEvent, script, dispatch, queue, callback, or fileRun.
  3175. error: The actual error message generated. Used in error types event, frameEvent, script, dispatch, fileLoad, fileRun, and text.
  3176. event: The name of the event responsible. Used in error types event, frameEvent, and internal.
  3177. file: The name of the file responsible. Used in error types fileNotFound, fileLoad, and fileRun.
  3178. frame: The name of the frame that the event was generated on. Used in error type frameEvent.
  3179. id: The internal ID of this error.
  3180. info: The info string provided as part of the event handler. Used in error types event, dispatch, perfWarning, perfError, and requirement.
  3181. script: The exact script entered by the user. Used in error type script.
  3182. stacktrace: The stacktrace at the point of the error. Used in error types event, frameEvent, script, dispatch, fileRun, layoutLoop, layoutError, perfWarning, perfError, text, and requirement.
  3183. 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. "perfWarning" indicates a watchdog performance warning. "perfError" indicates a watchdog performance error, and that the Lua thread may have been interrupted. "text" indicates an error in Lua code embedded in HTML text. "requirement" indicates an error caused by not fulfilling function requirements.
  3184. Event.System.Secure.Enter
  3185. Event documentation:
  3186. 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.
  3187. Event.System.Secure.Enter()
  3188. Event.System.Secure.Leave
  3189. Event documentation:
  3190. 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.
  3191. Event.System.Secure.Leave()
  3192. Event.System.Texture
  3193. Event documentation:
  3194. Signals information on Rift UI textures that have been seen.
  3195. Event.System.Texture(textures)
  3196. Parameters:
  3197. textures: A lookup table of all textures that has been seen since the last event.
  3198. Event.System.Update.Begin
  3199. Event documentation:
  3200. Signals the beginning of a frame render. This is your last chance to make UI changes for this frame.
  3201. Event.System.Update.Begin()
  3202. Event.System.Update.End
  3203. Event documentation:
  3204. Signals the end of a frame render.
  3205. Event.System.Update.End()
  3206. Event.TEMPORARY.Experience
  3207. Event documentation:
  3208. Signals a change in the player's experience.
  3209. This event is deprecated and will be removed in the future. It should not be used.
  3210. Event.TEMPORARY.Experience(accumulated, rested, needed)
  3211. Parameters:
  3212. accumulated: The amount of experience that has accumulated towards the next level.
  3213. rested: The amount of rested experience that has accumulated.
  3214. needed: The amount of experience required to reach the next level.
  3215. Event.TEMPORARY.Role
  3216. Event documentation:
  3217. Signals a change in the player's current role.
  3218. This event will be removed in the future.
  3219. Event.TEMPORARY.Role(role)
  3220. Parameters:
  3221. role: The ID of the new role.
  3222. Event.Title.Add
  3223. Event documentation:
  3224. Signals the addition of a new title.
  3225. Event.Title.Add(titles)
  3226. Parameters:
  3227. titles: A lookup table of newly available titles.
  3228. Event.Tooltip
  3229. Event documentation:
  3230. Signals that the tooltip has changed.
  3231. Event.Tooltip(type, shown, buff)
  3232. Parameters:
  3233. type: The current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".
  3234. shown: The blob describing the new element shown. Generally, some kind of identifier used in another part of the addon system.
  3235. buff: The ID of the tooltip's new buff. "shown" will be a unit in this case.
  3236. Event.Unit.Add
  3237. Event documentation:
  3238. 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.
  3239. Event.Unit.Add(units)
  3240. Parameters:
  3241. 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.
  3242. Event.Unit.Availability.Full
  3243. Event documentation:
  3244. Signals units entering Full availability.
  3245. Event.Unit.Availability.Full(units)
  3246. Parameters:
  3247. 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.
  3248. Event.Unit.Availability.None
  3249. Event documentation:
  3250. Signals units leaving availability entirely.
  3251. Event.Unit.Availability.None(units)
  3252. Parameters:
  3253. 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.
  3254. Event.Unit.Availability.Partial
  3255. Event documentation:
  3256. Signals units entering Partial availability, possibly on the way to Full or None availability.
  3257. Event.Unit.Availability.Partial(units)
  3258. Parameters:
  3259. 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.
  3260. Event.Unit.Castbar
  3261. Event documentation:
  3262. Signals a unit's castbar changing.
  3263. Event.Unit.Castbar(units)
  3264. Parameters:
  3265. units: Table of the units changed. Key is the unit ID, value is a castbar visibility flag.
  3266. Event.Unit.Detail.Absorb
  3267. Event documentation:
  3268. Signals a unit's damage absorption changing.
  3269. Event.Unit.Detail.Absorb(units)
  3270. Parameters:
  3271. units: Table of the units changed. Key is the unit ID, value is the new value.
  3272. Event.Unit.Detail.Afk
  3273. Event documentation:
  3274. Signals a unit's AFK flag changing. Will trigger only for partymembers.
  3275. Event.Unit.Detail.Afk(units)
  3276. Parameters:
  3277. units: Table of the units changed. Key is the unit ID, value is the new value.
  3278. Event.Unit.Detail.Aggro
  3279. Event documentation:
  3280. Signals a unit's aggro flag changing. Will trigger only for groupmembers.
  3281. Event.Unit.Detail.Aggro(units)
  3282. Parameters:
  3283. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3284. Event.Unit.Detail.Blocked
  3285. Event documentation:
  3286. Signals a unit's LOS-blocked flag changing. Will trigger only for groupmembers.
  3287. Event.Unit.Detail.Blocked(units)
  3288. Parameters:
  3289. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3290. Event.Unit.Detail.Charge
  3291. Event documentation:
  3292. Signals a unit's charge changing. Will trigger only for the player's unit ID.
  3293. Event.Unit.Detail.Charge(units)
  3294. Parameters:
  3295. units: Table of the units changed. Key is the unit ID, value is the new value.
  3296. Event.Unit.Detail.ChargeMax
  3297. Event documentation:
  3298. Signals a unit's charge maximum changing. Will trigger only for the player's unit ID.
  3299. Event.Unit.Detail.ChargeMax(units)
  3300. Parameters:
  3301. units: Table of the units changed. Key is the unit ID, value is the new value.
  3302. Event.Unit.Detail.Combat
  3303. Event documentation:
  3304. Signals a unit's combat status changing.
  3305. Event.Unit.Detail.Combat(units)
  3306. Parameters:
  3307. units: Table of the units changed. Key is the unit ID, value is the new value.
  3308. Event.Unit.Detail.Combo
  3309. Event documentation:
  3310. Signals a unit's combo points changing. Will trigger only for the player's unit ID.
  3311. Event.Unit.Detail.Combo(units)
  3312. Parameters:
  3313. units: Table of the units changed. Key is the unit ID, value is the new value.
  3314. Event.Unit.Detail.Coord
  3315. Event documentation:
  3316. Signals a change in the unit's location.
  3317. Event.Unit.Detail.Coord(x, y, z)
  3318. Parameters:
  3319. x: The new X coordinate of the changed elements. Takes the form of a table. The key is the element ID.
  3320. y: The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID.
  3321. z: The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID.
  3322. Event.Unit.Detail.Energy
  3323. Event documentation:
  3324. Signals a unit's energy changing.
  3325. Event.Unit.Detail.Energy(units)
  3326. Parameters:
  3327. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3328. Event.Unit.Detail.EnergyMax
  3329. Event documentation:
  3330. Signals a unit's energy maximum changing.
  3331. Event.Unit.Detail.EnergyMax(units)
  3332. Parameters:
  3333. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3334. Event.Unit.Detail.Guild
  3335. Event documentation:
  3336. Signals a unit's guild changing.
  3337. Event.Unit.Detail.Guild(units)
  3338. Parameters:
  3339. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3340. Event.Unit.Detail.Health
  3341. Event documentation:
  3342. Signals a unit's health changing.
  3343. Event.Unit.Detail.Health(units)
  3344. Parameters:
  3345. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3346. Event.Unit.Detail.HealthCap
  3347. Event documentation:
  3348. Signals a unit's health cap changing.
  3349. Event.Unit.Detail.HealthCap(units)
  3350. Parameters:
  3351. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3352. Event.Unit.Detail.HealthMax
  3353. Event documentation:
  3354. Signals a unit's health maximum changing.
  3355. Event.Unit.Detail.HealthMax(units)
  3356. Parameters:
  3357. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3358. Event.Unit.Detail.Level
  3359. Event documentation:
  3360. Signals a unit's level changing.
  3361. Event.Unit.Detail.Level(units)
  3362. Parameters:
  3363. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3364. Event.Unit.Detail.LocationName
  3365. Event documentation:
  3366. Signals a unit's location name changing.
  3367. Event.Unit.Detail.LocationName(units)
  3368. Parameters:
  3369. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3370. Event.Unit.Detail.Mana
  3371. Event documentation:
  3372. Signals a unit's mana changing.
  3373. Event.Unit.Detail.Mana(units)
  3374. Parameters:
  3375. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3376. Event.Unit.Detail.ManaMax
  3377. Event documentation:
  3378. Signals a unit's mana maximum changing.
  3379. Event.Unit.Detail.ManaMax(units)
  3380. Parameters:
  3381. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3382. Event.Unit.Detail.Mark
  3383. Event documentation:
  3384. Signals a unit's mark changing.
  3385. Event.Unit.Detail.Mark(units)
  3386. Parameters:
  3387. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3388. Event.Unit.Detail.Mentoring
  3389. Event documentation:
  3390. Signals a unit's mentoring status changing.
  3391. Event.Unit.Detail.Mentoring(units)
  3392. Parameters:
  3393. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3394. Event.Unit.Detail.Name
  3395. Event documentation:
  3396. Signals a unit's name changing.
  3397. Event.Unit.Detail.Name(units)
  3398. Parameters:
  3399. units: Table of the units changed. Key is the unit ID, value is the new value.
  3400. Event.Unit.Detail.Offline
  3401. Event documentation:
  3402. Signals a unit's offline flag changing. Will trigger only for partymembers.
  3403. Event.Unit.Detail.Offline(units)
  3404. Parameters:
  3405. units: Table of the units changed. Key is the unit ID, value is the new value.
  3406. Event.Unit.Detail.Planar
  3407. Event documentation:
  3408. Signals a unit's planar charges changing. Will trigger only for the player or groupmembers.
  3409. Event.Unit.Detail.Planar(units)
  3410. Parameters:
  3411. units: Table of the units changed. Key is the unit ID, value is the new value.
  3412. Event.Unit.Detail.PlanarMax
  3413. Event documentation:
  3414. Signals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers.
  3415. Event.Unit.Detail.PlanarMax(units)
  3416. Parameters:
  3417. units: Table of the units changed. Key is the unit ID, value is the new value.
  3418. Event.Unit.Detail.Power
  3419. Event documentation:
  3420. Signals a unit's power changing.
  3421. Event.Unit.Detail.Power(units)
  3422. Parameters:
  3423. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3424. Event.Unit.Detail.PublicSize
  3425. Event documentation:
  3426. Signals a unit's public group size or status changing.
  3427. Event.Unit.Detail.PublicSize(units)
  3428. Parameters:
  3429. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3430. Event.Unit.Detail.Pvp
  3431. Event documentation:
  3432. Signals a unit's PvP flag changing.
  3433. Event.Unit.Detail.Pvp(units)
  3434. Parameters:
  3435. units: Table of the units changed. Key is the unit ID, value is the new value.
  3436. Event.Unit.Detail.Radius
  3437. Event documentation:
  3438. Signals a unit's radius changing.
  3439. Event.Unit.Detail.Radius(units)
  3440. Parameters:
  3441. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3442. Event.Unit.Detail.Ready
  3443. Event documentation:
  3444. Signals a unit's readycheck status changing.
  3445. Event.Unit.Detail.Ready(units)
  3446. Parameters:
  3447. units: Table of the units changed. Key is the unit ID, value is the new value, or the string "nil" in place of nil.
  3448. Event.Unit.Detail.Role
  3449. Event documentation:
  3450. Signals a unit's role changing. Will trigger only for the player or partymembers.
  3451. Event.Unit.Detail.Role(units)
  3452. Parameters:
  3453. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3454. Event.Unit.Detail.Tagged
  3455. Event documentation:
  3456. Signals a unit's tagged status changing.
  3457. Event.Unit.Detail.Tagged(units)
  3458. Parameters:
  3459. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3460. Event.Unit.Detail.TitlePrefixId
  3461. Event documentation:
  3462. Signals a unit's title prefix ID changing.
  3463. Event.Unit.Detail.TitlePrefixId(units)
  3464. Parameters:
  3465. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3466. Event.Unit.Detail.TitlePrefixName
  3467. Event documentation:
  3468. Signals a unit's localized title prefix changing.
  3469. This event is deprecated and will be removed in the future. It should not be used.
  3470. Event.Unit.Detail.TitlePrefixName(units)
  3471. Parameters:
  3472. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3473. Event.Unit.Detail.TitleSuffixId
  3474. Event documentation:
  3475. Signals a unit's title suffix ID changing.
  3476. Event.Unit.Detail.TitleSuffixId(units)
  3477. Parameters:
  3478. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3479. Event.Unit.Detail.TitleSuffixName
  3480. Event documentation:
  3481. Signals a unit's localized title suffix changing.
  3482. This event is deprecated and will be removed in the future. It should not be used.
  3483. Event.Unit.Detail.TitleSuffixName(units)
  3484. Parameters:
  3485. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3486. Event.Unit.Detail.Vitality
  3487. Event documentation:
  3488. Signals a unit's vitality changing. Will trigger only for the player or groupmembers.
  3489. Event.Unit.Detail.Vitality(units)
  3490. Parameters:
  3491. units: Table of the units changed. Key is the unit ID, value is the new value.
  3492. Event.Unit.Detail.Warfront
  3493. Event documentation:
  3494. Signals a unit's warfront flag changing. Will trigger only for partymembers.
  3495. Event.Unit.Detail.Warfront(units)
  3496. Parameters:
  3497. units: Table of the units changed. Key is the unit ID, value is the new value.
  3498. Event.Unit.Detail.Zone
  3499. Event documentation:
  3500. Signals a change in the unit's zone.
  3501. Event.Unit.Detail.Zone(units)
  3502. Parameters:
  3503. units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
  3504. Event.Unit.Remove
  3505. Event documentation:
  3506. 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.
  3507. Event.Unit.Remove(units)
  3508. Parameters:
  3509. 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.
  3510.  
  3511. UI:
  3512. Layout:
  3513. Members:
  3514. EventAttach
  3515. Function documentation:
  3516. Attaches an event handler to an event.
  3517. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3518. Layout:EventAttach(handle, callback, label) -- eventFrame, function, string
  3519. Layout:EventAttach(handle, callback, label, priority) -- eventFrame, function, string, number
  3520. Parameters:
  3521. callback: A global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
  3522. handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
  3523. label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
  3524. priority: Priority of the event handler. Higher numbers trigger first.
  3525. EventDetach
  3526. Function documentation:
  3527. Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a wildcard. If multiple events match the constraints, only one will be detached.
  3528. Layout:EventDetach(handle, callback) -- eventFrame, function/nil
  3529. Layout:EventDetach(handle, callback, label) -- eventFrame, function/nil, string/nil
  3530. Layout:EventDetach(handle, callback, label, priority) -- eventFrame, function/nil, string/nil, number/nil
  3531. Layout:EventDetach(handle, callback, label, priority, owner) -- eventFrame, function/nil, string/nil, number/nil, string/nil
  3532. Parameters:
  3533. callback: A callback function to search for.
  3534. handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
  3535. label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
  3536. owner: Owner to search for.
  3537. priority: Priority of the event handler. Higher numbers trigger first.
  3538. EventList
  3539. Function documentation:
  3540. Lists the current event handlers for an event.
  3541. result = Layout:EventList(handle) -- table <- eventFrame
  3542. Parameters:
  3543. handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
  3544. Return values:
  3545. result: A table of event handlers for this event.
  3546. Returned members:
  3547. handler: The handler that will be called when the event fires.
  3548. label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
  3549. macro: The macro that will run when the event fires.
  3550. owner: Owner to search for.
  3551. priority: Priority of the event handler. Higher numbers trigger first.
  3552. EventMacroGet
  3553. Function documentation:
  3554. Gets the macro that will be triggered when this event occurs.
  3555. macro = Layout:EventMacroGet(handle) -- string/nil <- eventFrame
  3556. Parameters:
  3557. handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
  3558. Return values:
  3559. macro: The macro that will be triggered.
  3560. EventMacroSet
  3561. Function documentation:
  3562. Sets the macro that will be triggered when this event occurs.
  3563. Permitted only on a frame with "restricted" SecureMode while the addon environment is not secured.
  3564. Layout:EventMacroSet(handle, macro) -- eventFrame, string/nil
  3565. Parameters:
  3566. handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
  3567. macro: The macro to trigger. nil to clear the macro.
  3568. GetBottom
  3569. Function documentation:
  3570. Retrieves the Y position of the bottom edge of this element.
  3571. bottom = Layout:GetBottom() -- number <- void
  3572. Return values:
  3573. bottom: The Y position of the bottom edge of this element.
  3574. GetBounds
  3575. Function documentation:
  3576. Retrieves the complete bounds of this element.
  3577. left, top, right, bottom = Layout:GetBounds() -- number, number, number, number <- void
  3578. Return values:
  3579. bottom: The Y position of the bottom edge of this element.
  3580. left: The X position of the left edge of this element.
  3581. right: The X position of the right edge of this element.
  3582. top: The Y position of the top edge of this element.
  3583. GetEventTable
  3584. Function documentation:
  3585. Retrieves the event table of this element. By default, this value is also stored in "this.Event".
  3586. eventTable = Layout:GetEventTable() -- table <- void
  3587. Return values:
  3588. eventTable: The event table of this element.
  3589. GetHeight
  3590. Function documentation:
  3591. Retrieves the height of this element.
  3592. height = Layout:GetHeight() -- number <- void
  3593. Return values:
  3594. height: The height of this element.
  3595. GetLeft
  3596. Function documentation:
  3597. Retrieves the X position of the left edge of this element.
  3598. left = Layout:GetLeft() -- number <- void
  3599. Return values:
  3600. left: The X position of the left edge of this element.
  3601. GetName
  3602. Function documentation:
  3603. Retrieves the name of this element.
  3604. name = Layout:GetName() -- string <- void
  3605. Return values:
  3606. name: The name of this element, as provided by the addon that created it.
  3607. GetOwner
  3608. Function documentation:
  3609. Retrieves the owner of this element.
  3610. owner = Layout:GetOwner() -- string <- void
  3611. Return values:
  3612. owner: The owner of this element. Given as an addon identifier.
  3613. GetRight
  3614. Function documentation:
  3615. Retrieves the X position of the right edge of this element.
  3616. right = Layout:GetRight() -- number <- void
  3617. Return values:
  3618. right: The X position of the right edge of this element.
  3619. GetTop
  3620. Function documentation:
  3621. Retrieves the Y position of the top edge of this element.
  3622. top = Layout:GetTop() -- number <- void
  3623. Return values:
  3624. top: The Y position of the top edge of this element.
  3625. GetType
  3626. Function documentation:
  3627. Retrieves the type of this element.
  3628. type = Layout:GetType() -- string <- void
  3629. Return values:
  3630. type: The type of this element.
  3631. GetWidth
  3632. Function documentation:
  3633. Retrieves the width of this element.
  3634. width = Layout:GetWidth() -- number <- void
  3635. Return values:
  3636. width: The width of this element.
  3637. ReadAll
  3638. Function documentation:
  3639. Read all set points and sizes from this frame.
  3640. results = Layout:ReadAll() -- table <- void
  3641. Return values:
  3642. results: Result table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.
  3643. ReadHeight
  3644. Function documentation:
  3645. Read a set height from this frame.
  3646. height = Layout:ReadHeight() -- number <- void
  3647. Return values:
  3648. height: The parameter passed to SetHeight(), or nil if no such parameter has been passed.
  3649. ReadPoint
  3650. Function documentation:
  3651. Read a set point from this frame. Must be given a single-axis coordinate.
  3652. layout, position, offset = Layout:ReadPoint(coordinate) -- Layout, number, number <- string
  3653. layout, position, offset = Layout:ReadPoint(x, y) -- Layout, number, number <- number/nil, number/nil
  3654. origin, offset = Layout:ReadPoint(coordinate) -- string, number <- string
  3655. origin, offset = Layout:ReadPoint(x, y) -- string, number <- number/nil, number/nil
  3656. Parameters:
  3657. coordinate: Named coordinate. Must be a one-axis coordinate.
  3658. x: X coordinate of the point. Either this or Y must be nil.
  3659. y: Y coordinate of the point. Either this or X must be nil.
  3660. Return values:
  3661. layout: The table that this point is pinned to.
  3662. offset: The offset in pixels from the source location to the actual location.
  3663. origin: The string "origin".
  3664. 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.
  3665. ReadWidth
  3666. Function documentation:
  3667. Read a set width from this frame.
  3668. width = Layout:ReadWidth() -- number <- void
  3669. Return values:
  3670. width: The parameter passed to SetWidth(), or nil if no such parameter has been passed.
  3671. Events:
  3672. Move
  3673. Frame event documentation:
  3674. Signals that the frame's vertices have moved.
  3675. Layout.Event:Move()
  3676. Size
  3677. Frame event documentation:
  3678. Signals that the frame's size has changed.
  3679. Layout.Event:Size()
  3680. Native: Inherits from Layout
  3681. Members:
  3682. GetLayer
  3683. Function documentation:
  3684. Gets the native item's layer order.
  3685. layer = Native:GetLayer() -- number <- void
  3686. Return values:
  3687. layer: The render layer of this frame. See Frame:SetLayer for details.
  3688. GetLoaded
  3689. Function documentation:
  3690. Gets whether or not this native element is loaded and rendering.
  3691. loaded = Native:GetLoaded() -- boolean <- void
  3692. Return values:
  3693. loaded: true if it is loaded.
  3694. GetSecureMode
  3695. Function documentation:
  3696. Get the native element's secure mode. See Frame:SetSecureMode() for details.
  3697. secure = Native:GetSecureMode() -- string <- void
  3698. Return values:
  3699. secure: The current secure mode.
  3700. GetStrata
  3701. Function documentation:
  3702. Gets the native item's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.
  3703. strata = Native:GetStrata() -- string <- void
  3704. Return values:
  3705. strata: The item's current strata.
  3706. GetStrataList
  3707. Function documentation:
  3708. Gets a list of valid stratas for this native element.
  3709. stratas = Native:GetStrataList() -- table <- void
  3710. Return values:
  3711. stratas: An array of valid stratas, in order.
  3712. SetLayer
  3713. Function documentation:
  3714. Sets the frame layer for this native element. 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 guarantees no Z-fighting. Frames are always drawn after their parents.
  3715. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3716. Native:SetLayer(layer) -- number
  3717. Parameters:
  3718. layer: The new layer for this frame.
  3719. SetStrata
  3720. Function documentation:
  3721. Sets the strata for this native element.
  3722. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3723. Native:SetStrata(layer) -- string
  3724. Parameters:
  3725. layer: The new layer for this frame.
  3726. Events:
  3727. Layer
  3728. Frame event documentation:
  3729. Signals a change in the item's layer.
  3730. Native.Event:Layer()
  3731. Loaded
  3732. Frame event documentation:
  3733. Signals a change in the item's loaded status.
  3734. Native.Event:Loaded()
  3735. Strata
  3736. Frame event documentation:
  3737. Signals a change in the item's strata.
  3738. Native.Event:Strata()
  3739. Element: Inherits from Layout
  3740. Members:
  3741. GetAlpha
  3742. Function documentation:
  3743. Gets the alpha multiplier of this frame.
  3744. alpha = Element:GetAlpha() -- number <- void
  3745. Return values:
  3746. 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.
  3747. GetBackgroundColor
  3748. Function documentation:
  3749. Retrieves the background color of this frame.
  3750. r, g, b, a = Element:GetBackgroundColor() -- number, number, number, number <- void
  3751. Return values:
  3752. a: Alpha. 1 is fully opaque, 0 is fully transparent.
  3753. b: Blue.
  3754. g: Green.
  3755. r: Red.
  3756. GetChildren
  3757. Function documentation:
  3758. Returns a table containing all of this element's children.
  3759. children = Element:GetChildren() -- table <- void
  3760. Return values:
  3761. children: A table containing this element's children.
  3762. GetKeyFocus
  3763. Function documentation:
  3764. Gets the key focus status.
  3765. focus = Element:GetKeyFocus() -- boolean <- void
  3766. Return values:
  3767. focus: Whether this frame is the current key focus.
  3768. GetMouseMasking
  3769. Function documentation:
  3770. Get the current mouse masking mode. See SetMouseMasking for details.
  3771. mask = Element:GetMouseMasking() -- string <- void
  3772. Return values:
  3773. mask: The current mouse masking mode.
  3774. GetVisible
  3775. Function documentation:
  3776. Gets the visibility flag for this frame.
  3777. visible = Element:GetVisible() -- boolean <- void
  3778. Return values:
  3779. visible: This frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.
  3780. SetAlpha
  3781. Function documentation:
  3782. Sets the alpha transparency multiplier for this frame and its children.
  3783. Element:SetAlpha(alpha) -- number
  3784. Parameters:
  3785. alpha: The new alpha multiplier. 1 is fully opaque, 0 is fully transparent.
  3786. SetBackgroundColor
  3787. Function documentation:
  3788. Sets the background color of this frame.
  3789. Element:SetBackgroundColor(r, g, b) -- number, number, number
  3790. Element:SetBackgroundColor(r, g, b, a) -- number, number, number, number
  3791. Parameters:
  3792. a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
  3793. b: Blue.
  3794. g: Green.
  3795. r: Red.
  3796. SetKeyFocus
  3797. Function documentation:
  3798. 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.
  3799. Element:SetKeyFocus(focus) -- boolean
  3800. Parameters:
  3801. focus: The new key focus setting.
  3802. SetMouseMasking
  3803. Function documentation:
  3804. Sets the frame's mouse masking mode.
  3805. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3806. Element:SetMouseMasking(mask) -- string
  3807. Parameters:
  3808. 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 mouse event will still consume MouseMove/In/Out events.
  3809. SetVisible
  3810. Function documentation:
  3811. 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.
  3812. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3813. Element:SetVisible(visible) -- boolean
  3814. Parameters:
  3815. visible: The new visibility flag.
  3816. Events:
  3817. KeyDown
  3818. KeyFocusGain
  3819. KeyFocusLoss
  3820. KeyRepeat
  3821. KeyType
  3822. KeyUp
  3823. LeftClick
  3824. LeftDown
  3825. LeftUp
  3826. LeftUpoutside
  3827. MiddleClick
  3828. MiddleDown
  3829. MiddleUp
  3830. MiddleUpoutside
  3831. Mouse4Click
  3832. Mouse4Down
  3833. Mouse4Up
  3834. Mouse4Upoutside
  3835. Mouse5Click
  3836. Mouse5Down
  3837. Mouse5Up
  3838. Mouse5Upoutside
  3839. MouseIn
  3840. MouseMove
  3841. MouseOut
  3842. RightClick
  3843. RightDown
  3844. RightUp
  3845. RightUpoutside
  3846. WheelBack
  3847. WheelForward
  3848. Frame: Inherits from Element
  3849. Members:
  3850. ClearAll
  3851. Function documentation:
  3852. Clear all set points and sizes from this frame.
  3853. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3854. Frame:ClearAll() -- void
  3855. ClearHeight
  3856. Function documentation:
  3857. Clear a set height from this frame.
  3858. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3859. Frame:ClearHeight() -- void
  3860. ClearPoint
  3861. Function documentation:
  3862. Clear a set point from this frame.
  3863. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3864. Frame:ClearPoint(coordinate) -- string
  3865. Frame:ClearPoint(x, y) -- number/nil, number/nil
  3866. Parameters:
  3867. coordinate: Named coordinate.
  3868. x: X coordinate of the point.
  3869. y: Y coordinate of the point.
  3870. ClearWidth
  3871. Function documentation:
  3872. Clear a set width from this frame.
  3873. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3874. Frame:ClearWidth() -- void
  3875. GetLayer
  3876. Function documentation:
  3877. Gets the frame's layer order.
  3878. layer = Frame:GetLayer() -- number <- void
  3879. Return values:
  3880. layer: The render layer of this frame. See Frame:SetLayer for details.
  3881. GetMouseoverUnit
  3882. Function documentation:
  3883. Gets the unit that is being represented by this frame.
  3884. unit = Frame:GetMouseoverUnit() -- string <- void
  3885. Return values:
  3886. unit: The current mouseover unit. May be nil if there is no mouseover unit.
  3887. GetParent
  3888. Function documentation:
  3889. Gets the parent of this frame.
  3890. parent = Frame:GetParent() -- Element <- void
  3891. Return values:
  3892. parent: The parent element of this frame.
  3893. GetSecureMode
  3894. Function documentation:
  3895. Get the current secure mode. See SetSecureMode for details.
  3896. secure = Frame:GetSecureMode() -- string <- void
  3897. Return values:
  3898. secure: The current secure mode.
  3899. GetStrata
  3900. Function documentation:
  3901. Gets the frame's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.
  3902. strata = Frame:GetStrata() -- string <- void
  3903. Return values:
  3904. strata: The item's current strata.
  3905. GetStrataList
  3906. Function documentation:
  3907. Gets a list of valid stratas for this frame.
  3908. stratas = Frame:GetStrataList() -- table <- void
  3909. Return values:
  3910. stratas: An array of valid stratas, in order.
  3911. SetAllPoints
  3912. Function documentation:
  3913. 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.
  3914. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3915. Frame:SetAllPoints() -- void
  3916. Frame:SetAllPoints(target) -- Layout
  3917. Parameters:
  3918. target: Target Layout to pin this frame's edges to.
  3919. SetHeight
  3920. Function documentation:
  3921. Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
  3922. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3923. Frame:SetHeight(height) -- number
  3924. Parameters:
  3925. height: The new height of this frame.
  3926. SetLayer
  3927. Function documentation:
  3928. 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 guarantees no Z-fighting. Frames are always drawn after their parents.
  3929. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3930. Frame:SetLayer(layer) -- number
  3931. Parameters:
  3932. layer: The new layer for this frame.
  3933. SetMouseoverUnit
  3934. Function documentation:
  3935. Sets the unit that will be represented by this frame.
  3936. Permitted only on a frame with "restricted" SecureMode while the addon environment is not secured.
  3937. Frame:SetMouseoverUnit(unit) -- unit
  3938. Frame:SetMouseoverUnit(unit) -- nil
  3939. Parameters:
  3940. unit: The new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
  3941. SetParent
  3942. Function documentation:
  3943. 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".
  3944. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3945. Frame:SetParent(parent) -- Element
  3946. Parameters:
  3947. parent: The new parent for this frame.
  3948. SetPoint
  3949. Function documentation:
  3950. 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.
  3951. 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]).
  3952. 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".
  3953. 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.
  3954. Optionally, you may include an X or Y offset to the point.
  3955. This connection is permanent, and if the target frame moves, this frame will move along with it.
  3956. 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.
  3957. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3958. Frame:SetPoint(...) -- ...
  3959. Parameters:
  3960. ...: This function's parameters are complicated. Read the above summary for details.
  3961. SetSecureMode
  3962. Function documentation:
  3963. Sets the frame's secure mode.
  3964. "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.
  3965. If you are not planning to use any restricted functions, your frame should remain in normal mode.
  3966. At the moment, it is not possible to change from "restricted" back to "normal".
  3967. Frame:SetSecureMode(secure) -- string
  3968. Parameters:
  3969. secure: The new secure mode. Valid inputs are "normal" and "restricted".
  3970. SetStrata
  3971. Function documentation:
  3972. Sets the strata for this frame.
  3973. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3974. Frame:SetStrata(strata) -- string
  3975. Parameters:
  3976. strata: The item's new strata. Must be one of the elements returned by :GetStrataList().
  3977. SetWidth
  3978. Function documentation:
  3979. Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
  3980. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  3981. Frame:SetWidth(width) -- number
  3982. Parameters:
  3983. width: The new width of this frame.
  3984. Events:
  3985. Layer
  3986. Frame event documentation:
  3987. Signals a change in the item's layer.
  3988. Frame.Event:Layer()
  3989. Strata
  3990. Frame event documentation:
  3991. Signals a change in the item's strata.
  3992. Frame.Event:Strata()
  3993. Context: Inherits from Frame
  3994. Members:
  3995. (No extra members)
  3996. Events:
  3997. (No extra events)
  3998. Canvas: Inherits from Frame
  3999. Members:
  4000. GetShape
  4001. Function documentation:
  4002. Returns the current canvas shape.
  4003. shape, fill, stroke = Canvas:GetShape() -- table, table, table <- void
  4004. Return values:
  4005. fill: The current fill style. See Canvas:SetShape() for details.
  4006. shape: The current shape. See Canvas:SetShape() for details.
  4007. stroke: The current stroke style. See Canvas:SetShape() for details.
  4008. SetShape
  4009. Function documentation:
  4010. Sets the canvas shape. Must have at least one of "fill" or "stroke".
  4011. Canvas:SetShape(path, fill, stroke) -- nil, nil, nil
  4012. Canvas:SetShape(path, fill, stroke) -- table, table, nil
  4013. Canvas:SetShape(path, fill, stroke) -- table, nil, table
  4014. Canvas:SetShape(path, fill, stroke) -- table, table, table
  4015. Parameters:
  4016. fill: A fill style. By default, "gradientLinear" spreads on the X axis, between 0 and 100. "gradientRadial" is centered around the local origin, with a radius of 100 units. "texture" starts at the origin and extends out to the texture size. Members:
  4017. type: One of "solid", "gradientLinear", "gradientRadial", "texture". Required.
  4018. r: Red color value, betwen 0 and 1. Available and required for "solid".
  4019. g: Green color value, betwen 0 and 1. Available and required for "solid".
  4020. b: Blue color value, betwen 0 and 1. Available and required for "solid".
  4021. a: Alpha color value, betwen 0 and 1. Defaults to 1. Available for "solid".
  4022. color: Gradient color values. A table containing a series of tables, with consecutive integer keys starting from 1. Each internal table contains color values and a gradient position. Available and required for "gradientLinear" and "gradientRadial". Members:
  4023. r: Red color value, between 0 and 1. Required.
  4024. g: Green color value, between 0 and 1. Required.
  4025. b: Blue color value, between 0 and 1. Required.
  4026. a: Alpha color value, between 0 and 1. Defaults to 1.
  4027. position: Location within the gradient. Must be nondecreasing. Gradient automatically rescales to fit the largest position value seen.
  4028. transform: An array containing the first two rows of a 3x3 transformation matrix. The third row is set to (0,0,1). Defaults to {1, 0, 0, 0, 1, 0}, representing the identity matrix. See Utility.Matrix.Create() for basic functionality. Available for "gradientLinear", "gradientRadial", and "texture".
  4029. focus: Number between 0 and 1 controlling the center bias of radial gradients. Defaults to 0. Available for "gradientRadial".
  4030. wrap: Control the bounds behavior of textures. Must be either "clamp" or "repeat". Defaults to "clamp". Available for "texture".
  4031. smooth: Boolean controlling texture smoothing behavior. Defaults to true. Available for "texture".
  4032. source: Source addon ID of the texture to be rendered. See Texture:SetTexture() for details. Available and required for "texture".
  4033. texture: Texture identifier of the texture to be rendered. See Texture:SetTexture() for details. Available and required for "texture".
  4034. path: A path. Consists of a table containing a series of tables, with consecutive integer keys starting from 1. Each internal table contains coordinates, either as an absolute value relative to the top-left corner of the frame, or Proportional to the frame size, as a number from 0 to 1. Giving both an absolute value and a proportional value for any coordinate is not allowed. Members:
  4035. x/xProportional: x coordinate of this point. Required.
  4036. y/yProportional: y coordinate of this point. Required.
  4037. xControl/xControlProportional: x coordinate of the curve control handle. If this exists, yControl/yControlProportional must also exist.
  4038. yControl/yControlProportional: y coordinate of the curve control handle. If this exists, xControl/xControlProportional must also exist.
  4039. stroke: A stroke style. Members:
  4040. r: Red color value, betwen 0 and 1. Required.
  4041. g: Green color value, betwen 0 and 1. Required.
  4042. b: Blue color value, betwen 0 and 1. Required.
  4043. a: Alpha color value, betwen 0 and 1. Defaults to 1.
  4044. cap: Endcap behavior for non-loops. May be "none", "square", or "round". Defaults to "round".
  4045. miter: Corner behavior. May be "miter", "round", or "bevel". Defaults to "miter".
  4046. miterLimit: Determines how small the corner angle can be until the miter is chopped off. Defaults to 3. Available only if miter behavior is set to "miter".
  4047. thickness: Line thickness. Required.
  4048. Events:
  4049. (No extra events)
  4050. Mask: Inherits from Frame
  4051. Members:
  4052. GetShape
  4053. Function documentation:
  4054. Returns the current mask shape.
  4055. shape = Mask:GetShape() -- table <- void
  4056. Return values:
  4057. shape: The current shape. See Canvas:SetShape() for details.
  4058. SetShape
  4059. Function documentation:
  4060. Sets the mask shape. Note that masks with custom shapes will not cull mouse events according to the custom shape.
  4061. Mask:SetShape(path) -- nil
  4062. Mask:SetShape(path) -- table
  4063. Parameters:
  4064. path: A path. Consists of a table containing a series of tables, with consecutive integer keys starting from 1. Each internal table contains coordinates, either as an absolute value relative to the top-left corner of the frame, or Proportional to the frame size, as a number from 0 to 1. Giving both an absolute value and a proportional value for any coordinate is not allowed. Members:
  4065. x/xProportional: x coordinate of this point. Required.
  4066. y/yProportional: y coordinate of this point. Required.
  4067. xControl/xControlProportional: x coordinate of the curve control handle. If this exists, yControl/yControlProportional must also exist.
  4068. yControl/yControlProportional: y coordinate of the curve control handle. If this exists, xControl/xControlProportional must also exist.
  4069. Events:
  4070. (No extra events)
  4071. Text: Inherits from Frame
  4072. Members:
  4073. GetEffectBlur
  4074. Function documentation:
  4075. Gets the current parameters for the Blur effect.
  4076. effect = Text:GetEffectBlur() -- table <- void
  4077. effect = Text:GetEffectBlur() -- nil <- void
  4078. Return values:
  4079. effect: The current parameters for this effect. All members are optional. Pass nil to disable the effect.
  4080. Returned members:
  4081. blurX: Controls how much blurring exists along the X axis. Defaults to 2.
  4082. blurY: Controls how much blurring exists along the Y axis. Defaults to 2.
  4083. GetEffectGlow
  4084. Function documentation:
  4085. Gets the current parameters for the Glow effect.
  4086. effect = Text:GetEffectGlow() -- table <- void
  4087. effect = Text:GetEffectGlow() -- nil <- void
  4088. Return values:
  4089. effect: The current parameters for this effect. All members are optional. Pass nil to disable the effect.
  4090. Returned members:
  4091. blurX: Controls how much blurring exists along the X axis. Defaults to 2.
  4092. blurY: Controls how much blurring exists along the Y axis. Defaults to 2.
  4093. colorA: Controls the alpha channel of the glow effect. Defaults to 1.
  4094. colorB: Controls the blue channel of the glow effect. Defaults to 0.
  4095. colorG: Controls the green channel of the glow effect. Defaults to 0.
  4096. colorR: Controls the red channel of the glow effect. Defaults to 0.
  4097. knockout: Enables the "knockout" effect. Defaults to false.
  4098. offsetX: Controls the glow offset along the X axis. Defaults to 0.
  4099. offsetY: Controls the glow offset along the Y axis. Defaults to 0.
  4100. replace: Hides the original text. Defaults to false.
  4101. strength: Controls the strength of the glow. Defaults to 1.
  4102. GetFont
  4103. Function documentation:
  4104. Gets the current font used for this element.
  4105. source, font = Text:GetFont() -- string, string <- void
  4106. Return values:
  4107. font: The actual font identifier. Either a resource identifier or a filename.
  4108. 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.
  4109. GetFontColor
  4110. Function documentation:
  4111. Gets the current font color for this element.
  4112. r, g, b, a = Text:GetFontColor() -- number, number, number, number <- void
  4113. Return values:
  4114. a: Alpha. 1 is fully opaque, 0 is fully transparent.
  4115. b: Blue.
  4116. g: Green.
  4117. r: Red.
  4118. GetFontSize
  4119. Function documentation:
  4120. Gets the font size of the current element.
  4121. fontsize = Text:GetFontSize() -- number <- void
  4122. Return values:
  4123. fontsize: The current font size of this element.
  4124. GetText
  4125. Function documentation:
  4126. Get the current text for this element.
  4127. text, html = Text:GetText() -- string, boolean <- void
  4128. Return values:
  4129. html: The current HTML flag.
  4130. text: The current text of the element.
  4131. GetWordwrap
  4132. Function documentation:
  4133. Gets the wordwrap flag for this element.
  4134. wordwrap = Text:GetWordwrap() -- boolean <- void
  4135. Return values:
  4136. wordwrap: The current wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
  4137. SetEffectBlur
  4138. Function documentation:
  4139. Sets the parameters for the Blur effect.
  4140. Text:SetEffectBlur(effect) -- table
  4141. Text:SetEffectBlur(effect) -- nil
  4142. Parameters:
  4143. effect: The parameters for this effect. All members are optional. Pass nil to disable the effect.
  4144. Returned members:
  4145. blurX: Controls how much blurring exists along the X axis. Defaults to 2.
  4146. blurY: Controls how much blurring exists along the Y axis. Defaults to 2.
  4147. SetEffectGlow
  4148. Function documentation:
  4149. Sets the parameters for the Glow effect.
  4150. Text:SetEffectGlow(effect) -- table
  4151. Text:SetEffectGlow(effect) -- nil
  4152. Parameters:
  4153. effect: The parameters for this effect. All members are optional. Pass nil to disable the effect.
  4154. Returned members:
  4155. blurX: Controls how much blurring exists along the X axis. Defaults to 2.
  4156. blurY: Controls how much blurring exists along the Y axis. Defaults to 2.
  4157. colorA: Controls the alpha channel of the glow effect. Defaults to 1.
  4158. colorB: Controls the blue channel of the glow effect. Defaults to 0.
  4159. colorG: Controls the green channel of the glow effect. Defaults to 0.
  4160. colorR: Controls the red channel of the glow effect. Defaults to 0.
  4161. knockout: Enables the "knockout" effect. Defaults to false.
  4162. offsetX: Controls the glow offset along the X axis. Defaults to 0.
  4163. offsetY: Controls the glow offset along the Y axis. Defaults to 0.
  4164. replace: Hides the original text. Defaults to false.
  4165. strength: Controls the strength of the glow. Defaults to 1.
  4166. SetFont
  4167. Function documentation:
  4168. Sets the current font used for this element.
  4169. Text:SetFont(source, font) -- string, string
  4170. Parameters:
  4171. font: The actual font identifier. Either a resource identifier or a filename.
  4172. 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.
  4173. SetFontColor
  4174. Function documentation:
  4175. Sets the current font color for this element.
  4176. Text:SetFontColor(r, g, b) -- number, number, number
  4177. Text:SetFontColor(r, g, b, a) -- number, number, number, number
  4178. Parameters:
  4179. a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
  4180. b: Blue.
  4181. g: Green.
  4182. r: Red.
  4183. SetFontSize
  4184. Function documentation:
  4185. Sets the current font size of this element.
  4186. Text:SetFontSize(fontsize) -- number
  4187. Parameters:
  4188. fontsize: The new font size of this element.
  4189. SetText
  4190. Function documentation:
  4191. Sets the current text for this element.
  4192. Text:SetText(text) -- string
  4193. Text:SetText(text, html) -- string, boolean
  4194. Parameters:
  4195. html: Enables HTML mode. In HTML mode, a limited number of formatting tags are available: <u>, <font color="#rrggbb">, and <a lua="print('This is a lua script.')">.
  4196. text: The new text for the element.
  4197. SetWordwrap
  4198. Function documentation:
  4199. Sets the wordwrap flag for this element.
  4200. Text:SetWordwrap(wordwrap) -- boolean
  4201. Parameters:
  4202. wordwrap: The new wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
  4203. Events:
  4204. (No extra events)
  4205. Texture: Inherits from Frame
  4206. Members:
  4207. GetTexture
  4208. Function documentation:
  4209. Gets the current texture used for this element.
  4210. source, texture = Texture:GetTexture() -- string, string <- void
  4211. Return values:
  4212. 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.
  4213. texture: The actual texture identifier. Either a resource identifier or a filename.
  4214. GetTextureHeight
  4215. Function documentation:
  4216. Returns the actual pixel height of the current texture.
  4217. height = Texture:GetTextureHeight() -- number <- void
  4218. Return values:
  4219. height: The height of the current texture in pixels.
  4220. GetTextureWidth
  4221. Function documentation:
  4222. Returns the actual pixel width of the current texture.
  4223. width = Texture:GetTextureWidth() -- number <- void
  4224. Return values:
  4225. width: The width of the current texture in pixels.
  4226. SetTexture
  4227. Function documentation:
  4228. Sets the current texture used for this element.
  4229. Texture:SetTexture(source, texture) -- string, string
  4230. Parameters:
  4231. 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.
  4232. texture: The actual texture identifier. Either a resource identifier or a filename.
  4233. Events:
  4234. (No extra events)
  4235. RiftButton: Inherits from Frame
  4236. Members:
  4237. GetEnabled
  4238. Function documentation:
  4239. Gets whether the button is enabled or grayed out.
  4240. enabled = RiftButton:GetEnabled() -- boolean <- void
  4241. Return values:
  4242. enabled: The current enable state of this item.
  4243. GetSkin
  4244. Function documentation:
  4245. Gets the current skin of this item.
  4246. skin = RiftButton:GetSkin() -- string <- void
  4247. Return values:
  4248. skin: The current skin. Possible results include "default" and "close".
  4249. GetText
  4250. Function documentation:
  4251. Gets this button's text.
  4252. text = RiftButton:GetText() -- string <- void
  4253. Return values:
  4254. text: The current text of the element.
  4255. SetEnabled
  4256. Function documentation:
  4257. Sets whether the button is enabled or grayed out.
  4258. RiftButton:SetEnabled(enabled) -- boolean
  4259. Parameters:
  4260. enabled: The new enable state of this item.
  4261. SetSkin
  4262. Function documentation:
  4263. Sets the current skin of this item.
  4264. RiftButton:SetSkin(skin) -- string
  4265. Parameters:
  4266. skin: The new skin. Possible values are "default" and "close".
  4267. SetText
  4268. Function documentation:
  4269. Sets this button's text.
  4270. RiftButton:SetText(text) -- string
  4271. Parameters:
  4272. text: The new text for the element.
  4273. Events:
  4274. LeftPress
  4275. Frame event documentation:
  4276. Signals that the button has been pressed. Equivalent to LeftClick, but triggers only while the button is enabled.
  4277. RiftButton.Event:LeftPress()
  4278. RiftCheckbox: Inherits from Frame
  4279. Members:
  4280. GetChecked
  4281. Function documentation:
  4282. Gets whether the button is checked or not.
  4283. checked = RiftCheckbox:GetChecked() -- boolean <- void
  4284. Return values:
  4285. checked: The current checked state of this item.
  4286. GetEnabled
  4287. Function documentation:
  4288. Gets whether the checkbox is enabled or grayed out.
  4289. enabled = RiftCheckbox:GetEnabled() -- boolean <- void
  4290. Return values:
  4291. enabled: The current enable state of this item.
  4292. SetChecked
  4293. Function documentation:
  4294. Sets whether the checkbox is checked or not.
  4295. RiftCheckbox:SetChecked(checked) -- boolean
  4296. Parameters:
  4297. checked: The new checked state of this item.
  4298. SetEnabled
  4299. Function documentation:
  4300. Sets whether the checkbox is enabled or grayed out.
  4301. RiftCheckbox:SetEnabled(enabled) -- boolean
  4302. Parameters:
  4303. enabled: The new enable state of this item.
  4304. Events:
  4305. CheckboxChange
  4306. Frame event documentation:
  4307. Signals that the checkbox's checked state has changed.
  4308. RiftCheckbox.Event:CheckboxChange()
  4309. RiftScrollbar: Inherits from Frame
  4310. Members:
  4311. GetEnabled
  4312. Function documentation:
  4313. Gets whether the scrollbar is enabled or disabled.
  4314. enabled = RiftScrollbar:GetEnabled() -- boolean <- void
  4315. Return values:
  4316. enabled: The current enable state of this item.
  4317. GetOrientation
  4318. Function documentation:
  4319. Gets the current orientation of the scrollbar.
  4320. orientation = RiftScrollbar:GetOrientation() -- string <- void
  4321. Return values:
  4322. orientation: The current orientation. Valid results include "vertical" and "horizontal".
  4323. GetPosition
  4324. Function documentation:
  4325. Returns the current position of the scrollbar.
  4326. position = RiftScrollbar:GetPosition() -- number <- void
  4327. Return values:
  4328. position: The current position of this scrollbar.
  4329. GetRange
  4330. Function documentation:
  4331. Returns the current range of the scrollbar.
  4332. minimum, maximum = RiftScrollbar:GetRange() -- number, number <- void
  4333. Return values:
  4334. maximum: The maximum value for the position of this slider.
  4335. minimum: The minimum value for the position of this slider.
  4336. GetThickness
  4337. Function documentation:
  4338. Returns the thickness of the scrollbar handle. Size is relative to the range.
  4339. thickness = RiftScrollbar:GetThickness() -- number <- void
  4340. Return values:
  4341. thickness: The thickness of the handle.
  4342. Nudge
  4343. Function documentation:
  4344. Modify the scrollbar position, clamped to the current bounds.
  4345. RiftScrollbar:Nudge(offset) -- number
  4346. Parameters:
  4347. offset: The amount to nudge.
  4348. NudgeDown
  4349. Function documentation:
  4350. Shift the scrollbar down (i.e. away from zero) by a standard amount.
  4351. RiftScrollbar:NudgeDown() -- void
  4352. NudgeUp
  4353. Function documentation:
  4354. Shift the scrollbar up (i.e. towards zero) by a standard amount.
  4355. RiftScrollbar:NudgeUp() -- void
  4356. SetEnabled
  4357. Function documentation:
  4358. Sets whether the scrollbar is enabled or disabled.
  4359. RiftScrollbar:SetEnabled(enabled) -- boolean
  4360. Parameters:
  4361. enabled: The new enable state of this item.
  4362. SetOrientation
  4363. Function documentation:
  4364. Sets the orientation of the scrollbar.
  4365. RiftScrollbar:SetOrientation(orientation) -- string
  4366. Parameters:
  4367. orientation: The new orientation. Must be either "vertical" or "horizontal".
  4368. SetPosition
  4369. Function documentation:
  4370. Changes the current position of the scrollbar.
  4371. RiftScrollbar:SetPosition(position) -- number
  4372. Parameters:
  4373. position: The new position of this scrollbar. Must be within the current range.
  4374. SetRange
  4375. Function documentation:
  4376. Changes the current range of the scrollbar.
  4377. RiftScrollbar:SetRange(minimum, maximum) -- number, number
  4378. Parameters:
  4379. maximum: The new maximum value for the position of this slider. Must be an integer and larger than or equal to "minimum".
  4380. minimum: The new minimum value for the position of this slider. Must be an integer and smaller than or equal to "maximum".
  4381. SetThickness
  4382. Function documentation:
  4383. Sets the current thickness of the scrollbar handle. Size is relative to the range.
  4384. RiftScrollbar:SetThickness(thickness) -- number
  4385. Parameters:
  4386. thickness: The new thickness of the handle.
  4387. Events:
  4388. ScrollbarChange
  4389. Frame event documentation:
  4390. Signals a change in the scrollbar position.
  4391. RiftScrollbar.Event:ScrollbarChange()
  4392. ScrollbarGrab
  4393. Frame event documentation:
  4394. Signals the user grabbing the scrollbar with the mouse.
  4395. RiftScrollbar.Event:ScrollbarGrab()
  4396. ScrollbarRelease
  4397. Frame event documentation:
  4398. Signals the user releasing the scrollbar.
  4399. RiftScrollbar.Event:ScrollbarRelease()
  4400. RiftSlider: Inherits from Frame
  4401. Members:
  4402. GetEnabled
  4403. Function documentation:
  4404. Gets whether the slider is enabled or grayed out.
  4405. enabled = RiftSlider:GetEnabled() -- boolean <- void
  4406. Return values:
  4407. enabled: The current enable state of this item.
  4408. GetPosition
  4409. Function documentation:
  4410. Returns the current position of the slider.
  4411. position = RiftSlider:GetPosition() -- number <- void
  4412. Return values:
  4413. position: The current position of this slider.
  4414. GetRange
  4415. Function documentation:
  4416. Returns the current range of the slider.
  4417. minimum, maximum = RiftSlider:GetRange() -- number, number <- void
  4418. Return values:
  4419. maximum: The maximum value for the position of this slider.
  4420. minimum: The minimum value for the position of this slider.
  4421. SetEnabled
  4422. Function documentation:
  4423. Sets whether the slider is enabled or grayed out.
  4424. RiftSlider:SetEnabled(enabled) -- boolean
  4425. Parameters:
  4426. enabled: The new enable state of this item.
  4427. SetPosition
  4428. Function documentation:
  4429. Changes the current position of the slider.
  4430. RiftSlider:SetPosition(position) -- number
  4431. Parameters:
  4432. position: The new position of this slider. Must be within the current range.
  4433. SetRange
  4434. Function documentation:
  4435. Sets the current range of the slider.
  4436. RiftSlider:SetRange(minimum, maximum) -- number, number
  4437. Parameters:
  4438. maximum: The new maximum value for the position of this slider. Must be an integer and larger than or equal to "minimum".
  4439. minimum: The new minimum value for the position of this slider. Must be an integer and smaller than or equal to "maximum".
  4440. Events:
  4441. SliderChange
  4442. Frame event documentation:
  4443. Signals a change in the slider position.
  4444. RiftSlider.Event:SliderChange()
  4445. SliderGrab
  4446. Frame event documentation:
  4447. Signals the user grabbing the slider with the mouse.
  4448. RiftSlider.Event:SliderGrab()
  4449. SliderRelease
  4450. Frame event documentation:
  4451. Signals the user releasing the slider.
  4452. RiftSlider.Event:SliderRelease()
  4453. RiftTextfield: Inherits from Frame
  4454. Members:
  4455. GetCursor
  4456. Function documentation:
  4457. Returns the current position of the cursor.
  4458. cursor = RiftTextfield:GetCursor() -- number <- void
  4459. Return values:
  4460. cursor: The current position of this cursor. 0 indicates a cursor placed before any text.
  4461. GetSelection
  4462. Function documentation:
  4463. Returns the current bounds of the selected text.
  4464. begin, end = RiftTextfield:GetSelection() -- number, number <- void
  4465. Return values:
  4466. begin: The beginning of the selected text, in the same format GetCursor uses. nil if there is no text selected.
  4467. end: The end of the selected text, in the same format GetCursor uses. nil if there is no text selected.
  4468. GetSelectionText
  4469. Function documentation:
  4470. Get the current selected text for this element. Returns nil if no text has been selected.
  4471. text = RiftTextfield:GetSelectionText() -- string <- void
  4472. Return values:
  4473. text: The current text of the element.
  4474. GetText
  4475. Function documentation:
  4476. Get the current text for this element.
  4477. text = RiftTextfield:GetText() -- string <- void
  4478. Return values:
  4479. text: The current text of the element.
  4480. SetCursor
  4481. Function documentation:
  4482. Changes the current position of the cursor.
  4483. RiftTextfield:SetCursor(cursor) -- number
  4484. Parameters:
  4485. cursor: The new position of this cursor. Must be within the valid range.
  4486. SetSelection
  4487. Function documentation:
  4488. Sets the current bounds of the selected text. Call with no arguments to remove the current selection.
  4489. RiftTextfield:SetSelection() -- void
  4490. RiftTextfield:SetSelection(begin, end) -- number, number
  4491. Parameters:
  4492. begin: The new beginning of the selected text, in the same format SetCursor uses. Must be an integer and smaller than "end".
  4493. end: The new end of the selected text, in the same format SetCursor uses. Must be an integer and larger than "begin".
  4494. SetText
  4495. Function documentation:
  4496. Set the current text for this element.
  4497. RiftTextfield:SetText(text) -- string
  4498. Parameters:
  4499. text: The new text for the element.
  4500. Events:
  4501. TextfieldChange
  4502. Frame event documentation:
  4503. Signals that the textfield's text has changed.
  4504. RiftTextfield.Event:TextfieldChange()
  4505. TextfieldSelect
  4506. Frame event documentation:
  4507. Signals that the textfield's selection has changed.
  4508. RiftTextfield.Event:TextfieldSelect()
  4509. RiftWindow: Inherits from Frame
  4510. Members:
  4511. GetBorder
  4512. Function documentation:
  4513. Gets the element representing the window border.
  4514. border = RiftWindow:GetBorder() -- Element <- void
  4515. Return values:
  4516. border: The window border.
  4517. GetContent
  4518. Function documentation:
  4519. Gets the element representing the window content area.
  4520. content = RiftWindow:GetContent() -- Element <- void
  4521. Return values:
  4522. content: The window content area.
  4523. GetController
  4524. Function documentation:
  4525. Gets the ID of the current controller for this window.
  4526. controller = RiftWindow:GetController() -- string <- void
  4527. Return values:
  4528. controller: "border" or "content", whichever dictates the dimensions of the other.
  4529. GetTitle
  4530. Function documentation:
  4531. Get the current title for this element.
  4532. title = RiftWindow:GetTitle() -- string <- void
  4533. Return values:
  4534. title: The current title of the element.
  4535. GetTrimDimensions
  4536. Function documentation:
  4537. Gets the thicknesses of the border's visual trim.
  4538. left, top, right, bottom = RiftWindow:GetTrimDimensions() -- number, number, number, number <- void
  4539. Return values:
  4540. bottom: The thickness of the bottom window border.
  4541. left: The thickness of the left window border.
  4542. right: The thickness of the right window border.
  4543. top: The thickness of the top window border.
  4544. SetController
  4545. Function documentation:
  4546. 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.
  4547. Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
  4548. RiftWindow:SetController(controller) -- string
  4549. Parameters:
  4550. controller: The new controller ID. May be either "border" or "content".
  4551. SetTitle
  4552. Function documentation:
  4553. Set the current title for this element.
  4554. RiftWindow:SetTitle(title) -- string
  4555. Parameters:
  4556. title: The new title for the element.
  4557. Events:
  4558. (No extra events)
  4559.  
  4560. Frame events:
  4561. Event.UI.Button.Left.Press
  4562. Frame event documentation:
  4563. Signals that a Button has been pressed with the left mouse button. Equivalent to LeftClick, but triggers only while the button is enabled.
  4564. Event.UI.Button.Left.Press(handle)
  4565. Event.UI.Checkbox.Change
  4566. Frame event documentation:
  4567. Signals that a checkbox's state has changed.
  4568. Event.UI.Checkbox.Change(handle)
  4569. Event.UI.Input.Key.Down
  4570. Frame event documentation:
  4571. Signals that a keyboard key has been pressed. Requires key focus.
  4572. Event.UI.Input.Key.Down(handle, key)
  4573. Parameters:
  4574. key: Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.
  4575. Event.UI.Input.Key.Focus.Gain
  4576. Frame event documentation:
  4577. Signals that a frame has gained the key focus.
  4578. Event.UI.Input.Key.Focus.Gain(handle)
  4579. Event.UI.Input.Key.Focus.Loss
  4580. Frame event documentation:
  4581. Signals that a frame has lost the key focus.
  4582. Event.UI.Input.Key.Focus.Loss(handle)
  4583. Event.UI.Input.Key.Repeat
  4584. Frame event documentation:
  4585. Signals that a keyboard key is repeating. Requires key focus.
  4586. Event.UI.Input.Key.Repeat(handle, key)
  4587. Parameters:
  4588. key: Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.
  4589. Event.UI.Input.Key.Type
  4590. Frame event documentation:
  4591. Signals that text has been typed. Requires key focus.
  4592. Event.UI.Input.Key.Type(handle, text)
  4593. Parameters:
  4594. text: The text that has been entered.
  4595. Event.UI.Input.Key.Up
  4596. Frame event documentation:
  4597. Signals that a keyboard key has been released. Requires key focus.
  4598. Event.UI.Input.Key.Up(handle, key)
  4599. Parameters:
  4600. key: Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.
  4601. Event.UI.Input.Mouse.Cursor.In
  4602. Frame event documentation:
  4603. Signals that the cursor has moved into a frame.
  4604. Event.UI.Input.Mouse.Cursor.In(handle)
  4605. Event.UI.Input.Mouse.Cursor.Move
  4606. Frame event documentation:
  4607. Signals that the cursor has moved within a frame.
  4608. Event.UI.Input.Mouse.Cursor.Move(handle)
  4609. Event.UI.Input.Mouse.Cursor.Out
  4610. Frame event documentation:
  4611. Signals that the cursor has moved out of a frame.
  4612. Event.UI.Input.Mouse.Cursor.Out(handle)
  4613. Event.UI.Input.Mouse.Left.Click
  4614. Frame event documentation:
  4615. Signals that the user has clicked the left mouse button.
  4616. Event.UI.Input.Mouse.Left.Click(handle)
  4617. Event.UI.Input.Mouse.Left.Down
  4618. Frame event documentation:
  4619. Signals that the user has pressed the left mouse button.
  4620. Event.UI.Input.Mouse.Left.Down(handle)
  4621. Event.UI.Input.Mouse.Left.Up
  4622. Frame event documentation:
  4623. Signals that the user has released the left mouse button.
  4624. Event.UI.Input.Mouse.Left.Up(handle)
  4625. Event.UI.Input.Mouse.Left.Upoutside
  4626. Frame event documentation:
  4627. Signals that the user has released the left mouse button off this frame after pressing it on this frame.
  4628. Event.UI.Input.Mouse.Left.Upoutside(handle)
  4629. Event.UI.Input.Mouse.Middle.Click
  4630. Frame event documentation:
  4631. Signals that the user has clicked the middle mouse button.
  4632. Event.UI.Input.Mouse.Middle.Click(handle)
  4633. Event.UI.Input.Mouse.Middle.Down
  4634. Frame event documentation:
  4635. Signals that the user has pressed the middle mouse button.
  4636. Event.UI.Input.Mouse.Middle.Down(handle)
  4637. Event.UI.Input.Mouse.Middle.Up
  4638. Frame event documentation:
  4639. Signals that the user has released the middle mouse button.
  4640. Event.UI.Input.Mouse.Middle.Up(handle)
  4641. Event.UI.Input.Mouse.Middle.Upoutside
  4642. Frame event documentation:
  4643. Signals that the user has released the middle mouse button off this frame after pressing it on this frame.
  4644. Event.UI.Input.Mouse.Middle.Upoutside(handle)
  4645. Event.UI.Input.Mouse.Mouse4.Click
  4646. Frame event documentation:
  4647. Signals that the user has clicked the fourth mouse button.
  4648. Event.UI.Input.Mouse.Mouse4.Click(handle)
  4649. Event.UI.Input.Mouse.Mouse4.Down
  4650. Frame event documentation:
  4651. Signals that the user has pressed the fourth mouse button.
  4652. Event.UI.Input.Mouse.Mouse4.Down(handle)
  4653. Event.UI.Input.Mouse.Mouse4.Up
  4654. Frame event documentation:
  4655. Signals that the user has released the fourth mouse button.
  4656. Event.UI.Input.Mouse.Mouse4.Up(handle)
  4657. Event.UI.Input.Mouse.Mouse4.Upoutside
  4658. Frame event documentation:
  4659. Signals that the user has released the fourth mouse button off this frame after pressing it on this frame.
  4660. Event.UI.Input.Mouse.Mouse4.Upoutside(handle)
  4661. Event.UI.Input.Mouse.Mouse5.Click
  4662. Frame event documentation:
  4663. Signals that the user has clicked the fifth mouse button.
  4664. Event.UI.Input.Mouse.Mouse5.Click(handle)
  4665. Event.UI.Input.Mouse.Mouse5.Down
  4666. Frame event documentation:
  4667. Signals that the user has pressed the fifth mouse button.
  4668. Event.UI.Input.Mouse.Mouse5.Down(handle)
  4669. Event.UI.Input.Mouse.Mouse5.Up
  4670. Frame event documentation:
  4671. Signals that the user has released the fifth mouse button.
  4672. Event.UI.Input.Mouse.Mouse5.Up(handle)
  4673. Event.UI.Input.Mouse.Mouse5.Upoutside
  4674. Frame event documentation:
  4675. Signals that the user has released the fifth mouse button off this frame after pressing it on this frame.
  4676. Event.UI.Input.Mouse.Mouse5.Upoutside(handle)
  4677. Event.UI.Input.Mouse.Right.Click
  4678. Frame event documentation:
  4679. Signals that the user has clicked the right mouse button.
  4680. Event.UI.Input.Mouse.Right.Click(handle)
  4681. Event.UI.Input.Mouse.Right.Down
  4682. Frame event documentation:
  4683. Signals that the user has pressed the right mouse button.
  4684. Event.UI.Input.Mouse.Right.Down(handle)
  4685. Event.UI.Input.Mouse.Right.Up
  4686. Frame event documentation:
  4687. Signals that the user has released the right mouse button.
  4688. Event.UI.Input.Mouse.Right.Up(handle)
  4689. Event.UI.Input.Mouse.Right.Upoutside
  4690. Frame event documentation:
  4691. Signals that the user has released the right mouse button off this frame after pressing it on this frame.
  4692. Event.UI.Input.Mouse.Right.Upoutside(handle)
  4693. Event.UI.Input.Mouse.Wheel.Back
  4694. Frame event documentation:
  4695. Signals that the user has moved the mousewheel back.
  4696. Event.UI.Input.Mouse.Wheel.Back(handle)
  4697. Event.UI.Input.Mouse.Wheel.Forward
  4698. Frame event documentation:
  4699. Signals that the user has moved the mousewheel forwards.
  4700. Event.UI.Input.Mouse.Wheel.Forward(handle)
  4701. Event.UI.Layout.Layer
  4702. Frame event documentation:
  4703. Signals a change in layer.
  4704. Event.UI.Layout.Layer(handle)
  4705. Event.UI.Layout.Move
  4706. Frame event documentation:
  4707. Signals a change in the top-left corner's position. May be delayed after the actual movement.
  4708. Event.UI.Layout.Move(handle)
  4709. Event.UI.Layout.Size
  4710. Frame event documentation:
  4711. Signals a change in size. May be delayed after the actual change.
  4712. Event.UI.Layout.Size(handle)
  4713. Event.UI.Layout.Strata
  4714. Frame event documentation:
  4715. Signals a change in strata.
  4716. Event.UI.Layout.Strata(handle)
  4717. Event.UI.Native.Loaded
  4718. Frame event documentation:
  4719. Signals a change in this native frame's loaded state.
  4720. Event.UI.Native.Loaded(handle)
  4721. Event.UI.Scrollbar.Change
  4722. Frame event documentation:
  4723. Signals a change in scrollbar position.
  4724. Event.UI.Scrollbar.Change(handle)
  4725. Event.UI.Scrollbar.Grab
  4726. Frame event documentation:
  4727. Signals that a scrollbar has been grabbed.
  4728. Event.UI.Scrollbar.Grab(handle)
  4729. Event.UI.Scrollbar.Release
  4730. Frame event documentation:
  4731. Signals that a scrollbar has been released.
  4732. Event.UI.Scrollbar.Release(handle)
  4733. Event.UI.Slider.Change
  4734. Frame event documentation:
  4735. Signals a change in slider position.
  4736. Event.UI.Slider.Change(handle)
  4737. Event.UI.Slider.Grab
  4738. Frame event documentation:
  4739. Signals that a slider has been grabbed.
  4740. Event.UI.Slider.Grab(handle)
  4741. Event.UI.Slider.Release
  4742. Frame event documentation:
  4743. Signals that a slider has been released.
  4744. Event.UI.Slider.Release(handle)
  4745. Event.UI.Textfield.Change
  4746. Frame event documentation:
  4747. Signals a change in textfield contents.
  4748. Event.UI.Textfield.Change(handle)
  4749. Event.UI.Textfield.Select
  4750. Frame event documentation:
  4751. Signals a change in textfield selection.
  4752. Event.UI.Textfield.Select(handle)
  4753.  
  4754. Parameter types:
  4755. Canvas
  4756. A UI element of type Canvas or derived from Canvas.
  4757. Context
  4758. A UI element of type Context or derived from Context.
  4759. Element
  4760. A UI element of type Element or derived from Element.
  4761. Frame
  4762. A UI element of type Frame or derived from Frame.
  4763. Layout
  4764. A UI element of type Layout or derived from Layout.
  4765. Mask
  4766. A UI element of type Mask or derived from Mask.
  4767. Native
  4768. A UI element of type Native or derived from Native.
  4769. RiftButton
  4770. A UI element of type RiftButton or derived from RiftButton.
  4771. RiftCheckbox
  4772. A UI element of type RiftCheckbox or derived from RiftCheckbox.
  4773. RiftScrollbar
  4774. A UI element of type RiftScrollbar or derived from RiftScrollbar.
  4775. RiftSlider
  4776. A UI element of type RiftSlider or derived from RiftSlider.
  4777. RiftTextfield
  4778. A UI element of type RiftTextfield or derived from RiftTextfield.
  4779. RiftWindow
  4780. A UI element of type RiftWindow or derived from RiftWindow.
  4781. Text
  4782. A UI element of type Text or derived from Text.
  4783. Texture
  4784. A UI element of type Texture or derived from Texture.
  4785. ability
  4786. An ability, represented by a standard identifier with an 'a' prefix.
  4787. achievement
  4788. An achievement, represented by a standard identifier with a 'c' prefix.
  4789. achievementcategory
  4790. An achievement category, represented by a standard identifier with a 'C' prefix.
  4791. auction
  4792. An auction, represented by a standard identifier with an 'o' prefix.
  4793. boolean
  4794. A value of type 'boolean'.
  4795. buff
  4796. A buff, represented by a standard identifier with a 'b' prefix.
  4797. callbackfunction
  4798. A callback function, used to signal success or failure. Must be a function that takes two parameters, "failure" and "message". On success, "failure" will be false or nil. Otherwise, "failure" will be either a computer-readable string identifier or true. "message" may contain a human-readable message that may be delivered to the user.
  4799. console
  4800. A text console, represented by a standard ID with a 'v' prefix.
  4801. currencycategory
  4802. A currency category, represented by a standard identifier with a 'N' prefix.
  4803. dimensionitem
  4804. A dimension item, represented by a standard identifier with a 'd' prefix.
  4805. error
  4806. An error, represented by a standard ID with an 'x' prefix.
  4807. eventFrame
  4808. A frame event handle.
  4809. eventGlobal
  4810. A global event handle.
  4811. faction
  4812. A faction, represented by a standard ID with an 'f' prefix.
  4813. frameEventTable
  4814. A frame event table of a UI element.
  4815. function
  4816. A value of type 'function'.
  4817. function/nil
  4818. A value of type "function" or "nil".
  4819. function/string
  4820. A value of type "function" or "string".
  4821. function/string/nil
  4822. A value of type "function", "string", or "nil".
  4823. guildrank
  4824. A guild rank, represented by a standard identifier with a 'k' prefix.
  4825. guildwall
  4826. A guild wall ID, represented by a standard identifier with a 'w' prefix.
  4827. handleEventFrame
  4828. A handle for active frame events. Includes the member :GetTarget(), which returns the target frame of this event. If being passed to a .Dive handler, also includes :Halt() and :Catch(). :Halt() halts propogation of the event through the hierarchy and, after finishing the current frame's .Dive handlers, immediately begins processing .Bubble events. :Catch() works similarly but processes main events before continuing to .Bubble. Neither function may be called when the environment is in secure mode and either the current or target frame has a restricted secure mode.
  4829. handleEventGlobal
  4830. A handle for active global events. Currently contains no members.
  4831. item
  4832. An item, represented by either a standard identifier with an 'i' prefix or a slot.
  4833. itemtype
  4834. An item type, represented by a nonstandard identifier with an 'I' prefix.
  4835. location
  4836. A map location, represented by a nonstandard identifier with an 'l' prefix.
  4837. mail
  4838. A mail, represented by a standard identifier with an 'm' prefix.
  4839. nil
  4840. A value of type 'nil'.
  4841. number
  4842. A value of type 'number'. May not be NaN.
  4843. number/nil
  4844. A value of type 'number' or 'nil'. May not be NaN.
  4845. quest
  4846. A quest, represented by a standard identifier with a 'q' prefix.
  4847. role
  4848. A role, represented by a standard identifier with a "h" prefix.
  4849. slot
  4850. An item slot, represented by a nonstandard identifier with an 's' prefix, as generated by the Utility.Item.Slot.* functions.
  4851. string
  4852. A value of type 'string'.
  4853. string/nil
  4854. A value of type 'string' or 'nil'.
  4855. table
  4856. A value of type 'table'.
  4857. title
  4858. A title, represented by a standard identifier with a 't' prefix.
  4859. titlecategory
  4860. A title category, represented by a standard identifier with a 'T' prefix.
  4861. unit
  4862. A unit, represented by either a standard identifier with a 'u' prefix or by a unit specifier. Unit specifiers start with any of "player", "focus", "mouseover", "group01" through "group20", or a standard identifier with a 'u' prefix, and are followed by a chain of any number of ".target", ".pet", or ".owner" modifiers.
  4863. variant
  4864. A value of any type.
  4865. zone
  4866. A zone, represented by a standard identifier with a 'z' prefix.
RAW Paste Data