Name | Type | Deprecated | Secure | Description |
---|---|---|---|---|
Native | A UI element of type Native or derived from Native. | |||
Native.Event:Layer | Signals a change in the item's layer. | |||
Native.Event:Loaded | Signals a change in the item's loaded status. | |||
Native.Event:Move | Signals that the frame's vertices have moved. | |||
Native.Event:Size | Signals that the frame's size has changed. | |||
Native.Event:Strata | Signals a change in the item's strata. | |||
Native:EventAttach | function | Attaches an event handler to an event. | ||
Native:EventDetach | function | Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a... | ||
Native:EventList | function | Lists the current event handlers for an event. | ||
Native:EventMacroGet | function | Gets the macro that will be triggered when this event occurs. | ||
Native:EventMacroSet | function | Sets the macro that will be triggered when this event occurs. | ||
Native:GetBottom | function | Retrieves the Y position of the bottom edge of this element. | ||
Native:GetBounds | function | Retrieves the complete bounds of this element. | ||
Native:GetEventTable | function | Retrieves the event table of this element. By default, this value is also stored in "this.Event". | ||
Native:GetHeight | function | Retrieves the height of this element. | ||
Native:GetLayer | function | Gets the native item's layer order. | ||
Native:GetLeft | function | Retrieves the X position of the left edge of this element. | ||
Native:GetLoaded | function | Gets whether or not this native element is loaded and rendering. | ||
Native:GetName | function | Retrieves the name of this element. | ||
Native:GetOwner | function | Retrieves the owner of this element. | ||
Native:GetRight | function | Retrieves the X position of the right edge of this element. | ||
Native:GetSecureMode | function | Get the native element's secure mode. See Frame:SetSecureMode() for details. | ||
Native:GetStrata | function | Gets the native item's strata. The strata determines render order on a coarser level than Layer d... | ||
Native:GetStrataList | function | Gets a list of valid stratas for this native element. | ||
Native:GetTop | function | Retrieves the Y position of the top edge of this element. | ||
Native:GetType | function | Retrieves the type of this element. | ||
Native:GetWidth | function | Retrieves the width of this element. | ||
Native:ReadAll | function | Read all set points and sizes from this frame. | ||
Native:ReadHeight | function | Read a set height from this frame. | ||
Native:ReadPoint | function | Read a set point from this frame. Must be given a single-axis coordinate. | ||
Native:ReadWidth | function | Read a set width from this frame. | ||
Native:SetLayer | function | Sets the frame layer for this native element. This can be any number. Frames are drawn in ascendi... | ||
Native:SetStrata | function | Sets the strata for this native element. | ||
UI.Native.Ability | The Ability dialog. | |||
UI.Native.Accolade | The Warfront accolade HUD. | |||
UI.Native.Achievement | The Achievement dialog. | |||
UI.Native.AchievementPopup | The "Achievement Complete" popup. | |||
UI.Native.Adventure | The Instant Adventure dialog. | |||
UI.Native.Ascend | The Ascend-a-Friend dialog. | |||
UI.Native.Attunement | The Planar Attunement dialog. | |||
UI.Native.Auction | The Auction dialog. | |||
UI.Native.Bag | The bag and currency HUD. | |||
UI.Native.BagBank1 | The first bank inventory bag. | |||
UI.Native.BagBank2 | The second bank inventory bag. | |||
UI.Native.BagBank3 | The third bank inventory bag. | |||
UI.Native.BagBank4 | The fourth bank inventory bag. | |||
UI.Native.BagBank5 | The fifth bank inventory bag. | |||
UI.Native.BagBank6 | The sixth bank inventory bag. | |||
UI.Native.BagBank7 | The seventh bank inventory bag. | |||
UI.Native.BagBank8 | The eighth bank inventory bag. | |||
UI.Native.BagInventory1 | The first main inventory bag. | |||
UI.Native.BagInventory2 | The second main inventory bag. | |||
UI.Native.BagInventory3 | The third main inventory bag. | |||
UI.Native.BagInventory4 | The fourth main inventory bag. | |||
UI.Native.BagInventory5 | The fifth main inventory bag. | |||
UI.Native.Bank | The Bank dialog. | |||
UI.Native.BankGuild | The Guild Bank dialog. | |||
UI.Native.BarBottom1 | The first extra bottom action bar. | |||
UI.Native.BarBottom2 | The second extra bottom action bar. | |||
UI.Native.BarBottom3 | The third extra bottom action bar. | |||
UI.Native.BarBottom4 | The fourth extra bottom action bar. | |||
UI.Native.BarBottom5 | The fifth extra bottom action bar. | |||
UI.Native.BarBottom6 | The sixth extra bottom action bar. | |||
UI.Native.BarMain | The main action bar. | |||
UI.Native.BarPet | The pet action bar. | |||
UI.Native.BarSide1 | The first extra side action bar. | |||
UI.Native.BarSide2 | The second extra side action bar. | |||
UI.Native.BarSide3 | The third extra side action bar. | |||
UI.Native.BarSide4 | The fourth extra side action bar. | |||
UI.Native.BarTemporary | The action bar used for temporary abilities. | |||
UI.Native.Breath | The breath/fatigue bar. | |||
UI.Native.Buffbar | The player's buff bar. | |||
UI.Native.Castbar | The player's cast bar. | |||
UI.Native.Character | The Character dialog. | |||
UI.Native.Chronicle | The Chronicles dialog. | |||
UI.Native.Coinlock | The Coin Lock button. | |||
UI.Native.Console1 | The first console window. | |||
UI.Native.Console2 | The second console window. | |||
UI.Native.Console3 | The third console window. | |||
UI.Native.Console4 | The fourth console window. | |||
UI.Native.Console5 | The fifth console window. | |||
UI.Native.Console6 | The sixth console window. | |||
UI.Native.Console7 | The seventh console window. | |||
UI.Native.ConsoleSetting | The console settings dialog. | |||
UI.Native.Crafting | The Crafting dialog. | |||
UI.Native.Ctf | The Capture-the-Flag status indicator. | |||
UI.Native.Guest | The guest invite dialog for weddings. | |||
UI.Native.Guild | The Guild dialog. | |||
UI.Native.GuildCharter | The Guild Charter dialog. | |||
UI.Native.GuildFinder | The Guild Finder dialog. | |||
UI.Native.Import | The Import dialog, as reached from the escape menu. | |||
UI.Native.Keybind | The Keybind dialog. | |||
UI.Native.Layout | The UI Layout dialog. | |||
UI.Native.Leaderboard | The Leaderboard dialog. | |||
UI.Native.Lfg | The Looking-for-Group dialog. | |||
UI.Native.Loot | The Loot dialog. | |||
UI.Native.Macro | The Macro dialog. | |||
UI.Native.MacroIcon | The Macro icons list. | |||
UI.Native.MacroSlash | The Macro slash commands list. | |||
UI.Native.Mail | The Mail dialog. | |||
UI.Native.MailRead | The currently-being-read Mail dialog. | |||
UI.Native.MapMain | The main map. | |||
UI.Native.MapMini | The minimap. | |||
UI.Native.MechanicPlayer | The player-focused class-specific-mechanic HUD element. | |||
UI.Native.MechanicTarget | The target-focused class-specific-mechanic HUD element. | |||
UI.Native.Mentor | The Mentoring popup. | |||
UI.Native.Menu | The main menu HUD element. | |||
UI.Native.MessageEvent | The event-related message popup. | |||
UI.Native.MessageStandard | The generic message popup. | |||
UI.Native.MessageText | The generic text popup. | |||
UI.Native.MessageWarfront | The warfront-related message popup. | |||
UI.Native.MessageZone | The zone-related message popup. | |||
UI.Native.Notification | The notification message popup. | |||
UI.Native.Notify | The public-group/return-to-graveyard popup button. | |||
UI.Native.PortraitFocus | The portrait of your focus target. | |||
UI.Native.PortraitParty1 | The portrait of your first partymember. | |||
UI.Native.PortraitParty1Pet | The portrait of your first partymember's pet. | |||
UI.Native.PortraitParty2 | The portrait of your second partymember. | |||
UI.Native.PortraitParty2Pet | The portrait of your second partymember's pet. | |||
UI.Native.PortraitParty3 | The portrait of your third partymember. | |||
UI.Native.PortraitParty3Pet | The portrait of your third partymember's pet. | |||
UI.Native.PortraitParty4 | The portrait of your fourth partymember. | |||
UI.Native.PortraitParty4Pet | The portrait of your fourth partymember's pet. | |||
UI.Native.PortraitPet | The portrait of your pet. | |||
UI.Native.PortraitPlayer | Your portrait. | |||
UI.Native.PortraitTarget | The portrait of your target. | |||
UI.Native.PortraitTargetTarget | The portrait of your target's target. | |||
UI.Native.Quest | The Quest dialog. | |||
UI.Native.QuestStickies | The Quest sticky HUD. | |||
UI.Native.Question | The general-purpose question popup. | |||
UI.Native.Raid | The Raid dialog. | |||
UI.Native.RaidGroup1 | The raid frame for your raid's first group. | |||
UI.Native.RaidGroup1Pet | The raid frame for your raid's first group's pets. | |||
UI.Native.RaidGroup2 | The raid frame for your raid's second group. | |||
UI.Native.RaidGroup2Pet | The raid frame for your raid's second group's pets. | |||
UI.Native.RaidGroup3 | The raid frame for your raid's third group. | |||
UI.Native.RaidGroup3Pet | The raid frame for your raid's third group's pets. | |||
UI.Native.RaidGroup4 | The raid frame for your raid's fourth group. | |||
UI.Native.RaidGroup4Pet | The raid frame for your raid's fourth group's pets. | |||
UI.Native.RaidParty | The raid frame used for displaying your party as a raid. | |||
UI.Native.RaidPartyPet | The raid frame used for displaying your party's pets as a raid. | |||
UI.Native.Reactive | The reactive-ability popup. | |||
UI.Native.Recall | The set-recall-point dialog. | |||
UI.Native.Respec | The respec dialog. | |||
UI.Native.Rift | The Rift meter HUD. | |||
UI.Native.Roll1 | The first loot-roll popup. | |||
UI.Native.Roll2 | The second loot-roll popup. | |||
UI.Native.Roll3 | The third loot-roll popup. | |||
UI.Native.Roll4 | The fourth loot-roll popup. | |||
UI.Native.Setting | The Settings dialog. | |||
UI.Native.Social | The Social dialog. | |||
UI.Native.Soul | The Soul Tree dialog. | |||
UI.Native.Split | The stack split popup. | |||
UI.Native.Streaming | The icon that indicates your current streaming download status. | |||
UI.Native.Ticket | The Customer Service Ticket dialog. | |||
UI.Native.Tip | The Game Tip dialog. | |||
UI.Native.TipAlert | The Game Tip notification popup. | |||
UI.Native.Tooltip | The tooltip. | |||
UI.Native.TooltipAnchor | The location that tooltips are anchored to by default. | |||
UI.Native.Trade | The Trade dialog. | |||
UI.Native.Tray | The icon tray used for the clock, mail notification, and similar elements. | |||
UI.Native.TraySocial | The icon tray used for social notifications. | |||
UI.Native.Treasure | The Treasure popup used to claim dungeon loot. | |||
UI.Native.Trial | The Trial dialog. | |||
UI.Native.Upgrade | The Upgrade portrait, used for targets that are upgradeable. | |||
UI.Native.Warfront | The Warfront dialog. | |||
UI.Native.WarfrontLeaderboard | The Warfront Leaderboard dialog. | |||
UI.Native.World | The World Event dialog. |
A UI element of type Native or derived from Native.
Signals a change in the item's layer.
Native.Event:Layer() |
Signals a change in the item's loaded status.
Native.Event:Loaded() |
Signals that the frame's vertices have moved.
Layout.Event:Move() |
Signals that the frame's size has changed.
Layout.Event:Size() |
Signals a change in the item's strata.
Native.Event:Strata() |
Attaches an event handler to an event.
Layout:EventAttach(handle, callback, label) | |||
Layout:EventAttach(handle, callback, label, priority) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
callback | parameter | function | A global event handler function. This will be called when the event fires. The first parameter will be the standard frame event handle, any other parameters will follow that. |
handle | parameter | eventFrame | A handle to a frame event, usually pulled out of the "Event.UI." hierarchy. |
label | parameter | string | Human-readable label used to identify the handler in error reports, performance reports, and for later detaching. |
priority | parameter | number | Priority of the event handler. Higher numbers trigger first. |
Detaches an event handler from an event. Any parameter can be 'nil', and this is interpreted as a wildcard. If multiple events match the constraints, only one will be detached.
Layout:EventDetach(handle, callback) | |||
Layout:EventDetach(handle, callback, label) | |||
Layout:EventDetach(handle, callback, label, priority) | |||
Layout:EventDetach(handle, callback, label, priority, owner) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
callback | parameter | function/nil | A callback function to search for. |
handle | parameter | eventFrame | A handle to a frame event, usually pulled out of the "Event.UI." hierarchy. |
label | parameter | string/nil | Human-readable label used to identify the handler in error reports, performance reports, and for later detaching. |
owner | parameter | string/nil | Owner to search for. |
priority | parameter | number/nil | Priority of the event handler. Higher numbers trigger first. |
Lists the current event handlers for an event.
result = Layout:EventList(handle) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
handle | parameter | eventFrame | A handle to a frame event, usually pulled out of the "Event.UI." hierarchy. |
result | result | table | A table of event handlers for this event. |
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. |
Gets the macro that will be triggered when this event occurs.
macro = Layout:EventMacroGet(handle) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
handle | parameter | eventFrame | A handle to a frame event, usually pulled out of the "Event.UI." hierarchy. |
macro | result | string/nil | The macro that will be triggered. |
Sets the macro that will be triggered when this event occurs.
Layout:EventMacroSet(handle, macro) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
handle | parameter | eventFrame | A handle to a frame event, usually pulled out of the "Event.UI." hierarchy. |
macro | parameter | string/nil | The macro to trigger. nil to clear the macro. |
Retrieves the Y position of the bottom edge of this element.
bottom = Layout:GetBottom() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
bottom | result | number | The Y position of the bottom edge of this element. |
Retrieves the complete bounds of this element.
left, top, right, bottom = Layout:GetBounds() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
bottom | result | number | The Y position of the bottom edge of this element. |
left | result | number | The X position of the left edge of this element. |
right | result | number | The X position of the right edge of this element. |
top | result | number | The Y position of the top edge of this element. |
Retrieves the event table of this element. By default, this value is also stored in "this.Event".
eventTable = Layout:GetEventTable() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
eventTable | result | table | The event table of this element. |
Retrieves the height of this element.
height = Layout:GetHeight() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
height | result | number | The height of this element. |
Gets the native item's layer order.
layer = Native:GetLayer() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
layer | result | number | The render layer of this frame. See Frame:SetLayer for details. |
Retrieves the X position of the left edge of this element.
left = Layout:GetLeft() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
left | result | number | The X position of the left edge of this element. |
Gets whether or not this native element is loaded and rendering.
loaded = Native:GetLoaded() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
loaded | result | boolean | true if it is loaded. |
Retrieves the name of this element.
name = Layout:GetName() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
name | result | string | The name of this element, as provided by the addon that created it. |
Retrieves the owner of this element.
owner = Layout:GetOwner() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
owner | result | string | The owner of this element. Given as an addon identifier. |
Retrieves the X position of the right edge of this element.
right = Layout:GetRight() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
right | result | number | The X position of the right edge of this element. |
Get the native element's secure mode. See Frame:SetSecureMode() for details.
secure = Native:GetSecureMode() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
secure | result | string | The current secure mode. |
Gets the native item's strata. The strata determines render order on a coarser level than Layer does, as well as determining how far an element is brought to the front when clicked on.
strata = Native:GetStrata() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
strata | result | string | The item's current strata. |
Gets a list of valid stratas for this native element.
stratas = Native:GetStrataList() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
stratas | result | table | An array of valid stratas, in order. |
Retrieves the Y position of the top edge of this element.
top = Layout:GetTop() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
top | result | number | The Y position of the top edge of this element. |
Retrieves the type of this element.
type = Layout:GetType() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
type | result | string | The type of this element. |
Retrieves the width of this element.
width = Layout:GetWidth() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
width | result | number | The width of this element. |
Read all set points and sizes from this frame.
results = Layout:ReadAll() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
results | result | table | Result table. Contains data in the following format: {x = {size = (size), [(position)] = {layout = (layout), position = (position), offset = (offset)}}, y = (the same thing)}. |
Read a set height from this frame.
height = Layout:ReadHeight() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
height | result | number | The parameter passed to SetHeight(), or nil if no such parameter has been passed. |
Read a set point from this frame. Must be given a single-axis coordinate.
layout, position, offset = Layout:ReadPoint(coordinate) | |||
layout, position, offset = Layout:ReadPoint(x, y) | |||
origin, offset = Layout:ReadPoint(coordinate) | |||
origin, offset = Layout:ReadPoint(x, y) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
coordinate | parameter | string | Named coordinate. Must be a one-axis coordinate. |
x | parameter | number/nil | X coordinate of the point. Either this or Y must be nil. |
y | parameter | number/nil | Y coordinate of the point. Either this or X must be nil. |
layout | result | Layout | The table that this point is pinned to. |
offset | result | number | The offset in pixels from the source location to the actual location. |
origin | result | string | The string "origin". |
position | result | number | The position on "layout" that this point is pinned. 0 refers to the top or left edge, 1 refers to the bottom or right edge. |
Read a set width from this frame.
width = Layout:ReadWidth() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
width | result | number | The parameter passed to SetWidth(), or nil if no such parameter has been passed. |
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.
Native:SetLayer(layer) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
layer | parameter | number | The new layer for this frame. |
Sets the strata for this native element.
Native:SetStrata(layer) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
layer | parameter | string | The new layer for this frame. |
The Ability dialog.