INDEX (Broken-down Listing)

NameTypeDeprecatedSecureDescription
CanvasA UI element of type Canvas or derived from Canvas.
Canvas.Event:KeyDownSignals a key pressed.
Canvas.Event:KeyFocusGainSignals gaining key focus.
Canvas.Event:KeyFocusLossSignals losing key focus.
Canvas.Event:KeyRepeatFrame.Event:KeyRepeat@summary
Canvas.Event:KeyTypeSignals text typed.
Canvas.Event:KeyUpSignals a key released.
Canvas.Event:LayerSignals a change in the item's layer.
Canvas.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
Canvas.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
Canvas.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
Canvas.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
Canvas.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
Canvas.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
Canvas.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
Canvas.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
Canvas.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
Canvas.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
Canvas.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
Canvas.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
Canvas.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
Canvas.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
Canvas.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
Canvas.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
Canvas.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
Canvas.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
Canvas.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
Canvas.Event:MoveSignals that the frame's vertices have moved.
Canvas.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
Canvas.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
Canvas.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
Canvas.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
Canvas.Event:SizeSignals that the frame's size has changed.
Canvas.Event:StrataSignals a change in the item's strata.
Canvas.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
Canvas.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
Canvas:ClearAllfunctionClear all set points and sizes from this frame.
Canvas:ClearHeightfunctionClear a set height from this frame.
Canvas:ClearPointfunctionClear a set point from this frame.
Canvas:ClearWidthfunctionClear a set width from this frame.
Canvas:EventAttachfunctionAttaches an event handler to an event.
Canvas:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Canvas:EventListfunctionLists the current event handlers for an event.
Canvas:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
Canvas:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
Canvas:GetAlphafunctionGets the alpha multiplier of this frame.
Canvas:GetBackgroundColorfunctionRetrieves the background color of this frame.
Canvas:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
Canvas:GetBoundsfunctionRetrieves the complete bounds of this element.
Canvas:GetChildrenfunctionReturns a table containing all of this element's children.
Canvas:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
Canvas:GetHeightfunctionRetrieves the height of this element.
Canvas:GetKeyFocusfunctionGets the key focus status.
Canvas:GetLayerfunctionGets the frame's layer order.
Canvas:GetLeftfunctionRetrieves the X position of the left edge of this element.
Canvas:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
Canvas:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
Canvas:GetNamefunctionRetrieves the name of this element.
Canvas:GetOwnerfunctionRetrieves the owner of this element.
Canvas:GetParentfunctionGets the parent of this frame.
Canvas:GetRightfunctionRetrieves the X position of the right edge of this element.
Canvas:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
Canvas:GetShapefunctionReturns the current canvas shape.
Canvas:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
Canvas:GetStrataListfunctionGets a list of valid stratas for this frame.
Canvas:GetTopfunctionRetrieves the Y position of the top edge of this element.
Canvas:GetTypefunctionRetrieves the type of this element.
Canvas:GetVisiblefunctionGets the visibility flag for this frame.
Canvas:GetWidthfunctionRetrieves the width of this element.
Canvas:ReadAllfunctionRead all set points and sizes from this frame.
Canvas:ReadHeightfunctionRead a set height from this frame.
Canvas:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
Canvas:ReadWidthfunctionRead a set width from this frame.
Canvas:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
Canvas:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
Canvas:SetBackgroundColorfunctionSets the background color of this frame.
Canvas:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
Canvas:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
Canvas:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
Canvas:SetMouseMaskingfunctionSets the frame's mouse masking mode.
Canvas:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
Canvas:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
Canvas:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
Canvas:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
Canvas:SetShapefunctionSets the canvas shape. Must have at least one of "fill" or "stroke".
Canvas:SetStratafunctionSets the strata for this frame.
Canvas:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
Canvas:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
Command.Achievement.WatchfunctionWatches an achievement, possibly unwatching another item if the player is already watching the ma...
Command.Auction.AnalyzefunctionRequests auction statistics from the server. The results will be sent to Event.Auction.Statistics...
Command.Auction.BidfunctionBids or buys out an auction.
Command.Auction.CancelfunctionCancels an auction.
Command.Auction.FulfillfunctionFulfills an existing buy order.
Command.Auction.OrderfunctionPosts a new buy order.
Command.Auction.PostfunctionPosts a new auction.
Command.Auction.ScanfunctionRequests an auction house scan. For type "search", if "index" is omitted then this function will ...
Command.Buff.CancelfunctionCancels a buff on the player. Not all buffs are cancelable.
Command.Buff.DescribefunctionRequests a detailed description for a given buff.
Command.Console.DisplayfunctionPrints a line of text in a console window of your choice. Note that the line length is limited, i...
Command.CursorfunctionChanges the contents of the cursor. Ability cursors may be set only if the environment is not in ...
Command.Dimension.Layout.PickupfunctionPick up the specified dimension item from the world to your inventory.
Command.Dimension.Layout.PlacefunctionPlaces the item (dimension or inventory) in your current dimension and modifies the details speci...
Command.Dimension.Layout.SelectfunctionSelects or deselects the specified dimension item.
Command.Event.AttachfunctionAttaches an event handler to an event.
Command.Event.DetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Command.Guild.Bank.DepositfunctionDeposits money into the guild bank.
Command.Guild.Bank.PurchasefunctionPurchases a new guild bank vault.
Command.Guild.Bank.WithdrawfunctionWithdraws money from the guild bank.
Command.Guild.Log.RequestfunctionRequests a guild log event.
Command.Guild.MotdfunctionChanges the guild's Message of the Day.
Command.Guild.Roster.DemotefunctionDemotes a guildmember by one rank.
Command.Guild.Roster.KickfunctionKicks a guildmember from the guild.
Command.Guild.Roster.NotefunctionChanges your guild note.
Command.Guild.Roster.NoteOfficerfunctionChanges a guildmember's officer note.
Command.Guild.Roster.PromotefunctionPromotes a guildmember by one rank.
Command.Guild.Wall.DeletefunctionDeletes an entry from the guild wall.
Command.Guild.Wall.PostfunctionPosts an entry to the guild wall.
Command.Guild.Wall.RequestfunctionRequests a guild wall event.
Command.Item.DestroyfunctionDestroys an item. Be careful: this really does destroy an item. There is no confirmation dialog a...
Command.Item.MovefunctionMoves an item from one location to another. This cannot move items directly between equipment, wa...
Command.Item.SplitfunctionSplits a number of items off a stack.
Command.Item.Standard.DragfunctionBehaves in the same way that the addon system does when an inventory icon is dragged.
Command.Item.Standard.DropfunctionBehaves in the same way that the addon system does when an inventory icon is dropped.
Command.Item.Standard.LeftfunctionBehaves in the same way that the addon system does when an inventory icon is left-clicked.
Command.Item.Standard.RightfunctionBehaves in the same way that the addon system does when an inventory icon is right-clicked.
Command.Mail.DeletefunctionDeletes a mail.
Command.Mail.OpenfunctionOpens a mail, retrieving detailed information for it.
Command.Mail.PayfunctionPays the COD fee on a mail.
Command.Mail.ReturnfunctionReturns a mail to its sender.
Command.Mail.SendfunctionSends mail.
Command.Mail.SpamfunctionMarks mail as spam.
Command.Mail.TakefunctionTakes an attached item from mail.
Command.Map.MonitorfunctionControls the state of the map monitor flag. When enabled, mainmap data will be received, updating...
Command.Map.Waypoint.ClearfunctionClears the player's current waypoint.
Command.Map.Waypoint.SetfunctionSets the player's waypoint.
Command.Message.AcceptfunctionSets the environment to accept a given type and identifier of message. Parameters can be replaced...
Command.Message.BroadcastfunctionBroadcast an unreliable addon message to some number of targets. This message will be dropped sil...
Command.Message.RejectfunctionSets the environment to reject a given type and identifier of message. Directly cancels out singl...
Command.Message.SendfunctionSend an reliable addon message to a single target. The callback will respond with success only o...
Command.Minion.ClaimfunctionClaims an award from a minion adventure in "finished" mode.
Command.Minion.HurryfunctionHurry a minion adventure in "working" mode.
Command.Minion.SendfunctionSend a minion on an adventure.
Command.Minion.ShufflefunctionShuffle an adventure for a new option.
Command.Minion.UnlockfunctionUnlock another minion adventure slot.
Command.Quest.AbandonfunctionAbandons the given quest. Permitted only on personal quests.
Command.Quest.SharefunctionShares the given quest. Permitted only on personal quests.
Command.Quest.TrackfunctionTracks the current quest, un-tracking any other quest that may be tracked. Pass in "nil" to cance...
Command.Quest.WatchfunctionWatches a quest, possibly unwatching another item if the player is already watching the maximum i...
Command.Queue.HandlerfunctionSets the queue handler function. The queue handler function will be called when a Command.* funct...
Command.Slash.RegisterfunctionRegisters a new chat slash command, inserts a new event handle into the Event.Slash hierarchy, an...
Command.Social.Friend.AddfunctionAdds a player to your friend list.
Command.Social.Friend.NotefunctionChanges a friend's personal note.
Command.Social.Friend.RemovefunctionRemoves a player from your friend list.
Command.Social.Ignore.AddfunctionAdds an player to your ignore list.
Command.Social.Ignore.NotefunctionChanges an ignored player's personal note.
Command.Social.Ignore.RemovefunctionRemoves a player from your ignore list.
Command.Storage.ClearfunctionRemove an element from a storage segment. If accessing guild storage, you will need write access ...
Command.Storage.GetfunctionGets a specific element from a target's storage. The result will be sent to Event.Storage.Get. Th...
Command.Storage.ListfunctionLists the visible elements in a target's storage. The results will be sent to Event.Storage.List....
Command.Storage.SetfunctionSets a storage element. If accessing guild storage, you will need the Write to Guild Addon Stora...
Command.System.FlashfunctionControls the flashing of the Rift taskbar icon.
Command.System.StrictfunctionPuts the environment into Strict mode. In Strict mode, deprecated functions and events will throw...
Command.System.Texture.RecordfunctionBegin recording Rift UI textures. The texture list will be transmitted via Event.System.Texture d...
Command.System.Watchdog.QuietfunctionSignificantly increases the time required for the watchdog to generate warnings. Intended for boo...
Command.Title.PrefixfunctionChanges the player's prefix title.
Command.Title.SuffixfunctionChanges the player's suffix title.
Command.TooltipfunctionChanges the displayed tooltip.
Command.UI.ErrorfunctionDisplay the addon error dialog.
Command.Unit.MenufunctionCreates a standard context menu targeted at the unit of choice.
ContextA UI element of type Context or derived from Context.
ElementA UI element of type Element or derived from Element.
Event.Ability.New.AddSignals the addition of a player ability.
Event.Ability.New.Cooldown.BeginSignals the start of an ability's cooldown.
Event.Ability.New.Cooldown.EndSignals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.
Event.Ability.New.Range.FalseSignals a player ability exiting range from its current target.
Event.Ability.New.Range.TrueSignals a player ability entering range from its current target.
Event.Ability.New.RemoveSignals the removal of a player ability.
Event.Ability.New.TargetSignals a player ability changing its current target.
Event.Ability.New.Usable.FalseSignals a player ability becoming unusable.
Event.Ability.New.Usable.TrueSignals a player ability becoming usable.
Event.Achievement.CompleteSignals an achievement completing.
Event.Achievement.UpdateSignals a change in an achievement's information.
Event.Addon.Load.BeginSignals the beginning of an addon's loading sequence.
Event.Addon.Load.EndSignals the end of an addon's loading sequence. At this point, that addon is fully loaded and ini...
Event.Addon.SavedVariables.Load.BeginSignals the beginning of an addon's saved variable loading.
Event.Addon.SavedVariables.Load.EndSignals the end of an addon's saved variable load.
Event.Addon.SavedVariables.Save.BeginSignals the beginning of an addon's saved variable saving.
Event.Addon.SavedVariables.Save.EndSignals the end of an addon's saved variable saving.
Event.Addon.Shutdown.BeginSignals the beginning of the shutdown sequence.
Event.Addon.Shutdown.EndSignals the end of the shutdown sequence. This is the last event that will be sent.
Event.Addon.Startup.EndSignals the end of the startup sequence. At this point, all addons are fully loaded and initialized.
Event.Attunement.Progress.AccumulatedSignals your accumulated attunement experience changing.
Event.Attunement.Progress.AvailableSignals your available attunement points changing.
Event.Attunement.Progress.RestedSignals your available attunement rested experience changing.
Event.Attunement.Progress.SpentSignals your spent attunement points changing.
Event.Auction.ScanSignals incoming auction data.
Event.Auction.StatisticsSignals receipt of auction statistics.
Event.Buff.AddSignals new buffs on a unit.
Event.Buff.ChangeSignals a change in existing buffs on a unit.
Event.Buff.DescriptionSignals a change in an existing buff's detailed description. Value of the key is "true" if detail...
Event.Buff.RemoveSignals removal of buffs from a unit.
Event.Chat.NotifySignals a screen notification. This is generally used as a warning mechanism during boss fights.
Event.Chat.NpcSignals an NPC speaking a line of text.
Event.Combat.DamageSignals damage done to a unit. All units referenced by this event will be accessible within this ...
Event.Combat.DeathSignals the death of a unit. All units referenced by this event will be accessible within this ev...
Event.Combat.DodgeSignals a unit dodging an ability. All units referenced by this event will be accessible within t...
Event.Combat.HealSignals healing done to a unit. All units referenced by this event will be accessible within this...
Event.Combat.ImmuneSignals a unit resisting an ability through immunity. All units referenced by this event will be ...
Event.Combat.MissSignals an ability's effect missing a unit. All units referenced by this event will be accessible...
Event.Combat.ParrydeprecatedSignals a unit parrying an ability. All units referenced by this event will be accessible within ...
Event.Combat.ResistSignals a unit resisting an ability. All units referenced by this event will be accessible within...
Event.CurrencySignals a change in the player's available currency.
Event.CursorSignals that the cursor has changed.
Event.Dimension.Layout.AddSignals that a dimension item has been added.
Event.Dimension.Layout.RemoveSignals that a dimension item has been removed.
Event.Dimension.Layout.UpdateSignals that a dimension item has been updated.
Event.Experience.AccumulatedSignals your accumulated experience changing.
Event.Experience.RestedSignals your available rested experience changing.
Event.Faction.NotorietySignals a change in the player's faction notoriety.
Event.Guild.Bank.ChangeSignals a change in a guild bank vault's information.
Event.Guild.Bank.CoinSignals a change in the guild bank's money.
Event.Guild.LogSignals incoming guild log data. Can be triggered manually with Command.Guild.Log.Request().
Event.Guild.MotdSignals a change in the guild Message of the Day.
Event.Guild.RankSignals a change in one of your guild's ranks.
Event.Guild.Roster.AddSignals a new player added to the guild roster.
Event.Guild.Roster.Detail.LevelSignals a change in a guildmember's level.
Event.Guild.Roster.Detail.NoteSignals a change in a guildmember's note.
Event.Guild.Roster.Detail.NoteOfficerSignals a change in a guildmember's officer note.
Event.Guild.Roster.Detail.RankSignals a change in a guildmember's rank.
Event.Guild.Roster.Detail.StatusSignals a change in a guildmember's status.
Event.Guild.Roster.Detail.ZoneSignals a change in a guildmember's zone.
Event.Guild.Roster.RemoveSignals a player removed from the guild roster.
Event.Guild.WallSignals incoming guild wall data. Can be triggered manually with Command.Guild.Wall.Request().
Event.InteractionSignals a change in available interaction types.
Event.Item.SlotSignals that the contents of an item slot have changed.
Event.Item.UpdateSignals that an item has changed.
Event.MailSignals a change in the available mail messages.
Event.Map.AddSignals the addition of a map element.
Event.Map.ChangeSignals the change of a map element, in some manner besides coordinates.
Event.Map.Detail.CoordSignals the coordinate change of a map element.
Event.Map.RemoveSignals the removal of a map element.
Event.Map.Waypoint.UpdateSignals the change of a player's waypoint.
Event.Message.ReceiveSignals the receipt of an addon message.
Event.Minion.Adventure.ChangeSignals a change in a minion adventure.
Event.Minion.Minion.ChangeSignals a change in a minion.
Event.Mouse.MoveSignals the mouse moving.
Event.Pvp.History.FavorSignals your historical favor changing.
Event.Pvp.History.Kill.TodaySignals your daily kill count changing.
Event.Pvp.Prestige.AccumulatedSignals your accumulated prestige changing.
Event.Pvp.Prestige.RankSignals your prestige rank changing.
Event.Quest.AbandonSignals that a quest has been abandoned.
Event.Quest.AcceptSignals that a quest has been accepted.
Event.Quest.ChangeSignals that a quest has been changed in some manner, most likely progress in an objective.
Event.Quest.CompleteSignals that a quest has been completed.
Event.Queue.StatusSignals that a queue may have left or entered the throttled state.
Event.Social.FriendSignals a change in your friend list.
Event.Social.IgnoreSignals a change in your ignore list.
Event.StatSignals a change in the player's stats.
Event.Storage.GetSignals receiving storage data from a target.
Event.Storage.ListSignals receiving a list of storage elements from a target.
Event.System.ErrorSignals that an addon error has occurred. To prevent infinite loops, errors in handlers for this ...
Event.System.Secure.EnterSignals that the system is entering Secure mode. Usually this is equivalent to entering combat. F...
Event.System.Secure.LeaveSignals that the system is leaving Secure mode. Usually this is equivalent to leaving combat. Fun...
Event.System.TextureSignals information on Rift UI textures that have been seen.
Event.System.Update.BeginSignals the beginning of a frame render. This is your last chance to make UI changes for this frame.
Event.System.Update.EndSignals the end of a frame render.
Event.TEMPORARY.ExperiencedeprecatedSignals a change in the player's experience.
Event.TEMPORARY.RoledeprecatedSignals a change in the player's current role.
Event.Title.AddSignals the addition of a new title.
Event.TooltipSignals that the tooltip has changed.
Event.UI.Button.Left.PressSignals that a Button has been pressed with the left mouse button. Equivalent to LeftClick, but t...
Event.UI.Checkbox.ChangeSignals that a checkbox's state has changed.
Event.UI.Input.Key.DownSignals that a keyboard key has been pressed. Requires key focus.
Event.UI.Input.Key.Down.BubbleEvent.UI.Input.Key.Down.Bubble@summary
Event.UI.Input.Key.Down.DiveEvent.UI.Input.Key.Down.Dive@summary
Event.UI.Input.Key.Focus.GainSignals that a frame has gained the key focus.
Event.UI.Input.Key.Focus.Gain.BubbleEvent.UI.Input.Key.Focus.Gain.Bubble@summary
Event.UI.Input.Key.Focus.Gain.DiveEvent.UI.Input.Key.Focus.Gain.Dive@summary
Event.UI.Input.Key.Focus.LossSignals that a frame has lost the key focus.
Event.UI.Input.Key.Focus.Loss.BubbleEvent.UI.Input.Key.Focus.Loss.Bubble@summary
Event.UI.Input.Key.Focus.Loss.DiveEvent.UI.Input.Key.Focus.Loss.Dive@summary
Event.UI.Input.Key.RepeatSignals that a keyboard key is repeating. Requires key focus.
Event.UI.Input.Key.Repeat.BubbleEvent.UI.Input.Key.Repeat.Bubble@summary
Event.UI.Input.Key.Repeat.DiveEvent.UI.Input.Key.Repeat.Dive@summary
Event.UI.Input.Key.TypeSignals that text has been typed. Requires key focus.
Event.UI.Input.Key.Type.BubbleEvent.UI.Input.Key.Type.Bubble@summary
Event.UI.Input.Key.Type.DiveEvent.UI.Input.Key.Type.Dive@summary
Event.UI.Input.Key.UpSignals that a keyboard key has been released. Requires key focus.
Event.UI.Input.Key.Up.BubbleEvent.UI.Input.Key.Up.Bubble@summary
Event.UI.Input.Key.Up.DiveEvent.UI.Input.Key.Up.Dive@summary
Event.UI.Input.Mouse.Cursor.InSignals that the cursor has moved into a frame.
Event.UI.Input.Mouse.Cursor.In.BubbleEvent.UI.Input.Mouse.Cursor.In.Bubble@summary
Event.UI.Input.Mouse.Cursor.In.DiveEvent.UI.Input.Mouse.Cursor.In.Dive@summary
Event.UI.Input.Mouse.Cursor.MoveSignals that the cursor has moved within a frame.
Event.UI.Input.Mouse.Cursor.Move.BubbleEvent.UI.Input.Mouse.Cursor.Move.Bubble@summary
Event.UI.Input.Mouse.Cursor.Move.DiveEvent.UI.Input.Mouse.Cursor.Move.Dive@summary
Event.UI.Input.Mouse.Cursor.OutSignals that the cursor has moved out of a frame.
Event.UI.Input.Mouse.Cursor.Out.BubbleEvent.UI.Input.Mouse.Cursor.Out.Bubble@summary
Event.UI.Input.Mouse.Cursor.Out.DiveEvent.UI.Input.Mouse.Cursor.Out.Dive@summary
Event.UI.Input.Mouse.Left.ClickSignals that the user has clicked the left mouse button.
Event.UI.Input.Mouse.Left.Click.BubbleEvent.UI.Input.Mouse.Left.Click.Bubble@summary
Event.UI.Input.Mouse.Left.Click.DiveEvent.UI.Input.Mouse.Left.Click.Dive@summary
Event.UI.Input.Mouse.Left.DownSignals that the user has pressed the left mouse button.
Event.UI.Input.Mouse.Left.Down.BubbleEvent.UI.Input.Mouse.Left.Down.Bubble@summary
Event.UI.Input.Mouse.Left.Down.DiveEvent.UI.Input.Mouse.Left.Down.Dive@summary
Event.UI.Input.Mouse.Left.UpSignals that the user has released the left mouse button.
Event.UI.Input.Mouse.Left.Up.BubbleEvent.UI.Input.Mouse.Left.Up.Bubble@summary
Event.UI.Input.Mouse.Left.Up.DiveEvent.UI.Input.Mouse.Left.Up.Dive@summary
Event.UI.Input.Mouse.Left.UpoutsideSignals that the user has released the left mouse button off this frame after pressing it on this...
Event.UI.Input.Mouse.Left.Upoutside.BubbleEvent.UI.Input.Mouse.Left.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Left.Upoutside.DiveEvent.UI.Input.Mouse.Left.Upoutside.Dive@summary
Event.UI.Input.Mouse.Middle.ClickSignals that the user has clicked the middle mouse button.
Event.UI.Input.Mouse.Middle.Click.BubbleEvent.UI.Input.Mouse.Middle.Click.Bubble@summary
Event.UI.Input.Mouse.Middle.Click.DiveEvent.UI.Input.Mouse.Middle.Click.Dive@summary
Event.UI.Input.Mouse.Middle.DownSignals that the user has pressed the middle mouse button.
Event.UI.Input.Mouse.Middle.Down.BubbleEvent.UI.Input.Mouse.Middle.Down.Bubble@summary
Event.UI.Input.Mouse.Middle.Down.DiveEvent.UI.Input.Mouse.Middle.Down.Dive@summary
Event.UI.Input.Mouse.Middle.UpSignals that the user has released the middle mouse button.
Event.UI.Input.Mouse.Middle.Up.BubbleEvent.UI.Input.Mouse.Middle.Up.Bubble@summary
Event.UI.Input.Mouse.Middle.Up.DiveEvent.UI.Input.Mouse.Middle.Up.Dive@summary
Event.UI.Input.Mouse.Middle.UpoutsideSignals that the user has released the middle mouse button off this frame after pressing it on th...
Event.UI.Input.Mouse.Middle.Upoutside.BubbleEvent.UI.Input.Mouse.Middle.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Middle.Upoutside.DiveEvent.UI.Input.Mouse.Middle.Upoutside.Dive@summary
Event.UI.Input.Mouse.Mouse4.ClickSignals that the user has clicked the fourth mouse button.
Event.UI.Input.Mouse.Mouse4.Click.BubbleEvent.UI.Input.Mouse.Mouse4.Click.Bubble@summary
Event.UI.Input.Mouse.Mouse4.Click.DiveEvent.UI.Input.Mouse.Mouse4.Click.Dive@summary
Event.UI.Input.Mouse.Mouse4.DownSignals that the user has pressed the fourth mouse button.
Event.UI.Input.Mouse.Mouse4.Down.BubbleEvent.UI.Input.Mouse.Mouse4.Down.Bubble@summary
Event.UI.Input.Mouse.Mouse4.Down.DiveEvent.UI.Input.Mouse.Mouse4.Down.Dive@summary
Event.UI.Input.Mouse.Mouse4.UpSignals that the user has released the fourth mouse button.
Event.UI.Input.Mouse.Mouse4.Up.BubbleEvent.UI.Input.Mouse.Mouse4.Up.Bubble@summary
Event.UI.Input.Mouse.Mouse4.Up.DiveEvent.UI.Input.Mouse.Mouse4.Up.Dive@summary
Event.UI.Input.Mouse.Mouse4.UpoutsideSignals that the user has released the fourth mouse button off this frame after pressing it on th...
Event.UI.Input.Mouse.Mouse4.Upoutside.BubbleEvent.UI.Input.Mouse.Mouse4.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Mouse4.Upoutside.DiveEvent.UI.Input.Mouse.Mouse4.Upoutside.Dive@summary
Event.UI.Input.Mouse.Mouse5.ClickSignals that the user has clicked the fifth mouse button.
Event.UI.Input.Mouse.Mouse5.Click.BubbleEvent.UI.Input.Mouse.Mouse5.Click.Bubble@summary
Event.UI.Input.Mouse.Mouse5.Click.DiveEvent.UI.Input.Mouse.Mouse5.Click.Dive@summary
Event.UI.Input.Mouse.Mouse5.DownSignals that the user has pressed the fifth mouse button.
Event.UI.Input.Mouse.Mouse5.Down.BubbleEvent.UI.Input.Mouse.Mouse5.Down.Bubble@summary
Event.UI.Input.Mouse.Mouse5.Down.DiveEvent.UI.Input.Mouse.Mouse5.Down.Dive@summary
Event.UI.Input.Mouse.Mouse5.UpSignals that the user has released the fifth mouse button.
Event.UI.Input.Mouse.Mouse5.Up.BubbleEvent.UI.Input.Mouse.Mouse5.Up.Bubble@summary
Event.UI.Input.Mouse.Mouse5.Up.DiveEvent.UI.Input.Mouse.Mouse5.Up.Dive@summary
Event.UI.Input.Mouse.Mouse5.UpoutsideSignals that the user has released the fifth mouse button off this frame after pressing it on thi...
Event.UI.Input.Mouse.Mouse5.Upoutside.BubbleEvent.UI.Input.Mouse.Mouse5.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Mouse5.Upoutside.DiveEvent.UI.Input.Mouse.Mouse5.Upoutside.Dive@summary
Event.UI.Input.Mouse.Right.ClickSignals that the user has clicked the right mouse button.
Event.UI.Input.Mouse.Right.Click.BubbleEvent.UI.Input.Mouse.Right.Click.Bubble@summary
Event.UI.Input.Mouse.Right.Click.DiveEvent.UI.Input.Mouse.Right.Click.Dive@summary
Event.UI.Input.Mouse.Right.DownSignals that the user has pressed the right mouse button.
Event.UI.Input.Mouse.Right.Down.BubbleEvent.UI.Input.Mouse.Right.Down.Bubble@summary
Event.UI.Input.Mouse.Right.Down.DiveEvent.UI.Input.Mouse.Right.Down.Dive@summary
Event.UI.Input.Mouse.Right.UpSignals that the user has released the right mouse button.
Event.UI.Input.Mouse.Right.Up.BubbleEvent.UI.Input.Mouse.Right.Up.Bubble@summary
Event.UI.Input.Mouse.Right.Up.DiveEvent.UI.Input.Mouse.Right.Up.Dive@summary
Event.UI.Input.Mouse.Right.UpoutsideSignals that the user has released the right mouse button off this frame after pressing it on thi...
Event.UI.Input.Mouse.Right.Upoutside.BubbleEvent.UI.Input.Mouse.Right.Upoutside.Bubble@summary
Event.UI.Input.Mouse.Right.Upoutside.DiveEvent.UI.Input.Mouse.Right.Upoutside.Dive@summary
Event.UI.Input.Mouse.Wheel.BackSignals that the user has moved the mousewheel back.
Event.UI.Input.Mouse.Wheel.Back.BubbleEvent.UI.Input.Mouse.Wheel.Back.Bubble@summary
Event.UI.Input.Mouse.Wheel.Back.DiveEvent.UI.Input.Mouse.Wheel.Back.Dive@summary
Event.UI.Input.Mouse.Wheel.ForwardSignals that the user has moved the mousewheel forwards.
Event.UI.Input.Mouse.Wheel.Forward.BubbleEvent.UI.Input.Mouse.Wheel.Forward.Bubble@summary
Event.UI.Input.Mouse.Wheel.Forward.DiveEvent.UI.Input.Mouse.Wheel.Forward.Dive@summary
Event.UI.Layout.LayerSignals a change in layer.
Event.UI.Layout.MoveSignals a change in the top-left corner's position. May be delayed after the actual movement.
Event.UI.Layout.SizeSignals a change in size. May be delayed after the actual change.
Event.UI.Layout.StrataSignals a change in strata.
Event.UI.Native.LoadedSignals a change in this native frame's loaded state.
Event.UI.Scrollbar.ChangeSignals a change in scrollbar position.
Event.UI.Scrollbar.GrabSignals that a scrollbar has been grabbed.
Event.UI.Scrollbar.ReleaseSignals that a scrollbar has been released.
Event.UI.Slider.ChangeSignals a change in slider position.
Event.UI.Slider.GrabSignals that a slider has been grabbed.
Event.UI.Slider.ReleaseSignals that a slider has been released.
Event.UI.Textfield.ChangeSignals a change in textfield contents.
Event.UI.Textfield.SelectSignals a change in textfield selection.
Event.Unit.AddSignals the addition of units to unit specifiers. Always preceded by Event.Unit.Change.Remove. Tr...
Event.Unit.Availability.FullSignals units entering Full availability.
Event.Unit.Availability.NoneSignals units leaving availability entirely.
Event.Unit.Availability.PartialSignals units entering Partial availability, possibly on the way to Full or None availability.
Event.Unit.CastbarSignals a unit's castbar changing.
Event.Unit.Detail.AbsorbSignals a unit's damage absorption changing.
Event.Unit.Detail.AfkSignals a unit's AFK flag changing. Will trigger only for partymembers.
Event.Unit.Detail.AggroSignals a unit's aggro flag changing. Will trigger only for groupmembers.
Event.Unit.Detail.BlockedSignals a unit's LOS-blocked flag changing. Will trigger only for groupmembers.
Event.Unit.Detail.ChargeSignals a unit's charge changing. Will trigger only for the player's unit ID.
Event.Unit.Detail.ChargeMaxSignals a unit's charge maximum changing. Will trigger only for the player's unit ID.
Event.Unit.Detail.CombatSignals a unit's combat status changing.
Event.Unit.Detail.ComboSignals a unit's combo points changing. Will trigger only for the player's unit ID.
Event.Unit.Detail.CoordSignals a change in the unit's location.
Event.Unit.Detail.EnergySignals a unit's energy changing.
Event.Unit.Detail.EnergyMaxSignals a unit's energy maximum changing.
Event.Unit.Detail.GuildSignals a unit's guild changing.
Event.Unit.Detail.HealthSignals a unit's health changing.
Event.Unit.Detail.HealthCapSignals a unit's health cap changing.
Event.Unit.Detail.HealthMaxSignals a unit's health maximum changing.
Event.Unit.Detail.LevelSignals a unit's level changing.
Event.Unit.Detail.LocationNameSignals a unit's location name changing.
Event.Unit.Detail.ManaSignals a unit's mana changing.
Event.Unit.Detail.ManaMaxSignals a unit's mana maximum changing.
Event.Unit.Detail.MarkSignals a unit's mark changing.
Event.Unit.Detail.MentoringSignals a unit's mentoring status changing.
Event.Unit.Detail.NameSignals a unit's name changing.
Event.Unit.Detail.OfflineSignals a unit's offline flag changing. Will trigger only for partymembers.
Event.Unit.Detail.PlanarSignals a unit's planar charges changing. Will trigger only for the player or groupmembers.
Event.Unit.Detail.PlanarMaxSignals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers.
Event.Unit.Detail.PowerSignals a unit's power changing.
Event.Unit.Detail.PublicSizeSignals a unit's public group size or status changing.
Event.Unit.Detail.PvpSignals a unit's PvP flag changing.
Event.Unit.Detail.RadiusSignals a unit's radius changing.
Event.Unit.Detail.ReadySignals a unit's readycheck status changing.
Event.Unit.Detail.RoleSignals a unit's role changing. Will trigger only for the player or partymembers.
Event.Unit.Detail.TaggedSignals a unit's tagged status changing.
Event.Unit.Detail.TitlePrefixIdSignals a unit's title prefix ID changing.
Event.Unit.Detail.TitlePrefixNamedeprecatedSignals a unit's localized title prefix changing.
Event.Unit.Detail.TitleSuffixIdSignals a unit's title suffix ID changing.
Event.Unit.Detail.TitleSuffixNamedeprecatedSignals a unit's localized title suffix changing.
Event.Unit.Detail.VitalitySignals a unit's vitality changing. Will trigger only for the player or groupmembers.
Event.Unit.Detail.WarfrontSignals a unit's warfront flag changing. Will trigger only for partymembers.
Event.Unit.Detail.ZoneSignals a change in the unit's zone.
Event.Unit.RemoveSignals the removal of units from unit specifiers. Always followed by Event.Unit.Change.Add. Trig...
FrameA UI element of type Frame or derived from Frame.
Frame.Event:KeyDownSignals a key pressed.
Frame.Event:KeyFocusGainSignals gaining key focus.
Frame.Event:KeyFocusLossSignals losing key focus.
Frame.Event:KeyRepeatFrame.Event:KeyRepeat@summary
Frame.Event:KeyTypeSignals text typed.
Frame.Event:KeyUpSignals a key released.
Frame.Event:LayerSignals a change in the item's layer.
Frame.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
Frame.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
Frame.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
Frame.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
Frame.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
Frame.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
Frame.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
Frame.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
Frame.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
Frame.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
Frame.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
Frame.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
Frame.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
Frame.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
Frame.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
Frame.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
Frame.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
Frame.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
Frame.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
Frame.Event:MoveSignals that the frame's vertices have moved.
Frame.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
Frame.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
Frame.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
Frame.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
Frame.Event:SizeSignals that the frame's size has changed.
Frame.Event:StrataSignals a change in the item's strata.
Frame.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
Frame.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
Frame:ClearAllfunctionClear all set points and sizes from this frame.
Frame:ClearHeightfunctionClear a set height from this frame.
Frame:ClearPointfunctionClear a set point from this frame.
Frame:ClearWidthfunctionClear a set width from this frame.
Frame:EventAttachfunctionAttaches an event handler to an event.
Frame:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Frame:EventListfunctionLists the current event handlers for an event.
Frame:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
Frame:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
Frame:GetAlphafunctionGets the alpha multiplier of this frame.
Frame:GetBackgroundColorfunctionRetrieves the background color of this frame.
Frame:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
Frame:GetBoundsfunctionRetrieves the complete bounds of this element.
Frame:GetChildrenfunctionReturns a table containing all of this element's children.
Frame:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
Frame:GetHeightfunctionRetrieves the height of this element.
Frame:GetKeyFocusfunctionGets the key focus status.
Frame:GetLayerfunctionGets the frame's layer order.
Frame:GetLeftfunctionRetrieves the X position of the left edge of this element.
Frame:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
Frame:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
Frame:GetNamefunctionRetrieves the name of this element.
Frame:GetOwnerfunctionRetrieves the owner of this element.
Frame:GetParentfunctionGets the parent of this frame.
Frame:GetRightfunctionRetrieves the X position of the right edge of this element.
Frame:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
Frame:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
Frame:GetStrataListfunctionGets a list of valid stratas for this frame.
Frame:GetTopfunctionRetrieves the Y position of the top edge of this element.
Frame:GetTypefunctionRetrieves the type of this element.
Frame:GetVisiblefunctionGets the visibility flag for this frame.
Frame:GetWidthfunctionRetrieves the width of this element.
Frame:ReadAllfunctionRead all set points and sizes from this frame.
Frame:ReadHeightfunctionRead a set height from this frame.
Frame:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
Frame:ReadWidthfunctionRead a set width from this frame.
Frame:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
Frame:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
Frame:SetBackgroundColorfunctionSets the background color of this frame.
Frame:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
Frame:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
Frame:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
Frame:SetMouseMaskingfunctionSets the frame's mouse masking mode.
Frame:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
Frame:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
Frame:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
Frame:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
Frame:SetStratafunctionSets the strata for this frame.
Frame:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
Frame:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
Inspect.Ability.New.DetailfunctionProvides detailed information about abilities.
Inspect.Ability.New.ListfunctionList available abilities.
Inspect.Achievement.Category.DetailfunctionReturns information about achievement categories.
Inspect.Achievement.Category.ListfunctionReturns a table of valid achievement categories.
Inspect.Achievement.DetailfunctionProvides detailed information about achievements.
Inspect.Achievement.ListfunctionReturns a table of all known achievements.
Inspect.Addon.CpufunctionReturns recent CPU usage information. This is calculated using an exponential-falloff method.
Inspect.Addon.CurrentfunctionReturns the current addon. This information is used internally for counting CPU usage and determi...
Inspect.Addon.DetailfunctionProvides detailed information about loaded addons.
Inspect.Addon.ListfunctionLists all the addons that the client has loaded.
Inspect.Attunement.ProgressfunctionReturns information on your current attunement progress.
Inspect.Auction.DetailfunctionProvides detailed information about auctions.
Inspect.Buff.DetailfunctionProvides detailed information about the buffs on a unit.
Inspect.Buff.ListfunctionList buffs on a unit.
Inspect.Console.DetailfunctionProvides detailed information about consoles.
Inspect.Console.ListfunctionReturns a table of the current open text consoles.
Inspect.Currency.Category.DetailfunctionReturns information about currency categories.
Inspect.Currency.Category.ListfunctionReturns a table of valid currency categories.
Inspect.Currency.DetailfunctionProvides detailed information about currencies.
Inspect.Currency.ListfunctionReturns a table of all known currencies.
Inspect.CursorfunctionReturns the current contents of the cursor.
Inspect.Dimension.Layout.DetailfunctionReturns details about the specified dimension item.
Inspect.Dimension.Layout.ListfunctionReturns a list of dimension items in the dimension you're currently in, and whether or not they a...
Inspect.DocumentationfunctionProvide documentation on items in the addon environment. Called with no parameters, it returns a ...
Inspect.Event.ListfunctionLists the current event handlers for an event.
Inspect.ExperiencefunctionReturns information on your experience.
Inspect.Faction.DetailfunctionProvides detailed information about factions.
Inspect.Faction.ListfunctionReturns a table of all known factions.
Inspect.Guild.Bank.CoinfunctionReturns the amount of money contained within the guild bank.
Inspect.Guild.Bank.DetailfunctionProvides detailed information about guild bank vaults.
Inspect.Guild.Bank.ListfunctionReturns a table of all available guild bank vaults.
Inspect.Guild.MotdfunctionReturns the current guild Message of the Day.
Inspect.Guild.Rank.DetailfunctionProvides detailed information about guild ranks.
Inspect.Guild.Rank.ListfunctionLists available guild ranks.
Inspect.Guild.Roster.DetailfunctionProvides detailed information about guildmembers.
Inspect.Guild.Roster.ListfunctionLists guildmembers.
Inspect.InteractionfunctionProvides information about what types of interaction are available.
Inspect.Item.DetailfunctionProvides detailed information about items.
Inspect.Item.FindfunctionFinds a slot specifier based on an item ID.
Inspect.Item.ListfunctionGenerate a list of item IDs from a slot specifier or set of slot specifiers.
Inspect.Mail.DetailfunctionReturns information about mail.
Inspect.Mail.ListfunctionReturns a table of valid mail and its status.
Inspect.Map.DetailfunctionReturns information about map locations.
Inspect.Map.ListfunctionReturns a table of map locations.
Inspect.Map.MonitorfunctionInspects the state of the map monitor flag. See Command.Map.Monitor() for details.
Inspect.Map.Waypoint.GetfunctionGets a unit's current waypoint.
Inspect.Message.Accept.CheckfunctionChecks whether a given message type would be accepted if it were sent to you. Parameters can be r...
Inspect.Message.Accept.ListfunctionRetrieves the list of accepted message types and identifiers.
Inspect.Minion.Adventure.DetailfunctionProvides detailed information about minion adventures.
Inspect.Minion.Adventure.ListfunctionLists known minion adventures.
Inspect.Minion.Minion.DetailfunctionProvides detailed information about minions.
Inspect.Minion.Minion.ListfunctionLists available minions.
Inspect.Minion.SlotfunctionReturns the total number of minion adventure slots.
Inspect.MousefunctionReturns information about the current mouse position and button state.
Inspect.Pvp.HistoryfunctionReturns information on your PVP history.
Inspect.Pvp.PrestigefunctionReturns information on your PVP prestige.
Inspect.Quest.CompletefunctionReturns a table of all quests completed.
Inspect.Quest.DetailfunctionProvides detailed information about a quest.
Inspect.Quest.ListfunctionLists the player's current active quests.
Inspect.Queue.HandlerfunctionReturns the current queue handler function.
Inspect.Queue.StatusfunctionInspects the current queue status. Omit the first parameter to get a table containing information...
Inspect.Role.ListfunctionLists the player's roles.
Inspect.Setting.DetailfunctionProvides detailed information about a setting.
Inspect.Setting.ListfunctionLists the player's current settings.
Inspect.ShardfunctionReturns information about the current shard.
Inspect.Social.Friend.DetailfunctionProvides detailed information about a friend.
Inspect.Social.Friend.ListfunctionLists the player's current friends.
Inspect.Social.Ignore.DetailfunctionProvides detailed information about an ignored player.
Inspect.Social.Ignore.ListfunctionLists the player's current ignored players.
Inspect.StatfunctionReturns information about the player's stats.
Inspect.Storage.UsedfunctionReturns the storage space currently used for a given segment.
Inspect.System.Error.DetailfunctionProvides detailed information about an addon error.
Inspect.System.LanguagefunctionReturns the client's current language.
Inspect.System.SecurefunctionReturns the client's current secure mode.
Inspect.System.VersionfunctionReturns information on the client version.
Inspect.System.WatchdogfunctionReturns the number of seconds until the system watchdog may begin generating warnings.
Inspect.TEMPORARY.ExperiencefunctiondeprecatedReturns information about the player's experience.
Inspect.TEMPORARY.RolefunctiondeprecatedReturns the ID of the player's current role.
Inspect.Time.FramefunctionThe game time of the last frame. This function's return value will not change until the next frame.
Inspect.Time.RealfunctionA high-resolution realtime timer. Not measured in the same timespace as Inspect.Time.Frame.
Inspect.Time.ServerfunctionReturns the current server time.
Inspect.Title.Category.DetailfunctionProvides detailed information about a title category.
Inspect.Title.Category.ListfunctionLists known title categories.
Inspect.Title.DetailfunctionProvides detailed information about a title.
Inspect.Title.ListfunctionLists the player's currently available titles.
Inspect.TooltipfunctionReturns the current contents of the tooltip.
Inspect.Unit.CastbarfunctionProvides detailed information about a unit's castbar.
Inspect.Unit.DetailfunctionProvides detailed information about a unit.
Inspect.Unit.ListfunctionLists all the units that the client can see.
Inspect.Unit.LookupfunctionConverts unit IDs to unit specifiers and vice-versa.
Inspect.Zone.DetailfunctionReturns information about zones.
LayoutA UI element of type Layout or derived from Layout.
Layout.Event:MoveSignals that the frame's vertices have moved.
Layout.Event:SizeSignals that the frame's size has changed.
Layout:EventAttachfunctionAttaches an event handler to an event.
Layout:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Layout:EventListfunctionLists the current event handlers for an event.
Layout:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
Layout:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
Layout:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
Layout:GetBoundsfunctionRetrieves the complete bounds of this element.
Layout:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
Layout:GetHeightfunctionRetrieves the height of this element.
Layout:GetLeftfunctionRetrieves the X position of the left edge of this element.
Layout:GetNamefunctionRetrieves the name of this element.
Layout:GetOwnerfunctionRetrieves the owner of this element.
Layout:GetRightfunctionRetrieves the X position of the right edge of this element.
Layout:GetTopfunctionRetrieves the Y position of the top edge of this element.
Layout:GetTypefunctionRetrieves the type of this element.
Layout:GetWidthfunctionRetrieves the width of this element.
Layout:ReadAllfunctionRead all set points and sizes from this frame.
Layout:ReadHeightfunctionRead a set height from this frame.
Layout:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
Layout:ReadWidthfunctionRead a set width from this frame.
MaskA UI element of type Mask or derived from Mask.
Mask.Event:KeyDownSignals a key pressed.
Mask.Event:KeyFocusGainSignals gaining key focus.
Mask.Event:KeyFocusLossSignals losing key focus.
Mask.Event:KeyRepeatFrame.Event:KeyRepeat@summary
Mask.Event:KeyTypeSignals text typed.
Mask.Event:KeyUpSignals a key released.
Mask.Event:LayerSignals a change in the item's layer.
Mask.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
Mask.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
Mask.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
Mask.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
Mask.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
Mask.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
Mask.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
Mask.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
Mask.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
Mask.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
Mask.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
Mask.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
Mask.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
Mask.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
Mask.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
Mask.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
Mask.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
Mask.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
Mask.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
Mask.Event:MoveSignals that the frame's vertices have moved.
Mask.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
Mask.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
Mask.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
Mask.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
Mask.Event:SizeSignals that the frame's size has changed.
Mask.Event:StrataSignals a change in the item's strata.
Mask.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
Mask.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
Mask:ClearAllfunctionClear all set points and sizes from this frame.
Mask:ClearHeightfunctionClear a set height from this frame.
Mask:ClearPointfunctionClear a set point from this frame.
Mask:ClearWidthfunctionClear a set width from this frame.
Mask:EventAttachfunctionAttaches an event handler to an event.
Mask:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Mask:EventListfunctionLists the current event handlers for an event.
Mask:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
Mask:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
Mask:GetAlphafunctionGets the alpha multiplier of this frame.
Mask:GetBackgroundColorfunctionRetrieves the background color of this frame.
Mask:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
Mask:GetBoundsfunctionRetrieves the complete bounds of this element.
Mask:GetChildrenfunctionReturns a table containing all of this element's children.
Mask:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
Mask:GetHeightfunctionRetrieves the height of this element.
Mask:GetKeyFocusfunctionGets the key focus status.
Mask:GetLayerfunctionGets the frame's layer order.
Mask:GetLeftfunctionRetrieves the X position of the left edge of this element.
Mask:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
Mask:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
Mask:GetNamefunctionRetrieves the name of this element.
Mask:GetOwnerfunctionRetrieves the owner of this element.
Mask:GetParentfunctionGets the parent of this frame.
Mask:GetRightfunctionRetrieves the X position of the right edge of this element.
Mask:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
Mask:GetShapefunctionReturns the current mask shape.
Mask:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
Mask:GetStrataListfunctionGets a list of valid stratas for this frame.
Mask:GetTopfunctionRetrieves the Y position of the top edge of this element.
Mask:GetTypefunctionRetrieves the type of this element.
Mask:GetVisiblefunctionGets the visibility flag for this frame.
Mask:GetWidthfunctionRetrieves the width of this element.
Mask:ReadAllfunctionRead all set points and sizes from this frame.
Mask:ReadHeightfunctionRead a set height from this frame.
Mask:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
Mask:ReadWidthfunctionRead a set width from this frame.
Mask:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
Mask:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
Mask:SetBackgroundColorfunctionSets the background color of this frame.
Mask:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
Mask:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
Mask:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
Mask:SetMouseMaskingfunctionSets the frame's mouse masking mode.
Mask:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
Mask:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
Mask:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
Mask:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
Mask:SetShapefunctionSets the mask shape. Note that masks with custom shapes will not cull mouse events according to t...
Mask:SetStratafunctionSets the strata for this frame.
Mask:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
Mask:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
NativeA UI element of type Native or derived from Native.
Native.Event:LayerSignals a change in the item's layer.
Native.Event:LoadedSignals a change in the item's loaded status.
Native.Event:MoveSignals that the frame's vertices have moved.
Native.Event:SizeSignals that the frame's size has changed.
Native.Event:StrataSignals a change in the item's strata.
Native:EventAttachfunctionAttaches an event handler to an event.
Native:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Native:EventListfunctionLists the current event handlers for an event.
Native:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
Native:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
Native:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
Native:GetBoundsfunctionRetrieves the complete bounds of this element.
Native:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
Native:GetHeightfunctionRetrieves the height of this element.
Native:GetLayerfunctionGets the native item's layer order.
Native:GetLeftfunctionRetrieves the X position of the left edge of this element.
Native:GetLoadedfunctionGets whether or not this native element is loaded and rendering.
Native:GetNamefunctionRetrieves the name of this element.
Native:GetOwnerfunctionRetrieves the owner of this element.
Native:GetRightfunctionRetrieves the X position of the right edge of this element.
Native:GetSecureModefunctionGet the native element's secure mode. See Frame:SetSecureMode() for details.
Native:GetStratafunctionGets the native item's strata. The strata determines render order on a coarser level than Layer d...
Native:GetStrataListfunctionGets a list of valid stratas for this native element.
Native:GetTopfunctionRetrieves the Y position of the top edge of this element.
Native:GetTypefunctionRetrieves the type of this element.
Native:GetWidthfunctionRetrieves the width of this element.
Native:ReadAllfunctionRead all set points and sizes from this frame.
Native:ReadHeightfunctionRead a set height from this frame.
Native:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
Native:ReadWidthfunctionRead a set width from this frame.
Native:SetLayerfunctionSets the frame layer for this native element. This can be any number. Frames are drawn in ascendi...
Native:SetStratafunctionSets the strata for this native element.
RiftButtonA UI element of type RiftButton or derived from RiftButton.
RiftButton.Event:KeyDownSignals a key pressed.
RiftButton.Event:KeyFocusGainSignals gaining key focus.
RiftButton.Event:KeyFocusLossSignals losing key focus.
RiftButton.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftButton.Event:KeyTypeSignals text typed.
RiftButton.Event:KeyUpSignals a key released.
RiftButton.Event:LayerSignals a change in the item's layer.
RiftButton.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftButton.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftButton.Event:LeftPressSignals that the button has been pressed. Equivalent to LeftClick, but triggers only while the bu...
RiftButton.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftButton.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftButton.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftButton.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftButton.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftButton.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftButton.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftButton.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftButton.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftButton.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftButton.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftButton.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftButton.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftButton.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftButton.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftButton.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftButton.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftButton.Event:MoveSignals that the frame's vertices have moved.
RiftButton.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftButton.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftButton.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftButton.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftButton.Event:SizeSignals that the frame's size has changed.
RiftButton.Event:StrataSignals a change in the item's strata.
RiftButton.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftButton.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftButton:ClearAllfunctionClear all set points and sizes from this frame.
RiftButton:ClearHeightfunctionClear a set height from this frame.
RiftButton:ClearPointfunctionClear a set point from this frame.
RiftButton:ClearWidthfunctionClear a set width from this frame.
RiftButton:EventAttachfunctionAttaches an event handler to an event.
RiftButton:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftButton:EventListfunctionLists the current event handlers for an event.
RiftButton:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftButton:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftButton:GetAlphafunctionGets the alpha multiplier of this frame.
RiftButton:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftButton:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftButton:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftButton:GetChildrenfunctionReturns a table containing all of this element's children.
RiftButton:GetEnabledfunctionGets whether the button is enabled or grayed out.
RiftButton:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftButton:GetHeightfunctionRetrieves the height of this element.
RiftButton:GetKeyFocusfunctionGets the key focus status.
RiftButton:GetLayerfunctionGets the frame's layer order.
RiftButton:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftButton:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftButton:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
RiftButton:GetNamefunctionRetrieves the name of this element.
RiftButton:GetOwnerfunctionRetrieves the owner of this element.
RiftButton:GetParentfunctionGets the parent of this frame.
RiftButton:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftButton:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
RiftButton:GetSkinfunctionGets the current skin of this item.
RiftButton:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
RiftButton:GetStrataListfunctionGets a list of valid stratas for this frame.
RiftButton:GetTextfunctionGets this button's text.
RiftButton:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftButton:GetTypefunctionRetrieves the type of this element.
RiftButton:GetVisiblefunctionGets the visibility flag for this frame.
RiftButton:GetWidthfunctionRetrieves the width of this element.
RiftButton:ReadAllfunctionRead all set points and sizes from this frame.
RiftButton:ReadHeightfunctionRead a set height from this frame.
RiftButton:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftButton:ReadWidthfunctionRead a set width from this frame.
RiftButton:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
RiftButton:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftButton:SetBackgroundColorfunctionSets the background color of this frame.
RiftButton:SetEnabledfunctionSets whether the button is enabled or grayed out.
RiftButton:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
RiftButton:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftButton:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
RiftButton:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftButton:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
RiftButton:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
RiftButton:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
RiftButton:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
RiftButton:SetSkinfunctionSets the current skin of this item.
RiftButton:SetStratafunctionSets the strata for this frame.
RiftButton:SetTextfunctionSets this button's text.
RiftButton:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
RiftButton:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
RiftCheckboxA UI element of type RiftCheckbox or derived from RiftCheckbox.
RiftCheckbox.Event:CheckboxChangeSignals that the checkbox's checked state has changed.
RiftCheckbox.Event:KeyDownSignals a key pressed.
RiftCheckbox.Event:KeyFocusGainSignals gaining key focus.
RiftCheckbox.Event:KeyFocusLossSignals losing key focus.
RiftCheckbox.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftCheckbox.Event:KeyTypeSignals text typed.
RiftCheckbox.Event:KeyUpSignals a key released.
RiftCheckbox.Event:LayerSignals a change in the item's layer.
RiftCheckbox.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftCheckbox.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftCheckbox.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftCheckbox.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftCheckbox.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftCheckbox.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftCheckbox.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftCheckbox.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftCheckbox.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftCheckbox.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftCheckbox.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftCheckbox.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftCheckbox.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftCheckbox.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftCheckbox.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftCheckbox.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftCheckbox.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftCheckbox.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftCheckbox.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftCheckbox.Event:MoveSignals that the frame's vertices have moved.
RiftCheckbox.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftCheckbox.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftCheckbox.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftCheckbox.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftCheckbox.Event:SizeSignals that the frame's size has changed.
RiftCheckbox.Event:StrataSignals a change in the item's strata.
RiftCheckbox.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftCheckbox.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftCheckbox:ClearAllfunctionClear all set points and sizes from this frame.
RiftCheckbox:ClearHeightfunctionClear a set height from this frame.
RiftCheckbox:ClearPointfunctionClear a set point from this frame.
RiftCheckbox:ClearWidthfunctionClear a set width from this frame.
RiftCheckbox:EventAttachfunctionAttaches an event handler to an event.
RiftCheckbox:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftCheckbox:EventListfunctionLists the current event handlers for an event.
RiftCheckbox:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftCheckbox:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftCheckbox:GetAlphafunctionGets the alpha multiplier of this frame.
RiftCheckbox:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftCheckbox:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftCheckbox:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftCheckbox:GetCheckedfunctionGets whether the button is checked or not.
RiftCheckbox:GetChildrenfunctionReturns a table containing all of this element's children.
RiftCheckbox:GetEnabledfunctionGets whether the checkbox is enabled or grayed out.
RiftCheckbox:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftCheckbox:GetHeightfunctionRetrieves the height of this element.
RiftCheckbox:GetKeyFocusfunctionGets the key focus status.
RiftCheckbox:GetLayerfunctionGets the frame's layer order.
RiftCheckbox:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftCheckbox:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftCheckbox:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
RiftCheckbox:GetNamefunctionRetrieves the name of this element.
RiftCheckbox:GetOwnerfunctionRetrieves the owner of this element.
RiftCheckbox:GetParentfunctionGets the parent of this frame.
RiftCheckbox:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftCheckbox:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
RiftCheckbox:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
RiftCheckbox:GetStrataListfunctionGets a list of valid stratas for this frame.
RiftCheckbox:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftCheckbox:GetTypefunctionRetrieves the type of this element.
RiftCheckbox:GetVisiblefunctionGets the visibility flag for this frame.
RiftCheckbox:GetWidthfunctionRetrieves the width of this element.
RiftCheckbox:ReadAllfunctionRead all set points and sizes from this frame.
RiftCheckbox:ReadHeightfunctionRead a set height from this frame.
RiftCheckbox:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftCheckbox:ReadWidthfunctionRead a set width from this frame.
RiftCheckbox:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
RiftCheckbox:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftCheckbox:SetBackgroundColorfunctionSets the background color of this frame.
RiftCheckbox:SetCheckedfunctionSets whether the checkbox is checked or not.
RiftCheckbox:SetEnabledfunctionSets whether the checkbox is enabled or grayed out.
RiftCheckbox:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
RiftCheckbox:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftCheckbox:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
RiftCheckbox:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftCheckbox:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
RiftCheckbox:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
RiftCheckbox:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
RiftCheckbox:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
RiftCheckbox:SetStratafunctionSets the strata for this frame.
RiftCheckbox:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
RiftCheckbox:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
RiftScrollbarA UI element of type RiftScrollbar or derived from RiftScrollbar.
RiftScrollbar.Event:KeyDownSignals a key pressed.
RiftScrollbar.Event:KeyFocusGainSignals gaining key focus.
RiftScrollbar.Event:KeyFocusLossSignals losing key focus.
RiftScrollbar.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftScrollbar.Event:KeyTypeSignals text typed.
RiftScrollbar.Event:KeyUpSignals a key released.
RiftScrollbar.Event:LayerSignals a change in the item's layer.
RiftScrollbar.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftScrollbar.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftScrollbar.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftScrollbar.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftScrollbar.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftScrollbar.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftScrollbar.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftScrollbar.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftScrollbar.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftScrollbar.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftScrollbar.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftScrollbar.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftScrollbar.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftScrollbar.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftScrollbar.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftScrollbar.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftScrollbar.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftScrollbar.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftScrollbar.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftScrollbar.Event:MoveSignals that the frame's vertices have moved.
RiftScrollbar.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftScrollbar.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftScrollbar.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftScrollbar.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftScrollbar.Event:ScrollbarChangeSignals a change in the scrollbar position.
RiftScrollbar.Event:ScrollbarGrabSignals the user grabbing the scrollbar with the mouse.
RiftScrollbar.Event:ScrollbarReleaseSignals the user releasing the scrollbar.
RiftScrollbar.Event:SizeSignals that the frame's size has changed.
RiftScrollbar.Event:StrataSignals a change in the item's strata.
RiftScrollbar.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftScrollbar.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftScrollbar:ClearAllfunctionClear all set points and sizes from this frame.
RiftScrollbar:ClearHeightfunctionClear a set height from this frame.
RiftScrollbar:ClearPointfunctionClear a set point from this frame.
RiftScrollbar:ClearWidthfunctionClear a set width from this frame.
RiftScrollbar:EventAttachfunctionAttaches an event handler to an event.
RiftScrollbar:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftScrollbar:EventListfunctionLists the current event handlers for an event.
RiftScrollbar:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftScrollbar:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftScrollbar:GetAlphafunctionGets the alpha multiplier of this frame.
RiftScrollbar:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftScrollbar:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftScrollbar:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftScrollbar:GetChildrenfunctionReturns a table containing all of this element's children.
RiftScrollbar:GetEnabledfunctionGets whether the scrollbar is enabled or disabled.
RiftScrollbar:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftScrollbar:GetHeightfunctionRetrieves the height of this element.
RiftScrollbar:GetKeyFocusfunctionGets the key focus status.
RiftScrollbar:GetLayerfunctionGets the frame's layer order.
RiftScrollbar:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftScrollbar:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftScrollbar:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
RiftScrollbar:GetNamefunctionRetrieves the name of this element.
RiftScrollbar:GetOrientationfunctionGets the current orientation of the scrollbar.
RiftScrollbar:GetOwnerfunctionRetrieves the owner of this element.
RiftScrollbar:GetParentfunctionGets the parent of this frame.
RiftScrollbar:GetPositionfunctionReturns the current position of the scrollbar.
RiftScrollbar:GetRangefunctionReturns the current range of the scrollbar.
RiftScrollbar:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftScrollbar:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
RiftScrollbar:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
RiftScrollbar:GetStrataListfunctionGets a list of valid stratas for this frame.
RiftScrollbar:GetThicknessfunctionReturns the thickness of the scrollbar handle. Size is relative to the range.
RiftScrollbar:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftScrollbar:GetTypefunctionRetrieves the type of this element.
RiftScrollbar:GetVisiblefunctionGets the visibility flag for this frame.
RiftScrollbar:GetWidthfunctionRetrieves the width of this element.
RiftScrollbar:NudgefunctionModify the scrollbar position, clamped to the current bounds.
RiftScrollbar:NudgeDownfunctionShift the scrollbar down (i.e. away from zero) by a standard amount.
RiftScrollbar:NudgeUpfunctionShift the scrollbar up (i.e. towards zero) by a standard amount.
RiftScrollbar:ReadAllfunctionRead all set points and sizes from this frame.
RiftScrollbar:ReadHeightfunctionRead a set height from this frame.
RiftScrollbar:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftScrollbar:ReadWidthfunctionRead a set width from this frame.
RiftScrollbar:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
RiftScrollbar:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftScrollbar:SetBackgroundColorfunctionSets the background color of this frame.
RiftScrollbar:SetEnabledfunctionSets whether the scrollbar is enabled or disabled.
RiftScrollbar:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
RiftScrollbar:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftScrollbar:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
RiftScrollbar:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftScrollbar:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
RiftScrollbar:SetOrientationfunctionSets the orientation of the scrollbar.
RiftScrollbar:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
RiftScrollbar:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
RiftScrollbar:SetPositionfunctionChanges the current position of the scrollbar.
RiftScrollbar:SetRangefunctionChanges the current range of the scrollbar.
RiftScrollbar:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
RiftScrollbar:SetStratafunctionSets the strata for this frame.
RiftScrollbar:SetThicknessfunctionSets the current thickness of the scrollbar handle. Size is relative to the range.
RiftScrollbar:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
RiftScrollbar:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
RiftSliderA UI element of type RiftSlider or derived from RiftSlider.
RiftSlider.Event:KeyDownSignals a key pressed.
RiftSlider.Event:KeyFocusGainSignals gaining key focus.
RiftSlider.Event:KeyFocusLossSignals losing key focus.
RiftSlider.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftSlider.Event:KeyTypeSignals text typed.
RiftSlider.Event:KeyUpSignals a key released.
RiftSlider.Event:LayerSignals a change in the item's layer.
RiftSlider.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftSlider.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftSlider.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftSlider.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftSlider.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftSlider.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftSlider.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftSlider.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftSlider.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftSlider.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftSlider.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftSlider.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftSlider.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftSlider.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftSlider.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftSlider.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftSlider.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftSlider.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftSlider.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftSlider.Event:MoveSignals that the frame's vertices have moved.
RiftSlider.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftSlider.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftSlider.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftSlider.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftSlider.Event:SizeSignals that the frame's size has changed.
RiftSlider.Event:SliderChangeSignals a change in the slider position.
RiftSlider.Event:SliderGrabSignals the user grabbing the slider with the mouse.
RiftSlider.Event:SliderReleaseSignals the user releasing the slider.
RiftSlider.Event:StrataSignals a change in the item's strata.
RiftSlider.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftSlider.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftSlider:ClearAllfunctionClear all set points and sizes from this frame.
RiftSlider:ClearHeightfunctionClear a set height from this frame.
RiftSlider:ClearPointfunctionClear a set point from this frame.
RiftSlider:ClearWidthfunctionClear a set width from this frame.
RiftSlider:EventAttachfunctionAttaches an event handler to an event.
RiftSlider:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftSlider:EventListfunctionLists the current event handlers for an event.
RiftSlider:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftSlider:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftSlider:GetAlphafunctionGets the alpha multiplier of this frame.
RiftSlider:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftSlider:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftSlider:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftSlider:GetChildrenfunctionReturns a table containing all of this element's children.
RiftSlider:GetEnabledfunctionGets whether the slider is enabled or grayed out.
RiftSlider:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftSlider:GetHeightfunctionRetrieves the height of this element.
RiftSlider:GetKeyFocusfunctionGets the key focus status.
RiftSlider:GetLayerfunctionGets the frame's layer order.
RiftSlider:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftSlider:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftSlider:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
RiftSlider:GetNamefunctionRetrieves the name of this element.
RiftSlider:GetOwnerfunctionRetrieves the owner of this element.
RiftSlider:GetParentfunctionGets the parent of this frame.
RiftSlider:GetPositionfunctionReturns the current position of the slider.
RiftSlider:GetRangefunctionReturns the current range of the slider.
RiftSlider:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftSlider:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
RiftSlider:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
RiftSlider:GetStrataListfunctionGets a list of valid stratas for this frame.
RiftSlider:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftSlider:GetTypefunctionRetrieves the type of this element.
RiftSlider:GetVisiblefunctionGets the visibility flag for this frame.
RiftSlider:GetWidthfunctionRetrieves the width of this element.
RiftSlider:ReadAllfunctionRead all set points and sizes from this frame.
RiftSlider:ReadHeightfunctionRead a set height from this frame.
RiftSlider:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftSlider:ReadWidthfunctionRead a set width from this frame.
RiftSlider:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
RiftSlider:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftSlider:SetBackgroundColorfunctionSets the background color of this frame.
RiftSlider:SetEnabledfunctionSets whether the slider is enabled or grayed out.
RiftSlider:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
RiftSlider:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftSlider:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
RiftSlider:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftSlider:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
RiftSlider:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
RiftSlider:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
RiftSlider:SetPositionfunctionChanges the current position of the slider.
RiftSlider:SetRangefunctionSets the current range of the slider.
RiftSlider:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
RiftSlider:SetStratafunctionSets the strata for this frame.
RiftSlider:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
RiftSlider:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
RiftTextfieldA UI element of type RiftTextfield or derived from RiftTextfield.
RiftTextfield.Event:KeyDownSignals a key pressed.
RiftTextfield.Event:KeyFocusGainSignals gaining key focus.
RiftTextfield.Event:KeyFocusLossSignals losing key focus.
RiftTextfield.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftTextfield.Event:KeyTypeSignals text typed.
RiftTextfield.Event:KeyUpSignals a key released.
RiftTextfield.Event:LayerSignals a change in the item's layer.
RiftTextfield.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftTextfield.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftTextfield.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftTextfield.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftTextfield.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftTextfield.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftTextfield.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftTextfield.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftTextfield.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftTextfield.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftTextfield.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftTextfield.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftTextfield.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftTextfield.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftTextfield.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftTextfield.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftTextfield.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftTextfield.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftTextfield.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftTextfield.Event:MoveSignals that the frame's vertices have moved.
RiftTextfield.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftTextfield.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftTextfield.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftTextfield.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftTextfield.Event:SizeSignals that the frame's size has changed.
RiftTextfield.Event:StrataSignals a change in the item's strata.
RiftTextfield.Event:TextfieldChangeSignals that the textfield's text has changed.
RiftTextfield.Event:TextfieldSelectSignals that the textfield's selection has changed.
RiftTextfield.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftTextfield.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftTextfield:ClearAllfunctionClear all set points and sizes from this frame.
RiftTextfield:ClearHeightfunctionClear a set height from this frame.
RiftTextfield:ClearPointfunctionClear a set point from this frame.
RiftTextfield:ClearWidthfunctionClear a set width from this frame.
RiftTextfield:EventAttachfunctionAttaches an event handler to an event.
RiftTextfield:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftTextfield:EventListfunctionLists the current event handlers for an event.
RiftTextfield:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftTextfield:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftTextfield:GetAlphafunctionGets the alpha multiplier of this frame.
RiftTextfield:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftTextfield:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftTextfield:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftTextfield:GetChildrenfunctionReturns a table containing all of this element's children.
RiftTextfield:GetCursorfunctionReturns the current position of the cursor.
RiftTextfield:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftTextfield:GetHeightfunctionRetrieves the height of this element.
RiftTextfield:GetKeyFocusfunctionGets the key focus status.
RiftTextfield:GetLayerfunctionGets the frame's layer order.
RiftTextfield:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftTextfield:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftTextfield:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
RiftTextfield:GetNamefunctionRetrieves the name of this element.
RiftTextfield:GetOwnerfunctionRetrieves the owner of this element.
RiftTextfield:GetParentfunctionGets the parent of this frame.
RiftTextfield:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftTextfield:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
RiftTextfield:GetSelectionfunctionReturns the current bounds of the selected text.
RiftTextfield:GetSelectionTextfunctionGet the current selected text for this element. Returns nil if no text has been selected.
RiftTextfield:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
RiftTextfield:GetStrataListfunctionGets a list of valid stratas for this frame.
RiftTextfield:GetTextfunctionGet the current text for this element.
RiftTextfield:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftTextfield:GetTypefunctionRetrieves the type of this element.
RiftTextfield:GetVisiblefunctionGets the visibility flag for this frame.
RiftTextfield:GetWidthfunctionRetrieves the width of this element.
RiftTextfield:ReadAllfunctionRead all set points and sizes from this frame.
RiftTextfield:ReadHeightfunctionRead a set height from this frame.
RiftTextfield:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftTextfield:ReadWidthfunctionRead a set width from this frame.
RiftTextfield:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
RiftTextfield:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftTextfield:SetBackgroundColorfunctionSets the background color of this frame.
RiftTextfield:SetCursorfunctionChanges the current position of the cursor.
RiftTextfield:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
RiftTextfield:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftTextfield:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
RiftTextfield:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftTextfield:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
RiftTextfield:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
RiftTextfield:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
RiftTextfield:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
RiftTextfield:SetSelectionfunctionSets the current bounds of the selected text. Call with no arguments to remove the current select...
RiftTextfield:SetStratafunctionSets the strata for this frame.
RiftTextfield:SetTextfunctionSet the current text for this element.
RiftTextfield:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
RiftTextfield:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
RiftWindowA UI element of type RiftWindow or derived from RiftWindow.
RiftWindow.Event:KeyDownSignals a key pressed.
RiftWindow.Event:KeyFocusGainSignals gaining key focus.
RiftWindow.Event:KeyFocusLossSignals losing key focus.
RiftWindow.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftWindow.Event:KeyTypeSignals text typed.
RiftWindow.Event:KeyUpSignals a key released.
RiftWindow.Event:LayerSignals a change in the item's layer.
RiftWindow.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftWindow.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftWindow.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftWindow.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftWindow.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftWindow.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftWindow.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftWindow.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftWindow.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftWindow.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftWindow.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftWindow.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftWindow.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftWindow.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftWindow.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftWindow.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftWindow.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftWindow.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftWindow.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftWindow.Event:MoveSignals that the frame's vertices have moved.
RiftWindow.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftWindow.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftWindow.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftWindow.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftWindow.Event:SizeSignals that the frame's size has changed.
RiftWindow.Event:StrataSignals a change in the item's strata.
RiftWindow.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftWindow.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftWindow:ClearAllfunctionClear all set points and sizes from this frame.
RiftWindow:ClearHeightfunctionClear a set height from this frame.
RiftWindow:ClearPointfunctionClear a set point from this frame.
RiftWindow:ClearWidthfunctionClear a set width from this frame.
RiftWindow:EventAttachfunctionAttaches an event handler to an event.
RiftWindow:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftWindow:EventListfunctionLists the current event handlers for an event.
RiftWindow:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftWindow:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftWindow:GetAlphafunctionGets the alpha multiplier of this frame.
RiftWindow:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftWindow:GetBorderfunctionGets the element representing the window border.
RiftWindow:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftWindow:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftWindow:GetChildrenfunctionReturns a table containing all of this element's children.
RiftWindow:GetContentfunctionGets the element representing the window content area.
RiftWindow:GetControllerfunctionGets the ID of the current controller for this window.
RiftWindow:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftWindow:GetHeightfunctionRetrieves the height of this element.
RiftWindow:GetKeyFocusfunctionGets the key focus status.
RiftWindow:GetLayerfunctionGets the frame's layer order.
RiftWindow:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftWindow:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftWindow:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
RiftWindow:GetNamefunctionRetrieves the name of this element.
RiftWindow:GetOwnerfunctionRetrieves the owner of this element.
RiftWindow:GetParentfunctionGets the parent of this frame.
RiftWindow:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftWindow:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
RiftWindow:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
RiftWindow:GetStrataListfunctionGets a list of valid stratas for this frame.
RiftWindow:GetTitlefunctionGet the current title for this element.
RiftWindow:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftWindow:GetTrimDimensionsfunctionGets the thicknesses of the border's visual trim.
RiftWindow:GetTypefunctionRetrieves the type of this element.
RiftWindow:GetVisiblefunctionGets the visibility flag for this frame.
RiftWindow:GetWidthfunctionRetrieves the width of this element.
RiftWindow:ReadAllfunctionRead all set points and sizes from this frame.
RiftWindow:ReadHeightfunctionRead a set height from this frame.
RiftWindow:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftWindow:ReadWidthfunctionRead a set width from this frame.
RiftWindow:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
RiftWindow:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftWindow:SetBackgroundColorfunctionSets the background color of this frame.
RiftWindow:SetControllerfunctionSets the current controller for this window. The controller will take on the exact dimensions of ...
RiftWindow:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
RiftWindow:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftWindow:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
RiftWindow:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftWindow:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
RiftWindow:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
RiftWindow:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
RiftWindow:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
RiftWindow:SetStratafunctionSets the strata for this frame.
RiftWindow:SetTitlefunctionSet the current title for this element.
RiftWindow:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
RiftWindow:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
RiftWindowBorder.Event:KeyDownSignals a key pressed.
RiftWindowBorder.Event:KeyFocusGainSignals gaining key focus.
RiftWindowBorder.Event:KeyFocusLossSignals losing key focus.
RiftWindowBorder.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftWindowBorder.Event:KeyTypeSignals text typed.
RiftWindowBorder.Event:KeyUpSignals a key released.
RiftWindowBorder.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftWindowBorder.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftWindowBorder.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftWindowBorder.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftWindowBorder.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftWindowBorder.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftWindowBorder.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftWindowBorder.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftWindowBorder.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftWindowBorder.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftWindowBorder.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftWindowBorder.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftWindowBorder.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftWindowBorder.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftWindowBorder.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftWindowBorder.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftWindowBorder.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftWindowBorder.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftWindowBorder.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftWindowBorder.Event:MoveSignals that the frame's vertices have moved.
RiftWindowBorder.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftWindowBorder.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftWindowBorder.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftWindowBorder.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftWindowBorder.Event:SizeSignals that the frame's size has changed.
RiftWindowBorder.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftWindowBorder.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftWindowBorder:EventAttachfunctionAttaches an event handler to an event.
RiftWindowBorder:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftWindowBorder:EventListfunctionLists the current event handlers for an event.
RiftWindowBorder:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftWindowBorder:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftWindowBorder:GetAlphafunctionGets the alpha multiplier of this frame.
RiftWindowBorder:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftWindowBorder:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftWindowBorder:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftWindowBorder:GetChildrenfunctionReturns a table containing all of this element's children.
RiftWindowBorder:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftWindowBorder:GetHeightfunctionRetrieves the height of this element.
RiftWindowBorder:GetKeyFocusfunctionGets the key focus status.
RiftWindowBorder:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftWindowBorder:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftWindowBorder:GetNamefunctionRetrieves the name of this element.
RiftWindowBorder:GetOwnerfunctionRetrieves the owner of this element.
RiftWindowBorder:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftWindowBorder:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftWindowBorder:GetTypefunctionRetrieves the type of this element.
RiftWindowBorder:GetVisiblefunctionGets the visibility flag for this frame.
RiftWindowBorder:GetWidthfunctionRetrieves the width of this element.
RiftWindowBorder:ReadAllfunctionRead all set points and sizes from this frame.
RiftWindowBorder:ReadHeightfunctionRead a set height from this frame.
RiftWindowBorder:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftWindowBorder:ReadWidthfunctionRead a set width from this frame.
RiftWindowBorder:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftWindowBorder:SetBackgroundColorfunctionSets the background color of this frame.
RiftWindowBorder:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftWindowBorder:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftWindowBorder:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
RiftWindowContent.Event:KeyDownSignals a key pressed.
RiftWindowContent.Event:KeyFocusGainSignals gaining key focus.
RiftWindowContent.Event:KeyFocusLossSignals losing key focus.
RiftWindowContent.Event:KeyRepeatFrame.Event:KeyRepeat@summary
RiftWindowContent.Event:KeyTypeSignals text typed.
RiftWindowContent.Event:KeyUpSignals a key released.
RiftWindowContent.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
RiftWindowContent.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
RiftWindowContent.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
RiftWindowContent.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
RiftWindowContent.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
RiftWindowContent.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
RiftWindowContent.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
RiftWindowContent.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
RiftWindowContent.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
RiftWindowContent.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
RiftWindowContent.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
RiftWindowContent.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
RiftWindowContent.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
RiftWindowContent.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
RiftWindowContent.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
RiftWindowContent.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
RiftWindowContent.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
RiftWindowContent.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
RiftWindowContent.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
RiftWindowContent.Event:MoveSignals that the frame's vertices have moved.
RiftWindowContent.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
RiftWindowContent.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
RiftWindowContent.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
RiftWindowContent.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
RiftWindowContent.Event:SizeSignals that the frame's size has changed.
RiftWindowContent.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
RiftWindowContent.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
RiftWindowContent:EventAttachfunctionAttaches an event handler to an event.
RiftWindowContent:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
RiftWindowContent:EventListfunctionLists the current event handlers for an event.
RiftWindowContent:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
RiftWindowContent:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
RiftWindowContent:GetAlphafunctionGets the alpha multiplier of this frame.
RiftWindowContent:GetBackgroundColorfunctionRetrieves the background color of this frame.
RiftWindowContent:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
RiftWindowContent:GetBoundsfunctionRetrieves the complete bounds of this element.
RiftWindowContent:GetChildrenfunctionReturns a table containing all of this element's children.
RiftWindowContent:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
RiftWindowContent:GetHeightfunctionRetrieves the height of this element.
RiftWindowContent:GetKeyFocusfunctionGets the key focus status.
RiftWindowContent:GetLeftfunctionRetrieves the X position of the left edge of this element.
RiftWindowContent:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
RiftWindowContent:GetNamefunctionRetrieves the name of this element.
RiftWindowContent:GetOwnerfunctionRetrieves the owner of this element.
RiftWindowContent:GetRightfunctionRetrieves the X position of the right edge of this element.
RiftWindowContent:GetTopfunctionRetrieves the Y position of the top edge of this element.
RiftWindowContent:GetTypefunctionRetrieves the type of this element.
RiftWindowContent:GetVisiblefunctionGets the visibility flag for this frame.
RiftWindowContent:GetWidthfunctionRetrieves the width of this element.
RiftWindowContent:ReadAllfunctionRead all set points and sizes from this frame.
RiftWindowContent:ReadHeightfunctionRead a set height from this frame.
RiftWindowContent:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
RiftWindowContent:ReadWidthfunctionRead a set width from this frame.
RiftWindowContent:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
RiftWindowContent:SetBackgroundColorfunctionSets the background color of this frame.
RiftWindowContent:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
RiftWindowContent:SetMouseMaskingfunctionSets the frame's mouse masking mode.
RiftWindowContent:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
TextA UI element of type Text or derived from Text.
Text.Event:KeyDownSignals a key pressed.
Text.Event:KeyFocusGainSignals gaining key focus.
Text.Event:KeyFocusLossSignals losing key focus.
Text.Event:KeyRepeatFrame.Event:KeyRepeat@summary
Text.Event:KeyTypeSignals text typed.
Text.Event:KeyUpSignals a key released.
Text.Event:LayerSignals a change in the item's layer.
Text.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
Text.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
Text.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
Text.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
Text.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
Text.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
Text.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
Text.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
Text.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
Text.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
Text.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
Text.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
Text.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
Text.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
Text.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
Text.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
Text.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
Text.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
Text.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
Text.Event:MoveSignals that the frame's vertices have moved.
Text.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
Text.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
Text.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
Text.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
Text.Event:SizeSignals that the frame's size has changed.
Text.Event:StrataSignals a change in the item's strata.
Text.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
Text.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
Text:ClearAllfunctionClear all set points and sizes from this frame.
Text:ClearHeightfunctionClear a set height from this frame.
Text:ClearPointfunctionClear a set point from this frame.
Text:ClearWidthfunctionClear a set width from this frame.
Text:EventAttachfunctionAttaches an event handler to an event.
Text:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Text:EventListfunctionLists the current event handlers for an event.
Text:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
Text:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
Text:GetAlphafunctionGets the alpha multiplier of this frame.
Text:GetBackgroundColorfunctionRetrieves the background color of this frame.
Text:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
Text:GetBoundsfunctionRetrieves the complete bounds of this element.
Text:GetChildrenfunctionReturns a table containing all of this element's children.
Text:GetEffectBlurfunctionGets the current parameters for the Blur effect.
Text:GetEffectGlowfunctionGets the current parameters for the Glow effect.
Text:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
Text:GetFontfunctionGets the current font used for this element.
Text:GetFontColorfunctionGets the current font color for this element.
Text:GetFontSizefunctionGets the font size of the current element.
Text:GetHeightfunctionRetrieves the height of this element.
Text:GetKeyFocusfunctionGets the key focus status.
Text:GetLayerfunctionGets the frame's layer order.
Text:GetLeftfunctionRetrieves the X position of the left edge of this element.
Text:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
Text:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
Text:GetNamefunctionRetrieves the name of this element.
Text:GetOwnerfunctionRetrieves the owner of this element.
Text:GetParentfunctionGets the parent of this frame.
Text:GetRightfunctionRetrieves the X position of the right edge of this element.
Text:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
Text:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
Text:GetStrataListfunctionGets a list of valid stratas for this frame.
Text:GetTextfunctionGet the current text for this element.
Text:GetTopfunctionRetrieves the Y position of the top edge of this element.
Text:GetTypefunctionRetrieves the type of this element.
Text:GetVisiblefunctionGets the visibility flag for this frame.
Text:GetWidthfunctionRetrieves the width of this element.
Text:GetWordwrapfunctionGets the wordwrap flag for this element.
Text:ReadAllfunctionRead all set points and sizes from this frame.
Text:ReadHeightfunctionRead a set height from this frame.
Text:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
Text:ReadWidthfunctionRead a set width from this frame.
Text:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
Text:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
Text:SetBackgroundColorfunctionSets the background color of this frame.
Text:SetEffectBlurfunctionSets the parameters for the Blur effect.
Text:SetEffectGlowfunctionSets the parameters for the Glow effect.
Text:SetFontfunctionSets the current font used for this element.
Text:SetFontColorfunctionSets the current font color for this element.
Text:SetFontSizefunctionSets the current font size of this element.
Text:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
Text:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
Text:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
Text:SetMouseMaskingfunctionSets the frame's mouse masking mode.
Text:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
Text:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
Text:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
Text:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
Text:SetStratafunctionSets the strata for this frame.
Text:SetTextfunctionSets the current text for this element.
Text:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
Text:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
Text:SetWordwrapfunctionSets the wordwrap flag for this element.
TextureA UI element of type Texture or derived from Texture.
Texture.Event:KeyDownSignals a key pressed.
Texture.Event:KeyFocusGainSignals gaining key focus.
Texture.Event:KeyFocusLossSignals losing key focus.
Texture.Event:KeyRepeatFrame.Event:KeyRepeat@summary
Texture.Event:KeyTypeSignals text typed.
Texture.Event:KeyUpSignals a key released.
Texture.Event:LayerSignals a change in the item's layer.
Texture.Event:LeftClickSignals that the mouse's left button has been clicked inside the frame. Blocks left mouse events ...
Texture.Event:LeftDownSignals that the mouse's left button has been pressed inside the frame. Blocks left mouse events ...
Texture.Event:LeftUpSignals that the mouse's left button has been released inside the frame. Blocks left mouse events...
Texture.Event:LeftUpoutsideSignals that the mouse's left button has been released outside the frame, after a "Down" message....
Texture.Event:MiddleClickSignals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse eve...
Texture.Event:MiddleDownSignals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse eve...
Texture.Event:MiddleUpSignals that the mouse's middle button has been released inside the frame. Blocks middle mouse ev...
Texture.Event:MiddleUpoutsideSignals that the mouse's middle button has been released outside the frame, after a "Down" messag...
Texture.Event:Mouse4ClickSignals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mo...
Texture.Event:Mouse4DownSignals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mo...
Texture.Event:Mouse4UpSignals that the mouse's fourth button has been released inside the frame. Blocks fourth button m...
Texture.Event:Mouse4UpoutsideSignals that the mouse's fourth button has been released outside the frame, after a "Down" messag...
Texture.Event:Mouse5ClickSignals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mous...
Texture.Event:Mouse5DownSignals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mous...
Texture.Event:Mouse5UpSignals that the mouse's fifth button has been released inside the frame. Blocks fifth button mou...
Texture.Event:Mouse5UpoutsideSignals that the mouse's fifth button has been released outside the frame, after a "Down" message...
Texture.Event:MouseInSignals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from fr...
Texture.Event:MouseMoveSignals that the mouse cursor has been moved within the frame. Blocks mouse movement events from ...
Texture.Event:MouseOutSignals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from ...
Texture.Event:MoveSignals that the frame's vertices have moved.
Texture.Event:RightClickSignals that the mouse's right button has been clicked inside the frame. Blocks right mouse event...
Texture.Event:RightDownSignals that the mouse's right button has been pressed inside the frame. Blocks right mouse event...
Texture.Event:RightUpSignals that the mouse's right button has been released inside the frame. Blocks right mouse even...
Texture.Event:RightUpoutsideSignals that the mouse's right button has been released outside the frame, after a "Down" message...
Texture.Event:SizeSignals that the frame's size has changed.
Texture.Event:StrataSignals a change in the item's strata.
Texture.Event:WheelBackSignals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events fr...
Texture.Event:WheelForwardSignals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events fro...
Texture:ClearAllfunctionClear all set points and sizes from this frame.
Texture:ClearHeightfunctionClear a set height from this frame.
Texture:ClearPointfunctionClear a set point from this frame.
Texture:ClearWidthfunctionClear a set width from this frame.
Texture:EventAttachfunctionAttaches an event handler to an event.
Texture:EventDetachfunctionDetaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a...
Texture:EventListfunctionLists the current event handlers for an event.
Texture:EventMacroGetfunctionGets the macro that will be triggered when this event occurs.
Texture:EventMacroSetfunctionSets the macro that will be triggered when this event occurs.
Texture:GetAlphafunctionGets the alpha multiplier of this frame.
Texture:GetBackgroundColorfunctionRetrieves the background color of this frame.
Texture:GetBottomfunctionRetrieves the Y position of the bottom edge of this element.
Texture:GetBoundsfunctionRetrieves the complete bounds of this element.
Texture:GetChildrenfunctionReturns a table containing all of this element's children.
Texture:GetEventTablefunctionRetrieves the event table of this element. By default, this value is also stored in "this.Event".
Texture:GetHeightfunctionRetrieves the height of this element.
Texture:GetKeyFocusfunctionGets the key focus status.
Texture:GetLayerfunctionGets the frame's layer order.
Texture:GetLeftfunctionRetrieves the X position of the left edge of this element.
Texture:GetMouseMaskingfunctionGet the current mouse masking mode. See SetMouseMasking for details.
Texture:GetMouseoverUnitfunctionGets the unit that is being represented by this frame.
Texture:GetNamefunctionRetrieves the name of this element.
Texture:GetOwnerfunctionRetrieves the owner of this element.
Texture:GetParentfunctionGets the parent of this frame.
Texture:GetRightfunctionRetrieves the X position of the right edge of this element.
Texture:GetSecureModefunctionGet the current secure mode. See SetSecureMode for details.
Texture:GetStratafunctionGets the frame's strata. The strata determines render order on a coarser level than Layer does, a...
Texture:GetStrataListfunctionGets a list of valid stratas for this frame.
Texture:GetTexturefunctionGets the current texture used for this element.
Texture:GetTextureHeightfunctionReturns the actual pixel height of the current texture.
Texture:GetTextureWidthfunctionReturns the actual pixel width of the current texture.
Texture:GetTopfunctionRetrieves the Y position of the top edge of this element.
Texture:GetTypefunctionRetrieves the type of this element.
Texture:GetVisiblefunctionGets the visibility flag for this frame.
Texture:GetWidthfunctionRetrieves the width of this element.
Texture:ReadAllfunctionRead all set points and sizes from this frame.
Texture:ReadHeightfunctionRead a set height from this frame.
Texture:ReadPointfunctionRead a set point from this frame. Must be given a single-axis coordinate.
Texture:ReadWidthfunctionRead a set width from this frame.
Texture:SetAllPointsfunctionPins all the edges of this frame to the edges of a different frame. If no target is given, defaul...
Texture:SetAlphafunctionSets the alpha transparency multiplier for this frame and its children.
Texture:SetBackgroundColorfunctionSets the background color of this frame.
Texture:SetHeightfunctionSets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
Texture:SetKeyFocusfunctionSets the key focus status. Note that only one frame can be the key focus at a time. Focusing on a...
Texture:SetLayerfunctionSets the frame layer for this frame. This can be any number. Frames are drawn in ascending order....
Texture:SetMouseMaskingfunctionSets the frame's mouse masking mode.
Texture:SetMouseoverUnitfunctionSets the unit that will be represented by this frame.
Texture:SetParentfunctionSets the parent of this frame. Circular dependencies result in undefined behavior. If this frame'...
Texture:SetPointfunctionPins a point on this frame to a location on another frame. This is a rather complex function and ...
Texture:SetSecureModefunctionSets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to ...
Texture:SetStratafunctionSets the strata for this frame.
Texture:SetTexturefunctionSets the current texture used for this element.
Texture:SetVisiblefunctionSets the frame's visibility flag. If set to false, then this frame and all its children will not ...
Texture:SetWidthfunctionSets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
UI.ContextLists all contexts that have been created. Organizes them under [addonIdentifier][contextIdentifi...
UI.CreateContextfunctionCreates a new UI context. A UI context must be created in order to create any frames.
UI.CreateFramefunctionCreates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames m...
UI.FrameLists all frames that have been created. Organizes them under [addonIdentifier][contextIdentifier...
UI.Native.AbilityThe Ability dialog.
UI.Native.AccoladeThe Warfront accolade HUD.
UI.Native.AchievementThe Achievement dialog.
UI.Native.AchievementPopupThe "Achievement Complete" popup.
UI.Native.AdventureThe Instant Adventure dialog.
UI.Native.AscendThe Ascend-a-Friend dialog.
UI.Native.AttunementThe Planar Attunement dialog.
UI.Native.AuctionThe Auction dialog.
UI.Native.BagThe bag and currency HUD.
UI.Native.BagBank1The first bank inventory bag.
UI.Native.BagBank2The second bank inventory bag.
UI.Native.BagBank3The third bank inventory bag.
UI.Native.BagBank4The fourth bank inventory bag.
UI.Native.BagBank5The fifth bank inventory bag.
UI.Native.BagBank6The sixth bank inventory bag.
UI.Native.BagBank7The seventh bank inventory bag.
UI.Native.BagBank8The eighth bank inventory bag.
UI.Native.BagInventory1The first main inventory bag.
UI.Native.BagInventory2The second main inventory bag.
UI.Native.BagInventory3The third main inventory bag.
UI.Native.BagInventory4The fourth main inventory bag.
UI.Native.BagInventory5The fifth main inventory bag.
UI.Native.BagInventory6The sixth main inventory bag.
UI.Native.BagInventory7The seventh main inventory bag.
UI.Native.BagInventory8The eighth main inventory bag.
UI.Native.BankThe Bank dialog.
UI.Native.BankGuildThe Guild Bank dialog.
UI.Native.BarBottom1The first extra bottom action bar.
UI.Native.BarBottom2The second extra bottom action bar.
UI.Native.BarBottom3The third extra bottom action bar.
UI.Native.BarBottom4The fourth extra bottom action bar.
UI.Native.BarBottom5The fifth extra bottom action bar.
UI.Native.BarBottom6The sixth extra bottom action bar.
UI.Native.BarMainThe main action bar.
UI.Native.BarPetThe pet action bar.
UI.Native.BarSide1The first extra side action bar.
UI.Native.BarSide2The second extra side action bar.
UI.Native.BarSide3The third extra side action bar.
UI.Native.BarSide4The fourth extra side action bar.
UI.Native.BarTemporaryThe action bar used for temporary abilities.
UI.Native.BreathThe breath/fatigue bar.
UI.Native.BuffbarThe player's buff bar.
UI.Native.CastbarThe player's cast bar.
UI.Native.CharacterThe Character dialog.
UI.Native.ChronicleThe Chronicles dialog.
UI.Native.CoinlockThe Coin Lock button.
UI.Native.Console1The first console window.
UI.Native.Console2The second console window.
UI.Native.Console3The third console window.
UI.Native.Console4The fourth console window.
UI.Native.Console5The fifth console window.
UI.Native.Console6The sixth console window.
UI.Native.Console7The seventh console window.
UI.Native.ConsoleSettingThe console settings dialog.
UI.Native.CraftingThe Crafting dialog.
UI.Native.CtfThe Capture-the-Flag status indicator.
UI.Native.GuestThe guest invite dialog for weddings.
UI.Native.GuildThe Guild dialog.
UI.Native.GuildCharterThe Guild Charter dialog.
UI.Native.GuildFinderThe Guild Finder dialog.
UI.Native.ImportThe Import dialog, as reached from the escape menu.
UI.Native.KeybindThe Keybind dialog.
UI.Native.LayoutThe UI Layout dialog.
UI.Native.LeaderboardThe Leaderboard dialog.
UI.Native.LfgThe Looking-for-Group dialog.
UI.Native.LootThe Loot dialog.
UI.Native.MacroThe Macro dialog.
UI.Native.MacroIconThe Macro icons list.
UI.Native.MacroSlashThe Macro slash commands list.
UI.Native.MailThe Mail dialog.
UI.Native.MailReadThe currently-being-read Mail dialog.
UI.Native.MapMainThe main map.
UI.Native.MapMiniThe minimap.
UI.Native.MechanicPlayerThe player-focused class-specific-mechanic HUD element.
UI.Native.MechanicTargetThe target-focused class-specific-mechanic HUD element.
UI.Native.MentorThe Mentoring popup.
UI.Native.MenuThe main menu HUD element.
UI.Native.MessageEventThe event-related message popup.
UI.Native.MessageStandardThe generic message popup.
UI.Native.MessageTextThe generic text popup.
UI.Native.MessageWarfrontThe warfront-related message popup.
UI.Native.MessageZoneThe zone-related message popup.
UI.Native.NotificationThe notification message popup.
UI.Native.NotifyThe public-group/return-to-graveyard popup button.
UI.Native.PortraitFocusThe portrait of your focus target.
UI.Native.PortraitParty1The portrait of your first partymember.
UI.Native.PortraitParty1PetThe portrait of your first partymember's pet.
UI.Native.PortraitParty2The portrait of your second partymember.
UI.Native.PortraitParty2PetThe portrait of your second partymember's pet.
UI.Native.PortraitParty3The portrait of your third partymember.
UI.Native.PortraitParty3PetThe portrait of your third partymember's pet.
UI.Native.PortraitParty4The portrait of your fourth partymember.
UI.Native.PortraitParty4PetThe portrait of your fourth partymember's pet.
UI.Native.PortraitPetThe portrait of your pet.
UI.Native.PortraitPlayerYour portrait.
UI.Native.PortraitTargetThe portrait of your target.
UI.Native.PortraitTargetTargetThe portrait of your target's target.
UI.Native.QuestThe Quest dialog.
UI.Native.QuestStickiesThe Quest sticky HUD.
UI.Native.QuestionThe general-purpose question popup.
UI.Native.RaidThe Raid dialog.
UI.Native.RaidGroup1The raid frame for your raid's first group.
UI.Native.RaidGroup1PetThe raid frame for your raid's first group's pets.
UI.Native.RaidGroup2The raid frame for your raid's second group.
UI.Native.RaidGroup2PetThe raid frame for your raid's second group's pets.
UI.Native.RaidGroup3The raid frame for your raid's third group.
UI.Native.RaidGroup3PetThe raid frame for your raid's third group's pets.
UI.Native.RaidGroup4The raid frame for your raid's fourth group.
UI.Native.RaidGroup4PetThe raid frame for your raid's fourth group's pets.
UI.Native.RaidPartyThe raid frame used for displaying your party as a raid.
UI.Native.RaidPartyPetThe raid frame used for displaying your party's pets as a raid.
UI.Native.ReactiveThe reactive-ability popup.
UI.Native.RecallThe set-recall-point dialog.
UI.Native.RespecThe respec dialog.
UI.Native.RiftThe Rift meter HUD.
UI.Native.Roll1The first loot-roll popup.
UI.Native.Roll2The second loot-roll popup.
UI.Native.Roll3The third loot-roll popup.
UI.Native.Roll4The fourth loot-roll popup.
UI.Native.SettingThe Settings dialog.
UI.Native.SocialThe Social dialog.
UI.Native.SoulThe Soul Tree dialog.
UI.Native.SplitThe stack split popup.
UI.Native.StreamingThe icon that indicates your current streaming download status.
UI.Native.TicketThe Customer Service Ticket dialog.
UI.Native.TipThe Game Tip dialog.
UI.Native.TipAlertThe Game Tip notification popup.
UI.Native.TooltipThe tooltip.
UI.Native.TooltipAnchorThe location that tooltips are anchored to by default.
UI.Native.TradeThe Trade dialog.
UI.Native.TrayThe icon tray used for the clock, mail notification, and similar elements.
UI.Native.TraySocialThe icon tray used for social notifications.
UI.Native.TreasureThe Treasure popup used to claim dungeon loot.
UI.Native.TrialThe Trial dialog.
UI.Native.UpgradeThe Upgrade portrait, used for targets that are upgradeable.
UI.Native.WarfrontThe Warfront dialog.
UI.Native.WarfrontLeaderboardThe Warfront Leaderboard dialog.
UI.Native.WorldThe World Event dialog.
Utility.Auction.CostfunctiondeprecatedReturns the amount of silver it will cost to post a given auction.
Utility.Auction.CostOrderfunctionReturns the amount of silver it will cost to post a given order.
Utility.Auction.CostPostfunctionReturns the amount of silver it will cost to post a given auction.
Utility.DispatchfunctionCalls a function, crediting that function's execution and errors to a specific addon. Errors will...
Utility.Event.CreatefunctionCreates a custom event. Takes an identifier and an event path as parameters. Called with Create("...
Utility.Item.Slot.AllfunctionGenerates a slot specifier for all known items.
Utility.Item.Slot.BankfunctionGenerates a slot specifier for the player's bank.
Utility.Item.Slot.EquipmentfunctionGenerates a slot specifier for the player's equipment.
Utility.Item.Slot.GuildfunctionGenerates a slot specifier for the player's guild bank.
Utility.Item.Slot.InventoryfunctionGenerates a slot specifier for the player's inventory.
Utility.Item.Slot.ParsefunctionParses a slot specifier, returning information on what it represents.
Utility.Item.Slot.QuestfunctionGenerates a slot specifier for the player's quest bag.
Utility.Item.Slot.VaultfunctionGenerates a slot specifier for the player's bank vaults.
Utility.Item.Slot.WardrobefunctionGenerates a slot specifier for the player's wardrobe.
Utility.Mail.CostfunctionReturns the amount of silver it will cost to send a given mail.
Utility.Matrix.CreatefunctionCreates a transformation matrix table. These can also be created by hand; this is simply a conven...
Utility.Message.LimitsfunctionReturns information on the message bandwidth limits.
Utility.Message.SizefunctionReturns the size of a message, as used for bandwidth control.
Utility.Serialize.FullfunctionSerializes a table of parameters. Results in a string suitable for feeding directly into loadstri...
Utility.Serialize.InlinefunctionSerializes a single parameter. Results in a string suitable for use as a parameter in Lua code. I...
Utility.Storage.ChecksumfunctionCalculates the storage checksum of a string.
Utility.Storage.LimitsfunctionReturns information on the storage bandwidth limits.
Utility.Storage.SizefunctionReturns the size of a stored element, as used for storage quota and bandwidth control.
Utility.TypefunctionDetermines the type of a given item. Understands Rift-specific identifiers.
Utility.Unit.AvailabilityfunctionReturns information on which detail members are available in which availability mode.
abilityAn ability, represented by a standard identifier with an 'a' prefix.
achievementAn achievement, represented by a standard identifier with a 'c' prefix.
achievementcategoryAn achievement category, represented by a standard identifier with a 'C' prefix.
auctionAn auction, represented by a standard identifier with an 'o' prefix.
booleanA value of type 'boolean'.
buffA buff, represented by a standard identifier with a 'b' prefix.
callbackfunctionA callback function, used to signal success or failure. Must be a function that takes two paramet...
consoleA text console, represented by a standard ID with a 'v' prefix.
currencycategoryA currency category, represented by a standard identifier with a 'N' prefix.
dimensionitemA dimension item, represented by a standard identifier with a 'd' prefix.
dumpfunctionDebug utility function. Similar to print(), but serializes any table parameters before outputting.
errorAn error, represented by a standard ID with an 'x' prefix.
eventFrameA frame event handle.
eventGlobalA global event handle.
factionA faction, represented by a standard ID with an 'f' prefix.
frameEventTableA frame event table of a UI element.
functionA value of type 'function'.
function/nilA value of type "function" or "nil".
function/stringA value of type "function" or "string".
function/string/nilA value of type "function", "string", or "nil".
guildrankA guild rank, represented by a standard identifier with a 'k' prefix.
guildwallA guild wall ID, represented by a standard identifier with a 'w' prefix.
handleEventFrameA handle for active frame events. Includes the member :GetTarget(), which returns the target fram...
handleEventGlobalA handle for active global events. Currently contains no members.
itemAn item, represented by either a standard identifier with an 'i' prefix or a slot.
itemtypeAn item type, represented by a nonstandard identifier with an 'I' prefix.
locationA map location, represented by a nonstandard identifier with an 'l' prefix.
mailA mail, represented by a standard identifier with an 'm' prefix.
minionadventureA minion adventure, represented by a standard identifier with a 'mn.adv.' prefix.
minionminionA minion, represented by a standard identifier with a 'mn.mn.' prefix.
nilA value of type 'nil'.
numberA value of type 'number'. May not be NaN.
number/nilA value of type 'number' or 'nil'. May not be NaN.
questA quest, represented by a standard identifier with a 'q' prefix.
roleA role, represented by a standard identifier with a "h" prefix.
slotAn item slot, represented by a nonstandard identifier with an 's' prefix, as generated by the Uti...
stringA value of type 'string'.
string/nilA value of type 'string' or 'nil'.
tableA value of type 'table'.
titleA title, represented by a standard identifier with a 't' prefix.
titlecategoryA title category, represented by a standard identifier with a 'T' prefix.
unitA unit, represented by either a standard identifier with a 'u' prefix or by a unit specifier. Uni...
variantA value of any type.
zoneA zone, represented by a standard identifier with a 'z' prefix.

Canvas

A UI element of type Canvas or derived from Canvas.

Canvas.Event:KeyDown

Signals a key pressed.

Usage:

Frame.Event:KeyDown(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Canvas.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

Canvas.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

Canvas.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Frame.Event:KeyRepeat(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Canvas.Event:KeyType

Signals text typed.

Usage:

Frame.Event:KeyType(typed)
ParameterTypeDatatypeDescription
typedparametervariantThe text.

Canvas.Event:KeyUp

Signals a key released.

Usage:

Frame.Event:KeyUp(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Canvas.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

Canvas.Event:LeftClick

Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftClick()

Canvas.Event:LeftDown

Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftDown()

Canvas.Event:LeftUp

Signals that the mouse's left button has been released inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUp()

Canvas.Event:LeftUpoutside

Signals that the mouse's left button has been released outside the frame, after a "Down" message. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUpoutside()

Canvas.Event:MiddleClick

Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleClick()

Canvas.Event:MiddleDown

Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleDown()

Canvas.Event:MiddleUp

Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUp()

Canvas.Event:MiddleUpoutside

Signals that the mouse's middle button has been released outside the frame, after a "Down" message. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUpoutside()

Canvas.Event:Mouse4Click

Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Click()

Canvas.Event:Mouse4Down

Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Down()

Canvas.Event:Mouse4Up

Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Up()

Canvas.Event:Mouse4Upoutside

Signals that the mouse's fourth button has been released outside the frame, after a "Down" message. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Upoutside()

Canvas.Event:Mouse5Click

Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Click()

Canvas.Event:Mouse5Down

Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Down()

Canvas.Event:Mouse5Up

Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Up()

Canvas.Event:Mouse5Upoutside

Signals that the mouse's fifth button has been released outside the frame, after a "Down" message. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Upoutside()

Canvas.Event:MouseIn

Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseIn()

Canvas.Event:MouseMove

Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseMove(x, y)
ParameterTypeDatatypeDescription
xparametervariantX coordinate.
yparameter<nope>Y coordinate.

Canvas.Event:MouseOut

Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseOut()

Canvas.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

Canvas.Event:RightClick

Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightClick()

Canvas.Event:RightDown

Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightDown()

Canvas.Event:RightUp

Signals that the mouse's right button has been released inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUp()

Canvas.Event:RightUpoutside

Signals that the mouse's right button has been released outside the frame, after a "Down" message. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUpoutside()

Canvas.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

Canvas.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

Canvas.Event:WheelBack

Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelBack()

Canvas.Event:WheelForward

Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelForward()

Canvas:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()
noSecureFrameAndEnvironment
true

Canvas:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()
noSecureFrameAndEnvironment
true

Canvas:ClearPoint

Clear a set point from this frame.

Usage:

Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate.
xparameternumber/nilX coordinate of the point.
yparameternumber/nilY coordinate of the point.
noSecureFrameAndEnvironment
true

Canvas:ClearWidth

Clear a set width from this frame.

Usage:

Frame:ClearWidth()
noSecureFrameAndEnvironment
true

Canvas:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

Canvas:EventDetach

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.

Usage:

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

Canvas:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro The macro that will run when the event fires.
owner Owner to search for.
priority Priority of the event handler. Higher numbers trigger first.

Canvas:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

Canvas:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

Canvas:GetAlpha

Gets the alpha multiplier of this frame.

Usage:

alpha = Element:GetAlpha()
ParameterTypeDatatypeDescription
alpharesultnumberThe alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.

Canvas:GetBackgroundColor

Retrieves the background color of this frame.

Usage:

r, g, b, a = Element:GetBackgroundColor()
ParameterTypeDatatypeDescription
aresultnumberAlpha. 1 is fully opaque, 0 is fully transparent.
bresultnumberBlue.
gresultnumberGreen.
rresultnumberRed.

Canvas:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

Canvas:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

Canvas:GetChildren

Returns a table containing all of this element's children.

Usage:

children = Element:GetChildren()
ParameterTypeDatatypeDescription
childrenresulttableA table containing this element's children.

Canvas:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

Canvas:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

Canvas:GetKeyFocus

Gets the key focus status.

Usage:

focus = Element:GetKeyFocus()
ParameterTypeDatatypeDescription
focusresultbooleanWhether this frame is the current key focus.

Canvas:GetLayer

Gets the frame's layer order.

Usage:

layer = Frame:GetLayer()
ParameterTypeDatatypeDescription
layerresultnumberThe render layer of this frame. See Frame:SetLayer for details.

Canvas:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

Canvas:GetMouseMasking

Get the current mouse masking mode. See SetMouseMasking for details.

Usage:

mask = Element:GetMouseMasking()
ParameterTypeDatatypeDescription
maskresultstringThe current mouse masking mode.

Canvas:GetMouseoverUnit

Gets the unit that is being represented by this frame.

Usage:

unit = Frame:GetMouseoverUnit()
ParameterTypeDatatypeDescription
unitresultstringThe current mouseover unit. May be nil if there is no mouseover unit.

Canvas:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

Canvas:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

Canvas:GetParent

Gets the parent of this frame.

Usage:

parent = Frame:GetParent()
ParameterTypeDatatypeDescription
parentresultElementThe parent element of this frame.

Canvas:GetRight

Retrieves the X position of the right edge of this element.

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

Canvas:GetSecureMode

Get the current secure mode. See SetSecureMode for details.

Usage:

secure = Frame:GetSecureMode()
ParameterTypeDatatypeDescription
secureresultstringThe current secure mode.

Canvas:GetShape

Returns the current canvas shape.

Usage:

shape, fill, stroke = Canvas:GetShape()
ParameterTypeDatatypeDescription
fillresulttableThe current fill style. See Canvas:SetShape() for details.
shaperesulttableThe current shape. See Canvas:SetShape() for details.
strokeresulttableThe current stroke style. See Canvas:SetShape() for details.

Canvas:GetStrata

Gets the frame's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.

Usage:

strata = Frame:GetStrata()
ParameterTypeDatatypeDescription
strataresultstringThe item's current strata.

Canvas:GetStrataList

Gets a list of valid stratas for this frame.

Usage:

stratas = Frame:GetStrataList()
ParameterTypeDatatypeDescription
stratasresulttableAn array of valid stratas, in order.

Canvas:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

Canvas:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

Canvas:GetVisible

Gets the visibility flag for this frame.

Usage:

visible = Element:GetVisible()
ParameterTypeDatatypeDescription
visibleresultbooleanThis frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.

Canvas:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

Canvas:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

Canvas:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

Canvas:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

Canvas:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

Canvas:SetAllPoints

Pins all the edges of this frame to the edges of a different frame. If no target is given, defaults to this frame's parent.

Usage:

Frame:SetAllPoints()
Frame:SetAllPoints(target)
ParameterTypeDatatypeDescription
targetparameterLayoutTarget Layout to pin this frame's edges to.
noSecureFrameAndEnvironment
true

Canvas:SetAlpha

Sets the alpha transparency multiplier for this frame and its children.

Usage:

Element:SetAlpha(alpha)
ParameterTypeDatatypeDescription
alphaparameternumberThe new alpha multiplier. 1 is fully opaque, 0 is fully transparent.

Canvas:SetBackgroundColor

Sets the background color of this frame.

Usage:

Element:SetBackgroundColor(r, g, b)
Element:SetBackgroundColor(r, g, b, a)
ParameterTypeDatatypeDescription
aparameternumberAlpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
bparameternumberBlue.
gparameternumberGreen.
rparameternumberRed.

Canvas:SetHeight

Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.

Usage:

Frame:SetHeight(height)
ParameterTypeDatatypeDescription
heightparameternumberThe new height of this frame.
noSecureFrameAndEnvironment
true

Canvas:SetKeyFocus

Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on another frame will automatically unset the current focus.

Usage:

Element:SetKeyFocus(focus)
ParameterTypeDatatypeDescription
focusparameterbooleanThe new key focus setting.

Canvas:SetLayer

Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but guarantees no Z-fighting. Frames are always drawn after their parents.

Usage:

Frame:SetLayer(layer)
ParameterTypeDatatypeDescription
layerparameternumberThe new layer for this frame.
noSecureFrameAndEnvironment
true

Canvas:SetMouseMasking

Sets the frame's mouse masking mode.

Usage:

Element:SetMouseMasking(mask)
ParameterTypeDatatypeDescription
maskparameterstringThe new mouse masking mode. "full" is the standard mode, and means that creating any Left, Right, or movement-related mouse event will cause the frame to accept and consume any event from any of those types. "limited" causes the frame to accept and consume only events for buttons that have been hooked, so that hooking "LeftDown" will still pass Right mouse events through the frame. Note that hooking any mouse event will still consume MouseMove/In/Out events.
noSecureFrameAndEnvironment
true

Canvas:SetMouseoverUnit

Sets the unit that will be represented by this frame.

Usage:

Frame:SetMouseoverUnit(unit)
ParameterTypeDatatypeDescription
unitparameternil, unitThe new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
requireSecureFrameAndInsecureEnvironment
true

Canvas:SetParent

Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame's secure mode is "restricted", then its parent must also have a secure mode of "restricted".

Usage:

Frame:SetParent(parent)
ParameterTypeDatatypeDescription
parentparameterElementThe new parent for this frame.
noSecureFrameAndEnvironment
true

Canvas:SetPoint

Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it.
This function can take many different forms. In general, it looks like this: SetPoint(point_on_this_frame, target_frame, point_on_target_frame [, x_offset, y_offset]).
The first part is the point on this frame that will be attached. Usually, these are string identifiers. "TOPLEFT", "TOPCENTER", "TOPRIGHT", "CENTERLEFT", "CENTER", "CENTERRIGHT", "BOTTOMLEFT", "BOTTOMCENTER", "BOTTOMRIGHT". You may also use a string identifier that refers to a single axis - "TOP", "BOTTOM", "LEFT", "RIGHT", "CENTERX", "CENTERY". If you want more direct numeric control you can use number pairs. 0,0 is equivalent to "TOPLEFT", 1,1 is equivalent to "BOTTOMRIGHT", 0.5,nil is equivalent to "CENTERX".
The second part is the frame to attach to, as well as the point on that frame to attach to. The frame is simply passing in the frame table. The point is the same identifier or number pair as the first parameter.
Optionally, you may include an X or Y offset to the point.
This connection is permanent, and if the target frame moves, this frame will move along with it.
Caveat: If the target is a frame set to the "restricted" SecureMode, and the client is currently in "secure" mode, then unexpected behavior may occur.

Usage:

Frame:SetPoint(...)
ParameterTypeDatatypeDescription
...parameter...This function's parameters are complicated. Read the above summary for details.
noSecureFrameAndEnvironment
true

Canvas:SetSecureMode

Sets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
If you are not planning to use any restricted functions, your frame should remain in normal mode.
At the moment, it is not possible to change from "restricted" back to "normal".

Usage:

Frame:SetSecureMode(secure)
ParameterTypeDatatypeDescription
secureparameterstringThe new secure mode. Valid inputs are "normal" and "restricted".

Canvas:SetShape

Sets the canvas shape. Must have at least one of "fill" or "stroke".

Usage:

Canvas:SetShape(path, fill, stroke)
ParameterTypeDatatypeDescription
fillparametertable, nilA fill style. By default, "gradientLinear" spreads on the X axis, between 0 and 100. "gradientRadial" is centered around the local origin, with a radius of 100 units. "texture" starts at the origin and extends out to the texture size. Members:
type: One of "solid", "gradientLinear", "gradientRadial", "texture". Required.
r: Red color value, betwen 0 and 1. Available and required for "solid".
g: Green color value, betwen 0 and 1. Available and required for "solid".
b: Blue color value, betwen 0 and 1. Available and required for "solid".
a: Alpha color value, betwen 0 and 1. Defaults to 1. Available for "solid".
color: Gradient color values. A table containing a series of tables, with consecutive integer keys starting from 1. Each internal table contains color values and a gradient position. Available and required for "gradientLinear" and "gradientRadial". Members:
r: Red color value, between 0 and 1. Required.
g: Green color value, between 0 and 1. Required.
b: Blue color value, between 0 and 1. Required.
a: Alpha color value, between 0 and 1. Defaults to 1.
position: Location within the gradient. Must be nondecreasing. Gradient automatically rescales to fit the largest position value seen.
transform: An array containing the first two rows of a 3x3 transformation matrix. The third row is set to (0,0,1). Defaults to {1, 0, 0, 0, 1, 0}, representing the identity matrix. See Utility.Matrix.Create() for basic functionality. Available for "gradientLinear", "gradientRadial", and "texture".
focus: Number between 0 and 1 controlling the center bias of radial gradients. Defaults to 0. Available for "gradientRadial".
wrap: Control the bounds behavior of textures. Must be either "clamp" or "repeat". Defaults to "clamp". Available for "texture".
smooth: Boolean controlling texture smoothing behavior. Defaults to true. Available for "texture".
source: Source addon ID of the texture to be rendered. See Texture:SetTexture() for details. Available and required for "texture".
texture: Texture identifier of the texture to be rendered. See Texture:SetTexture() for details. Available and required for "texture".
pathparametertable, nilA path. Consists of a table containing a series of tables, with consecutive integer keys starting from 1. Each internal table contains coordinates, either as an absolute value relative to the top-left corner of the frame, or Proportional to the frame size, as a number from 0 to 1. Giving both an absolute value and a proportional value for any coordinate is not allowed. Members:
x/xProportional: x coordinate of this point. Required.
y/yProportional: y coordinate of this point. Required.
xControl/xControlProportional: x coordinate of the curve control handle. If this exists, yControl/yControlProportional must also exist.
yControl/yControlProportional: y coordinate of the curve control handle. If this exists, xControl/xControlProportional must also exist.
strokeparametertable, nilA stroke style. Members:
r: Red color value, betwen 0 and 1. Required.
g: Green color value, betwen 0 and 1. Required.
b: Blue color value, betwen 0 and 1. Required.
a: Alpha color value, betwen 0 and 1. Defaults to 1.
cap: Endcap behavior for non-loops. May be "none", "square", or "round". Defaults to "round".
miter: Corner behavior. May be "miter", "round", or "bevel". Defaults to "miter".
miterLimit: Determines how small the corner angle can be until the miter is chopped off. Defaults to 3. Available only if miter behavior is set to "miter".
thickness: Line thickness. Required.

Canvas:SetStrata

Sets the strata for this frame.

Usage:

Frame:SetStrata(strata)
ParameterTypeDatatypeDescription
strataparameterstringThe item's new strata. Must be one of the elements returned by :GetStrataList().
noSecureFrameAndEnvironment
true

Canvas:SetVisible

Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.

Usage:

Element:SetVisible(visible)
ParameterTypeDatatypeDescription
visibleparameterbooleanThe new visibility flag.
noSecureFrameAndEnvironment
true

Canvas:SetWidth

Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.

Usage:

Frame:SetWidth(width)
ParameterTypeDatatypeDescription
widthparameternumberThe new width of this frame.
noSecureFrameAndEnvironment
true

Command.Achievement.Watch

Watches an achievement, possibly unwatching another item if the player is already watching the maximum item count. Permitted only on unfinished achievements.

Usage:

Command.Achievement.Watch(achievement, flag)
ParameterTypeDatatypeDescription
achievementparameterachievementThe achievement to be affected.
flagparameterbooleanThe new watch status.

Command.Auction.Analyze

Requests auction statistics from the server. The results will be sent to Event.Auction.Statistics. This command is throttled by the "auctionanalyze" throttle type, proportional to the number of days requested.

Usage:

Interaction category: auction

Command.Auction.Analyze(itemtype, begin, end)
Command.Auction.Analyze(itemtype, begin, end, callback)
ParameterTypeDatatypeDescription
beginparameternumberUNIX timestamp to begin analysis at.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
endparameternumberUNIX timestamp to end analysis at.
itemtypeparameteritemtypeItem type to analyze.

Command.Auction.Bid

Bids or buys out an auction.

Usage:

Interaction category: auction

Throttled.

Command.Auction.Bid(auction, bid)
Command.Auction.Bid(auction, bid, quantity)
Command.Auction.Bid(auction, bid, callback)
Command.Auction.Bid(auction, bid, quantity, callback)
ParameterTypeDatatypeDescription
auctionparameterauctionThe auction to be targeted.
bidparameternumberThe amount to bid. To place a buyout, simply bid the buyout value.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
quantityparameternumberHow many items to purchase. If omitted, defaults to the entire auction quantity.

Command.Auction.Cancel

Cancels an auction.

Usage:

Interaction category: auction

Throttled.

Command.Auction.Cancel(auction)
Command.Auction.Cancel(auction, callback)
ParameterTypeDatatypeDescription
auctionparameterauctionThe auction to be targeted.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.

Command.Auction.Fulfill

Fulfills an existing buy order.

Usage:

Interaction category: auction

Throttled.

Command.Auction.Fulfill(auction, item, quantity)
Command.Auction.Fulfill(auction, item, quantity, callback)
ParameterTypeDatatypeDescription
auctionparameterauctionThe auction to be targeted.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
itemparameteritemThe ID of the item to be taken.
quantityparameternumberStack size to fulfill.

Command.Auction.Order

Posts a new buy order.

Usage:

Interaction category: auction

Throttled.

Command.Auction.Order(itemtype, quantity, time, buyout)
Command.Auction.Order(itemtype, quantity, time, buyout, callback)
ParameterTypeDatatypeDescription
buyoutparameternumberThe total buyout for the new auction, in silver. Must be evenly divisible by quantity.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
itemtypeparameteritemtypeThe item type to be ordered.
quantityparameternumberThe number of items to be ordered.
timeparameternumberThe duration that the order should last, in hours. Valid values are limited to 12, 24, and 48.

Command.Auction.Post

Posts a new auction.

Usage:

Interaction category: auction

Throttled.

Command.Auction.Post(item, time, bid, buyout)
Command.Auction.Post(item, time, bid, buyout, partial)
Command.Auction.Post(item, time, bid, buyout, callback)
Command.Auction.Post(item, time, bid, buyout, partial, callback)
ParameterTypeDatatypeDescription
bidparameternumber/nilThe minimum bid for the new auction, in silver. nil if no bid is desired.
buyoutparameternumber/nilThe buyout for the new auction, in silver. nil if no buyout is desired.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
itemparameteritemThe ID of the item to be auctioned.
partialparameterbooleanWhether partial buyouts should be permitted. Must be "false" if a buyout is not provided or if a bid is provided that is different from the buyout. If this parameter is omitted, will default to "true" when possible, or "false" otherwise.
timeparameternumberThe duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.

Command.Auction.Scan

Requests an auction house scan. For type "search", if "index" is omitted then this function will error if the "auctionfullscan" queue is not ready. Type "search" with "index" will throttle on the "auction" command queue. Other types throttle on the "global" command queue.

Usage:

Interaction category: auction

Command.Auction.Scan(parameters)
ParameterTypeDatatypeDescription
parametersparametertableTable containing data about the requested scan.
type: Type of scan to perform. One of "bids", "buy", "mine", "orders", or "search".
If type is "bids", "mine", or "orders", no other parameters are allowed.
If type is "search":
category: Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional.
index: Numeric item index to start the scan at. If provided, the auction scan will return the first 50 items immediately following this index.
levelMax: Maximum level the item must require. Optional.
levelMin: Minimum level the item must require. Optional.
priceMax: Maximum price of the item. Optional.
priceMin: Minimum price of the item. Optional.
rarity: The minimum rarity to search for. Same as the "rarity" member returned by Inspect.Item.Detail(). Optional.
role: The role that the item must be compatible with. One of "mage", "rogue", "cleric", "warrior", or "primalist". Optional.
statType: Which stat to filter based on. One of "armor", "block", "critPower", "critSpell", "dexterity", "dodge", "endurance", "health", "hit", "intelligence", "mana", "powerAttack", "powerSpell", "resistAir", "resistDeath", "resistEarth", "resistFire", "resistLife", "resistWater", "strength", or "wisdom". Optional. If provided, statMin and statMax must also be provided.
statMax: Maximum allowed value for the filter stat. Optional. If provided, statType and statMin must also be provided.
statMin: Minimum allowed value for the filter stat. Optional. If provided, statType and statMax must also be provided.
sort: Which column the requested items should be sorted based on. One of "rarity", "name", "level", "time", "seller", "pricePerUnit", "bid", "buyout", "stack". Optional.
sortOrder: What order to sort in. One of "ascending" or "descending". Optional.
text: A string to search for in the item name. Optional.
type: Type of scan to perform. One of "search", "buy", "mine", or "bids". If "mine" or "bids", must be the only member in the table.
If type is "buy":
category: Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional.
text: A string to search for in the item name. Optional.
hardwareevent
true

Command.Buff.Cancel

Cancels a buff on the player. Not all buffs are cancelable.

Usage:

Throttled.

Command.Buff.Cancel(buff)
ParameterTypeDatatypeDescription
buffparameterbuffThe ID of the buff to cancel.

Command.Buff.Describe

Requests a detailed description for a given buff.

Usage:

Throttled.

Command.Buff.Describe(unit, buff)
ParameterTypeDatatypeDescription
buffparameterbuffThe ID of the buff to describe.
unitparameterunitThe ID of the unit that the buff is on.

Command.Console.Display

Prints a line of text in a console window of your choice. Note that the line length is limited, including HTML tags.

Usage:

Command.Console.Display(console, suppressPrefix, text, html)
ParameterTypeDatatypeDescription
consoleparameterconsoleThe console to display text into. May be "general", "combat", or a console ID.
htmlparameterbooleanEnables 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.')">.
suppressPrefixparameterbooleanSuppress the automatic addon shortname prefix.
textparameterstringThe text to be printed.

Command.Cursor

Changes the contents of the cursor. Ability cursors may be set only if the environment is not in secure mode.

Usage:

Command.Cursor(hold)
ParameterTypeDatatypeDescription
holdparametervariantThe new cursor. Currently accepts ability, item, itemtype, or non-empty non-wildcard slot IDs. Pass nil to clear the cursor.

Command.Dimension.Layout.Pickup

Pick up the specified dimension item from the world to your inventory.

Usage:

Command.Dimension.Layout.Pickup(dimensionItem)
ParameterTypeDatatypeDescription
dimensionItemparameterdimensionitemThe ID of the dimension item to operate on.

Command.Dimension.Layout.Place

Places the item (dimension or inventory) in your current dimension and modifies the details specified by the values parameter.

Usage:

Command.Dimension.Layout.Place(item, values)
Command.Dimension.Layout.Place(dimensionItem, values)
ParameterTypeDatatypeDescription
dimensionItemparameterdimensionitemThe ID of the dimension item to operate on.
itemparameteritemThe inventory item to operate on.
valuesparametertableTable containing data to set on the dimension item. All parameters are optional and will default to current or default values.
coordX: The X coordinate of the item.
coordY: The Y coordinate of the item.
coordZ: The Z coordinate of the item.
pitch: The pitch rotation of the item.
roll: The roll rotation of the item.
scale: The scale of the item.
yaw: The yaw rotation of the item.

Command.Dimension.Layout.Select

Selects or deselects the specified dimension item.

Usage:

Command.Dimension.Layout.Select(dimensionItem, selected)
ParameterTypeDatatypeDescription
dimensionItemparameterdimensionitemThe ID of the dimension item to operate on.
selectedparameterbooleanIndicates if the dimension item should be selected or deselected.

Command.Event.Attach

Attaches an event handler to an event.

Usage:

Command.Event.Attach(event, handler, label)
Command.Event.Attach(event, handler, label, priority)
ParameterTypeDatatypeDescription
eventparametereventGlobalA global event handle, usually pulled out of the "Event." hierarchy.
handlerparameterfunctionA 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.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.

Command.Event.Detach

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.

Usage:

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)
ParameterTypeDatatypeDescription
eventparametereventGlobalA global event handle, usually pulled out of the "Event." hierarchy.
handlerparameterfunction/nilA 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.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

Command.Guild.Bank.Deposit

Deposits money into the guild bank.

Usage:

Interaction category: guildbank

Throttled.

Command.Guild.Bank.Deposit(coin)
Command.Guild.Bank.Deposit(coin, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
coinparameternumberThe string "coin", used as a value to request the player's money.

Command.Guild.Bank.Purchase

Purchases a new guild bank vault.

Usage:

Interaction category: guildbank

Throttled.

Command.Guild.Bank.Purchase()
Command.Guild.Bank.Purchase(callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.

Command.Guild.Bank.Withdraw

Withdraws money from the guild bank.

Usage:

Interaction category: guildbank

Throttled.

Command.Guild.Bank.Withdraw(coin)
Command.Guild.Bank.Withdraw(coin, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
coinparameternumberThe string "coin", used as a value to request the player's money.

Command.Guild.Log.Request

Requests a guild log event.

Usage:

Command.Guild.Log.Request()
Command.Guild.Log.Request(callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
throttleBulk
true

Command.Guild.Motd

Changes the guild's Message of the Day.

Usage:

Throttled.

Command.Guild.Motd(motd)
Command.Guild.Motd(motd, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
motdparameterstringThe new Message of the Day.

Command.Guild.Roster.Demote

Demotes a guildmember by one rank.

Usage:

Throttled.

Command.Guild.Roster.Demote(member)
Command.Guild.Roster.Demote(member, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
memberparameterstringThe guildmember to target.

Command.Guild.Roster.Kick

Kicks a guildmember from the guild.

Usage:

Throttled.

Command.Guild.Roster.Kick(member)
Command.Guild.Roster.Kick(member, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
memberparameterstringThe guildmember to target.

Command.Guild.Roster.Note

Changes your guild note.

Usage:

Throttled.

Command.Guild.Roster.Note(note)
Command.Guild.Roster.Note(note, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
noteparameterstringThe new note.

Command.Guild.Roster.NoteOfficer

Changes a guildmember's officer note.

Usage:

Throttled.

Command.Guild.Roster.NoteOfficer(member, note)
Command.Guild.Roster.NoteOfficer(member, note, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
memberparameterstringThe guildmember to target.
noteparameterstringThe new note.

Command.Guild.Roster.Promote

Promotes a guildmember by one rank.

Usage:

Throttled.

Command.Guild.Roster.Promote(member)
Command.Guild.Roster.Promote(member, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
memberparameterstringThe guildmember to target.

Command.Guild.Wall.Delete

Deletes an entry from the guild wall.

Usage:

Throttled.

Command.Guild.Wall.Delete(wall)
Command.Guild.Wall.Delete(wall, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
wallparameterguildwallThe ID of the target wall post.

Command.Guild.Wall.Post

Posts an entry to the guild wall.

Usage:

Throttled.

Command.Guild.Wall.Post(post)
Command.Guild.Wall.Post(post, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
postparameterstringThe item to post.

Command.Guild.Wall.Request

Requests a guild wall event.

Usage:

Command.Guild.Wall.Request()
Command.Guild.Wall.Request(callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
throttleBulk
true

Command.Item.Destroy

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.

Usage:

Interaction category: item

Throttled.

Command.Item.Destroy(target)
ParameterTypeDatatypeDescription
targetparameteritemThe item ID of the item to destroy.

Command.Item.Move

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.

Usage:

Interaction category: item

Throttled.

Command.Item.Move(source, destination)
ParameterTypeDatatypeDescription
destinationparameterslotThe location to move the item. May attempt to stack or swap if there is already an item here.
sourceparameteritem, slotThe item to move. Must be a slot specifier that refers to an actual item.

Command.Item.Split

Splits a number of items off a stack.

Usage:

Interaction category: item

Throttled.

Command.Item.Split(source, stack)
ParameterTypeDatatypeDescription
sourceparameteritem, slotThe item to split. May be a slot specifier or an item ID.
stackparameternumberThe number of items to move into the new stack. Must be a positive integer.

Command.Item.Standard.Drag

Behaves in the same way that the addon system does when an inventory icon is dragged.

Usage:

Interaction category: item

Command.Item.Standard.Drag(target)
ParameterTypeDatatypeDescription
targetparameteritem, slotThe item or slot to be targeted.

Command.Item.Standard.Drop

Behaves in the same way that the addon system does when an inventory icon is dropped.

Usage:

Interaction category: item

Command.Item.Standard.Drop(target)
ParameterTypeDatatypeDescription
targetparameteritem, slotThe item or slot to be targeted.
hardwareevent
true

Command.Item.Standard.Left

Behaves in the same way that the addon system does when an inventory icon is left-clicked.

Usage:

Interaction category: item

Command.Item.Standard.Left(target)
ParameterTypeDatatypeDescription
targetparameteritem, slotThe item or slot to be targeted.
hardwareevent
true

Command.Item.Standard.Right

Behaves in the same way that the addon system does when an inventory icon is right-clicked.

Usage:

Interaction category: item

Command.Item.Standard.Right(target)
ParameterTypeDatatypeDescription
targetparameteritem, slotThe item or slot to be targeted.
hardwareevent
true

Command.Mail.Delete

Deletes a mail.

Usage:

Interaction category: mail

Throttled.

Command.Mail.Delete(mail)
Command.Mail.Delete(mail, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
mailparametermailThe ID of the mail to be targeted.

Command.Mail.Open

Opens a mail, retrieving detailed information for it.

Usage:

Interaction category: mail

Throttled.

Command.Mail.Open(mail)
Command.Mail.Open(mail, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
mailparametermailThe ID of the mail to be targeted.

Command.Mail.Pay

Pays the COD fee on a mail.

Usage:

Interaction category: mail

Throttled.

Command.Mail.Pay(mail)
Command.Mail.Pay(mail, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
mailparametermailThe ID of the mail to be targeted.

Command.Mail.Return

Returns a mail to its sender.

Usage:

Interaction category: mail

Throttled.

Command.Mail.Return(mail)
Command.Mail.Return(mail, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
mailparametermailThe ID of the mail to be targeted.

Command.Mail.Send

Sends mail.

Usage:

Interaction category: mail

Command.Mail.Send(mail)
Command.Mail.Send(mail, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
mailparametertableTable 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.
hardwareevent
true

Command.Mail.Spam

Marks mail as spam.

Usage:

Interaction category: mail

Throttled.

Command.Mail.Spam(mail)
Command.Mail.Spam(mail, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
mailparametermailThe ID of the mail to be targeted.

Command.Mail.Take

Takes an attached item from mail.

Usage:

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)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
itemparameteritemThe ID of the item to be taken.
itemsparametertableA table containing a list of the items to be taken.
mailparametermailThe ID of the mail to be targeted.

Command.Map.Monitor

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.

Usage:

Command.Map.Monitor(monitor)
ParameterTypeDatatypeDescription
monitorparameterbooleanThe new state of the map monitor flag.

Command.Map.Waypoint.Clear

Clears the player's current waypoint.

Usage:

Command.Map.Waypoint.Clear()

Command.Map.Waypoint.Set

Sets the player's waypoint.

Usage:

Command.Map.Waypoint.Set(x, z)
ParameterTypeDatatypeDescription
xparameternumberThe x coordinate of the waypoint.
zparameternumberThe z coordinate of the waypoint.

Command.Message.Accept

Sets the environment to accept a given type and identifier of message. Parameters can be replaced with "nil" to act as a wildcard.

Usage:

Command.Message.Accept(type, identifier)
ParameterTypeDatatypeDescription
identifierparameterstring/nilThe 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.
typeparameterstring/nilThe type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".

Command.Message.Broadcast

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.

Usage:

Command.Message.Broadcast(type, target, identifier, data)
Command.Message.Broadcast(type, target, identifier, data, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
dataparameterstringThe data to send. This parameter is binary-safe.
identifierparameterstringThe 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.
targetparameterstring/nilThe target of this message. Required for "channel" or "tell" message types, must be nil otherwise.
typeparameterstringThe type of message to send. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell".

Command.Message.Reject

Sets the environment to reject a given type and identifier of message. Directly cancels out single calls to Command.Message.Accept.

Usage:

Command.Message.Reject(type, identifier)
ParameterTypeDatatypeDescription
identifierparameterstring/nilThe 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.
typeparameterstring/nilThe type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".

Command.Message.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.

Usage:

Command.Message.Send(target, identifier, data, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
dataparameterstringThe data to send. This parameter is binary-safe.
identifierparameterstringThe 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.
targetparameterstringThe name of the player to send the message to.

Command.Minion.Claim

Claims an award from a minion adventure in "finished" mode.

Usage:

Command.Minion.Claim(adventure)
ParameterTypeDatatypeDescription
adventureparameterminionadventureThe minion adventure to be affected.
hardwareevent
true

Command.Minion.Hurry

Hurry a minion adventure in "working" mode.

Usage:

Throttled.

Command.Minion.Hurry(adventure, currency)
ParameterTypeDatatypeDescription
adventureparameterminionadventureThe minion adventure to be affected.
currencyparameterstringThe currency to use for this command. May be any of "none", "aventurine", or "credit".

Command.Minion.Send

Send a minion on an adventure.

Usage:

Command.Minion.Send(minion, adventure)
Command.Minion.Send(minion, adventure, currency)
ParameterTypeDatatypeDescription
adventureparameterminionadventureThe minion adventure to be affected.
currencyparameterstringThe currency to use for this command. May be any of "none", "aventurine", or "credit".
minionparameterminionminionThe minion to be affected.
hardwareevent
true

Command.Minion.Shuffle

Shuffle an adventure for a new option.

Usage:

Throttled.

Command.Minion.Shuffle(adventure, currency)
ParameterTypeDatatypeDescription
adventureparameterminionadventureThe minion adventure to be affected.
currencyparameterstringThe currency to use for this command. May be any of "none", "aventurine", or "credit".

Command.Minion.Unlock

Unlock another minion adventure slot.

Usage:

Command.Minion.Unlock()
hardwareevent
true

Command.Quest.Abandon

Abandons the given quest. Permitted only on personal quests.

Usage:

Throttled.

Command.Quest.Abandon(quest)
ParameterTypeDatatypeDescription
questparameterquestThe quest to be affected.

Command.Quest.Share

Shares the given quest. Permitted only on personal quests.

Usage:

Command.Quest.Share(quest)
ParameterTypeDatatypeDescription
questparameterquestThe quest to be affected.
hardwareevent
true

Command.Quest.Track

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.

Usage:

Command.Quest.Track(quest)
Command.Quest.Track(nil)
ParameterTypeDatatypeDescription
nilparameternilThe value "nil".
questparameterquestThe quest to be affected.

Command.Quest.Watch

Watches a quest, possibly unwatching another item if the player is already watching the maximum item count. Permitted only on personal quests.

Usage:

Command.Quest.Watch(quest, flag)
ParameterTypeDatatypeDescription
flagparameterbooleanThe new watch status.
questparameterquestThe quest to be affected.

Command.Queue.Handler

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.

Usage:

Command.Queue.Handler(handler)
ParameterTypeDatatypeDescription
handlerparameterfunctionThe new queue handler.

Command.Slash.Register

Registers a new chat slash command, inserts a new event handle into the Event.Slash hierarchy, and returns that handle. If called multiple times with the same slash command, will return the same handle each time.

Usage:

eventTable = Command.Slash.Register(slashCommand)
ParameterTypeDatatypeDescription
slashCommandparameterstringThe name of the slash command to register.
eventTableresulttableThe event table for your slash command. nil if the slash command could not be registered (usually because it conflicts with a built-in slash command.) Will return the same event table if used twice to register the same slash command.

Command.Social.Friend.Add

Adds a player to your friend list.

Usage:

Throttled.

Command.Social.Friend.Add(name)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the friend.

Command.Social.Friend.Note

Changes a friend's personal note.

Usage:

Throttled.

Command.Social.Friend.Note(name, note)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the friend.
noteparameterstringThe new personal note.

Command.Social.Friend.Remove

Removes a player from your friend list.

Usage:

Throttled.

Command.Social.Friend.Remove(name)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the friend.

Command.Social.Ignore.Add

Adds an player to your ignore list.

Usage:

Throttled.

Command.Social.Ignore.Add(name)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the ignored player.

Command.Social.Ignore.Note

Changes an ignored player's personal note.

Usage:

Throttled.

Command.Social.Ignore.Note(name, note)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the ignored player.
noteparameterstringThe new personal note.

Command.Social.Ignore.Remove

Removes a player from your ignore list.

Usage:

Throttled.

Command.Social.Ignore.Remove(name)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the ignored player.

Command.Storage.Clear

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.

Usage:

Command.Storage.Clear(segment, identifier, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
identifierparameterstringThe identifier of the storage bucket. Must be at least three characters long.
segmentparameterstringThe storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted.

Command.Storage.Get

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.

Usage:

Command.Storage.Get(target, segment, identifier, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
identifierparameterstringThe identifier of the storage bucket. Must be at least three characters long.
segmentparameterstringThe 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.
targetparameterstringThe name of the player whose storage should be accessed. Will work only on players in your guild, players in your group, or players that the addon unit system is aware of.

Command.Storage.List

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.

Usage:

Command.Storage.List(target, segment, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
segmentparameterstringThe 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.
targetparameterstringThe name of the player whose storage should be accessed. Will work only on players in your guild, players in your group, or players that the addon unit system is aware of.

Command.Storage.Set

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.

Usage:

Command.Storage.Set(segment, identifier, read, write, data, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
dataparameterstringThe data to store. This parameter is binary-safe.
identifierparameterstringThe identifier of the storage bucket. Must be at least three characters long.
readparameterstringRead 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.
segmentparameterstringThe 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.
writeparameterstringWrite permissions for this element. If the segment is "player", this must be "private", as only you may modify your own storage. If the segment is "guild", this may be "guild" or "officer", where guild is changeable by guildmembers with the Delete from Guild Addon Storage permission, and officer is changeable by guildmembers with the Delete from Guild Addon Storage permission and the Officer Chat permission. The write permission must be "officer" if the read permission is "officer".

Command.System.Flash

Controls the flashing of the Rift taskbar icon.

Usage:

Command.System.Flash(flash)
ParameterTypeDatatypeDescription
flashparameterbooleanWhether the taskbar icon should flash or not.

Command.System.Strict

Puts the environment into Strict mode. In Strict mode, deprecated functions and events will throw errors instead of functioning normally.

Usage:

Command.System.Strict()

Command.System.Texture.Record

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.

Usage:

Command.System.Texture.Record()

Command.System.Watchdog.Quiet

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.

Usage:

Command.System.Watchdog.Quiet()

Command.Title.Prefix

Changes the player's prefix title.

Usage:

Throttled.

Command.Title.Prefix(title)
ParameterTypeDatatypeDescription
titleparametertitle, nilThe ID of the new title to set, or "nil" for no title.

Command.Title.Suffix

Changes the player's suffix title.

Usage:

Throttled.

Command.Title.Suffix(title)
ParameterTypeDatatypeDescription
titleparametertitle, nilThe ID of the new title to set, or "nil" for no title.

Command.Tooltip

Changes the displayed tooltip.

Usage:

Command.Tooltip(target)
Command.Tooltip(target, nil)
Command.Tooltip(owner, buff)
ParameterTypeDatatypeDescription
buffparameterbuffThe ID of a buff for the new tooltip.
nilparameternilOptional placeholder nil.
ownerparameterunitThe ID of the owner of the buff.
targetparametervariantThe new tooltip. Currently accepts ability, item, itemtype, or unit IDs. Pass nil to clear the tooltip.

Command.UI.Error

Display the addon error dialog.

Usage:

Command.UI.Error(id)
ParameterTypeDatatypeDescription
idparametererrorThe ID of the error to be displayed.

Command.Unit.Menu

Creates a standard context menu targeted at the unit of choice.

Usage:

Command.Unit.Menu(target)
ParameterTypeDatatypeDescription
targetparameterunitThe unit to generate a context menu for.

Context

A UI element of type Context or derived from Context.

Element

A UI element of type Element or derived from Element.

Event.Ability.New.Add

Signals the addition of a player ability.

Usage:

Event.Ability.New.Add(abilities)
ParameterTypeDatatypeDescription
abilitiesparametervariantLists the abilities that were added. Table from ability ID to "true".

Event.Ability.New.Cooldown.Begin

Signals the start of an ability's cooldown.

Usage:

Event.Ability.New.Cooldown.Begin(cooldowns)
ParameterTypeDatatypeDescription
cooldownsparametervariantThe abilities whose cooldown has been changed. The key is the ability ID, the value is the new cooldown. 0 indicates that the cooldown has finished.

Event.Ability.New.Cooldown.End

Signals the end of an ability's cooldown. All the values in the "cooldown" parameter will be 0.

Usage:

Event.Ability.New.Cooldown.End(cooldowns)
ParameterTypeDatatypeDescription
cooldownsparametervariantThe abilities whose cooldown has been changed. The key is the ability ID, the value is the new cooldown. 0 indicates that the cooldown has finished.

Event.Ability.New.Range.False

Signals a player ability exiting range from its current target.

Usage:

Event.Ability.New.Range.False(abilities)
ParameterTypeDatatypeDescription
abilitiesparametervariantThe abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.

Event.Ability.New.Range.True

Signals a player ability entering range from its current target.

Usage:

Event.Ability.New.Range.True(abilities)
ParameterTypeDatatypeDescription
abilitiesparametervariantThe abilities that have entered or exited range. The key is the ability ID, the value is whether they are currently in range.

Event.Ability.New.Remove

Signals the removal of a player ability.

Usage:

Event.Ability.New.Remove(abilities)
ParameterTypeDatatypeDescription
abilitiesparametervariantLists the abilities that were removed. Table from ability ID to "false".

Event.Ability.New.Target

Signals a player ability changing its current target.

Usage:

Event.Ability.New.Target(abilities)
ParameterTypeDatatypeDescription
abilitiesparametervariantThe abilities whose target has changed. The key is the ability ID, the value is the new target.

Event.Ability.New.Usable.False

Signals a player ability becoming unusable.

Usage:

Event.Ability.New.Usable.False(abilities)
ParameterTypeDatatypeDescription
abilitiesparametervariantThe abilities whose usability has changed. The key is the ability ID, the value is the new usability.

Event.Ability.New.Usable.True

Signals a player ability becoming usable.

Usage:

Event.Ability.New.Usable.True(abilities)
ParameterTypeDatatypeDescription
abilitiesparametervariantThe abilities whose usability has changed. The key is the ability ID, the value is the new usability.

Event.Achievement.Complete

Signals an achievement completing.

Usage:

Event.Achievement.Complete(achievement)
ParameterTypeDatatypeDescription
achievementparametervariantThe ID of the achievement.

Event.Achievement.Update

Signals a change in an achievement's information.

Usage:

Event.Achievement.Update(achievements)
ParameterTypeDatatypeDescription
achievementsparametervariantA table of the achievements, in {id = true} format.

Event.Addon.Load.Begin

Signals the beginning of an addon's loading sequence.

Usage:

Event.Addon.Load.Begin(addonidentifier)
ParameterTypeDatatypeDescription
addonidentifierparametervariantThe addon's identifier.

Event.Addon.Load.End

Signals the end of an addon's loading sequence. At this point, that addon is fully loaded and initialized.

Usage:

Event.Addon.Load.End(addonidentifier)
ParameterTypeDatatypeDescription
addonidentifierparametervariantThe addon's identifier.

Event.Addon.SavedVariables.Load.Begin

Signals the beginning of an addon's saved variable loading.

Usage:

Event.Addon.SavedVariables.Load.Begin(addonidentifier)
ParameterTypeDatatypeDescription
addonidentifierparametervariantThe addon's identifier.

Event.Addon.SavedVariables.Load.End

Signals the end of an addon's saved variable load.

Usage:

Event.Addon.SavedVariables.Load.End(addonidentifier)
ParameterTypeDatatypeDescription
addonidentifierparametervariantThe addon's identifier.

Event.Addon.SavedVariables.Save.Begin

Signals the beginning of an addon's saved variable saving.

Usage:

Event.Addon.SavedVariables.Save.Begin(addonidentifier)
ParameterTypeDatatypeDescription
addonidentifierparametervariantThe addon's identifier.

Event.Addon.SavedVariables.Save.End

Signals the end of an addon's saved variable saving.

Usage:

Event.Addon.SavedVariables.Save.End(addonidentifier)
ParameterTypeDatatypeDescription
addonidentifierparametervariantThe addon's identifier.

Event.Addon.Shutdown.Begin

Signals the beginning of the shutdown sequence.

Usage:

Event.Addon.Shutdown.Begin()

Event.Addon.Shutdown.End

Signals the end of the shutdown sequence. This is the last event that will be sent.

Usage:

Event.Addon.Shutdown.End()

Event.Addon.Startup.End

Signals the end of the startup sequence. At this point, all addons are fully loaded and initialized.

Usage:

Event.Addon.Startup.End()

Event.Attunement.Progress.Accumulated

Signals your accumulated attunement experience changing.

Usage:

Event.Attunement.Progress.Accumulated(accumulated)
ParameterTypeDatatypeDescription
accumulatedparametervariantTotal quantity of accumulated attunement experience in this level.

Event.Attunement.Progress.Available

Signals your available attunement points changing.

Usage:

Event.Attunement.Progress.Available(available)
ParameterTypeDatatypeDescription
availableparametervariantNumber of unused attunement ranks.

Event.Attunement.Progress.Rested

Signals your available attunement rested experience changing.

Usage:

Event.Attunement.Progress.Rested(rested)
ParameterTypeDatatypeDescription
restedparametervariantQuantity of available attunement rested experience.

Event.Attunement.Progress.Spent

Signals your spent attunement points changing.

Usage:

Event.Attunement.Progress.Spent(spent)
ParameterTypeDatatypeDescription
spentparametervariantNumber of spent attunement ranks.

Event.Auction.Scan

Signals incoming auction data.

Usage:

Event.Auction.Scan(type, auctions)
ParameterTypeDatatypeDescription
auctionsparameter<nope>A table of the auctions returned from this scan.
typeparametervariantA table containing information on this scan. In the same format as the parameter to Command.Auction.Scan().

Event.Auction.Statistics

Signals receipt of auction statistics.

Usage:

Event.Auction.Statistics(itemtype, data)
ParameterTypeDatatypeDescription
dataparameter<nope>Table containing a series of tables with different timestamps, each containing data for a single day.
itemtypeparametervariantItem type that the attached statistics refer to.
members
priceAverage Average item price during this day.
priceMax Maximum item price during this day.
priceMin Minimum item price during this day.
priceVariance Variance in item price during this day.
time UNIX timestamp of the day.
volume Quantity of items traded during this day.

Event.Buff.Add

Signals new buffs on a unit.

Usage:

Event.Buff.Add(unit, buffs)
ParameterTypeDatatypeDescription
buffsparameter<nope>A table containing the buffs involved. The key is the buff ID, the value is the buff type ID or 'true' if the buff has no type.
unitparametervariantThe Unit ID of the unit involved.

Event.Buff.Change

Signals a change in existing buffs on a unit.

Usage:

Event.Buff.Change(unit, buffs)
ParameterTypeDatatypeDescription
buffsparameter<nope>A table containing the buffs involved.
unitparametervariantThe Unit ID of the unit involved.

Event.Buff.Description

Signals a change in an existing buff's detailed description. Value of the key is "true" if detail is now available, "false" if it is no longer available.

Usage:

Event.Buff.Description(unit, buffs)
ParameterTypeDatatypeDescription
buffsparameter<nope>A table containing the buffs involved.
unitparametervariantThe Unit ID of the unit involved.

Event.Buff.Remove

Signals removal of buffs from a unit.

Usage:

Event.Buff.Remove(unit, buffs)
ParameterTypeDatatypeDescription
buffsparameter<nope>A table containing the buffs involved.
unitparametervariantThe Unit ID of the unit involved.

Event.Chat.Notify

Signals a screen notification. This is generally used as a warning mechanism during boss fights.

Usage:

Event.Chat.Notify(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
message The text said.

Event.Chat.Npc

Signals an NPC speaking a line of text.

Usage:

Event.Chat.Npc(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
from The unit ID of the speaker, if available.
fromName The name of the speaker.
message The text said.

Event.Combat.Damage

Signals damage done to a unit. All units referenced by this event will be accessible within this event's handlers.

Usage:

Event.Combat.Damage(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
ability The ability ID for the ability used, if available.
abilityName The name of the ability used.
caster The unit ID for this event's initiator, if one exists.
casterName The name of this event's initiator, if available.
crit Whether this was the result of a critical hit.
damage The amount of damage actually done.
damageAbsorbed The amount of damage absorbed.
damageBlocked The amount of damage blocked.
damageIntercepted The amount of damage intercepted.
damageModified The amount of damage modified.
overkill The amount of overkill done.
target The unit ID for the target.
targetName The name of the target, if available.
type The damage type. Values include "life", "death", "air", "earth", "fire", "water".

Event.Combat.Death

Signals the death of a unit. All units referenced by this event will be accessible within this event's handlers.

Usage:

Event.Combat.Death(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
caster The unit ID for this event's initiator, if one exists.
casterName The name of this event's initiator, if available.
target The unit ID for the target.
targetName The name of the target, if available.

Event.Combat.Dodge

Signals a unit dodging an ability. All units referenced by this event will be accessible within this event's handlers.

Usage:

Event.Combat.Dodge(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
ability The ability ID for the ability used, if available.
abilityName The name of the ability used.
caster The unit ID for this event's initiator, if one exists.
casterName The name of this event's initiator, if available.
target The unit ID for the target.
targetName The name of the target, if available.

Event.Combat.Heal

Signals healing done to a unit. All units referenced by this event will be accessible within this event's handlers.

Usage:

Event.Combat.Heal(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
ability The ability ID for the ability used, if available.
abilityName The name of the ability used.
caster The unit ID for this event's initiator, if one exists.
casterName The name of this event's initiator, if available.
crit Whether this was the result of a critical hit.
heal The amount healed.
overheal The amount of healing past maximum health wasted.
target The unit ID for the target.
targetName The name of the target, if available.

Event.Combat.Immune

Signals a unit resisting an ability through immunity. All units referenced by this event will be accessible within this event's handlers.

Usage:

Event.Combat.Immune(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
ability The ability ID for the ability used, if available.
abilityName The name of the ability used.
caster The unit ID for this event's initiator, if one exists.
casterName The name of this event's initiator, if available.
target The unit ID for the target.
targetName The name of the target, if available.

Event.Combat.Miss

Signals an ability's effect missing a unit. All units referenced by this event will be accessible within this event's handlers.

Usage:

Event.Combat.Miss(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
ability The ability ID for the ability used, if available.
abilityName The name of the ability used.
caster The unit ID for this event's initiator, if one exists.
casterName The name of this event's initiator, if available.
target The unit ID for the target.
targetName The name of the target, if available.

Event.Combat.Parry (deprecated)

Signals a unit parrying an ability. All units referenced by this event will be accessible within this event's handlers.

Usage:

Event.Combat.Parry(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
deprecated
standard
members
ability The ability ID for the ability used, if available.
abilityName The name of the ability used.
caster The unit ID for this event's initiator, if one exists.
casterName The name of this event's initiator, if available.
target The unit ID for the target.
targetName The name of the target, if available.

Event.Combat.Resist

Signals a unit resisting an ability. All units referenced by this event will be accessible within this event's handlers.

Usage:

Event.Combat.Resist(info)
ParameterTypeDatatypeDescription
infoparametervariantDetailed information table about this event, containing several named parameters.
members
ability The ability ID for the ability used, if available.
abilityName The name of the ability used.
caster The unit ID for this event's initiator, if one exists.
casterName The name of this event's initiator, if available.
target The unit ID for the target.
targetName The name of the target, if available.

Event.Currency

Signals a change in the player's available currency.

Usage:

Event.Currency(currencies)
ParameterTypeDatatypeDescription
currenciesparametervariantNew currency counts, in key/value form.

Event.Cursor

Signals that the cursor has changed.

Usage:

Event.Cursor(type, held)
ParameterTypeDatatypeDescription
heldparameter<nope>The blob describing the new element held. Generally, some kind of identifier used in another part of the addon system.
typeparametervariantThe current cursor type. Valid values include "ability", "item", and "itemtype".

Event.Dimension.Layout.Add

Signals that a dimension item has been added.

Usage:

Event.Dimension.Layout.Add(addedItem)
ParameterTypeDatatypeDescription
addedItemparametervariantThe dimension item that has been added.

Event.Dimension.Layout.Remove

Signals that a dimension item has been removed.

Usage:

Event.Dimension.Layout.Remove(removedItem)
ParameterTypeDatatypeDescription
removedItemparametervariantThe dimension item that has been removed.

Event.Dimension.Layout.Update

Signals that a dimension item has been updated.

Usage:

Event.Dimension.Layout.Update(updatedItem)
ParameterTypeDatatypeDescription
updatedItemparametervariantThe dimension item that has been updated.

Event.Experience.Accumulated

Signals your accumulated experience changing.

Usage:

Event.Experience.Accumulated(accumulated)
ParameterTypeDatatypeDescription
accumulatedparametervariantTotal quantity of accumulated experience in this level.

Event.Experience.Rested

Signals your available rested experience changing.

Usage:

Event.Experience.Rested(rested)
ParameterTypeDatatypeDescription
restedparametervariantQuantity of available rested experience.

Event.Faction.Notoriety

Signals a change in the player's faction notoriety.

Usage:

Event.Faction.Notoriety(notoriety)
ParameterTypeDatatypeDescription
notorietyparametervariantNew notoriety values, in key/value form.

Event.Guild.Bank.Change

Signals a change in a guild bank vault's information.

Usage:

Event.Guild.Bank.Change(vaults)
ParameterTypeDatatypeDescription
vaultsparametervariantA lookup table of vaults that have changed.

Event.Guild.Bank.Coin

Signals a change in the guild bank's money.

Usage:

Event.Guild.Bank.Coin(coin)
ParameterTypeDatatypeDescription
coinparametervariantThe new amount of money in the guild bank.

Event.Guild.Log

Signals incoming guild log data. Can be triggered manually with Command.Guild.Log.Request().

Usage:

Event.Guild.Log(log)
ParameterTypeDatatypeDescription
logparametervariantAn array containing the refreshed guild log items, in order.
members
achievement The achievement involved.
coin The amount of silver involved.
count The number of items involved.
item The item type involved.
level The level involved.
rank The rank involved.
source The source of the log event.
target The target of the log event.
type The type of the log message. May be any of achievement, bankCoinDeposit, bankCoinHeal, bankCoinTithe, bankCoinWithdraw, bankItemDeposit, bankItemWithdraw, bankVault, charterSign, charterUnsign, demote, demoteTrial, dimensionBuy, finder, firstAchievement, firstCollection, firstItem, firstKill, firstQuest, form, found, invite, kick, leave, level, motd, promote, rankEdit, rename, transferred, unlearnActive, unlearnPassive, wallDelete, wallModify, xp, or xpQuest.
xp The amount of XP involved.

Event.Guild.Motd

Signals a change in the guild Message of the Day.

Usage:

Event.Guild.Motd(motd)
ParameterTypeDatatypeDescription
motdparametervariantThe new Message of the Day.

Event.Guild.Rank

Signals a change in one of your guild's ranks.

Usage:

Event.Guild.Rank(ranks)
ParameterTypeDatatypeDescription
ranksparametervariantA lookup table of ranks that have changed.

Event.Guild.Roster.Add

Signals a new player added to the guild roster.

Usage:

Event.Guild.Roster.Add(add)
ParameterTypeDatatypeDescription
addparametervariantThe name of the added guildmember.

Event.Guild.Roster.Detail.Level

Signals a change in a guildmember's level.

Usage:

Event.Guild.Roster.Detail.Level(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Detail.Note

Signals a change in a guildmember's note.

Usage:

Event.Guild.Roster.Detail.Note(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Detail.NoteOfficer

Signals a change in a guildmember's officer note.

Usage:

Event.Guild.Roster.Detail.NoteOfficer(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Detail.Rank

Signals a change in a guildmember's rank.

Usage:

Event.Guild.Roster.Detail.Rank(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Detail.Status

Signals a change in a guildmember's status.

Usage:

Event.Guild.Roster.Detail.Status(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Guild.Roster.Detail.Zone

Signals a change in a guildmember's zone.

Usage:

Event.Guild.Roster.Detail.Zone(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Remove

Signals a player removed from the guild roster.

Usage:

Event.Guild.Roster.Remove(remove)
ParameterTypeDatatypeDescription
removeparametervariantThe name of the removed guildmember.

Event.Guild.Wall

Signals incoming guild wall data. Can be triggered manually with Command.Guild.Wall.Request().

Usage:

Event.Guild.Wall(wall)
ParameterTypeDatatypeDescription
wallparametervariantAn array containing the refreshed guild wall items, in order.
members
id The ID of the guild wall entry.
poster The poster of the guild wall entry.
text The text of the guild wall entry.
time The time the wall entry was posted, in UNIX time.

Event.Interaction

Signals a change in available interaction types.

Usage:

Event.Interaction(interaction, state)
ParameterTypeDatatypeDescription
interactionparametervariantThe identifier of the interaction type. May be any of "auction", "bank", "guildbank", or "mail".
stateparameter<nope>Boolean indicating whether or not that interaction is available.

Event.Item.Slot

Signals that the contents of an item slot have changed.

Usage:

Event.Item.Slot(updates)
ParameterTypeDatatypeDescription
updatesparametervariantTable of changes. Key is the slot identifier, value is an item ID, false if the slot is now empty, or the string "nil" if the slot no longer exists.

Event.Item.Update

Signals that an item has changed.

Usage:

Event.Item.Update(updates)
ParameterTypeDatatypeDescription
updatesparametervariantTable of changes. Key is the slot identifier, value is an item ID, false if the slot is now empty, or the string "nil" if the slot no longer exists.

Event.Mail

Signals a change in the available mail messages.

Usage:

Event.Mail(mail)
ParameterTypeDatatypeDescription
mailparametervariantThe changed mail messages. Takes the form of a table. The key is the mail ID, the value is "basic" to indicate basic information available about a piece of mail, "detail" to indicate detailed information available, or false to indicate no information available.

Event.Map.Add

Signals the addition of a map element.

Usage:

Event.Map.Add(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Map.Change

Signals the change of a map element, in some manner besides coordinates.

Usage:

Event.Map.Change(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Map.Detail.Coord

Signals the coordinate change of a map element.

Usage:

Event.Map.Detail.Coord(x, y, z)
ParameterTypeDatatypeDescription
xparametervariantThe new X coordinate of the changed elements. Takes the form of a table. The key is the element ID.
yparameter<nope>The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID.
zparameter<nope>The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID.

Event.Map.Remove

Signals the removal of a map element.

Usage:

Event.Map.Remove(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Map.Waypoint.Update

Signals the change of a player's waypoint.

Usage:

Event.Map.Waypoint.Update(units)
ParameterTypeDatatypeDescription
unitsparametervariantThe unit whose waypoint has changed. Takes the form of a table. The key is the element ID.

Event.Message.Receive

Signals the receipt of an addon message.

Usage:

Event.Message.Receive(from, type, channel, identifier, data)
ParameterTypeDatatypeDescription
channelparameter<nope>If type is "channel", the channel that this message was sent to. Otherwise, nil.
dataparameter<nope>The data payload for this message type.
fromparametervariantThe name of the player this message is from.
identifierparameter<nope>The identifier for this message.
typeparameter<nope>The type of this message. May be any of "send", "tell", "channel", "guild", "officer", "party", "raid", "say", or "yell".

Event.Minion.Adventure.Change

Signals a change in a minion adventure.

Usage:

Event.Minion.Adventure.Change(adventures)
ParameterTypeDatatypeDescription
adventuresparametervariantA table of minion adventures that have changed. Takes the form of a table. The key is the minion adventure ID.

Event.Minion.Minion.Change

Signals a change in a minion.

Usage:

Event.Minion.Minion.Change(minions)
ParameterTypeDatatypeDescription
minionsparametervariantA table of minions that have changed. Takes the form of a table. The key is the minion ID.

Event.Mouse.Move

Signals the mouse moving.

Usage:

Event.Mouse.Move(x, y)
ParameterTypeDatatypeDescription
xparametervariantThe mouse's new X position.
yparameter<nope>The mouse's new Y position.

Event.Pvp.History.Favor

Signals your historical favor changing.

Usage:

Event.Pvp.History.Favor(favor)
ParameterTypeDatatypeDescription
favorparametervariantAmount of lifetime favor accumulated.

Event.Pvp.History.Kill.Today

Signals your daily kill count changing.

Usage:

Event.Pvp.History.Kill.Today(kill)
ParameterTypeDatatypeDescription
killparametervariantAmount of kills made in this time period.

Event.Pvp.Prestige.Accumulated

Signals your accumulated prestige changing.

Usage:

Event.Pvp.Prestige.Accumulated(accumulated)
ParameterTypeDatatypeDescription
accumulatedparametervariantTotal quantity of accumulated prestige in this rank.

Event.Pvp.Prestige.Rank

Signals your prestige rank changing.

Usage:

Event.Pvp.Prestige.Rank(rank)
ParameterTypeDatatypeDescription
rankparametervariantCurrent prestige rank.

Event.Quest.Abandon

Signals that a quest has been abandoned.

Usage:

Event.Quest.Abandon(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Quest.Accept

Signals that a quest has been accepted.

Usage:

Event.Quest.Accept(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Quest.Change

Signals that a quest has been changed in some manner, most likely progress in an objective.

Usage:

Event.Quest.Change(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Quest.Complete

Signals that a quest has been completed.

Usage:

Event.Quest.Complete(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Queue.Status

Signals that a queue may have left or entered the throttled state.

Usage:

Event.Queue.Status(id)
ParameterTypeDatatypeDescription
idparametervariantThe ID of the queue affected. To get the actual new state, use Inspect.Queue.Status().

Event.Social.Friend

Signals a change in your friend list.

Usage:

Event.Social.Friend(friends)
ParameterTypeDatatypeDescription
friendsparametervariantA lookup table containing the changed friends.

Event.Social.Ignore

Signals a change in your ignore list.

Usage:

Event.Social.Ignore(ignores)
ParameterTypeDatatypeDescription
ignoresparametervariantA lookup table containing the changed ignored players.

Event.Stat

Signals a change in the player's stats.

Usage:

Event.Stat(stats)
ParameterTypeDatatypeDescription
statsparametervariantA table from stat ID to stat value, containing the stats that changed.

Event.Storage.Get

Signals receiving storage data from a target.

Usage:

Event.Storage.Get(target, segment, identifier, read, write, data)
ParameterTypeDatatypeDescription
dataparameter<nope>The data contained in the requested element.
identifierparameter<nope>The identifier that was inspected.
readparameter<nope>The read permissions of this element. See Command.Storage.Set() for details.
segmentparameter<nope>The segment that has been inspected, either "player" or "guild".
targetparametervariantThe name of the player that has been inspected.
writeparameter<nope>The write permissions of this element. See Command.Storage.Set() for details.

Event.Storage.List

Signals receiving a list of storage elements from a target.

Usage:

Event.Storage.List(target, segment, identifiers)
ParameterTypeDatatypeDescription
identifiersparameter<nope>A list of identifiers available to you, in {identifier = checksum} format.
segmentparameter<nope>The segment that has been inspected, either "player" or "guild".
targetparametervariantThe name of the player that has been inspected.

Event.System.Error

Signals that an addon error has occurred. To prevent infinite loops, errors in handlers for this event may not result in further events being triggered.

Usage:

Event.System.Error(error)
ParameterTypeDatatypeDescription
errorparametervariantTable containing error data.
members
addon The identifier of the responsible addon. Used in error types event, frameEvent, dispatch, fileNotFound, fileLoad, fileRun, perfWarning, perfError, text, and requirement.
axis The axis influenced by the error. Used in error types layoutLoop and layoutError.
deprecation Indicates that the error was caused by attempted use of deprecated functionality. May appear in error types event, frameEvent, script, dispatch, queue, callback, or fileRun.
error The actual error message generated. Used in error types event, frameEvent, script, dispatch, fileLoad, fileRun, and text.
event The name of the event responsible. Used in error types event, frameEvent, and internal.
file The name of the file responsible. Used in error types fileNotFound, fileLoad, and fileRun.
frame The name of the frame that the event was generated on. Used in error type frameEvent.
id The internal ID of this error.
info The info string provided as part of the event handler. Used in error types event, dispatch, perfWarning, perfError, and requirement.
script The exact script entered by the user. Used in error type script.
stacktrace The stacktrace at the point of the error. Used in error types event, frameEvent, script, dispatch, fileRun, layoutLoop, layoutError, perfWarning, perfError, text, and requirement.
type Error type. "event" indicates an error within a global event handler. "frameEvent" indicates an error within a frame event handler. "script" indicates an error within a user-entered /script. "dispatch" indicates an error within a Utility.Dispatch handler. "internal" indicates an error within Rift's code (hopefully you'll never see this). "fileNotFound" indicates a missing file when attempting to load an addon. "fileLoad" indicates a parse failure when attempting to load an addon. "fileRun" indicates an execution error when attempting to load an addon. "layoutLoop" indicates a dependency loop found when evaluating the layout. "layoutError" indicates an invalid position found when evaluating the layout. "perfWarning" indicates a watchdog performance warning. "perfError" indicates a watchdog performance error, and that the Lua thread may have been interrupted. "text" indicates an error in Lua code embedded in HTML text. "requirement" indicates an error caused by not fulfilling function requirements.

Event.System.Secure.Enter

Signals that the system is entering Secure mode. Usually this is equivalent to entering combat. Functions that may not be called in Secure mode will be locked after this event is complete.

Usage:

Event.System.Secure.Enter()

Event.System.Secure.Leave

Signals that the system is leaving Secure mode. Usually this is equivalent to leaving combat. Functions that may not be called in Secure mode are unlocked just before this event fires.

Usage:

Event.System.Secure.Leave()

Event.System.Texture

Signals information on Rift UI textures that have been seen.

Usage:

Event.System.Texture(textures)
ParameterTypeDatatypeDescription
texturesparametervariantA lookup table of all textures that has been seen since the last event.

Event.System.Update.Begin

Signals the beginning of a frame render. This is your last chance to make UI changes for this frame.

Usage:

Event.System.Update.Begin()

Event.System.Update.End

Signals the end of a frame render.

Usage:

Event.System.Update.End()

Event.TEMPORARY.Experience (deprecated)

Signals a change in the player's experience.

Usage:

Event.TEMPORARY.Experience(accumulated, rested, needed)
ParameterTypeDatatypeDescription
accumulatedparametervariantThe amount of experience that has accumulated towards the next level.
neededparameter<nope>The amount of experience required to reach the next level.
restedparameter<nope>The amount of rested experience that has accumulated.
deprecated
standard

Event.TEMPORARY.Role (deprecated)

Signals a change in the player's current role.

Usage:

Event.TEMPORARY.Role(role)
ParameterTypeDatatypeDescription
roleparametervariantThe ID of the new role.
deprecated
soft

Event.Title.Add

Signals the addition of a new title.

Usage:

Event.Title.Add(titles)
ParameterTypeDatatypeDescription
titlesparametervariantA lookup table of newly available titles.

Event.Tooltip

Signals that the tooltip has changed.

Usage:

Event.Tooltip(type, shown, buff)
ParameterTypeDatatypeDescription
buffparameter<nope>The ID of the tooltip's new buff. "shown" will be a unit in this case.
shownparameter<nope>The blob describing the new element shown. Generally, some kind of identifier used in another part of the addon system.
typeparametervariantThe current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".

Event.UI.Button.Left.Press

Signals that a Button has been pressed with the left mouse button. Equivalent to LeftClick, but triggers only while the button is enabled.

Usage:

Event.UI.Button.Left.Press(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Checkbox.Change

Signals that a checkbox's state has changed.

Usage:

Event.UI.Checkbox.Change(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Down

Signals that a keyboard key has been pressed. Requires key focus.

Usage:

Event.UI.Input.Key.Down(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Down.Bubble

Event.UI.Input.Key.Down.Bubble@summary

Usage:

Event.UI.Input.Key.Down.Bubble(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Down.Dive

Event.UI.Input.Key.Down.Dive@summary

Usage:

Event.UI.Input.Key.Down.Dive(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Focus.Gain

Signals that a frame has gained the key focus.

Usage:

Event.UI.Input.Key.Focus.Gain(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Gain.Bubble

Event.UI.Input.Key.Focus.Gain.Bubble@summary

Usage:

Event.UI.Input.Key.Focus.Gain.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Gain.Dive

Event.UI.Input.Key.Focus.Gain.Dive@summary

Usage:

Event.UI.Input.Key.Focus.Gain.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Loss

Signals that a frame has lost the key focus.

Usage:

Event.UI.Input.Key.Focus.Loss(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Loss.Bubble

Event.UI.Input.Key.Focus.Loss.Bubble@summary

Usage:

Event.UI.Input.Key.Focus.Loss.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Focus.Loss.Dive

Event.UI.Input.Key.Focus.Loss.Dive@summary

Usage:

Event.UI.Input.Key.Focus.Loss.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Key.Repeat

Signals that a keyboard key is repeating. Requires key focus.

Usage:

Event.UI.Input.Key.Repeat(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Repeat.Bubble

Event.UI.Input.Key.Repeat.Bubble@summary

Usage:

Event.UI.Input.Key.Repeat.Bubble(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Repeat.Dive

Event.UI.Input.Key.Repeat.Dive@summary

Usage:

Event.UI.Input.Key.Repeat.Dive(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Type

Signals that text has been typed. Requires key focus.

Usage:

Event.UI.Input.Key.Type(handle, text)
ParameterTypeDatatypeDescription
handle???variant
textparameter<nope>The text that has been entered.

Event.UI.Input.Key.Type.Bubble

Event.UI.Input.Key.Type.Bubble@summary

Usage:

Event.UI.Input.Key.Type.Bubble(handle, text)
ParameterTypeDatatypeDescription
handle???variant
textparameter<nope>The text that has been entered.

Event.UI.Input.Key.Type.Dive

Event.UI.Input.Key.Type.Dive@summary

Usage:

Event.UI.Input.Key.Type.Dive(handle, text)
ParameterTypeDatatypeDescription
handle???variant
textparameter<nope>The text that has been entered.

Event.UI.Input.Key.Up

Signals that a keyboard key has been released. Requires key focus.

Usage:

Event.UI.Input.Key.Up(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Up.Bubble

Event.UI.Input.Key.Up.Bubble@summary

Usage:

Event.UI.Input.Key.Up.Bubble(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Key.Up.Dive

Event.UI.Input.Key.Up.Dive@summary

Usage:

Event.UI.Input.Key.Up.Dive(handle, key)
ParameterTypeDatatypeDescription
handle???variant
keyparameter<nope>Key code for the applicable key. Generally, the lowercase non-shifted result of pressing that key. Will be a user-identifiable string for keys without standard display representations.

Event.UI.Input.Mouse.Cursor.In

Signals that the cursor has moved into a frame.

Usage:

Event.UI.Input.Mouse.Cursor.In(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.In.Bubble

Event.UI.Input.Mouse.Cursor.In.Bubble@summary

Usage:

Event.UI.Input.Mouse.Cursor.In.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.In.Dive

Event.UI.Input.Mouse.Cursor.In.Dive@summary

Usage:

Event.UI.Input.Mouse.Cursor.In.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Move

Signals that the cursor has moved within a frame.

Usage:

Event.UI.Input.Mouse.Cursor.Move(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Move.Bubble

Event.UI.Input.Mouse.Cursor.Move.Bubble@summary

Usage:

Event.UI.Input.Mouse.Cursor.Move.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Move.Dive

Event.UI.Input.Mouse.Cursor.Move.Dive@summary

Usage:

Event.UI.Input.Mouse.Cursor.Move.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Out

Signals that the cursor has moved out of a frame.

Usage:

Event.UI.Input.Mouse.Cursor.Out(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Out.Bubble

Event.UI.Input.Mouse.Cursor.Out.Bubble@summary

Usage:

Event.UI.Input.Mouse.Cursor.Out.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Cursor.Out.Dive

Event.UI.Input.Mouse.Cursor.Out.Dive@summary

Usage:

Event.UI.Input.Mouse.Cursor.Out.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Click

Signals that the user has clicked the left mouse button.

Usage:

Event.UI.Input.Mouse.Left.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Click.Bubble

Event.UI.Input.Mouse.Left.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Left.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Click.Dive

Event.UI.Input.Mouse.Left.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Left.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Down

Signals that the user has pressed the left mouse button.

Usage:

Event.UI.Input.Mouse.Left.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Down.Bubble

Event.UI.Input.Mouse.Left.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Left.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Down.Dive

Event.UI.Input.Mouse.Left.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Left.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Up

Signals that the user has released the left mouse button.

Usage:

Event.UI.Input.Mouse.Left.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Up.Bubble

Event.UI.Input.Mouse.Left.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Left.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Up.Dive

Event.UI.Input.Mouse.Left.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Left.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Upoutside

Signals that the user has released the left mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Left.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Upoutside.Bubble

Event.UI.Input.Mouse.Left.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Left.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Left.Upoutside.Dive

Event.UI.Input.Mouse.Left.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Left.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Click

Signals that the user has clicked the middle mouse button.

Usage:

Event.UI.Input.Mouse.Middle.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Click.Bubble

Event.UI.Input.Mouse.Middle.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Middle.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Click.Dive

Event.UI.Input.Mouse.Middle.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Middle.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Down

Signals that the user has pressed the middle mouse button.

Usage:

Event.UI.Input.Mouse.Middle.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Down.Bubble

Event.UI.Input.Mouse.Middle.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Middle.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Down.Dive

Event.UI.Input.Mouse.Middle.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Middle.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Up

Signals that the user has released the middle mouse button.

Usage:

Event.UI.Input.Mouse.Middle.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Up.Bubble

Event.UI.Input.Mouse.Middle.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Middle.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Up.Dive

Event.UI.Input.Mouse.Middle.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Middle.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Upoutside

Signals that the user has released the middle mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Middle.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Upoutside.Bubble

Event.UI.Input.Mouse.Middle.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Middle.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Middle.Upoutside.Dive

Event.UI.Input.Mouse.Middle.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Middle.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Click

Signals that the user has clicked the fourth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse4.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Click.Bubble

Event.UI.Input.Mouse.Mouse4.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Click.Dive

Event.UI.Input.Mouse.Mouse4.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Down

Signals that the user has pressed the fourth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse4.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Down.Bubble

Event.UI.Input.Mouse.Mouse4.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Down.Dive

Event.UI.Input.Mouse.Mouse4.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Up

Signals that the user has released the fourth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse4.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Up.Bubble

Event.UI.Input.Mouse.Mouse4.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Up.Dive

Event.UI.Input.Mouse.Mouse4.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Upoutside

Signals that the user has released the fourth mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Mouse4.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Upoutside.Bubble

Event.UI.Input.Mouse.Mouse4.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse4.Upoutside.Dive

Event.UI.Input.Mouse.Mouse4.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse4.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Click

Signals that the user has clicked the fifth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse5.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Click.Bubble

Event.UI.Input.Mouse.Mouse5.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Click.Dive

Event.UI.Input.Mouse.Mouse5.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Down

Signals that the user has pressed the fifth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse5.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Down.Bubble

Event.UI.Input.Mouse.Mouse5.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Down.Dive

Event.UI.Input.Mouse.Mouse5.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Up

Signals that the user has released the fifth mouse button.

Usage:

Event.UI.Input.Mouse.Mouse5.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Up.Bubble

Event.UI.Input.Mouse.Mouse5.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Up.Dive

Event.UI.Input.Mouse.Mouse5.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Upoutside

Signals that the user has released the fifth mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Mouse5.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Upoutside.Bubble

Event.UI.Input.Mouse.Mouse5.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Mouse5.Upoutside.Dive

Event.UI.Input.Mouse.Mouse5.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Mouse5.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Click

Signals that the user has clicked the right mouse button.

Usage:

Event.UI.Input.Mouse.Right.Click(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Click.Bubble

Event.UI.Input.Mouse.Right.Click.Bubble@summary

Usage:

Event.UI.Input.Mouse.Right.Click.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Click.Dive

Event.UI.Input.Mouse.Right.Click.Dive@summary

Usage:

Event.UI.Input.Mouse.Right.Click.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Down

Signals that the user has pressed the right mouse button.

Usage:

Event.UI.Input.Mouse.Right.Down(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Down.Bubble

Event.UI.Input.Mouse.Right.Down.Bubble@summary

Usage:

Event.UI.Input.Mouse.Right.Down.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Down.Dive

Event.UI.Input.Mouse.Right.Down.Dive@summary

Usage:

Event.UI.Input.Mouse.Right.Down.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Up

Signals that the user has released the right mouse button.

Usage:

Event.UI.Input.Mouse.Right.Up(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Up.Bubble

Event.UI.Input.Mouse.Right.Up.Bubble@summary

Usage:

Event.UI.Input.Mouse.Right.Up.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Up.Dive

Event.UI.Input.Mouse.Right.Up.Dive@summary

Usage:

Event.UI.Input.Mouse.Right.Up.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Upoutside

Signals that the user has released the right mouse button off this frame after pressing it on this frame.

Usage:

Event.UI.Input.Mouse.Right.Upoutside(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Upoutside.Bubble

Event.UI.Input.Mouse.Right.Upoutside.Bubble@summary

Usage:

Event.UI.Input.Mouse.Right.Upoutside.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Right.Upoutside.Dive

Event.UI.Input.Mouse.Right.Upoutside.Dive@summary

Usage:

Event.UI.Input.Mouse.Right.Upoutside.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Back

Signals that the user has moved the mousewheel back.

Usage:

Event.UI.Input.Mouse.Wheel.Back(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Back.Bubble

Event.UI.Input.Mouse.Wheel.Back.Bubble@summary

Usage:

Event.UI.Input.Mouse.Wheel.Back.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Back.Dive

Event.UI.Input.Mouse.Wheel.Back.Dive@summary

Usage:

Event.UI.Input.Mouse.Wheel.Back.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Forward

Signals that the user has moved the mousewheel forwards.

Usage:

Event.UI.Input.Mouse.Wheel.Forward(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Forward.Bubble

Event.UI.Input.Mouse.Wheel.Forward.Bubble@summary

Usage:

Event.UI.Input.Mouse.Wheel.Forward.Bubble(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Input.Mouse.Wheel.Forward.Dive

Event.UI.Input.Mouse.Wheel.Forward.Dive@summary

Usage:

Event.UI.Input.Mouse.Wheel.Forward.Dive(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Layout.Layer

Signals a change in layer.

Usage:

Event.UI.Layout.Layer(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Layout.Move

Signals a change in the top-left corner's position. May be delayed after the actual movement.

Usage:

Event.UI.Layout.Move(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Layout.Size

Signals a change in size. May be delayed after the actual change.

Usage:

Event.UI.Layout.Size(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Layout.Strata

Signals a change in strata.

Usage:

Event.UI.Layout.Strata(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Native.Loaded

Signals a change in this native frame's loaded state.

Usage:

Event.UI.Native.Loaded(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Scrollbar.Change

Signals a change in scrollbar position.

Usage:

Event.UI.Scrollbar.Change(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Scrollbar.Grab

Signals that a scrollbar has been grabbed.

Usage:

Event.UI.Scrollbar.Grab(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Scrollbar.Release

Signals that a scrollbar has been released.

Usage:

Event.UI.Scrollbar.Release(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Slider.Change

Signals a change in slider position.

Usage:

Event.UI.Slider.Change(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Slider.Grab

Signals that a slider has been grabbed.

Usage:

Event.UI.Slider.Grab(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Slider.Release

Signals that a slider has been released.

Usage:

Event.UI.Slider.Release(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Textfield.Change

Signals a change in textfield contents.

Usage:

Event.UI.Textfield.Change(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.UI.Textfield.Select

Signals a change in textfield selection.

Usage:

Event.UI.Textfield.Select(handle)
ParameterTypeDatatypeDescription
handle???variant

Event.Unit.Add

Signals the addition of units to unit specifiers. Always preceded by Event.Unit.Change.Remove. Triggers for unit IDs that have been removed from the specifier tree, but may not trigger for any children of those units. You may want to use LibUnitChange instead of this event.

Usage:

Event.Unit.Add(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Event.Unit.Availability.Full

Signals units entering Full availability.

Usage:

Event.Unit.Availability.Full(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Event.Unit.Availability.None

Signals units leaving availability entirely.

Usage:

Event.Unit.Availability.None(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Event.Unit.Availability.Partial

Signals units entering Partial availability, possibly on the way to Full or None availability.

Usage:

Event.Unit.Availability.Partial(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Event.Unit.Castbar

Signals a unit's castbar changing.

Usage:

Event.Unit.Castbar(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is a castbar visibility flag.

Event.Unit.Detail.Absorb

Signals a unit's damage absorption changing.

Usage:

Event.Unit.Detail.Absorb(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Afk

Signals a unit's AFK flag changing. Will trigger only for partymembers.

Usage:

Event.Unit.Detail.Afk(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Aggro

Signals a unit's aggro flag changing. Will trigger only for groupmembers.

Usage:

Event.Unit.Detail.Aggro(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Blocked

Signals a unit's LOS-blocked flag changing. Will trigger only for groupmembers.

Usage:

Event.Unit.Detail.Blocked(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Charge

Signals a unit's charge changing. Will trigger only for the player's unit ID.

Usage:

Event.Unit.Detail.Charge(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.ChargeMax

Signals a unit's charge maximum changing. Will trigger only for the player's unit ID.

Usage:

Event.Unit.Detail.ChargeMax(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Combat

Signals a unit's combat status changing.

Usage:

Event.Unit.Detail.Combat(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Combo

Signals a unit's combo points changing. Will trigger only for the player's unit ID.

Usage:

Event.Unit.Detail.Combo(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Coord

Signals a change in the unit's location.

Usage:

Event.Unit.Detail.Coord(x, y, z)
ParameterTypeDatatypeDescription
xparametervariantThe new X coordinate of the changed elements. Takes the form of a table. The key is the element ID.
yparameter<nope>The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID.
zparameter<nope>The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID.

Event.Unit.Detail.Energy

Signals a unit's energy changing.

Usage:

Event.Unit.Detail.Energy(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.EnergyMax

Signals a unit's energy maximum changing.

Usage:

Event.Unit.Detail.EnergyMax(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Guild

Signals a unit's guild changing.

Usage:

Event.Unit.Detail.Guild(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Health

Signals a unit's health changing.

Usage:

Event.Unit.Detail.Health(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.HealthCap

Signals a unit's health cap changing.

Usage:

Event.Unit.Detail.HealthCap(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.HealthMax

Signals a unit's health maximum changing.

Usage:

Event.Unit.Detail.HealthMax(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Level

Signals a unit's level changing.

Usage:

Event.Unit.Detail.Level(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.LocationName

Signals a unit's location name changing.

Usage:

Event.Unit.Detail.LocationName(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Mana

Signals a unit's mana changing.

Usage:

Event.Unit.Detail.Mana(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.ManaMax

Signals a unit's mana maximum changing.

Usage:

Event.Unit.Detail.ManaMax(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Mark

Signals a unit's mark changing.

Usage:

Event.Unit.Detail.Mark(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Mentoring

Signals a unit's mentoring status changing.

Usage:

Event.Unit.Detail.Mentoring(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Name

Signals a unit's name changing.

Usage:

Event.Unit.Detail.Name(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Offline

Signals a unit's offline flag changing. Will trigger only for partymembers.

Usage:

Event.Unit.Detail.Offline(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Planar

Signals a unit's planar charges changing. Will trigger only for the player or groupmembers.

Usage:

Event.Unit.Detail.Planar(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.PlanarMax

Signals a unit's maximum planar charges changing. Will trigger only for the player or groupmembers.

Usage:

Event.Unit.Detail.PlanarMax(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Power

Signals a unit's power changing.

Usage:

Event.Unit.Detail.Power(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.PublicSize

Signals a unit's public group size or status changing.

Usage:

Event.Unit.Detail.PublicSize(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Pvp

Signals a unit's PvP flag changing.

Usage:

Event.Unit.Detail.Pvp(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Radius

Signals a unit's radius changing.

Usage:

Event.Unit.Detail.Radius(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Ready

Signals a unit's readycheck status changing.

Usage:

Event.Unit.Detail.Ready(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or the string "nil" in place of nil.

Event.Unit.Detail.Role

Signals a unit's role changing. Will trigger only for the player or partymembers.

Usage:

Event.Unit.Detail.Role(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.Tagged

Signals a unit's tagged status changing.

Usage:

Event.Unit.Detail.Tagged(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.TitlePrefixId

Signals a unit's title prefix ID changing.

Usage:

Event.Unit.Detail.TitlePrefixId(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.TitlePrefixName (deprecated)

Signals a unit's localized title prefix changing.

Usage:

Event.Unit.Detail.TitlePrefixName(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
deprecated
standard

Event.Unit.Detail.TitleSuffixId

Signals a unit's title suffix ID changing.

Usage:

Event.Unit.Detail.TitleSuffixId(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Detail.TitleSuffixName (deprecated)

Signals a unit's localized title suffix changing.

Usage:

Event.Unit.Detail.TitleSuffixName(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.
deprecated
standard

Event.Unit.Detail.Vitality

Signals a unit's vitality changing. Will trigger only for the player or groupmembers.

Usage:

Event.Unit.Detail.Vitality(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Warfront

Signals a unit's warfront flag changing. Will trigger only for partymembers.

Usage:

Event.Unit.Detail.Warfront(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value.

Event.Unit.Detail.Zone

Signals a change in the unit's zone.

Usage:

Event.Unit.Detail.Zone(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Unit.Remove

Signals the removal of units from unit specifiers. Always followed by Event.Unit.Change.Add. Triggers for unit IDs that have been removed from the specifier tree, but may not trigger for any children of those units. You may want to use LibUnitChange instead of this event.

Usage:

Event.Unit.Remove(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable of the units changed. Key is the unit ID, value is the unit specifier, or "false" if the unit now has no specifier.

Frame

A UI element of type Frame or derived from Frame.

Frame.Event:KeyDown

Signals a key pressed.

Usage:

Frame.Event:KeyDown(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Frame.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

Frame.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

Frame.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Frame.Event:KeyRepeat(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Frame.Event:KeyType

Signals text typed.

Usage:

Frame.Event:KeyType(typed)
ParameterTypeDatatypeDescription
typedparametervariantThe text.

Frame.Event:KeyUp

Signals a key released.

Usage:

Frame.Event:KeyUp(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Frame.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

Frame.Event:LeftClick

Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftClick()

Frame.Event:LeftDown

Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftDown()

Frame.Event:LeftUp

Signals that the mouse's left button has been released inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUp()

Frame.Event:LeftUpoutside

Signals that the mouse's left button has been released outside the frame, after a "Down" message. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUpoutside()

Frame.Event:MiddleClick

Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleClick()

Frame.Event:MiddleDown

Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleDown()

Frame.Event:MiddleUp

Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUp()

Frame.Event:MiddleUpoutside

Signals that the mouse's middle button has been released outside the frame, after a "Down" message. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUpoutside()

Frame.Event:Mouse4Click

Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Click()

Frame.Event:Mouse4Down

Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Down()

Frame.Event:Mouse4Up

Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Up()

Frame.Event:Mouse4Upoutside

Signals that the mouse's fourth button has been released outside the frame, after a "Down" message. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Upoutside()

Frame.Event:Mouse5Click

Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Click()

Frame.Event:Mouse5Down

Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Down()

Frame.Event:Mouse5Up

Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Up()

Frame.Event:Mouse5Upoutside

Signals that the mouse's fifth button has been released outside the frame, after a "Down" message. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Upoutside()

Frame.Event:MouseIn

Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseIn()

Frame.Event:MouseMove

Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseMove(x, y)
ParameterTypeDatatypeDescription
xparametervariantX coordinate.
yparameter<nope>Y coordinate.

Frame.Event:MouseOut

Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseOut()

Frame.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

Frame.Event:RightClick

Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightClick()

Frame.Event:RightDown

Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightDown()

Frame.Event:RightUp

Signals that the mouse's right button has been released inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUp()

Frame.Event:RightUpoutside

Signals that the mouse's right button has been released outside the frame, after a "Down" message. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUpoutside()

Frame.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

Frame.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

Frame.Event:WheelBack

Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelBack()

Frame.Event:WheelForward

Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelForward()

Frame:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()
noSecureFrameAndEnvironment
true

Frame:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()
noSecureFrameAndEnvironment
true

Frame:ClearPoint

Clear a set point from this frame.

Usage:

Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate.
xparameternumber/nilX coordinate of the point.
yparameternumber/nilY coordinate of the point.
noSecureFrameAndEnvironment
true

Frame:ClearWidth

Clear a set width from this frame.

Usage:

Frame:ClearWidth()
noSecureFrameAndEnvironment
true

Frame:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

Frame:EventDetach

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.

Usage:

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

Frame:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro The macro that will run when the event fires.
owner Owner to search for.
priority Priority of the event handler. Higher numbers trigger first.

Frame:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

Frame:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

Frame:GetAlpha

Gets the alpha multiplier of this frame.

Usage:

alpha = Element:GetAlpha()
ParameterTypeDatatypeDescription
alpharesultnumberThe alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.

Frame:GetBackgroundColor

Retrieves the background color of this frame.

Usage:

r, g, b, a = Element:GetBackgroundColor()
ParameterTypeDatatypeDescription
aresultnumberAlpha. 1 is fully opaque, 0 is fully transparent.
bresultnumberBlue.
gresultnumberGreen.
rresultnumberRed.

Frame:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

Frame:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

Frame:GetChildren

Returns a table containing all of this element's children.

Usage:

children = Element:GetChildren()
ParameterTypeDatatypeDescription
childrenresulttableA table containing this element's children.

Frame:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

Frame:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

Frame:GetKeyFocus

Gets the key focus status.

Usage:

focus = Element:GetKeyFocus()
ParameterTypeDatatypeDescription
focusresultbooleanWhether this frame is the current key focus.

Frame:GetLayer

Gets the frame's layer order.

Usage:

layer = Frame:GetLayer()
ParameterTypeDatatypeDescription
layerresultnumberThe render layer of this frame. See Frame:SetLayer for details.

Frame:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

Frame:GetMouseMasking

Get the current mouse masking mode. See SetMouseMasking for details.

Usage:

mask = Element:GetMouseMasking()
ParameterTypeDatatypeDescription
maskresultstringThe current mouse masking mode.

Frame:GetMouseoverUnit

Gets the unit that is being represented by this frame.

Usage:

unit = Frame:GetMouseoverUnit()
ParameterTypeDatatypeDescription
unitresultstringThe current mouseover unit. May be nil if there is no mouseover unit.

Frame:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

Frame:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

Frame:GetParent

Gets the parent of this frame.

Usage:

parent = Frame:GetParent()
ParameterTypeDatatypeDescription
parentresultElementThe parent element of this frame.

Frame:GetRight

Retrieves the X position of the right edge of this element.

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

Frame:GetSecureMode

Get the current secure mode. See SetSecureMode for details.

Usage:

secure = Frame:GetSecureMode()
ParameterTypeDatatypeDescription
secureresultstringThe current secure mode.

Frame:GetStrata

Gets the frame's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.

Usage:

strata = Frame:GetStrata()
ParameterTypeDatatypeDescription
strataresultstringThe item's current strata.

Frame:GetStrataList

Gets a list of valid stratas for this frame.

Usage:

stratas = Frame:GetStrataList()
ParameterTypeDatatypeDescription
stratasresulttableAn array of valid stratas, in order.

Frame:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

Frame:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

Frame:GetVisible

Gets the visibility flag for this frame.

Usage:

visible = Element:GetVisible()
ParameterTypeDatatypeDescription
visibleresultbooleanThis frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.

Frame:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

Frame:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

Frame:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

Frame:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

Frame:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

Frame:SetAllPoints

Pins all the edges of this frame to the edges of a different frame. If no target is given, defaults to this frame's parent.

Usage:

Frame:SetAllPoints()
Frame:SetAllPoints(target)
ParameterTypeDatatypeDescription
targetparameterLayoutTarget Layout to pin this frame's edges to.
noSecureFrameAndEnvironment
true

Frame:SetAlpha

Sets the alpha transparency multiplier for this frame and its children.

Usage:

Element:SetAlpha(alpha)
ParameterTypeDatatypeDescription
alphaparameternumberThe new alpha multiplier. 1 is fully opaque, 0 is fully transparent.

Frame:SetBackgroundColor

Sets the background color of this frame.

Usage:

Element:SetBackgroundColor(r, g, b)
Element:SetBackgroundColor(r, g, b, a)
ParameterTypeDatatypeDescription
aparameternumberAlpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
bparameternumberBlue.
gparameternumberGreen.
rparameternumberRed.

Frame:SetHeight

Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.

Usage:

Frame:SetHeight(height)
ParameterTypeDatatypeDescription
heightparameternumberThe new height of this frame.
noSecureFrameAndEnvironment
true

Frame:SetKeyFocus

Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on another frame will automatically unset the current focus.

Usage:

Element:SetKeyFocus(focus)
ParameterTypeDatatypeDescription
focusparameterbooleanThe new key focus setting.

Frame:SetLayer

Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but guarantees no Z-fighting. Frames are always drawn after their parents.

Usage:

Frame:SetLayer(layer)
ParameterTypeDatatypeDescription
layerparameternumberThe new layer for this frame.
noSecureFrameAndEnvironment
true

Frame:SetMouseMasking

Sets the frame's mouse masking mode.

Usage:

Element:SetMouseMasking(mask)
ParameterTypeDatatypeDescription
maskparameterstringThe new mouse masking mode. "full" is the standard mode, and means that creating any Left, Right, or movement-related mouse event will cause the frame to accept and consume any event from any of those types. "limited" causes the frame to accept and consume only events for buttons that have been hooked, so that hooking "LeftDown" will still pass Right mouse events through the frame. Note that hooking any mouse event will still consume MouseMove/In/Out events.
noSecureFrameAndEnvironment
true

Frame:SetMouseoverUnit

Sets the unit that will be represented by this frame.

Usage:

Frame:SetMouseoverUnit(unit)
ParameterTypeDatatypeDescription
unitparameternil, unitThe new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
requireSecureFrameAndInsecureEnvironment
true

Frame:SetParent

Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame's secure mode is "restricted", then its parent must also have a secure mode of "restricted".

Usage:

Frame:SetParent(parent)
ParameterTypeDatatypeDescription
parentparameterElementThe new parent for this frame.
noSecureFrameAndEnvironment
true

Frame:SetPoint

Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it.
This function can take many different forms. In general, it looks like this: SetPoint(point_on_this_frame, target_frame, point_on_target_frame [, x_offset, y_offset]).
The first part is the point on this frame that will be attached. Usually, these are string identifiers. "TOPLEFT", "TOPCENTER", "TOPRIGHT", "CENTERLEFT", "CENTER", "CENTERRIGHT", "BOTTOMLEFT", "BOTTOMCENTER", "BOTTOMRIGHT". You may also use a string identifier that refers to a single axis - "TOP", "BOTTOM", "LEFT", "RIGHT", "CENTERX", "CENTERY". If you want more direct numeric control you can use number pairs. 0,0 is equivalent to "TOPLEFT", 1,1 is equivalent to "BOTTOMRIGHT", 0.5,nil is equivalent to "CENTERX".
The second part is the frame to attach to, as well as the point on that frame to attach to. The frame is simply passing in the frame table. The point is the same identifier or number pair as the first parameter.
Optionally, you may include an X or Y offset to the point.
This connection is permanent, and if the target frame moves, this frame will move along with it.
Caveat: If the target is a frame set to the "restricted" SecureMode, and the client is currently in "secure" mode, then unexpected behavior may occur.

Usage:

Frame:SetPoint(...)
ParameterTypeDatatypeDescription
...parameter...This function's parameters are complicated. Read the above summary for details.
noSecureFrameAndEnvironment
true

Frame:SetSecureMode

Sets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
If you are not planning to use any restricted functions, your frame should remain in normal mode.
At the moment, it is not possible to change from "restricted" back to "normal".

Usage:

Frame:SetSecureMode(secure)
ParameterTypeDatatypeDescription
secureparameterstringThe new secure mode. Valid inputs are "normal" and "restricted".

Frame:SetStrata

Sets the strata for this frame.

Usage:

Frame:SetStrata(strata)
ParameterTypeDatatypeDescription
strataparameterstringThe item's new strata. Must be one of the elements returned by :GetStrataList().
noSecureFrameAndEnvironment
true

Frame:SetVisible

Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.

Usage:

Element:SetVisible(visible)
ParameterTypeDatatypeDescription
visibleparameterbooleanThe new visibility flag.
noSecureFrameAndEnvironment
true

Frame:SetWidth

Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.

Usage:

Frame:SetWidth(width)
ParameterTypeDatatypeDescription
widthparameternumberThe new width of this frame.
noSecureFrameAndEnvironment
true

Inspect.Ability.New.Detail

Provides detailed information about abilities.

Usage:

detail = Inspect.Ability.New.Detail(ability)
details = Inspect.Ability.New.Detail(abilities)
ParameterTypeDatatypeDescription
abilitiesparametertableA table of identifiers of abilities to retrieve detail for.
abilityparameterabilityThe identifier of the ability to retrieve detail for.
detailresulttableDetail table for a single ability.
detailsresulttableDetail tables for all requested abilities. The key is the ability ID, the value is the ability's detail table.
members
autoattack Autoattack mode of the ability.
castingTime Casting time of the ability, in seconds.
channeled Signals that the ability is channeled.
continuous Signals that the ability is continuous.
cooldown Cooldown of the ability, in seconds.
costCharge The amount of charge this ability consumes on use.
costEnergy The amount of energy this ability consumes on use.
costMana The amount of mana this ability consumes on use.
costPlanarCharge The amount of planar charges this ability consumes on use.
costPower The amount of power this ability consumes on use.
costSpirit The amount of spirit this ability consumes on use.
currentCooldownBegin The time the current cooldown started, in the context of Inspect.Time.Frame.
currentCooldownDuration Duration of the current cooldown the ability is influenced by, in seconds.
currentCooldownExpired Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
currentCooldownPaused Indicates that this ability's cooldown is paused.
currentCooldownRemaining Time remaining in the ability's current cooldown, in seconds.
description Description for the ability.
focusMax The maximum focus to use this ability.
focusMin The minimum focus to use this ability.
gainCharge Amount of charge gained by using the ability.
icon Resource filename of the ability's icon.
id The ID of the requested element.
idNew The new ability ID.
name Name of the ability.
outOfRange Signals that the ability is out of range.
passive Signals that the ability is passive.
positioned Signals that the ability's effect is manually positioned by the user.
racial Signals that the ability is a racial ability.
rangeMax The maximum range of the ability.
rangeMin The minimum range of the ability.
stealthRequired Signals that the ability requires the user to be in stealth.
target The Unit ID of the unit that this ability will be used on if triggered at this moment.
unusable Signals that this ability is unusable.
weapon The required equipped weapon for this ability. May be "any", "melee", or "ranged".

Inspect.Ability.New.List

List available abilities.

Usage:

abilities = Inspect.Ability.New.List()
ParameterTypeDatatypeDescription
abilitiesresulttableA table of IDs of the available abilities.

Inspect.Achievement.Category.Detail

Returns information about achievement categories.

Usage:

detail = Inspect.Achievement.Category.Detail(category)
details = Inspect.Achievement.Category.Detail(categories)
ParameterTypeDatatypeDescription
categoriesparametertableA table of identifiers of achievement categories to retrieve detail for.
categoryparameterachievementcategoryThe identifier of the achievement category to retrieve detail for.
detailresulttableDetail table for a single achievement category.
detailsresulttableDetail tables for all requested achievement categories. The key is the category ID, the value is the category's detail table.
members
id The ID of the requested element.
name The name of the achievement category.
parent The category's parent, if it has one.

Inspect.Achievement.Category.List

Returns a table of valid achievement categories.

Usage:

categories = Inspect.Achievement.Category.List()
ParameterTypeDatatypeDescription
categoriesresulttableValid achievement categories, in {id = true} format.

Inspect.Achievement.Detail

Provides detailed information about achievements.

Usage:

detail = Inspect.Achievement.Detail(achievement)
details = Inspect.Achievement.Detail(achievements)
ParameterTypeDatatypeDescription
achievementparameterachievementThe identifier of the achievement to retrieve detail for.
achievementsparametertableA table of identifiers of achievements to retrieve detail for.
detailresulttableDetail table for a single achievement.
detailsresulttableDetail tables for all requested achievements. The key is the achievement ID, the value is the achievement's detail table.
members
alliance The alliance that this achievement requires, either "guardian", "defiant", or nil.
category ID of the achievement's category.
complete true is the achievement is completed by this character. If the achievement has been completed by another of the player's characters, gives that character's name.
description The achievement's description.
icon Internal name of the achievement's icon.
id The ID of the requested element.
name The achievement's name.
previous The ID of the achievement immediately previous to this in a chain.
requirement Table listing the requirements for this achievement. Each item may include multiple members.
type: The type of the requirement. Valid values include "achievement", "artifactset", "discover", "event", "quest", and "tradeskill".
name: The name of the requirement.
count: The count required for completion.
countDone: The count already completed.
complete: Signals that this requirement is complete.
id: The id of whatever this requires.
score The number of points this achievement awards for completion.
sort A number indicating the order that this achievement should be sorted in.
title The ID of the title this achievement awards.
watch Signals that this achievement is being watched.

Inspect.Achievement.List

Returns a table of all known achievements.

Usage:

achievements = Inspect.Achievement.List()
ParameterTypeDatatypeDescription
achievementsresulttableAll known achievements, in {id = true} format.

Inspect.Addon.Cpu

Returns recent CPU usage information. This is calculated using an exponential-falloff method.

Usage:

data = Inspect.Addon.Cpu()
ParameterTypeDatatypeDescription
dataresulttableRecent CPU usage. This takes the format { AddonIdentifier = { SubIdentifier = cpu_used_as_a_fraction_of_one } }. SubIdentifiers are generated by Rift and the format may change without notice.

Inspect.Addon.Current

Returns the current addon. This information is used internally for counting CPU usage and determining frame ownership.

Usage:

addonIdentifier = Inspect.Addon.Current()
ParameterTypeDatatypeDescription
addonIdentifierresultstringThe addon's identifier, as written in its TOC file.

Inspect.Addon.Detail

Provides detailed information about loaded addons.

Usage:

detail = Inspect.Addon.Detail(addon)
details = Inspect.Addon.Detail(addons)
ParameterTypeDatatypeDescription
addonparameterstringAn addon identifier.
addonsparametertableA table containing addon identifiers.
detailresulttableDetail table for a single addon.
detailsresulttableDetail tables for all requested addons. The key is the addon identifier, the value is the addon's detail table.
members
data The "data" table provided to the addon at load time.
description The chosen localization of the TOC Description field.
id The ID of the requested element.
identifier The addon's identifier.
name The chosen localization of the TOC Name field.
nameShort The chosen localization of the TOC NameShort field.
toc The addon's RiftAddon.toc file, parsed and in table form.

Inspect.Addon.List

Lists all the addons that the client has loaded.

Usage:

addons = Inspect.Addon.List()
ParameterTypeDatatypeDescription
addonsresulttableMap of addon identifier to addon version, or "true" if no version is provided.

Inspect.Attunement.Progress

Returns information on your current attunement progress.

Usage:

result = Inspect.Attunement.Progress()
ParameterTypeDatatypeDescription
resultresulttableTable containing information on attunement progress.
members
accumulated Attunement experience accumulated so far in this attunement level.
available Number of unused attunement ranks.
needed Quantity of attunement experience needed to gain a level.
rested Quantity of available attunement rested experience.
spent Number of spent attunement ranks.

Inspect.Auction.Detail

Provides detailed information about auctions.

Usage:

Interaction category: auction

detail = Inspect.Auction.Detail(auction)
details = Inspect.Auction.Detail(auctions)
ParameterTypeDatatypeDescription
auctionparameterauctionAn identifier for the auction to retrieve detail for.
auctionsparametertableA table containing auction identifiers to retrieve details for. The value is the sort order.
detailresulttableDetail table for a single auction.
detailsresulttableDetail tables for all requested auctions. The key is the auction ID, the value is the auction's detail table.
members
bid The current bid on this auction, in silver.
bidder Current high bidder on this auction. Available only if your current character is the bidder or the seller.
buyout The buyout amount for this auction, in silver.
id The ID of the requested element.
item ID of the item involved in the auction.
itemStack The size of this item stack.
itemType The item's type specifier.
partial Whether partial buyouts are permitted.
remaining Time remaining in the auction, as a number of seconds.
seller The name of the auction's seller.

Inspect.Buff.Detail

Provides detailed information about the buffs on a unit.

Usage:

detail = Inspect.Buff.Detail(unit, buff)
details = Inspect.Buff.Detail(unit, buffs)
ParameterTypeDatatypeDescription
buffparameterbuffAn identifier for the buff to retrieve detail for.
buffsparametertableA table containing buff identifiers to retrieve details for.
unitparameterunitThe unit to inspect.
detailresulttableDetail table for a single buff.
detailsresulttableDetail tables for all requested buffs. The key is the buff ID, the value is the buff's detail table.
members
ability The ID of the ability that created this buff. Not guaranteed to exist.
begin The time the buff started, in the context of Inspect.Time.Frame.
caster Unit ID of the buff's caster.
curse Signals that the buff is a curse.
debuff Signals that the buff is a debuff. If this is missing, then it's an actual buff.
description Description for the buff. Numbers may not be accurate - see Command.Buff.Describe().
descriptionComplete Signals that the buff description is complete.
disease Signals that the buff is a disease.
duration Duration of the buff in seconds.
expired Number of seconds the buff is past its expiration time. Generally indicates lag.
icon Resource filename of the buff's icon.
id The ID of the requested element.
name Name of the buff.
noncancelable Signals that the buff cannot be voluntarily canceled. Does not show up for debuffs.
poison Signals that the buff is a poison.
remaining Time remaining on the buff, in seconds.
rune If this buff is created by a rune, the ID of the rune causing it.
stack Number of stacks on the buff.
type The buff type ID.

Inspect.Buff.List

List buffs on a unit.

Usage:

buffs = Inspect.Buff.List(unit)
ParameterTypeDatatypeDescription
unitparameterunitThe unit to inspect.
buffsresulttableA table of the IDs of the buffs on the unit.

Inspect.Console.Detail

Provides detailed information about consoles.

Usage:

detail = Inspect.Console.Detail(console)
details = Inspect.Console.Detail(consoles)
ParameterTypeDatatypeDescription
consoleparameterconsoleThe identifier of the console to retrieve information for. May also be "general" or "combat".
consolesparametertableA table of consoles to retrieve detail for.
detailresulttableDetail table for a single console.
detailsresulttableDetail tables for all requested consoles.
members
accolade Indicates that this console displays Accolade messages.
achievement Indicates that this console displays Achievement messages.
channel May contain a table of public channels that this console will display. nil if the console does not display any public channels.
combatBad Indicates that this console displays Combat Bad messages.
combatGood Indicates that this console displays Combat Good messages.
combatNeutral Indicates that this console displays Combat Neutral messages.
combatOther Indicates that this console displays Combat Other messages.
combatSpecial Indicates that this console displays Combat Special messages.
craftingOther Indicates that this console displays Crafting Others messages.
craftingSelf Indicates that this console displays Crafting Self messages.
emote Indicates that this console displays Emote messages.
experience Indicates that this console displays Experience messages.
guild Indicates that this console displays Guild messages.
id The ID of the requested element.
lootGroup Indicates that this console displays Group Loot messages.
lootItem Indicates that this console displays Item Loot messages.
lootMoney Indicates that this console displays Money Loot messages.
name The player-chosen name of the console.
notoriety Indicates that this console displays Notoriety messages.
npc Indicates that this console displays NPC messages.
officer Indicates that this console displays Officer messages.
party Indicates that this console displays Party messages.
purchase Indicates that this console displays Purchase messages.
raid Indicates that this console displays Raid messages.
raidWarning Indicates that this console displays Raid Warning messages.
say Indicates that this console displays Say messages.
skill Indicates that this console displays Skill messages.
system Indicates that this console displays System messages.
tell Indicates that this console displays Tell messages.
twitter Indicates that this console displays Twitter messages.
yell Indicates that this console displays Yell messages.

Inspect.Console.List

Returns a table of the current open text consoles.

Usage:

consoles = Inspect.Console.List()
ParameterTypeDatatypeDescription
consolesresulttableA table containing the IDs of the available consoles.

Inspect.Currency.Category.Detail

Returns information about currency categories.

Usage:

detail = Inspect.Currency.Category.Detail(category)
details = Inspect.Currency.Category.Detail(categories)
ParameterTypeDatatypeDescription
categoriesparametertableA table of identifiers of currency categories to retrieve detail for.
categoryparametercurrencycategoryThe identifier of the currency category to retrieve detail for.
detailresulttableDetail table for a single currency category.
detailsresulttableDetail tables for all requested currency categories. The key is the category ID, the value is the category's detail table.
members
id The ID of the requested element.
name The name of the currency category.

Inspect.Currency.Category.List

Returns a table of valid currency categories.

Usage:

categories = Inspect.Currency.Category.List()
ParameterTypeDatatypeDescription
categoriesresulttableValid currency categories, in {id = true} format.

Inspect.Currency.Detail

Provides detailed information about currencies.

Usage:

detail = Inspect.Currency.Detail(coin)
detail = Inspect.Currency.Detail(currency)
details = Inspect.Currency.Detail(currencies)
ParameterTypeDatatypeDescription
coinparameterstringThe string "coin", used as a value to request the player's money.
currenciesparametertableA table of identifiers of currencies to retrieve detail for.
currencyparameteritemtypeThe identifier of the currency to retrieve detail for.
detailresulttableDetail table for a single currency.
detailsresulttableDetail tables for all requested currencies. The key is the currency ID, the value is the currency's detail table.
members
category ID of the currency's category.
icon Internal name of the currency's icon.
id The ID of the requested element.
name The currency's name.
stack The number of this currency that you have.
stackMax The maximum number of this currency that you can have.

Inspect.Currency.List

Returns a table of all known currencies.

Usage:

currencies = Inspect.Currency.List()
ParameterTypeDatatypeDescription
currenciesresulttableAll known currencies, in {id = amount} format.

Inspect.Cursor

Returns the current contents of the cursor.

Usage:

type, held = Inspect.Cursor()
ParameterTypeDatatypeDescription
heldresultvariant, nilThe blob describing what is currently held. Generally, some kind of identifier used in another part of the addon system.
typeresultstring, nilThe current cursor type. Valid values include "ability", "item", "itemtype", and nil.

Inspect.Dimension.Layout.Detail

Returns details about the specified dimension item.

Usage:

detail = Inspect.Dimension.Layout.Details(dimensionitem)
details = Inspect.Dimension.Layout.Details(dimensionitems)
ParameterTypeDatatypeDescription
dimensionitemparameterdimensionitemThe identifier of the dimension item to retrieve detail for.
dimensionitemsparametertableA table of identifiers of dimension items to retrieve detail for.
detailresulttableTable of details about the dimension item specified.
detailsresulttableDetail table for all requsted dimension items. The key is the dimension item ID, the value is the dimension item's detail table.
members
coordX The X coordinate of the item.
coordY The Y coordinate of the item.
coordZ The Z coordinate of the item.
crated Indicates that the item is crated.
icon Resource filename of the item's icon.
id The item's id.
name The name of the item.
pitch The pitch of the item.
roll The roll of the item.
scale The scale of the item.
selected Indicates that the item is selected.
type The type of the item.
yaw The yaw of the item.

Inspect.Dimension.Layout.List

Returns a list of dimension items in the dimension you're currently in, and whether or not they are crated.

Usage:

list = Inspect.Dimension.Layout.List()
ParameterTypeDatatypeDescription
listresulttableThe list of detail results.

Inspect.Documentation

Provide documentation on items in the addon environment. Called with no parameters, it returns a table listing all documentation. Can provide both human-readable and computer-readable documentation.

Usage:

documentables = Inspect.Documentation()
documentation = Inspect.Documentation(item)
documentation = Inspect.Documentation(item, parseable)
documentationTable = Inspect.Documentation(item, parseable)
ParameterTypeDatatypeDescription
itemparametervariantThe item to get documentation on. May be either the item itself or a string identifier.
parseableparameterbooleanWhether to return in a computer-readable format, as opposed to the normal human-readable format.
documentablesresulttableList of all items that documentation can be retrieved for. In {["itemname"] = true} format.
documentationresultstringDocumentation for the requested item.
documentationTableresulttableComputer-readable documentation for the requested item. Format may change without warning.
members
(other) May include many other parameters. These parameters are not yet documented.
disabled Boolean that indicates whether this function is disabled for deprecation reasons.
readable Human-readable string version of this documentation.

Inspect.Event.List

Lists the current event handlers for an event.

Usage:

result = Inspect.Event.List(event)
ParameterTypeDatatypeDescription
eventparametereventGlobalA global event handle, usually pulled out of the "Event." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Label assigned to the event handler at creation.
owner Owner addon for the event handler.
priority Priority for the event handler.

Inspect.Experience

Returns information on your experience.

Usage:

result = Inspect.Experience()
ParameterTypeDatatypeDescription
resultresulttableTable containing information on experience.
members
accumulated Experience accumulated so far in this character level.
needed Quantity of experience needed to gain a level.
rested Quantity of available rested experience.

Inspect.Faction.Detail

Provides detailed information about factions.

Usage:

detail = Inspect.Faction.Detail(faction)
details = Inspect.Faction.Detail(factions)
ParameterTypeDatatypeDescription
factionparameterfactionThe identifier of the faction to retrieve detail for.
factionsparametertableA table of identifiers of factions to retrieve detail for.
detailresulttableDetail table for a single faction.
detailsresulttableDetail tables for all requested factions. The key is the faction ID, the value is the faction's detail table.
members
categoryName Name of the faction's category.
id The ID of the requested element.
name The faction's name.
notoriety The current notoriety you have with this faction.

Inspect.Faction.List

Returns a table of all known factions.

Usage:

factions = Inspect.Faction.List()
ParameterTypeDatatypeDescription
factionsresulttableAll known factions, in {id = notoriety} format.

Inspect.Guild.Bank.Coin

Returns the amount of money contained within the guild bank.

Usage:

Interaction category: guildbank

coin = Inspect.Guild.Bank.Coin()
ParameterTypeDatatypeDescription
coinresultnumberThe current money in the guild bank, in silver.

Inspect.Guild.Bank.Detail

Provides detailed information about guild bank vaults.

Usage:

detail = Inspect.Guild.Bank.Detail(guildvault)
details = Inspect.Guild.Bank.Detail(guildvaults)
ParameterTypeDatatypeDescription
guildvaultparameterslotA slot specifier representing the entire guild bank vault to retrieve information for.
guildvaultsparametertableA table of slot specifiers, each representing an entire guild bank vault, to retrieve information for.
detailresulttableDetail table for a guild bank vault.
detailsresulttableDetail tables for all requested guild bank vault. The key is the vault specifier, the value is the vault's detail table.
members
id The ID of the requested element.
name The name of the vault.

Inspect.Guild.Bank.List

Returns a table of all available guild bank vaults.

Usage:

list = Inspect.Guild.Bank.List()
ParameterTypeDatatypeDescription
listresulttableAll available guild vaults, in {id = name} format.

Inspect.Guild.Motd

Returns the current guild Message of the Day.

Usage:

motd = Inspect.Guild.Motd()
ParameterTypeDatatypeDescription
motdresultstringThe current Message of the Day.

Inspect.Guild.Rank.Detail

Provides detailed information about guild ranks.

Usage:

detail = Inspect.Guild.Rank.Detail(guildrank)
details = Inspect.Guild.Rank.Detail(guildranks)
ParameterTypeDatatypeDescription
guildrankparameterguildrankThe identifier of the rank to retrieve detail for.
guildranksparametertableA table of identifiers of ranks to retrieve detail for.
detailresulttableDetail table for a single rank.
detailsresulttableDetail table for all requested ranks. The key is the rank ID, the value is the rank's detail table.
members
addonStorageDelete Signals that this rank has permission to modify or delete addon storage elements.
addonStorageWrite Signals that this rank has permission to non-destructively write addon storage elements.
demote Signals that this rank has permission to demote guildmembers.
finderEdit Signals that this rank has permission to edit the Guild Finder settings.
finderReceive Signals that this rank has permission to receive Guild Finder messages.
id The ID of the requested element.
invite Signals that this rank has permission to invite new guildmembers.
kick Signals that this rank has permission to kick guildmembers.
listen Signals that this rank has permission to listen to guild chat.
motd Signals that this rank has permission to change the guild Message of the Day.
name The name of this rank.
noteOfficer Signals that this rank has permission to view and edit Officer Notes.
officer Signals that this rank has permission to listen to and speak in officer chat.
perk Signals that this rank has permission to choose guild perks.
promote Signals that this rank has permission to promote guildmembers.
questAbandon Signals that this rank has permission to abandon guild quests.
questAccept Signals that this rank has permission to accept guild quests.
questComplete Signals that this rank has permission to complete guild quests.
rally Signals that this rank has permission to set the guild rally point.
rankEdit Signals that this rank has permission to edit rank permissions.
rename Signals that this rank has permission to rename the guild.
speak Signals that this rank has permission to speak in guild chat.
vaultAccess A table containing information on vault access permissions. The key is the vault ID in slot format. The value is a table containing two members, "access" which may be nil, "deposit", or "full", and "withdrawLimit" which gives the number of stacks that may be withdrawn daily.
vaultBuy Signals that this rank has permission to buy guild vaults.
vaultRename Signals that this rank has permission to rename guild vaults.
wallDelete Signals that this rank has permission to delete entries off the Guild Wall.
wallPost Signals that this rank has permission to post to the Guild Wall.

Inspect.Guild.Rank.List

Lists available guild ranks.

Usage:

list = Inspect.Guild.Rank.List()
ParameterTypeDatatypeDescription
listresulttableA table of the IDs of the available ranks. The value is the rank's name.

Inspect.Guild.Roster.Detail

Provides detailed information about guildmembers.

Usage:

detail = Inspect.Guild.Roster.Detail(guildmember)
details = Inspect.Guild.Roster.Detail(guildmembers)
ParameterTypeDatatypeDescription
guildmemberparameterstringThe name of the guildmember to retrieve data for.
guildmembersparametertableA table of names of guildmembers to retrieve data for.
detailresulttableDetail table for a single guildmember.
detailsresulttableDetail tables for all requested guildmembers. The key is the guildmember's name, the value is the guildmember's detail table.
members
id The ID of the requested element.
level The guildmember's level.
logout The guildmember's last logout time, in UNIX time.
name The guildmember's name.
note The guildmember's public note.
noteOfficer The guildmember's officer note.
rank The guildmember's rank.
score The guildmember's achievement score.
status The guildmember's current status. May include "online" or "mobile". nil if the guildmember is offline.
zone The guildmember's current zone, if online.

Inspect.Guild.Roster.List

Lists guildmembers.

Usage:

list = Inspect.Guild.Roster.List()
ParameterTypeDatatypeDescription
listresulttableA table listing all your guildmembers. The key is the guildmember's name, the value is the guildmember's status.

Inspect.Interaction

Provides information about what types of interaction are available.

Usage:

interactions = Inspect.Interaction()
status = Inspect.Interaction(interaction)
ParameterTypeDatatypeDescription
interactionparameterstringOptional name of the interaction type to query. Valid values include "auction", "bank", "guildbank", and "mail".
interactionsresulttableTable from interaction type to indicator of whether that interaction is available.
statusresultbooleanWhether or not that interaction type is available.

Inspect.Item.Detail

Provides detailed information about items.

Usage:

item = Inspect.Item.Detail(item)
item = Inspect.Item.Detail(itemtype)
item = Inspect.Item.Detail(slot)
items = Inspect.Item.Detail(slot)
items = Inspect.Item.Detail(elements)
ParameterTypeDatatypeDescription
elementsparametertableA table of slot specifiers, item IDs, or item types.
itemparameteritem, tableDetail table for a single item.
itemtypeparameteritemtypeA single item type.
slotparameterslotA single slot specifier.
itemresultitem, tableDetail table for a single item.
itemsresulttableDetail tables for all requested items. The key is the string used to lookup, the value is the item's detail table.
members
bind The item's binding type. May be "equip", "use", "pickup", or "account".
bound The item's bound flag.
category The item's type category.
coin The amount of silver this item represents.
cooldown The cooldown for using this item.
cooldownBegin The time the current cooldown started, in the context of Inspect.Time.Frame.
cooldownDuration Duration of the current cooldown the item is influenced by, in seconds.
cooldownExpired Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
cooldownRemaining Time remaining in the item's current cooldown, in seconds.
crafter The name of the player who crafted this item.
damageDelay If a weapon, the delay between autoattacks using this weapon.
damageMax If a weapon, the maximum damage done by a single hit with this item.
damageMin If a weapon, the minimum damage done by a single hit with this item.
damageType If a weapon, the damage type done by autoattacks. Values include "life", "death", "air", "earth", "fire", and "water".
description The description of this item.
flavor The flavor text for this item.
icon Resource filename of the item's icon.
id The ID of the requested element.
lootable Indicates that the item contains loot.
name The item's name.
range If a ranged weapon, the maximum range of this item.
rarity The item's rarity. Values include "sellable", "uncommon", "rare", "epic", "relic", "transcendent", or "quest". Common items have a rarity of nil.
requiredCalling Space-delimited list of the required callings to use this item.
requiredFaction The ID of the faction required to use this item.
requiredFactionLevel The faction notoriety required to use this item.
requiredLevel The level required to use this item.
requiredPrestige The prestige rank required to use this item.
requiredSkill The skill required to use this item.
requiredSkillLevel The skill level required to use this item.
sell The sell value of this item, in silver.
slots If a container, the number of slots that this item can contain.
stack The size of this item stack.
stackMax The maximum size of this item stack.
stats The base stats of this item. Members may include "armor", "block", "critAttack", "critPower", "critSpell", "dexterity", "dodge", "endurance", "energyMax", "energyRegen", "hit", "intelligence", "manaMax", "manaRegen", "movement", "powerAttack", "powerMax", "powerRegen", "powerSpell", "resistAir", "resistAll", "resistDeath", "resistEarth", "resistFire", "resistLife", "resistWater", "stealth", "stealthDetect", "strength", and "wisdom".
statsRune The added rune stats of this item. May contain the same members as stats.
statsRuneTemporary The added temporary rune stats of this item. May contain the same members as stats.
type The item's type specifier.

Inspect.Item.Find

Finds a slot specifier based on an item ID.

Usage:

slot = Inspect.Item.Find(item)
slots = Inspect.Item.Find(items)
ParameterTypeDatatypeDescription
itemparameteritemA single item ID.
itemsparametertableA table of item IDs.
slotresultslotA slot specifier for that item.
slotsresulttableSlot specifiers for all requested items. The key is the string used to lookup, the value is the slot specifier.

Inspect.Item.List

Generate a list of item IDs from a slot specifier or set of slot specifiers.

Usage:

items = Inspect.Item.List()
item = Inspect.Item.List(slot)
items = Inspect.Item.List(slot)
items = Inspect.Item.List(slots)
ParameterTypeDatatypeDescription
slotparameterslotA single slot specifier.
slotsparametertableA table of slot specifiers.
itemresultitemA single item ID. This will be returned only if the input is a single fully-specified slot specifier.
itemsresulttableA table of item IDs. The key is the slot specifier, the value is the item ID.

Inspect.Mail.Detail

Returns information about mail.

Usage:

Interaction category: mail

detail = Inspect.Mail.Detail(mail)
details = Inspect.Mail.Detail(mails)
ParameterTypeDatatypeDescription
mailparametermailThe identifier of the mail to retrieve detail for.
mailsparametertableA table of identifiers of mail to retrieve detail for.
detailresulttableDetail table for a single mail.
detailsresulttableDetail tables for all requested mail. The key is the mail ID, the value is the mail's detail table.
members
attachments The attachments available on this mail. A number if this mail has basic information, or a table of item IDs if this mail has detailed information.
body The body of this mail. Available only if detailed information on the mail has been retrieved.
cod The Cash on Delivery required to retrieve attachments out of this mail message.
expire The time this mail will expire, in Unix timestamp form.
from The name of the character this mail was sent from.
id The ID of the requested element.
read "true" if you have already opened this mail.
spam "true" if this mail is considered spam.
subject The subject line for this mail.

Inspect.Mail.List

Returns a table of valid mail and its status.

Usage:

Interaction category: mail

mails = Inspect.Mail.List()
ParameterTypeDatatypeDescription
mailsresulttableValid mail, in {id = "type"} format. The type may be either "basic" or "detail", indicating whether the mail has been opened and its detailed information is available.

Inspect.Map.Detail

Returns information about map locations.

Usage:

detail = Inspect.Map.Detail(location)
details = Inspect.Map.Detail(locations)
ParameterTypeDatatypeDescription
locationparameterlocationThe identifier of the location to retrieve detail for.
locationsparametertableA table of identifiers of locations to retrieve detail for.
detailresulttableDetail table for a single location.
detailsresulttableDetail tables for all requested locations. The key is the location ID, the value is the location's detail table.
members
coordX The map location's current X coordinate.
coordY The map location's current Y coordinate.
coordZ The map location's current Z coordinate.
description The description of this map location, if it has one.
id The ID of the requested element.
title The title of this map location, if it has one.

Inspect.Map.List

Returns a table of map locations.

Usage:

list = Inspect.Map.List()
ParameterTypeDatatypeDescription
listresulttableValid locations, in {id = true} format.

Inspect.Map.Monitor

Inspects the state of the map monitor flag. See Command.Map.Monitor() for details.

Usage:

monitor = Inspect.Map.Monitor()
ParameterTypeDatatypeDescription
monitorresultbooleanThe current state of the map monitor flag.

Inspect.Map.Waypoint.Get

Gets a unit's current waypoint.

Usage:

x, z = Inspect.Map.Waypoint.Get(unit)
ParameterTypeDatatypeDescription
unitparameterunitA unit, in either unit ID or unit specifier format.
xresultnumberThe x coordinate of the waypoint.
zresultnumberThe z coordinate of the waypoint.

Inspect.Message.Accept.Check

Checks whether a given message type would be accepted if it were sent to you. Parameters can be replaced by "nil" to check for wildcard acceptance.

Usage:

accepted = Inspect.Message.Accept.Check(type, identifier)
ParameterTypeDatatypeDescription
identifierparameterstring/nilThe 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.
typeparameterstring/nilThe type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
acceptedresultbooleanTrue if the message would be transferred to this client.

Inspect.Message.Accept.List

Retrieves the list of accepted message types and identifiers.

Usage:

accepts = Inspect.Message.Accept.List()
ParameterTypeDatatypeDescription
acceptsresulttableList of all accepted message types. Takes the form of a key/value table. The key is a table containing {type, identifier}, where either element may be nil to indicate a wildcard. The value is the number of times this type has been accepted.

Inspect.Minion.Adventure.Detail

Provides detailed information about minion adventures.

Usage:

detail = Inspect.Minion.Adventure.Detail(adventure)
details = Inspect.Minion.Adventure.Detail(adventures)
ParameterTypeDatatypeDescription
adventureparameterminionadventureThe identifier of the minion adventure to retrieve detail for.
adventuresparametertableA table of identifiers of minion adventures to retrieve detail for.
detailresulttableDetail table for a single minion adventure.
detailsresulttableDetail table for all requested minion adventures. The key is the minion adventure ID, the value is the adventure's detail table.
members
completion The time a "working" adventure will change to "finished", represented as UNIX time.
costAventurine The cost to start this adventure in Aventurine.
costCredit The cost to start this adventure in credits.
costStamina The cost to start this adventure in stamina.
duration The duration of this adventure in seconds.
hurryAventurine The cost to hurry this adventure in Aventurine.
hurryCredit The cost to hurry this adventure in credits.
id The ID of the requested element.
minion The minion currently involved with this adventure.
mode The mode this adventure is in. One of "available", "working", or "finished".
name The name of this adventure.
reward The reward type of this adventure.
rewardQuality The final reward quality of this adventure once in "finished" mode.
statAir Indicates greater rewards if finished by a minion with an Air stat.
statArtifact Indicates greater rewards if finished by a minion with an Artifact stat.
statAssassination Indicates greater rewards if finished by a minion with an Assassination stat.
statDeath Indicates greater rewards if finished by a minion with a Death stat.
statDimension Indicates greater rewards if finished by a minion with a Dimension stat.
statDiplomacy Indicates greater rewards if finished by a minion with a Diplomacy stat.
statEarth Indicates greater rewards if finished by a minion with an Earth stat.
statExploration Indicates greater rewards if finished by a minion with an Exploration stat.
statFire Indicates greater rewards if finished by a minion with a Fire stat.
statHarvesting Indicates greater rewards if finished by a minion with a Harvesting stat.
statHunting Indicates greater rewards if finished by a minion with a Hunting stat.
statLife Indicates greater rewards if finished by a minion with a Life stat.
statWater Indicates greater rewards if finished by a minion with a Water stat.

Inspect.Minion.Adventure.List

Lists known minion adventures.

Usage:

list = Inspect.Minion.Adventure.List()
ParameterTypeDatatypeDescription
listresulttableA table of minion adventure IDs. The key is the minion adventure ID.

Inspect.Minion.Minion.Detail

Provides detailed information about minions.

Usage:

detail = Inspect.Minion.Minion.Detail(minion)
details = Inspect.Minion.Minion.Detail(minions)
ParameterTypeDatatypeDescription
minionparameterminionminionThe identifier of the minion to retrieve detail for.
minionsparametertableA table of identifiers of minions to retrieve detail for.
detailresulttableDetail table for a single minion.
detailsresulttableDetail table for all requested minions. The key is the minion ID, the value is the minion's detail table.
members
description The description of this minion.
experienceAccumulated If not at max level, this minion's accumulated experience in their current level.
experienceNeeded If not at max level, the amount of experience required to gain a level.
id The ID of the requested element.
level The current level of this minion.
name The name of this minion.
rarity The rarity of this minion. "common", "uncommon", "rare", or "epic".
stamina The current stamina of this minion.
staminaMax The maximum stamina of this minion.
statAir This minion's Air stat.
statArtifact This minion's Artifact stat.
statAssassination This minion's Assassination stat.
statDeath This minion's Death stat.
statDimension This minion's Dimension stat.
statDiplomacy This minion's Diplomacy stat.
statEarth This minion's Earth stat.
statExploration This minion's Exploration stat.
statFire This minion's Fire stat.
statHarvesting This minion's Harvesting stat.
statHunting This minion's Hunting stat.
statLife This minion's Life stat.
statWater This minion's Water stat.

Inspect.Minion.Minion.List

Lists available minions.

Usage:

list = Inspect.Minion.Minion.List()
ParameterTypeDatatypeDescription
listresulttableA table of minion IDs. The key is the minion ID.

Inspect.Minion.Slot

Returns the total number of minion adventure slots.

Usage:

slots = Inspect.Minion.Slot()
ParameterTypeDatatypeDescription
slotsresultnumberThe number of slots available for active minion adventures.

Inspect.Mouse

Returns information about the current mouse position and button state.

Usage:

results = Inspect.Mouse()
ParameterTypeDatatypeDescription
resultsresulttableTable containing the current mouse state. May include members x, y, Left, Right, Middle, Mouse4, Mouse5.

Inspect.Pvp.History

Returns information on your PVP history.

Usage:

result = Inspect.Pvp.History()
ParameterTypeDatatypeDescription
resultresulttableTable containing information on PVP history.
members
favorLifetime Amount of lifetime favor accumulated.
killLifetime Amount of kills made on this character.
killMonth Amount of kills made on this character within the last month.
killToday Amount of kills made on this character within the last day.
killWeek Amount of kills made on this character within the last week.

Inspect.Pvp.Prestige

Returns information on your PVP prestige.

Usage:

result = Inspect.Pvp.Prestige()
ParameterTypeDatatypeDescription
resultresulttableTable containing information on prestige.
members
accumulated Prestige accumulated so far in this rank.
needed Quantity of prestige needed to gain a rank.
rank Current prestige rank.

Inspect.Quest.Complete

Returns a table of all quests completed.

Usage:

quests = Inspect.Quest.Complete()
ParameterTypeDatatypeDescription
questsresulttableA table where the key is the incomplete quest identifier. Identifiers returned by this function may not include all characters - the last eight characters may be replaced by "xxxxxxxx". These elements can still be compared against standard quest IDs by comparing only the first nine characters (including the 'q' prefix).

Inspect.Quest.Detail

Provides detailed information about a quest.

Usage:

detail = Inspect.Quest.Detail(quest)
details = Inspect.Quest.Detail(quests)
ParameterTypeDatatypeDescription
questparameterquestThe quest to retrieve detail for.
questsparametertableA table of quests to retrieve detail for.
detailresulttableDetail table for a single quest.
detailsresulttableDetail tables for all requested quests.
members
categoryName The name of the category this quest is placed under.
complete Signals that this quest is complete.
description The long description for this quest.
domain The quest's domain. May be "area", "guild", "instant", or "zone". Personal quests are signaled with nil.
failed Signals that this quest has failed.
id The ID of the requested element.
mode This quest's mode, if it has a special mode. May be "story" or "soul".
name The name of this quest.
objective A table of objectives. Each objective is a table that may contain the following members: "description", representing the quest's full description. "count", representing how many elements must be completed to finish this quest. "countDone", representing how many elements have been completed. "complete", indicating that this objective is complete. "indicator", listing all the map indicators that can be used to complete this quest.
rewardChoose Lists the possible reward choices for the player. The key is the item type, the value is the count.
rewardCoin The amount of silver this quest's completion will award.
rewardExperience The amount of experience this quest's completion will award.
rewardExperienceGuild The amount of guild experience this quest's completion will award.
rewardFavor The amount of favor this quest's completion will award.
rewardGuaranteed Lists the guaranteed rewards for the player. The key is the item type, the value is the count.
rewardNotoriety The amount of notoriety this quest's completion will award, represented as a table. The key is the faction ID, the value is the amount.
rewardPrestige The amount of prestige this quest's completion will award.
summary The short summary for this quest.
tag The quest's tags, space-separated.
tagName The quest's tags, localized.
track Signals that this quest is being manually tracked.
watch Signals that this quest is being watched.

Inspect.Quest.List

Lists the player's current active quests.

Usage:

quests = Inspect.Quest.List()
ParameterTypeDatatypeDescription
questsresulttableA table containing the player's current quests.

Inspect.Queue.Handler

Returns the current queue handler function.

Usage:

handler, owner = Inspect.Queue.Handler()
ParameterTypeDatatypeDescription
handlerresultfunctionThe current queue handler function.
ownerresultstringThe owner of the current queue handler function.

Inspect.Queue.Status

Inspects the current queue status. Omit the first parameter to get a table containing information on all queues.

Usage:

results = Inspect.Queue.Status()
result = Inspect.Queue.Status(queue)
results = Inspect.Queue.Status(queue, size)
ParameterTypeDatatypeDescription
queueparameterstringOptional identifier of the queue to query. Valid values include "global" and "auctionfullscan".
sizeparameternumberThe size of the element to test in this queue. Defaults to 1 if no size is provided.
resultresultbooleanfalse if this queue is throttled, non-false otherwise.
resultsresulttableA key/value table. The first parameter is the name of the queue. The second parameter is false if the queue is throttled, or a number representing the queue size available otherwise.

Inspect.Role.List

Lists the player's roles.

Usage:

roles = Inspect.Role.List()
ParameterTypeDatatypeDescription
rolesresulttableA table containing the player's roles. The key is the role ID, the value is the role name.

Inspect.Setting.Detail

Provides detailed information about a setting.

Usage:

detail = Inspect.Setting.Detail(setting)
details = Inspect.Setting.Detail(settings)
ParameterTypeDatatypeDescription
settingparameterstringThe setting to retrieve detail for.
settingsparametertableA table of settings to retrieve detail for.
detailresulttableDetail table for a single setting.
detailsresulttableDetail tables for all requested settings.
members
id The ID of the requested element.
value The value of the requested element.

Inspect.Setting.List

Lists the player's current settings.

Usage:

settings = Inspect.Setting.List()
ParameterTypeDatatypeDescription
settingsresulttableA table containing the player's current settings.

Inspect.Shard

Returns information about the current shard.

Usage:

shard = Inspect.Shard()
ParameterTypeDatatypeDescription
shardresulttableTable containing requested data.
members
name The shard's name.
pvp Signals that the shard is a PvP shard.
rp Signals that the shard is a roleplaying shard.

Inspect.Social.Friend.Detail

Provides detailed information about a friend.

Usage:

detail = Inspect.Social.Friend.Detail(friend)
details = Inspect.Social.Friend.Detail(friends)
ParameterTypeDatatypeDescription
friendparameterstringThe name of a friend to retrieve detail for.
friendsparametertableA table of names of friends to retrieve detail for.
detailresulttableDetail table for a single friend.
detailsresulttableDetail tables for all requested friends.
members
calling The friend's calling, if known.
guild The friend's current guild.
id The ID of the requested element.
level The friend's current level, if known.
name The friend's name.
note The friend's personal note.
race The friend's race, if known.
status The friend's status. Either "online", "afk", or nil.
zone The friend's current zone, if known.

Inspect.Social.Friend.List

Lists the player's current friends.

Usage:

friends = Inspect.Social.Friend.List()
ParameterTypeDatatypeDescription
friendsresulttableA table containing the player's current friends.

Inspect.Social.Ignore.Detail

Provides detailed information about an ignored player.

Usage:

detail = Inspect.Social.Ignore.Detail(ignore)
details = Inspect.Social.Ignore.Detail(ignores)
ParameterTypeDatatypeDescription
ignoreparameterstringThe name of an ignored player to retrieve detail for.
ignoresparametertableA table of names of ignored players to retrieve detail for.
detailresulttableDetail table for a single ignored player.
detailsresulttableDetail tables for all requested ignored players.
members
id The ID of the requested element.
name The ignored player's name.
note The ignored player's personal note.

Inspect.Social.Ignore.List

Lists the player's current ignored players.

Usage:

ignores = Inspect.Social.Ignore.List()
ParameterTypeDatatypeDescription
ignoresresulttableA table containing the player's current ignored players.

Inspect.Stat

Returns information about the player's stats.

Usage:

results = Inspect.Stat()
result = Inspect.Stat(stat)
ParameterTypeDatatypeDescription
statparameterstringOptional parameter identifying the stat desired. May be any of strength, dexterity, intelligence, wisdom, endurance, resistLife, resistDeath, resistFire, resistWater, resistEarth, resistAir, armor, powerAttack, critAttack, hit, powerSpell, critSpell, critPower, block, dodge, or any of the previous with "Unbuffed" appended.
resultresultnumberThe current value of that stat.
resultsresulttableA table from stat ID to stat value, containing all the player's stats.

Inspect.Storage.Used

Returns the storage space currently used for a given segment.

Usage:

current, maximum = Inspect.Storage.Used(segment)
ParameterTypeDatatypeDescription
segmentparameterstringThe 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.
currentresultnumberCurrent storage space used.
maximumresultnumberMaximum storage space available.

Inspect.System.Error.Detail

Provides detailed information about an addon error.

Usage:

detail = Inspect.System.Error.Detail(error)
details = Inspect.System.Error.Detail(errors)
ParameterTypeDatatypeDescription
errorparametererrorThe error to be inspected.
errorsparametertableA table of errors to retrieve detail for.
detailresulttableDetail table for a single error. Member documentation can be found in Event.System.Error.
detailsresulttableDetail tables for all requested errors.

Inspect.System.Language

Returns the client's current language.

Usage:

language = Inspect.System.Language()
ParameterTypeDatatypeDescription
languageresultstringCurrent language. Valid values include "English", "French", "German", "Korean", "Russian", "Chinese", and "Taiwanese".

Inspect.System.Secure

Returns the client's current secure mode.

Usage:

secure = Inspect.System.Secure()
ParameterTypeDatatypeDescription
secureresultbooleanThe current secure mode.

Inspect.System.Version

Returns information on the client version.

Usage:

version = Inspect.System.Version()
ParameterTypeDatatypeDescription
versionresulttableA table containing detailed version information.
members
build Client build information.
external Client external version.
internal Client internal version.

Inspect.System.Watchdog

Returns the number of seconds until the system watchdog may begin generating warnings.

Usage:

time = Inspect.System.Watchdog()
ParameterTypeDatatypeDescription
timeresultnumberTime left in seconds.

Inspect.TEMPORARY.Experience (deprecated)

Returns information about the player's experience.

Usage:

accumulated, rested, needed = Inspect.TEMPORARY.Experience()
ParameterTypeDatatypeDescription
accumulatedresultnumberThe amount of experience that has accumulated towards the next level.
neededresultnumberThe amonut of experience required to reach the next level.
restedresultnumberThe amount of rested experience that has accumulated.
deprecated
standard

Inspect.TEMPORARY.Role (deprecated)

Returns the ID of the player's current role.

Usage:

role = Inspect.TEMPORARY.Role()
ParameterTypeDatatypeDescription
roleresultnumberThe ID of the player's current role.
deprecated
soft

Inspect.Time.Frame

The game time of the last frame. This function's return value will not change until the next frame.

Usage:

time = Inspect.Time.Frame()
ParameterTypeDatatypeDescription
timeresultnumberTime in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.

Inspect.Time.Real

A high-resolution realtime timer. Not measured in the same timespace as Inspect.Time.Frame.

Usage:

time = Inspect.Time.Real()
ParameterTypeDatatypeDescription
timeresultnumberTime in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.

Inspect.Time.Server

Returns the current server time.

Usage:

time = Inspect.Time.Server()
ParameterTypeDatatypeDescription
timeresultnumberServer time, as seconds from the Unix epoch.

Inspect.Title.Category.Detail

Provides detailed information about a title category.

Usage:

detail = Inspect.Title.Category.Detail(titlecategory)
details = Inspect.Title.Category.Detail(titlecategories)
ParameterTypeDatatypeDescription
titlecategoriesparametertableA table of title categories to retrieve details for.
titlecategoryparametertitlecategoryThe title category to retrieve detail for.
detailresulttableDetail table for a single title category.
detailsresulttableDetail tables for all requested title categories.
members
id The ID of the required element.
name The name of the title category.

Inspect.Title.Category.List

Lists known title categories.

Usage:

titlecategories = Inspect.Title.Category.List()
ParameterTypeDatatypeDescription
titlecategoriesresulttableA lookup table of known title categories.

Inspect.Title.Detail

Provides detailed information about a title.

Usage:

detail = Inspect.Title.Detail(title)
details = Inspect.Title.Detail(titles)
ParameterTypeDatatypeDescription
titleparametertitleThe title ID to retrieve detail for.
titlesparametertableA table of title IDs to retrieve detail for.
detailresulttableDetail table for a single title.
detailsresulttableDetail tables for all requested titles.
members
gameFemale The title as seen ingame and applied to female characters.
gameMale The title as seen ingame and applied to male characters.
id The ID of the requested element.
nameFemale The title as seen in menus and applied to female characters.
nameMale The title as seen in menus and applied to male characters.
prefix Signals that the title is a prefix title.

Inspect.Title.List

Lists the player's currently available titles.

Usage:

titles = Inspect.Title.List()
ParameterTypeDatatypeDescription
titlesresulttableA lookup table of all available titles.

Inspect.Tooltip

Returns the current contents of the tooltip.

Usage:

type, shown = Inspect.Tooltip()
type, unit, buff = Inspect.Tooltip()
ParameterTypeDatatypeDescription
buffresultbuffThe ID of the tooltip's buff.
shownresultvariant, nilThe blob describing what is currently shown. Generally, some kind of identifier used in another part of the addon system.
typeresultstring, nilThe current tooltip type. Valid values include "ability", "buff", "item", "itemtype", and "unit".
unitresultunitThe unit that the buff is attached to.

Inspect.Unit.Castbar

Provides detailed information about a unit's castbar.

Usage:

detail = Inspect.Unit.Castbar(unit)
details = Inspect.Unit.Castbar(units)
ParameterTypeDatatypeDescription
unitparameterunitA unit, in either unit ID or unit specifier format.
unitsparametertableA table containing units to inspect.
detailresulttableDetail table for a single castbar.
detailsresulttableDetail tables for all requested castbars. The key is the unit ID or unit specifier, the value is the castbar's detail table.
members
ability ID of the ability being cast, if available.
abilityName Name of the ability being cast.
begin The time the cast started, in the context of Inspect.Time.Frame.
channeled True if this ability is channeled.
duration Duration of the cast in seconds.
expired Number of the seconds the cast is past its completion time. Generally indicates lag.
remaining Time remaining on the cast, in seconds.
uninterruptible Signals that the cast is not interruptible.

Inspect.Unit.Detail

Provides detailed information about a unit.

Usage:

detail = Inspect.Unit.Detail(unit)
details = Inspect.Unit.Detail(units)
ParameterTypeDatatypeDescription
unitparameterunitA unit, in either unit ID or unit specifier format.
unitsparametertableA table containing units to inspect.
detailresulttableDetail table for a single unit.
detailsresulttableDetail tables for all requested units. The key is the unit ID or unit specifier, the value is the unit's detail table.
members
absorb The unit's damage absorption.
afk Signals that the unit is AFK. Provided only for the player and the player's groupmembers.
aggro Signals that this unit is being attacked. Provided only for groupmembers.
alliance The unit's alliance. "defiant", "guardian", or nil.
availability The unit's current availability. See Utility.Unit.Availability() for details.
blocked Signals that this unit is not in line of sight. Provided only for groupmembers.
calling The unit's calling. May be "mage", "rogue", "cleric", "warrior", or "primalist".
charge The unit's charge. Provided only for the player.
chargeMax The unit's maximum charge. Provided only for the player.
combat The unit's combat status.
combo The unit's combo points. Provided only for the player.
coordX The unit's current X coordinate.
coordY The unit's current Y coordinate.
coordZ The unit's current Z coordinate.
energy The unit's energy.
energyMax The unit's maximum energy.
factionId The unit's faction ID.
focus The unit's focus.
guaranteedLoot Signals that this unit guarantees loot on death. Shown in the user interface as a diamond above the portrait.
guild The unit's guild.
health The unit's health.
healthCap The unit's capped maximum health.
healthMax The unit's maximum health.
id The ID of the requested element.
level The unit's level. May be "??" if the unit is hostile and very high-level.
locationName The name of the unit's location. Provided only for friendly players.
loot The Unit ID that has looting rights to this corpse.
mana The unit's mana.
manaMax The unit's maximum mana.
mark The mark on this unit.
mentoring The unit's mentoring status.
name The unit's name.
nameSecondary The unit's secondary name.
offline Signals that the unit is offline. Provided only for the player's groupmembers.
planar The unit's available planar charges. Provided only for the player or groupmembers.
planarMax The unit's maximum planar charges. Provided only for the player or groupmembers.
player Signals that the unit is a player, not an NPC.
power The unit's power.
publicSize The unit's current public group size. nil if the group is not public. Provided only for friendly players.
pvp The unit's PvP flag.
race The unit's race. Provided only for players.
raceName The unit's race, localized. Provided only for players.
radius The unit's radius.
ready The unit's readycheck status.
relation The unit's relation to you. May be "hostile" or "friendly". Neutral targets will not have this member.
role The unit's role. May be "tank", "heal", "dps", "support", or nil. Provided only for the player and the player's groupmembers.
spirit The unit's spirit.
tag The unit's tags, space-separated.
tagName The unit's tags, localized.
tagged The unit's tagged status. true if the unit has been tagged by you, "other" if the unit has been tagged by someone else.
tier The unit's difficulty tier. nil, "group", or "raid".
titlePrefixId The unit's title prefix ID.
titlePrefixName The unit's localized title prefix.
titleSuffixId The unit's title suffix ID.
titleSuffixName The unit's localized title suffix.
type The unit type ID.
vitality The unit's vitality. Provided only for the player or groupmembers.
warfront Signals that the unit has temporarily left the group to join a warfront. Provided only for groupmembers.
zone The ID of the unit's current zone.

Inspect.Unit.List

Lists all the units that the client can see.

Usage:

list = Inspect.Unit.List()
ParameterTypeDatatypeDescription
listresulttableMap of unit ID to unit specifier. Units with multiple valid specifiers will have one chosen at random.

Inspect.Unit.Lookup

Converts unit IDs to unit specifiers and vice-versa.

Usage:

unit = Inspect.Unit.Lookup(unit)
units = Inspect.Unit.Lookup(units)
ParameterTypeDatatypeDescription
unitparameterunitA unit ID or unit specifier, whichever is the opposite of the parameter given. May be nil.
unitsparametertableA table of unit IDs and unit specifiers. The key is the input, the value is the result. Invalid inputs will not result in output entries.
unitresultunitA unit ID or unit specifier, whichever is the opposite of the parameter given. May be nil.
unitsresulttableA table of unit IDs and unit specifiers. The key is the input, the value is the result. Invalid inputs will not result in output entries.

Inspect.Zone.Detail

Returns information about zones.

Usage:

detail = Inspect.Zone.Detail(zone)
details = Inspect.Zone.Detail(zones)
ParameterTypeDatatypeDescription
zoneparameterzoneThe identifier of the zone to retrieve detail for.
zonesparametertableA table of identifiers of zones to retrieve detail for.
detailresulttableDetail table for a single zone.
detailsresulttableDetail tables for all requested zones. The key is the zone ID, the value is the zone's detail table.
members
id The ID of the requested element.
name The name of the zone.
type The type of this zone. May be either "instance", "warfront", or nil.

Layout

A UI element of type Layout or derived from Layout.

Layout.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

Layout.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

Layout:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

Layout:EventDetach

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.

Usage:

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

Layout:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro The macro that will run when the event fires.
owner Owner to search for.
priority Priority of the event handler. Higher numbers trigger first.

Layout:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

Layout:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

Layout:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

Layout:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

Layout:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

Layout:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

Layout:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

Layout:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

Layout:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

Layout:GetRight

Retrieves the X position of the right edge of this element.

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

Layout:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

Layout:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

Layout:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

Layout:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

Layout:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

Layout:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

Layout:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

Mask

A UI element of type Mask or derived from Mask.

Mask.Event:KeyDown

Signals a key pressed.

Usage:

Frame.Event:KeyDown(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Mask.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

Mask.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

Mask.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Frame.Event:KeyRepeat(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Mask.Event:KeyType

Signals text typed.

Usage:

Frame.Event:KeyType(typed)
ParameterTypeDatatypeDescription
typedparametervariantThe text.

Mask.Event:KeyUp

Signals a key released.

Usage:

Frame.Event:KeyUp(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

Mask.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

Mask.Event:LeftClick

Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftClick()

Mask.Event:LeftDown

Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftDown()

Mask.Event:LeftUp

Signals that the mouse's left button has been released inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUp()

Mask.Event:LeftUpoutside

Signals that the mouse's left button has been released outside the frame, after a "Down" message. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUpoutside()

Mask.Event:MiddleClick

Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleClick()

Mask.Event:MiddleDown

Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleDown()

Mask.Event:MiddleUp

Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUp()

Mask.Event:MiddleUpoutside

Signals that the mouse's middle button has been released outside the frame, after a "Down" message. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUpoutside()

Mask.Event:Mouse4Click

Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Click()

Mask.Event:Mouse4Down

Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Down()

Mask.Event:Mouse4Up

Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Up()

Mask.Event:Mouse4Upoutside

Signals that the mouse's fourth button has been released outside the frame, after a "Down" message. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Upoutside()

Mask.Event:Mouse5Click

Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Click()

Mask.Event:Mouse5Down

Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Down()

Mask.Event:Mouse5Up

Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Up()

Mask.Event:Mouse5Upoutside

Signals that the mouse's fifth button has been released outside the frame, after a "Down" message. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Upoutside()

Mask.Event:MouseIn

Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseIn()

Mask.Event:MouseMove

Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseMove(x, y)
ParameterTypeDatatypeDescription
xparametervariantX coordinate.
yparameter<nope>Y coordinate.

Mask.Event:MouseOut

Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseOut()

Mask.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

Mask.Event:RightClick

Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightClick()

Mask.Event:RightDown

Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightDown()

Mask.Event:RightUp

Signals that the mouse's right button has been released inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUp()

Mask.Event:RightUpoutside

Signals that the mouse's right button has been released outside the frame, after a "Down" message. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUpoutside()

Mask.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

Mask.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

Mask.Event:WheelBack

Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelBack()

Mask.Event:WheelForward

Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelForward()

Mask:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()
noSecureFrameAndEnvironment
true

Mask:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()
noSecureFrameAndEnvironment
true

Mask:ClearPoint

Clear a set point from this frame.

Usage:

Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate.
xparameternumber/nilX coordinate of the point.
yparameternumber/nilY coordinate of the point.
noSecureFrameAndEnvironment
true

Mask:ClearWidth

Clear a set width from this frame.

Usage:

Frame:ClearWidth()
noSecureFrameAndEnvironment
true

Mask:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

Mask:EventDetach

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.

Usage:

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

Mask:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro The macro that will run when the event fires.
owner Owner to search for.
priority Priority of the event handler. Higher numbers trigger first.

Mask:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

Mask:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

Mask:GetAlpha

Gets the alpha multiplier of this frame.

Usage:

alpha = Element:GetAlpha()
ParameterTypeDatatypeDescription
alpharesultnumberThe alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.

Mask:GetBackgroundColor

Retrieves the background color of this frame.

Usage:

r, g, b, a = Element:GetBackgroundColor()
ParameterTypeDatatypeDescription
aresultnumberAlpha. 1 is fully opaque, 0 is fully transparent.
bresultnumberBlue.
gresultnumberGreen.
rresultnumberRed.

Mask:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

Mask:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

Mask:GetChildren

Returns a table containing all of this element's children.

Usage:

children = Element:GetChildren()
ParameterTypeDatatypeDescription
childrenresulttableA table containing this element's children.

Mask:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

Mask:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

Mask:GetKeyFocus

Gets the key focus status.

Usage:

focus = Element:GetKeyFocus()
ParameterTypeDatatypeDescription
focusresultbooleanWhether this frame is the current key focus.

Mask:GetLayer

Gets the frame's layer order.

Usage:

layer = Frame:GetLayer()
ParameterTypeDatatypeDescription
layerresultnumberThe render layer of this frame. See Frame:SetLayer for details.

Mask:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

Mask:GetMouseMasking

Get the current mouse masking mode. See SetMouseMasking for details.

Usage:

mask = Element:GetMouseMasking()
ParameterTypeDatatypeDescription
maskresultstringThe current mouse masking mode.

Mask:GetMouseoverUnit

Gets the unit that is being represented by this frame.

Usage:

unit = Frame:GetMouseoverUnit()
ParameterTypeDatatypeDescription
unitresultstringThe current mouseover unit. May be nil if there is no mouseover unit.

Mask:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

Mask:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

Mask:GetParent

Gets the parent of this frame.

Usage:

parent = Frame:GetParent()
ParameterTypeDatatypeDescription
parentresultElementThe parent element of this frame.

Mask:GetRight

Retrieves the X position of the right edge of this element.

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

Mask:GetSecureMode

Get the current secure mode. See SetSecureMode for details.

Usage:

secure = Frame:GetSecureMode()
ParameterTypeDatatypeDescription
secureresultstringThe current secure mode.

Mask:GetShape

Returns the current mask shape.

Usage:

shape = Mask:GetShape()
ParameterTypeDatatypeDescription
shaperesulttableThe current shape. See Canvas:SetShape() for details.

Mask:GetStrata

Gets the frame's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.

Usage:

strata = Frame:GetStrata()
ParameterTypeDatatypeDescription
strataresultstringThe item's current strata.

Mask:GetStrataList

Gets a list of valid stratas for this frame.

Usage:

stratas = Frame:GetStrataList()
ParameterTypeDatatypeDescription
stratasresulttableAn array of valid stratas, in order.

Mask:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

Mask:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

Mask:GetVisible

Gets the visibility flag for this frame.

Usage:

visible = Element:GetVisible()
ParameterTypeDatatypeDescription
visibleresultbooleanThis frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.

Mask:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

Mask:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

Mask:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

Mask:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

Mask:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

Mask:SetAllPoints

Pins all the edges of this frame to the edges of a different frame. If no target is given, defaults to this frame's parent.

Usage:

Frame:SetAllPoints()
Frame:SetAllPoints(target)
ParameterTypeDatatypeDescription
targetparameterLayoutTarget Layout to pin this frame's edges to.
noSecureFrameAndEnvironment
true

Mask:SetAlpha

Sets the alpha transparency multiplier for this frame and its children.

Usage:

Element:SetAlpha(alpha)
ParameterTypeDatatypeDescription
alphaparameternumberThe new alpha multiplier. 1 is fully opaque, 0 is fully transparent.

Mask:SetBackgroundColor

Sets the background color of this frame.

Usage:

Element:SetBackgroundColor(r, g, b)
Element:SetBackgroundColor(r, g, b, a)
ParameterTypeDatatypeDescription
aparameternumberAlpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
bparameternumberBlue.
gparameternumberGreen.
rparameternumberRed.

Mask:SetHeight

Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.

Usage:

Frame:SetHeight(height)
ParameterTypeDatatypeDescription
heightparameternumberThe new height of this frame.
noSecureFrameAndEnvironment
true

Mask:SetKeyFocus

Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on another frame will automatically unset the current focus.

Usage:

Element:SetKeyFocus(focus)
ParameterTypeDatatypeDescription
focusparameterbooleanThe new key focus setting.

Mask:SetLayer

Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but guarantees no Z-fighting. Frames are always drawn after their parents.

Usage:

Frame:SetLayer(layer)
ParameterTypeDatatypeDescription
layerparameternumberThe new layer for this frame.
noSecureFrameAndEnvironment
true

Mask:SetMouseMasking

Sets the frame's mouse masking mode.

Usage:

Element:SetMouseMasking(mask)
ParameterTypeDatatypeDescription
maskparameterstringThe new mouse masking mode. "full" is the standard mode, and means that creating any Left, Right, or movement-related mouse event will cause the frame to accept and consume any event from any of those types. "limited" causes the frame to accept and consume only events for buttons that have been hooked, so that hooking "LeftDown" will still pass Right mouse events through the frame. Note that hooking any mouse event will still consume MouseMove/In/Out events.
noSecureFrameAndEnvironment
true

Mask:SetMouseoverUnit

Sets the unit that will be represented by this frame.

Usage:

Frame:SetMouseoverUnit(unit)
ParameterTypeDatatypeDescription
unitparameternil, unitThe new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
requireSecureFrameAndInsecureEnvironment
true

Mask:SetParent

Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame's secure mode is "restricted", then its parent must also have a secure mode of "restricted".

Usage:

Frame:SetParent(parent)
ParameterTypeDatatypeDescription
parentparameterElementThe new parent for this frame.
noSecureFrameAndEnvironment
true

Mask:SetPoint

Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it.
This function can take many different forms. In general, it looks like this: SetPoint(point_on_this_frame, target_frame, point_on_target_frame [, x_offset, y_offset]).
The first part is the point on this frame that will be attached. Usually, these are string identifiers. "TOPLEFT", "TOPCENTER", "TOPRIGHT", "CENTERLEFT", "CENTER", "CENTERRIGHT", "BOTTOMLEFT", "BOTTOMCENTER", "BOTTOMRIGHT". You may also use a string identifier that refers to a single axis - "TOP", "BOTTOM", "LEFT", "RIGHT", "CENTERX", "CENTERY". If you want more direct numeric control you can use number pairs. 0,0 is equivalent to "TOPLEFT", 1,1 is equivalent to "BOTTOMRIGHT", 0.5,nil is equivalent to "CENTERX".
The second part is the frame to attach to, as well as the point on that frame to attach to. The frame is simply passing in the frame table. The point is the same identifier or number pair as the first parameter.
Optionally, you may include an X or Y offset to the point.
This connection is permanent, and if the target frame moves, this frame will move along with it.
Caveat: If the target is a frame set to the "restricted" SecureMode, and the client is currently in "secure" mode, then unexpected behavior may occur.

Usage:

Frame:SetPoint(...)
ParameterTypeDatatypeDescription
...parameter...This function's parameters are complicated. Read the above summary for details.
noSecureFrameAndEnvironment
true

Mask:SetSecureMode

Sets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
If you are not planning to use any restricted functions, your frame should remain in normal mode.
At the moment, it is not possible to change from "restricted" back to "normal".

Usage:

Frame:SetSecureMode(secure)
ParameterTypeDatatypeDescription
secureparameterstringThe new secure mode. Valid inputs are "normal" and "restricted".

Mask:SetShape

Sets the mask shape. Note that masks with custom shapes will not cull mouse events according to the custom shape.

Usage:

Mask:SetShape(path)
ParameterTypeDatatypeDescription
pathparametertable, nilA path. Consists of a table containing a series of tables, with consecutive integer keys starting from 1. Each internal table contains coordinates, either as an absolute value relative to the top-left corner of the frame, or Proportional to the frame size, as a number from 0 to 1. Giving both an absolute value and a proportional value for any coordinate is not allowed. Members:
x/xProportional: x coordinate of this point. Required.
y/yProportional: y coordinate of this point. Required.
xControl/xControlProportional: x coordinate of the curve control handle. If this exists, yControl/yControlProportional must also exist.
yControl/yControlProportional: y coordinate of the curve control handle. If this exists, xControl/xControlProportional must also exist.

Mask:SetStrata

Sets the strata for this frame.

Usage:

Frame:SetStrata(strata)
ParameterTypeDatatypeDescription
strataparameterstringThe item's new strata. Must be one of the elements returned by :GetStrataList().
noSecureFrameAndEnvironment
true

Mask:SetVisible

Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.

Usage:

Element:SetVisible(visible)
ParameterTypeDatatypeDescription
visibleparameterbooleanThe new visibility flag.
noSecureFrameAndEnvironment
true

Mask:SetWidth

Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.

Usage:

Frame:SetWidth(width)
ParameterTypeDatatypeDescription
widthparameternumberThe new width of this frame.
noSecureFrameAndEnvironment
true

Native

A UI element of type Native or derived from Native.

Native.Event:Layer

Signals a change in the item's layer.

Usage:

Native.Event:Layer()

Native.Event:Loaded

Signals a change in the item's loaded status.

Usage:

Native.Event:Loaded()

Native.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

Native.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

Native.Event:Strata

Signals a change in the item's strata.

Usage:

Native.Event:Strata()

Native:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

Native:EventDetach

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.

Usage:

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

Native:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro The macro that will run when the event fires.
owner Owner to search for.
priority Priority of the event handler. Higher numbers trigger first.

Native:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

Native:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

Native:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

Native:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

Native:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

Native:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

Native:GetLayer

Gets the native item's layer order.

Usage:

layer = Native:GetLayer()
ParameterTypeDatatypeDescription
layerresultnumberThe render layer of this frame. See Frame:SetLayer for details.

Native:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

Native:GetLoaded

Gets whether or not this native element is loaded and rendering.

Usage:

loaded = Native:GetLoaded()
ParameterTypeDatatypeDescription
loadedresultbooleantrue if it is loaded.

Native:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

Native:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

Native:GetRight

Retrieves the X position of the right edge of this element.

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

Native:GetSecureMode

Get the native element's secure mode. See Frame:SetSecureMode() for details.

Usage:

secure = Native:GetSecureMode()
ParameterTypeDatatypeDescription
secureresultstringThe current secure mode.

Native:GetStrata

Gets the native item's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.

Usage:

strata = Native:GetStrata()
ParameterTypeDatatypeDescription
strataresultstringThe item's current strata.

Native:GetStrataList

Gets a list of valid stratas for this native element.

Usage:

stratas = Native:GetStrataList()
ParameterTypeDatatypeDescription
stratasresulttableAn array of valid stratas, in order.

Native:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

Native:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

Native:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

Native:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

Native:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

Native:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

Native:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

Native:SetLayer

Sets the frame layer for this native element. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but guarantees no Z-fighting. Frames are always drawn after their parents.

Usage:

Native:SetLayer(layer)
ParameterTypeDatatypeDescription
layerparameternumberThe new layer for this frame.
noSecureFrameAndEnvironment
true

Native:SetStrata

Sets the strata for this native element.

Usage:

Native:SetStrata(layer)
ParameterTypeDatatypeDescription
layerparameterstringThe new layer for this frame.
noSecureFrameAndEnvironment
true

RiftButton

A UI element of type RiftButton or derived from RiftButton.

RiftButton.Event:KeyDown

Signals a key pressed.

Usage:

Frame.Event:KeyDown(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftButton.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

RiftButton.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

RiftButton.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Frame.Event:KeyRepeat(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftButton.Event:KeyType

Signals text typed.

Usage:

Frame.Event:KeyType(typed)
ParameterTypeDatatypeDescription
typedparametervariantThe text.

RiftButton.Event:KeyUp

Signals a key released.

Usage:

Frame.Event:KeyUp(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftButton.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

RiftButton.Event:LeftClick

Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftClick()

RiftButton.Event:LeftDown

Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftDown()

RiftButton.Event:LeftPress

Signals that the button has been pressed. Equivalent to LeftClick, but triggers only while the button is enabled.

Usage:

RiftButton.Event:LeftPress()

RiftButton.Event:LeftUp

Signals that the mouse's left button has been released inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUp()

RiftButton.Event:LeftUpoutside

Signals that the mouse's left button has been released outside the frame, after a "Down" message. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUpoutside()

RiftButton.Event:MiddleClick

Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleClick()

RiftButton.Event:MiddleDown

Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleDown()

RiftButton.Event:MiddleUp

Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUp()

RiftButton.Event:MiddleUpoutside

Signals that the mouse's middle button has been released outside the frame, after a "Down" message. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUpoutside()

RiftButton.Event:Mouse4Click

Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Click()

RiftButton.Event:Mouse4Down

Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Down()

RiftButton.Event:Mouse4Up

Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Up()

RiftButton.Event:Mouse4Upoutside

Signals that the mouse's fourth button has been released outside the frame, after a "Down" message. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Upoutside()

RiftButton.Event:Mouse5Click

Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Click()

RiftButton.Event:Mouse5Down

Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Down()

RiftButton.Event:Mouse5Up

Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Up()

RiftButton.Event:Mouse5Upoutside

Signals that the mouse's fifth button has been released outside the frame, after a "Down" message. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Upoutside()

RiftButton.Event:MouseIn

Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseIn()

RiftButton.Event:MouseMove

Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseMove(x, y)
ParameterTypeDatatypeDescription
xparametervariantX coordinate.
yparameter<nope>Y coordinate.

RiftButton.Event:MouseOut

Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseOut()

RiftButton.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

RiftButton.Event:RightClick

Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightClick()

RiftButton.Event:RightDown

Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightDown()

RiftButton.Event:RightUp

Signals that the mouse's right button has been released inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUp()

RiftButton.Event:RightUpoutside

Signals that the mouse's right button has been released outside the frame, after a "Down" message. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUpoutside()

RiftButton.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

RiftButton.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

RiftButton.Event:WheelBack

Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelBack()

RiftButton.Event:WheelForward

Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelForward()

RiftButton:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()
noSecureFrameAndEnvironment
true

RiftButton:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()
noSecureFrameAndEnvironment
true

RiftButton:ClearPoint

Clear a set point from this frame.

Usage:

Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate.
xparameternumber/nilX coordinate of the point.
yparameternumber/nilY coordinate of the point.
noSecureFrameAndEnvironment
true

RiftButton:ClearWidth

Clear a set width from this frame.

Usage:

Frame:ClearWidth()
noSecureFrameAndEnvironment
true

RiftButton:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

RiftButton:EventDetach

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.

Usage:

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

RiftButton:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro The macro that will run when the event fires.
owner Owner to search for.
priority Priority of the event handler. Higher numbers trigger first.

RiftButton:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

RiftButton:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

RiftButton:GetAlpha

Gets the alpha multiplier of this frame.

Usage:

alpha = Element:GetAlpha()
ParameterTypeDatatypeDescription
alpharesultnumberThe alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.

RiftButton:GetBackgroundColor

Retrieves the background color of this frame.

Usage:

r, g, b, a = Element:GetBackgroundColor()
ParameterTypeDatatypeDescription
aresultnumberAlpha. 1 is fully opaque, 0 is fully transparent.
bresultnumberBlue.
gresultnumberGreen.
rresultnumberRed.

RiftButton:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

RiftButton:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

RiftButton:GetChildren

Returns a table containing all of this element's children.

Usage:

children = Element:GetChildren()
ParameterTypeDatatypeDescription
childrenresulttableA table containing this element's children.

RiftButton:GetEnabled

Gets whether the button is enabled or grayed out.

Usage:

enabled = RiftButton:GetEnabled()
ParameterTypeDatatypeDescription
enabledresultbooleanThe current enable state of this item.

RiftButton:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

RiftButton:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

RiftButton:GetKeyFocus

Gets the key focus status.

Usage:

focus = Element:GetKeyFocus()
ParameterTypeDatatypeDescription
focusresultbooleanWhether this frame is the current key focus.

RiftButton:GetLayer

Gets the frame's layer order.

Usage:

layer = Frame:GetLayer()
ParameterTypeDatatypeDescription
layerresultnumberThe render layer of this frame. See Frame:SetLayer for details.

RiftButton:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

RiftButton:GetMouseMasking

Get the current mouse masking mode. See SetMouseMasking for details.

Usage:

mask = Element:GetMouseMasking()
ParameterTypeDatatypeDescription
maskresultstringThe current mouse masking mode.

RiftButton:GetMouseoverUnit

Gets the unit that is being represented by this frame.

Usage:

unit = Frame:GetMouseoverUnit()
ParameterTypeDatatypeDescription
unitresultstringThe current mouseover unit. May be nil if there is no mouseover unit.

RiftButton:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

RiftButton:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

RiftButton:GetParent

Gets the parent of this frame.

Usage:

parent = Frame:GetParent()
ParameterTypeDatatypeDescription
parentresultElementThe parent element of this frame.

RiftButton:GetRight

Retrieves the X position of the right edge of this element.

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

RiftButton:GetSecureMode

Get the current secure mode. See SetSecureMode for details.

Usage:

secure = Frame:GetSecureMode()
ParameterTypeDatatypeDescription
secureresultstringThe current secure mode.

RiftButton:GetSkin

Gets the current skin of this item.

Usage:

skin = RiftButton:GetSkin()
ParameterTypeDatatypeDescription
skinresultstringThe current skin. Possible results include "default" and "close".

RiftButton:GetStrata

Gets the frame's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.

Usage:

strata = Frame:GetStrata()
ParameterTypeDatatypeDescription
strataresultstringThe item's current strata.

RiftButton:GetStrataList

Gets a list of valid stratas for this frame.

Usage:

stratas = Frame:GetStrataList()
ParameterTypeDatatypeDescription
stratasresulttableAn array of valid stratas, in order.

RiftButton:GetText

Gets this button's text.

Usage:

text = RiftButton:GetText()
ParameterTypeDatatypeDescription
textresultstringThe current text of the element.

RiftButton:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

RiftButton:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

RiftButton:GetVisible

Gets the visibility flag for this frame.

Usage:

visible = Element:GetVisible()
ParameterTypeDatatypeDescription
visibleresultbooleanThis frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.

RiftButton:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

RiftButton:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

RiftButton:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

RiftButton:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

RiftButton:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

RiftButton:SetAllPoints

Pins all the edges of this frame to the edges of a different frame. If no target is given, defaults to this frame's parent.

Usage:

Frame:SetAllPoints()
Frame:SetAllPoints(target)
ParameterTypeDatatypeDescription
targetparameterLayoutTarget Layout to pin this frame's edges to.
noSecureFrameAndEnvironment
true

RiftButton:SetAlpha

Sets the alpha transparency multiplier for this frame and its children.

Usage:

Element:SetAlpha(alpha)
ParameterTypeDatatypeDescription
alphaparameternumberThe new alpha multiplier. 1 is fully opaque, 0 is fully transparent.

RiftButton:SetBackgroundColor

Sets the background color of this frame.

Usage:

Element:SetBackgroundColor(r, g, b)
Element:SetBackgroundColor(r, g, b, a)
ParameterTypeDatatypeDescription
aparameternumberAlpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
bparameternumberBlue.
gparameternumberGreen.
rparameternumberRed.

RiftButton:SetEnabled

Sets whether the button is enabled or grayed out.

Usage:

RiftButton:SetEnabled(enabled)
ParameterTypeDatatypeDescription
enabledparameterbooleanThe new enable state of this item.

RiftButton:SetHeight

Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.

Usage:

Frame:SetHeight(height)
ParameterTypeDatatypeDescription
heightparameternumberThe new height of this frame.
noSecureFrameAndEnvironment
true

RiftButton:SetKeyFocus

Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on another frame will automatically unset the current focus.

Usage:

Element:SetKeyFocus(focus)
ParameterTypeDatatypeDescription
focusparameterbooleanThe new key focus setting.

RiftButton:SetLayer

Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but guarantees no Z-fighting. Frames are always drawn after their parents.

Usage:

Frame:SetLayer(layer)
ParameterTypeDatatypeDescription
layerparameternumberThe new layer for this frame.
noSecureFrameAndEnvironment
true

RiftButton:SetMouseMasking

Sets the frame's mouse masking mode.

Usage:

Element:SetMouseMasking(mask)
ParameterTypeDatatypeDescription
maskparameterstringThe new mouse masking mode. "full" is the standard mode, and means that creating any Left, Right, or movement-related mouse event will cause the frame to accept and consume any event from any of those types. "limited" causes the frame to accept and consume only events for buttons that have been hooked, so that hooking "LeftDown" will still pass Right mouse events through the frame. Note that hooking any mouse event will still consume MouseMove/In/Out events.
noSecureFrameAndEnvironment
true

RiftButton:SetMouseoverUnit

Sets the unit that will be represented by this frame.

Usage:

Frame:SetMouseoverUnit(unit)
ParameterTypeDatatypeDescription
unitparameternil, unitThe new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
requireSecureFrameAndInsecureEnvironment
true

RiftButton:SetParent

Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame's secure mode is "restricted", then its parent must also have a secure mode of "restricted".

Usage:

Frame:SetParent(parent)
ParameterTypeDatatypeDescription
parentparameterElementThe new parent for this frame.
noSecureFrameAndEnvironment
true

RiftButton:SetPoint

Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it.
This function can take many different forms. In general, it looks like this: SetPoint(point_on_this_frame, target_frame, point_on_target_frame [, x_offset, y_offset]).
The first part is the point on this frame that will be attached. Usually, these are string identifiers. "TOPLEFT", "TOPCENTER", "TOPRIGHT", "CENTERLEFT", "CENTER", "CENTERRIGHT", "BOTTOMLEFT", "BOTTOMCENTER", "BOTTOMRIGHT". You may also use a string identifier that refers to a single axis - "TOP", "BOTTOM", "LEFT", "RIGHT", "CENTERX", "CENTERY". If you want more direct numeric control you can use number pairs. 0,0 is equivalent to "TOPLEFT", 1,1 is equivalent to "BOTTOMRIGHT", 0.5,nil is equivalent to "CENTERX".
The second part is the frame to attach to, as well as the point on that frame to attach to. The frame is simply passing in the frame table. The point is the same identifier or number pair as the first parameter.
Optionally, you may include an X or Y offset to the point.
This connection is permanent, and if the target frame moves, this frame will move along with it.
Caveat: If the target is a frame set to the "restricted" SecureMode, and the client is currently in "secure" mode, then unexpected behavior may occur.

Usage:

Frame:SetPoint(...)
ParameterTypeDatatypeDescription
...parameter...This function's parameters are complicated. Read the above summary for details.
noSecureFrameAndEnvironment
true

RiftButton:SetSecureMode

Sets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
If you are not planning to use any restricted functions, your frame should remain in normal mode.
At the moment, it is not possible to change from "restricted" back to "normal".

Usage:

Frame:SetSecureMode(secure)
ParameterTypeDatatypeDescription
secureparameterstringThe new secure mode. Valid inputs are "normal" and "restricted".

RiftButton:SetSkin

Sets the current skin of this item.

Usage:

RiftButton:SetSkin(skin)
ParameterTypeDatatypeDescription
skinparameterstringThe new skin. Possible values are "default" and "close".

RiftButton:SetStrata

Sets the strata for this frame.

Usage:

Frame:SetStrata(strata)
ParameterTypeDatatypeDescription
strataparameterstringThe item's new strata. Must be one of the elements returned by :GetStrataList().
noSecureFrameAndEnvironment
true

RiftButton:SetText

Sets this button's text.

Usage:

RiftButton:SetText(text)
ParameterTypeDatatypeDescription
textparameterstringThe new text for the element.

RiftButton:SetVisible

Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.

Usage:

Element:SetVisible(visible)
ParameterTypeDatatypeDescription
visibleparameterbooleanThe new visibility flag.
noSecureFrameAndEnvironment
true

RiftButton:SetWidth

Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.

Usage:

Frame:SetWidth(width)
ParameterTypeDatatypeDescription
widthparameternumberThe new width of this frame.
noSecureFrameAndEnvironment
true

RiftCheckbox

A UI element of type RiftCheckbox or derived from RiftCheckbox.

RiftCheckbox.Event:CheckboxChange

Signals that the checkbox's checked state has changed.

Usage:

RiftCheckbox.Event:CheckboxChange()

RiftCheckbox.Event:KeyDown

Signals a key pressed.

Usage:

Frame.Event:KeyDown(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftCheckbox.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

RiftCheckbox.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

RiftCheckbox.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Frame.Event:KeyRepeat(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftCheckbox.Event:KeyType

Signals text typed.

Usage:

Frame.Event:KeyType(typed)
ParameterTypeDatatypeDescription
typedparametervariantThe text.

RiftCheckbox.Event:KeyUp

Signals a key released.

Usage:

Frame.Event:KeyUp(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftCheckbox.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

RiftCheckbox.Event:LeftClick

Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftClick()

RiftCheckbox.Event:LeftDown

Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftDown()

RiftCheckbox.Event:LeftUp

Signals that the mouse's left button has been released inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUp()

RiftCheckbox.Event:LeftUpoutside

Signals that the mouse's left button has been released outside the frame, after a "Down" message. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUpoutside()

RiftCheckbox.Event:MiddleClick

Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleClick()

RiftCheckbox.Event:MiddleDown

Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleDown()

RiftCheckbox.Event:MiddleUp

Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUp()

RiftCheckbox.Event:MiddleUpoutside

Signals that the mouse's middle button has been released outside the frame, after a "Down" message. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUpoutside()

RiftCheckbox.Event:Mouse4Click

Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Click()

RiftCheckbox.Event:Mouse4Down

Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Down()

RiftCheckbox.Event:Mouse4Up

Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Up()

RiftCheckbox.Event:Mouse4Upoutside

Signals that the mouse's fourth button has been released outside the frame, after a "Down" message. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Upoutside()

RiftCheckbox.Event:Mouse5Click

Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Click()

RiftCheckbox.Event:Mouse5Down

Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Down()

RiftCheckbox.Event:Mouse5Up

Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Up()

RiftCheckbox.Event:Mouse5Upoutside

Signals that the mouse's fifth button has been released outside the frame, after a "Down" message. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Upoutside()

RiftCheckbox.Event:MouseIn

Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseIn()

RiftCheckbox.Event:MouseMove

Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseMove(x, y)
ParameterTypeDatatypeDescription
xparametervariantX coordinate.
yparameter<nope>Y coordinate.

RiftCheckbox.Event:MouseOut

Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseOut()

RiftCheckbox.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

RiftCheckbox.Event:RightClick

Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightClick()

RiftCheckbox.Event:RightDown

Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightDown()

RiftCheckbox.Event:RightUp

Signals that the mouse's right button has been released inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUp()

RiftCheckbox.Event:RightUpoutside

Signals that the mouse's right button has been released outside the frame, after a "Down" message. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUpoutside()

RiftCheckbox.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

RiftCheckbox.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

RiftCheckbox.Event:WheelBack

Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelBack()

RiftCheckbox.Event:WheelForward

Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelForward()

RiftCheckbox:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()
noSecureFrameAndEnvironment
true

RiftCheckbox:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()
noSecureFrameAndEnvironment
true

RiftCheckbox:ClearPoint

Clear a set point from this frame.

Usage:

Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate.
xparameternumber/nilX coordinate of the point.
yparameternumber/nilY coordinate of the point.
noSecureFrameAndEnvironment
true

RiftCheckbox:ClearWidth

Clear a set width from this frame.

Usage:

Frame:ClearWidth()
noSecureFrameAndEnvironment
true

RiftCheckbox:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

RiftCheckbox:EventDetach

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.

Usage:

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

RiftCheckbox:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro The macro that will run when the event fires.
owner Owner to search for.
priority Priority of the event handler. Higher numbers trigger first.

RiftCheckbox:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

RiftCheckbox:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

RiftCheckbox:GetAlpha

Gets the alpha multiplier of this frame.

Usage:

alpha = Element:GetAlpha()
ParameterTypeDatatypeDescription
alpharesultnumberThe alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.

RiftCheckbox:GetBackgroundColor

Retrieves the background color of this frame.

Usage:

r, g, b, a = Element:GetBackgroundColor()
ParameterTypeDatatypeDescription
aresultnumberAlpha. 1 is fully opaque, 0 is fully transparent.
bresultnumberBlue.
gresultnumberGreen.
rresultnumberRed.

RiftCheckbox:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

RiftCheckbox:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

RiftCheckbox:GetChecked

Gets whether the button is checked or not.

Usage:

checked = RiftCheckbox:GetChecked()
ParameterTypeDatatypeDescription
checkedresultbooleanThe current checked state of this item.

RiftCheckbox:GetChildren

Returns a table containing all of this element's children.

Usage:

children = Element:GetChildren()
ParameterTypeDatatypeDescription
childrenresulttableA table containing this element's children.

RiftCheckbox:GetEnabled

Gets whether the checkbox is enabled or grayed out.

Usage:

enabled = RiftCheckbox:GetEnabled()
ParameterTypeDatatypeDescription
enabledresultbooleanThe current enable state of this item.

RiftCheckbox:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

RiftCheckbox:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

RiftCheckbox:GetKeyFocus

Gets the key focus status.

Usage:

focus = Element:GetKeyFocus()
ParameterTypeDatatypeDescription
focusresultbooleanWhether this frame is the current key focus.

RiftCheckbox:GetLayer

Gets the frame's layer order.

Usage:

layer = Frame:GetLayer()
ParameterTypeDatatypeDescription
layerresultnumberThe render layer of this frame. See Frame:SetLayer for details.

RiftCheckbox:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

RiftCheckbox:GetMouseMasking

Get the current mouse masking mode. See SetMouseMasking for details.

Usage:

mask = Element:GetMouseMasking()
ParameterTypeDatatypeDescription
maskresultstringThe current mouse masking mode.

RiftCheckbox:GetMouseoverUnit

Gets the unit that is being represented by this frame.

Usage:

unit = Frame:GetMouseoverUnit()
ParameterTypeDatatypeDescription
unitresultstringThe current mouseover unit. May be nil if there is no mouseover unit.

RiftCheckbox:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

RiftCheckbox:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

RiftCheckbox:GetParent

Gets the parent of this frame.

Usage:

parent = Frame:GetParent()
ParameterTypeDatatypeDescription
parentresultElementThe parent element of this frame.

RiftCheckbox:GetRight

Retrieves the X position of the right edge of this element.

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

RiftCheckbox:GetSecureMode

Get the current secure mode. See SetSecureMode for details.

Usage:

secure = Frame:GetSecureMode()
ParameterTypeDatatypeDescription
secureresultstringThe current secure mode.

RiftCheckbox:GetStrata

Gets the frame's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.

Usage:

strata = Frame:GetStrata()
ParameterTypeDatatypeDescription
strataresultstringThe item's current strata.

RiftCheckbox:GetStrataList

Gets a list of valid stratas for this frame.

Usage:

stratas = Frame:GetStrataList()
ParameterTypeDatatypeDescription
stratasresulttableAn array of valid stratas, in order.

RiftCheckbox:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

RiftCheckbox:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

RiftCheckbox:GetVisible

Gets the visibility flag for this frame.

Usage:

visible = Element:GetVisible()
ParameterTypeDatatypeDescription
visibleresultbooleanThis frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.

RiftCheckbox:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

RiftCheckbox:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

RiftCheckbox:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

RiftCheckbox:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

RiftCheckbox:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

RiftCheckbox:SetAllPoints

Pins all the edges of this frame to the edges of a different frame. If no target is given, defaults to this frame's parent.

Usage:

Frame:SetAllPoints()
Frame:SetAllPoints(target)
ParameterTypeDatatypeDescription
targetparameterLayoutTarget Layout to pin this frame's edges to.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetAlpha

Sets the alpha transparency multiplier for this frame and its children.

Usage:

Element:SetAlpha(alpha)
ParameterTypeDatatypeDescription
alphaparameternumberThe new alpha multiplier. 1 is fully opaque, 0 is fully transparent.

RiftCheckbox:SetBackgroundColor

Sets the background color of this frame.

Usage:

Element:SetBackgroundColor(r, g, b)
Element:SetBackgroundColor(r, g, b, a)
ParameterTypeDatatypeDescription
aparameternumberAlpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
bparameternumberBlue.
gparameternumberGreen.
rparameternumberRed.

RiftCheckbox:SetChecked

Sets whether the checkbox is checked or not.

Usage:

RiftCheckbox:SetChecked(checked)
ParameterTypeDatatypeDescription
checkedparameterbooleanThe new checked state of this item.

RiftCheckbox:SetEnabled

Sets whether the checkbox is enabled or grayed out.

Usage:

RiftCheckbox:SetEnabled(enabled)
ParameterTypeDatatypeDescription
enabledparameterbooleanThe new enable state of this item.

RiftCheckbox:SetHeight

Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.

Usage:

Frame:SetHeight(height)
ParameterTypeDatatypeDescription
heightparameternumberThe new height of this frame.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetKeyFocus

Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on another frame will automatically unset the current focus.

Usage:

Element:SetKeyFocus(focus)
ParameterTypeDatatypeDescription
focusparameterbooleanThe new key focus setting.

RiftCheckbox:SetLayer

Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but guarantees no Z-fighting. Frames are always drawn after their parents.

Usage:

Frame:SetLayer(layer)
ParameterTypeDatatypeDescription
layerparameternumberThe new layer for this frame.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetMouseMasking

Sets the frame's mouse masking mode.

Usage:

Element:SetMouseMasking(mask)
ParameterTypeDatatypeDescription
maskparameterstringThe new mouse masking mode. "full" is the standard mode, and means that creating any Left, Right, or movement-related mouse event will cause the frame to accept and consume any event from any of those types. "limited" causes the frame to accept and consume only events for buttons that have been hooked, so that hooking "LeftDown" will still pass Right mouse events through the frame. Note that hooking any mouse event will still consume MouseMove/In/Out events.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetMouseoverUnit

Sets the unit that will be represented by this frame.

Usage:

Frame:SetMouseoverUnit(unit)
ParameterTypeDatatypeDescription
unitparameternil, unitThe new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
requireSecureFrameAndInsecureEnvironment
true

RiftCheckbox:SetParent

Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame's secure mode is "restricted", then its parent must also have a secure mode of "restricted".

Usage:

Frame:SetParent(parent)
ParameterTypeDatatypeDescription
parentparameterElementThe new parent for this frame.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetPoint

Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it.
This function can take many different forms. In general, it looks like this: SetPoint(point_on_this_frame, target_frame, point_on_target_frame [, x_offset, y_offset]).
The first part is the point on this frame that will be attached. Usually, these are string identifiers. "TOPLEFT", "TOPCENTER", "TOPRIGHT", "CENTERLEFT", "CENTER", "CENTERRIGHT", "BOTTOMLEFT", "BOTTOMCENTER", "BOTTOMRIGHT". You may also use a string identifier that refers to a single axis - "TOP", "BOTTOM", "LEFT", "RIGHT", "CENTERX", "CENTERY". If you want more direct numeric control you can use number pairs. 0,0 is equivalent to "TOPLEFT", 1,1 is equivalent to "BOTTOMRIGHT", 0.5,nil is equivalent to "CENTERX".
The second part is the frame to attach to, as well as the point on that frame to attach to. The frame is simply passing in the frame table. The point is the same identifier or number pair as the first parameter.
Optionally, you may include an X or Y offset to the point.
This connection is permanent, and if the target frame moves, this frame will move along with it.
Caveat: If the target is a frame set to the "restricted" SecureMode, and the client is currently in "secure" mode, then unexpected behavior may occur.

Usage:

Frame:SetPoint(...)
ParameterTypeDatatypeDescription
...parameter...This function's parameters are complicated. Read the above summary for details.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetSecureMode

Sets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
If you are not planning to use any restricted functions, your frame should remain in normal mode.
At the moment, it is not possible to change from "restricted" back to "normal".

Usage:

Frame:SetSecureMode(secure)
ParameterTypeDatatypeDescription
secureparameterstringThe new secure mode. Valid inputs are "normal" and "restricted".

RiftCheckbox:SetStrata

Sets the strata for this frame.

Usage:

Frame:SetStrata(strata)
ParameterTypeDatatypeDescription
strataparameterstringThe item's new strata. Must be one of the elements returned by :GetStrataList().
noSecureFrameAndEnvironment
true

RiftCheckbox:SetVisible

Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.

Usage:

Element:SetVisible(visible)
ParameterTypeDatatypeDescription
visibleparameterbooleanThe new visibility flag.
noSecureFrameAndEnvironment
true

RiftCheckbox:SetWidth

Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.

Usage:

Frame:SetWidth(width)
ParameterTypeDatatypeDescription
widthparameternumberThe new width of this frame.
noSecureFrameAndEnvironment
true

RiftScrollbar

A UI element of type RiftScrollbar or derived from RiftScrollbar.

RiftScrollbar.Event:KeyDown

Signals a key pressed.

Usage:

Frame.Event:KeyDown(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftScrollbar.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

RiftScrollbar.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

RiftScrollbar.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Frame.Event:KeyRepeat(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftScrollbar.Event:KeyType

Signals text typed.

Usage:

Frame.Event:KeyType(typed)
ParameterTypeDatatypeDescription
typedparametervariantThe text.

RiftScrollbar.Event:KeyUp

Signals a key released.

Usage:

Frame.Event:KeyUp(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftScrollbar.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

RiftScrollbar.Event:LeftClick

Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftClick()

RiftScrollbar.Event:LeftDown

Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftDown()

RiftScrollbar.Event:LeftUp

Signals that the mouse's left button has been released inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUp()

RiftScrollbar.Event:LeftUpoutside

Signals that the mouse's left button has been released outside the frame, after a "Down" message. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUpoutside()

RiftScrollbar.Event:MiddleClick

Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleClick()

RiftScrollbar.Event:MiddleDown

Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleDown()

RiftScrollbar.Event:MiddleUp

Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUp()

RiftScrollbar.Event:MiddleUpoutside

Signals that the mouse's middle button has been released outside the frame, after a "Down" message. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUpoutside()

RiftScrollbar.Event:Mouse4Click

Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Click()

RiftScrollbar.Event:Mouse4Down

Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Down()

RiftScrollbar.Event:Mouse4Up

Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Up()

RiftScrollbar.Event:Mouse4Upoutside

Signals that the mouse's fourth button has been released outside the frame, after a "Down" message. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Upoutside()

RiftScrollbar.Event:Mouse5Click

Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Click()

RiftScrollbar.Event:Mouse5Down

Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Down()

RiftScrollbar.Event:Mouse5Up

Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Up()

RiftScrollbar.Event:Mouse5Upoutside

Signals that the mouse's fifth button has been released outside the frame, after a "Down" message. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Upoutside()

RiftScrollbar.Event:MouseIn

Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseIn()

RiftScrollbar.Event:MouseMove

Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseMove(x, y)
ParameterTypeDatatypeDescription
xparametervariantX coordinate.
yparameter<nope>Y coordinate.

RiftScrollbar.Event:MouseOut

Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseOut()

RiftScrollbar.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

RiftScrollbar.Event:RightClick

Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightClick()

RiftScrollbar.Event:RightDown

Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightDown()

RiftScrollbar.Event:RightUp

Signals that the mouse's right button has been released inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUp()

RiftScrollbar.Event:RightUpoutside

Signals that the mouse's right button has been released outside the frame, after a "Down" message. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUpoutside()

RiftScrollbar.Event:ScrollbarChange

Signals a change in the scrollbar position.

Usage:

RiftScrollbar.Event:ScrollbarChange()

RiftScrollbar.Event:ScrollbarGrab

Signals the user grabbing the scrollbar with the mouse.

Usage:

RiftScrollbar.Event:ScrollbarGrab()

RiftScrollbar.Event:ScrollbarRelease

Signals the user releasing the scrollbar.

Usage:

RiftScrollbar.Event:ScrollbarRelease()

RiftScrollbar.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

RiftScrollbar.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

RiftScrollbar.Event:WheelBack

Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelBack()

RiftScrollbar.Event:WheelForward

Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelForward()

RiftScrollbar:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()
noSecureFrameAndEnvironment
true

RiftScrollbar:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()
noSecureFrameAndEnvironment
true

RiftScrollbar:ClearPoint

Clear a set point from this frame.

Usage:

Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate.
xparameternumber/nilX coordinate of the point.
yparameternumber/nilY coordinate of the point.
noSecureFrameAndEnvironment
true

RiftScrollbar:ClearWidth

Clear a set width from this frame.

Usage:

Frame:ClearWidth()
noSecureFrameAndEnvironment
true

RiftScrollbar:EventAttach

Attaches an event handler to an event.

Usage:

Layout:EventAttach(handle, callback, label)
Layout:EventAttach(handle, callback, label, priority)
ParameterTypeDatatypeDescription
callbackparameterfunctionA global event handler function. This will be called when the event fires. The first parameter will be the frame that the event is called on, the second parameter will be the standard frame event handle, any other parameters will follow that.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstringHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
priorityparameternumberPriority of the event handler. Higher numbers trigger first.
noSecureFrameAndEnvironment
true

RiftScrollbar:EventDetach

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.

Usage:

Layout:EventDetach(handle, callback)
Layout:EventDetach(handle, callback, label)
Layout:EventDetach(handle, callback, label, priority)
Layout:EventDetach(handle, callback, label, priority, owner)
ParameterTypeDatatypeDescription
callbackparameterfunction/nilA callback function to search for.
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
labelparameterstring/nilHuman-readable label used to identify the handler in error reports, performance reports, and for later detaching.
ownerparameterstring/nilOwner to search for.
priorityparameternumber/nilPriority of the event handler. Higher numbers trigger first.

RiftScrollbar:EventList

Lists the current event handlers for an event.

Usage:

result = Layout:EventList(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
resultresulttableA table of event handlers for this event.
members
handler The handler that will be called when the event fires.
label Human-readable label used to identify the handler in error reports, performance reports, and for later detaching.
macro The macro that will run when the event fires.
owner Owner to search for.
priority Priority of the event handler. Higher numbers trigger first.

RiftScrollbar:EventMacroGet

Gets the macro that will be triggered when this event occurs.

Usage:

macro = Layout:EventMacroGet(handle)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroresultstring/nilThe macro that will be triggered.

RiftScrollbar:EventMacroSet

Sets the macro that will be triggered when this event occurs.

Usage:

Layout:EventMacroSet(handle, macro)
ParameterTypeDatatypeDescription
handleparametereventFrameA handle to a frame event, usually pulled out of the "Event.UI." hierarchy.
macroparameterstring/nilThe macro to trigger. nil to clear the macro.
requireSecureFrameAndInsecureEnvironment
true

RiftScrollbar:GetAlpha

Gets the alpha multiplier of this frame.

Usage:

alpha = Element:GetAlpha()
ParameterTypeDatatypeDescription
alpharesultnumberThe alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.

RiftScrollbar:GetBackgroundColor

Retrieves the background color of this frame.

Usage:

r, g, b, a = Element:GetBackgroundColor()
ParameterTypeDatatypeDescription
aresultnumberAlpha. 1 is fully opaque, 0 is fully transparent.
bresultnumberBlue.
gresultnumberGreen.
rresultnumberRed.

RiftScrollbar:GetBottom

Retrieves the Y position of the bottom edge of this element.

Usage:

bottom = Layout:GetBottom()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.

RiftScrollbar:GetBounds

Retrieves the complete bounds of this element.

Usage:

left, top, right, bottom = Layout:GetBounds()
ParameterTypeDatatypeDescription
bottomresultnumberThe Y position of the bottom edge of this element.
leftresultnumberThe X position of the left edge of this element.
rightresultnumberThe X position of the right edge of this element.
topresultnumberThe Y position of the top edge of this element.

RiftScrollbar:GetChildren

Returns a table containing all of this element's children.

Usage:

children = Element:GetChildren()
ParameterTypeDatatypeDescription
childrenresulttableA table containing this element's children.

RiftScrollbar:GetEnabled

Gets whether the scrollbar is enabled or disabled.

Usage:

enabled = RiftScrollbar:GetEnabled()
ParameterTypeDatatypeDescription
enabledresultbooleanThe current enable state of this item.

RiftScrollbar:GetEventTable

Retrieves the event table of this element. By default, this value is also stored in "this.Event".

Usage:

eventTable = Layout:GetEventTable()
ParameterTypeDatatypeDescription
eventTableresulttableThe event table of this element.

RiftScrollbar:GetHeight

Retrieves the height of this element.

Usage:

height = Layout:GetHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe height of this element.

RiftScrollbar:GetKeyFocus

Gets the key focus status.

Usage:

focus = Element:GetKeyFocus()
ParameterTypeDatatypeDescription
focusresultbooleanWhether this frame is the current key focus.

RiftScrollbar:GetLayer

Gets the frame's layer order.

Usage:

layer = Frame:GetLayer()
ParameterTypeDatatypeDescription
layerresultnumberThe render layer of this frame. See Frame:SetLayer for details.

RiftScrollbar:GetLeft

Retrieves the X position of the left edge of this element.

Usage:

left = Layout:GetLeft()
ParameterTypeDatatypeDescription
leftresultnumberThe X position of the left edge of this element.

RiftScrollbar:GetMouseMasking

Get the current mouse masking mode. See SetMouseMasking for details.

Usage:

mask = Element:GetMouseMasking()
ParameterTypeDatatypeDescription
maskresultstringThe current mouse masking mode.

RiftScrollbar:GetMouseoverUnit

Gets the unit that is being represented by this frame.

Usage:

unit = Frame:GetMouseoverUnit()
ParameterTypeDatatypeDescription
unitresultstringThe current mouseover unit. May be nil if there is no mouseover unit.

RiftScrollbar:GetName

Retrieves the name of this element.

Usage:

name = Layout:GetName()
ParameterTypeDatatypeDescription
nameresultstringThe name of this element, as provided by the addon that created it.

RiftScrollbar:GetOrientation

Gets the current orientation of the scrollbar.

Usage:

orientation = RiftScrollbar:GetOrientation()
ParameterTypeDatatypeDescription
orientationresultstringThe current orientation. Valid results include "vertical" and "horizontal".

RiftScrollbar:GetOwner

Retrieves the owner of this element.

Usage:

owner = Layout:GetOwner()
ParameterTypeDatatypeDescription
ownerresultstringThe owner of this element. Given as an addon identifier.

RiftScrollbar:GetParent

Gets the parent of this frame.

Usage:

parent = Frame:GetParent()
ParameterTypeDatatypeDescription
parentresultElementThe parent element of this frame.

RiftScrollbar:GetPosition

Returns the current position of the scrollbar.

Usage:

position = RiftScrollbar:GetPosition()
ParameterTypeDatatypeDescription
positionresultnumberThe current position of this scrollbar.

RiftScrollbar:GetRange

Returns the current range of the scrollbar.

Usage:

minimum, maximum = RiftScrollbar:GetRange()
ParameterTypeDatatypeDescription
maximumresultnumberThe maximum value for the position of this slider.
minimumresultnumberThe minimum value for the position of this slider.

RiftScrollbar:GetRight

Retrieves the X position of the right edge of this element.

Usage:

right = Layout:GetRight()
ParameterTypeDatatypeDescription
rightresultnumberThe X position of the right edge of this element.

RiftScrollbar:GetSecureMode

Get the current secure mode. See SetSecureMode for details.

Usage:

secure = Frame:GetSecureMode()
ParameterTypeDatatypeDescription
secureresultstringThe current secure mode.

RiftScrollbar:GetStrata

Gets the frame's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.

Usage:

strata = Frame:GetStrata()
ParameterTypeDatatypeDescription
strataresultstringThe item's current strata.

RiftScrollbar:GetStrataList

Gets a list of valid stratas for this frame.

Usage:

stratas = Frame:GetStrataList()
ParameterTypeDatatypeDescription
stratasresulttableAn array of valid stratas, in order.

RiftScrollbar:GetThickness

Returns the thickness of the scrollbar handle. Size is relative to the range.

Usage:

thickness = RiftScrollbar:GetThickness()
ParameterTypeDatatypeDescription
thicknessresultnumberThe thickness of the handle.

RiftScrollbar:GetTop

Retrieves the Y position of the top edge of this element.

Usage:

top = Layout:GetTop()
ParameterTypeDatatypeDescription
topresultnumberThe Y position of the top edge of this element.

RiftScrollbar:GetType

Retrieves the type of this element.

Usage:

type = Layout:GetType()
ParameterTypeDatatypeDescription
typeresultstringThe type of this element.

RiftScrollbar:GetVisible

Gets the visibility flag for this frame.

Usage:

visible = Element:GetVisible()
ParameterTypeDatatypeDescription
visibleresultbooleanThis frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.

RiftScrollbar:GetWidth

Retrieves the width of this element.

Usage:

width = Layout:GetWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe width of this element.

RiftScrollbar:Nudge

Modify the scrollbar position, clamped to the current bounds.

Usage:

RiftScrollbar:Nudge(offset)
ParameterTypeDatatypeDescription
offsetparameternumberThe amount to nudge.

RiftScrollbar:NudgeDown

Shift the scrollbar down (i.e. away from zero) by a standard amount.

Usage:

RiftScrollbar:NudgeDown()

RiftScrollbar:NudgeUp

Shift the scrollbar up (i.e. towards zero) by a standard amount.

Usage:

RiftScrollbar:NudgeUp()

RiftScrollbar:ReadAll

Read all set points and sizes from this frame.

Usage:

results = Layout:ReadAll()
ParameterTypeDatatypeDescription
resultsresulttableResult table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}.

RiftScrollbar:ReadHeight

Read a set height from this frame.

Usage:

height = Layout:ReadHeight()
ParameterTypeDatatypeDescription
heightresultnumberThe parameter passed to SetHeight(), or nil if no such parameter has been passed.

RiftScrollbar:ReadPoint

Read a set point from this frame. Must be given a single-axis coordinate.

Usage:

layout, position, offset = Layout:ReadPoint(coordinate)
layout, position, offset = Layout:ReadPoint(x, y)
origin, offset = Layout:ReadPoint(coordinate)
origin, offset = Layout:ReadPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate. Must be a one-axis coordinate.
xparameternumber/nilX coordinate of the point. Either this or Y must be nil.
yparameternumber/nilY coordinate of the point. Either this or X must be nil.
layoutresultLayoutThe table that this point is pinned to.
offsetresultnumberThe offset in pixels from the source location to the actual location.
originresultstringThe string "origin".
positionresultnumberThe position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge.

RiftScrollbar:ReadWidth

Read a set width from this frame.

Usage:

width = Layout:ReadWidth()
ParameterTypeDatatypeDescription
widthresultnumberThe parameter passed to SetWidth(), or nil if no such parameter has been passed.

RiftScrollbar:SetAllPoints

Pins all the edges of this frame to the edges of a different frame. If no target is given, defaults to this frame's parent.

Usage:

Frame:SetAllPoints()
Frame:SetAllPoints(target)
ParameterTypeDatatypeDescription
targetparameterLayoutTarget Layout to pin this frame's edges to.
noSecureFrameAndEnvironment
true

RiftScrollbar:SetAlpha

Sets the alpha transparency multiplier for this frame and its children.

Usage:

Element:SetAlpha(alpha)
ParameterTypeDatatypeDescription
alphaparameternumberThe new alpha multiplier. 1 is fully opaque, 0 is fully transparent.

RiftScrollbar:SetBackgroundColor

Sets the background color of this frame.

Usage:

Element:SetBackgroundColor(r, g, b)
Element:SetBackgroundColor(r, g, b, a)
ParameterTypeDatatypeDescription
aparameternumberAlpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
bparameternumberBlue.
gparameternumberGreen.
rparameternumberRed.

RiftScrollbar:SetEnabled

Sets whether the scrollbar is enabled or disabled.

Usage:

RiftScrollbar:SetEnabled(enabled)
ParameterTypeDatatypeDescription
enabledparameterbooleanThe new enable state of this item.

RiftScrollbar:SetHeight

Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.

Usage:

Frame:SetHeight(height)
ParameterTypeDatatypeDescription
heightparameternumberThe new height of this frame.
noSecureFrameAndEnvironment
true

RiftScrollbar:SetKeyFocus

Sets the key focus status. Note that only one frame can be the key focus at a time. Focusing on another frame will automatically unset the current focus.

Usage:

Element:SetKeyFocus(focus)
ParameterTypeDatatypeDescription
focusparameterbooleanThe new key focus setting.

RiftScrollbar:SetLayer

Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but guarantees no Z-fighting. Frames are always drawn after their parents.

Usage:

Frame:SetLayer(layer)
ParameterTypeDatatypeDescription
layerparameternumberThe new layer for this frame.
noSecureFrameAndEnvironment
true

RiftScrollbar:SetMouseMasking

Sets the frame's mouse masking mode.

Usage:

Element:SetMouseMasking(mask)
ParameterTypeDatatypeDescription
maskparameterstringThe new mouse masking mode. "full" is the standard mode, and means that creating any Left, Right, or movement-related mouse event will cause the frame to accept and consume any event from any of those types. "limited" causes the frame to accept and consume only events for buttons that have been hooked, so that hooking "LeftDown" will still pass Right mouse events through the frame. Note that hooking any mouse event will still consume MouseMove/In/Out events.
noSecureFrameAndEnvironment
true

RiftScrollbar:SetMouseoverUnit

Sets the unit that will be represented by this frame.

Usage:

Frame:SetMouseoverUnit(unit)
ParameterTypeDatatypeDescription
unitparameternil, unitThe new mouseover unit. May be a unit ID or a unit specifier. Pass in nil to disable the mouseover effect.
requireSecureFrameAndInsecureEnvironment
true

RiftScrollbar:SetOrientation

Sets the orientation of the scrollbar.

Usage:

RiftScrollbar:SetOrientation(orientation)
ParameterTypeDatatypeDescription
orientationparameterstringThe new orientation. Must be either "vertical" or "horizontal".

RiftScrollbar:SetParent

Sets the parent of this frame. Circular dependencies result in undefined behavior. If this frame's secure mode is "restricted", then its parent must also have a secure mode of "restricted".

Usage:

Frame:SetParent(parent)
ParameterTypeDatatypeDescription
parentparameterElementThe new parent for this frame.
noSecureFrameAndEnvironment
true

RiftScrollbar:SetPoint

Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it.
This function can take many different forms. In general, it looks like this: SetPoint(point_on_this_frame, target_frame, point_on_target_frame [, x_offset, y_offset]).
The first part is the point on this frame that will be attached. Usually, these are string identifiers. "TOPLEFT", "TOPCENTER", "TOPRIGHT", "CENTERLEFT", "CENTER", "CENTERRIGHT", "BOTTOMLEFT", "BOTTOMCENTER", "BOTTOMRIGHT". You may also use a string identifier that refers to a single axis - "TOP", "BOTTOM", "LEFT", "RIGHT", "CENTERX", "CENTERY". If you want more direct numeric control you can use number pairs. 0,0 is equivalent to "TOPLEFT", 1,1 is equivalent to "BOTTOMRIGHT", 0.5,nil is equivalent to "CENTERX".
The second part is the frame to attach to, as well as the point on that frame to attach to. The frame is simply passing in the frame table. The point is the same identifier or number pair as the first parameter.
Optionally, you may include an X or Y offset to the point.
This connection is permanent, and if the target frame moves, this frame will move along with it.
Caveat: If the target is a frame set to the "restricted" SecureMode, and the client is currently in "secure" mode, then unexpected behavior may occur.

Usage:

Frame:SetPoint(...)
ParameterTypeDatatypeDescription
...parameter...This function's parameters are complicated. Read the above summary for details.
noSecureFrameAndEnvironment
true

RiftScrollbar:SetPosition

Changes the current position of the scrollbar.

Usage:

RiftScrollbar:SetPosition(position)
ParameterTypeDatatypeDescription
positionparameternumberThe new position of this scrollbar. Must be within the current range.

RiftScrollbar:SetRange

Changes the current range of the scrollbar.

Usage:

RiftScrollbar:SetRange(minimum, maximum)
ParameterTypeDatatypeDescription
maximumparameternumberThe new maximum value for the position of this slider. Must be an integer and larger than or equal to "minimum".
minimumparameternumberThe new minimum value for the position of this slider. Must be an integer and smaller than or equal to "maximum".

RiftScrollbar:SetSecureMode

Sets the frame's secure mode.
"normal" is the standard mode. It allows for most functionality to be used and does not restrict frames in combat. "restricted" allows for certain sensitive functions to be called, but disables a significant amount of functionality in combat. In order to change a frame to "restricted", its parent must already be "restricted". Note that a "restricted" frame can still have "normal" children.
If you are not planning to use any restricted functions, your frame should remain in normal mode.
At the moment, it is not possible to change from "restricted" back to "normal".

Usage:

Frame:SetSecureMode(secure)
ParameterTypeDatatypeDescription
secureparameterstringThe new secure mode. Valid inputs are "normal" and "restricted".

RiftScrollbar:SetStrata

Sets the strata for this frame.

Usage:

Frame:SetStrata(strata)
ParameterTypeDatatypeDescription
strataparameterstringThe item's new strata. Must be one of the elements returned by :GetStrataList().
noSecureFrameAndEnvironment
true

RiftScrollbar:SetThickness

Sets the current thickness of the scrollbar handle. Size is relative to the range.

Usage:

RiftScrollbar:SetThickness(thickness)
ParameterTypeDatatypeDescription
thicknessparameternumberThe new thickness of the handle.

RiftScrollbar:SetVisible

Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.

Usage:

Element:SetVisible(visible)
ParameterTypeDatatypeDescription
visibleparameterbooleanThe new visibility flag.
noSecureFrameAndEnvironment
true

RiftScrollbar:SetWidth

Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.

Usage:

Frame:SetWidth(width)
ParameterTypeDatatypeDescription
widthparameternumberThe new width of this frame.
noSecureFrameAndEnvironment
true

RiftSlider

A UI element of type RiftSlider or derived from RiftSlider.

RiftSlider.Event:KeyDown

Signals a key pressed.

Usage:

Frame.Event:KeyDown(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftSlider.Event:KeyFocusGain

Signals gaining key focus.

Usage:

Frame.Event:KeyFocusGain()

RiftSlider.Event:KeyFocusLoss

Signals losing key focus.

Usage:

Frame.Event:KeyFocusLoss()

RiftSlider.Event:KeyRepeat

Frame.Event:KeyRepeat@summary

Usage:

Frame.Event:KeyRepeat(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftSlider.Event:KeyType

Signals text typed.

Usage:

Frame.Event:KeyType(typed)
ParameterTypeDatatypeDescription
typedparametervariantThe text.

RiftSlider.Event:KeyUp

Signals a key released.

Usage:

Frame.Event:KeyUp(button)
ParameterTypeDatatypeDescription
buttonparametervariantThe key, in string form.

RiftSlider.Event:Layer

Signals a change in the item's layer.

Usage:

Frame.Event:Layer()

RiftSlider.Event:LeftClick

Signals that the mouse's left button has been clicked inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftClick()

RiftSlider.Event:LeftDown

Signals that the mouse's left button has been pressed inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftDown()

RiftSlider.Event:LeftUp

Signals that the mouse's left button has been released inside the frame. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUp()

RiftSlider.Event:LeftUpoutside

Signals that the mouse's left button has been released outside the frame, after a "Down" message. Blocks left mouse events and mouse movement events from frames below this one. May block right mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:LeftUpoutside()

RiftSlider.Event:MiddleClick

Signals that the mouse's middle button has been clicked inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleClick()

RiftSlider.Event:MiddleDown

Signals that the mouse's middle button has been pressed inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleDown()

RiftSlider.Event:MiddleUp

Signals that the mouse's middle button has been released inside the frame. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUp()

RiftSlider.Event:MiddleUpoutside

Signals that the mouse's middle button has been released outside the frame, after a "Down" message. Blocks middle mouse events from frames below this one.

Usage:

Frame.Event:MiddleUpoutside()

RiftSlider.Event:Mouse4Click

Signals that the mouse's fourth button has been clicked inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Click()

RiftSlider.Event:Mouse4Down

Signals that the mouse's fourth button has been pressed inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Down()

RiftSlider.Event:Mouse4Up

Signals that the mouse's fourth button has been released inside the frame. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Up()

RiftSlider.Event:Mouse4Upoutside

Signals that the mouse's fourth button has been released outside the frame, after a "Down" message. Blocks fourth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse4Upoutside()

RiftSlider.Event:Mouse5Click

Signals that the mouse's fifth button has been clicked inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Click()

RiftSlider.Event:Mouse5Down

Signals that the mouse's fifth button has been pressed inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Down()

RiftSlider.Event:Mouse5Up

Signals that the mouse's fifth button has been released inside the frame. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Up()

RiftSlider.Event:Mouse5Upoutside

Signals that the mouse's fifth button has been released outside the frame, after a "Down" message. Blocks fifth button mouse events from frames below this one.

Usage:

Frame.Event:Mouse5Upoutside()

RiftSlider.Event:MouseIn

Signals that the mouse cursor has been moved onto the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseIn()

RiftSlider.Event:MouseMove

Signals that the mouse cursor has been moved within the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseMove(x, y)
ParameterTypeDatatypeDescription
xparametervariantX coordinate.
yparameter<nope>Y coordinate.

RiftSlider.Event:MouseOut

Signals that the mouse cursor has been moved off of the frame. Blocks mouse movement events from frames below this one. May block left and right events depending on the MouseMasking mode.

Usage:

Frame.Event:MouseOut()

RiftSlider.Event:Move

Signals that the frame's vertices have moved.

Usage:

Layout.Event:Move()

RiftSlider.Event:RightClick

Signals that the mouse's right button has been clicked inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightClick()

RiftSlider.Event:RightDown

Signals that the mouse's right button has been pressed inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightDown()

RiftSlider.Event:RightUp

Signals that the mouse's right button has been released inside the frame. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUp()

RiftSlider.Event:RightUpoutside

Signals that the mouse's right button has been released outside the frame, after a "Down" message. Blocks right mouse events and mouse movement events from frames below this one. May block left mouse events depending on the MouseMasking mode.

Usage:

Frame.Event:RightUpoutside()

RiftSlider.Event:Size

Signals that the frame's size has changed.

Usage:

Layout.Event:Size()

RiftSlider.Event:SliderChange

Signals a change in the slider position.

Usage:

RiftSlider.Event:SliderChange()

RiftSlider.Event:SliderGrab

Signals the user grabbing the slider with the mouse.

Usage:

RiftSlider.Event:SliderGrab()

RiftSlider.Event:SliderRelease

Signals the user releasing the slider.

Usage:

RiftSlider.Event:SliderRelease()

RiftSlider.Event:Strata

Signals a change in the item's strata.

Usage:

Frame.Event:Strata()

RiftSlider.Event:WheelBack

Signals that the mousewheel has been moved backward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelBack()

RiftSlider.Event:WheelForward

Signals that the mousewheel has been moved forward inside the frame. Blocks mousewheel events from frames below this one.

Usage:

Frame.Event:WheelForward()

RiftSlider:ClearAll

Clear all set points and sizes from this frame.

Usage:

Frame:ClearAll()
noSecureFrameAndEnvironment
true

RiftSlider:ClearHeight

Clear a set height from this frame.

Usage:

Frame:ClearHeight()
noSecureFrameAndEnvironment
true

RiftSlider:ClearPoint

Clear a set point from this frame.

Usage:

Frame:ClearPoint(coordinate)
Frame:ClearPoint(x, y)
ParameterTypeDatatypeDescription
coordinateparameterstringNamed coordinate.
xparameternumber/nilX coordinate of the point.
yparameternumber/nilY coordinate of the point.
noSecureFrameAndEnvironment
true