Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- Basic globals:
- UI.Context
- 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].
- UI.CreateContext
- Function documentation:
- Creates a new UI context. A UI context must be created in order to create any frames.
- context = UI.CreateContext(name) -- Context <- string
- Parameters:
- name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
- Return values:
- context: A new context. Contexts are guaranteed to have at least the capabilities of a Frame.
- UI.CreateFrame
- Function documentation:
- 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.
- List of valid frame types:
- Frame: The base type. No special capabilities. Useful for spacing, organization, input handling, and solid color squares.
- Mask: Obscures the contents of child frames that do not fall within the mask boundaries.
- Text: Displays text.
- Texture: Displays a static texture image.
- RiftButton: A standard Rift button widget.
- RiftCheckbox: A standard Rift checkbox widget.
- RiftScrollbar: A standard Rift scrollbar widget.
- RiftSlider: A standard Rift slider widget.
- RiftTextfield: A standard Rift textfield widget.
- RiftWindow: A standard Rift window widget.
- frame = UI.CreateFrame(type, name, parent) -- Frame <- string, string, Element
- Parameters:
- name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
- parent: The new parent for this frame.
- type: The type of your new frame. Current supported types: Frame, Text, Texture.
- Return values:
- frame: Your new frame.
- UI.Frame
- 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].
- UIParent.Event.Move
- UIParent.Event.Size
- _VERSION
- assert
- bit.arshift
- bit.band
- bit.bnot
- bit.bor
- bit.bswap
- bit.bxor
- bit.lshift
- bit.rol
- bit.ror
- bit.rshift
- bit.tobit
- bit.tohex
- collectgarbage
- coroutine.create
- coroutine.resume
- coroutine.running
- coroutine.status
- coroutine.wrap
- coroutine.yield
- debug.traceback
- dump
- Function documentation:
- Debug utility function. Similar to print(), but serializes any table parameters before outputting.
- dump(...) -- ...
- Parameters:
- ...: Takes any number of any parameter type.
- error
- An error, represented by a standard ID with an 'x' prefix.
- gcinfo
- getfenv
- getmetatable
- ipairs
- load
- loadstring
- math.abs
- math.acos
- math.asin
- math.atan
- math.atan2
- math.ceil
- math.cos
- math.cosh
- math.deg
- math.exp
- math.floor
- math.fmod
- math.frexp
- math.huge
- math.ldexp
- math.log
- math.log10
- math.max
- math.min
- math.modf
- math.pi
- math.pow
- math.rad
- math.random
- math.randomseed
- math.sin
- math.sinh
- math.sqrt
- math.tan
- math.tanh
- math.tau
- newproxy
- next
- os.date
- os.difftime
- os.time
- pairs
- pcall
- print
- rawequal
- rawget
- rawlen
- rawset
- select
- setfenv
- setmetatable
- string.byte
- string.char
- string.find
- string.format
- string.gmatch
- string.gsub
- string.len
- string.lower
- string.match
- string.rep
- string.reverse
- string.sub
- string.upper
- table.concat
- table.foreach
- table.foreachi
- table.getn
- table.insert
- table.maxn
- table.pack
- table.remove
- table.sort
- table.unpack
- tonumber
- tostring
- type
- unpack
- xpcall
- zlib.BEST_COMPRESSION
- zlib.BEST_SPEED
- zlib._COPYRIGHT
- zlib._DESCRIPTION
- zlib._VERSION
- zlib.deflate
- zlib.inflate
- Inspectors:
- Inspect.Ability.New.Detail
- Function documentation:
- Provides detailed information about abilities.
- detail = Inspect.Ability.New.Detail(ability) -- table <- ability
- details = Inspect.Ability.New.Detail(abilities) -- table <- table
- Parameters:
- abilities: A table of identifiers of abilities to retrieve detail for.
- ability: The identifier of the ability to retrieve detail for.
- Return values:
- detail: Detail table for a single ability.
- details: Detail tables for all requested abilities. The key is the ability ID, the value is the ability's detail table.
- Returned members:
- autoattack: Autoattack mode of the ability.
- castingTime: Casting time of the ability, in seconds.
- channeled: Signals that the ability is channeled.
- continuous: Signals that the ability is continuous.
- cooldown: Cooldown of the ability, in seconds.
- costCharge: The amount of charge this ability consumes on use.
- costEnergy: The amount of energy this ability consumes on use.
- costMana: The amount of mana this ability consumes on use.
- costPlanarCharge: The amount of planar charges this ability consumes on use.
- costPower: The amount of power this ability consumes on use.
- currentCooldownBegin: The time the current cooldown started, in the context of Inspect.Time.Frame.
- currentCooldownDuration: Duration of the current cooldown the ability is influenced by, in seconds.
- currentCooldownExpired: Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
- currentCooldownPaused: Indicates that this ability's cooldown is paused.
- currentCooldownRemaining: Time remaining in the ability's current cooldown, in seconds.
- description: Description for the ability.
- gainCharge: Amount of charge gained by using the ability.
- icon: Resource filename of the ability's icon.
- id: The ID of the requested element.
- idNew: The new ability ID.
- name: Name of the ability.
- outOfRange: Signals that the ability is out of range.
- passive: Signals that the ability is passive.
- positioned: Signals that the ability's effect is manually positioned by the user.
- racial: Signals that the ability is a racial ability.
- rangeMax: The maximum range of the ability.
- rangeMin: The minimum range of the ability.
- stealthRequired: Signals that the ability requires the user to be in stealth.
- target: The Unit ID of the unit that this ability will be used on if triggered at this moment.
- unusable: Signals that this ability is unusable.
- weapon: The required equipped weapon for this ability. May be "any", "melee", or "ranged".
- Inspect.Ability.New.List
- Function documentation:
- List available abilities.
- abilities = Inspect.Ability.New.List() -- table <- void
- Return values:
- abilities: A table of IDs of the available abilities.
- Inspect.Achievement.Category.Detail
- Function documentation:
- Returns information about achievement categories.
- detail = Inspect.Achievement.Category.Detail(category) -- table <- achievementcategory
- details = Inspect.Achievement.Category.Detail(categories) -- table <- table
- Parameters:
- categories: A table of identifiers of achievement categories to retrieve detail for.
- category: The identifier of the achievement category to retrieve detail for.
- Return values:
- detail: Detail table for a single achievement category.
- details: Detail tables for all requested achievement categories. The key is the category ID, the value is the category's detail table.
- Returned members:
- id: The ID of the requested element.
- name: The name of the achievement category.
- parent: The category's parent, if it has one.
- Inspect.Achievement.Category.List
- Function documentation:
- Returns a table of valid achievement categories.
- categories = Inspect.Achievement.Category.List() -- table <- void
- Return values:
- categories: Valid achievement categories, in {id = true} format.
- Inspect.Achievement.Detail
- Function documentation:
- Provides detailed information about achievements.
- detail = Inspect.Achievement.Detail(achievement) -- table <- achievement
- details = Inspect.Achievement.Detail(achievements) -- table <- table
- Parameters:
- achievement: The identifier of the achievement to retrieve detail for.
- achievements: A table of identifiers of achievements to retrieve detail for.
- Return values:
- detail: Detail table for a single achievement.
- details: Detail tables for all requested achievements. The key is the achievement ID, the value is the achievement's detail table.
- Returned members:
- alliance: The alliance that this achievement requires, either "guardian", "defiant", or nil.
- category: ID of the achievement's category.
- 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.
- description: The achievement's description.
- icon: Internal name of the achievement's icon.
- id: The ID of the requested element.
- name: The achievement's name.
- previous: The ID of the achievement immediately previous to this in a chain.
- requirement: Table listing the requirements for this achievement. Each item may include multiple members.
- type: The type of the requirement. Valid values include "achievement", "artifactset", "discover", "event", "quest", and "tradeskill".
- name: The name of the requirement.
- count: The count required for completion.
- countDone: The count already completed.
- complete: Signals that this requirement is complete.
- id: The id of whatever this requires.
- score: The number of points this achievement awards for completion.
- sort: A number indicating the order that this achievement should be sorted in.
- title: The ID of the title this achievement awards.
- watch: Signals that this achievement is being watched.
- Inspect.Achievement.List
- Function documentation:
- Returns a table of all known achievements.
- achievements = Inspect.Achievement.List() -- table <- void
- Return values:
- achievements: All known achievements, in {id = true} format.
- Inspect.Addon.Cpu
- Function documentation:
- Returns recent CPU usage information. This is calculated using an exponential-falloff method.
- data = Inspect.Addon.Cpu() -- table <- void
- Return values:
- 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.
- Inspect.Addon.Current
- Function documentation:
- Returns the current addon. This information is used internally for counting CPU usage and determining frame ownership.
- addonIdentifier = Inspect.Addon.Current() -- string <- void
- Return values:
- addonIdentifier: The addon's identifier, as written in its TOC file.
- Inspect.Addon.Detail
- Function documentation:
- Provides detailed information about loaded addons.
- detail = Inspect.Addon.Detail(addon) -- table <- string
- details = Inspect.Addon.Detail(addons) -- table <- table
- Parameters:
- addon: An addon identifier.
- addons: A table containing addon identifiers.
- Return values:
- detail: Detail table for a single addon.
- details: Detail tables for all requested addons. The key is the addon identifier, the value is the addon's detail table.
- Returned members:
- data: The "data" table provided to the addon at load time.
- description: The chosen localization of the TOC Description field.
- id: The ID of the requested element.
- identifier: The addon's identifier.
- name: The chosen localization of the TOC Name field.
- nameShort: The chosen localization of the TOC NameShort field.
- toc: The addon's RiftAddon.toc file, parsed and in table form.
- Inspect.Addon.List
- Function documentation:
- Lists all the addons that the client has loaded.
- addons = Inspect.Addon.List() -- table <- void
- Return values:
- addons: Map of addon identifier to addon version, or "true" if no version is provided.
- Inspect.Attunement.Progress
- Function documentation:
- Returns information on your current attunement progress.
- result = Inspect.Attunement.Progress() -- table <- void
- Return values:
- result: Table containing information on attunement progress.
- Returned members:
- accumulated: Attunement experience accumulated so far in this attunement level.
- available: Number of unused attunement ranks.
- needed: Quantity of attunement experience needed to gain a level.
- rested: Quantity of available attunement rested experience.
- spent: Number of spent attunement ranks.
- Inspect.Auction.Detail
- Function documentation:
- Provides detailed information about auctions.
- Requires the "auction" interaction flag to be set.
- detail = Inspect.Auction.Detail(auction) -- table <- auction
- details = Inspect.Auction.Detail(auctions) -- table <- table
- Parameters:
- auction: An identifier for the auction to retrieve detail for.
- auctions: A table containing auction identifiers to retrieve details for. The value is the sort order.
- Return values:
- detail: Detail table for a single auction.
- details: Detail tables for all requested auctions. The key is the auction ID, the value is the auction's detail table.
- Returned members:
- bid: The current bid on this auction, in silver.
- bidder: Current high bidder on this auction. Available only if your current character is the bidder or the seller.
- buyout: The buyout amount for this auction, in silver.
- id: The ID of the requested element.
- item: ID of the item involved in the auction.
- itemStack: The size of this item stack.
- itemType: The item's type specifier.
- partial: Whether partial buyouts are permitted.
- remaining: Time remaining in the auction, as a number of seconds.
- seller: The name of the auction's seller.
- Inspect.Buff.Detail
- Function documentation:
- Provides detailed information about the buffs on a unit.
- detail = Inspect.Buff.Detail(unit, buff) -- table <- unit, buff
- details = Inspect.Buff.Detail(unit, buffs) -- table <- unit, table
- Parameters:
- buff: An identifier for the buff to retrieve detail for.
- buffs: A table containing buff identifiers to retrieve details for.
- unit: The unit to inspect.
- Return values:
- detail: Detail table for a single buff.
- details: Detail tables for all requested buffs. The key is the buff ID, the value is the buff's detail table.
- Returned members:
- ability: The ID of the ability that created this buff. Not guaranteed to exist.
- begin: The time the buff started, in the context of Inspect.Time.Frame.
- caster: Unit ID of the buff's caster.
- curse: Signals that the buff is a curse.
- debuff: Signals that the buff is a debuff. If this is missing, then it's an actual buff.
- description: Description for the buff. Numbers may not be accurate - see Command.Buff.Describe().
- descriptionComplete: Signals that the buff description is complete.
- disease: Signals that the buff is a disease.
- duration: Duration of the buff in seconds.
- expired: Number of seconds the buff is past its expiration time. Generally indicates lag.
- icon: Resource filename of the buff's icon.
- id: The ID of the requested element.
- name: Name of the buff.
- noncancelable: Signals that the buff cannot be voluntarily canceled. Does not show up for debuffs.
- poison: Signals that the buff is a poison.
- remaining: Time remaining on the buff, in seconds.
- rune: If this buff is created by a rune, the ID of the rune causing it.
- stack: Number of stacks on the buff.
- type: The buff type ID.
- Inspect.Buff.List
- Function documentation:
- List buffs on a unit.
- buffs = Inspect.Buff.List(unit) -- table <- unit
- Parameters:
- unit: The unit to inspect.
- Return values:
- buffs: A table of the IDs of the buffs on the unit.
- Inspect.Console.Detail
- Function documentation:
- Provides detailed information about consoles.
- detail = Inspect.Console.Detail(console) -- table <- console
- details = Inspect.Console.Detail(consoles) -- table <- table
- Parameters:
- console: The identifier of the console to retrieve information for. May also be "general" or "combat".
- consoles: A table of consoles to retrieve detail for.
- Return values:
- detail: Detail table for a single console.
- details: Detail tables for all requested consoles.
- Returned members:
- accolade: Indicates that this console displays Accolade messages.
- achievement: Indicates that this console displays Achievement messages.
- channel: May contain a table of public channels that this console will display. nil if the console does not display any public channels.
- combatBad: Indicates that this console displays Combat Bad messages.
- combatGood: Indicates that this console displays Combat Good messages.
- combatNeutral: Indicates that this console displays Combat Neutral messages.
- combatOther: Indicates that this console displays Combat Other messages.
- combatSpecial: Indicates that this console displays Combat Special messages.
- craftingOther: Indicates that this console displays Crafting Others messages.
- craftingSelf: Indicates that this console displays Crafting Self messages.
- emote: Indicates that this console displays Emote messages.
- experience: Indicates that this console displays Experience messages.
- guild: Indicates that this console displays Guild messages.
- id: The ID of the requested element.
- lootGroup: Indicates that this console displays Group Loot messages.
- lootItem: Indicates that this console displays Item Loot messages.
- lootMoney: Indicates that this console displays Money Loot messages.
- name: The player-chosen name of the console.
- notoriety: Indicates that this console displays Notoriety messages.
- npc: Indicates that this console displays NPC messages.
- officer: Indicates that this console displays Officer messages.
- party: Indicates that this console displays Party messages.
- purchase: Indicates that this console displays Purchase messages.
- raid: Indicates that this console displays Raid messages.
- raidWarning: Indicates that this console displays Raid Warning messages.
- say: Indicates that this console displays Say messages.
- skill: Indicates that this console displays Skill messages.
- system: Indicates that this console displays System messages.
- tell: Indicates that this console displays Tell messages.
- twitter: Indicates that this console displays Twitter messages.
- yell: Indicates that this console displays Yell messages.
- Inspect.Console.List
- Function documentation:
- Returns a table of the current open text consoles.
- consoles = Inspect.Console.List() -- table <- void
- Return values:
- consoles: A table containing the IDs of the available consoles.
- Inspect.Currency.Category.Detail
- Function documentation:
- Returns information about currency categories.
- detail = Inspect.Currency.Category.Detail(category) -- table <- currencycategory
- details = Inspect.Currency.Category.Detail(categories) -- table <- table
- Parameters:
- categories: A table of identifiers of currency categories to retrieve detail for.
- category: The identifier of the currency category to retrieve detail for.
- Return values:
- detail: Detail table for a single currency category.
- details: Detail tables for all requested currency categories. The key is the category ID, the value is the category's detail table.
- Returned members:
- id: The ID of the requested element.
- name: The name of the currency category.
- Inspect.Currency.Category.List
- Function documentation:
- Returns a table of valid currency categories.
- categories = Inspect.Currency.Category.List() -- table <- void
- Return values:
- categories: Valid currency categories, in {id = true} format.
- Inspect.Currency.Detail
- Function documentation:
- Provides detailed information about currencies.
- detail = Inspect.Currency.Detail(coin) -- table <- string
- detail = Inspect.Currency.Detail(currency) -- table <- itemtype
- details = Inspect.Currency.Detail(currencies) -- table <- table
- Parameters:
- coin: The string "coin", used as a value to request the player's money.
- currencies: A table of identifiers of currencies to retrieve detail for.
- currency: The identifier of the currency to retrieve detail for.
- Return values:
- detail: Detail table for a single currency.
- details: Detail tables for all requested currencies. The key is the currency ID, the value is the currency's detail table.
- Returned members:
- category: ID of the currency's category.
- icon: Internal name of the currency's icon.
- id: The ID of the requested element.
- name: The currency's name.
- stack: The number of this currency that you have.
- stackMax: The maximum number of this currency that you can have.
- Inspect.Currency.List
- Function documentation:
- Returns a table of all known currencies.
- currencies = Inspect.Currency.List() -- table <- void
- Return values:
- currencies: All known currencies, in {id = amount} format.
- Inspect.Cursor
- Function documentation:
- Returns the current contents of the cursor.
- type, held = Inspect.Cursor() -- nil, nil <- void
- type, held = Inspect.Cursor() -- string, variant <- void
- Return values:
- held: The blob describing what is currently held. Generally, some kind of identifier used in another part of the addon system.
- type: The current cursor type. Valid values include "ability", "item", "itemtype", and nil.
- Inspect.Dimension.Layout.Detail
- Function documentation:
- Returns details about the specified dimension item.
- detail = Inspect.Dimension.Layout.Details(dimensionitem) -- table <- dimensionitem
- details = Inspect.Dimension.Layout.Details(dimensionitems) -- table <- table
- Parameters:
- dimensionitem: The identifier of the dimension item to retrieve detail for.
- dimensionitems: A table of identifiers of dimension items to retrieve detail for.
- Return values:
- detail: Table of details about the dimension item specified.
- details: Detail table for all requsted dimension items. The key is the dimension item ID, the value is the dimension item's detail table.
- Returned members:
- coordX: The X coordinate of the item.
- coordY: The Y coordinate of the item.
- coordZ: The Z coordinate of the item.
- crated: Indicates that the item is crated.
- icon: Resource filename of the item's icon.
- id: The item's id.
- name: The name of the item.
- pitch: The pitch of the item.
- roll: The roll of the item.
- scale: The scale of the item.
- selected: Indicates that the item is selected.
- type: The type of the item.
- yaw: The yaw of the item.
- Inspect.Dimension.Layout.List
- Function documentation:
- Returns a list of dimension items in the dimension you're currently in, and whether or not they are crated.
- list = Inspect.Dimension.Layout.List() -- table <- void
- Return values:
- list: The list of detail results.
- Inspect.Documentation
- Function documentation:
- 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.
- documentables = Inspect.Documentation() -- table <- void
- documentation = Inspect.Documentation(item) -- string <- variant
- documentation = Inspect.Documentation(item, parseable) -- string <- variant, boolean
- documentationTable = Inspect.Documentation(item, parseable) -- table <- variant, boolean
- Parameters:
- item: The item to get documentation on. May be either the item itself or a string identifier.
- parseable: Whether to return in a computer-readable format, as opposed to the normal human-readable format.
- Return values:
- documentables: List of all items that documentation can be retrieved for. In {["itemname"] = true} format.
- documentation: Documentation for the requested item.
- documentationTable: Computer-readable documentation for the requested item. Format may change without warning.
- Returned members:
- (other): May include many other parameters. These parameters are not yet documented.
- disabled: Boolean that indicates whether this function is disabled for deprecation reasons.
- readable: Human-readable string version of this documentation.
- Inspect.Event.List
- Function documentation:
- Lists the current event handlers for an event.
- result = Inspect.Event.List(event) -- table <- eventGlobal
- Parameters:
- event: A global event handle, usually pulled out of the "Event." hierarchy.
- Return values:
- result: A table of event handlers for this event.
- Returned members:
- handler: The handler that will be called when the event fires.
- label: Label assigned to the event handler at creation.
- owner: Owner addon for the event handler.
- priority: Priority for the event handler.
- Inspect.Experience
- Function documentation:
- Returns information on your experience.
- result = Inspect.Experience() -- table <- void
- Return values:
- result: Table containing information on experience.
- Returned members:
- accumulated: Experience accumulated so far in this character level.
- needed: Quantity of experience needed to gain a level.
- rested: Quantity of available rested experience.
- Inspect.Faction.Detail
- Function documentation:
- Provides detailed information about factions.
- detail = Inspect.Faction.Detail(faction) -- table <- faction
- details = Inspect.Faction.Detail(factions) -- table <- table
- Parameters:
- faction: The identifier of the faction to retrieve detail for.
- factions: A table of identifiers of factions to retrieve detail for.
- Return values:
- detail: Detail table for a single faction.
- details: Detail tables for all requested factions. The key is the faction ID, the value is the faction's detail table.
- Returned members:
- categoryName: Name of the faction's category.
- id: The ID of the requested element.
- name: The faction's name.
- notoriety: The current notoriety you have with this faction.
- Inspect.Faction.List
- Function documentation:
- Returns a table of all known factions.
- factions = Inspect.Faction.List() -- table <- void
- Return values:
- factions: All known factions, in {id = notoriety} format.
- Inspect.Guild.Bank.Coin
- Function documentation:
- Returns the amount of money contained within the guild bank.
- Requires the "guildbank" interaction flag to be set.
- coin = Inspect.Guild.Bank.Coin() -- number <- void
- Return values:
- coin: The current money in the guild bank, in silver.
- Inspect.Guild.Bank.Detail
- Function documentation:
- Provides detailed information about guild bank vaults.
- detail = Inspect.Guild.Bank.Detail(guildvault) -- table <- slot
- details = Inspect.Guild.Bank.Detail(guildvaults) -- table <- table
- Parameters:
- guildvault: A slot specifier representing the entire guild bank vault to retrieve information for.
- guildvaults: A table of slot specifiers, each representing an entire guild bank vault, to retrieve information for.
- Return values:
- detail: Detail table for a guild bank vault.
- details: Detail tables for all requested guild bank vault. The key is the vault specifier, the value is the vault's detail table.
- Returned members:
- id: The ID of the requested element.
- name: The name of the vault.
- Inspect.Guild.Bank.List
- Function documentation:
- Returns a table of all available guild bank vaults.
- list = Inspect.Guild.Bank.List() -- table <- void
- Return values:
- list: All available guild vaults, in {id = name} format.
- Inspect.Guild.Motd
- Function documentation:
- Returns the current guild Message of the Day.
- motd = Inspect.Guild.Motd() -- string <- void
- Return values:
- motd: The current Message of the Day.
- Inspect.Guild.Rank.Detail
- Function documentation:
- Provides detailed information about guild ranks.
- detail = Inspect.Guild.Rank.Detail(guildrank) -- table <- guildrank
- details = Inspect.Guild.Rank.Detail(guildranks) -- table <- table
- Parameters:
- guildrank: The identifier of the rank to retrieve detail for.
- guildranks: A table of identifiers of ranks to retrieve detail for.
- Return values:
- detail: Detail table for a single rank.
- details: Detail table for all requested ranks. The key is the rank ID, the value is the rank's detail table.
- Returned members:
- addonStorageDelete: Signals that this rank has permission to modify or delete addon storage elements.
- addonStorageWrite: Signals that this rank has permission to non-destructively write addon storage elements.
- demote: Signals that this rank has permission to demote guildmembers.
- finderEdit: Signals that this rank has permission to edit the Guild Finder settings.
- finderReceive: Signals that this rank has permission to receive Guild Finder messages.
- id: The ID of the requested element.
- invite: Signals that this rank has permission to invite new guildmembers.
- kick: Signals that this rank has permission to kick guildmembers.
- listen: Signals that this rank has permission to listen to guild chat.
- motd: Signals that this rank has permission to change the guild Message of the Day.
- name: The name of this rank.
- noteOfficer: Signals that this rank has permission to view and edit Officer Notes.
- officer: Signals that this rank has permission to listen to and speak in officer chat.
- perk: Signals that this rank has permission to choose guild perks.
- promote: Signals that this rank has permission to promote guildmembers.
- questAbandon: Signals that this rank has permission to abandon guild quests.
- questAccept: Signals that this rank has permission to accept guild quests.
- questComplete: Signals that this rank has permission to complete guild quests.
- rally: Signals that this rank has permission to set the guild rally point.
- rankEdit: Signals that this rank has permission to edit rank permissions.
- rename: Signals that this rank has permission to rename the guild.
- speak: Signals that this rank has permission to speak in guild chat.
- 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.
- vaultBuy: Signals that this rank has permission to buy guild vaults.
- vaultRename: Signals that this rank has permission to rename guild vaults.
- wallDelete: Signals that this rank has permission to delete entries off the Guild Wall.
- wallPost: Signals that this rank has permission to post to the Guild Wall.
- Inspect.Guild.Rank.List
- Function documentation:
- Lists available guild ranks.
- list = Inspect.Guild.Rank.List() -- table <- void
- Return values:
- list: A table of the IDs of the available ranks. The value is the rank's name.
- Inspect.Guild.Roster.Detail
- Function documentation:
- Provides detailed information about guildmembers.
- detail = Inspect.Guild.Roster.Detail(guildmember) -- table <- string
- details = Inspect.Guild.Roster.Detail(guildmembers) -- table <- table
- Parameters:
- guildmember: The name of the guildmember to retrieve data for.
- guildmembers: A table of names of guildmembers to retrieve data for.
- Return values:
- detail: Detail table for a single guildmember.
- details: Detail tables for all requested guildmembers. The key is the guildmember's name, the value is the guildmember's detail table.
- Returned members:
- id: The ID of the requested element.
- level: The guildmember's level.
- logout: The guildmember's last logout time, in UNIX time.
- name: The guildmember's name.
- note: The guildmember's public note.
- noteOfficer: The guildmember's officer note.
- rank: The guildmember's rank.
- score: The guildmember's achievement score.
- status: The guildmember's current status. May include "online" or "mobile". nil if the guildmember is offline.
- zone: The guildmember's current zone, if online.
- Inspect.Guild.Roster.List
- Function documentation:
- Lists guildmembers.
- list = Inspect.Guild.Roster.List() -- table <- void
- Return values:
- list: A table listing all your guildmembers. The key is the guildmember's name, the value is the guildmember's status.
- Inspect.Interaction
- Function documentation:
- Provides information about what types of interaction are available.
- interactions = Inspect.Interaction() -- table <- void
- status = Inspect.Interaction(interaction) -- boolean <- string
- Parameters:
- interaction: Optional name of the interaction type to query. Valid values include "auction", "bank", "guildbank", and "mail".
- Return values:
- interactions: Table from interaction type to indicator of whether that interaction is available.
- status: Whether or not that interaction type is available.
- Inspect.Item.Detail
- Function documentation:
- Provides detailed information about items.
- item = Inspect.Item.Detail(item) -- table <- item
- item = Inspect.Item.Detail(itemtype) -- table <- itemtype
- item = Inspect.Item.Detail(slot) -- table <- slot
- items = Inspect.Item.Detail(slot) -- table <- slot
- items = Inspect.Item.Detail(elements) -- table <- table
- Parameters:
- elements: A table of slot specifiers, item IDs, or item types.
- item: A single item ID.
- itemtype: A single item type.
- slot: A single slot specifier.
- Return values:
- item: Detail table for a single item.
- items: Detail tables for all requested items. The key is the string used to lookup, the value is the item's detail table.
- Returned members:
- bind: The item's binding type. May be "equip", "use", "pickup", or "account".
- bound: The item's bound flag.
- category: The item's type category.
- coin: The amount of silver this item represents.
- cooldown: The cooldown for using this item.
- cooldownBegin: The time the current cooldown started, in the context of Inspect.Time.Frame.
- cooldownDuration: Duration of the current cooldown the item is influenced by, in seconds.
- cooldownExpired: Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
- cooldownRemaining: Time remaining in the item's current cooldown, in seconds.
- crafter: The name of the player who crafted this item.
- damageDelay: If a weapon, the delay between autoattacks using this weapon.
- damageMax: If a weapon, the maximum damage done by a single hit with this item.
- damageMin: If a weapon, the minimum damage done by a single hit with this item.
- damageType: If a weapon, the damage type done by autoattacks. Values include "life", "death", "air", "earth", "fire", and "water".
- description: The description of this item.
- flavor: The flavor text for this item.
- icon: Resource filename of the item's icon.
- id: The ID of the requested element.
- lootable: Indicates that the item contains loot.
- name: The item's name.
- range: If a ranged weapon, the maximum range of this item.
- rarity: The item's rarity. Values include "sellable", "uncommon", "rare", "epic", "relic", "transcendent", or "quest". Common items have a rarity of nil.
- requiredCalling: Space-delimited list of the required callings to use this item.
- requiredFaction: The ID of the faction required to use this item.
- requiredFactionLevel: The faction notoriety required to use this item.
- requiredLevel: The level required to use this item.
- requiredPrestige: The prestige rank required to use this item.
- requiredSkill: The skill required to use this item.
- requiredSkillLevel: The skill level required to use this item.
- sell: The sell value of this item, in silver.
- slots: If a container, the number of slots that this item can contain.
- stack: The size of this item stack.
- stackMax: The maximum size of this item stack.
- 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".
- statsRune: The added rune stats of this item. May contain the same members as stats.
- statsRuneTemporary: The added temporary rune stats of this item. May contain the same members as stats.
- type: The item's type specifier.
- Inspect.Item.Find
- Function documentation:
- Finds a slot specifier based on an item ID.
- slot = Inspect.Item.Find(item) -- slot <- item
- slots = Inspect.Item.Find(items) -- table <- table
- Parameters:
- item: A single item ID.
- items: A table of item IDs.
- Return values:
- slot: A slot specifier for that item.
- slots: Slot specifiers for all requested items. The key is the string used to lookup, the value is the slot specifier.
- Inspect.Item.List
- Function documentation:
- Generate a list of item IDs from a slot specifier or set of slot specifiers.
- items = Inspect.Item.List() -- table <- void
- item = Inspect.Item.List(slot) -- item <- slot
- items = Inspect.Item.List(slot) -- table <- slot
- items = Inspect.Item.List(slots) -- table <- table
- Parameters:
- slot: A single slot specifier.
- slots: A table of slot specifiers.
- Return values:
- item: A single item ID. This will be returned only if the input is a single fully-specified slot specifier.
- items: A table of item IDs. The key is the slot specifier, the value is the item ID.
- Inspect.Mail.Detail
- Function documentation:
- Returns information about mail.
- Requires the "mail" interaction flag to be set.
- detail = Inspect.Mail.Detail(mail) -- table <- mail
- details = Inspect.Mail.Detail(mails) -- table <- table
- Parameters:
- mail: The identifier of the mail to retrieve detail for.
- mails: A table of identifiers of mail to retrieve detail for.
- Return values:
- detail: Detail table for a single mail.
- details: Detail tables for all requested mail. The key is the mail ID, the value is the mail's detail table.
- Returned members:
- 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.
- body: The body of this mail. Available only if detailed information on the mail has been retrieved.
- cod: The Cash on Delivery required to retrieve attachments out of this mail message.
- expire: The time this mail will expire, in Unix timestamp form.
- from: The name of the character this mail was sent from.
- id: The ID of the requested element.
- read: "true" if you have already opened this mail.
- spam: "true" if this mail is considered spam.
- subject: The subject line for this mail.
- Inspect.Mail.List
- Function documentation:
- Returns a table of valid mail and its status.
- Requires the "mail" interaction flag to be set.
- mails = Inspect.Mail.List() -- table <- void
- Return values:
- 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.
- Inspect.Map.Detail
- Function documentation:
- Returns information about map locations.
- detail = Inspect.Map.Detail(location) -- table <- location
- details = Inspect.Map.Detail(locations) -- table <- table
- Parameters:
- location: The identifier of the location to retrieve detail for.
- locations: A table of identifiers of locations to retrieve detail for.
- Return values:
- detail: Detail table for a single location.
- details: Detail tables for all requested locations. The key is the location ID, the value is the location's detail table.
- Returned members:
- coordX: The map location's current X coordinate.
- coordY: The map location's current Y coordinate.
- coordZ: The map location's current Z coordinate.
- description: The description of this map location, if it has one.
- id: The ID of the requested element.
- title: The title of this map location, if it has one.
- Inspect.Map.List
- Function documentation:
- Returns a table of map locations.
- list = Inspect.Map.List() -- table <- void
- Return values:
- list: Valid locations, in {id = true} format.
- Inspect.Map.Monitor
- Function documentation:
- Inspects the state of the map monitor flag. See Command.Map.Monitor() for details.
- monitor = Inspect.Map.Monitor() -- boolean <- void
- Return values:
- monitor: The current state of the map monitor flag.
- Inspect.Map.Waypoint.Get
- Function documentation:
- Gets a unit's current waypoint.
- x, z = Inspect.Map.Waypoint.Get(unit) -- number, number <- unit
- Parameters:
- unit: A unit, in either unit ID or unit specifier format.
- Return values:
- x: The x coordinate of the waypoint.
- z: The z coordinate of the waypoint.
- Inspect.Message.Accept.Check
- Function documentation:
- 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.
- accepted = Inspect.Message.Accept.Check(type, identifier) -- boolean <- string/nil, string/nil
- Parameters:
- 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.
- type: The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
- Return values:
- accepted: True if the message would be transferred to this client.
- Inspect.Message.Accept.List
- Function documentation:
- Retrieves the list of accepted message types and identifiers.
- accepts = Inspect.Message.Accept.List() -- table <- void
- Return values:
- 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.
- Inspect.Mouse
- Function documentation:
- Returns information about the current mouse position and button state.
- results = Inspect.Mouse() -- table <- void
- Return values:
- results: Table containing the current mouse state. May include members x, y, Left, Right, Middle, Mouse4, Mouse5.
- Inspect.Pvp.History
- Function documentation:
- Returns information on your PVP history.
- result = Inspect.Pvp.History() -- table <- void
- Return values:
- result: Table containing information on PVP history.
- Returned members:
- favorLifetime: Amount of lifetime favor accumulated.
- killLifetime: Amount of kills made on this character.
- killMonth: Amount of kills made on this character within the last month.
- killToday: Amount of kills made on this character within the last day.
- killWeek: Amount of kills made on this character within the last week.
- Inspect.Pvp.Prestige
- Function documentation:
- Returns information on your PVP prestige.
- result = Inspect.Pvp.Prestige() -- table <- void
- Return values:
- result: Table containing information on prestige.
- Returned members:
- accumulated: Prestige accumulated so far in this rank.
- needed: Quantity of prestige needed to gain a rank.
- rank: Current prestige rank.
- Inspect.Quest.Complete
- Function documentation:
- Returns a table of all quests completed.
- quests = Inspect.Quest.Complete() -- table <- void
- Return values:
- 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).
- Inspect.Quest.Detail
- Function documentation:
- Provides detailed information about a quest.
- detail = Inspect.Quest.Detail(quest) -- table <- quest
- details = Inspect.Quest.Detail(quests) -- table <- table
- Parameters:
- quest: The quest to retrieve detail for.
- quests: A table of quests to retrieve detail for.
- Return values:
- detail: Detail table for a single quest.
- details: Detail tables for all requested quests.
- Returned members:
- categoryName: The name of the category this quest is placed under.
- complete: Signals that this quest is complete.
- description: The long description for this quest.
- domain: The quest's domain. May be "area", "guild", "instant", or "zone". Personal quests are signaled with nil.
- failed: Signals that this quest has failed.
- id: The ID of the requested element.
- mode: This quest's mode, if it has a special mode. May be "story" or "soul".
- name: The name of this quest.
- 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.
- rewardChoose: Lists the possible reward choices for the player. The key is the item type, the value is the count.
- rewardCoin: The amount of silver this quest's completion will award.
- rewardExperience: The amount of experience this quest's completion will award.
- rewardExperienceGuild: The amount of guild experience this quest's completion will award.
- rewardFavor: The amount of favor this quest's completion will award.
- rewardGuaranteed: Lists the guaranteed rewards for the player. The key is the item type, the value is the count.
- 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.
- rewardPrestige: The amount of prestige this quest's completion will award.
- summary: The short summary for this quest.
- tag: The quest's tags, space-separated.
- tagName: The quest's tags, localized.
- track: Signals that this quest is being manually tracked.
- watch: Signals that this quest is being watched.
- Inspect.Quest.List
- Function documentation:
- Lists the player's current active quests.
- quests = Inspect.Quest.List() -- table <- void
- Return values:
- quests: A table containing the player's current quests.
- Inspect.Queue.Handler
- Function documentation:
- Returns the current queue handler function.
- handler, owner = Inspect.Queue.Handler() -- function, string <- void
- Return values:
- handler: The current queue handler function.
- owner: The owner of the current queue handler function.
- Inspect.Queue.Status
- Function documentation:
- Inspects the current queue status. Omit the first parameter to get a table containing information on all queues.
- results = Inspect.Queue.Status() -- table <- void
- result = Inspect.Queue.Status(queue) -- boolean <- string
- results = Inspect.Queue.Status(queue, size) -- table <- string, number
- Parameters:
- queue: Optional identifier of the queue to query. Valid values include "global" and "auctionfullscan".
- size: The size of the element to test in this queue. Defaults to 1 if no size is provided.
- Return values:
- result: false if this queue is throttled, non-false otherwise.
- 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.
- Inspect.Role.List
- Function documentation:
- Lists the player's roles.
- roles = Inspect.Role.List() -- table <- void
- Return values:
- roles: A table containing the player's roles. The key is the role ID, the value is the role name.
- Inspect.Setting.Detail
- Function documentation:
- Provides detailed information about a setting.
- detail = Inspect.Setting.Detail(setting) -- table <- string
- details = Inspect.Setting.Detail(settings) -- table <- table
- Parameters:
- setting: The setting to retrieve detail for.
- settings: A table of settings to retrieve detail for.
- Return values:
- detail: Detail table for a single setting.
- details: Detail tables for all requested settings.
- Returned members:
- id: The ID of the requested element.
- value: The value of the requested element.
- Inspect.Setting.List
- Function documentation:
- Lists the player's current settings.
- settings = Inspect.Setting.List() -- table <- void
- Return values:
- settings: A table containing the player's current settings.
- Inspect.Shard
- Function documentation:
- Returns information about the current shard.
- shard = Inspect.Shard() -- table <- void
- Return values:
- shard: Table containing requested data.
- Returned members:
- name: The shard's name.
- pvp: Signals that the shard is a PvP shard.
- rp: Signals that the shard is a roleplaying shard.
- Inspect.Social.Friend.Detail
- Function documentation:
- Provides detailed information about a friend.
- detail = Inspect.Social.Friend.Detail(friend) -- table <- string
- details = Inspect.Social.Friend.Detail(friends) -- table <- table
- Parameters:
- friend: The name of a friend to retrieve detail for.
- friends: A table of names of friends to retrieve detail for.
- Return values:
- detail: Detail table for a single friend.
- details: Detail tables for all requested friends.
- Returned members:
- calling: The friend's calling, if known.
- guild: The friend's current guild.
- id: The ID of the requested element.
- level: The friend's current level, if known.
- name: The friend's name.
- note: The friend's personal note.
- race: The friend's race, if known.
- status: The friend's status. Either "online", "afk", or nil.
- zone: The friend's current zone, if known.
- Inspect.Social.Friend.List
- Function documentation:
- Lists the player's current friends.
- friends = Inspect.Social.Friend.List() -- table <- void
- Return values:
- friends: A table containing the player's current friends.
- Inspect.Social.Ignore.Detail
- Function documentation:
- Provides detailed information about an ignored player.
- detail = Inspect.Social.Ignore.Detail(ignore) -- table <- string
- details = Inspect.Social.Ignore.Detail(ignores) -- table <- table
- Parameters:
- ignore: The name of an ignored player to retrieve detail for.
- ignores: A table of names of ignored players to retrieve detail for.
- Return values:
- detail: Detail table for a single ignored player.
- details: Detail tables for all requested ignored players.
- Returned members:
- id: The ID of the requested element.
- name: The ignored player's name.
- note: The ignored player's personal note.
- Inspect.Social.Ignore.List
- Function documentation:
- Lists the player's current ignored players.
- ignores = Inspect.Social.Ignore.List() -- table <- void
- Return values:
- ignores: A table containing the player's current ignored players.
- Inspect.Stat
- Function documentation:
- Returns information about the player's stats.
- results = Inspect.Stat() -- table <- void
- result = Inspect.Stat(stat) -- number <- string
- Parameters:
- 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.
- Return values:
- result: The current value of that stat.
- results: A table from stat ID to stat value, containing all the player's stats.
- Inspect.Storage.Used
- Function documentation:
- Returns the storage space currently used for a given segment.
- current, maximum = Inspect.Storage.Used(segment) -- number, number <- string
- Parameters:
- 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.
- Return values:
- current: Current storage space used.
- maximum: Maximum storage space available.
- Inspect.System.Error.Detail
- Function documentation:
- Provides detailed information about an addon error.
- detail = Inspect.System.Error.Detail(error) -- table <- error
- details = Inspect.System.Error.Detail(errors) -- table <- table
- Parameters:
- error: The error to be inspected.
- errors: A table of errors to retrieve detail for.
- Return values:
- detail: Detail table for a single error. Member documentation can be found in Event.System.Error.
- details: Detail tables for all requested errors.
- Inspect.System.Language
- Function documentation:
- Returns the client's current language.
- language = Inspect.System.Language() -- string <- void
- Return values:
- language: Current language. Valid values include "English", "French", "German", "Korean", "Russian", "Chinese", and "Taiwanese".
- Inspect.System.Secure
- Function documentation:
- Returns the client's current secure mode.
- secure = Inspect.System.Secure() -- boolean <- void
- Return values:
- secure: The current secure mode.
- Inspect.System.Version
- Function documentation:
- Returns information on the client version.
- version = Inspect.System.Version() -- table <- void
- Return values:
- version: A table containing detailed version information.
- Returned members:
- build: Client build information.
- external: Client external version.
- internal: Client internal version.
- Inspect.System.Watchdog
- Function documentation:
- Returns the number of seconds until the system watchdog may begin generating warnings.
- time = Inspect.System.Watchdog() -- number <- void
- Return values:
- time: Time left in seconds.
- Inspect.TEMPORARY.Experience
- Function documentation:
- Returns information about the player's experience.
- This function is deprecated and will be removed in the future. It should not be used.
- accumulated, rested, needed = Inspect.TEMPORARY.Experience() -- number, number, number <- void
- Return values:
- accumulated: The amount of experience that has accumulated towards the next level.
- needed: The amonut of experience required to reach the next level.
- rested: The amount of rested experience that has accumulated.
- Inspect.TEMPORARY.Role
- Function documentation:
- Returns the ID of the player's current role.
- This function will be removed in the future.
- role = Inspect.TEMPORARY.Role() -- number <- void
- Return values:
- role: The ID of the player's current role.
- Inspect.Time.Frame
- Function documentation:
- The game time of the last frame. This function's return value will not change until the next frame.
- time = Inspect.Time.Frame() -- number <- void
- Return values:
- time: Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.
- Inspect.Time.Real
- Function documentation:
- A high-resolution realtime timer. Not measured in the same timespace as Inspect.Time.Frame.
- time = Inspect.Time.Real() -- number <- void
- Return values:
- time: Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.
- Inspect.Time.Server
- Function documentation:
- Returns the current server time.
- time = Inspect.Time.Server() -- number <- void
- Return values:
- time: Server time, as seconds from the Unix epoch.
- Inspect.Title.Category.Detail
- Function documentation:
- Provides detailed information about a title category.
- detail = Inspect.Title.Category.Detail(titlecategory) -- table <- titlecategory
- details = Inspect.Title.Category.Detail(titlecategories) -- table <- table
- Parameters:
- titlecategories: A table of title categories to retrieve details for.
- titlecategory: The title category to retrieve detail for.
- Return values:
- detail: Detail table for a single title category.
- details: Detail tables for all requested title categories.
- Returned members:
- id: The ID of the required element.
- name: The name of the title category.
- Inspect.Title.Category.List
- Function documentation:
- Lists known title categories.
- titlecategories = Inspect.Title.Category.List() -- table <- void
- Return values:
- titlecategories: A lookup table of known title categories.
- Inspect.Title.Detail
- Function documentation:
- Provides detailed information about a title.
- detail = Inspect.Title.Detail(title) -- table <- title
- details = Inspect.Title.Detail(titles) -- table <- table
- Parameters:
- title: The title ID to retrieve detail for.
- titles: A table of title IDs to retrieve detail for.
- Return values:
- detail: Detail table for a single title.
- details: Detail tables for all requested titles.
- Returned members:
- gameFemale: The title as seen ingame and applied to female characters.
- gameMale: The title as seen ingame and applied to male characters.
- id: The ID of the requested element.
- nameFemale: The title as seen in menus and applied to female characters.
- nameMale: The title as seen in menus and applied to male characters.
- prefix: Signals that the title is a prefix title.
- Inspect.Title.List
- Function documentation:
- Lists the player's currently available titles.
- titles = Inspect.Title.List() -- table <- void
- Return values:
- titles: A lookup table of all available titles.
- Inspect.Tooltip
- Function documentation:
- Returns the current contents of the tooltip.
- type, shown = Inspect.Tooltip() -- nil, nil <- void
- type, shown = Inspect.Tooltip() -- string, variant <- void
- type, unit, buff = Inspect.Tooltip() -- string, unit, buff <- void
- Return values:
- buff: The ID of the tooltip's buff.
- shown: The blob describing what is currently shown. Generally, some kind of identifier used in another part of the addon system.
- type: The current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".
- unit: The unit that the buff is attached to.
- Inspect.Unit.Castbar
- Function documentation:
- Provides detailed information about a unit's castbar.
- detail = Inspect.Unit.Castbar(unit) -- table <- unit
- details = Inspect.Unit.Castbar(units) -- table <- table
- Parameters:
- unit: A unit, in either unit ID or unit specifier format.
- units: A table containing units to inspect.
- Return values:
- detail: Detail table for a single castbar.
- details: Detail tables for all requested castbars. The key is the unit ID or unit specifier, the value is the castbar's detail table.
- Returned members:
- ability: ID of the ability being cast, if available.
- abilityName: Name of the ability being cast.
- begin: The time the cast started, in the context of Inspect.Time.Frame.
- channeled: True if this ability is channeled.
- duration: Duration of the cast in seconds.
- expired: Number of the seconds the cast is past its completion time. Generally indicates lag.
- remaining: Time remaining on the cast, in seconds.
- uninterruptible: Signals that the cast is not interruptible.
- Inspect.Unit.Detail
- Function documentation:
- Provides detailed information about a unit.
- detail = Inspect.Unit.Detail(unit) -- table <- unit
- details = Inspect.Unit.Detail(units) -- table <- table
- Parameters:
- unit: A unit, in either unit ID or unit specifier format.
- units: A table containing units to inspect.
- Return values:
- detail: Detail table for a single unit.
- details: Detail tables for all requested units. The key is the unit ID or unit specifier, the value is the unit's detail table.
- Returned members:
- absorb: The unit's damage absorption.
- afk: Signals that the unit is AFK. Provided only for the player and the player's groupmembers.
- aggro: Signals that this unit is being attacked. Provided only for groupmembers.
- alliance: The unit's alliance. "defiant", "guardian", or nil.
- availability: The unit's current availability. See Utility.Unit.Availability() for details.
- blocked: Signals that this unit is not in line of sight. Provided only for groupmembers.
- calling: The unit's calling. May be "mage", "rogue", "cleric", or "warrior".
- charge: The unit's charge. Provided only for the player.
- chargeMax: The unit's maximum charge. Provided only for the player.
- combat: The unit's combat status.
- combo: The unit's combo points. Provided only for the player.
- coordX: The unit's current X coordinate.
- coordY: The unit's current Y coordinate.
- coordZ: The unit's current Z coordinate.
- energy: The unit's energy.
- energyMax: The unit's maximum energy.
- factionId: The unit's faction ID.
- guaranteedLoot: Signals that this unit guarantees loot on death. Shown in the user interface as a diamond above the portrait.
- guild: The unit's guild.
- health: The unit's health.
- healthCap: The unit's capped maximum health.
- healthMax: The unit's maximum health.
- id: The ID of the requested element.
- level: The unit's level. May be "??" if the unit is hostile and very high-level.
- locationName: The name of the unit's location. Provided only for friendly players.
- loot: The Unit ID that has looting rights to this corpse.
- mana: The unit's mana.
- manaMax: The unit's maximum mana.
- mark: The mark on this unit.
- mentoring: The unit's mentoring status.
- name: The unit's name.
- nameSecondary: The unit's secondary name.
- offline: Signals that the unit is offline. Provided only for the player's groupmembers.
- planar: The unit's available planar charges. Provided only for the player or groupmembers.
- planarMax: The unit's maximum planar charges. Provided only for the player or groupmembers.
- player: Signals that the unit is a player, not an NPC.
- power: The unit's power.
- publicSize: The unit's current public group size. nil if the group is not public. Provided only for friendly players.
- pvp: The unit's PvP flag.
- race: The unit's race. Provided only for players.
- raceName: The unit's race, localized. Provided only for players.
- radius: The unit's radius.
- ready: The unit's readycheck status.
- relation: The unit's relation to you. May be "hostile" or "friendly". Neutral targets will not have this member.
- role: The unit's role. May be "tank", "heal", "dps", "support", or nil. Provided only for the player and the player's groupmembers.
- tag: The unit's tags, space-separated.
- tagName: The unit's tags, localized.
- 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.
- tier: The unit's difficulty tier. nil, "group", or "raid".
- titlePrefixId: The unit's title prefix ID.
- titlePrefixName: The unit's localized title prefix.
- titleSuffixId: The unit's title suffix ID.
- titleSuffixName: The unit's localized title suffix.
- type: The unit type ID.
- vitality: The unit's vitality. Provided only for the player or groupmembers.
- warfront: Signals that the unit has temporarily left the group to join a warfront. Provided only for groupmembers.
- zone: The ID of the unit's current zone.
- Inspect.Unit.List
- Function documentation:
- Lists all the units that the client can see.
- list = Inspect.Unit.List() -- table <- void
- Return values:
- list: Map of unit ID to unit specifier. Units with multiple valid specifiers will have one chosen at random.
- Inspect.Unit.Lookup
- Function documentation:
- Converts unit IDs to unit specifiers and vice-versa.
- unit = Inspect.Unit.Lookup(unit) -- unit <- unit
- units = Inspect.Unit.Lookup(units) -- table <- table
- Parameters:
- unit: A single unit ID or unit specifier.
- units: A table containing unit IDs and unit specifiers.
- Return values:
- unit: A unit ID or unit specifier, whichever is the opposite of the parameter given. May be nil.
- 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.
- Inspect.Zone.Detail
- Function documentation:
- Returns information about zones.
- detail = Inspect.Zone.Detail(zone) -- table <- zone
- details = Inspect.Zone.Detail(zones) -- table <- table
- Parameters:
- zone: The identifier of the zone to retrieve detail for.
- zones: A table of identifiers of zones to retrieve detail for.
- Return values:
- detail: Detail table for a single zone.
- details: Detail tables for all requested zones. The key is the zone ID, the value is the zone's detail table.
- Returned members:
- id: The ID of the requested element.
- name: The name of the zone.
- type: The type of this zone. May be either "instance", "warfront", or nil.
- Commands:
- Command.Achievement.Watch
- Function documentation:
- Watches an achievement, possibly unwatching another item if the player is already watching the maximum item count. Permitted only on unfinished achievements.
- Command.Achievement.Watch(achievement, flag) -- achievement, boolean
- Parameters:
- achievement: The achievement to be affected.
- flag: The new watch status.
- Command.Auction.Analyze
- Function documentation:
- 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.
- Requires the "auction" interaction flag to be set.
- Command.Auction.Analyze(itemtype, begin, end) -- itemtype, number, number
- Command.Auction.Analyze(itemtype, begin, end, callback) -- itemtype, number, number, callbackfunction
- Parameters:
- begin: UNIX timestamp to begin analysis at.
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- end: UNIX timestamp to end analysis at.
- itemtype: Item type to analyze.
- Command.Auction.Bid
- Function documentation:
- Bids or buys out an auction.
- Requires the "auction" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Auction.Bid(auction, bid) -- auction, number
- Command.Auction.Bid(auction, bid, quantity) -- auction, number, number
- Command.Auction.Bid(auction, bid, callback) -- auction, number, callbackfunction
- Command.Auction.Bid(auction, bid, quantity, callback) -- auction, number, number, callbackfunction
- Parameters:
- auction: The auction to be targeted.
- bid: The amount to bid. To place a buyout, simply bid the buyout value.
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- quantity: How many items to purchase. If omitted, defaults to the entire auction quantity.
- Command.Auction.Cancel
- Function documentation:
- Cancels an auction.
- Requires the "auction" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Auction.Cancel(auction) -- auction
- Command.Auction.Cancel(auction, callback) -- auction, callbackfunction
- Parameters:
- auction: The auction to be targeted.
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- Command.Auction.Fulfill
- Function documentation:
- Fulfills an existing buy order.
- Requires the "auction" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Auction.Fulfill(auction, item, quantity) -- auction, item, number
- Command.Auction.Fulfill(auction, item, quantity, callback) -- auction, item, number, callbackfunction
- Parameters:
- auction: The auction to be targeted.
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- item: The ID of the item to be taken.
- quantity: Stack size to fulfill.
- Command.Auction.Order
- Function documentation:
- Posts a new buy order.
- Requires the "auction" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Auction.Order(itemtype, quantity, time, buyout) -- itemtype, number, number, number
- Command.Auction.Order(itemtype, quantity, time, buyout, callback) -- itemtype, number, number, number, callbackfunction
- Parameters:
- buyout: The total buyout for the new auction, in silver. Must be evenly divisible by quantity.
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- itemtype: The item type to be ordered.
- quantity: The number of items to be ordered.
- time: The duration that the order should last, in hours. Valid values are limited to 12, 24, and 48.
- Command.Auction.Post
- Function documentation:
- Posts a new auction.
- Requires the "auction" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Auction.Post(item, time, bid, buyout) -- item, number, number/nil, number/nil
- Command.Auction.Post(item, time, bid, buyout, partial) -- item, number, number/nil, number/nil, boolean
- Command.Auction.Post(item, time, bid, buyout, callback) -- item, number, number/nil, number/nil, callbackfunction
- Command.Auction.Post(item, time, bid, buyout, partial, callback) -- item, number, number/nil, number/nil, boolean, callbackfunction
- Parameters:
- bid: The minimum bid for the new auction, in silver. nil if no bid is desired.
- buyout: The buyout for the new auction, in silver. nil if no buyout is desired.
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- item: The ID of the item to be auctioned.
- 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.
- time: The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.
- Command.Auction.Scan
- Function documentation:
- 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.
- 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.*.
- Requires the "auction" interaction flag to be set.
- Command.Auction.Scan(parameters) -- table
- Parameters:
- parameters: Table containing data about the requested scan.
- type: Type of scan to perform. One of "bids", "buy", "mine", "orders", or "search".
- If type is "bids", "mine", or "orders", no other parameters are allowed.
- If type is "search":
- category: Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional.
- index: Numeric item index to start the scan at. If provided, the auction scan will return the first 50 items immediately following this index.
- levelMax: Maximum level the item must require. Optional.
- levelMin: Minimum level the item must require. Optional.
- priceMax: Maximum price of the item. Optional.
- priceMin: Minimum price of the item. Optional.
- rarity: The minimum rarity to search for. Same as the "rarity" member returned by Inspect.Item.Detail(). Optional.
- role: The role that the item must be compatible with. One of "mage", "rogue", "cleric", or "warrior". Optional.
- 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.
- statMax: Maximum allowed value for the filter stat. Optional. If provided, statType and statMin must also be provided.
- statMin: Minimum allowed value for the filter stat. Optional. If provided, statType and statMax must also be provided.
- sort: Which column the requested items should be sorted based on. One of "rarity", "name", "level", "time", "seller", "pricePerUnit", "bid", "buyout", "stack". Optional.
- sortOrder: What order to sort in. One of "ascending" or "descending". Optional.
- text: A string to search for in the item name. Optional.
- 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.
- If type is "buy":
- category: Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional.
- text: A string to search for in the item name. Optional.
- Command.Buff.Cancel
- Function documentation:
- Cancels a buff on the player. Not all buffs are cancelable.
- This function is subject to the "global" command queue.
- Command.Buff.Cancel(buff) -- buff
- Parameters:
- buff: The ID of the buff to cancel.
- Command.Buff.Describe
- Function documentation:
- Requests a detailed description for a given buff.
- This function is subject to the "global" command queue.
- Command.Buff.Describe(unit, buff) -- unit, buff
- Parameters:
- buff: The ID of the buff to describe.
- unit: The ID of the unit that the buff is on.
- Command.Console.Display
- Function documentation:
- Prints a line of text in a console window of your choice. Note that the line length is limited, including HTML tags.
- Command.Console.Display(console, suppressPrefix, text, html) -- console, boolean, string, boolean
- Parameters:
- console: The console to display text into. May be "general", "combat", or a console ID.
- 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.')">.
- suppressPrefix: Suppress the automatic addon shortname prefix.
- text: The text to be printed.
- Command.Cursor
- Function documentation:
- Changes the contents of the cursor. Ability cursors may be set only if the environment is not in secure mode.
- Command.Cursor(hold) -- variant
- Parameters:
- hold: The new cursor. Currently accepts ability, item, itemtype, or non-empty non-wildcard slot IDs. Pass nil to clear the cursor.
- Command.Dimension.Layout.Pickup
- Function documentation:
- Pick up the specified dimension item from the world to your inventory.
- Command.Dimension.Layout.Pickup(dimensionItem) -- dimensionitem
- Parameters:
- dimensionItem: The ID of the dimension item to operate on.
- Command.Dimension.Layout.Place
- Function documentation:
- Places the item (dimension or inventory) in your current dimension and modifies the details specified by the values parameter.
- Command.Dimension.Layout.Place(item, values) -- item, table
- Command.Dimension.Layout.Place(dimensionItem, values) -- dimensionitem, table
- Parameters:
- dimensionItem: The ID of the dimension item to operate on.
- item: The inventory item to operate on.
- values: Table containing data to set on the dimension item. All parameters are optional and will default to current or default values.
- coordX: The X coordinate of the item.
- coordY: The Y coordinate of the item.
- coordZ: The Z coordinate of the item.
- pitch: The pitch rotation of the item.
- roll: The roll rotation of the item.
- scale: The scale of the item.
- yaw: The yaw rotation of the item.
- Command.Dimension.Layout.Select
- Function documentation:
- Selects or deselects the specified dimension item.
- Command.Dimension.Layout.Select(dimensionItem, selected) -- dimensionitem, boolean
- Parameters:
- dimensionItem: The ID of the dimension item to operate on.
- selected: Indicates if the dimension item should be selected or deselected.
- Command.Event.Attach
- Function documentation:
- Attaches an event handler to an event.
- Command.Event.Attach(event, handler, label) -- eventGlobal, function, string
- Command.Event.Attach(event, handler, label, priority) -- eventGlobal, function, string, number
- Parameters:
- event: A global event handle, usually pulled out of the "Event." hierarchy.
- 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.
- label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
- priority: Priority of the event handler. Higher numbers trigger first.
- Command.Event.Detach
- Function documentation:
- 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.
- Command.Event.Detach(event, handler) -- eventGlobal, function/nil
- Command.Event.Detach(event, handler, label) -- eventGlobal, function/nil, string/nil
- Command.Event.Detach(event, handler, label, priority) -- eventGlobal, function/nil, string/nil, number/nil
- Command.Event.Detach(event, handler, label, priority, owner) -- eventGlobal, function/nil, string/nil, number/nil, string/nil
- Parameters:
- event: A global event handle, usually pulled out of the "Event." hierarchy.
- 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.
- label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
- owner: Owner to search for.
- priority: Priority of the event handler. Higher numbers trigger first.
- Command.Guild.Bank.Deposit
- Function documentation:
- Deposits money into the guild bank.
- Requires the "guildbank" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Guild.Bank.Deposit(coin) -- number
- Command.Guild.Bank.Deposit(coin, callback) -- number, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- coin: The string "coin", used as a value to request the player's money.
- Command.Guild.Bank.Purchase
- Function documentation:
- Purchases a new guild bank vault.
- Requires the "guildbank" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Guild.Bank.Purchase() -- void
- Command.Guild.Bank.Purchase(callback) -- callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- Command.Guild.Bank.Withdraw
- Function documentation:
- Withdraws money from the guild bank.
- Requires the "guildbank" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Guild.Bank.Withdraw(coin) -- number
- Command.Guild.Bank.Withdraw(coin, callback) -- number, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- coin: The string "coin", used as a value to request the player's money.
- Command.Guild.Log.Request
- Function documentation:
- Requests a guild log event.
- This function is subject to the "bulk" command queue, and will error if the command queue is not ready to send.
- Command.Guild.Log.Request() -- void
- Command.Guild.Log.Request(callback) -- callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- Command.Guild.Motd
- Function documentation:
- Changes the guild's Message of the Day.
- This function is subject to the "global" command queue.
- Command.Guild.Motd(motd) -- string
- Command.Guild.Motd(motd, callback) -- string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- motd: The new Message of the Day.
- Command.Guild.Roster.Demote
- Function documentation:
- Demotes a guildmember by one rank.
- This function is subject to the "global" command queue.
- Command.Guild.Roster.Demote(member) -- string
- Command.Guild.Roster.Demote(member, callback) -- string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- member: The guildmember to target.
- Command.Guild.Roster.Kick
- Function documentation:
- Kicks a guildmember from the guild.
- This function is subject to the "global" command queue.
- Command.Guild.Roster.Kick(member) -- string
- Command.Guild.Roster.Kick(member, callback) -- string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- member: The guildmember to target.
- Command.Guild.Roster.Note
- Function documentation:
- Changes your guild note.
- This function is subject to the "global" command queue.
- Command.Guild.Roster.Note(note) -- string
- Command.Guild.Roster.Note(note, callback) -- string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- note: The new note.
- Command.Guild.Roster.NoteOfficer
- Function documentation:
- Changes a guildmember's officer note.
- This function is subject to the "global" command queue.
- Command.Guild.Roster.NoteOfficer(member, note) -- string, string
- Command.Guild.Roster.NoteOfficer(member, note, callback) -- string, string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- member: The guildmember to target.
- note: The new note.
- Command.Guild.Roster.Promote
- Function documentation:
- Promotes a guildmember by one rank.
- This function is subject to the "global" command queue.
- Command.Guild.Roster.Promote(member) -- string
- Command.Guild.Roster.Promote(member, callback) -- string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- member: The guildmember to target.
- Command.Guild.Wall.Delete
- Function documentation:
- Deletes an entry from the guild wall.
- This function is subject to the "global" command queue.
- Command.Guild.Wall.Delete(wall) -- guildwall
- Command.Guild.Wall.Delete(wall, callback) -- guildwall, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- wall: The ID of the target wall post.
- Command.Guild.Wall.Post
- Function documentation:
- Posts an entry to the guild wall.
- This function is subject to the "global" command queue.
- Command.Guild.Wall.Post(post) -- string
- Command.Guild.Wall.Post(post, callback) -- string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- post: The item to post.
- Command.Guild.Wall.Request
- Function documentation:
- Requests a guild wall event.
- This function is subject to the "bulk" command queue, and will error if the command queue is not ready to send.
- Command.Guild.Wall.Request() -- void
- Command.Guild.Wall.Request(callback) -- callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- Command.Item.Destroy
- Function documentation:
- 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.
- 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.
- This function is subject to the "global" command queue.
- Command.Item.Destroy(target) -- item
- Parameters:
- target: The item ID of the item to destroy.
- Command.Item.Move
- Function documentation:
- 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.
- 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.
- This function is subject to the "global" command queue.
- Command.Item.Move(source, destination) -- item, slot
- Command.Item.Move(source, destination) -- slot, slot
- Parameters:
- destination: The location to move the item. May attempt to stack or swap if there is already an item here.
- source: The item to move. Must be a slot specifier that refers to an actual item.
- Command.Item.Split
- Function documentation:
- Splits a number of items off a stack.
- 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.
- This function is subject to the "global" command queue.
- Command.Item.Split(source, stack) -- item, number
- Command.Item.Split(source, stack) -- slot, number
- Parameters:
- source: The item to split. May be a slot specifier or an item ID.
- stack: The number of items to move into the new stack. Must be a positive integer.
- Command.Item.Standard.Drag
- Function documentation:
- Behaves in the same way that the addon system does when an inventory icon is dragged.
- 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.
- Command.Item.Standard.Drag(target) -- slot
- Command.Item.Standard.Drag(target) -- item
- Parameters:
- target: The item or slot to be targeted.
- Command.Item.Standard.Drop
- Function documentation:
- Behaves in the same way that the addon system does when an inventory icon is dropped.
- 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.*.
- 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.
- Command.Item.Standard.Drop(target) -- slot
- Command.Item.Standard.Drop(target) -- item
- Parameters:
- target: The item or slot to be targeted.
- Command.Item.Standard.Left
- Function documentation:
- Behaves in the same way that the addon system does when an inventory icon is left-clicked.
- 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.*.
- 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.
- Command.Item.Standard.Left(target) -- slot
- Command.Item.Standard.Left(target) -- item
- Parameters:
- target: The item or slot to be targeted.
- Command.Item.Standard.Right
- Function documentation:
- Behaves in the same way that the addon system does when an inventory icon is right-clicked.
- 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.*.
- 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.
- Command.Item.Standard.Right(target) -- slot
- Command.Item.Standard.Right(target) -- item
- Parameters:
- target: The item or slot to be targeted.
- Command.Mail.Delete
- Function documentation:
- Deletes a mail.
- Requires the "mail" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Mail.Delete(mail) -- mail
- Command.Mail.Delete(mail, callback) -- mail, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- mail: The ID of the mail to be targeted.
- Command.Mail.Open
- Function documentation:
- Opens a mail, retrieving detailed information for it.
- Requires the "mail" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Mail.Open(mail) -- mail
- Command.Mail.Open(mail, callback) -- mail, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- mail: The ID of the mail to be targeted.
- Command.Mail.Pay
- Function documentation:
- Pays the COD fee on a mail.
- Requires the "mail" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Mail.Pay(mail) -- mail
- Command.Mail.Pay(mail, callback) -- mail, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- mail: The ID of the mail to be targeted.
- Command.Mail.Return
- Function documentation:
- Returns a mail to its sender.
- Requires the "mail" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Mail.Return(mail) -- mail
- Command.Mail.Return(mail, callback) -- mail, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- mail: The ID of the mail to be targeted.
- Command.Mail.Send
- Function documentation:
- Sends mail.
- 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.*.
- Requires the "mail" interaction flag to be set.
- Command.Mail.Send(mail) -- table
- Command.Mail.Send(mail, callback) -- table, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- mail: Table containing data about the mail to send.
- to: The name of the player to send mail to. Required.
- subject: The mail's subject. Required.
- body: The mail's body.
- cod: The money required for the recipient to remove attachments. Mutually exclusive with "coin", requires non-empty "attachments".
- coin: The amount of money attached to this message. Mutually exclusive with "cod".
- attachments: A table listing the item IDs of the items you wish to attach. Maximum of 6.
- Command.Mail.Spam
- Function documentation:
- Marks mail as spam.
- Requires the "mail" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Mail.Spam(mail) -- mail
- Command.Mail.Spam(mail, callback) -- mail, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- mail: The ID of the mail to be targeted.
- Command.Mail.Take
- Function documentation:
- Takes an attached item from mail.
- Requires the "mail" interaction flag to be set.
- This function is subject to the "global" command queue.
- Command.Mail.Take(mail, item) -- mail, item
- Command.Mail.Take(mail, items) -- mail, table
- Command.Mail.Take(mail, item, callback) -- mail, item, callbackfunction
- Command.Mail.Take(mail, items, callback) -- mail, table, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- item: The ID of the item to be taken.
- items: A table containing a list of the items to be taken.
- mail: The ID of the mail to be targeted.
- Command.Map.Monitor
- Function documentation:
- 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.
- Command.Map.Monitor(monitor) -- boolean
- Parameters:
- monitor: The new state of the map monitor flag.
- Command.Map.Waypoint.Clear
- Function documentation:
- Clears the player's current waypoint.
- Command.Map.Waypoint.Clear() -- void
- Command.Map.Waypoint.Set
- Function documentation:
- Sets the player's waypoint.
- Command.Map.Waypoint.Set(x, z) -- number, number
- Parameters:
- x: The x coordinate of the waypoint.
- z: The z coordinate of the waypoint.
- Command.Message.Accept
- Function documentation:
- Sets the environment to accept a given type and identifier of message. Parameters can be replaced with "nil" to act as a wildcard.
- Command.Message.Accept(type, identifier) -- string/nil, string/nil
- Parameters:
- 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.
- type: The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
- Command.Message.Broadcast
- Function documentation:
- 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.
- Command.Message.Broadcast(type, target, identifier, data) -- string, string/nil, string, string
- Command.Message.Broadcast(type, target, identifier, data, callback) -- string, string/nil, string, string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- data: The data to send. This parameter is binary-safe.
- 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.
- target: The target of this message. Required for "channel" or "tell" message types, must be nil otherwise.
- type: The type of message to send. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell".
- Command.Message.Reject
- Function documentation:
- Sets the environment to reject a given type and identifier of message. Directly cancels out single calls to Command.Message.Accept.
- Command.Message.Reject(type, identifier) -- string/nil, string/nil
- Parameters:
- 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.
- type: The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
- Command.Message.Send
- Function documentation:
- 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.
- Command.Message.Send(target, identifier, data, callback) -- string, string, string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- data: The data to send. This parameter is binary-safe.
- 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.
- target: The name of the player to send the message to.
- Command.Quest.Abandon
- Function documentation:
- Abandons the given quest. Permitted only on personal quests.
- This function is subject to the "global" command queue.
- Command.Quest.Abandon(quest) -- quest
- Parameters:
- quest: The quest to be affected.
- Command.Quest.Share
- Function documentation:
- Shares the given quest. Permitted only on personal quests.
- 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.*.
- Command.Quest.Share(quest) -- quest
- Parameters:
- quest: The quest to be affected.
- Command.Quest.Track
- Function documentation:
- 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.
- Command.Quest.Track(quest) -- quest
- Command.Quest.Track(nil) -- nil
- Parameters:
- nil: The value "nil".
- quest: The quest to be affected.
- Command.Quest.Watch
- Function documentation:
- Watches a quest, possibly unwatching another item if the player is already watching the maximum item count. Permitted only on personal quests.
- Command.Quest.Watch(quest, flag) -- quest, boolean
- Parameters:
- flag: The new watch status.
- quest: The quest to be affected.
- Command.Queue.Handler
- Function documentation:
- 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.
- Command.Queue.Handler(handler) -- function
- Parameters:
- handler: The new queue handler.
- Command.Slash.Register
- Function documentation:
- 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.
- eventTable = Command.Slash.Register(slashCommand) -- table <- string
- Parameters:
- slashCommand: The name of the slash command to register.
- Return values:
- 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.
- Command.Social.Friend.Add
- Function documentation:
- Adds a player to your friend list.
- This function is subject to the "global" command queue.
- Command.Social.Friend.Add(name) -- string
- Parameters:
- name: The name of the friend.
- Command.Social.Friend.Note
- Function documentation:
- Changes a friend's personal note.
- This function is subject to the "global" command queue.
- Command.Social.Friend.Note(name, note) -- string, string
- Parameters:
- name: The name of the friend.
- note: The new personal note.
- Command.Social.Friend.Remove
- Function documentation:
- Removes a player from your friend list.
- This function is subject to the "global" command queue.
- Command.Social.Friend.Remove(name) -- string
- Parameters:
- name: The name of the friend.
- Command.Social.Ignore.Add
- Function documentation:
- Adds an player to your ignore list.
- This function is subject to the "global" command queue.
- Command.Social.Ignore.Add(name) -- string
- Parameters:
- name: The name of the ignored player.
- Command.Social.Ignore.Note
- Function documentation:
- Changes an ignored player's personal note.
- This function is subject to the "global" command queue.
- Command.Social.Ignore.Note(name, note) -- string, string
- Parameters:
- name: The name of the ignored player.
- note: The new personal note.
- Command.Social.Ignore.Remove
- Function documentation:
- Removes a player from your ignore list.
- This function is subject to the "global" command queue.
- Command.Social.Ignore.Remove(name) -- string
- Parameters:
- name: The name of the ignored player.
- Command.Storage.Clear
- Function documentation:
- 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.
- Command.Storage.Clear(segment, identifier, callback) -- string, string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- identifier: The identifier of the storage bucket. Must be at least three characters long.
- 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.
- Command.Storage.Get
- Function documentation:
- 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.
- Command.Storage.Get(target, segment, identifier, callback) -- string, string, string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- identifier: The identifier of the storage bucket. Must be at least three characters long.
- 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.
- 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.
- Command.Storage.List
- Function documentation:
- 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.
- Command.Storage.List(target, segment, callback) -- string, string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- 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.
- 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.
- Command.Storage.Set
- Function documentation:
- 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.
- Command.Storage.Set(segment, identifier, read, write, data, callback) -- string, string, string, string, string, callbackfunction
- Parameters:
- callback: A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
- data: The data to store. This parameter is binary-safe.
- identifier: The identifier of the storage bucket. Must be at least three characters long.
- 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.
- 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.
- 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".
- Command.System.Flash
- Function documentation:
- Controls the flashing of the Rift taskbar icon.
- Command.System.Flash(flash) -- boolean
- Parameters:
- flash: Whether the taskbar icon should flash or not.
- Command.System.Strict
- Function documentation:
- Puts the environment into Strict mode. In Strict mode, deprecated functions and events will throw errors instead of functioning normally.
- Command.System.Strict() -- void
- Command.System.Texture.Record
- Function documentation:
- 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.
- Command.System.Texture.Record() -- void
- Command.System.Watchdog.Quiet
- Function documentation:
- 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.
- Command.System.Watchdog.Quiet() -- void
- Command.Title.Prefix
- Function documentation:
- Changes the player's prefix title.
- This function is subject to the "global" command queue.
- Command.Title.Prefix(title) -- title
- Command.Title.Prefix(title) -- nil
- Parameters:
- title: The ID of the new title to set, or "nil" for no title.
- Command.Title.Suffix
- Function documentation:
- Changes the player's suffix title.
- This function is subject to the "global" command queue.
- Command.Title.Suffix(title) -- title
- Command.Title.Suffix(title) -- nil
- Parameters:
- title: The ID of the new title to set, or "nil" for no title.
- Command.Tooltip
- Function documentation:
- Changes the displayed tooltip.
- Command.Tooltip(target) -- variant
- Command.Tooltip(target, nil) -- variant, nil
- Command.Tooltip(owner, buff) -- unit, buff
- Parameters:
- buff: The ID of a buff for the new tooltip.
- nil: Optional placeholder nil.
- owner: The ID of the owner of the buff.
- target: The new tooltip. Currently accepts ability, item, itemtype, or unit IDs. Pass nil to clear the tooltip.
- Command.UI.Error
- Function documentation:
- Display the addon error dialog.
- Command.UI.Error(id) -- error
- Parameters:
- id: The ID of the error to be displayed.
- Command.Unit.Menu
- Function documentation:
- Creates a standard context menu targeted at the unit of choice.
- Command.Unit.Menu(target) -- unit
- Parameters:
- target: The unit to generate a context menu for.
- Utilities:
- Utility.Auction.Cost
- Function documentation:
- Returns the amount of silver it will cost to post a given auction.
- This function is deprecated and will be removed in the future. It should not be used.
- cost = Utility.Auction.Cost(item, time, bid, buyout) -- number <- item, number, number/nil, number/nil
- cost = Utility.Auction.Cost(item, time, bid, buyout, partial) -- number <- item, number, number/nil, number/nil, boolean
- Parameters:
- bid: The minimum bid for the new auction, in silver. nil if no bid is desired.
- buyout: The buyout for the new auction, in silver. nil if no buyout is desired.
- item: The ID of the item to be auctioned.
- 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.
- time: The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.
- Return values:
- cost: The cost of posting this auction, in silver.
- Utility.Auction.CostOrder
- Function documentation:
- Returns the amount of silver it will cost to post a given order.
- cost = Utility.Auction.CostOrder(itemtype, quantity, time, buyout) -- number <- itemtype, number, number, number
- Parameters:
- buyout: The total buyout for the new auction, in silver. Must be evenly divisible by quantity.
- itemtype: The item type to be ordered.
- quantity: The number of items to be ordered.
- time: The duration that the order should last, in hours. Valid values are limited to 12, 24, and 48.
- Return values:
- cost: The cost of posting this order, in silver. Includes the full deposit for the items.
- Utility.Auction.CostPost
- Function documentation:
- Returns the amount of silver it will cost to post a given auction.
- cost = Utility.Auction.CostPost(item, time, bid, buyout) -- number <- item, number, number/nil, number/nil
- cost = Utility.Auction.CostPost(item, time, bid, buyout, partial) -- number <- item, number, number/nil, number/nil, boolean
- Parameters:
- bid: The minimum bid for the new auction, in silver. nil if no bid is desired.
- buyout: The buyout for the new auction, in silver. nil if no buyout is desired.
- item: The ID of the item to be auctioned.
- 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.
- time: The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.
- Return values:
- cost: The cost of posting this auction, in silver.
- Utility.Dispatch
- Function documentation:
- 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.
- Utility.Dispatch(func, identifier, info) -- function, string, string
- Parameters:
- func: The function to call.
- identifier: The identifier of the addon to credit execution time towards.
- info: An info string to be included in error reports.
- Utility.Event.Create
- Function documentation:
- 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.
- caller, handle = Utility.Event.Create(identifier, event) -- function, table <- string, string
- Parameters:
- event: The event's name. "." characters will be treated as hierarchy delimeters.
- identifier: The identifier of the addon creating this event.
- Return values:
- 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.
- handle: The resulting event handle.
- Utility.Item.Slot.All
- Function documentation:
- Generates a slot specifier for all known items.
- slot = Utility.Item.Slot.All() -- slot <- void
- Return values:
- slot: The requested slot specifier.
- Utility.Item.Slot.Bank
- Function documentation:
- Generates a slot specifier for the player's bank.
- slot = Utility.Item.Slot.Bank() -- slot <- void
- slot = Utility.Item.Slot.Bank(segment) -- slot <- string
- slot = Utility.Item.Slot.Bank(segment) -- slot <- number
- slot = Utility.Item.Slot.Bank(segment, slot) -- slot <- string, number
- slot = Utility.Item.Slot.Bank(segment, slot) -- slot <- number, number
- Parameters:
- 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.
- slot: The slot ID, starting at 1.
- Return values:
- slot: The requested slot specifier.
- Utility.Item.Slot.Equipment
- Function documentation:
- Generates a slot specifier for the player's equipment.
- slot = Utility.Item.Slot.Equipment() -- slot <- void
- slot = Utility.Item.Slot.Equipment(slot) -- slot <- string
- Parameters:
- 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".
- Return values:
- slot: The requested slot specifier.
- Utility.Item.Slot.Guild
- Function documentation:
- Generates a slot specifier for the player's guild bank.
- slot = Utility.Item.Slot.Guild() -- slot <- void
- slot = Utility.Item.Slot.Guild(vault) -- slot <- number
- slot = Utility.Item.Slot.Guild(vault, slot) -- slot <- number, number
- Parameters:
- slot: The slot ID, starting at 1.
- vault: The vault ID to inspect. Starts at 1.
- Return values:
- slot: The requested slot specifier.
- Utility.Item.Slot.Inventory
- Function documentation:
- Generates a slot specifier for the player's inventory.
- slot = Utility.Item.Slot.Inventory() -- slot <- void
- slot = Utility.Item.Slot.Inventory(bag) -- slot <- string
- slot = Utility.Item.Slot.Inventory(bag) -- slot <- number
- slot = Utility.Item.Slot.Inventory(bag, slot) -- slot <- string, number
- slot = Utility.Item.Slot.Inventory(bag, slot) -- slot <- number, number
- Parameters:
- bag: The number of the bag whose contents should be inspected, starting at 1, or "bag" to inspect the actual inventory bags.
- slot: The slot ID, starting at 1.
- Return values:
- slot: The requested slot specifier.
- Utility.Item.Slot.Parse
- Function documentation:
- Parses a slot specifier, returning information on what it represents.
- type, parameter, parameter = Utility.Item.Slot.Parse(slot) -- string, variant, variant <- slot
- type, parameter = Utility.Item.Slot.Parse(slot) -- string, variant <- slot
- type = Utility.Item.Slot.Parse(slot) -- string <- slot
- Utility.Item.Slot.Parse(slot) -- slot
- Parameters:
- slot: The slot ID, starting at 1.
- Return values:
- parameter: A parameter for this slot type. Actual meaning depends on the type.
- type: The type of this element.
- Utility.Item.Slot.Quest
- Function documentation:
- Generates a slot specifier for the player's quest bag.
- slot = Utility.Item.Slot.Quest() -- slot <- void
- slot = Utility.Item.Slot.Quest(slot) -- slot <- number
- Parameters:
- slot: The slot ID, starting at 1.
- Return values:
- slot: The requested slot specifier.
- Utility.Item.Slot.Vault
- Function documentation:
- Generates a slot specifier for the player's bank vaults.
- slot = Utility.Item.Slot.Vault() -- slot <- void
- slot = Utility.Item.Slot.Vault(vault) -- slot <- number
- slot = Utility.Item.Slot.Vault(vault, slot) -- slot <- number, number
- Parameters:
- slot: The slot ID, starting at 1.
- vault: The vault ID, starting at 1.
- Return values:
- slot: The requested slot specifier.
- Utility.Item.Slot.Wardrobe
- Function documentation:
- Generates a slot specifier for the player's wardrobe.
- slot = Utility.Item.Slot.Wardrobe() -- slot <- void
- slot = Utility.Item.Slot.Wardrobe(costume) -- slot <- number
- slot = Utility.Item.Slot.Wardrobe(costume, slot) -- slot <- number, string
- Parameters:
- costume: The number of the wardrobe costume to inspect, starting at 1.
- slot: The equipment slot to be used. Can be any of the following: "helmet", "cape", "shoulders", "chest", "gloves", "legs", or "feet".
- Return values:
- slot: The requested slot specifier.
- Utility.Mail.Cost
- Function documentation:
- Returns the amount of silver it will cost to send a given mail.
- cost = Utility.Mail.Cost(mail) -- number <- table
- Parameters:
- mail: The mail to check. In the same format as the parameter of Command.Mail.Send.
- Return values:
- cost: The cost of sending this mail, in silver.
- Utility.Matrix.Create
- Function documentation:
- 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.
- matrix = Utility.Matrix.Create(scaleX, scaleY, rotate, translateX, translateY) -- table <- number/nil, number/nil, number/nil, number/nil, number/nil
- Parameters:
- rotate: Rotation amount in radians. Defaults to 0.
- scaleX: Scaling along the X axis. Defaults to 1.
- scaleY: Scaling along the Y axis. Defaults to 1.
- translateX: Translation along the X axis. Defaults to 0.
- translateY: Translation along the Y axis. Defaults to 0.
- Return values:
- matrix: Matrix table suitable for "transform" members.
- Utility.Message.Limits
- Function documentation:
- Returns information on the message bandwidth limits.
- data = Utility.Message.Limits() -- table <- void
- Return values:
- data: The requested data.
- Returned members:
- burst: The amount of data that can be sent or received without being subject to throttling.
- maximum: Maximum allowed message size.
- sustained: Amount of data that can be transferred per second without dropping messages.
- Utility.Message.Size
- Function documentation:
- Returns the size of a message, as used for bandwidth control.
- size = Utility.Message.Size(to, identifier, data) -- number <- string/nil, string, string
- Parameters:
- data: The data to send. This parameter is binary-safe.
- 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.
- to: The name of the player or channel to send to. nil if this is not targeted at a specific player or channel.
- Return values:
- size: The calculated size of the message.
- Utility.Serialize.Full
- Function documentation:
- Serializes a table of parameters. Results in a string suitable for feeding directly into loadstring(). Deals properly with table cycles and non-tree structures.
- serialized = Utility.Serialize.Full(elements) -- string <- table
- serialized = Utility.Serialize.Full(elements, exists) -- string <- table, table
- Parameters:
- elements: Table of elements to serialize.
- exists: Optional parameter containing a table of elements that should be included even in the case that they are nil.
- Return values:
- serialized: String containing serialized output. May be nil if there was an error with the input.
- Utility.Serialize.Inline
- Function documentation:
- 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.
- serialized = Utility.Serialize.Inline(element) -- string <- variant
- Parameters:
- element: Element to serialize.
- Return values:
- serialized: String containing serialized output. May be nil if there was an error with the input.
- Utility.Storage.Checksum
- Function documentation:
- Calculates the storage checksum of a string.
- checksum = Utility.Storage.Checksum(data) -- string <- string
- Parameters:
- data: The data to store. This parameter is binary-safe.
- Return values:
- checksum: An opaque string representing the storage checksum.
- Utility.Storage.Limits
- Function documentation:
- Returns information on the storage bandwidth limits.
- data = Utility.Storage.Limits() -- table <- void
- Return values:
- data: The requested data.
- Returned members:
- burst: The amount of data that can be sent or received without being subject to throttling.
- sustained: Amount of data that can be transferred per second without dropping messages.
- Utility.Storage.Size
- Function documentation:
- Returns the size of a stored element, as used for storage quota and bandwidth control.
- size = Utility.Storage.Size(identifier, data) -- number <- string, string
- Parameters:
- data: The data to store. This parameter is binary-safe.
- identifier: The identifier of the storage bucket. Must be at least three characters long.
- Return values:
- size: The calculated size of the storage bucket.
- Utility.Type
- Function documentation:
- Determines the type of a given item. Understands Rift-specific identifiers.
- type = Utility.Type(element) -- string <- variant
- Parameters:
- element: The element to check.
- Return values:
- type: The type of this element.
- Utility.Unit.Availability
- Function documentation:
- Returns information on which detail members are available in which availability mode.
- lookup = Utility.Unit.Availability() -- table <- void
- Return values:
- lookup: Lookup table for which members are available in which availability mode. To check if "full" availability contains "level", check "lookup.full.level".
- Native frames:
- UI.Native.Ability
- The Ability dialog.
- UI.Native.Accolade
- The Warfront accolade HUD.
- UI.Native.Achievement
- The Achievement dialog.
- UI.Native.AchievementPopup
- The "Achievement Complete" popup.
- UI.Native.Adventure
- The Instant Adventure dialog.
- UI.Native.Ascend
- The Ascend-a-Friend dialog.
- UI.Native.Attunement
- The Planar Attunement dialog.
- UI.Native.Auction
- The Auction dialog.
- UI.Native.Bag
- The bag and currency HUD.
- UI.Native.BagBank1
- The first bank inventory bag.
- UI.Native.BagBank2
- The second bank inventory bag.
- UI.Native.BagBank3
- The third bank inventory bag.
- UI.Native.BagBank4
- The fourth bank inventory bag.
- UI.Native.BagBank5
- The fifth bank inventory bag.
- UI.Native.BagBank6
- The sixth bank inventory bag.
- UI.Native.BagBank7
- The seventh bank inventory bag.
- UI.Native.BagBank8
- The eighth bank inventory bag.
- UI.Native.BagInventory1
- The first main inventory bag.
- UI.Native.BagInventory2
- The second main inventory bag.
- UI.Native.BagInventory3
- The third main inventory bag.
- UI.Native.BagInventory4
- The fourth main inventory bag.
- UI.Native.BagInventory5
- The fifth main inventory bag.
- UI.Native.BagInventory6
- The sixth main inventory bag.
- UI.Native.BagInventory7
- The seventh main inventory bag.
- UI.Native.Bank
- The Bank dialog.
- UI.Native.BankGuild
- The Guild Bank dialog.
- UI.Native.BarBottom1
- The first extra bottom action bar.
- UI.Native.BarBottom2
- The second extra bottom action bar.
- UI.Native.BarBottom3
- The third extra bottom action bar.
- UI.Native.BarBottom4
- The fourth extra bottom action bar.
- UI.Native.BarBottom5
- The fifth extra bottom action bar.
- UI.Native.BarBottom6
- The sixth extra bottom action bar.
- UI.Native.BarMain
- The main action bar.
- UI.Native.BarPet
- The pet action bar.
- UI.Native.BarSide1
- The first extra side action bar.
- UI.Native.BarSide2
- The second extra side action bar.
- UI.Native.BarSide3
- The third extra side action bar.
- UI.Native.BarSide4
- The fourth extra side action bar.
- UI.Native.BarTemporary
- The action bar used for temporary abilities.
- UI.Native.Breath
- The breath/fatigue bar.
- UI.Native.Buffbar
- The player's buff bar.
- UI.Native.Castbar
- The player's cast bar.
- UI.Native.Character
- The Character dialog.
- UI.Native.Chronicle
- The Chronicles dialog.
- UI.Native.Coinlock
- The Coin Lock button.
- UI.Native.Console1
- The first console window.
- UI.Native.Console2
- The second console window.
- UI.Native.Console3
- The third console window.
- UI.Native.Console4
- The fourth console window.
- UI.Native.Console5
- The fifth console window.
- UI.Native.Console6
- The sixth console window.
- UI.Native.Console7
- The seventh console window.
- UI.Native.ConsoleSetting
- The console settings dialog.
- UI.Native.Crafting
- The Crafting dialog.
- UI.Native.Ctf
- The Capture-the-Flag status indicator.
- UI.Native.Guest
- The guest invite dialog for weddings.
- UI.Native.Guild
- The Guild dialog.
- UI.Native.GuildCharter
- The Guild Charter dialog.
- UI.Native.GuildFinder
- The Guild Finder dialog.
- UI.Native.Import
- The Import dialog, as reached from the escape menu.
- UI.Native.Keybind
- The Keybind dialog.
- UI.Native.Layout
- The UI Layout dialog.
- UI.Native.Leaderboard
- The Leaderboard dialog.
- UI.Native.Lfg
- The Looking-for-Group dialog.
- UI.Native.Loot
- The Loot dialog.
- UI.Native.Macro
- The Macro dialog.
- UI.Native.MacroIcon
- The Macro icons list.
- UI.Native.MacroSlash
- The Macro slash commands list.
- UI.Native.Mail
- The Mail dialog.
- UI.Native.MailRead
- The currently-being-read Mail dialog.
- UI.Native.MapMain
- The main map.
- UI.Native.MapMini
- The minimap.
- UI.Native.MechanicPlayer
- The player-focused class-specific-mechanic HUD element.
- UI.Native.MechanicTarget
- The target-focused class-specific-mechanic HUD element.
- UI.Native.Mentor
- The Mentoring popup.
- UI.Native.Menu
- The main menu HUD element.
- UI.Native.MessageEvent
- The event-related message popup.
- UI.Native.MessageStandard
- The generic message popup.
- UI.Native.MessageText
- The generic text popup.
- UI.Native.MessageWarfront
- The warfront-related message popup.
- UI.Native.MessageZone
- The zone-related message popup.
- UI.Native.Notification
- The notification message popup.
- UI.Native.Notify
- The public-group/return-to-graveyard popup button.
- UI.Native.PortraitFocus
- The portrait of your focus target.
- UI.Native.PortraitParty1
- The portrait of your first partymember.
- UI.Native.PortraitParty1Pet
- The portrait of your first partymember's pet.
- UI.Native.PortraitParty2
- The portrait of your second partymember.
- UI.Native.PortraitParty2Pet
- The portrait of your second partymember's pet.
- UI.Native.PortraitParty3
- The portrait of your third partymember.
- UI.Native.PortraitParty3Pet
- The portrait of your third partymember's pet.
- UI.Native.PortraitParty4
- The portrait of your fourth partymember.
- UI.Native.PortraitParty4Pet
- The portrait of your fourth partymember's pet.
- UI.Native.PortraitPet
- The portrait of your pet.
- UI.Native.PortraitPlayer
- Your portrait.
- UI.Native.PortraitTarget
- The portrait of your target.
- UI.Native.PortraitTargetTarget
- The portrait of your target's target.
- UI.Native.Quest
- The Quest dialog.
- UI.Native.QuestStickies
- The Quest sticky HUD.
- UI.Native.Question
- The general-purpose question popup.
- UI.Native.Raid
- The Raid dialog.
- UI.Native.RaidGroup1
- The raid frame for your raid's first group.
- UI.Native.RaidGroup1Pet
- The raid frame for your raid's first group's pets.
- UI.Native.RaidGroup2
- The raid frame for your raid's second group.
- UI.Native.RaidGroup2Pet
- The raid frame for your raid's second group's pets.
- UI.Native.RaidGroup3
- The raid frame for your raid's third group.
- UI.Native.RaidGroup3Pet
- The raid frame for your raid's third group's pets.
- UI.Native.RaidGroup4
- The raid frame for your raid's fourth group.
- UI.Native.RaidGroup4Pet
- The raid frame for your raid's fourth group's pets.
- UI.Native.RaidParty
- The raid frame used for displaying your party as a raid.
- UI.Native.RaidPartyPet
- The raid frame used for displaying your party's pets as a raid.
- UI.Native.Reactive
- The reactive-ability popup.
- UI.Native.Recall
- The set-recall-point dialog.
- UI.Native.Respec
- The respec dialog.
- UI.Native.Rift
- The Rift meter HUD.
- UI.Native.Roll1
- The first loot-roll popup.
- UI.Native.Roll2
- The second loot-roll popup.
- UI.Native.Roll3
- The third loot-roll popup.
- UI.Native.Roll4
- The fourth loot-roll popup.
- UI.Native.Setting
- The Settings dialog.
- UI.Native.Social
- The Social dialog.
- UI.Native.Soul
- The Soul Tree dialog.
- UI.Native.Split
- The stack split popup.
- UI.Native.Streaming
- The icon that indicates your current streaming download status.
- UI.Native.Ticket
- The Customer Service Ticket dialog.
- UI.Native.Tip
- The Game Tip dialog.
- UI.Native.TipAlert
- The Game Tip notification popup.
- UI.Native.Tooltip
- The tooltip.
- UI.Native.TooltipAnchor
- The location that tooltips are anchored to by default.
- UI.Native.Trade
- The Trade dialog.
- UI.Native.Tray
- The icon tray used for the clock, mail notification, and similar elements.
- UI.Native.TraySocial
- The icon tray used for social notifications.
- UI.Native.Treasure
- The Treasure popup used to claim dungeon loot.
- UI.Native.Trial
- The Trial dialog.
- UI.Native.Upgrade
- The Upgrade portrait, used for targets that are upgradeable.
- UI.Native.Warfront
- The Warfront dialog.
- UI.Native.WarfrontLeaderboard
- The Warfront Leaderboard dialog.
- UI.Native.World
- The World Event dialog.
- Global events:
- Event.Ability.New.Add
- Event documentation:
- Signals the addition of a player ability.
- Event.Ability.New.Add(abilities)
- Parameters:
- abilities: Lists the abilities that were added. Table from ability ID to "true".
- Event.Ability.New.Cooldown.Begin
- Event documentation:
- Signals the start of an ability's cooldown.
- Event.Ability.New.Cooldown.Begin(cooldowns)
- Parameters:
- 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.
- Event.Ability.New.Cooldown.End
- Event documentation:
- Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.
- Event.Ability.New.Cooldown.End(cooldowns)
- Parameters:
- 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.
- Event.Ability.New.Range.False
- Event documentation:
- Signals a player ability exiting range from its current target.
- Event.Ability.New.Range.False(abilities)
- Parameters:
- abilities: The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.
- Event.Ability.New.Range.True
- Event documentation:
- Signals a player ability entering range from its current target.
- Event.Ability.New.Range.True(abilities)
- Parameters:
- abilities: The abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.
- Event.Ability.New.Remove
- Event documentation:
- Signals the removal of a player ability.
- Event.Ability.New.Remove(abilities)
- Parameters:
- abilities: Lists the abilities that were removed. Table from ability ID to "false".
- Event.Ability.New.Target
- Event documentation:
- Signals a player ability changing its current target.
- Event.Ability.New.Target(abilities)
- Parameters:
- abilities: The abilities whose target has changed. The key is the ability ID, the value is the new target.
- Event.Ability.New.Usable.False
- Event documentation:
- Signals a player ability becoming unusable.
- Event.Ability.New.Usable.False(abilities)
- Parameters:
- abilities: The abilities whose usability has changed. The key is the ability ID, the value is the new usability.
- Event.Ability.New.Usable.True
- Event documentation:
- Signals a player ability becoming usable.
- Event.Ability.New.Usable.True(abilities)
- Parameters:
- abilities: The abilities whose usability has changed. The key is the ability ID, the value is the new usability.
- Event.Achievement.Complete
- Event documentation:
- Signals an achievement completing.
- Event.Achievement.Complete(achievement)
- Parameters:
- achievement: The ID of the achievement.
- Event.Achievement.Update
- Event documentation:
- Signals a change in an achievement's information.
- Event.Achievement.Update(achievements)
- Parameters:
- achievements: A table of the achievements, in {id = true} format.
- Event.Addon.Load.Begin
- Event documentation:
- Signals the beginning of an addon's loading sequence.
- Event.Addon.Load.Begin(addonidentifier)
- Parameters:
- addonidentifier: The addon's identifier.
- Event.Addon.Load.End
- Event documentation:
- Signals the end of an addon's loading sequence. At this point, that addon is fully loaded and initialized.
- Event.Addon.Load.End(addonidentifier)
- Parameters:
- addonidentifier: The addon's identifier.
- Event.Addon.SavedVariables.Load.Begin
- Event documentation:
- Signals the beginning of an addon's saved variable loading.
- Event.Addon.SavedVariables.Load.Begin(addonidentifier)
- Parameters:
- addonidentifier: The addon's identifier.
- Event.Addon.SavedVariables.Load.End
- Event documentation:
- Signals the end of an addon's saved variable load.
- Event.Addon.SavedVariables.Load.End(addonidentifier)
- Parameters:
- addonidentifier: The addon's identifier.
- Event.Addon.SavedVariables.Save.Begin
- Event documentation:
- Signals the beginning of an addon's saved variable saving.
- Event.Addon.SavedVariables.Save.Begin(addonidentifier)
- Parameters:
- addonidentifier: The addon's identifier.
- Event.Addon.SavedVariables.Save.End
- Event documentation:
- Signals the end of an addon's saved variable saving.
- Event.Addon.SavedVariables.Save.End(addonidentifier)
- Parameters:
- addonidentifier: The addon's identifier.
- Event.Addon.Shutdown.Begin
- Event documentation:
- Signals the beginning of the shutdown sequence.
- Event.Addon.Shutdown.Begin()
- Event.Addon.Shutdown.End
- Event documentation:
- Signals the end of the shutdown sequence. This is the last event that will be sent.
- Event.Addon.Shutdown.End()
- Event.Addon.Startup.End
- Event documentation:
- Signals the end of the startup sequence. At this point, all addons are fully loaded and initialized.
- Event.Addon.Startup.End()
- Event.Attunement.Progress.Accumulated
- Event documentation:
- Signals your accumulated attunement experience changing.
- Event.Attunement.Progress.Accumulated(accumulated)
- Parameters:
- accumulated: Total quantity of accumulated attunement experience in this level.
- Event.Attunement.Progress.Available
- Event documentation:
- Signals your available attunement points changing.
- Event.Attunement.Progress.Available(available)
- Parameters:
- available: Number of unused attunement ranks.
- Event.Attunement.Progress.Rested
- Event documentation:
- Signals your available attunement rested experience changing.
- Event.Attunement.Progress.Rested(rested)
- Parameters:
- rested: Quantity of available attunement rested experience.
- Event.Attunement.Progress.Spent
- Event documentation:
- Signals your spent attunement points changing.
- Event.Attunement.Progress.Spent(spent)
- Parameters:
- spent: Number of spent attunement ranks.
- Event.Auction.Scan
- Event documentation:
- Signals incoming auction data.
- Event.Auction.Scan(type, auctions)
- Parameters:
- type: A table containing information on this scan. In the same format as the parameter to Command.Auction.Scan().
- auctions: A table of the auctions returned from this scan.
- Event.Auction.Statistics
- Event documentation:
- Signals receipt of auction statistics.
- Event.Auction.Statistics(itemtype, data)
- Parameters:
- itemtype: Item type that the attached statistics refer to.
- data: Table containing a series of tables with different timestamps, each containing data for a single day.
- Parameter members:
- priceAverage: Average item price during this day.
- priceMax: Maximum item price during this day.
- priceMin: Minimum item price during this day.
- priceVariance: Variance in item price during this day.
- time: UNIX timestamp of the day.
- volume: Quantity of items traded during this day.
- Event.Buff.Add
- Event documentation:
- Signals new buffs on a unit.
- Event.Buff.Add(unit, buffs)
- Parameters:
- unit: The Unit ID of the unit involved.
- 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.
- Event.Buff.Change
- Event documentation:
- Signals a change in existing buffs on a unit.
- Event.Buff.Change(unit, buffs)
- Parameters:
- unit: The Unit ID of the unit involved.
- buffs: A table containing the buffs involved.
- Event.Buff.Description
- Event documentation:
- 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.
- Event.Buff.Description(unit, buffs)
- Parameters:
- unit: The Unit ID of the unit involved.
- buffs: A table containing the buffs involved.
- Event.Buff.Remove
- Event documentation:
- Signals removal of buffs from a unit.
- Event.Buff.Remove(unit, buffs)
- Parameters:
- unit: The Unit ID of the unit involved.
- buffs: A table containing the buffs involved.
- Event.Chat.Notify
- Event documentation:
- Signals a screen notification. This is generally used as a warning mechanism during boss fights.
- Event.Chat.Notify(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- message: The text said.
- Event.Chat.Npc
- Event documentation:
- Signals an NPC speaking a line of text.
- Event.Chat.Npc(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- from: The unit ID of the speaker, if available.
- fromName: The name of the speaker.
- message: The text said.
- Event.Combat.Damage
- Event documentation:
- Signals damage done to a unit. All units referenced by this event will be accessible within this event's handlers.
- Event.Combat.Damage(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- ability: The ability ID for the ability used, if available.
- abilityName: The name of the ability used.
- caster: The unit ID for this event's initiator, if one exists.
- casterName: The name of this event's initiator, if available.
- crit: Whether this was the result of a critical hit.
- damage: The amount of damage actually done.
- damageAbsorbed: The amount of damage absorbed.
- damageBlocked: The amount of damage blocked.
- damageDeflected: The amount of damage deflected.
- damageIntercepted: The amount of damage intercepted.
- damageModified: The amount of damage modified.
- overkill: The amount of overkill done.
- target: The unit ID for the target.
- targetName: The name of the target, if available.
- type: The damage type. Values include "life", "death", "air", "earth", "fire", "water".
- Event.Combat.Death
- Event documentation:
- Signals the death of a unit. All units referenced by this event will be accessible within this event's handlers.
- Event.Combat.Death(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- caster: The unit ID for this event's initiator, if one exists.
- casterName: The name of this event's initiator, if available.
- target: The unit ID for the target.
- targetName: The name of the target, if available.
- Event.Combat.Dodge
- Event documentation:
- Signals a unit dodging an ability. All units referenced by this event will be accessible within this event's handlers.
- Event.Combat.Dodge(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- ability: The ability ID for the ability used, if available.
- abilityName: The name of the ability used.
- caster: The unit ID for this event's initiator, if one exists.
- casterName: The name of this event's initiator, if available.
- target: The unit ID for the target.
- targetName: The name of the target, if available.
- Event.Combat.Heal
- Event documentation:
- Signals healing done to a unit. All units referenced by this event will be accessible within this event's handlers.
- Event.Combat.Heal(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- ability: The ability ID for the ability used, if available.
- abilityName: The name of the ability used.
- caster: The unit ID for this event's initiator, if one exists.
- casterName: The name of this event's initiator, if available.
- crit: Whether this was the result of a critical hit.
- heal: The amount healed.
- overheal: The amount of healing past maximum health wasted.
- target: The unit ID for the target.
- targetName: The name of the target, if available.
- Event.Combat.Immune
- Event documentation:
- Signals a unit resisting an ability through immunity. All units referenced by this event will be accessible within this event's handlers.
- Event.Combat.Immune(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- ability: The ability ID for the ability used, if available.
- abilityName: The name of the ability used.
- caster: The unit ID for this event's initiator, if one exists.
- casterName: The name of this event's initiator, if available.
- target: The unit ID for the target.
- targetName: The name of the target, if available.
- Event.Combat.Miss
- Event documentation:
- Signals an ability's effect missing a unit. All units referenced by this event will be accessible within this event's handlers.
- Event.Combat.Miss(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- ability: The ability ID for the ability used, if available.
- abilityName: The name of the ability used.
- caster: The unit ID for this event's initiator, if one exists.
- casterName: The name of this event's initiator, if available.
- target: The unit ID for the target.
- targetName: The name of the target, if available.
- Event.Combat.Parry
- Event documentation:
- Signals a unit parrying an ability. All units referenced by this event will be accessible within this event's handlers.
- Event.Combat.Parry(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- ability: The ability ID for the ability used, if available.
- abilityName: The name of the ability used.
- caster: The unit ID for this event's initiator, if one exists.
- casterName: The name of this event's initiator, if available.
- target: The unit ID for the target.
- targetName: The name of the target, if available.
- Event.Combat.Resist
- Event documentation:
- Signals a unit resisting an ability. All units referenced by this event will be accessible within this event's handlers.
- Event.Combat.Resist(info)
- Parameters:
- info: Detailed information table about this event, containing several named parameters.
- Parameter members:
- ability: The ability ID for the ability used, if available.
- abilityName: The name of the ability used.
- caster: The unit ID for this event's initiator, if one exists.
- casterName: The name of this event's initiator, if available.
- target: The unit ID for the target.
- targetName: The name of the target, if available.
- Event.Currency
- Event documentation:
- Signals a change in the player's available currency.
- Event.Currency(currencies)
- Parameters:
- currencies: New currency counts, in key/value form.
- Event.Cursor
- Event documentation:
- Signals that the cursor has changed.
- Event.Cursor(type, held)
- Parameters:
- type: The current cursor type. Valid values include "ability", "item", and "itemtype".
- held: The blob describing the new element held. Generally, some kind of identifier used in another part of the addon system.
- Event.Dimension.Layout.Add
- Event documentation:
- Signals that a dimension item has been added.
- Event.Dimension.Layout.Add(addedItem)
- Parameters:
- addedItem: The dimension item that has been added.
- Event.Dimension.Layout.Remove
- Event documentation:
- Signals that a dimension item has been removed.
- Event.Dimension.Layout.Remove(removedItem)
- Parameters:
- removedItem: The dimension item that has been removed.
- Event.Dimension.Layout.Update
- Event documentation:
- Signals that a dimension item has been updated.
- Event.Dimension.Layout.Update(updatedItem)
- Parameters:
- updatedItem: The dimension item that has been updated.
- Event.Experience.Accumulated
- Event documentation:
- Signals your accumulated experience changing.
- Event.Experience.Accumulated(accumulated)
- Parameters:
- accumulated: Total quantity of accumulated experience in this level.
- Event.Experience.Rested
- Event documentation:
- Signals your available rested experience changing.
- Event.Experience.Rested(rested)
- Parameters:
- rested: Quantity of available rested experience.
- Event.Faction.Notoriety
- Event documentation:
- Signals a change in the player's faction notoriety.
- Event.Faction.Notoriety(notoriety)
- Parameters:
- notoriety: New notoriety values, in key/value form.
- Event.Guild.Bank.Change
- Event documentation:
- Signals a change in a guild bank vault's information.
- Event.Guild.Bank.Change(vaults)
- Parameters:
- vaults: A lookup table of vaults that have changed.
- Event.Guild.Bank.Coin
- Event documentation:
- Signals a change in the guild bank's money.
- Event.Guild.Bank.Coin(coin)
- Parameters:
- coin: The new amount of money in the guild bank.
- Event.Guild.Log
- Event documentation:
- Signals incoming guild log data. Can be triggered manually with Command.Guild.Log.Request().
- Event.Guild.Log(log)
- Parameters:
- log: An array containing the refreshed guild log items, in order.
- Parameter members:
- achievement: The achievement involved.
- coin: The amount of silver involved.
- count: The number of items involved.
- item: The item type involved.
- level: The level involved.
- rank: The rank involved.
- source: The source of the log event.
- target: The target of the log event.
- 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.
- xp: The amount of XP involved.
- Event.Guild.Motd
- Event documentation:
- Signals a change in the guild Message of the Day.
- Event.Guild.Motd(motd)
- Parameters:
- motd: The new Message of the Day.
- Event.Guild.Rank
- Event documentation:
- Signals a change in one of your guild's ranks.
- Event.Guild.Rank(ranks)
- Parameters:
- ranks: A lookup table of ranks that have changed.
- Event.Guild.Roster.Add
- Event documentation:
- Signals a new player added to the guild roster.
- Event.Guild.Roster.Add(add)
- Parameters:
- add: The name of the added guildmember.
- Event.Guild.Roster.Detail.Level
- Event documentation:
- Signals a change in a guildmember's level.
- Event.Guild.Roster.Detail.Level(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Guild.Roster.Detail.Note
- Event documentation:
- Signals a change in a guildmember's note.
- Event.Guild.Roster.Detail.Note(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Guild.Roster.Detail.NoteOfficer
- Event documentation:
- Signals a change in a guildmember's officer note.
- Event.Guild.Roster.Detail.NoteOfficer(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Guild.Roster.Detail.Rank
- Event documentation:
- Signals a change in a guildmember's rank.
- Event.Guild.Roster.Detail.Rank(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Guild.Roster.Detail.Status
- Event documentation:
- Signals a change in a guildmember's status.
- Event.Guild.Roster.Detail.Status(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Guild.Roster.Detail.Zone
- Event documentation:
- Signals a change in a guildmember's zone.
- Event.Guild.Roster.Detail.Zone(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Guild.Roster.Remove
- Event documentation:
- Signals a player removed from the guild roster.
- Event.Guild.Roster.Remove(remove)
- Parameters:
- remove: The name of the removed guildmember.
- Event.Guild.Wall
- Event documentation:
- Signals incoming guild wall data. Can be triggered manually with Command.Guild.Wall.Request().
- Event.Guild.Wall(wall)
- Parameters:
- wall: An array containing the refreshed guild wall items, in order.
- Parameter members:
- id: The ID of the guild wall entry.
- poster: The poster of the guild wall entry.
- text: The text of the guild wall entry.
- time: The time the wall entry was posted, in UNIX time.
- Event.Interaction
- Event documentation:
- Signals a change in available interaction types.
- Event.Interaction(interaction, state)
- Parameters:
- interaction: The identifier of the interaction type. May be any of "auction", "bank", "guildbank", or "mail".
- state: Boolean indicating whether or not that interaction is available.
- Event.Item.Slot
- Event documentation:
- Signals that the contents of an item slot have changed.
- Event.Item.Slot(updates)
- Parameters:
- 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.
- Event.Item.Update
- Event documentation:
- Signals that an item has changed.
- Event.Item.Update(updates)
- Parameters:
- 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.
- Event.Mail
- Event documentation:
- Signals a change in the available mail messages.
- Event.Mail(mail)
- Parameters:
- 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.
- Event.Map.Add
- Event documentation:
- Signals the addition of a map element.
- Event.Map.Add(elements)
- Parameters:
- elements: The changed elements. Takes the form of a table. The key is the element ID.
- Event.Map.Change
- Event documentation:
- Signals the change of a map element, in some manner besides coordinates.
- Event.Map.Change(elements)
- Parameters:
- elements: The changed elements. Takes the form of a table. The key is the element ID.
- Event.Map.Detail.Coord
- Event documentation:
- Signals the coordinate change of a map element.
- Event.Map.Detail.Coord(x, y, z)
- Parameters:
- x: The new X coordinate of the changed elements. Takes the form of a table. The key is the element ID.
- y: The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID.
- z: The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID.
- Event.Map.Remove
- Event documentation:
- Signals the removal of a map element.
- Event.Map.Remove(elements)
- Parameters:
- elements: The changed elements. Takes the form of a table. The key is the element ID.
- Event.Map.Waypoint.Update
- Event documentation:
- Signals the change of a player's waypoint.
- Event.Map.Waypoint.Update(units)
- Parameters:
- units: The unit whose waypoint has changed. Takes the form of a table. The key is the element ID.
- Event.Message.Receive
- Event documentation:
- Signals the receipt of an addon message.
- Event.Message.Receive(from, type, channel, identifier, data)
- Parameters:
- from: The name of the player this message is from.
- type: The type of this message. May be any of "send", "tell", "channel", "guild", "officer", "party", "raid", "say", or "yell".
- channel: If type is "channel", the channel that this message was sent to. Otherwise, nil.
- identifier: The identifier for this message.
- data: The data payload for this message type.
- Event.Mouse.Move
- Event documentation:
- Signals the mouse moving.
- Event.Mouse.Move(x, y)
- Parameters:
- x: The mouse's new X position.
- y: The mouse's new Y position.
- Event.Pvp.History.Favor
- Event documentation:
- Signals your historical favor changing.
- Event.Pvp.History.Favor(favor)
- Parameters:
- favor: Amount of lifetime favor accumulated.
- Event.Pvp.History.Kill.Today
- Event documentation:
- Signals your daily kill count changing.
- Event.Pvp.History.Kill.Today(kill)
- Parameters:
- kill: Amount of kills made in this time period.
- Event.Pvp.Prestige.Accumulated
- Event documentation:
- Signals your accumulated prestige changing.
- Event.Pvp.Prestige.Accumulated(accumulated)
- Parameters:
- accumulated: Total quantity of accumulated prestige in this rank.
- Event.Pvp.Prestige.Rank
- Event documentation:
- Signals your prestige rank changing.
- Event.Pvp.Prestige.Rank(rank)
- Parameters:
- rank: Current prestige rank.
- Event.Quest.Abandon
- Event documentation:
- Signals that a quest has been abandoned.
- Event.Quest.Abandon(elements)
- Parameters:
- elements: The changed elements. Takes the form of a table. The key is the element ID.
- Event.Quest.Accept
- Event documentation:
- Signals that a quest has been accepted.
- Event.Quest.Accept(elements)
- Parameters:
- elements: The changed elements. Takes the form of a table. The key is the element ID.
- Event.Quest.Change
- Event documentation:
- Signals that a quest has been changed in some manner, most likely progress in an objective.
- Event.Quest.Change(elements)
- Parameters:
- elements: The changed elements. Takes the form of a table. The key is the element ID.
- Event.Quest.Complete
- Event documentation:
- Signals that a quest has been completed.
- Event.Quest.Complete(elements)
- Parameters:
- elements: The changed elements. Takes the form of a table. The key is the element ID.
- Event.Queue.Status
- Event documentation:
- Signals that a queue may have left or entered the throttled state.
- Event.Queue.Status(id)
- Parameters:
- id: The ID of the queue affected. To get the actual new state, use Inspect.Queue.Status().
- Event.Slash (category for dynamically-created events)
- Event.Slash.addonerror
- Frame event documentation:
- Addon-created event. No documentation available.
- Event.Slash.addonerror(handle, ...)
- Event.Slash.dump
- Frame event documentation:
- Addon-created event. No documentation available.
- Event.Slash.dump(handle, ...)
- Event.Slash.eventlog
- Frame event documentation:
- Addon-created event. No documentation available.
- Event.Slash.eventlog(handle, ...)
- Event.Slash.framecap
- Frame event documentation:
- Addon-created event. No documentation available.
- Event.Slash.framecap(handle, ...)
- Event.Slash.layout
- Frame event documentation:
- Addon-created event. No documentation available.
- Event.Slash.layout(handle, ...)
- Event.Social.Friend
- Event documentation:
- Signals a change in your friend list.
- Event.Social.Friend(friends)
- Parameters:
- friends: A lookup table containing the changed friends.
- Event.Social.Ignore
- Event documentation:
- Signals a change in your ignore list.
- Event.Social.Ignore(ignores)
- Parameters:
- ignores: A lookup table containing the changed ignored players.
- Event.Stat
- Event documentation:
- Signals a change in the player's stats.
- Event.Stat(stats)
- Parameters:
- stats: A table from stat ID to stat value, containing the stats that changed.
- Event.Storage.Get
- Event documentation:
- Signals receiving storage data from a target.
- Event.Storage.Get(target, segment, identifier, read, write, data)
- Parameters:
- target: The name of the player that has been inspected.
- segment: The segment that has been inspected, either "player" or "guild".
- identifier: The identifier that was inspected.
- read: The read permissions of this element. See Command.Storage.Set() for details.
- write: The write permissions of this element. See Command.Storage.Set() for details.
- data: The data contained in the requested element.
- Event.Storage.List
- Event documentation:
- Signals receiving a list of storage elements from a target.
- Event.Storage.List(target, segment, identifiers)
- Parameters:
- target: The name of the player that has been inspected.
- segment: The segment that has been inspected, either "player" or "guild".
- identifiers: A list of identifiers available to you, in {identifier = checksum} format.
- Event.System.Error
- Event documentation:
- 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.
- Event.System.Error(error)
- Parameters:
- error: Table containing error data.
- Parameter members:
- addon: The identifier of the responsible addon. Used in error types event, frameEvent, dispatch, fileNotFound, fileLoad, fileRun, perfWarning, perfError, text, and requirement.
- axis: The axis influenced by the error. Used in error types layoutLoop and layoutError.
- 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.
- error: The actual error message generated. Used in error types event, frameEvent, script, dispatch, fileLoad, fileRun, and text.
- event: The name of the event responsible. Used in error types event, frameEvent, and internal.
- file: The name of the file responsible. Used in error types fileNotFound, fileLoad, and fileRun.
- frame: The name of the frame that the event was generated on. Used in error type frameEvent.
- id: The internal ID of this error.
- info: The info string provided as part of the event handler. Used in error types event, dispatch, perfWarning, perfError, and requirement.
- script: The exact script entered by the user. Used in error type script.
- 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.
- 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.
- Event.System.Secure.Enter
- Event documentation:
- 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.
- Event.System.Secure.Enter()
- Event.System.Secure.Leave
- Event documentation:
- 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.
- Event.System.Secure.Leave()
- Event.System.Texture
- Event documentation:
- Signals information on Rift UI textures that have been seen.
- Event.System.Texture(textures)
- Parameters:
- textures: A lookup table of all textures that has been seen since the last event.
- Event.System.Update.Begin
- Event documentation:
- Signals the beginning of a frame render. This is your last chance to make UI changes for this frame.
- Event.System.Update.Begin()
- Event.System.Update.End
- Event documentation:
- Signals the end of a frame render.
- Event.System.Update.End()
- Event.TEMPORARY.Experience
- Event documentation:
- Signals a change in the player's experience.
- This event is deprecated and will be removed in the future. It should not be used.
- Event.TEMPORARY.Experience(accumulated, rested, needed)
- Parameters:
- accumulated: The amount of experience that has accumulated towards the next level.
- rested: The amount of rested experience that has accumulated.
- needed: The amount of experience required to reach the next level.
- Event.TEMPORARY.Role
- Event documentation:
- Signals a change in the player's current role.
- This event will be removed in the future.
- Event.TEMPORARY.Role(role)
- Parameters:
- role: The ID of the new role.
- Event.Title.Add
- Event documentation:
- Signals the addition of a new title.
- Event.Title.Add(titles)
- Parameters:
- titles: A lookup table of newly available titles.
- Event.Tooltip
- Event documentation:
- Signals that the tooltip has changed.
- Event.Tooltip(type, shown, buff)
- Parameters:
- type: The current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".
- shown: The blob describing the new element shown. Generally, some kind of identifier used in another part of the addon system.
- buff: The ID of the tooltip's new buff. "shown" will be a unit in this case.
- Event.Unit.Add
- Event documentation:
- 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.
- Event.Unit.Add(units)
- Parameters:
- 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.
- Event.Unit.Availability.Full
- Event documentation:
- Signals units entering Full availability.
- Event.Unit.Availability.Full(units)
- Parameters:
- 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.
- Event.Unit.Availability.None
- Event documentation:
- Signals units leaving availability entirely.
- Event.Unit.Availability.None(units)
- Parameters:
- 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.
- Event.Unit.Availability.Partial
- Event documentation:
- Signals units entering Partial availability, possibly on the way to Full or None availability.
- Event.Unit.Availability.Partial(units)
- Parameters:
- 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.
- Event.Unit.Castbar
- Event documentation:
- Signals a unit's castbar changing.
- Event.Unit.Castbar(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is a castbar visibility flag.
- Event.Unit.Detail.Absorb
- Event documentation:
- Signals a unit's damage absorption changing.
- Event.Unit.Detail.Absorb(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Afk
- Event documentation:
- Signals a unit's AFK flag changing. Will trigger only for partymembers.
- Event.Unit.Detail.Afk(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Aggro
- Event documentation:
- Signals a unit's aggro flag changing. Will trigger only for groupmembers.
- Event.Unit.Detail.Aggro(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Blocked
- Event documentation:
- Signals a unit's LOS-blocked flag changing. Will trigger only for groupmembers.
- Event.Unit.Detail.Blocked(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Charge
- Event documentation:
- Signals a unit's charge changing. Will trigger only for the player's unit ID.
- Event.Unit.Detail.Charge(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.ChargeMax
- Event documentation:
- Signals a unit's charge maximum changing. Will trigger only for the player's unit ID.
- Event.Unit.Detail.ChargeMax(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Combat
- Event documentation:
- Signals a unit's combat status changing.
- Event.Unit.Detail.Combat(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Combo
- Event documentation:
- Signals a unit's combo points changing. Will trigger only for the player's unit ID.
- Event.Unit.Detail.Combo(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Coord
- Event documentation:
- Signals a change in the unit's location.
- Event.Unit.Detail.Coord(x, y, z)
- Parameters:
- x: The new X coordinate of the changed elements. Takes the form of a table. The key is the element ID.
- y: The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID.
- z: The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID.
- Event.Unit.Detail.Energy
- Event documentation:
- Signals a unit's energy changing.
- Event.Unit.Detail.Energy(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.EnergyMax
- Event documentation:
- Signals a unit's energy maximum changing.
- Event.Unit.Detail.EnergyMax(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Guild
- Event documentation:
- Signals a unit's guild changing.
- Event.Unit.Detail.Guild(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Health
- Event documentation:
- Signals a unit's health changing.
- Event.Unit.Detail.Health(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.HealthCap
- Event documentation:
- Signals a unit's health cap changing.
- Event.Unit.Detail.HealthCap(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.HealthMax
- Event documentation:
- Signals a unit's health maximum changing.
- Event.Unit.Detail.HealthMax(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Level
- Event documentation:
- Signals a unit's level changing.
- Event.Unit.Detail.Level(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.LocationName
- Event documentation:
- Signals a unit's location name changing.
- Event.Unit.Detail.LocationName(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Mana
- Event documentation:
- Signals a unit's mana changing.
- Event.Unit.Detail.Mana(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.ManaMax
- Event documentation:
- Signals a unit's mana maximum changing.
- Event.Unit.Detail.ManaMax(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Mark
- Event documentation:
- Signals a unit's mark changing.
- Event.Unit.Detail.Mark(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Mentoring
- Event documentation:
- Signals a unit's mentoring status changing.
- Event.Unit.Detail.Mentoring(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Name
- Event documentation:
- Signals a unit's name changing.
- Event.Unit.Detail.Name(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Offline
- Event documentation:
- Signals a unit's offline flag changing. Will trigger only for partymembers.
- Event.Unit.Detail.Offline(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Planar
- Event documentation:
- Signals a unit's planar charges changing. Will trigger only for the player or groupmembers.
- Event.Unit.Detail.Planar(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.PlanarMax
- Event documentation:
- Signals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers.
- Event.Unit.Detail.PlanarMax(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Power
- Event documentation:
- Signals a unit's power changing.
- Event.Unit.Detail.Power(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.PublicSize
- Event documentation:
- Signals a unit's public group size or status changing.
- Event.Unit.Detail.PublicSize(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Pvp
- Event documentation:
- Signals a unit's PvP flag changing.
- Event.Unit.Detail.Pvp(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Radius
- Event documentation:
- Signals a unit's radius changing.
- Event.Unit.Detail.Radius(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Ready
- Event documentation:
- Signals a unit's readycheck status changing.
- Event.Unit.Detail.Ready(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or the string "nil" in place of nil.
- Event.Unit.Detail.Role
- Event documentation:
- Signals a unit's role changing. Will trigger only for the player or partymembers.
- Event.Unit.Detail.Role(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Tagged
- Event documentation:
- Signals a unit's tagged status changing.
- Event.Unit.Detail.Tagged(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.TitlePrefixId
- Event documentation:
- Signals a unit's title prefix ID changing.
- Event.Unit.Detail.TitlePrefixId(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.TitlePrefixName
- Event documentation:
- Signals a unit's localized title prefix changing.
- This event is deprecated and will be removed in the future. It should not be used.
- Event.Unit.Detail.TitlePrefixName(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.TitleSuffixId
- Event documentation:
- Signals a unit's title suffix ID changing.
- Event.Unit.Detail.TitleSuffixId(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.TitleSuffixName
- Event documentation:
- Signals a unit's localized title suffix changing.
- This event is deprecated and will be removed in the future. It should not be used.
- Event.Unit.Detail.TitleSuffixName(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Detail.Vitality
- Event documentation:
- Signals a unit's vitality changing. Will trigger only for the player or groupmembers.
- Event.Unit.Detail.Vitality(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Warfront
- Event documentation:
- Signals a unit's warfront flag changing. Will trigger only for partymembers.
- Event.Unit.Detail.Warfront(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value.
- Event.Unit.Detail.Zone
- Event documentation:
- Signals a change in the unit's zone.
- Event.Unit.Detail.Zone(units)
- Parameters:
- units: Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
- Event.Unit.Remove
- Event documentation:
- 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.
- Event.Unit.Remove(units)
- Parameters:
- 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.
- UI:
- Layout:
- Members:
- EventAttach
- Function documentation:
- Attaches an event handler to an event.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Layout:EventAttach(handle, callback, label) -- eventFrame, function, string
- Layout:EventAttach(handle, callback, label, priority) -- eventFrame, function, string, number
- Parameters:
- 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.
- handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
- label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
- priority: Priority of the event handler. Higher numbers trigger first.
- EventDetach
- Function documentation:
- 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.
- Layout:EventDetach(handle, callback) -- eventFrame, function/nil
- Layout:EventDetach(handle, callback, label) -- eventFrame, function/nil, string/nil
- Layout:EventDetach(handle, callback, label, priority) -- eventFrame, function/nil, string/nil, number/nil
- Layout:EventDetach(handle, callback, label, priority, owner) -- eventFrame, function/nil, string/nil, number/nil, string/nil
- Parameters:
- callback: A callback function to search for.
- handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
- label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
- owner: Owner to search for.
- priority: Priority of the event handler. Higher numbers trigger first.
- EventList
- Function documentation:
- Lists the current event handlers for an event.
- result = Layout:EventList(handle) -- table <- eventFrame
- Parameters:
- handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
- Return values:
- result: A table of event handlers for this event.
- Returned members:
- handler: The handler that will be called when the event fires.
- label: Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
- macro: The macro that will run when the event fires.
- owner: Owner to search for.
- priority: Priority of the event handler. Higher numbers trigger first.
- EventMacroGet
- Function documentation:
- Gets the macro that will be triggered when this event occurs.
- macro = Layout:EventMacroGet(handle) -- string/nil <- eventFrame
- Parameters:
- handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
- Return values:
- macro: The macro that will be triggered.
- EventMacroSet
- Function documentation:
- Sets the macro that will be triggered when this event occurs.
- Permitted only on a frame with "restricted" SecureMode while the addon environment is not secured.
- Layout:EventMacroSet(handle, macro) -- eventFrame, string/nil
- Parameters:
- handle: A handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
- macro: The macro to trigger. nil to clear the macro.
- GetBottom
- Function documentation:
- Retrieves the Y position of the bottom edge of this element.
- bottom = Layout:GetBottom() -- number <- void
- Return values:
- bottom: The Y position of the bottom edge of this element.
- GetBounds
- Function documentation:
- Retrieves the complete bounds of this element.
- left, top, right, bottom = Layout:GetBounds() -- number, number, number, number <- void
- Return values:
- bottom: The Y position of the bottom edge of this element.
- left: The X position of the left edge of this element.
- right: The X position of the right edge of this element.
- top: The Y position of the top edge of this element.
- GetEventTable
- Function documentation:
- Retrieves the event table of this element. By default, this value is also stored in "this.Event".
- eventTable = Layout:GetEventTable() -- table <- void
- Return values:
- eventTable: The event table of this element.
- GetHeight
- Function documentation:
- Retrieves the height of this element.
- height = Layout:GetHeight() -- number <- void
- Return values:
- height: The height of this element.
- GetLeft
- Function documentation:
- Retrieves the X position of the left edge of this element.
- left = Layout:GetLeft() -- number <- void
- Return values:
- left: The X position of the left edge of this element.
- GetName
- Function documentation:
- Retrieves the name of this element.
- name = Layout:GetName() -- string <- void
- Return values:
- name: The name of this element, as provided by the addon that created it.
- GetOwner
- Function documentation:
- Retrieves the owner of this element.
- owner = Layout:GetOwner() -- string <- void
- Return values:
- owner: The owner of this element. Given as an addon identifier.
- GetRight
- Function documentation:
- Retrieves the X position of the right edge of this element.
- right = Layout:GetRight() -- number <- void
- Return values:
- right: The X position of the right edge of this element.
- GetTop
- Function documentation:
- Retrieves the Y position of the top edge of this element.
- top = Layout:GetTop() -- number <- void
- Return values:
- top: The Y position of the top edge of this element.
- GetType
- Function documentation:
- Retrieves the type of this element.
- type = Layout:GetType() -- string <- void
- Return values:
- type: The type of this element.
- GetWidth
- Function documentation:
- Retrieves the width of this element.
- width = Layout:GetWidth() -- number <- void
- Return values:
- width: The width of this element.
- ReadAll
- Function documentation:
- Read all set points and sizes from this frame.
- results = Layout:ReadAll() -- table <- void
- Return values:
- results: Result table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.
- ReadHeight
- Function documentation:
- Read a set height from this frame.
- height = Layout:ReadHeight() -- number <- void
- Return values:
- height: The parameter passed to SetHeight(), or nil if no such parameter has been passed.
- ReadPoint
- Function documentation:
- Read a set point from this frame. Must be given a single-axis coordinate.
- layout, position, offset = Layout:ReadPoint(coordinate) -- Layout, number, number <- string
- layout, position, offset = Layout:ReadPoint(x, y) -- Layout, number, number <- number/nil, number/nil
- origin, offset = Layout:ReadPoint(coordinate) -- string, number <- string
- origin, offset = Layout:ReadPoint(x, y) -- string, number <- number/nil, number/nil
- Parameters:
- coordinate: Named coordinate. Must be a one-axis coordinate.
- x: X coordinate of the point. Either this or Y must be nil.
- y: Y coordinate of the point. Either this or X must be nil.
- Return values:
- layout: The table that this point is pinned to.
- offset: The offset in pixels from the source location to the actual location.
- origin: The string "origin".
- 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.
- ReadWidth
- Function documentation:
- Read a set width from this frame.
- width = Layout:ReadWidth() -- number <- void
- Return values:
- width: The parameter passed to SetWidth(), or nil if no such parameter has been passed.
- Events:
- Move
- Frame event documentation:
- Signals that the frame's vertices have moved.
- Layout.Event:Move()
- Size
- Frame event documentation:
- Signals that the frame's size has changed.
- Layout.Event:Size()
- Native: Inherits from Layout
- Members:
- GetLayer
- Function documentation:
- Gets the native item's layer order.
- layer = Native:GetLayer() -- number <- void
- Return values:
- layer: The render layer of this frame. See Frame:SetLayer for details.
- GetLoaded
- Function documentation:
- Gets whether or not this native element is loaded and rendering.
- loaded = Native:GetLoaded() -- boolean <- void
- Return values:
- loaded: true if it is loaded.
- GetSecureMode
- Function documentation:
- Get the native element's secure mode. See Frame:SetSecureMode() for details.
- secure = Native:GetSecureMode() -- string <- void
- Return values:
- secure: The current secure mode.
- GetStrata
- Function documentation:
- 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.
- strata = Native:GetStrata() -- string <- void
- Return values:
- strata: The item's current strata.
- GetStrataList
- Function documentation:
- Gets a list of valid stratas for this native element.
- stratas = Native:GetStrataList() -- table <- void
- Return values:
- stratas: An array of valid stratas, in order.
- SetLayer
- Function documentation:
- 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.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Native:SetLayer(layer) -- number
- Parameters:
- layer: The new layer for this frame.
- SetStrata
- Function documentation:
- Sets the strata for this native element.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Native:SetStrata(layer) -- string
- Parameters:
- layer: The new layer for this frame.
- Events:
- Layer
- Frame event documentation:
- Signals a change in the item's layer.
- Native.Event:Layer()
- Loaded
- Frame event documentation:
- Signals a change in the item's loaded status.
- Native.Event:Loaded()
- Strata
- Frame event documentation:
- Signals a change in the item's strata.
- Native.Event:Strata()
- Element: Inherits from Layout
- Members:
- GetAlpha
- Function documentation:
- Gets the alpha multiplier of this frame.
- alpha = Element:GetAlpha() -- number <- void
- Return values:
- 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.
- GetBackgroundColor
- Function documentation:
- Retrieves the background color of this frame.
- r, g, b, a = Element:GetBackgroundColor() -- number, number, number, number <- void
- Return values:
- a: Alpha. 1 is fully opaque, 0 is fully transparent.
- b: Blue.
- g: Green.
- r: Red.
- GetChildren
- Function documentation:
- Returns a table containing all of this element's children.
- children = Element:GetChildren() -- table <- void
- Return values:
- children: A table containing this element's children.
- GetKeyFocus
- Function documentation:
- Gets the key focus status.
- focus = Element:GetKeyFocus() -- boolean <- void
- Return values:
- focus: Whether this frame is the current key focus.
- GetMouseMasking
- Function documentation:
- Get the current mouse masking mode. See SetMouseMasking for details.
- mask = Element:GetMouseMasking() -- string <- void
- Return values:
- mask: The current mouse masking mode.
- GetVisible
- Function documentation:
- Gets the visibility flag for this frame.
- visible = Element:GetVisible() -- boolean <- void
- Return values:
- visible: This frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.
- SetAlpha
- Function documentation:
- Sets the alpha transparency multiplier for this frame and its children.
- Element:SetAlpha(alpha) -- number
- Parameters:
- alpha: The new alpha multiplier. 1 is fully opaque, 0 is fully transparent.
- SetBackgroundColor
- Function documentation:
- Sets the background color of this frame.
- Element:SetBackgroundColor(r, g, b) -- number, number, number
- Element:SetBackgroundColor(r, g, b, a) -- number, number, number, number
- Parameters:
- a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
- b: Blue.
- g: Green.
- r: Red.
- SetKeyFocus
- Function documentation:
- 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.
- Element:SetKeyFocus(focus) -- boolean
- Parameters:
- focus: The new key focus setting.
- SetMouseMasking
- Function documentation:
- Sets the frame's mouse masking mode.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Element:SetMouseMasking(mask) -- string
- Parameters:
- 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.
- SetVisible
- Function documentation:
- 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.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Element:SetVisible(visible) -- boolean
- Parameters:
- visible: The new visibility flag.
- Events:
- KeyDown
- KeyFocusGain
- KeyFocusLoss
- KeyRepeat
- KeyType
- KeyUp
- LeftClick
- LeftDown
- LeftUp
- LeftUpoutside
- MiddleClick
- MiddleDown
- MiddleUp
- MiddleUpoutside
- Mouse4Click
- Mouse4Down
- Mouse4Up
- Mouse4Upoutside
- Mouse5Click
- Mouse5Down
- Mouse5Up
- Mouse5Upoutside
- MouseIn
- MouseMove
- MouseOut
- RightClick
- RightDown
- RightUp
- RightUpoutside
- WheelBack
- WheelForward
- Frame: Inherits from Element
- Members:
- ClearAll
- Function documentation:
- Clear all set points and sizes from this frame.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:ClearAll() -- void
- ClearHeight
- Function documentation:
- Clear a set height from this frame.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:ClearHeight() -- void
- ClearPoint
- Function documentation:
- Clear a set point from this frame.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:ClearPoint(coordinate) -- string
- Frame:ClearPoint(x, y) -- number/nil, number/nil
- Parameters:
- coordinate: Named coordinate.
- x: X coordinate of the point.
- y: Y coordinate of the point.
- ClearWidth
- Function documentation:
- Clear a set width from this frame.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:ClearWidth() -- void
- GetLayer
- Function documentation:
- Gets the frame's layer order.
- layer = Frame:GetLayer() -- number <- void
- Return values:
- layer: The render layer of this frame. See Frame:SetLayer for details.
- GetMouseoverUnit
- Function documentation:
- Gets the unit that is being represented by this frame.
- unit = Frame:GetMouseoverUnit() -- string <- void
- Return values:
- unit: The current mouseover unit. May be nil if there is no mouseover unit.
- GetParent
- Function documentation:
- Gets the parent of this frame.
- parent = Frame:GetParent() -- Element <- void
- Return values:
- parent: The parent element of this frame.
- GetSecureMode
- Function documentation:
- Get the current secure mode. See SetSecureMode for details.
- secure = Frame:GetSecureMode() -- string <- void
- Return values:
- secure: The current secure mode.
- GetStrata
- Function documentation:
- 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.
- strata = Frame:GetStrata() -- string <- void
- Return values:
- strata: The item's current strata.
- GetStrataList
- Function documentation:
- Gets a list of valid stratas for this frame.
- stratas = Frame:GetStrataList() -- table <- void
- Return values:
- stratas: An array of valid stratas, in order.
- SetAllPoints
- Function documentation:
- 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.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:SetAllPoints() -- void
- Frame:SetAllPoints(target) -- Layout
- Parameters:
- target: Target Layout to pin this frame's edges to.
- SetHeight
- Function documentation:
- Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:SetHeight(height) -- number
- Parameters:
- height: The new height of this frame.
- SetLayer
- Function documentation:
- 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.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:SetLayer(layer) -- number
- Parameters:
- layer: The new layer for this frame.
- SetMouseoverUnit
- Function documentation:
- Sets the unit that will be represented by this frame.
- Permitted only on a frame with "restricted" SecureMode while the addon environment is not secured.
- Frame:SetMouseoverUnit(unit) -- unit
- Frame:SetMouseoverUnit(unit) -- nil
- Parameters:
- unit: The new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
- SetParent
- Function documentation:
- 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".
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:SetParent(parent) -- Element
- Parameters:
- parent: The new parent for this frame.
- SetPoint
- Function documentation:
- 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.
- 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]).
- 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".
- 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.
- Optionally, you may include an X or Y offset to the point.
- This connection is permanent, and if the target frame moves, this frame will move along with it.
- 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.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:SetPoint(...) -- ...
- Parameters:
- ...: This function's parameters are complicated. Read the above summary for details.
- SetSecureMode
- Function documentation:
- Sets the frame's secure mode.
- "normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
- If you are not planning to use any restricted functions, your frame should remain in normal mode.
- At the moment, it is not possible to change from "restricted" back to "normal".
- Frame:SetSecureMode(secure) -- string
- Parameters:
- secure: The new secure mode. Valid inputs are "normal" and "restricted".
- SetStrata
- Function documentation:
- Sets the strata for this frame.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:SetStrata(strata) -- string
- Parameters:
- strata: The item's new strata. Must be one of the elements returned by :GetStrataList().
- SetWidth
- Function documentation:
- Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- Frame:SetWidth(width) -- number
- Parameters:
- width: The new width of this frame.
- Events:
- Layer
- Frame event documentation:
- Signals a change in the item's layer.
- Frame.Event:Layer()
- Strata
- Frame event documentation:
- Signals a change in the item's strata.
- Frame.Event:Strata()
- Context: Inherits from Frame
- Members:
- (No extra members)
- Events:
- (No extra events)
- Canvas: Inherits from Frame
- Members:
- GetShape
- Function documentation:
- Returns the current canvas shape.
- shape, fill, stroke = Canvas:GetShape() -- table, table, table <- void
- Return values:
- fill: The current fill style. See Canvas:SetShape() for details.
- shape: The current shape. See Canvas:SetShape() for details.
- stroke: The current stroke style. See Canvas:SetShape() for details.
- SetShape
- Function documentation:
- Sets the canvas shape. Must have at least one of "fill" or "stroke".
- Canvas:SetShape(path, fill, stroke) -- nil, nil, nil
- Canvas:SetShape(path, fill, stroke) -- table, table, nil
- Canvas:SetShape(path, fill, stroke) -- table, nil, table
- Canvas:SetShape(path, fill, stroke) -- table, table, table
- Parameters:
- 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:
- type: One of "solid", "gradientLinear", "gradientRadial", "texture". Required.
- r: Red color value, betwen 0 and 1. Available and required for "solid".
- g: Green color value, betwen 0 and 1. Available and required for "solid".
- b: Blue color value, betwen 0 and 1. Available and required for "solid".
- a: Alpha color value, betwen 0 and 1. Defaults to 1. Available for "solid".
- 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:
- r: Red color value, between 0 and 1. Required.
- g: Green color value, between 0 and 1. Required.
- b: Blue color value, between 0 and 1. Required.
- a: Alpha color value, between 0 and 1. Defaults to 1.
- position: Location within the gradient. Must be nondecreasing. Gradient automatically rescales to fit the largest position value seen.
- 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".
- focus: Number between 0 and 1 controlling the center bias of radial gradients. Defaults to 0. Available for "gradientRadial".
- wrap: Control the bounds behavior of textures. Must be either "clamp" or "repeat". Defaults to "clamp". Available for "texture".
- smooth: Boolean controlling texture smoothing behavior. Defaults to true. Available for "texture".
- source: Source addon ID of the texture to be rendered. See Texture:SetTexture() for details. Available and required for "texture".
- texture: Texture identifier of the texture to be rendered. See Texture:SetTexture() for details. Available and required for "texture".
- 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:
- x/xProportional: x coordinate of this point. Required.
- y/yProportional: y coordinate of this point. Required.
- xControl/xControlProportional: x coordinate of the curve control handle. If this exists, yControl/yControlProportional must also exist.
- yControl/yControlProportional: y coordinate of the curve control handle. If this exists, xControl/xControlProportional must also exist.
- stroke: A stroke style. Members:
- r: Red color value, betwen 0 and 1. Required.
- g: Green color value, betwen 0 and 1. Required.
- b: Blue color value, betwen 0 and 1. Required.
- a: Alpha color value, betwen 0 and 1. Defaults to 1.
- cap: Endcap behavior for non-loops. May be "none", "square", or "round". Defaults to "round".
- miter: Corner behavior. May be "miter", "round", or "bevel". Defaults to "miter".
- 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".
- thickness: Line thickness. Required.
- Events:
- (No extra events)
- Mask: Inherits from Frame
- Members:
- GetShape
- Function documentation:
- Returns the current mask shape.
- shape = Mask:GetShape() -- table <- void
- Return values:
- shape: The current shape. See Canvas:SetShape() for details.
- SetShape
- Function documentation:
- Sets the mask shape. Note that masks with custom shapes will not cull mouse events according to the custom shape.
- Mask:SetShape(path) -- nil
- Mask:SetShape(path) -- table
- Parameters:
- 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:
- x/xProportional: x coordinate of this point. Required.
- y/yProportional: y coordinate of this point. Required.
- xControl/xControlProportional: x coordinate of the curve control handle. If this exists, yControl/yControlProportional must also exist.
- yControl/yControlProportional: y coordinate of the curve control handle. If this exists, xControl/xControlProportional must also exist.
- Events:
- (No extra events)
- Text: Inherits from Frame
- Members:
- GetEffectBlur
- Function documentation:
- Gets the current parameters for the Blur effect.
- effect = Text:GetEffectBlur() -- table <- void
- effect = Text:GetEffectBlur() -- nil <- void
- Return values:
- effect: The current parameters for this effect. All members are optional. Pass nil to disable the effect.
- Returned members:
- blurX: Controls how much blurring exists along the X axis. Defaults to 2.
- blurY: Controls how much blurring exists along the Y axis. Defaults to 2.
- GetEffectGlow
- Function documentation:
- Gets the current parameters for the Glow effect.
- effect = Text:GetEffectGlow() -- table <- void
- effect = Text:GetEffectGlow() -- nil <- void
- Return values:
- effect: The current parameters for this effect. All members are optional. Pass nil to disable the effect.
- Returned members:
- blurX: Controls how much blurring exists along the X axis. Defaults to 2.
- blurY: Controls how much blurring exists along the Y axis. Defaults to 2.
- colorA: Controls the alpha channel of the glow effect. Defaults to 1.
- colorB: Controls the blue channel of the glow effect. Defaults to 0.
- colorG: Controls the green channel of the glow effect. Defaults to 0.
- colorR: Controls the red channel of the glow effect. Defaults to 0.
- knockout: Enables the "knockout" effect. Defaults to false.
- offsetX: Controls the glow offset along the X axis. Defaults to 0.
- offsetY: Controls the glow offset along the Y axis. Defaults to 0.
- replace: Hides the original text. Defaults to false.
- strength: Controls the strength of the glow. Defaults to 1.
- GetFont
- Function documentation:
- Gets the current font used for this element.
- source, font = Text:GetFont() -- string, string <- void
- Return values:
- font: The actual font identifier. Either a resource identifier or a filename.
- 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.
- GetFontColor
- Function documentation:
- Gets the current font color for this element.
- r, g, b, a = Text:GetFontColor() -- number, number, number, number <- void
- Return values:
- a: Alpha. 1 is fully opaque, 0 is fully transparent.
- b: Blue.
- g: Green.
- r: Red.
- GetFontSize
- Function documentation:
- Gets the font size of the current element.
- fontsize = Text:GetFontSize() -- number <- void
- Return values:
- fontsize: The current font size of this element.
- GetText
- Function documentation:
- Get the current text for this element.
- text, html = Text:GetText() -- string, boolean <- void
- Return values:
- html: The current HTML flag.
- text: The current text of the element.
- GetWordwrap
- Function documentation:
- Gets the wordwrap flag for this element.
- wordwrap = Text:GetWordwrap() -- boolean <- void
- Return values:
- wordwrap: The current wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
- SetEffectBlur
- Function documentation:
- Sets the parameters for the Blur effect.
- Text:SetEffectBlur(effect) -- table
- Text:SetEffectBlur(effect) -- nil
- Parameters:
- effect: The parameters for this effect. All members are optional. Pass nil to disable the effect.
- Returned members:
- blurX: Controls how much blurring exists along the X axis. Defaults to 2.
- blurY: Controls how much blurring exists along the Y axis. Defaults to 2.
- SetEffectGlow
- Function documentation:
- Sets the parameters for the Glow effect.
- Text:SetEffectGlow(effect) -- table
- Text:SetEffectGlow(effect) -- nil
- Parameters:
- effect: The parameters for this effect. All members are optional. Pass nil to disable the effect.
- Returned members:
- blurX: Controls how much blurring exists along the X axis. Defaults to 2.
- blurY: Controls how much blurring exists along the Y axis. Defaults to 2.
- colorA: Controls the alpha channel of the glow effect. Defaults to 1.
- colorB: Controls the blue channel of the glow effect. Defaults to 0.
- colorG: Controls the green channel of the glow effect. Defaults to 0.
- colorR: Controls the red channel of the glow effect. Defaults to 0.
- knockout: Enables the "knockout" effect. Defaults to false.
- offsetX: Controls the glow offset along the X axis. Defaults to 0.
- offsetY: Controls the glow offset along the Y axis. Defaults to 0.
- replace: Hides the original text. Defaults to false.
- strength: Controls the strength of the glow. Defaults to 1.
- SetFont
- Function documentation:
- Sets the current font used for this element.
- Text:SetFont(source, font) -- string, string
- Parameters:
- font: The actual font identifier. Either a resource identifier or a filename.
- 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.
- SetFontColor
- Function documentation:
- Sets the current font color for this element.
- Text:SetFontColor(r, g, b) -- number, number, number
- Text:SetFontColor(r, g, b, a) -- number, number, number, number
- Parameters:
- a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
- b: Blue.
- g: Green.
- r: Red.
- SetFontSize
- Function documentation:
- Sets the current font size of this element.
- Text:SetFontSize(fontsize) -- number
- Parameters:
- fontsize: The new font size of this element.
- SetText
- Function documentation:
- Sets the current text for this element.
- Text:SetText(text) -- string
- Text:SetText(text, html) -- string, boolean
- Parameters:
- 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.')">.
- text: The new text for the element.
- SetWordwrap
- Function documentation:
- Sets the wordwrap flag for this element.
- Text:SetWordwrap(wordwrap) -- boolean
- Parameters:
- wordwrap: The new wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
- Events:
- (No extra events)
- Texture: Inherits from Frame
- Members:
- GetTexture
- Function documentation:
- Gets the current texture used for this element.
- source, texture = Texture:GetTexture() -- string, string <- void
- Return values:
- 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.
- texture: The actual texture identifier. Either a resource identifier or a filename.
- GetTextureHeight
- Function documentation:
- Returns the actual pixel height of the current texture.
- height = Texture:GetTextureHeight() -- number <- void
- Return values:
- height: The height of the current texture in pixels.
- GetTextureWidth
- Function documentation:
- Returns the actual pixel width of the current texture.
- width = Texture:GetTextureWidth() -- number <- void
- Return values:
- width: The width of the current texture in pixels.
- SetTexture
- Function documentation:
- Sets the current texture used for this element.
- Texture:SetTexture(source, texture) -- string, string
- Parameters:
- 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.
- texture: The actual texture identifier. Either a resource identifier or a filename.
- Events:
- (No extra events)
- RiftButton: Inherits from Frame
- Members:
- GetEnabled
- Function documentation:
- Gets whether the button is enabled or grayed out.
- enabled = RiftButton:GetEnabled() -- boolean <- void
- Return values:
- enabled: The current enable state of this item.
- GetSkin
- Function documentation:
- Gets the current skin of this item.
- skin = RiftButton:GetSkin() -- string <- void
- Return values:
- skin: The current skin. Possible results include "default" and "close".
- GetText
- Function documentation:
- Gets this button's text.
- text = RiftButton:GetText() -- string <- void
- Return values:
- text: The current text of the element.
- SetEnabled
- Function documentation:
- Sets whether the button is enabled or grayed out.
- RiftButton:SetEnabled(enabled) -- boolean
- Parameters:
- enabled: The new enable state of this item.
- SetSkin
- Function documentation:
- Sets the current skin of this item.
- RiftButton:SetSkin(skin) -- string
- Parameters:
- skin: The new skin. Possible values are "default" and "close".
- SetText
- Function documentation:
- Sets this button's text.
- RiftButton:SetText(text) -- string
- Parameters:
- text: The new text for the element.
- Events:
- LeftPress
- Frame event documentation:
- Signals that the button has been pressed. Equivalent to LeftClick, but triggers only while the button is enabled.
- RiftButton.Event:LeftPress()
- RiftCheckbox: Inherits from Frame
- Members:
- GetChecked
- Function documentation:
- Gets whether the button is checked or not.
- checked = RiftCheckbox:GetChecked() -- boolean <- void
- Return values:
- checked: The current checked state of this item.
- GetEnabled
- Function documentation:
- Gets whether the checkbox is enabled or grayed out.
- enabled = RiftCheckbox:GetEnabled() -- boolean <- void
- Return values:
- enabled: The current enable state of this item.
- SetChecked
- Function documentation:
- Sets whether the checkbox is checked or not.
- RiftCheckbox:SetChecked(checked) -- boolean
- Parameters:
- checked: The new checked state of this item.
- SetEnabled
- Function documentation:
- Sets whether the checkbox is enabled or grayed out.
- RiftCheckbox:SetEnabled(enabled) -- boolean
- Parameters:
- enabled: The new enable state of this item.
- Events:
- CheckboxChange
- Frame event documentation:
- Signals that the checkbox's checked state has changed.
- RiftCheckbox.Event:CheckboxChange()
- RiftScrollbar: Inherits from Frame
- Members:
- GetEnabled
- Function documentation:
- Gets whether the scrollbar is enabled or disabled.
- enabled = RiftScrollbar:GetEnabled() -- boolean <- void
- Return values:
- enabled: The current enable state of this item.
- GetOrientation
- Function documentation:
- Gets the current orientation of the scrollbar.
- orientation = RiftScrollbar:GetOrientation() -- string <- void
- Return values:
- orientation: The current orientation. Valid results include "vertical" and "horizontal".
- GetPosition
- Function documentation:
- Returns the current position of the scrollbar.
- position = RiftScrollbar:GetPosition() -- number <- void
- Return values:
- position: The current position of this scrollbar.
- GetRange
- Function documentation:
- Returns the current range of the scrollbar.
- minimum, maximum = RiftScrollbar:GetRange() -- number, number <- void
- Return values:
- maximum: The maximum value for the position of this slider.
- minimum: The minimum value for the position of this slider.
- GetThickness
- Function documentation:
- Returns the thickness of the scrollbar handle. Size is relative to the range.
- thickness = RiftScrollbar:GetThickness() -- number <- void
- Return values:
- thickness: The thickness of the handle.
- Nudge
- Function documentation:
- Modify the scrollbar position, clamped to the current bounds.
- RiftScrollbar:Nudge(offset) -- number
- Parameters:
- offset: The amount to nudge.
- NudgeDown
- Function documentation:
- Shift the scrollbar down (i.e. away from zero) by a standard amount.
- RiftScrollbar:NudgeDown() -- void
- NudgeUp
- Function documentation:
- Shift the scrollbar up (i.e. towards zero) by a standard amount.
- RiftScrollbar:NudgeUp() -- void
- SetEnabled
- Function documentation:
- Sets whether the scrollbar is enabled or disabled.
- RiftScrollbar:SetEnabled(enabled) -- boolean
- Parameters:
- enabled: The new enable state of this item.
- SetOrientation
- Function documentation:
- Sets the orientation of the scrollbar.
- RiftScrollbar:SetOrientation(orientation) -- string
- Parameters:
- orientation: The new orientation. Must be either "vertical" or "horizontal".
- SetPosition
- Function documentation:
- Changes the current position of the scrollbar.
- RiftScrollbar:SetPosition(position) -- number
- Parameters:
- position: The new position of this scrollbar. Must be within the current range.
- SetRange
- Function documentation:
- Changes the current range of the scrollbar.
- RiftScrollbar:SetRange(minimum, maximum) -- number, number
- Parameters:
- maximum: The new maximum value for the position of this slider. Must be an integer and larger than or equal to "minimum".
- minimum: The new minimum value for the position of this slider. Must be an integer and smaller than or equal to "maximum".
- SetThickness
- Function documentation:
- Sets the current thickness of the scrollbar handle. Size is relative to the range.
- RiftScrollbar:SetThickness(thickness) -- number
- Parameters:
- thickness: The new thickness of the handle.
- Events:
- ScrollbarChange
- Frame event documentation:
- Signals a change in the scrollbar position.
- RiftScrollbar.Event:ScrollbarChange()
- ScrollbarGrab
- Frame event documentation:
- Signals the user grabbing the scrollbar with the mouse.
- RiftScrollbar.Event:ScrollbarGrab()
- ScrollbarRelease
- Frame event documentation:
- Signals the user releasing the scrollbar.
- RiftScrollbar.Event:ScrollbarRelease()
- RiftSlider: Inherits from Frame
- Members:
- GetEnabled
- Function documentation:
- Gets whether the slider is enabled or grayed out.
- enabled = RiftSlider:GetEnabled() -- boolean <- void
- Return values:
- enabled: The current enable state of this item.
- GetPosition
- Function documentation:
- Returns the current position of the slider.
- position = RiftSlider:GetPosition() -- number <- void
- Return values:
- position: The current position of this slider.
- GetRange
- Function documentation:
- Returns the current range of the slider.
- minimum, maximum = RiftSlider:GetRange() -- number, number <- void
- Return values:
- maximum: The maximum value for the position of this slider.
- minimum: The minimum value for the position of this slider.
- SetEnabled
- Function documentation:
- Sets whether the slider is enabled or grayed out.
- RiftSlider:SetEnabled(enabled) -- boolean
- Parameters:
- enabled: The new enable state of this item.
- SetPosition
- Function documentation:
- Changes the current position of the slider.
- RiftSlider:SetPosition(position) -- number
- Parameters:
- position: The new position of this slider. Must be within the current range.
- SetRange
- Function documentation:
- Sets the current range of the slider.
- RiftSlider:SetRange(minimum, maximum) -- number, number
- Parameters:
- maximum: The new maximum value for the position of this slider. Must be an integer and larger than or equal to "minimum".
- minimum: The new minimum value for the position of this slider. Must be an integer and smaller than or equal to "maximum".
- Events:
- SliderChange
- Frame event documentation:
- Signals a change in the slider position.
- RiftSlider.Event:SliderChange()
- SliderGrab
- Frame event documentation:
- Signals the user grabbing the slider with the mouse.
- RiftSlider.Event:SliderGrab()
- SliderRelease
- Frame event documentation:
- Signals the user releasing the slider.
- RiftSlider.Event:SliderRelease()
- RiftTextfield: Inherits from Frame
- Members:
- GetCursor
- Function documentation:
- Returns the current position of the cursor.
- cursor = RiftTextfield:GetCursor() -- number <- void
- Return values:
- cursor: The current position of this cursor. 0 indicates a cursor placed before any text.
- GetSelection
- Function documentation:
- Returns the current bounds of the selected text.
- begin, end = RiftTextfield:GetSelection() -- number, number <- void
- Return values:
- begin: The beginning of the selected text, in the same format GetCursor uses. nil if there is no text selected.
- end: The end of the selected text, in the same format GetCursor uses. nil if there is no text selected.
- GetSelectionText
- Function documentation:
- Get the current selected text for this element. Returns nil if no text has been selected.
- text = RiftTextfield:GetSelectionText() -- string <- void
- Return values:
- text: The current text of the element.
- GetText
- Function documentation:
- Get the current text for this element.
- text = RiftTextfield:GetText() -- string <- void
- Return values:
- text: The current text of the element.
- SetCursor
- Function documentation:
- Changes the current position of the cursor.
- RiftTextfield:SetCursor(cursor) -- number
- Parameters:
- cursor: The new position of this cursor. Must be within the valid range.
- SetSelection
- Function documentation:
- Sets the current bounds of the selected text. Call with no arguments to remove the current selection.
- RiftTextfield:SetSelection() -- void
- RiftTextfield:SetSelection(begin, end) -- number, number
- Parameters:
- begin: The new beginning of the selected text, in the same format SetCursor uses. Must be an integer and smaller than "end".
- end: The new end of the selected text, in the same format SetCursor uses. Must be an integer and larger than "begin".
- SetText
- Function documentation:
- Set the current text for this element.
- RiftTextfield:SetText(text) -- string
- Parameters:
- text: The new text for the element.
- Events:
- TextfieldChange
- Frame event documentation:
- Signals that the textfield's text has changed.
- RiftTextfield.Event:TextfieldChange()
- TextfieldSelect
- Frame event documentation:
- Signals that the textfield's selection has changed.
- RiftTextfield.Event:TextfieldSelect()
- RiftWindow: Inherits from Frame
- Members:
- GetBorder
- Function documentation:
- Gets the element representing the window border.
- border = RiftWindow:GetBorder() -- Element <- void
- Return values:
- border: The window border.
- GetContent
- Function documentation:
- Gets the element representing the window content area.
- content = RiftWindow:GetContent() -- Element <- void
- Return values:
- content: The window content area.
- GetController
- Function documentation:
- Gets the ID of the current controller for this window.
- controller = RiftWindow:GetController() -- string <- void
- Return values:
- controller: "border" or "content", whichever dictates the dimensions of the other.
- GetTitle
- Function documentation:
- Get the current title for this element.
- title = RiftWindow:GetTitle() -- string <- void
- Return values:
- title: The current title of the element.
- GetTrimDimensions
- Function documentation:
- Gets the thicknesses of the border's visual trim.
- left, top, right, bottom = RiftWindow:GetTrimDimensions() -- number, number, number, number <- void
- Return values:
- bottom: The thickness of the bottom window border.
- left: The thickness of the left window border.
- right: The thickness of the right window border.
- top: The thickness of the top window border.
- SetController
- Function documentation:
- 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.
- Not permitted on a frame with "restricted" SecureMode while the addon environment is secured.
- RiftWindow:SetController(controller) -- string
- Parameters:
- controller: The new controller ID. May be either "border" or "content".
- SetTitle
- Function documentation:
- Set the current title for this element.
- RiftWindow:SetTitle(title) -- string
- Parameters:
- title: The new title for the element.
- Events:
- (No extra events)
- Frame events:
- Event.UI.Button.Left.Press
- Frame event documentation:
- Signals that a Button has been pressed with the left mouse button. Equivalent to LeftClick, but triggers only while the button is enabled.
- Event.UI.Button.Left.Press(handle)
- Event.UI.Checkbox.Change
- Frame event documentation:
- Signals that a checkbox's state has changed.
- Event.UI.Checkbox.Change(handle)
- Event.UI.Input.Key.Down
- Frame event documentation:
- Signals that a keyboard key has been pressed. Requires key focus.
- Event.UI.Input.Key.Down(handle, key)
- Parameters:
- 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.
- Event.UI.Input.Key.Focus.Gain
- Frame event documentation:
- Signals that a frame has gained the key focus.
- Event.UI.Input.Key.Focus.Gain(handle)
- Event.UI.Input.Key.Focus.Loss
- Frame event documentation:
- Signals that a frame has lost the key focus.
- Event.UI.Input.Key.Focus.Loss(handle)
- Event.UI.Input.Key.Repeat
- Frame event documentation:
- Signals that a keyboard key is repeating. Requires key focus.
- Event.UI.Input.Key.Repeat(handle, key)
- Parameters:
- 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.
- Event.UI.Input.Key.Type
- Frame event documentation:
- Signals that text has been typed. Requires key focus.
- Event.UI.Input.Key.Type(handle, text)
- Parameters:
- text: The text that has been entered.
- Event.UI.Input.Key.Up
- Frame event documentation:
- Signals that a keyboard key has been released. Requires key focus.
- Event.UI.Input.Key.Up(handle, key)
- Parameters:
- 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.
- Event.UI.Input.Mouse.Cursor.In
- Frame event documentation:
- Signals that the cursor has moved into a frame.
- Event.UI.Input.Mouse.Cursor.In(handle)
- Event.UI.Input.Mouse.Cursor.Move
- Frame event documentation:
- Signals that the cursor has moved within a frame.
- Event.UI.Input.Mouse.Cursor.Move(handle)
- Event.UI.Input.Mouse.Cursor.Out
- Frame event documentation:
- Signals that the cursor has moved out of a frame.
- Event.UI.Input.Mouse.Cursor.Out(handle)
- Event.UI.Input.Mouse.Left.Click
- Frame event documentation:
- Signals that the user has clicked the left mouse button.
- Event.UI.Input.Mouse.Left.Click(handle)
- Event.UI.Input.Mouse.Left.Down
- Frame event documentation:
- Signals that the user has pressed the left mouse button.
- Event.UI.Input.Mouse.Left.Down(handle)
- Event.UI.Input.Mouse.Left.Up
- Frame event documentation:
- Signals that the user has released the left mouse button.
- Event.UI.Input.Mouse.Left.Up(handle)
- Event.UI.Input.Mouse.Left.Upoutside
- Frame event documentation:
- Signals that the user has released the left mouse button off this frame after pressing it on this frame.
- Event.UI.Input.Mouse.Left.Upoutside(handle)
- Event.UI.Input.Mouse.Middle.Click
- Frame event documentation:
- Signals that the user has clicked the middle mouse button.
- Event.UI.Input.Mouse.Middle.Click(handle)
- Event.UI.Input.Mouse.Middle.Down
- Frame event documentation:
- Signals that the user has pressed the middle mouse button.
- Event.UI.Input.Mouse.Middle.Down(handle)
- Event.UI.Input.Mouse.Middle.Up
- Frame event documentation:
- Signals that the user has released the middle mouse button.
- Event.UI.Input.Mouse.Middle.Up(handle)
- Event.UI.Input.Mouse.Middle.Upoutside
- Frame event documentation:
- Signals that the user has released the middle mouse button off this frame after pressing it on this frame.
- Event.UI.Input.Mouse.Middle.Upoutside(handle)
- Event.UI.Input.Mouse.Mouse4.Click
- Frame event documentation:
- Signals that the user has clicked the fourth mouse button.
- Event.UI.Input.Mouse.Mouse4.Click(handle)
- Event.UI.Input.Mouse.Mouse4.Down
- Frame event documentation:
- Signals that the user has pressed the fourth mouse button.
- Event.UI.Input.Mouse.Mouse4.Down(handle)
- Event.UI.Input.Mouse.Mouse4.Up
- Frame event documentation:
- Signals that the user has released the fourth mouse button.
- Event.UI.Input.Mouse.Mouse4.Up(handle)
- Event.UI.Input.Mouse.Mouse4.Upoutside
- Frame event documentation:
- Signals that the user has released the fourth mouse button off this frame after pressing it on this frame.
- Event.UI.Input.Mouse.Mouse4.Upoutside(handle)
- Event.UI.Input.Mouse.Mouse5.Click
- Frame event documentation:
- Signals that the user has clicked the fifth mouse button.
- Event.UI.Input.Mouse.Mouse5.Click(handle)
- Event.UI.Input.Mouse.Mouse5.Down
- Frame event documentation:
- Signals that the user has pressed the fifth mouse button.
- Event.UI.Input.Mouse.Mouse5.Down(handle)
- Event.UI.Input.Mouse.Mouse5.Up
- Frame event documentation:
- Signals that the user has released the fifth mouse button.
- Event.UI.Input.Mouse.Mouse5.Up(handle)
- Event.UI.Input.Mouse.Mouse5.Upoutside
- Frame event documentation:
- Signals that the user has released the fifth mouse button off this frame after pressing it on this frame.
- Event.UI.Input.Mouse.Mouse5.Upoutside(handle)
- Event.UI.Input.Mouse.Right.Click
- Frame event documentation:
- Signals that the user has clicked the right mouse button.
- Event.UI.Input.Mouse.Right.Click(handle)
- Event.UI.Input.Mouse.Right.Down
- Frame event documentation:
- Signals that the user has pressed the right mouse button.
- Event.UI.Input.Mouse.Right.Down(handle)
- Event.UI.Input.Mouse.Right.Up
- Frame event documentation:
- Signals that the user has released the right mouse button.
- Event.UI.Input.Mouse.Right.Up(handle)
- Event.UI.Input.Mouse.Right.Upoutside
- Frame event documentation:
- Signals that the user has released the right mouse button off this frame after pressing it on this frame.
- Event.UI.Input.Mouse.Right.Upoutside(handle)
- Event.UI.Input.Mouse.Wheel.Back
- Frame event documentation:
- Signals that the user has moved the mousewheel back.
- Event.UI.Input.Mouse.Wheel.Back(handle)
- Event.UI.Input.Mouse.Wheel.Forward
- Frame event documentation:
- Signals that the user has moved the mousewheel forwards.
- Event.UI.Input.Mouse.Wheel.Forward(handle)
- Event.UI.Layout.Layer
- Frame event documentation:
- Signals a change in layer.
- Event.UI.Layout.Layer(handle)
- Event.UI.Layout.Move
- Frame event documentation:
- Signals a change in the top-left corner's position. May be delayed after the actual movement.
- Event.UI.Layout.Move(handle)
- Event.UI.Layout.Size
- Frame event documentation:
- Signals a change in size. May be delayed after the actual change.
- Event.UI.Layout.Size(handle)
- Event.UI.Layout.Strata
- Frame event documentation:
- Signals a change in strata.
- Event.UI.Layout.Strata(handle)
- Event.UI.Native.Loaded
- Frame event documentation:
- Signals a change in this native frame's loaded state.
- Event.UI.Native.Loaded(handle)
- Event.UI.Scrollbar.Change
- Frame event documentation:
- Signals a change in scrollbar position.
- Event.UI.Scrollbar.Change(handle)
- Event.UI.Scrollbar.Grab
- Frame event documentation:
- Signals that a scrollbar has been grabbed.
- Event.UI.Scrollbar.Grab(handle)
- Event.UI.Scrollbar.Release
- Frame event documentation:
- Signals that a scrollbar has been released.
- Event.UI.Scrollbar.Release(handle)
- Event.UI.Slider.Change
- Frame event documentation:
- Signals a change in slider position.
- Event.UI.Slider.Change(handle)
- Event.UI.Slider.Grab
- Frame event documentation:
- Signals that a slider has been grabbed.
- Event.UI.Slider.Grab(handle)
- Event.UI.Slider.Release
- Frame event documentation:
- Signals that a slider has been released.
- Event.UI.Slider.Release(handle)
- Event.UI.Textfield.Change
- Frame event documentation:
- Signals a change in textfield contents.
- Event.UI.Textfield.Change(handle)
- Event.UI.Textfield.Select
- Frame event documentation:
- Signals a change in textfield selection.
- Event.UI.Textfield.Select(handle)
- Parameter types:
- Canvas
- A UI element of type Canvas or derived from Canvas.
- Context
- A UI element of type Context or derived from Context.
- Element
- A UI element of type Element or derived from Element.
- Frame
- A UI element of type Frame or derived from Frame.
- Layout
- A UI element of type Layout or derived from Layout.
- Mask
- A UI element of type Mask or derived from Mask.
- Native
- A UI element of type Native or derived from Native.
- RiftButton
- A UI element of type RiftButton or derived from RiftButton.
- RiftCheckbox
- A UI element of type RiftCheckbox or derived from RiftCheckbox.
- RiftScrollbar
- A UI element of type RiftScrollbar or derived from RiftScrollbar.
- RiftSlider
- A UI element of type RiftSlider or derived from RiftSlider.
- RiftTextfield
- A UI element of type RiftTextfield or derived from RiftTextfield.
- RiftWindow
- A UI element of type RiftWindow or derived from RiftWindow.
- Text
- A UI element of type Text or derived from Text.
- Texture
- A UI element of type Texture or derived from Texture.
- ability
- An ability, represented by a standard identifier with an 'a' prefix.
- achievement
- An achievement, represented by a standard identifier with a 'c' prefix.
- achievementcategory
- An achievement category, represented by a standard identifier with a 'C' prefix.
- auction
- An auction, represented by a standard identifier with an 'o' prefix.
- boolean
- A value of type 'boolean'.
- buff
- A buff, represented by a standard identifier with a 'b' prefix.
- callbackfunction
- 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.
- console
- A text console, represented by a standard ID with a 'v' prefix.
- currencycategory
- A currency category, represented by a standard identifier with a 'N' prefix.
- dimensionitem
- A dimension item, represented by a standard identifier with a 'd' prefix.
- error
- An error, represented by a standard ID with an 'x' prefix.
- eventFrame
- A frame event handle.
- eventGlobal
- A global event handle.
- faction
- A faction, represented by a standard ID with an 'f' prefix.
- frameEventTable
- A frame event table of a UI element.
- function
- A value of type 'function'.
- function/nil
- A value of type "function" or "nil".
- function/string
- A value of type "function" or "string".
- function/string/nil
- A value of type "function", "string", or "nil".
- guildrank
- A guild rank, represented by a standard identifier with a 'k' prefix.
- guildwall
- A guild wall ID, represented by a standard identifier with a 'w' prefix.
- handleEventFrame
- 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.
- handleEventGlobal
- A handle for active global events. Currently contains no members.
- item
- An item, represented by either a standard identifier with an 'i' prefix or a slot.
- itemtype
- An item type, represented by a nonstandard identifier with an 'I' prefix.
- location
- A map location, represented by a nonstandard identifier with an 'l' prefix.
- mail
- A mail, represented by a standard identifier with an 'm' prefix.
- nil
- A value of type 'nil'.
- number
- A value of type 'number'. May not be NaN.
- number/nil
- A value of type 'number' or 'nil'. May not be NaN.
- quest
- A quest, represented by a standard identifier with a 'q' prefix.
- role
- A role, represented by a standard identifier with a "h" prefix.
- slot
- An item slot, represented by a nonstandard identifier with an 's' prefix, as generated by the Utility.Item.Slot.* functions.
- string
- A value of type 'string'.
- string/nil
- A value of type 'string' or 'nil'.
- table
- A value of type 'table'.
- title
- A title, represented by a standard identifier with a 't' prefix.
- titlecategory
- A title category, represented by a standard identifier with a 'T' prefix.
- unit
- 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.
- variant
- A value of any type.
- zone
- A zone, represented by a standard identifier with a 'z' prefix.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement