| Name | Type | Deprecated | Secure | Description |
|---|---|---|---|---|
| Command.Auction.Bid | function | Bids on an auction. | ||
| Command.Auction.Cancel | function | Cancels an auction. | ||
| Command.Auction.Post | function | Posts a new auction. | ||
| Command.Auction.Scan | function | Requests an auction house scan. If "index" is omitted then this function will error if the "aucti... | ||
| Command.Buff.Cancel | function | Cancels a buff on the player. Not all buffs are cancelable. | ||
| Command.Buff.Describe | function | Requests a detailed description for a given buff. | ||
| Command.Console.Display | function | Prints a line of text in a console window of your choice. Note that the line length is limited, i... | ||
| Command.Cursor | function | Changes the contents of the cursor. Ability cursors may be set only if the environment is not in ... | ||
| Command.Dimension.Layout.Pickup | function | Pick up the specified dimension item from the world to your inventory. | ||
| Command.Dimension.Layout.Place | function | Places the item (dimension or inventory) in your current dimension and modifies the details speci... | ||
| Command.Dimension.Layout.Select | function | Selects or deselects the specified dimension item. | ||
| Command.Event.Attach | function | Attaches an event handler to an event. | ||
| Command.Event.Detach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| Command.Guild.Bank.Deposit | function | Deposits money into the guild bank. | ||
| Command.Guild.Bank.Purchase | function | Purchases a new guild bank vault. | ||
| Command.Guild.Bank.Withdraw | function | Withdraws money from the guild bank. | ||
| Command.Guild.Log.Request | function | Requests a guild log event. | ||
| Command.Guild.Motd | function | Changes the guild's Message of the Day. | ||
| Command.Guild.Roster.Demote | function | Demotes a guildmember by one rank. | ||
| Command.Guild.Roster.Kick | function | Kicks a guildmember from the guild. | ||
| Command.Guild.Roster.Note | function | Changes your guild note. | ||
| Command.Guild.Roster.NoteOfficer | function | Changes a guildmember's officer note. | ||
| Command.Guild.Roster.Promote | function | Promotes a guildmember by one rank. | ||
| Command.Guild.Wall.Delete | function | Deletes an entry from the guild wall. | ||
| Command.Guild.Wall.Post | function | Posts an entry to the guild wall. | ||
| Command.Guild.Wall.Request | function | Requests a guild wall event. | ||
| Command.Item.Destroy | function | Destroys an item. Be careful: this really does destroy an item. There is no confirmation dialog a... | ||
| Command.Item.Move | function | Moves an item from one location to another. This cannot move items directly between equipment, wa... | ||
| Command.Item.Split | function | Splits a number of items off a stack. | ||
| Command.Item.Standard.Drag | function | Behaves in the same way that the addon system does when an inventory icon is dragged. | ||
| Command.Item.Standard.Drop | function | Behaves in the same way that the addon system does when an inventory icon is dropped. | ||
| Command.Item.Standard.Left | function | Behaves in the same way that the addon system does when an inventory icon is left-clicked. | ||
| Command.Item.Standard.Right | function | Behaves in the same way that the addon system does when an inventory icon is right-clicked. | ||
| Command.Mail.Delete | function | Deletes a mail. | ||
| Command.Mail.Open | function | Opens a mail, retrieving detailed information for it. | ||
| Command.Mail.Pay | function | Pays the COD fee on a mail. | ||
| Command.Mail.Return | function | Returns a mail to its sender. | ||
| Command.Mail.Send | function | Sends mail. | ||
| Command.Mail.Spam | function | Marks mail as spam. | ||
| Command.Mail.Take | function | Takes an attached item from mail. | ||
| Command.Map.Monitor | function | Controls the state of the map monitor flag. When enabled, mainmap data will be received, updating... | ||
| Command.Message.Accept | function | Sets the environment to accept a given type and identifier of message. Parameters can be replaced... | ||
| Command.Message.Broadcast | function | Broadcast an unreliable addon message to some number of targets. This message will be dropped sil... | ||
| Command.Message.Reject | function | Sets the environment to reject a given type and identifier of message. Directly cancels out singl... | ||
| Command.Message.Send | function | Send an reliable addon message to a single target. The callback will respond with success only o... | ||
| Command.Quest.Abandon | function | Abandons the given quest. Permitted only on personal quests. | ||
| Command.Quest.Share | function | Shares the given quest. Permitted only on personal quests. | ||
| Command.Quest.Track | function | Tracks the current quest, un-tracking any other quest that may be tracked. Pass in "nil" to cance... | ||
| Command.Quest.Watch | function | Watches a quest, possibly unwatching another quest if the player is already watching the maximum ... | ||
| Command.Queue.Handler | function | Sets the queue handler function. The queue handler function will be called when a Command.* funct... | ||
| Command.Slash.Register | function | Registers a new chat slash command, inserts a new event table into the Event.Slash hierarchy, and... | ||
| Command.Social.Friend.Add | function | Adds a player to your friend list. | ||
| Command.Social.Friend.Note | function | Changes a friend's personal note. | ||
| Command.Social.Friend.Remove | function | Removes a player from your friend list. | ||
| Command.Social.Ignore.Add | function | Adds an player to your ignore list. | ||
| Command.Social.Ignore.Note | function | Changes an ignored player's personal note. | ||
| Command.Social.Ignore.Remove | function | Removes a player from your ignore list. | ||
| Command.Storage.Clear | function | Remove an element from a storage segment. If accessing guild storage, you will need write access ... | ||
| Command.Storage.Get | function | Gets a specific element from a target's storage. The result will be sent to Event.Storage.Get. Th... | ||
| Command.Storage.List | function | Lists the visible elements in a target's storage. The results will be sent to Event.Storage.List.... | ||
| Command.Storage.Set | function | Sets a storage element. If accessing guild storage, you will need the Write to Guild Addon Stora... | ||
| Command.System.Flash | function | Controls the flashing of the Rift taskbar icon. | ||
| Command.System.Strict | function | Puts the environment into Strict mode. In Strict mode, deprecated functions and events will throw... | ||
| Command.System.Texture.Record | function | Begin recording Rift UI textures. The texture list will be transmitted via Event.System.Texture d... | ||
| Command.System.Watchdog.Quiet | function | Significantly increases the time required for the watchdog to generate warnings. Intended for boo... | ||
| Command.Title.Prefix | function | Changes the player's prefix title. | ||
| Command.Title.Suffix | function | Changes the player's suffix title. | ||
| Command.Tooltip | function | Changes the displayed tooltip. | ||
| Command.UI.Error | function | Display the addon error dialog. | ||
| Command.Unit.Menu | function | Creates a standard context menu targeted at the unit of choice. | ||
| Context | A UI element of type Context or derived from Context. | |||
| Element | A UI element of type Element or derived from Element. | |||
| Event.Ability.Add | deprecated | Signals the addition of a player ability. | ||
| Event.Ability.Cooldown.Begin | deprecated | Signals the start of an ability's cooldown. | ||
| Event.Ability.Cooldown.End | deprecated | Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0. | ||
| Event.Ability.New.Add | Signals the addition of a player ability. | |||
| Event.Ability.New.Cooldown.Begin | Signals the start of an ability's cooldown. | |||
| Event.Ability.New.Cooldown.End | Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0. | |||
| Event.Ability.New.Range.False | Signals a player ability exiting range from its current target. | |||
| Event.Ability.New.Range.True | Signals a player ability entering range from its current target. | |||
| Event.Ability.New.Remove | Signals the removal of a player ability. | |||
| Event.Ability.New.Target | Signals a player ability changing its current target. | |||
| Event.Ability.New.Usable.False | Signals a player ability becoming unusable. | |||
| Event.Ability.New.Usable.True | Signals a player ability becoming usable. | |||
| Event.Ability.Range.False | deprecated | Signals a player ability exiting range from its current target. | ||
| Event.Ability.Range.True | deprecated | Signals a player ability entering range from its current target. | ||
| Event.Ability.Remove | deprecated | Signals the removal of a player ability. | ||
| Event.Ability.Target | deprecated | Signals a player ability changing its current target. | ||
| Event.Ability.Usable.False | deprecated | Signals a player ability becoming unusable. | ||
| Event.Ability.Usable.True | deprecated | Signals a player ability becoming usable. | ||
| Event.Achievement.Complete | Signals an achievement completing. | |||
| Event.Achievement.Update | Signals a change in an achievement's information. | |||
| Event.Addon.Load.Begin | Signals the beginning of an addon's loading sequence. | |||
| Event.Addon.Load.End | Signals the end of an addon's loading sequence. At this point, that addon is fully loaded and ini... | |||
| Event.Addon.SavedVariables.Load.Begin | Signals the beginning of an addon's saved variable loading. | |||
| Event.Addon.SavedVariables.Load.End | Signals the end of an addon's saved variable load. | |||
| Event.Addon.SavedVariables.Save.Begin | Signals the beginning of an addon's saved variable saving. | |||
| Event.Addon.SavedVariables.Save.End | Signals the end of an addon's saved variable saving. | |||
| Event.Addon.Shutdown.Begin | Signals the beginning of the shutdown sequence. | |||
| Event.Addon.Shutdown.End | Signals the end of the shutdown sequence. This is the last event that will be sent. | |||
| Event.Addon.Startup.End | Signals the end of the startup sequence. At this point, all addons are fully loaded and initialized. | |||
| Event.Attunement.Progress.Accumulated | Signals your accumulated attunement experience changing. | |||
| Event.Attunement.Progress.Available | Signals your available attunement points changing. | |||
| Event.Attunement.Progress.Rested | Signals your available attunement rested experience changing. | |||
| Event.Attunement.Progress.Spent | Signals your spent attunement points changing. | |||
| Event.Auction.Scan | Signals incoming auction data. | |||
| Event.Buff.Add | Signals new buffs on a unit. | |||
| Event.Buff.Change | Signals a change in existing buffs on a unit. | |||
| Event.Buff.Description | Signals a change in an existing buff's detailed description. Value of the key is "true" if detail... | |||
| Event.Buff.Remove | Signals removal of buffs from a unit. | |||
| Event.Chat.Notify | Signals a screen notification. This is generally used as a warning mechanism during boss fights. | |||
| Event.Chat.Npc | Signals an NPC speaking a line of text. | |||
| Event.Combat.Damage | Signals damage done to a unit. All units referenced by this event will be accessible within this ... | |||
| Event.Combat.Death | Signals the death of a unit. All units referenced by this event will be accessible within this ev... | |||
| Event.Combat.Dodge | Signals a unit dodging an ability. All units referenced by this event will be accessible within t... | |||
| Event.Combat.Heal | Signals healing done to a unit. All units referenced by this event will be accessible within this... | |||
| Event.Combat.Immune | Signals a unit resisting an ability through immunity. All units referenced by this event will be ... | |||
| Event.Combat.Miss | Signals an ability's effect missing a unit. All units referenced by this event will be accessible... | |||
| Event.Combat.Parry | Signals a unit parrying an ability. All units referenced by this event will be accessible within ... | |||
| Event.Combat.Resist | Signals a unit resisting an ability. All units referenced by this event will be accessible within... | |||
| Event.Currency | Signals a change in the player's available currency. | |||
| Event.Cursor | Signals that the cursor has changed. | |||
| Event.Dimension.Layout.Add | Signals that a dimension item has been added. | |||
| Event.Dimension.Layout.Remove | Signals that a dimension item has been removed. | |||
| Event.Dimension.Layout.Update | Signals that a dimension item has been updated. | |||
| Event.Experience.Accumulated | Signals your accumulated experience changing. | |||
| Event.Experience.Rested | Signals your available rested experience changing. | |||
| Event.Faction.Notoriety | Signals a change in the player's faction notoriety. | |||
| Event.Guild.Bank.Change | Signals a change in a guild bank vault's information. | |||
| Event.Guild.Bank.Coin | Signals a change in the guild bank's money. | |||
| Event.Guild.Log | Signals incoming guild log data. Can be triggered manually with Command.Guild.Log.Request(). | |||
| Event.Guild.Motd | Signals a change in the guild Message of the Day. | |||
| Event.Guild.Rank | Signals a change in one of your guild's ranks. | |||
| Event.Guild.Roster.Add | Signals a new player added to the guild roster. | |||
| Event.Guild.Roster.Detail.Level | Signals a change in a guildmember's level. | |||
| Event.Guild.Roster.Detail.Note | Signals a change in a guildmember's note. | |||
| Event.Guild.Roster.Detail.NoteOfficer | Signals a change in a guildmember's officer note. | |||
| Event.Guild.Roster.Detail.Rank | Signals a change in a guildmember's rank. | |||
| Event.Guild.Roster.Detail.Status | Signals a change in a guildmember's status. | |||
| Event.Guild.Roster.Detail.Zone | Signals a change in a guildmember's zone. | |||
| Event.Guild.Roster.Remove | Signals a player removed from the guild roster. | |||
| Event.Guild.Wall | Signals incoming guild wall data. Can be triggered manually with Command.Guild.Wall.Request(). | |||
| Event.Interaction | Signals a change in available interaction types. | |||
| Event.Item.Slot | Signals that the contents of an item slot have changed. | |||
| Event.Item.Update | Signals that an item has changed. | |||
| Event.Mail | Signals a change in the available mail messages. | |||
| Event.Map.Add | Signals the addition of a map element. | |||
| Event.Map.Change | Signals the change of a map element, in some manner besides coordinates. | |||
| Event.Map.Detail.Coord | Signals the coordinate change of a map element. | |||
| Event.Map.Remove | Signals the removal of a map element. | |||
| Event.Message.Receive | Signals the receipt of an addon message. | |||
| Event.Mouse.Move | Signals the mouse moving. | |||
| Event.Pvp.History.Favor | Signals your historical favor changing. | |||
| Event.Pvp.History.Kill.Today | Signals your daily kill count changing. | |||
| Event.Pvp.Prestige.Accumulated | Signals your accumulated prestige changing. | |||
| Event.Pvp.Prestige.Rank | Signals your prestige rank changing. | |||
| Event.Quest.Abandon | Signals that a quest has been abandoned. | |||
| Event.Quest.Accept | Signals that a quest has been accepted. | |||
| Event.Quest.Change | Signals that a quest has been changed in some manner, most likely progress in an objective. | |||
| Event.Quest.Complete | Signals that a quest has been completed. | |||
| Event.Queue.Status | Signals that a queue may have left or entered the throttled state. | |||
| Event.Slash.accounts | Addon-created event. No documentation available. | |||
| Event.Slash.bag | Addon-created event. No documentation available. | |||
| Event.Slash.enfilt | Addon-created event. No documentation available. | |||
| Event.Slash.getopt | Addon-created event. No documentation available. | |||
| Event.Social.Friend | Signals a change in your friend list. | |||
| Event.Social.Ignore | Signals a change in your ignore list. | |||
| Event.Stat | Signals a change in the player's stats. | |||
| Event.Storage.Get | Signals receiving storage data from a target. | |||
| Event.Storage.List | Signals receiving a list of storage elements from a target. | |||
| Event.System.Error | Signals that an addon error has occurred. To prevent infinite loops, errors in handlers for this ... | |||
| Event.System.Secure.Enter | Signals that the system is entering Secure mode. Usually this is equivalent to entering combat. F... | |||
| Event.System.Secure.Leave | Signals that the system is leaving Secure mode. Usually this is equivalent to leaving combat. Fun... | |||
| Event.System.Texture | Signals information on Rift UI textures that have been seen. | |||
| Event.System.Update.Begin | Signals the beginning of a frame render. This is your last chance to make UI changes for this frame. | |||
| Event.System.Update.End | Signals the end of a frame render. | |||
| Event.TEMPORARY.Experience | deprecated | Signals a change in the player's experience. | ||
| Event.TEMPORARY.Role | deprecated | Signals a change in the player's current role. | ||
| Event.Title.Add | Signals the addition of a new title. | |||
| Event.Tooltip | Signals that the tooltip has changed. | |||
| Event.UI.Button.Left.Press | Signals that a button has been pressed with the left mouse button. | |||
| Event.UI.Checkbox.Change | Signals that a checkbox's state has changed. | |||
| Event.UI.Input.Key.Down | Signals that a keyboard key has been pressed. Requires key focus. | |||
| Event.UI.Input.Key.Down.Bubble | Event.UI.Input.Key.Down.Bubble@summary | |||
| Event.UI.Input.Key.Down.Dive | Event.UI.Input.Key.Down.Dive@summary | |||
| Event.UI.Input.Key.Focus.Gain | Signals that a frame has gained the key focus. | |||
| Event.UI.Input.Key.Focus.Gain.Bubble | Event.UI.Input.Key.Focus.Gain.Bubble@summary | |||
| Event.UI.Input.Key.Focus.Gain.Dive | Event.UI.Input.Key.Focus.Gain.Dive@summary | |||
| Event.UI.Input.Key.Focus.Loss | Signals that a frame has lost the key focus. | |||
| Event.UI.Input.Key.Focus.Loss.Bubble | Event.UI.Input.Key.Focus.Loss.Bubble@summary | |||
| Event.UI.Input.Key.Focus.Loss.Dive | Event.UI.Input.Key.Focus.Loss.Dive@summary | |||
| Event.UI.Input.Key.Repeat | Signals that a keyboard key is repeating. Requires key focus. | |||
| Event.UI.Input.Key.Repeat.Bubble | Event.UI.Input.Key.Repeat.Bubble@summary | |||
| Event.UI.Input.Key.Repeat.Dive | Event.UI.Input.Key.Repeat.Dive@summary | |||
| Event.UI.Input.Key.Type | Signals that text has been typed. Requires key focus. | |||
| Event.UI.Input.Key.Type.Bubble | Event.UI.Input.Key.Type.Bubble@summary | |||
| Event.UI.Input.Key.Type.Dive | Event.UI.Input.Key.Type.Dive@summary | |||
| Event.UI.Input.Key.Up | Signals that a keyboard key has been released. Requires key focus. | |||
| Event.UI.Input.Key.Up.Bubble | Event.UI.Input.Key.Up.Bubble@summary | |||
| Event.UI.Input.Key.Up.Dive | Event.UI.Input.Key.Up.Dive@summary | |||
| Event.UI.Input.Mouse.Cursor.In | Signals that the cursor has moved into a frame. | |||
| Event.UI.Input.Mouse.Cursor.In.Bubble | Event.UI.Input.Mouse.Cursor.In.Bubble@summary | |||
| Event.UI.Input.Mouse.Cursor.In.Dive | Event.UI.Input.Mouse.Cursor.In.Dive@summary | |||
| Event.UI.Input.Mouse.Cursor.Move | Signals that the cursor has moved within a frame. | |||
| Event.UI.Input.Mouse.Cursor.Move.Bubble | Event.UI.Input.Mouse.Cursor.Move.Bubble@summary | |||
| Event.UI.Input.Mouse.Cursor.Move.Dive | Event.UI.Input.Mouse.Cursor.Move.Dive@summary | |||
| Event.UI.Input.Mouse.Cursor.Out | Signals that the cursor has moved out of a frame. | |||
| Event.UI.Input.Mouse.Cursor.Out.Bubble | Event.UI.Input.Mouse.Cursor.Out.Bubble@summary | |||
| Event.UI.Input.Mouse.Cursor.Out.Dive | Event.UI.Input.Mouse.Cursor.Out.Dive@summary | |||
| Event.UI.Input.Mouse.Left.Click | Signals that the user has clicked the left mouse button. | |||
| Event.UI.Input.Mouse.Left.Click.Bubble | Event.UI.Input.Mouse.Left.Click.Bubble@summary | |||
| Event.UI.Input.Mouse.Left.Click.Dive | Event.UI.Input.Mouse.Left.Click.Dive@summary | |||
| Event.UI.Input.Mouse.Left.Down | Signals that the user has pressed the left mouse button. | |||
| Event.UI.Input.Mouse.Left.Down.Bubble | Event.UI.Input.Mouse.Left.Down.Bubble@summary | |||
| Event.UI.Input.Mouse.Left.Down.Dive | Event.UI.Input.Mouse.Left.Down.Dive@summary | |||
| Event.UI.Input.Mouse.Left.Up | Signals that the user has released the left mouse button. | |||
| Event.UI.Input.Mouse.Left.Up.Bubble | Event.UI.Input.Mouse.Left.Up.Bubble@summary | |||
| Event.UI.Input.Mouse.Left.Up.Dive | Event.UI.Input.Mouse.Left.Up.Dive@summary | |||
| Event.UI.Input.Mouse.Left.Upoutside | Signals that the user has released the left mouse button off this frame after pressing it on this... | |||
| Event.UI.Input.Mouse.Left.Upoutside.Bubble | Event.UI.Input.Mouse.Left.Upoutside.Bubble@summary | |||
| Event.UI.Input.Mouse.Left.Upoutside.Dive | Event.UI.Input.Mouse.Left.Upoutside.Dive@summary | |||
| Event.UI.Input.Mouse.Middle.Click | Signals that the user has clicked the middle mouse button. | |||
| Event.UI.Input.Mouse.Middle.Click.Bubble | Event.UI.Input.Mouse.Middle.Click.Bubble@summary | |||
| Event.UI.Input.Mouse.Middle.Click.Dive | Event.UI.Input.Mouse.Middle.Click.Dive@summary | |||
| Event.UI.Input.Mouse.Middle.Down | Signals that the user has pressed the middle mouse button. | |||
| Event.UI.Input.Mouse.Middle.Down.Bubble | Event.UI.Input.Mouse.Middle.Down.Bubble@summary | |||
| Event.UI.Input.Mouse.Middle.Down.Dive | Event.UI.Input.Mouse.Middle.Down.Dive@summary | |||
| Event.UI.Input.Mouse.Middle.Up | Signals that the user has released the middle mouse button. | |||
| Event.UI.Input.Mouse.Middle.Up.Bubble | Event.UI.Input.Mouse.Middle.Up.Bubble@summary | |||
| Event.UI.Input.Mouse.Middle.Up.Dive | Event.UI.Input.Mouse.Middle.Up.Dive@summary | |||
| Event.UI.Input.Mouse.Middle.Upoutside | Signals that the user has released the middle mouse button off this frame after pressing it on th... | |||
| Event.UI.Input.Mouse.Middle.Upoutside.Bubble | Event.UI.Input.Mouse.Middle.Upoutside.Bubble@summary | |||
| Event.UI.Input.Mouse.Middle.Upoutside.Dive | Event.UI.Input.Mouse.Middle.Upoutside.Dive@summary | |||
| Event.UI.Input.Mouse.Mouse4.Click | Signals that the user has clicked the fourth mouse button. | |||
| Event.UI.Input.Mouse.Mouse4.Click.Bubble | Event.UI.Input.Mouse.Mouse4.Click.Bubble@summary | |||
| Event.UI.Input.Mouse.Mouse4.Click.Dive | Event.UI.Input.Mouse.Mouse4.Click.Dive@summary | |||
| Event.UI.Input.Mouse.Mouse4.Down | Signals that the user has pressed the fourth mouse button. | |||
| Event.UI.Input.Mouse.Mouse4.Down.Bubble | Event.UI.Input.Mouse.Mouse4.Down.Bubble@summary | |||
| Event.UI.Input.Mouse.Mouse4.Down.Dive | Event.UI.Input.Mouse.Mouse4.Down.Dive@summary | |||
| Event.UI.Input.Mouse.Mouse4.Up | Signals that the user has released the fourth mouse button. | |||
| Event.UI.Input.Mouse.Mouse4.Up.Bubble | Event.UI.Input.Mouse.Mouse4.Up.Bubble@summary | |||
| Event.UI.Input.Mouse.Mouse4.Up.Dive | Event.UI.Input.Mouse.Mouse4.Up.Dive@summary | |||
| Event.UI.Input.Mouse.Mouse4.Upoutside | Signals that the user has released the fourth mouse button off this frame after pressing it on th... | |||
| Event.UI.Input.Mouse.Mouse4.Upoutside.Bubble | Event.UI.Input.Mouse.Mouse4.Upoutside.Bubble@summary | |||
| Event.UI.Input.Mouse.Mouse4.Upoutside.Dive | Event.UI.Input.Mouse.Mouse4.Upoutside.Dive@summary | |||
| Event.UI.Input.Mouse.Mouse5.Click | Signals that the user has clicked the fifth mouse button. | |||
| Event.UI.Input.Mouse.Mouse5.Click.Bubble | Event.UI.Input.Mouse.Mouse5.Click.Bubble@summary | |||
| Event.UI.Input.Mouse.Mouse5.Click.Dive | Event.UI.Input.Mouse.Mouse5.Click.Dive@summary | |||
| Event.UI.Input.Mouse.Mouse5.Down | Signals that the user has pressed the fifth mouse button. | |||
| Event.UI.Input.Mouse.Mouse5.Down.Bubble | Event.UI.Input.Mouse.Mouse5.Down.Bubble@summary | |||
| Event.UI.Input.Mouse.Mouse5.Down.Dive | Event.UI.Input.Mouse.Mouse5.Down.Dive@summary | |||
| Event.UI.Input.Mouse.Mouse5.Up | Signals that the user has released the fifth mouse button. | |||
| Event.UI.Input.Mouse.Mouse5.Up.Bubble | Event.UI.Input.Mouse.Mouse5.Up.Bubble@summary | |||
| Event.UI.Input.Mouse.Mouse5.Up.Dive | Event.UI.Input.Mouse.Mouse5.Up.Dive@summary | |||
| Event.UI.Input.Mouse.Mouse5.Upoutside | Signals that the user has released the fifth mouse button off this frame after pressing it on thi... | |||
| Event.UI.Input.Mouse.Mouse5.Upoutside.Bubble | Event.UI.Input.Mouse.Mouse5.Upoutside.Bubble@summary | |||
| Event.UI.Input.Mouse.Mouse5.Upoutside.Dive | Event.UI.Input.Mouse.Mouse5.Upoutside.Dive@summary | |||
| Event.UI.Input.Mouse.Right.Click | Signals that the user has clicked the right mouse button. | |||
| Event.UI.Input.Mouse.Right.Click.Bubble | Event.UI.Input.Mouse.Right.Click.Bubble@summary | |||
| Event.UI.Input.Mouse.Right.Click.Dive | Event.UI.Input.Mouse.Right.Click.Dive@summary | |||
| Event.UI.Input.Mouse.Right.Down | Signals that the user has pressed the right mouse button. | |||
| Event.UI.Input.Mouse.Right.Down.Bubble | Event.UI.Input.Mouse.Right.Down.Bubble@summary | |||
| Event.UI.Input.Mouse.Right.Down.Dive | Event.UI.Input.Mouse.Right.Down.Dive@summary | |||
| Event.UI.Input.Mouse.Right.Up | Signals that the user has released the right mouse button. | |||
| Event.UI.Input.Mouse.Right.Up.Bubble | Event.UI.Input.Mouse.Right.Up.Bubble@summary | |||
| Event.UI.Input.Mouse.Right.Up.Dive | Event.UI.Input.Mouse.Right.Up.Dive@summary | |||
| Event.UI.Input.Mouse.Right.Upoutside | Signals that the user has released the right mouse button off this frame after pressing it on thi... | |||
| Event.UI.Input.Mouse.Right.Upoutside.Bubble | Event.UI.Input.Mouse.Right.Upoutside.Bubble@summary | |||
| Event.UI.Input.Mouse.Right.Upoutside.Dive | Event.UI.Input.Mouse.Right.Upoutside.Dive@summary | |||
| Event.UI.Input.Mouse.Wheel.Back | Signals that the user has moved the mousewheel back. | |||
| Event.UI.Input.Mouse.Wheel.Back.Bubble | Event.UI.Input.Mouse.Wheel.Back.Bubble@summary | |||
| Event.UI.Input.Mouse.Wheel.Back.Dive | Event.UI.Input.Mouse.Wheel.Back.Dive@summary | |||
| Event.UI.Input.Mouse.Wheel.Forward | Signals that the user has moved the mousewheel forwards. | |||
| Event.UI.Input.Mouse.Wheel.Forward.Bubble | Event.UI.Input.Mouse.Wheel.Forward.Bubble@summary | |||
| Event.UI.Input.Mouse.Wheel.Forward.Dive | Event.UI.Input.Mouse.Wheel.Forward.Dive@summary | |||
| Event.UI.Layout.Layer | Signals a change in layer. | |||
| Event.UI.Layout.Move | Signals a change in the top-left corner's position. May be delayed after the actual movement. | |||
| Event.UI.Layout.Size | Signals a change in size. May be delayed after the actual change. | |||
| Event.UI.Layout.Strata | Signals a change in strata. | |||
| Event.UI.Native.Loaded | Signals a change in this native frame's loaded state. | |||
| Event.UI.Scrollbar.Change | Signals a change in scrollbar position. | |||
| Event.UI.Scrollbar.Grab | Signals that a scrollbar has been grabbed. | |||
| Event.UI.Scrollbar.Release | Signals that a scrollbar has been released. | |||
| Event.UI.Slider.Change | Signals a change in slider position. | |||
| Event.UI.Slider.Grab | Signals that a slider has been grabbed. | |||
| Event.UI.Slider.Release | Signals that a slider has been released. | |||
| Event.UI.Textfield.Change | Signals a change in textfield contents. | |||
| Event.UI.Textfield.Select | Signals a change in textfield selection. | |||
| Event.Unit.Add | Signals the addition of units to unit specifiers. Always preceded by Event.Unit.Change.Remove. Tr... | |||
| Event.Unit.Availability.Full | Signals units entering Full availability. | |||
| Event.Unit.Availability.None | Signals units leaving availability entirely. | |||
| Event.Unit.Availability.Partial | Signals units entering Partial availability, possibly on the way to Full or None availability. | |||
| Event.Unit.Available | deprecated | Signals the availability of Inspect.Unit.Detail. | ||
| Event.Unit.Castbar | Signals a unit's castbar changing. | |||
| Event.Unit.Detail.Absorb | Signals a unit's damage absorption changing. | |||
| Event.Unit.Detail.Afk | Signals a unit's AFK flag changing. Will trigger only for partymembers. | |||
| Event.Unit.Detail.Aggro | Signals a unit's aggro flag changing. Will trigger only for groupmembers. | |||
| Event.Unit.Detail.Blocked | Signals a unit's LOS-blocked flag changing. Will trigger only for groupmembers. | |||
| Event.Unit.Detail.Charge | Signals a unit's charge changing. Will trigger only for the player's unit ID. | |||
| Event.Unit.Detail.ChargeMax | Signals a unit's charge maximum changing. Will trigger only for the player's unit ID. | |||
| Event.Unit.Detail.Combat | Signals a unit's combat status changing. | |||
| Event.Unit.Detail.Combo | Signals a unit's combo points changing. Will trigger only for the player's unit ID. | |||
| Event.Unit.Detail.ComboUnit | Signals a unit's combo point target changing. Will trigger only for the player's unit ID. | |||
| Event.Unit.Detail.Coord | Signals a change in the unit's location. | |||
| Event.Unit.Detail.Energy | Signals a unit's energy changing. | |||
| Event.Unit.Detail.EnergyMax | Signals a unit's energy maximum changing. | |||
| Event.Unit.Detail.Guild | Signals a unit's guild changing. | |||
| Event.Unit.Detail.Health | Signals a unit's health changing. | |||
| Event.Unit.Detail.HealthCap | Signals a unit's health cap changing. | |||
| Event.Unit.Detail.HealthMax | Signals a unit's health maximum changing. | |||
| Event.Unit.Detail.Level | Signals a unit's level changing. | |||
| Event.Unit.Detail.LocationName | Signals a unit's location name changing. | |||
| Event.Unit.Detail.Mana | Signals a unit's mana changing. | |||
| Event.Unit.Detail.ManaMax | Signals a unit's mana maximum changing. | |||
| Event.Unit.Detail.Mark | Signals a unit's mark changing. | |||
| Event.Unit.Detail.Mentoring | Signals a unit's mentoring status changing. | |||
| Event.Unit.Detail.Name | Signals a unit's name changing. | |||
| Event.Unit.Detail.Offline | Signals a unit's offline flag changing. Will trigger only for partymembers. | |||
| Event.Unit.Detail.Planar | Signals a unit's planar charges changing. Will trigger only for the player or groupmembers. | |||
| Event.Unit.Detail.PlanarMax | Signals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers. | |||
| Event.Unit.Detail.Power | Signals a unit's power changing. | |||
| Event.Unit.Detail.PublicSize | Signals a unit's public group size or status changing. | |||
| Event.Unit.Detail.Pvp | Signals a unit's PvP flag changing. | |||
| Event.Unit.Detail.Radius | Signals a unit's radius changing. | |||
| Event.Unit.Detail.Ready | Signals a unit's readycheck status changing. | |||
| Event.Unit.Detail.Role | Signals a unit's role changing. Will trigger only for the player or partymembers. | |||
| Event.Unit.Detail.Tagged | Signals a unit's tagged status changing. | |||
| Event.Unit.Detail.TitlePrefix | deprecated | Signals a unit's localized title prefix changing. This event is deprecated and should not be used. | ||
| Event.Unit.Detail.TitlePrefixId | Signals a unit's title prefix ID changing. | |||
| Event.Unit.Detail.TitlePrefixName | deprecated | Signals a unit's localized title prefix changing. | ||
| Event.Unit.Detail.TitleSuffix | deprecated | Signals a unit's localized title suffix changing. This event is deprecated and should not be used. | ||
| Event.Unit.Detail.TitleSuffixId | Signals a unit's title suffix ID changing. | |||
| Event.Unit.Detail.TitleSuffixName | deprecated | Signals a unit's localized title suffix changing. | ||
| Event.Unit.Detail.Vitality | Signals a unit's vitality changing. Will trigger only for the player or groupmembers. | |||
| Event.Unit.Detail.Warfront | Signals a unit's warfront flag changing. Will trigger only for partymembers. | |||
| Event.Unit.Detail.Zone | Signals a change in the unit's zone. | |||
| Event.Unit.Remove | Signals the removal of units from unit specifiers. Always followed by Event.Unit.Change.Add. Trig... | |||
| Event.Unit.Unavailable | deprecated | Signals the unavailability of Inspect.Unit.Detail. | ||
| Frame | A UI element of type Frame or derived from Frame. | |||
| Frame.Event:KeyDown | Signals a key pressed. | |||
| Frame.Event:KeyFocusGain | Signals gaining key focus. | |||
| Frame.Event:KeyFocusLoss | Signals losing key focus. | |||
| Frame.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| Frame.Event:KeyType | Signals text typed. | |||
| Frame.Event:KeyUp | Signals a key released. | |||
| Frame.Event:Layer | Signals a change in the item's layer. | |||
| Frame.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| Frame.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| Frame.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| Frame.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| Frame.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| Frame.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| Frame.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| Frame.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| Frame.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| Frame.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| Frame.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| Frame.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| Frame.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| Frame.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| Frame.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| Frame.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| Frame.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| Frame.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| Frame.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| Frame.Event:Move | Signals that the frame's vertices have moved. | |||
| Frame.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| Frame.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| Frame.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| Frame.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| Frame.Event:Size | Signals that the frame's size has changed. | |||
| Frame.Event:Strata | Signals a change in the item's strata. | |||
| Frame.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| Frame.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| Frame:ClearAll | function | Clear all set points and sizes from this frame. | ||
| Frame:ClearHeight | function | Clear a set height from this frame. | ||
| Frame:ClearPoint | function | Clear a set point from this frame. | ||
| Frame:ClearWidth | function | Clear a set width from this frame. | ||
| Frame:EventAttach | function | Attaches an event handler to an event. | ||
| Frame:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| Frame:EventList | function | Lists the current event handlers for an event. | ||
| Frame:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| Frame:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| Frame:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| Frame:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| Frame:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| Frame:GetBounds | function | Retrieves the complete bounds of this element. | ||
| Frame:GetChildren | function | Returns a table containing all of this element's children. | ||
| Frame:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| Frame:GetHeight | function | Retrieves the height of this element. | ||
| Frame:GetKeyFocus | function | Gets the key focus status. | ||
| Frame:GetLayer | function | Gets the frame's layer order. | ||
| Frame:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| Frame:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| Frame:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| Frame:GetName | function | Retrieves the name of this element. | ||
| Frame:GetOwner | function | Retrieves the owner of this element. | ||
| Frame:GetParent | function | Gets the parent of this frame. | ||
| Frame:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| Frame:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| Frame:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| Frame:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| Frame:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| Frame:GetType | function | Retrieves the type of this element. | ||
| Frame:GetVisible | function | Gets the visibility flag for this frame. | ||
| Frame:GetWidth | function | Retrieves the width of this element. | ||
| Frame:ReadAll | function | Read all set points and sizes from this frame. | ||
| Frame:ReadHeight | function | Read a set height from this frame. | ||
| Frame:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| Frame:ReadWidth | function | Read a set width from this frame. | ||
| Frame:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| Frame:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| Frame:SetBackgroundColor | function | Sets the background color of this frame. | ||
| Frame:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| Frame:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| Frame:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| Frame:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| Frame:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| Frame:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| Frame:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| Frame:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| Frame:SetStrata | function | Sets the strata for this frame. | ||
| Frame:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| Frame:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| Inspect.Ability.Detail | function | deprecated | Provides detailed information about abilities. | |
| Inspect.Ability.List | function | deprecated | List available abilities. | |
| Inspect.Ability.New.Detail | function | Provides detailed information about abilities. | ||
| Inspect.Ability.New.List | function | List available abilities. | ||
| Inspect.Achievement.Category.Detail | function | Returns information about achievement categories. | ||
| Inspect.Achievement.Category.List | function | Returns a table of valid achievement categories. | ||
| Inspect.Achievement.Detail | function | Provides detailed information about achievements. | ||
| Inspect.Achievement.List | function | Returns a table of all known achievements. | ||
| Inspect.Addon.Cpu | function | Returns recent CPU usage information. This is calculated using an exponential-falloff method. | ||
| Inspect.Addon.Current | function | Returns the current addon. This information is used internally for counting CPU usage and determi... | ||
| Inspect.Addon.Detail | function | Provides detailed information about loaded addons. | ||
| Inspect.Addon.List | function | Lists all the addons that the client has loaded. | ||
| Inspect.Attunement.Progress | function | Returns information on your current attunement progress. | ||
| Inspect.Auction.Detail | function | Provides detailed information about auctions. | ||
| Inspect.Buff.Detail | function | Provides detailed information about the buffs on a unit. | ||
| Inspect.Buff.List | function | List buffs on a unit. | ||
| Inspect.Console.Detail | function | Provides detailed information about consoles. | ||
| Inspect.Console.List | function | Returns a table of the current open text consoles. | ||
| Inspect.Currency.Category.Detail | function | Returns information about currency categories. | ||
| Inspect.Currency.Category.List | function | Returns a table of valid currency categories. | ||
| Inspect.Currency.Detail | function | Provides detailed information about currencies. | ||
| Inspect.Currency.List | function | Returns a table of all known currencies. | ||
| Inspect.Cursor | function | Returns the current contents of the cursor. | ||
| Inspect.Dimension.Layout.Detail | function | Returns details about the specified dimension item. | ||
| Inspect.Dimension.Layout.List | function | Returns a list of dimension items in the dimension you're currently in, and whether or not they a... | ||
| Inspect.Documentation | function | Provide documentation on items in the addon environment. Called with no parameters, it returns a ... | ||
| Inspect.Event.List | function | Lists the current event handlers for an event. | ||
| Inspect.Experience | function | Returns information on your experience. | ||
| Inspect.Faction.Detail | function | Provides detailed information about factions. | ||
| Inspect.Faction.List | function | Returns a table of all known factions. | ||
| Inspect.Guild.Bank.Coin | function | Returns the amount of money contained within the guild bank. | ||
| Inspect.Guild.Bank.Detail | function | Provides detailed information about guild bank vaults. | ||
| Inspect.Guild.Bank.List | function | Returns a table of all available guild bank vaults. | ||
| Inspect.Guild.Motd | function | Returns the current guild Message of the Day. | ||
| Inspect.Guild.Rank.Detail | function | Provides detailed information about guild ranks. | ||
| Inspect.Guild.Rank.List | function | Lists available guild ranks. | ||
| Inspect.Guild.Roster.Detail | function | Provides detailed information about guildmembers. | ||
| Inspect.Guild.Roster.List | function | Lists guildmembers. | ||
| Inspect.Interaction | function | Provides information about what types of interaction are available. | ||
| Inspect.Item.Detail | function | Provides detailed information about items. | ||
| Inspect.Item.Find | function | Finds a slot specifier based on an item ID. | ||
| Inspect.Item.List | function | Generate a list of item IDs from a slot specifier or set of slot specifiers. | ||
| Inspect.Mail.Detail | function | Returns information about mail. | ||
| Inspect.Mail.List | function | Returns a table of valid mail and its status. | ||
| Inspect.Map.Detail | function | Returns information about map locations. | ||
| Inspect.Map.List | function | Returns a table of map locations. | ||
| Inspect.Map.Monitor | function | Inspects the state of the map monitor flag. See Command.Map.Monitor() for details. | ||
| Inspect.Message.Accept.Check | function | Checks whether a given message type would be accepted if it were sent to you. Parameters can be r... | ||
| Inspect.Message.Accept.List | function | Retrieves the list of accepted message types and identifiers. | ||
| Inspect.Mouse | function | Returns information about the current mouse position and button state. | ||
| Inspect.Pvp.History | function | Returns information on your PVP history. | ||
| Inspect.Pvp.Prestige | function | Returns information on your PVP prestige. | ||
| Inspect.Quest.Complete | function | Returns a table of all quests completed. | ||
| Inspect.Quest.Detail | function | Provides detailed information about a quest. | ||
| Inspect.Quest.List | function | Lists the player's current active quests. | ||
| Inspect.Queue.Handler | function | Returns the current queue handler function. | ||
| Inspect.Queue.Status | function | Inspects the current queue status. Omit the first parameter to get a table containing information... | ||
| Inspect.Role.List | function | Lists the player's roles. | ||
| Inspect.Setting.Detail | function | Provides detailed information about a setting. | ||
| Inspect.Setting.List | function | Lists the player's current settings. | ||
| Inspect.Shard | function | Returns information about the current shard. | ||
| Inspect.Social.Friend.Detail | function | Provides detailed information about a friend. | ||
| Inspect.Social.Friend.List | function | Lists the player's current friends. | ||
| Inspect.Social.Ignore.Detail | function | Provides detailed information about an ignored player. | ||
| Inspect.Social.Ignore.List | function | Lists the player's current ignored players. | ||
| Inspect.Stat | function | Returns information about the player's stats. | ||
| Inspect.Storage.Used | function | Returns the storage space currently used for a given segment. | ||
| Inspect.System.Error.Detail | function | Provides detailed information about an addon error. | ||
| Inspect.System.Language | function | Returns the client's current language. | ||
| Inspect.System.Secure | function | Returns the client's current secure mode. | ||
| Inspect.System.Version | function | Returns information on the client version. | ||
| Inspect.System.Watchdog | function | Returns the number of seconds until the system watchdog may begin generating warnings. | ||
| Inspect.TEMPORARY.Experience | function | deprecated | Returns information about the player's experience. | |
| Inspect.TEMPORARY.Role | function | deprecated | Returns the ID of the player's current role. | |
| Inspect.Time.Frame | function | The game time of the last frame. This function's return value will not change until the next frame. | ||
| Inspect.Time.Real | function | A high-resolution realtime timer. Not measured in the same timespace as Inspect.Time.Frame. | ||
| Inspect.Time.Server | function | Returns the current server time. | ||
| Inspect.Title.Category.Detail | function | Provides detailed information about a title category. | ||
| Inspect.Title.Category.List | function | Lists known title categories. | ||
| Inspect.Title.Detail | function | Provides detailed information about a title. | ||
| Inspect.Title.List | function | Lists the player's currently available titles. | ||
| Inspect.Tooltip | function | Returns the current contents of the tooltip. | ||
| Inspect.Unit.Castbar | function | Provides detailed information about a unit's castbar. | ||
| Inspect.Unit.Detail | function | Provides detailed information about a unit. | ||
| Inspect.Unit.List | function | Lists all the units that the client can see. | ||
| Inspect.Unit.Lookup | function | Converts unit IDs to unit specifiers and vice-versa. | ||
| Inspect.Zone.Detail | function | Returns information about zones. | ||
| Layout | A UI element of type Layout or derived from Layout. | |||
| Layout.Event:Move | Signals that the frame's vertices have moved. | |||
| Layout.Event:Size | Signals that the frame's size has changed. | |||
| Layout:EventAttach | function | Attaches an event handler to an event. | ||
| Layout:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| Layout:EventList | function | Lists the current event handlers for an event. | ||
| Layout:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| Layout:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| Layout:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| Layout:GetBounds | function | Retrieves the complete bounds of this element. | ||
| Layout:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| Layout:GetHeight | function | Retrieves the height of this element. | ||
| Layout:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| Layout:GetName | function | Retrieves the name of this element. | ||
| Layout:GetOwner | function | Retrieves the owner of this element. | ||
| Layout:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| Layout:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| Layout:GetType | function | Retrieves the type of this element. | ||
| Layout:GetWidth | function | Retrieves the width of this element. | ||
| Layout:ReadAll | function | Read all set points and sizes from this frame. | ||
| Layout:ReadHeight | function | Read a set height from this frame. | ||
| Layout:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| Layout:ReadWidth | function | Read a set width from this frame. | ||
| Mask | A UI element of type Mask or derived from Mask. | |||
| Mask.Event:KeyDown | Signals a key pressed. | |||
| Mask.Event:KeyFocusGain | Signals gaining key focus. | |||
| Mask.Event:KeyFocusLoss | Signals losing key focus. | |||
| Mask.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| Mask.Event:KeyType | Signals text typed. | |||
| Mask.Event:KeyUp | Signals a key released. | |||
| Mask.Event:Layer | Signals a change in the item's layer. | |||
| Mask.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| Mask.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| Mask.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| Mask.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| Mask.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| Mask.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| Mask.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| Mask.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| Mask.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| Mask.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| Mask.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| Mask.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| Mask.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| Mask.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| Mask.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| Mask.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| Mask.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| Mask.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| Mask.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| Mask.Event:Move | Signals that the frame's vertices have moved. | |||
| Mask.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| Mask.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| Mask.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| Mask.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| Mask.Event:Size | Signals that the frame's size has changed. | |||
| Mask.Event:Strata | Signals a change in the item's strata. | |||
| Mask.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| Mask.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| Mask:ClearAll | function | Clear all set points and sizes from this frame. | ||
| Mask:ClearHeight | function | Clear a set height from this frame. | ||
| Mask:ClearPoint | function | Clear a set point from this frame. | ||
| Mask:ClearWidth | function | Clear a set width from this frame. | ||
| Mask:EventAttach | function | Attaches an event handler to an event. | ||
| Mask:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| Mask:EventList | function | Lists the current event handlers for an event. | ||
| Mask:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| Mask:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| Mask:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| Mask:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| Mask:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| Mask:GetBounds | function | Retrieves the complete bounds of this element. | ||
| Mask:GetChildren | function | Returns a table containing all of this element's children. | ||
| Mask:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| Mask:GetHeight | function | Retrieves the height of this element. | ||
| Mask:GetKeyFocus | function | Gets the key focus status. | ||
| Mask:GetLayer | function | Gets the frame's layer order. | ||
| Mask:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| Mask:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| Mask:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| Mask:GetName | function | Retrieves the name of this element. | ||
| Mask:GetOwner | function | Retrieves the owner of this element. | ||
| Mask:GetParent | function | Gets the parent of this frame. | ||
| Mask:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| Mask:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| Mask:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| Mask:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| Mask:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| Mask:GetType | function | Retrieves the type of this element. | ||
| Mask:GetVisible | function | Gets the visibility flag for this frame. | ||
| Mask:GetWidth | function | Retrieves the width of this element. | ||
| Mask:ReadAll | function | Read all set points and sizes from this frame. | ||
| Mask:ReadHeight | function | Read a set height from this frame. | ||
| Mask:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| Mask:ReadWidth | function | Read a set width from this frame. | ||
| Mask:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| Mask:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| Mask:SetBackgroundColor | function | Sets the background color of this frame. | ||
| Mask:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| Mask:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| Mask:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| Mask:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| Mask:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| Mask:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| Mask:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| Mask:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| Mask:SetStrata | function | Sets the strata for this frame. | ||
| Mask:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| Mask:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| Native | A UI element of type Native or derived from Native. | |||
| Native.Event:Layer | Signals a change in the item's layer. | |||
| Native.Event:Loaded | Signals a change in the item's loaded status. | |||
| Native.Event:Move | Signals that the frame's vertices have moved. | |||
| Native.Event:Size | Signals that the frame's size has changed. | |||
| Native.Event:Strata | Signals a change in the item's strata. | |||
| Native:EventAttach | function | Attaches an event handler to an event. | ||
| Native:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| Native:EventList | function | Lists the current event handlers for an event. | ||
| Native:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| Native:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| Native:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| Native:GetBounds | function | Retrieves the complete bounds of this element. | ||
| Native:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| Native:GetHeight | function | Retrieves the height of this element. | ||
| Native:GetLayer | function | Gets the native item's layer order. | ||
| Native:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| Native:GetLoaded | function | Gets whether or not this native element is loaded and rendering. | ||
| Native:GetName | function | Retrieves the name of this element. | ||
| Native:GetOwner | function | Retrieves the owner of this element. | ||
| Native:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| Native:GetSecureMode | function | Get the native element's secure mode. See Frame:SetSecureMode() for details. | ||
| Native:GetStrata | function | Gets the native item's strata. The strata determines render order on a coarser level than Layer d... | ||
| Native:GetStrataList | function | Gets a list of valid stratas for this native element. | ||
| Native:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| Native:GetType | function | Retrieves the type of this element. | ||
| Native:GetWidth | function | Retrieves the width of this element. | ||
| Native:ReadAll | function | Read all set points and sizes from this frame. | ||
| Native:ReadHeight | function | Read a set height from this frame. | ||
| Native:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| Native:ReadWidth | function | Read a set width from this frame. | ||
| Native:SetLayer | function | Sets the frame layer for this native element. This can be any number. Frames are drawn in ascendi... | ||
| Native:SetStrata | function | Sets the strata for this native element. | ||
| RiftButton | A UI element of type RiftButton or derived from RiftButton. | |||
| RiftButton.Event:KeyDown | Signals a key pressed. | |||
| RiftButton.Event:KeyFocusGain | Signals gaining key focus. | |||
| RiftButton.Event:KeyFocusLoss | Signals losing key focus. | |||
| RiftButton.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| RiftButton.Event:KeyType | Signals text typed. | |||
| RiftButton.Event:KeyUp | Signals a key released. | |||
| RiftButton.Event:Layer | Signals a change in the item's layer. | |||
| RiftButton.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| RiftButton.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| RiftButton.Event:LeftPress | Signals that the button has been pressed. Equivalent to LeftClick, but triggers only while the bu... | |||
| RiftButton.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| RiftButton.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| RiftButton.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| RiftButton.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| RiftButton.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| RiftButton.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| RiftButton.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| RiftButton.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| RiftButton.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| RiftButton.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| RiftButton.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| RiftButton.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| RiftButton.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| RiftButton.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| RiftButton.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| RiftButton.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| RiftButton.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| RiftButton.Event:Move | Signals that the frame's vertices have moved. | |||
| RiftButton.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| RiftButton.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| RiftButton.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| RiftButton.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| RiftButton.Event:Size | Signals that the frame's size has changed. | |||
| RiftButton.Event:Strata | Signals a change in the item's strata. | |||
| RiftButton.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| RiftButton.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| RiftButton:ClearAll | function | Clear all set points and sizes from this frame. | ||
| RiftButton:ClearHeight | function | Clear a set height from this frame. | ||
| RiftButton:ClearPoint | function | Clear a set point from this frame. | ||
| RiftButton:ClearWidth | function | Clear a set width from this frame. | ||
| RiftButton:EventAttach | function | Attaches an event handler to an event. | ||
| RiftButton:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| RiftButton:EventList | function | Lists the current event handlers for an event. | ||
| RiftButton:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| RiftButton:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| RiftButton:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| RiftButton:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| RiftButton:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| RiftButton:GetBounds | function | Retrieves the complete bounds of this element. | ||
| RiftButton:GetChildren | function | Returns a table containing all of this element's children. | ||
| RiftButton:GetDefaultHeight | function | deprecated | Returns the default height of Rift buttons. | |
| RiftButton:GetDefaultWidth | function | deprecated | Returns the default width of Rift buttons. | |
| RiftButton:GetEnabled | function | Gets whether the button is enabled or grayed out. | ||
| RiftButton:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| RiftButton:GetHeight | function | Retrieves the height of this element. | ||
| RiftButton:GetKeyFocus | function | Gets the key focus status. | ||
| RiftButton:GetLayer | function | Gets the frame's layer order. | ||
| RiftButton:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| RiftButton:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| RiftButton:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| RiftButton:GetName | function | Retrieves the name of this element. | ||
| RiftButton:GetOwner | function | Retrieves the owner of this element. | ||
| RiftButton:GetParent | function | Gets the parent of this frame. | ||
| RiftButton:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| RiftButton:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| RiftButton:GetSkin | function | Gets the current skin of this item. | ||
| RiftButton:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| RiftButton:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| RiftButton:GetText | function | Gets this button's text. | ||
| RiftButton:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| RiftButton:GetType | function | Retrieves the type of this element. | ||
| RiftButton:GetVisible | function | Gets the visibility flag for this frame. | ||
| RiftButton:GetWidth | function | Retrieves the width of this element. | ||
| RiftButton:ReadAll | function | Read all set points and sizes from this frame. | ||
| RiftButton:ReadHeight | function | Read a set height from this frame. | ||
| RiftButton:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| RiftButton:ReadWidth | function | Read a set width from this frame. | ||
| RiftButton:ResizeToDefault | function | deprecated | Resizes this button to its default width and height. | |
| RiftButton:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| RiftButton:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| RiftButton:SetBackgroundColor | function | Sets the background color of this frame. | ||
| RiftButton:SetEnabled | function | Sets whether the button is enabled or grayed out. | ||
| RiftButton:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| RiftButton:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| RiftButton:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| RiftButton:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| RiftButton:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| RiftButton:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| RiftButton:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| RiftButton:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| RiftButton:SetSkin | function | Sets the current skin of this item. | ||
| RiftButton:SetStrata | function | Sets the strata for this frame. | ||
| RiftButton:SetText | function | Sets this button's text. | ||
| RiftButton:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| RiftButton:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| RiftCheckbox | A UI element of type RiftCheckbox or derived from RiftCheckbox. | |||
| RiftCheckbox.Event:CheckboxChange | Signals that the checkbox's checked state has changed. | |||
| RiftCheckbox.Event:KeyDown | Signals a key pressed. | |||
| RiftCheckbox.Event:KeyFocusGain | Signals gaining key focus. | |||
| RiftCheckbox.Event:KeyFocusLoss | Signals losing key focus. | |||
| RiftCheckbox.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| RiftCheckbox.Event:KeyType | Signals text typed. | |||
| RiftCheckbox.Event:KeyUp | Signals a key released. | |||
| RiftCheckbox.Event:Layer | Signals a change in the item's layer. | |||
| RiftCheckbox.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| RiftCheckbox.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| RiftCheckbox.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| RiftCheckbox.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| RiftCheckbox.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| RiftCheckbox.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| RiftCheckbox.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| RiftCheckbox.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| RiftCheckbox.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| RiftCheckbox.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| RiftCheckbox.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| RiftCheckbox.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| RiftCheckbox.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| RiftCheckbox.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| RiftCheckbox.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| RiftCheckbox.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| RiftCheckbox.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| RiftCheckbox.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| RiftCheckbox.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| RiftCheckbox.Event:Move | Signals that the frame's vertices have moved. | |||
| RiftCheckbox.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| RiftCheckbox.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| RiftCheckbox.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| RiftCheckbox.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| RiftCheckbox.Event:Size | Signals that the frame's size has changed. | |||
| RiftCheckbox.Event:Strata | Signals a change in the item's strata. | |||
| RiftCheckbox.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| RiftCheckbox.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| RiftCheckbox:ClearAll | function | Clear all set points and sizes from this frame. | ||
| RiftCheckbox:ClearHeight | function | Clear a set height from this frame. | ||
| RiftCheckbox:ClearPoint | function | Clear a set point from this frame. | ||
| RiftCheckbox:ClearWidth | function | Clear a set width from this frame. | ||
| RiftCheckbox:EventAttach | function | Attaches an event handler to an event. | ||
| RiftCheckbox:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| RiftCheckbox:EventList | function | Lists the current event handlers for an event. | ||
| RiftCheckbox:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| RiftCheckbox:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| RiftCheckbox:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| RiftCheckbox:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| RiftCheckbox:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| RiftCheckbox:GetBounds | function | Retrieves the complete bounds of this element. | ||
| RiftCheckbox:GetChecked | function | Gets whether the button is checked or not. | ||
| RiftCheckbox:GetChildren | function | Returns a table containing all of this element's children. | ||
| RiftCheckbox:GetDefaultHeight | function | deprecated | Returns the default height of Rift checkboxes. | |
| RiftCheckbox:GetDefaultWidth | function | deprecated | Returns the default width of Rift checkboxes. | |
| RiftCheckbox:GetEnabled | function | Gets whether the checkbox is enabled or grayed out. | ||
| RiftCheckbox:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| RiftCheckbox:GetHeight | function | Retrieves the height of this element. | ||
| RiftCheckbox:GetKeyFocus | function | Gets the key focus status. | ||
| RiftCheckbox:GetLayer | function | Gets the frame's layer order. | ||
| RiftCheckbox:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| RiftCheckbox:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| RiftCheckbox:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| RiftCheckbox:GetName | function | Retrieves the name of this element. | ||
| RiftCheckbox:GetOwner | function | Retrieves the owner of this element. | ||
| RiftCheckbox:GetParent | function | Gets the parent of this frame. | ||
| RiftCheckbox:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| RiftCheckbox:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| RiftCheckbox:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| RiftCheckbox:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| RiftCheckbox:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| RiftCheckbox:GetType | function | Retrieves the type of this element. | ||
| RiftCheckbox:GetVisible | function | Gets the visibility flag for this frame. | ||
| RiftCheckbox:GetWidth | function | Retrieves the width of this element. | ||
| RiftCheckbox:ReadAll | function | Read all set points and sizes from this frame. | ||
| RiftCheckbox:ReadHeight | function | Read a set height from this frame. | ||
| RiftCheckbox:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| RiftCheckbox:ReadWidth | function | Read a set width from this frame. | ||
| RiftCheckbox:ResizeToDefault | function | deprecated | Resizes this checkbox to its default width and height. | |
| RiftCheckbox:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| RiftCheckbox:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| RiftCheckbox:SetBackgroundColor | function | Sets the background color of this frame. | ||
| RiftCheckbox:SetChecked | function | Sets whether the checkbox is checked or not. | ||
| RiftCheckbox:SetEnabled | function | Sets whether the checkbox is enabled or grayed out. | ||
| RiftCheckbox:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| RiftCheckbox:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| RiftCheckbox:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| RiftCheckbox:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| RiftCheckbox:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| RiftCheckbox:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| RiftCheckbox:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| RiftCheckbox:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| RiftCheckbox:SetStrata | function | Sets the strata for this frame. | ||
| RiftCheckbox:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| RiftCheckbox:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| RiftScrollbar | A UI element of type RiftScrollbar or derived from RiftScrollbar. | |||
| RiftScrollbar.Event:KeyDown | Signals a key pressed. | |||
| RiftScrollbar.Event:KeyFocusGain | Signals gaining key focus. | |||
| RiftScrollbar.Event:KeyFocusLoss | Signals losing key focus. | |||
| RiftScrollbar.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| RiftScrollbar.Event:KeyType | Signals text typed. | |||
| RiftScrollbar.Event:KeyUp | Signals a key released. | |||
| RiftScrollbar.Event:Layer | Signals a change in the item's layer. | |||
| RiftScrollbar.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| RiftScrollbar.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| RiftScrollbar.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| RiftScrollbar.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| RiftScrollbar.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| RiftScrollbar.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| RiftScrollbar.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| RiftScrollbar.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| RiftScrollbar.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| RiftScrollbar.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| RiftScrollbar.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| RiftScrollbar.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| RiftScrollbar.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| RiftScrollbar.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| RiftScrollbar.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| RiftScrollbar.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| RiftScrollbar.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| RiftScrollbar.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| RiftScrollbar.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| RiftScrollbar.Event:Move | Signals that the frame's vertices have moved. | |||
| RiftScrollbar.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| RiftScrollbar.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| RiftScrollbar.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| RiftScrollbar.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| RiftScrollbar.Event:ScrollbarChange | Signals a change in the scrollbar position. | |||
| RiftScrollbar.Event:ScrollbarGrab | Signals the user grabbing the scrollbar with the mouse. | |||
| RiftScrollbar.Event:ScrollbarRelease | Signals the user releasing the scrollbar. | |||
| RiftScrollbar.Event:Size | Signals that the frame's size has changed. | |||
| RiftScrollbar.Event:Strata | Signals a change in the item's strata. | |||
| RiftScrollbar.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| RiftScrollbar.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| RiftScrollbar:ClearAll | function | Clear all set points and sizes from this frame. | ||
| RiftScrollbar:ClearHeight | function | Clear a set height from this frame. | ||
| RiftScrollbar:ClearPoint | function | Clear a set point from this frame. | ||
| RiftScrollbar:ClearWidth | function | Clear a set width from this frame. | ||
| RiftScrollbar:EventAttach | function | Attaches an event handler to an event. | ||
| RiftScrollbar:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| RiftScrollbar:EventList | function | Lists the current event handlers for an event. | ||
| RiftScrollbar:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| RiftScrollbar:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| RiftScrollbar:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| RiftScrollbar:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| RiftScrollbar:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| RiftScrollbar:GetBounds | function | Retrieves the complete bounds of this element. | ||
| RiftScrollbar:GetChildren | function | Returns a table containing all of this element's children. | ||
| RiftScrollbar:GetEnabled | function | Gets whether the scrollbar is enabled or disabled. | ||
| RiftScrollbar:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| RiftScrollbar:GetHeight | function | Retrieves the height of this element. | ||
| RiftScrollbar:GetKeyFocus | function | Gets the key focus status. | ||
| RiftScrollbar:GetLayer | function | Gets the frame's layer order. | ||
| RiftScrollbar:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| RiftScrollbar:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| RiftScrollbar:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| RiftScrollbar:GetName | function | Retrieves the name of this element. | ||
| RiftScrollbar:GetOrientation | function | Gets the current orientation of the scrollbar. | ||
| RiftScrollbar:GetOwner | function | Retrieves the owner of this element. | ||
| RiftScrollbar:GetParent | function | Gets the parent of this frame. | ||
| RiftScrollbar:GetPosition | function | Returns the current position of the scrollbar. | ||
| RiftScrollbar:GetRange | function | Returns the current range of the scrollbar. | ||
| RiftScrollbar:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| RiftScrollbar:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| RiftScrollbar:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| RiftScrollbar:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| RiftScrollbar:GetThickness | function | Returns the thickness of the scrollbar handle. Size is relative to the range. | ||
| RiftScrollbar:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| RiftScrollbar:GetType | function | Retrieves the type of this element. | ||
| RiftScrollbar:GetVisible | function | Gets the visibility flag for this frame. | ||
| RiftScrollbar:GetWidth | function | Retrieves the width of this element. | ||
| RiftScrollbar:Nudge | function | Modify the scrollbar position, clamped to the current bounds. | ||
| RiftScrollbar:NudgeDown | function | Shift the scrollbar down (i.e. away from zero) by a standard amount. | ||
| RiftScrollbar:NudgeUp | function | Shift the scrollbar up (i.e. towards zero) by a standard amount. | ||
| RiftScrollbar:ReadAll | function | Read all set points and sizes from this frame. | ||
| RiftScrollbar:ReadHeight | function | Read a set height from this frame. | ||
| RiftScrollbar:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| RiftScrollbar:ReadWidth | function | Read a set width from this frame. | ||
| RiftScrollbar:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| RiftScrollbar:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| RiftScrollbar:SetBackgroundColor | function | Sets the background color of this frame. | ||
| RiftScrollbar:SetEnabled | function | Sets whether the scrollbar is enabled or disabled. | ||
| RiftScrollbar:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| RiftScrollbar:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| RiftScrollbar:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| RiftScrollbar:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| RiftScrollbar:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| RiftScrollbar:SetOrientation | function | Sets the orientation of the scrollbar. | ||
| RiftScrollbar:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| RiftScrollbar:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| RiftScrollbar:SetPosition | function | Changes the current position of the scrollbar. | ||
| RiftScrollbar:SetRange | function | Changes the current range of the scrollbar. | ||
| RiftScrollbar:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| RiftScrollbar:SetStrata | function | Sets the strata for this frame. | ||
| RiftScrollbar:SetThickness | function | Sets the current thickness of the scrollbar handle. Size is relative to the range. | ||
| RiftScrollbar:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| RiftScrollbar:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| RiftSlider | A UI element of type RiftSlider or derived from RiftSlider. | |||
| RiftSlider.Event:KeyDown | Signals a key pressed. | |||
| RiftSlider.Event:KeyFocusGain | Signals gaining key focus. | |||
| RiftSlider.Event:KeyFocusLoss | Signals losing key focus. | |||
| RiftSlider.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| RiftSlider.Event:KeyType | Signals text typed. | |||
| RiftSlider.Event:KeyUp | Signals a key released. | |||
| RiftSlider.Event:Layer | Signals a change in the item's layer. | |||
| RiftSlider.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| RiftSlider.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| RiftSlider.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| RiftSlider.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| RiftSlider.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| RiftSlider.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| RiftSlider.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| RiftSlider.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| RiftSlider.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| RiftSlider.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| RiftSlider.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| RiftSlider.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| RiftSlider.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| RiftSlider.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| RiftSlider.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| RiftSlider.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| RiftSlider.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| RiftSlider.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| RiftSlider.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| RiftSlider.Event:Move | Signals that the frame's vertices have moved. | |||
| RiftSlider.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| RiftSlider.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| RiftSlider.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| RiftSlider.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| RiftSlider.Event:Size | Signals that the frame's size has changed. | |||
| RiftSlider.Event:SliderChange | Signals a change in the slider position. | |||
| RiftSlider.Event:SliderGrab | Signals the user grabbing the slider with the mouse. | |||
| RiftSlider.Event:SliderRelease | Signals the user releasing the slider. | |||
| RiftSlider.Event:Strata | Signals a change in the item's strata. | |||
| RiftSlider.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| RiftSlider.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| RiftSlider:ClearAll | function | Clear all set points and sizes from this frame. | ||
| RiftSlider:ClearHeight | function | Clear a set height from this frame. | ||
| RiftSlider:ClearPoint | function | Clear a set point from this frame. | ||
| RiftSlider:ClearWidth | function | Clear a set width from this frame. | ||
| RiftSlider:EventAttach | function | Attaches an event handler to an event. | ||
| RiftSlider:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| RiftSlider:EventList | function | Lists the current event handlers for an event. | ||
| RiftSlider:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| RiftSlider:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| RiftSlider:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| RiftSlider:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| RiftSlider:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| RiftSlider:GetBounds | function | Retrieves the complete bounds of this element. | ||
| RiftSlider:GetChildren | function | Returns a table containing all of this element's children. | ||
| RiftSlider:GetDefaultHeight | function | deprecated | Returns the default height of Rift sliders. | |
| RiftSlider:GetDefaultWidth | function | deprecated | Returns the default width of Rift sliders. | |
| RiftSlider:GetEnabled | function | Gets whether the slider is enabled or grayed out. | ||
| RiftSlider:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| RiftSlider:GetHeight | function | Retrieves the height of this element. | ||
| RiftSlider:GetKeyFocus | function | Gets the key focus status. | ||
| RiftSlider:GetLayer | function | Gets the frame's layer order. | ||
| RiftSlider:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| RiftSlider:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| RiftSlider:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| RiftSlider:GetName | function | Retrieves the name of this element. | ||
| RiftSlider:GetOwner | function | Retrieves the owner of this element. | ||
| RiftSlider:GetParent | function | Gets the parent of this frame. | ||
| RiftSlider:GetPosition | function | Returns the current position of the slider. | ||
| RiftSlider:GetRange | function | Returns the current range of the slider. | ||
| RiftSlider:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| RiftSlider:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| RiftSlider:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| RiftSlider:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| RiftSlider:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| RiftSlider:GetType | function | Retrieves the type of this element. | ||
| RiftSlider:GetVisible | function | Gets the visibility flag for this frame. | ||
| RiftSlider:GetWidth | function | Retrieves the width of this element. | ||
| RiftSlider:ReadAll | function | Read all set points and sizes from this frame. | ||
| RiftSlider:ReadHeight | function | Read a set height from this frame. | ||
| RiftSlider:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| RiftSlider:ReadWidth | function | Read a set width from this frame. | ||
| RiftSlider:ResizeToDefault | function | deprecated | Resizes this slider to its default width and height. | |
| RiftSlider:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| RiftSlider:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| RiftSlider:SetBackgroundColor | function | Sets the background color of this frame. | ||
| RiftSlider:SetEnabled | function | Sets whether the slider is enabled or grayed out. | ||
| RiftSlider:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| RiftSlider:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| RiftSlider:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| RiftSlider:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| RiftSlider:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| RiftSlider:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| RiftSlider:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| RiftSlider:SetPosition | function | Changes the current position of the slider. | ||
| RiftSlider:SetRange | function | Sets the current range of the slider. | ||
| RiftSlider:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| RiftSlider:SetStrata | function | Sets the strata for this frame. | ||
| RiftSlider:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| RiftSlider:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| RiftTextfield | A UI element of type RiftTextfield or derived from RiftTextfield. | |||
| RiftTextfield.Event:KeyDown | Signals a key pressed. | |||
| RiftTextfield.Event:KeyFocusGain | Signals gaining key focus. | |||
| RiftTextfield.Event:KeyFocusLoss | Signals losing key focus. | |||
| RiftTextfield.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| RiftTextfield.Event:KeyType | Signals text typed. | |||
| RiftTextfield.Event:KeyUp | Signals a key released. | |||
| RiftTextfield.Event:Layer | Signals a change in the item's layer. | |||
| RiftTextfield.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| RiftTextfield.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| RiftTextfield.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| RiftTextfield.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| RiftTextfield.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| RiftTextfield.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| RiftTextfield.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| RiftTextfield.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| RiftTextfield.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| RiftTextfield.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| RiftTextfield.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| RiftTextfield.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| RiftTextfield.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| RiftTextfield.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| RiftTextfield.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| RiftTextfield.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| RiftTextfield.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| RiftTextfield.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| RiftTextfield.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| RiftTextfield.Event:Move | Signals that the frame's vertices have moved. | |||
| RiftTextfield.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| RiftTextfield.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| RiftTextfield.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| RiftTextfield.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| RiftTextfield.Event:Size | Signals that the frame's size has changed. | |||
| RiftTextfield.Event:Strata | Signals a change in the item's strata. | |||
| RiftTextfield.Event:TextfieldChange | Signals that the textfield's text has changed. | |||
| RiftTextfield.Event:TextfieldSelect | Signals that the textfield's selection has changed. | |||
| RiftTextfield.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| RiftTextfield.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| RiftTextfield:ClearAll | function | Clear all set points and sizes from this frame. | ||
| RiftTextfield:ClearHeight | function | Clear a set height from this frame. | ||
| RiftTextfield:ClearPoint | function | Clear a set point from this frame. | ||
| RiftTextfield:ClearWidth | function | Clear a set width from this frame. | ||
| RiftTextfield:EventAttach | function | Attaches an event handler to an event. | ||
| RiftTextfield:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| RiftTextfield:EventList | function | Lists the current event handlers for an event. | ||
| RiftTextfield:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| RiftTextfield:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| RiftTextfield:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| RiftTextfield:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| RiftTextfield:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| RiftTextfield:GetBounds | function | Retrieves the complete bounds of this element. | ||
| RiftTextfield:GetChildren | function | Returns a table containing all of this element's children. | ||
| RiftTextfield:GetCursor | function | Returns the current position of the cursor. | ||
| RiftTextfield:GetDefaultHeight | function | deprecated | Returns the default height of Rift textfields. | |
| RiftTextfield:GetDefaultWidth | function | deprecated | Returns the default width of Rift textfields. | |
| RiftTextfield:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| RiftTextfield:GetHeight | function | Retrieves the height of this element. | ||
| RiftTextfield:GetKeyFocus | function | Gets the key focus status. | ||
| RiftTextfield:GetLayer | function | Gets the frame's layer order. | ||
| RiftTextfield:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| RiftTextfield:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| RiftTextfield:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| RiftTextfield:GetName | function | Retrieves the name of this element. | ||
| RiftTextfield:GetOwner | function | Retrieves the owner of this element. | ||
| RiftTextfield:GetParent | function | Gets the parent of this frame. | ||
| RiftTextfield:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| RiftTextfield:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| RiftTextfield:GetSelection | function | Returns the current bounds of the selected text. | ||
| RiftTextfield:GetSelectionText | function | Get the current selected text for this element. Returns nil if no text has been selected. | ||
| RiftTextfield:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| RiftTextfield:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| RiftTextfield:GetText | function | Get the current text for this element. | ||
| RiftTextfield:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| RiftTextfield:GetType | function | Retrieves the type of this element. | ||
| RiftTextfield:GetVisible | function | Gets the visibility flag for this frame. | ||
| RiftTextfield:GetWidth | function | Retrieves the width of this element. | ||
| RiftTextfield:ReadAll | function | Read all set points and sizes from this frame. | ||
| RiftTextfield:ReadHeight | function | Read a set height from this frame. | ||
| RiftTextfield:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| RiftTextfield:ReadWidth | function | Read a set width from this frame. | ||
| RiftTextfield:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| RiftTextfield:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| RiftTextfield:SetBackgroundColor | function | Sets the background color of this frame. | ||
| RiftTextfield:SetCursor | function | Changes the current position of the cursor. | ||
| RiftTextfield:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| RiftTextfield:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| RiftTextfield:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| RiftTextfield:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| RiftTextfield:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| RiftTextfield:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| RiftTextfield:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| RiftTextfield:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| RiftTextfield:SetSelection | function | Sets the current bounds of the selected text. Call with no arguments to remove the current select... | ||
| RiftTextfield:SetStrata | function | Sets the strata for this frame. | ||
| RiftTextfield:SetText | function | Set the current text for this element. | ||
| RiftTextfield:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| RiftTextfield:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| RiftWindow | A UI element of type RiftWindow or derived from RiftWindow. | |||
| RiftWindow.Event:KeyDown | Signals a key pressed. | |||
| RiftWindow.Event:KeyFocusGain | Signals gaining key focus. | |||
| RiftWindow.Event:KeyFocusLoss | Signals losing key focus. | |||
| RiftWindow.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| RiftWindow.Event:KeyType | Signals text typed. | |||
| RiftWindow.Event:KeyUp | Signals a key released. | |||
| RiftWindow.Event:Layer | Signals a change in the item's layer. | |||
| RiftWindow.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| RiftWindow.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| RiftWindow.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| RiftWindow.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| RiftWindow.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| RiftWindow.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| RiftWindow.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| RiftWindow.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| RiftWindow.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| RiftWindow.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| RiftWindow.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| RiftWindow.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| RiftWindow.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| RiftWindow.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| RiftWindow.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| RiftWindow.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| RiftWindow.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| RiftWindow.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| RiftWindow.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| RiftWindow.Event:Move | Signals that the frame's vertices have moved. | |||
| RiftWindow.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| RiftWindow.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| RiftWindow.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| RiftWindow.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| RiftWindow.Event:Size | Signals that the frame's size has changed. | |||
| RiftWindow.Event:Strata | Signals a change in the item's strata. | |||
| RiftWindow.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| RiftWindow.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| RiftWindow:ClearAll | function | Clear all set points and sizes from this frame. | ||
| RiftWindow:ClearHeight | function | Clear a set height from this frame. | ||
| RiftWindow:ClearPoint | function | Clear a set point from this frame. | ||
| RiftWindow:ClearWidth | function | Clear a set width from this frame. | ||
| RiftWindow:EventAttach | function | Attaches an event handler to an event. | ||
| RiftWindow:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| RiftWindow:EventList | function | Lists the current event handlers for an event. | ||
| RiftWindow:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| RiftWindow:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| RiftWindow:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| RiftWindow:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| RiftWindow:GetBorder | function | Gets the element representing the window border. | ||
| RiftWindow:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| RiftWindow:GetBounds | function | Retrieves the complete bounds of this element. | ||
| RiftWindow:GetChildren | function | Returns a table containing all of this element's children. | ||
| RiftWindow:GetContent | function | Gets the element representing the window content area. | ||
| RiftWindow:GetController | function | Gets the ID of the current controller for this window. | ||
| RiftWindow:GetDefaultHeight | function | deprecated | Returns the default height of Rift windows. | |
| RiftWindow:GetDefaultWidth | function | deprecated | Returns the default width of Rift windows. | |
| RiftWindow:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| RiftWindow:GetHeight | function | Retrieves the height of this element. | ||
| RiftWindow:GetKeyFocus | function | Gets the key focus status. | ||
| RiftWindow:GetLayer | function | Gets the frame's layer order. | ||
| RiftWindow:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| RiftWindow:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| RiftWindow:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| RiftWindow:GetName | function | Retrieves the name of this element. | ||
| RiftWindow:GetOwner | function | Retrieves the owner of this element. | ||
| RiftWindow:GetParent | function | Gets the parent of this frame. | ||
| RiftWindow:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| RiftWindow:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| RiftWindow:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| RiftWindow:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| RiftWindow:GetTitle | function | Get the current title for this element. | ||
| RiftWindow:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| RiftWindow:GetTrimDimensions | function | Gets the thicknesses of the border's visual trim. | ||
| RiftWindow:GetType | function | Retrieves the type of this element. | ||
| RiftWindow:GetVisible | function | Gets the visibility flag for this frame. | ||
| RiftWindow:GetWidth | function | Retrieves the width of this element. | ||
| RiftWindow:ReadAll | function | Read all set points and sizes from this frame. | ||
| RiftWindow:ReadHeight | function | Read a set height from this frame. | ||
| RiftWindow:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| RiftWindow:ReadWidth | function | Read a set width from this frame. | ||
| RiftWindow:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| RiftWindow:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| RiftWindow:SetBackgroundColor | function | Sets the background color of this frame. | ||
| RiftWindow:SetController | function | Sets the current controller for this window. The controller will take on the exact dimensions of ... | ||
| RiftWindow:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| RiftWindow:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| RiftWindow:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| RiftWindow:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| RiftWindow:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| RiftWindow:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| RiftWindow:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| RiftWindow:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| RiftWindow:SetStrata | function | Sets the strata for this frame. | ||
| RiftWindow:SetTitle | function | Set the current title for this element. | ||
| RiftWindow:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| RiftWindow:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| RiftWindowBorder.Event:KeyDown | Signals a key pressed. | |||
| RiftWindowBorder.Event:KeyFocusGain | Signals gaining key focus. | |||
| RiftWindowBorder.Event:KeyFocusLoss | Signals losing key focus. | |||
| RiftWindowBorder.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| RiftWindowBorder.Event:KeyType | Signals text typed. | |||
| RiftWindowBorder.Event:KeyUp | Signals a key released. | |||
| RiftWindowBorder.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| RiftWindowBorder.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| RiftWindowBorder.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| RiftWindowBorder.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| RiftWindowBorder.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| RiftWindowBorder.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| RiftWindowBorder.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| RiftWindowBorder.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| RiftWindowBorder.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| RiftWindowBorder.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| RiftWindowBorder.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| RiftWindowBorder.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| RiftWindowBorder.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| RiftWindowBorder.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| RiftWindowBorder.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| RiftWindowBorder.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| RiftWindowBorder.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| RiftWindowBorder.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| RiftWindowBorder.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| RiftWindowBorder.Event:Move | Signals that the frame's vertices have moved. | |||
| RiftWindowBorder.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| RiftWindowBorder.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| RiftWindowBorder.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| RiftWindowBorder.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| RiftWindowBorder.Event:Size | Signals that the frame's size has changed. | |||
| RiftWindowBorder.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| RiftWindowBorder.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| RiftWindowBorder:EventAttach | function | Attaches an event handler to an event. | ||
| RiftWindowBorder:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| RiftWindowBorder:EventList | function | Lists the current event handlers for an event. | ||
| RiftWindowBorder:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| RiftWindowBorder:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| RiftWindowBorder:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| RiftWindowBorder:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| RiftWindowBorder:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| RiftWindowBorder:GetBounds | function | Retrieves the complete bounds of this element. | ||
| RiftWindowBorder:GetChildren | function | Returns a table containing all of this element's children. | ||
| RiftWindowBorder:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| RiftWindowBorder:GetHeight | function | Retrieves the height of this element. | ||
| RiftWindowBorder:GetKeyFocus | function | Gets the key focus status. | ||
| RiftWindowBorder:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| RiftWindowBorder:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| RiftWindowBorder:GetName | function | Retrieves the name of this element. | ||
| RiftWindowBorder:GetOwner | function | Retrieves the owner of this element. | ||
| RiftWindowBorder:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| RiftWindowBorder:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| RiftWindowBorder:GetType | function | Retrieves the type of this element. | ||
| RiftWindowBorder:GetVisible | function | Gets the visibility flag for this frame. | ||
| RiftWindowBorder:GetWidth | function | Retrieves the width of this element. | ||
| RiftWindowBorder:ReadAll | function | Read all set points and sizes from this frame. | ||
| RiftWindowBorder:ReadHeight | function | Read a set height from this frame. | ||
| RiftWindowBorder:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| RiftWindowBorder:ReadWidth | function | Read a set width from this frame. | ||
| RiftWindowBorder:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| RiftWindowBorder:SetBackgroundColor | function | Sets the background color of this frame. | ||
| RiftWindowBorder:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| RiftWindowBorder:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| RiftWindowBorder:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| RiftWindowContent.Event:KeyDown | Signals a key pressed. | |||
| RiftWindowContent.Event:KeyFocusGain | Signals gaining key focus. | |||
| RiftWindowContent.Event:KeyFocusLoss | Signals losing key focus. | |||
| RiftWindowContent.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| RiftWindowContent.Event:KeyType | Signals text typed. | |||
| RiftWindowContent.Event:KeyUp | Signals a key released. | |||
| RiftWindowContent.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| RiftWindowContent.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| RiftWindowContent.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| RiftWindowContent.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| RiftWindowContent.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| RiftWindowContent.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| RiftWindowContent.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| RiftWindowContent.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| RiftWindowContent.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| RiftWindowContent.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| RiftWindowContent.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| RiftWindowContent.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| RiftWindowContent.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| RiftWindowContent.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| RiftWindowContent.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| RiftWindowContent.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| RiftWindowContent.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| RiftWindowContent.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| RiftWindowContent.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| RiftWindowContent.Event:Move | Signals that the frame's vertices have moved. | |||
| RiftWindowContent.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| RiftWindowContent.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| RiftWindowContent.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| RiftWindowContent.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| RiftWindowContent.Event:Size | Signals that the frame's size has changed. | |||
| RiftWindowContent.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| RiftWindowContent.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| RiftWindowContent:EventAttach | function | Attaches an event handler to an event. | ||
| RiftWindowContent:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| RiftWindowContent:EventList | function | Lists the current event handlers for an event. | ||
| RiftWindowContent:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| RiftWindowContent:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| RiftWindowContent:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| RiftWindowContent:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| RiftWindowContent:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| RiftWindowContent:GetBounds | function | Retrieves the complete bounds of this element. | ||
| RiftWindowContent:GetChildren | function | Returns a table containing all of this element's children. | ||
| RiftWindowContent:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| RiftWindowContent:GetHeight | function | Retrieves the height of this element. | ||
| RiftWindowContent:GetKeyFocus | function | Gets the key focus status. | ||
| RiftWindowContent:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| RiftWindowContent:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| RiftWindowContent:GetName | function | Retrieves the name of this element. | ||
| RiftWindowContent:GetOwner | function | Retrieves the owner of this element. | ||
| RiftWindowContent:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| RiftWindowContent:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| RiftWindowContent:GetType | function | Retrieves the type of this element. | ||
| RiftWindowContent:GetVisible | function | Gets the visibility flag for this frame. | ||
| RiftWindowContent:GetWidth | function | Retrieves the width of this element. | ||
| RiftWindowContent:ReadAll | function | Read all set points and sizes from this frame. | ||
| RiftWindowContent:ReadHeight | function | Read a set height from this frame. | ||
| RiftWindowContent:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| RiftWindowContent:ReadWidth | function | Read a set width from this frame. | ||
| RiftWindowContent:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| RiftWindowContent:SetBackgroundColor | function | Sets the background color of this frame. | ||
| RiftWindowContent:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| RiftWindowContent:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| RiftWindowContent:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| Text | A UI element of type Text or derived from Text. | |||
| Text.Event:KeyDown | Signals a key pressed. | |||
| Text.Event:KeyFocusGain | Signals gaining key focus. | |||
| Text.Event:KeyFocusLoss | Signals losing key focus. | |||
| Text.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| Text.Event:KeyType | Signals text typed. | |||
| Text.Event:KeyUp | Signals a key released. | |||
| Text.Event:Layer | Signals a change in the item's layer. | |||
| Text.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| Text.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| Text.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| Text.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| Text.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| Text.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| Text.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| Text.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| Text.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| Text.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| Text.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| Text.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| Text.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| Text.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| Text.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| Text.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| Text.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| Text.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| Text.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| Text.Event:Move | Signals that the frame's vertices have moved. | |||
| Text.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| Text.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| Text.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| Text.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| Text.Event:Size | Signals that the frame's size has changed. | |||
| Text.Event:Strata | Signals a change in the item's strata. | |||
| Text.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| Text.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| Text:ClearAll | function | Clear all set points and sizes from this frame. | ||
| Text:ClearHeight | function | Clear a set height from this frame. | ||
| Text:ClearPoint | function | Clear a set point from this frame. | ||
| Text:ClearWidth | function | Clear a set width from this frame. | ||
| Text:EventAttach | function | Attaches an event handler to an event. | ||
| Text:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| Text:EventList | function | Lists the current event handlers for an event. | ||
| Text:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| Text:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| Text:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| Text:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| Text:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| Text:GetBounds | function | Retrieves the complete bounds of this element. | ||
| Text:GetChildren | function | Returns a table containing all of this element's children. | ||
| Text:GetEffectBlur | function | Gets the current parameters for the Blur effect. | ||
| Text:GetEffectGlow | function | Gets the current parameters for the Glow effect. | ||
| Text:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| Text:GetFont | function | Gets the current font used for this element. | ||
| Text:GetFontColor | function | Gets the current font color for this element. | ||
| Text:GetFontSize | function | Gets the font size of the current element. | ||
| Text:GetFullHeight | function | deprecated | Get the height that would be required for this element to display all lines of text. | |
| Text:GetFullWidth | function | deprecated | Get the width that would be required for this element to avoid word wrapping or truncation. | |
| Text:GetHeight | function | Retrieves the height of this element. | ||
| Text:GetKeyFocus | function | Gets the key focus status. | ||
| Text:GetLayer | function | Gets the frame's layer order. | ||
| Text:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| Text:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| Text:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| Text:GetName | function | Retrieves the name of this element. | ||
| Text:GetOwner | function | Retrieves the owner of this element. | ||
| Text:GetParent | function | Gets the parent of this frame. | ||
| Text:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| Text:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| Text:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| Text:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| Text:GetText | function | Get the current text for this element. | ||
| Text:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| Text:GetType | function | Retrieves the type of this element. | ||
| Text:GetVisible | function | Gets the visibility flag for this frame. | ||
| Text:GetWidth | function | Retrieves the width of this element. | ||
| Text:GetWordwrap | function | Gets the wordwrap flag for this element. | ||
| Text:ReadAll | function | Read all set points and sizes from this frame. | ||
| Text:ReadHeight | function | Read a set height from this frame. | ||
| Text:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| Text:ReadWidth | function | Read a set width from this frame. | ||
| Text:ResizeToText | function | deprecated | Sets the element's width and height to display all text without wordwrapping or truncation. | |
| Text:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| Text:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| Text:SetBackgroundColor | function | Sets the background color of this frame. | ||
| Text:SetEffectBlur | function | Sets the parameters for the Blur effect. | ||
| Text:SetEffectGlow | function | Sets the parameters for the Glow effect. | ||
| Text:SetFont | function | Sets the current font used for this element. | ||
| Text:SetFontColor | function | Sets the current font color for this element. | ||
| Text:SetFontSize | function | Sets the current font size of this element. | ||
| Text:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| Text:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| Text:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| Text:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| Text:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| Text:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| Text:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| Text:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| Text:SetStrata | function | Sets the strata for this frame. | ||
| Text:SetText | function | Sets the current text for this element. | ||
| Text:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| Text:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| Text:SetWordwrap | function | Sets the wordwrap flag for this element. | ||
| Texture | A UI element of type Texture or derived from Texture. | |||
| Texture.Event:KeyDown | Signals a key pressed. | |||
| Texture.Event:KeyFocusGain | Signals gaining key focus. | |||
| Texture.Event:KeyFocusLoss | Signals losing key focus. | |||
| Texture.Event:KeyRepeat | Frame.Event:KeyRepeat@summary | |||
| Texture.Event:KeyType | Signals text typed. | |||
| Texture.Event:KeyUp | Signals a key released. | |||
| Texture.Event:Layer | Signals a change in the item's layer. | |||
| Texture.Event:LeftClick | Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ... | |||
| Texture.Event:LeftDown | Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ... | |||
| Texture.Event:LeftUp | Signals that the mouse's left button has been released inside the frame. Blocks left mouse events... | |||
| Texture.Event:LeftUpoutside | Signals that the mouse's left button has been released outside the frame, after a "Down" message.... | |||
| Texture.Event:MiddleClick | Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve... | |||
| Texture.Event:MiddleDown | Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve... | |||
| Texture.Event:MiddleUp | Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev... | |||
| Texture.Event:MiddleUpoutside | Signals that the mouse's middle button has been released outside the frame, after a "Down" messag... | |||
| Texture.Event:Mouse4Click | Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo... | |||
| Texture.Event:Mouse4Down | Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo... | |||
| Texture.Event:Mouse4Up | Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button m... | |||
| Texture.Event:Mouse4Upoutside | Signals that the mouse's fourth button has been released outside the frame, after a "Down" messag... | |||
| Texture.Event:Mouse5Click | Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous... | |||
| Texture.Event:Mouse5Down | Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous... | |||
| Texture.Event:Mouse5Up | Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou... | |||
| Texture.Event:Mouse5Upoutside | Signals that the mouse's fifth button has been released outside the frame, after a "Down" message... | |||
| Texture.Event:MouseIn | Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr... | |||
| Texture.Event:MouseMove | Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ... | |||
| Texture.Event:MouseOut | Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ... | |||
| Texture.Event:Move | Signals that the frame's vertices have moved. | |||
| Texture.Event:RightClick | Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse event... | |||
| Texture.Event:RightDown | Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse event... | |||
| Texture.Event:RightUp | Signals that the mouse's right button has been released inside the frame. Blocks right mouse even... | |||
| Texture.Event:RightUpoutside | Signals that the mouse's right button has been released outside the frame, after a "Down" message... | |||
| Texture.Event:Size | Signals that the frame's size has changed. | |||
| Texture.Event:Strata | Signals a change in the item's strata. | |||
| Texture.Event:WheelBack | Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr... | |||
| Texture.Event:WheelForward | Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro... | |||
| Texture:ClearAll | function | Clear all set points and sizes from this frame. | ||
| Texture:ClearHeight | function | Clear a set height from this frame. | ||
| Texture:ClearPoint | function | Clear a set point from this frame. | ||
| Texture:ClearWidth | function | Clear a set width from this frame. | ||
| Texture:EventAttach | function | Attaches an event handler to an event. | ||
| Texture:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
| Texture:EventList | function | Lists the current event handlers for an event. | ||
| Texture:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
| Texture:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
| Texture:GetAlpha | function | Gets the alpha multiplier of this frame. | ||
| Texture:GetBackgroundColor | function | Retrieves the background color of this frame. | ||
| Texture:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
| Texture:GetBounds | function | Retrieves the complete bounds of this element. | ||
| Texture:GetChildren | function | Returns a table containing all of this element's children. | ||
| Texture:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
| Texture:GetHeight | function | Retrieves the height of this element. | ||
| Texture:GetKeyFocus | function | Gets the key focus status. | ||
| Texture:GetLayer | function | Gets the frame's layer order. | ||
| Texture:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
| Texture:GetMouseMasking | function | Get the current mouse masking mode. See SetMouseMasking for details. | ||
| Texture:GetMouseoverUnit | function | Gets the unit that is being represented by this frame. | ||
| Texture:GetName | function | Retrieves the name of this element. | ||
| Texture:GetOwner | function | Retrieves the owner of this element. | ||
| Texture:GetParent | function | Gets the parent of this frame. | ||
| Texture:GetRight | function | Retrieves the X position of the right edge of this element. | ||
| Texture:GetSecureMode | function | Get the current secure mode. See SetSecureMode for details. | ||
| Texture:GetStrata | function | Gets the frame's strata. The strata determines render order on a coarser level than Layer does, a... | ||
| Texture:GetStrataList | function | Gets a list of valid stratas for this frame. | ||
| Texture:GetTexture | function | Gets the current texture used for this element. | ||
| Texture:GetTextureHeight | function | Returns the actual pixel height of the current texture. | ||
| Texture:GetTextureWidth | function | Returns the actual pixel width of the current texture. | ||
| Texture:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
| Texture:GetType | function | Retrieves the type of this element. | ||
| Texture:GetVisible | function | Gets the visibility flag for this frame. | ||
| Texture:GetWidth | function | Retrieves the width of this element. | ||
| Texture:ReadAll | function | Read all set points and sizes from this frame. | ||
| Texture:ReadHeight | function | Read a set height from this frame. | ||
| Texture:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
| Texture:ReadWidth | function | Read a set width from this frame. | ||
| Texture:ResizeToTexture | function | deprecated | Sets the element's width and height to the exact pixel size of the texture. | |
| Texture:SetAllPoints | function | Pins all the edges of this frame to the edges of a different frame. If no target is given, defaul... | ||
| Texture:SetAlpha | function | Sets the alpha transparency multiplier for this frame and its children. | ||
| Texture:SetBackgroundColor | function | Sets the background color of this frame. | ||
| Texture:SetHeight | function | Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates. | ||
| Texture:SetKeyFocus | function | Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a... | ||
| Texture:SetLayer | function | Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order.... | ||
| Texture:SetMouseMasking | function | Sets the frame's mouse masking mode. | ||
| Texture:SetMouseoverUnit | function | Sets the unit that will be represented by this frame. | ||
| Texture:SetParent | function | Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'... | ||
| Texture:SetPoint | function | Pins a point on this frame to a location on another frame. This is a rather complex function and ... | ||
| Texture:SetSecureMode | function | Sets the frame's secure mode. "normal" is the standard mode. It allows for most functionality to ... | ||
| Texture:SetStrata | function | Sets the strata for this frame. | ||
| Texture:SetTexture | function | Sets the current texture used for this element. | ||
| Texture:SetVisible | function | Sets the frame's visibility flag. If set to false, then this frame and all its children will not ... | ||
| Texture:SetWidth | function | Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates. | ||
| UI.Context | Lists all contexts that have been created. Organizes them under [addonIdentifier][contextIdentifi... | |||
| UI.CreateContext | function | Creates a new UI context. A UI context must be created in order to create any frames. | ||
| UI.CreateFrame | function | Creates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames m... | ||
| UI.Frame | Lists all frames that have been created. Organizes them under [addonIdentifier][contextIdentifier... | |||
| 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.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. | |||
| Utility.Auction.Cost | function | Returns the amount of silver it will cost to post a given auction. | ||
| Utility.Dispatch | function | Calls a function, crediting that function's execution and errors to a specific addon. Errors will... | ||
| Utility.Event.Create | function | Creates a custom event. Takes an identifier and an event path as parameters. Called with Create("... | ||
| Utility.Item.Slot.All | function | Generates a slot specifier for all known items. | ||
| Utility.Item.Slot.Bank | function | Generates a slot specifier for the player's bank. | ||
| Utility.Item.Slot.Equipment | function | Generates a slot specifier for the player's equipment. | ||
| Utility.Item.Slot.Guild | function | Generates a slot specifier for the player's guild bank. | ||
| Utility.Item.Slot.Inventory | function | Generates a slot specifier for the player's inventory. | ||
| Utility.Item.Slot.Parse | function | Parses a slot specifier, returning information on what it represents. | ||
| Utility.Item.Slot.Quest | function | Generates a slot specifier for the player's quest bag. | ||
| Utility.Item.Slot.Wardrobe | function | Generates a slot specifier for the player's wardrobe. | ||
| Utility.Mail.Cost | function | Returns the amount of silver it will cost to send a given mail. | ||
| Utility.Message.Limits | function | Returns information on the message bandwidth limits. | ||
| Utility.Message.Size | function | Returns the size of a message, as used for bandwidth control. | ||
| Utility.Serialize.Full | function | Serializes a table of parameters. Results in a string suitable for feeding directly into loadstri... | ||
| Utility.Serialize.Inline | function | Serializes a single parameter. Results in a string suitable for use as a parameter in Lua code. I... | ||
| Utility.Storage.Checksum | function | Calculates the storage checksum of a string. | ||
| Utility.Storage.Limits | function | Returns information on the storage bandwidth limits. | ||
| Utility.Storage.Size | function | Returns the size of a stored element, as used for storage quota and bandwidth control. | ||
| Utility.Type | function | Determines the type of a given item. Understands Rift-specific identifiers. | ||
| Utility.Unit.Availability | function | Returns information on which detail members are available in which availability mode. | ||
| 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 paramet... | |||
| 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. | |||
| dump | function | Debug utility function. Similar to print(), but serializes any table parameters before outputting. | ||
| 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 fram... | |||
| 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. | |||
| 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 Uti... | |||
| 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. Uni... | |||
| variant | A value of any type. | |||
| zone | A zone, represented by a standard identifier with a 'z' prefix. |
Bids on an auction.
Interaction category: auction
| Command.Auction.Bid(auction, bid) | |||
| Command.Auction.Bid(auction, bid, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| auction | parameter | auction | The auction to be targeted. |
| bid | parameter | number | The amount to bid. To place a buyout, simply bid the buyout value. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
Cancels an auction.
Interaction category: auction
| Command.Auction.Cancel(auction) | |||
| Command.Auction.Cancel(auction, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| auction | parameter | auction | The auction to be targeted. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
Posts a new auction.
Interaction category: auction
Throttled.
| Command.Auction.Post(item, time, bid, buyout) | |||
| Command.Auction.Post(item, time, bid, buyout, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| bid | parameter | number | The minimum bid for the new auction, in silver. |
| buyout | parameter | number/nil | The buyout for the new auction, in silver. nil if no buyout is desired. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| item | parameter | item | The ID of the item to be auctioned. |
| time | parameter | number | The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48. |
Requests an auction house scan. If "index" is omitted then this function will error if the "auctionfullscan" queue is not ready. Otherwise, this function is subject to the "global" command queue.
Interaction category: auction
| Command.Auction.Scan(parameters) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| parameters | parameter | table | Table containing data about the requested scan. 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. 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", "mine", or "bids". If "mine" or "bids", must be the only member in the table. |
Cancels a buff on the player. Not all buffs are cancelable.
Throttled.
| Command.Buff.Cancel(buff) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| buff | parameter | buff | The ID of the buff to cancel. |
Requests a detailed description for a given buff.
Throttled.
| Command.Buff.Describe(unit, buff) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| buff | parameter | buff | The ID of the buff to describe. |
| unit | parameter | unit | The ID of the unit that the buff is on. |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| console | parameter | console | The console to display text into. May be "general", "combat", or a console ID. |
| html | parameter | boolean | 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 | parameter | boolean | Suppress the automatic addon shortname prefix. |
| text | parameter | string | The text to be printed. |
Changes the contents of the cursor. Ability cursors may be set only if the environment is not in secure mode.
| Command.Cursor(hold) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| hold | parameter | variant | The new cursor. Currently accepts ability, item, itemtype, or non-empty non-wildcard slot IDs. Pass nil to clear the cursor. |
Pick up the specified dimension item from the world to your inventory.
| Command.Dimension.Layout.Pickup(dimensionItem) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| dimensionItem | parameter | dimensionitem | The ID of the dimension item to operate on. |
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) | |||
| Command.Dimension.Layout.Place(dimensionItem, values) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| dimensionItem | parameter | dimensionitem | The ID of the dimension item to operate on. |
| item | parameter | item | The inventory item to operate on. |
| values | parameter | table | 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. |
Selects or deselects the specified dimension item.
| Command.Dimension.Layout.Select(dimensionItem, selected) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| dimensionItem | parameter | dimensionitem | The ID of the dimension item to operate on. |
| selected | parameter | boolean | Indicates if the dimension item should be selected or deselected. |
Attaches an event handler to an event.
| Command.Event.Attach(event, handler, label) | |||
| Command.Event.Attach(event, handler, label, priority) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| event | parameter | eventGlobal | A global event handle, usually pulled out of the "Event." hierarchy. |
| handler | parameter | function | 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 | parameter | string | Human-readable label used to identify the handler in error reports, performance reports, and for later detaching. |
| priority | parameter | number | Priority of the event handler. Higher numbers trigger first. |
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) | |||
| Command.Event.Detach(event, handler, label) | |||
| Command.Event.Detach(event, handler, label, priority) | |||
| Command.Event.Detach(event, handler, label, priority, owner) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| event | parameter | eventGlobal | A global event handle, usually pulled out of the "Event." hierarchy. |
| handler | parameter | function/nil | 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 | parameter | string/nil | Human-readable label used to identify the handler in error reports, performance reports, and for later detaching. |
| owner | parameter | string/nil | Owner to search for. |
| priority | parameter | number/nil | Priority of the event handler. Higher numbers trigger first. |
Deposits money into the guild bank.
Interaction category: guildbank
Throttled.
| Command.Guild.Bank.Deposit(coin) | |||
| Command.Guild.Bank.Deposit(coin, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| coin | parameter | number | The string "coin", used as a value to request the player's money. |
Purchases a new guild bank vault.
Interaction category: guildbank
Throttled.
| Command.Guild.Bank.Purchase() | |||
| Command.Guild.Bank.Purchase(callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
Withdraws money from the guild bank.
Interaction category: guildbank
Throttled.
| Command.Guild.Bank.Withdraw(coin) | |||
| Command.Guild.Bank.Withdraw(coin, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| coin | parameter | number | The string "coin", used as a value to request the player's money. |
Requests a guild log event.
| Command.Guild.Log.Request() | |||
| Command.Guild.Log.Request(callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
Changes the guild's Message of the Day.
Throttled.
| Command.Guild.Motd(motd) | |||
| Command.Guild.Motd(motd, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| motd | parameter | string | The new Message of the Day. |
Demotes a guildmember by one rank.
Throttled.
| Command.Guild.Roster.Demote(member) | |||
| Command.Guild.Roster.Demote(member, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| member | parameter | string | The guildmember to target. |
Kicks a guildmember from the guild.
Throttled.
| Command.Guild.Roster.Kick(member) | |||
| Command.Guild.Roster.Kick(member, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| member | parameter | string | The guildmember to target. |
Changes your guild note.
Throttled.
| Command.Guild.Roster.Note(note) | |||
| Command.Guild.Roster.Note(note, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| note | parameter | string | The new note. |
Changes a guildmember's officer note.
Throttled.
| Command.Guild.Roster.NoteOfficer(member, note) | |||
| Command.Guild.Roster.NoteOfficer(member, note, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| member | parameter | string | The guildmember to target. |
| note | parameter | string | The new note. |
Promotes a guildmember by one rank.
Throttled.
| Command.Guild.Roster.Promote(member) | |||
| Command.Guild.Roster.Promote(member, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| member | parameter | string | The guildmember to target. |
Deletes an entry from the guild wall.
Throttled.
| Command.Guild.Wall.Delete(wall) | |||
| Command.Guild.Wall.Delete(wall, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| wall | parameter | guildwall | The ID of the target wall post. |
Posts an entry to the guild wall.
Throttled.
| Command.Guild.Wall.Post(post) | |||
| Command.Guild.Wall.Post(post, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| post | parameter | string | The item to post. |
Requests a guild wall event.
| Command.Guild.Wall.Request() | |||
| Command.Guild.Wall.Request(callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
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.
Interaction category: item
Throttled.
| Command.Item.Destroy(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item | The item ID of the item to destroy. |
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.
Interaction category: item
Throttled.
| Command.Item.Move(source, destination) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| destination | parameter | slot | The location to move the item. May attempt to stack or swap if there is already an item here. |
| source | parameter | item, slot | The item to move. Must be a slot specifier that refers to an actual item. |
Splits a number of items off a stack.
Interaction category: item
Throttled.
| Command.Item.Split(source, stack) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| source | parameter | item, slot | The item to split. May be a slot specifier or an item ID. |
| stack | parameter | number | The number of items to move into the new stack. Must be a positive integer. |
Behaves in the same way that the addon system does when an inventory icon is dragged.
Interaction category: item
| Command.Item.Standard.Drag(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item, slot | The item or slot to be targeted. |
Behaves in the same way that the addon system does when an inventory icon is dropped.
Interaction category: item
| Command.Item.Standard.Drop(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item, slot | The item or slot to be targeted. |
Behaves in the same way that the addon system does when an inventory icon is left-clicked.
Interaction category: item
| Command.Item.Standard.Left(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item, slot | The item or slot to be targeted. |
Behaves in the same way that the addon system does when an inventory icon is right-clicked.
Interaction category: item
| Command.Item.Standard.Right(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | item, slot | The item or slot to be targeted. |
Deletes a mail.
Interaction category: mail
Throttled.
| Command.Mail.Delete(mail) | |||
| Command.Mail.Delete(mail, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| parameter | The ID of the mail to be targeted. | ||
Opens a mail, retrieving detailed information for it.
Interaction category: mail
Throttled.
| Command.Mail.Open(mail) | |||
| Command.Mail.Open(mail, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| parameter | The ID of the mail to be targeted. | ||
Pays the COD fee on a mail.
Interaction category: mail
Throttled.
| Command.Mail.Pay(mail) | |||
| Command.Mail.Pay(mail, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| parameter | The ID of the mail to be targeted. | ||
Returns a mail to its sender.
Interaction category: mail
Throttled.
| Command.Mail.Return(mail) | |||
| Command.Mail.Return(mail, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| parameter | The ID of the mail to be targeted. | ||
Sends mail.
Interaction category: mail
| Command.Mail.Send(mail) | |||
| Command.Mail.Send(mail, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| parameter | table | 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. | |
Marks mail as spam.
Interaction category: mail
Throttled.
| Command.Mail.Spam(mail) | |||
| Command.Mail.Spam(mail, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| parameter | The ID of the mail to be targeted. | ||
Takes an attached item from mail.
Interaction category: mail
Throttled.
| Command.Mail.Take(mail, item) | |||
| Command.Mail.Take(mail, items) | |||
| Command.Mail.Take(mail, item, callback) | |||
| Command.Mail.Take(mail, items, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| item | parameter | item | The ID of the item to be taken. |
| items | parameter | table | A table containing a list of the items to be taken. |
| parameter | The ID of the mail to be targeted. | ||
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| monitor | parameter | boolean | The new state of the map monitor flag. |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| identifier | parameter | string/nil | 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 | parameter | string/nil | The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send". |
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) | |||
| Command.Message.Broadcast(type, target, identifier, data, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| data | parameter | string | The data to send. This parameter is binary-safe. |
| identifier | parameter | string | 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 | parameter | string/nil | The target of this message. Required for "channel" or "tell" message types, must be nil otherwise. |
| type | parameter | string | The type of message to send. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell". |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| identifier | parameter | string/nil | 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 | parameter | string/nil | The type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send". |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| data | parameter | string | The data to send. This parameter is binary-safe. |
| identifier | parameter | string | 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 | parameter | string | The name of the player to send the message to. |
Abandons the given quest. Permitted only on personal quests.
Throttled.
| Command.Quest.Abandon(quest) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| quest | parameter | quest | The quest to be affected. |
Shares the given quest. Permitted only on personal quests.
| Command.Quest.Share(quest) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| quest | parameter | quest | The quest to be affected. |
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) | |||
| Command.Quest.Track(nil) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| nil | parameter | nil | The value "nil". |
| quest | parameter | quest | The quest to be affected. |
Watches a quest, possibly unwatching another quest if the player is already watching the maximum quest count. Permitted only on personal quests.
| Command.Quest.Watch(quest, flag) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| flag | parameter | boolean | The new watch status. |
| quest | parameter | quest | The quest to be affected. |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| handler | parameter | function | The new queue handler. |
Registers a new chat slash command, inserts a new event table into the Event.Slash hierarchy, and returns that table. If called multiple times with the same slash command, will return the same table each time.
| eventTable = Command.Slash.Register(slashCommand) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| slashCommand | parameter | string | The name of the slash command to register. |
| eventTable | result | table | 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. |
Adds a player to your friend list.
Throttled.
| Command.Social.Friend.Add(name) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| name | parameter | string | The name of the friend. |
Changes a friend's personal note.
Throttled.
| Command.Social.Friend.Note(name, note) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| name | parameter | string | The name of the friend. |
| note | parameter | string | The new personal note. |
Removes a player from your friend list.
Throttled.
| Command.Social.Friend.Remove(name) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| name | parameter | string | The name of the friend. |
Adds an player to your ignore list.
Throttled.
| Command.Social.Ignore.Add(name) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| name | parameter | string | The name of the ignored player. |
Changes an ignored player's personal note.
Throttled.
| Command.Social.Ignore.Note(name, note) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| name | parameter | string | The name of the ignored player. |
| note | parameter | string | The new personal note. |
Removes a player from your ignore list.
Throttled.
| Command.Social.Ignore.Remove(name) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| name | parameter | string | The name of the ignored player. |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| identifier | parameter | string | The identifier of the storage bucket. Must be at least three characters long. |
| segment | parameter | string | 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. |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| identifier | parameter | string | The identifier of the storage bucket. Must be at least three characters long. |
| segment | parameter | string | 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 | parameter | string | 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. |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| segment | parameter | string | 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 | parameter | string | 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. |
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) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| data | parameter | string | The data to store. This parameter is binary-safe. |
| identifier | parameter | string | The identifier of the storage bucket. Must be at least three characters long. |
| read | parameter | string | 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 | parameter | string | 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 | parameter | string | 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". |
Controls the flashing of the Rift taskbar icon.
| Command.System.Flash(flash) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| flash | parameter | boolean | Whether the taskbar icon should flash or not. |
Puts the environment into Strict mode. In Strict mode, deprecated functions and events will throw errors instead of functioning normally.
| Command.System.Strict() |
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() |
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() |
Changes the player's prefix title.
Throttled.
| Command.Title.Prefix(title) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| title | parameter | title, nil | The ID of the new title to set, or "nil" for no title. |
Changes the player's suffix title.
Throttled.
| Command.Title.Suffix(title) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| title | parameter | title, nil | The ID of the new title to set, or "nil" for no title. |
Changes the displayed tooltip.
| Command.Tooltip(target) | |||
| Command.Tooltip(target, nil) | |||
| Command.Tooltip(owner, buff) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| buff | parameter | buff | The ID of a buff for the new tooltip. |
| nil | parameter | nil | Optional placeholder nil. |
| owner | parameter | unit | The ID of the owner of the buff. |
| target | parameter | variant | The new tooltip. Currently accepts ability, item, itemtype, or unit IDs. Pass nil to clear the tooltip. |
Display the addon error dialog.
| Command.UI.Error(id) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| id | parameter | error | The ID of the error to be displayed. |
Creates a standard context menu targeted at the unit of choice.
| Command.Unit.Menu(target) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| target | parameter | unit | The unit to generate a context menu for. |
A UI element of type Context or derived from Context.
A UI element of type Element or derived from Element.