Widget API

Main Menu
WoW API Lua API FrameXML util Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Widgets are user interface elements, created from Lua functions like CreateFrame() and XML tags like <Frame>. This page lists the defined methods for each widget type, grouping together types with common inheritance.

Most widgets also have widget script handlers (responding to actions), and this list may be extended with virtual XML templates (more methods) and intrinsic frames (more widget types).

Widgets drawn on the UI may be inspected with /fstack, /tinspect and debug addons.

Abstract	Base	Frame	Animation
UIObject ParentedObject ScriptObject Region LayeredRegion FontInstance	Frame AnimationGroup Animation ControlPoint Texture MaskTexture Line Font FontString	Browser Button CheckButton ItemButton Checkout ColorSelect Cooldown EditBox FogOfWarFrame GameTooltip MessageFrame Minimap Model PlayerModel CinematicModel DressUpModel TabardModel ModelScene ModelSceneActor MovieFrame OffScreenFrame POIFrame ArchaeologyDigSiteFrame QuestPOIFrame ScenarioPOIFrame ScrollFrame ScrollingMessageFrame SimpleHTML Slider StatusBar UnitPositionFrame WorldFrame ...other	Alpha Scale LineScale Translation LineTranslation Path Rotation TextureCoordTranslation

Widget Hierarchy

References: Blizzard. XML Schema Definition. wowprogramming. Widget Hierarchy. Townlong Yak. Helix/WidgetAPI.lua. Resike. BlizzardInterfaceResources. Ketho. BlizzardInterfaceResources.

Note: This list is up to date as of Patch 9.1.5 (40871) Oct 29 2021

UIObject

[Edit UIObject]

UIObject is an abstract widget type that all user interface elements derive from.

UIObject:GetName() - Returns the widget object's name.

UIObject:GetObjectType() - Returns the object's widget type.

UIObject:IsObjectType(type) - Returns whether the object belongs to a given widget type.

ParentedObject

[Edit ParentedObject]

ParentedObject (inherits from UIObject) is an abstract UI type that provides support for querying the parent of a given object.

ParentedObject:GetDebugName() - Returns the widget object's debug name.

ParentedObject:GetParent() - Returns the widget's parent object.

ParentedObject:IsForbidden() - Returns if this widget's methods may only be called from secure execution paths.

ParentedObject:SetForbidden() - Sets the widget to be forbidden for insecure code.

ScriptObject

[Edit ScriptObject]

ScriptObject is an abstract widget type that provides support for widget scripts.

ScriptObject:GetScript(scriptType [, bindingType]) - Returns the widget's script handler.

ScriptObject:SetScript(scriptType, handler) - Sets the widget's script handler.

ScriptObject:HookScript(scriptType, handler [, bindingType]) - Securely hooks a script handler.

ScriptObject:HasScript(scriptType) - Returns whether the widget supports a script type.

Region

Region:GetAlpha() : alpha - Returns the region's opacity.

Region:GetDrawLayer() : layer, sublayer - Returns the layer in which the region is drawn.

Region:GetEffectiveScale() : effectiveScale - Returns the scale of the region after propagating from its parents.

Region:GetScale() : scale - Returns the scale of the region.

Region:GetVertexColor() : colorR, colorG, colorB, colorA - Returns the vertex color shading of the region.

Region:IsIgnoringParentAlpha() : isIgnoring - Returns true if the region is ignoring parent alpha.

Region:IsIgnoringParentScale() : isIgnoring - Returns true if the region is ignoring parent scale.

Region:IsObjectLoaded() : isLoaded - Returns true if the region is fully loaded.

Region:SetAlpha(alpha) - Sets the opacity of the region.

Region:SetDrawLayer(layer [, sublevel]) - Sets the layer in which the region is drawn.

Region:SetIgnoreParentAlpha(ignore) - Sets whether the region should ignore its parent's alpha.

Region:SetIgnoreParentScale(ignore) - Sets whether the region should ignore its parent's scale.

Region:SetScale(scale) - Sets the size scaling of the region.

Region:SetVertexColor(colorR, colorG, colorB [, a]) - Sets the vertex shading color of the region.

LayeredRegion

[Edit LayeredRegion]

LayeredRegion (inherits from Region) is an abstract widget type that groups together the functionality of layered graphical regions: Textures, FontStrings, Lines and MaskTextures.

LayeredRegion:GetDrawLayer() - Returns the layer at which the region's graphics are drawn relative to others in its frame.

LayeredRegion:SetDrawLayer(layer [, sublevel]) - Sets the layer at which the region's graphics are drawn relative to others in its frame.

LayeredRegion:SetVertexColor(r, g, b [, a]) - Sets a color shading for the region's graphics.

AnimationGroup

AnimationGroups (inherits from ParentedObject and ScriptObject, created with Region:CreateAnimationGroup) control how various animations are actually applied to a region.^[1]
zork 2010-09-22. 3.1.0 Animation roundup.

AnimationGroup:CreateAnimation(animationType, [name[,inheritsFrom]]) - Create and return an Animation as a child of this group.

AnimationGroup:Finish() - Notify this group to stop playing once the current loop cycle is done. Does nothing if this group is not playing.

AnimationGroup:GetAnimations()

AnimationGroup:GetDuration() - Gets the total duration across all child Animations that the group will take to complete one loop cycle.

AnimationGroup:GetLoopState() - Gets the current loop state of the group. Output is [NONE, FORWARD, or REVERSE].

AnimationGroup:GetLooping() - Gets the type of looping for the group.

AnimationGroup:GetProgress() - Returns the progress of this animation as a unit value [0,1].

AnimationGroup:IsDone() - Returns true if the group has finished playing.

AnimationGroup:IsPaused() - Returns true if the group is paused.

AnimationGroup:IsPendingFinish()

AnimationGroup:IsPlaying() - Returns true if the group is playing.

AnimationGroup:IsSetToFinalAlpha()

AnimationGroup:Pause() - Pause the animations in this group.

AnimationGroup:Play() - Start playing the animations in this group.

AnimationGroup:RemoveAnimations()

AnimationGroup:Restart()

AnimationGroup:SetLooping(loopType) - Sets the type of looping for the group. Input is [NONE, REPEAT, or BOUNCE].

AnimationGroup:SetPlaying(play)

AnimationGroup:SetToFinalAlpha() - Apply the animations final resulting alpha to all animating regions.

AnimationGroup:Stop() - Stop all animations in this group.

Animation

Animation:GetDuration() : durationSec

Animation:GetElapsed() : elapsedSec

Animation:GetEndDelay() : delaySec

Animation:GetOrder() : order

Animation:GetProgress() : progress

Animation:GetRegionParent() : region

Animation:GetScript(scriptTypeName [, bindingType]) : script

Animation:GetSmoothProgress() : progress

Animation:GetSmoothing() : weights

Animation:GetStartDelay() : delaySec

Animation:GetTarget() : target

Animation:HasScript(scriptName) : hasScript

Animation:HookScript(scriptTypeName, script [, bindingType])

Animation:IsDelaying() : isDelaying

Animation:IsDone() : isDone

Animation:IsPaused() : isPaused

Animation:IsPlaying() : isPlaying

Animation:IsStopped() : isStopped

Animation:Pause()

Animation:Play()

Animation:Restart()

Animation:SetChildKey(childKey) : success

Animation:SetDuration(durationSec [, recomputeGroupDuration])

Animation:SetEndDelay(delaySec [, recomputeGroupDuration])

Animation:SetOrder(newOrder)

Animation:SetParent(parent [, order])

Animation:SetPlaying(play)

Animation:SetScript(scriptTypeName [, script])

Animation:SetSmoothProgress(durationSec)

Animation:SetSmoothing(weights)

Animation:SetStartDelay(delaySec [, recomputeGroupDuration])

Animation:SetTarget(target) : success

Animation:SetTargetKey(key) : success

Animation:SetTargetName(name) : success

Animation:SetTargetParent() : success

Animation:Stop()

OnFinished(self, requested) - Invoked when the animation finishes animating.

OnPause(self) - Invoked when the animation is paused.

OnPlay(self) - Invoked when the animation begins to play.

OnStop(self, requested) - Invoked when the animation is stopped.

Alpha

This animation changes the alpha value of its parent region.

Alpha has all the methods from Animation, plus the following:

Alpha:GetFromAlpha() - Gets the start value that the alpha of this animation's parent Region changes by.

Alpha:GetToAlpha() - Gets the end value that the alpha of this animation's parent Region changes by.

Alpha:SetFromAlpha(fromAlpha) - Sets the start value from which the alpha of this animation's parent Region changes by.

Alpha:SetToAlpha(toAlpha) - Sets the end value from which the alpha of this animation's parent Region changes by.

Scale

This is an affine transformation that scales a parent Region about an origin. The scale can be non-uniform.

Scale has all the methods from Animation, plus the following:

Scale:GetFromScale() - Gets the X scalar and the Y scalar that the animation will scale from if set.

Scale:GetOrigin() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.

Scale:GetScale() - Gets the X scalar and the Y scalar that the animation's parent Region should scale by.

Scale:GetToScale() - Gets the X scalar and the Y scalar that the animation will scale to if set.

Scale:SetFromScale(x, y) - Sets the X scalar and the Y scalar that the animation will scale from.

Scale:SetOrigin(point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region.

Scale:SetScale(x, y) - Sets the X scalar and the Y scalar that the animation's parent Region should scale by.

Scale:SetToScale(x, y) - Sets the X scalar and the Y scalar that the animation will scale to.

LineScale

LineScale has the same methods as Scale.

Translation

This is an affine transformation that moves a parent Region by an offset. Translation has all the methods from Animation, plus the following:

Translation:GetOffset() - Gets the offset that the animation's parent Region would travel.

Translation:SetOffset(x, y) - Sets the offset that the animation's parent Region would travel.

LineTranslation

LineTranslation has the same methods as Translation.

Path

This is a set of translations, which lets you move a frame smoothly along a path.

Path has all the methods from Animation, plus the following:

Path:CreateControlPoint([name [, template [, order]]]) - Creates a new control point.

Path:GetControlPoints() - Gets the control points of the Path.

Path:GetCurve() - Gets the current curve type.

Path:GetMaxOrder() - Gets the maximum order of the Path.

Path:SetCurve(curveType) - Sets the curve type, which can be "SMOOTH" or "NONE".

Rotation

This is an affine transformation that rotates a parent Region about an origin.

Rotation has all the methods from Animation, plus the following:

Rotation:GetDegrees() - Gets the amount of degrees that the animation's parent Region would rotate.

Rotation:GetOrigin() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.

Rotation:GetRadians() - Gets the amount of radians that the animation's parent Region would travel.

Rotation:SetDegrees(degrees) - Sets the amount of degrees that the animation's parent Region would rotate.

Rotation:SetOrigin(point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region.

Rotation:SetRadians(radians) - Sets the amount of radians that the animation's parent Region would travel.

TextureCoordTranslation

TextureCoordTranslation has all the methods from Animation but does not have any other methods.

ControlPoint

ControlPoint can be created from Path:CreateControlPoint and has all the methods from UIObject, plus the following:

ControlPoint:GetOffset()

ControlPoint:GetOrder()

ControlPoint:SetOffset()

ControlPoint:SetOrder(order)

ControlPoint:SetParent()

FontInstance

[Edit FontInstance]

FontInstance (inherits from UIObject) is an abstract UI type that groups together the functionality of text-based frames.

FontInstance:GetFont() - Return the font path, height, and flags that may be used to construct an identical Font object.

FontInstance:GetFontObject() - Return the "parent" Font object, or nil if none.

FontInstance:SetFont(path, height, flags) - Constructs a new Font object and assigns it to this FontInstance.

FontInstance:SetFontObject(fontObject) - Sets the "parent" Font object from which this object inherits properties.

FontInstance:GetIndentedWordWrap() - Returns the indentation when text wraps beyond the first line

FontInstance:GetJustifyH() - Returns the horizontal text justification.

FontInstance:GetJustifyV() - Returns the vertical text justification.

FontInstance:GetSpacing() - Returns the line spacing.

FontInstance:SetIndentedWordWrap() - Defines the indentation when text wraps beyond the first line

FontInstance:SetJustifyH(justifyH) - Defines the horizontal text justification ("LEFT","RIGHT", or "CENTER")

FontInstance:SetJustifyV(justifyV) - Defines the vertical text justification ("TOP", "BOTTOM", or "MIDDLE")

FontInstance:SetSpacing(spacing) - Sets the spacing between lines of text in the object.

FontInstance:GetShadowColor() - Returns the color of text shadow.

FontInstance:GetShadowOffset() - Returns the text shadow offset.

FontInstance:GetTextColor() - Returns the default text color.

FontInstance:SetShadowColor(r, g, b[, a]) - Sets the text shadow color.

FontInstance:SetShadowOffset(x, y) - Sets the text shadow offset.

FontInstance:SetTextColor(r, g, b[, a]) - Sets the default text color.

Font

Font:CopyFontObject(sourceFont)

Font:GetAlpha() : alpha

Font:GetFont() : fontFile, height, flags

Font:GetFontObject() : font

Font:GetIndentedWordWrap() : wordWrap

Font:GetJustifyH() : justifyH

Font:GetJustifyV() : justifyV

Font:GetShadowColor() : colorR, colorG, colorB, colorA

Font:GetShadowOffset() : offsetX, offsetY

Font:GetSpacing() : spacing

Font:GetTextColor() : colorR, colorG, colorB, colorA

Font:SetAlpha(alpha)

Font:SetFont(fontFile, height, flags)

Font:SetFontObject(font)

Font:SetIndentedWordWrap(wordWrap)

Font:SetJustifyH(justifyH)

Font:SetJustifyV(justifyV)

Font:SetShadowColor(colorR, colorG, colorB [, a])

Font:SetShadowOffset(offsetX, offsetY)

Font:SetSpacing(spacing)

Font:SetTextColor(colorR, colorG, colorB [, a])

FontString

FontString:CalculateScreenAreaFromCharacterSpan(leftIndex, rightIndex) : areas

FontString:CanNonSpaceWrap() : wrap

FontString:CanWordWrap() : wrap

FontString:FindCharacterIndexAtCoordinate(x, y) : characterIndex, inside

FontString:GetFieldSize() : fieldSize

FontString:GetFont() : fontFile, fontHeight, flags

FontString:GetFontObject() : font

FontString:GetIndentedWordWrap() : wrap

FontString:GetJustifyH() : justifyH

FontString:GetJustifyV() : justifyH

FontString:GetLineHeight() : lineHeight

FontString:GetMaxLines() : maxLines

FontString:GetNumLines() : numLines

FontString:GetRotation() : radians

FontString:GetShadowColor() : colorR, colorG, colorB, colorA

FontString:GetShadowOffset() : offsetX, offsetY

FontString:GetSpacing() : spacing

FontString:GetStringHeight() : height

FontString:GetStringWidth() : width

FontString:GetText() : text

FontString:GetTextColor() : colorR, colorG, colorB, colorA

FontString:GetTextScale() : textScale

FontString:GetUnboundedStringWidth() : width

FontString:GetWrappedWidth() : width

FontString:IsTruncated() : isTruncated

FontString:SetAlphaGradient(start, length) : isWithinText

FontString:SetFixedColor(fixedColor)

FontString:SetFont(fontFile, fontHeight, flags)

FontString:SetFontObject(font)

FontString:SetFormattedText(text)

FontString:SetIndentedWordWrap(wrap)

FontString:SetJustifyH(justifyH)

FontString:SetJustifyV(justifyV)

FontString:SetMaxLines(maxLines)

FontString:SetNonSpaceWrap(wrap)

FontString:SetRotation(radians)

FontString:SetShadowColor(colorR, colorG, colorB [, a])

FontString:SetShadowOffset(offsetX, offsetY)

FontString:SetSpacing(spacing)

FontString:SetText([text])

FontString:SetTextColor(colorR, colorG, colorB [, a])

FontString:SetTextHeight(height)

FontString:SetTextScale(textScale)

FontString:SetWordWrap(wrap)

Texture

Texture:AddMaskTexture(mask)

Texture:GetMaskTexture(index) : mask

Texture:GetNumMaskTextures() : count

Texture:RemoveMaskTexture(mask)

MaskTexture

MaskTexture has the same methods as Texture except the texture mask API. It is created from Frame:CreateMaskTexture.

Line

The Region methods regarding Points (SetAllPoints, SetPoint, etc.) and Size (SetSize, SetWidth, etc.) are not included in this widget, thus those attributes for a Line must be done solely through the below listed methods. Edge methods are still available.

Line can be created from Frame:CreateLine and has almost all the methods from Texture, plus the following:

Line:GetEndPoint() - Gets the point at which the line ends.

Line:GetStartPoint() - Gets the point from where the line starts.

Line:GetThickness() - Gets this line's thickness.

Line:SetEndPoint(relativePoint [,relativeFrame or relativeObject [, xOfs [, yOfs]]]) - Sets the point at which the line ends.

Line:SetStartPoint(relativePoint [,relativeFrame or relativeObject [, xOfs [, yOfs]]]) - Sets the point from where the line starts.

Line:SetThickness(thickness) - Sets this line's thickness.

Frame

Frame:AbortDrag()

Frame:CanChangeAttribute() : canChangeAttributes

Frame:CreateFontString([name, drawLayer, templateName]) : line - Creates a fontstring.

Frame:CreateLine([name, drawLayer, templateName, subLevel]) : line - Draws a line.

Frame:CreateMaskTexture([name, drawLayer, templateName, subLevel]) : maskTexture - Creates a mask texture.

Frame:CreateTexture([name, drawLayer, templateName, subLevel]) : texture - Creates a texture.

Frame:DesaturateHierarchy(desaturation [, excludeRoot])

Frame:DisableDrawLayer(layer) - Prevents display of the frame on the specified draw layer.

Frame:DoesClipChildren() : clipsChildren

Frame:EnableDrawLayer(layer) - Allows display of the frame on the specified draw layer.

Frame:EnableGamePadButton([enable]) - Allows the receipt of gamepad button inputs for this frame.

Frame:EnableGamePadStick([enable]) - Allows the receipt of gamepad stick inputs for this frame.

Frame:EnableKeyboard([enable]) - Allows this frame to receive keyboard input.

Frame:ExecuteAttribute(attributeName, unpackedPrimitiveType, ...) : success, unpackedPrimitiveType, ...

Frame:GetAlpha() : alpha -> Region:GetAlpha

Frame:GetAttribute(attributeName) : value - Returns the value of a secure frame attribute.

Frame:GetBoundsRect() : left, bottom, width, height

Frame:GetChildren() : child1, ... - Returns a list of child frames belonging to the frame.

Frame:GetClampRectInsets() : left, right, top, bottom - Returns the frame's clamp rectangle offsets.

Frame:GetDontSavePosition() : dontSave

Frame:GetEffectiveAlpha() : effectiveAlpha - Returns the effective alpha after propagating from the parent region.

Frame:GetEffectiveScale() : effectiveScale - Returns the effective scale after propagating from the parent region.

Frame:GetEffectivelyFlattensRenderLayers() : flatten - Returns true if render layer flattening has been implicitly enabled.

Frame:GetFlattensRenderLayers() : flatten - Returns true if render layer flattening has been enabled.

Frame:GetFrameLevel() : frameLevel - Returns the frame level of the frame.

Frame:GetFrameStrata() : strata - Returns the layering strata of the frame.

Frame:GetHitRectInsets() : left, right, top, bottom - Returns the insets of the frame's hit rectangle.

Frame:GetHyperlinksEnabled() : enabled - Returns true if mouse interaction with hyperlinks on the frame is enabled.

Frame:GetID() : id - Returns the frame's numeric identifier.

Frame:GetNumChildren() : numChildren - Returns the number of child frames belonging to the frame.

Frame:GetNumRegions() : numRegions - Returns the number of non-Frame child regions belonging to the frame.

Frame:GetPropagateKeyboardInput() : propagate - Returns whether the frame propagates keyboard events.

Frame:GetRegions() : region1, ... - Returns a list of non-Frame child regions belonging to the frame.

Frame:GetResizeBounds() : minWidth, minHeight, maxWidth, maxHeight - Returns the minimum and maximum size of the frame for user resizing.

Frame:GetScale() : frameScale -> Region:GetScale

Frame:HasFixedFrameLevel() : isFixed

Frame:HasFixedFrameStrata() : isFixed

Frame:Hide() -> ScriptRegion:Hide

Frame:InterceptStartDrag(delegate)

Frame:IsClampedToScreen() : clampedToScreen - Returns whether a frame is prevented from being moved off-screen.

Frame:IsEventRegistered(eventName) : isRegistered, unit1, ... - Returns whether a frame is registered to an event.

Frame:IsGamePadButtonEnabled() : enabled - Checks if this frame is configured to receive gamepad button inputs.

Frame:IsGamePadStickEnabled() : enabled - Checks if this frame is configured to receive gamepad stick inputs.

Frame:IsIgnoringParentAlpha() : ignore -> Region:IsIgnoringParentAlpha

Frame:IsIgnoringParentScale() : ignore -> Region:IsIgnoringParentScale

Frame:IsKeyboardEnabled() : enabled - Returns true if keyboard interactivity is enabled for the frame.

Frame:IsMovable() : isMovable - Returns true if the frame is movable.

Frame:IsObjectLoaded() : isLoaded -> Region:IsObjectLoaded

Frame:IsResizable() : resizable - Returns true if the frame can be resized by the user.

Frame:IsShown() : isShown -> ScriptRegion:IsShown

Frame:IsToplevel() : isTopLevel - Returns whether this frame should raise its frame level on mouse interaction.

Frame:IsUserPlaced() : isUserPlaced - Returns whether the frame has been moved by the user.

Frame:IsVisible() : isVisible -> ScriptRegion:IsVisible

Frame:Lower() - Reduces the frame's frame level below all other frames in its strata.

Frame:Raise() - Increases the frame's frame level above all other frames in its strata.

Frame:RegisterAllEvents() - Flags the frame to receive all events.

Frame:RegisterEvent(eventName) : registered - Registers the frame to an event.

Frame:RegisterForDrag([button1, ...]) - Registers the frame for dragging with a mouse button.

Frame:RegisterUnitEvent(eventName [, unit1, ...]) : registered - Registers the frame for a specific event, triggering only for the specified units.

Frame:RotateTextures(radians [, x, y])

Frame:SetAlpha(alpha) -> Region:SetAlpha

Frame:SetAttribute(attributeName, value) - Sets an attribute on the frame.

Frame:SetAttributeNoHandler(attributeName, value) - Sets an attribute on the frame without triggering the OnAttributeChanged script handler.

Frame:SetClampRectInsets(left, right, top, bottom) - Controls how much of the frame may be moved off-screen.

Frame:SetClampedToScreen(clampedToScreen) - Prevents the frame from moving off-screen.

Frame:SetClipsChildren(clipsChildren)

Frame:SetDontSavePosition(dontSave)

Frame:SetDrawLayerEnabled(layer [, isEnabled])

Frame:SetFixedFrameLevel(isFixed)

Frame:SetFixedFrameStrata(isFixed)

Frame:SetFlattensRenderLayers(flatten) - Controls whether all subregions are composited into a single render layer.

Frame:SetFrameLevel(frameLevel) - Sets the level at which the frame is layered relative to others in its strata.

Frame:SetFrameStrata(strata) - Sets the layering strata of the frame.

Frame:SetHitRectInsets(left, right, top, bottom) #secureframe - Returns the insets of the frame's hit rectangle.

Frame:SetHyperlinksEnabled([enabled]) - Allows mouse interaction with hyperlinks on the frame.

Frame:SetID(id) - Returns the frame's numeric identifier.

Frame:SetIgnoreParentAlpha(ignore) -> Region:SetIgnoreParentAlpha

Frame:SetIgnoreParentScale(ignore) -> Region:SetIgnoreParentScale

Frame:SetIsFrameBuffer(isFrameBuffer) - Controls whether or not a frame is rendered to its own framebuffer prior to being composited atop the UI.

Frame:SetMovable(movable) - Sets whether the frame can be moved.

Frame:SetPropagateKeyboardInput(propagate) #nocombat - Sets whether keyboard input is consumed by this frame or propagates to further frames.

Frame:SetResizable(resizable) - Sets whether the frame can be resized by the user.

Frame:SetResizeBounds(minWidth, minHeight [, maxWidth, maxHeight]) - Sets the minimum and maximum size of the frame for user resizing.

Frame:SetScale(scale) -> Region:SetScale

Frame:SetShown([shown]) -> ScriptRegion:SetShown

Frame:SetToplevel(topLevel) #secureframe - Controls whether or not a frame should raise its frame level on mouse interaction.

Frame:SetUserPlaced(userPlaced) - Sets whether a frame has been moved by the user and will be saved in the layout cache.

Frame:Show() -> ScriptRegion:Show

Frame:StartMoving([alwaysStartFromMouse]) - Begins repositioning the frame via mouse movement.

Frame:StartSizing([resizePoint, alwaysStartFromMouse]) - Begins resizing the frame via mouse movement.

Frame:StopMovingOrSizing() - Stops moving or resizing the frame.

Frame:UnregisterAllEvents() - Unregisters all events from the frame.

Frame:UnregisterEvent(eventName) : registered - Unregisters an event from the frame.

OnAttributeChanged(self, key, value) - Invoked when a secure frame attribute is changed.

OnChar(self, text) - Invoked for each text character typed in the frame.

OnDisable(self) - Invoked when the frame is disabled.

OnDragStart(self, button) - Invoked when the mouse is dragged starting in the frame

OnDragStop(self) - Invoked when the mouse button is released after a drag started in the frame,

OnEnable(self) - Invoked when the frame is enabled.

OnEvent(self, event, ...) - Invoked whenever an event fires for which the frame is registered.

OnGamePadButtonDown(self, button) - Invoked when a gamepad button is pressed.

OnGamePadButtonUp(self, button) - Invoked when a gamepad button is released.

OnGamePadStick(self, stick, x, y, len) - Invoked when a gamepad stick is moved.

OnHyperlinkClick(self, link, text, button, region, left, bottom, width, height) - Invoked when the mouse clicks a hyperlink on the FontInstance object.

OnHyperlinkEnter(self, link, text, region, left, bottom, width, height) - Invoked when the mouse moves over a hyperlink on the FontInstance object.

OnHyperlinkLeave(self) - Invoked when the mouse moves away from a hyperlink on the FontInstance object.

OnKeyDown(self, key) - Invoked when a keyboard key is pressed if the frame is keyboard enabled.

OnKeyUp(self, key) - Invoked when a keyboard key is released if the frame is keyboard enabled.

OnReceiveDrag(self) - Invoked when the mouse button is released after dragging into the frame.

OnSizeChanged(self, width, height) - Invoked when a frame's size changes.

Browser

Browser has all the methods from Frame, plus the following:

Browser:ClearFocus()

Browser:CopyExternalLink()

Browser:DeleteCookies()

Browser:NavigateBack()

Browser:NavigateForward()

Browser:NavigateHome(tag)

Browser:NavigateReload()

Browser:NavigateStop()

Browser:OpenExternalLink()

Browser:OpenTicket(index)

Browser:SetFocus()

Browser:SetZoom(zoom)

Button

Button:ClearDisabledTexture()

Button:ClearHighlightTexture()

Button:ClearNormalTexture()

Button:ClearPushedTexture()

Button:Click([button, isDown]) - Performs a virtual mouse click on the button.

Button:Disable()

Button:Enable()

Button:GetButtonState() : buttonState

Button:GetDisabledFontObject() : font

Button:GetDisabledTexture() : texture

Button:GetFontString() : fontString

Button:GetHighlightFontObject() : font

Button:GetHighlightTexture() : texture - Returns the highlight texture for the button.

Button:GetMotionScriptsWhileDisabled() : motionScriptsWhileDisabled

Button:GetNormalFontObject() : font - Returns the font object for the button's normal state.

Button:GetNormalTexture() : texture

Button:GetPushedTextOffset() : offsetX, offsetY

Button:GetPushedTexture() : texture

Button:GetText() : text - Returns the text on the button.

Button:GetTextHeight() : height

Button:GetTextWidth() : width

Button:IsEnabled() : isEnabled - Returns true if the button is enabled.

Button:LockHighlight()

Button:RegisterForClicks([button1, ...]) - Registers the button widget to receive mouse clicks.

Button:RegisterForMouse(unpackedPrimitiveType, ...)

Button:SetButtonState(buttonState [, lock])

Button:SetDisabledAtlas(atlas)

Button:SetDisabledFontObject(font)

Button:SetDisabledTexture(asset)

Button:SetEnabled([enabled])

Button:SetFontString(fontString)

Button:SetFormattedText(text)

Button:SetHighlightAtlas(atlas [, blendMode])

Button:SetHighlightFontObject(font)

Button:SetHighlightLocked(locked)

Button:SetHighlightTexture(asset [, blendMode])

Button:SetMotionScriptsWhileDisabled(motionScriptsWhileDisabled)

Button:SetNormalAtlas(atlas)

Button:SetNormalFontObject(font) - Sets the font object used for the button's normal state.

Button:SetNormalTexture(asset) - Sets the normal texture for a button.

Button:SetPushedAtlas(atlas)

Button:SetPushedTextOffset(offsetX, offsetY)

Button:SetPushedTexture(asset)

Button:SetText([text]) - Sets the text of the button.

Button:UnlockHighlight()

OnClick(self, self, button, down) - Invoked when clicking a button.

OnDoubleClick(self, self, button) - Invoked when double-clicking a button.

PostClick(self, button, down) - Invoked immediately after `OnClick`.

PreClick(self, button, down) - Invoked immediately before `OnClick`.

CheckButton

CheckButton:GetChecked() : checked - Returns true if the checkbutton is checked.

CheckButton:GetCheckedTexture() : texture

CheckButton:GetDisabledCheckedTexture() : texture

CheckButton:SetChecked([checked]) - Sets whether the checkbutton is checked.

CheckButton:SetCheckedTexture(asset)

CheckButton:SetDisabledCheckedTexture(asset)

ItemButton

ItemButton is an intrinsic frame.

It has all the methods from Button and ItemButtonMixin.

Checkout

Checkout has all the methods from Frame, plus the following:

Checkout:CancelOpenCheckout()

Checkout:ClearFocus()

Checkout:CloseCheckout()

Checkout:CopyExternalLink()

Checkout:OpenCheckout()

Checkout:OpenExternalLink()

Checkout:SetFocus()

Checkout:SetZoom()

REMOVED (8.2.0) Checkout:ClearRenderSize()

REMOVED (8.2.0) Checkout:SetRenderSize()

ColorSelect

ColorSelect has all the methods from Frame, plus the following:

ColorSelect:GetColorHSV() - Get the HSV values of the selected color.

ColorSelect:GetColorRGB() - Get the RGB values of the selected color.

ColorSelect:GetColorValueTexture() - Get the texture used to show color value - new in 1.11.

ColorSelect:GetColorValueThumbTexture() - Get the texture for the color value thumb - New in 1.11.

ColorSelect:GetColorWheelTexture() - Get the texture for the color wheel - New in 1.11.

ColorSelect:GetColorWheelThumbTexture() - Get the texture for the color wheel thumb - New in 1.11.

ColorSelect:SetColorHSV(h, s, v) - Set to a specific HSV color.

ColorSelect:SetColorRGB(r, g, b) - Set to a specific RGB color.

ColorSelect:SetColorValueTexture(texturebool) - Set the texture used to show color value - New in 1.11.

ColorSelect:SetColorValueThumbTexture(texturebool) - Set the texture for the color value thumb - New in 1.11.

ColorSelect:SetColorWheelTexture(texturebool) - Set the texture for the color wheel - New in 1.11.

ColorSelect:SetColorWheelThumbTexture(texturebool) - Set the texture for the color wheel thumb - New in 1.11.

Cooldown

[Edit Cooldown]

Cooldown (inherits from Frame) displays "clock-like" sweep and leading-edge effects over abilities and buffs.

Cooldown:Clear() - Clears the currently active cooldown of the widget

Cooldown:GetCooldownDisplayDuration()

Cooldown:GetCooldownDuration() - Returns the duration currently shown by the cooldown frame in milliseconds

Cooldown:GetCooldownTimes() - Returns the starting time and duration of the cooldown frame in milliseconds

Cooldown:GetDrawBling()

Cooldown:GetDrawEdge() - Returns whether a bright line should be drawn on the moving edge of the cooldown animation

Cooldown:GetDrawSwipe()

Cooldown:GetEdgeScale()

Cooldown:GetReverse() - Returns whether the bright and dark portions of the cooldown animation should be inverted

Cooldown:GetRotation() - Get the current rotation of the cooldown in radians

Cooldown:IsPaused() - Returns whether the cooldown is currently paused

Cooldown:Pause() - Pause the cooldown

Cooldown:Resume() - Resume the cooldown after being paused

Cooldown:SetBlingTexture(file or fileDataID, [r, g, b, a])

Cooldown:SetCooldown(start, duration[, modRate]) - Shows a cooldown animation.

Cooldown:SetCooldownDuration(duration[, modRate])

Cooldown:SetCooldownUNIX(start, duration[, modRate])

Cooldown:SetCountdownAbbrevThreshold(seconds)

Cooldown:SetCountdownFont(font)

Cooldown:SetDrawBling()

Cooldown:SetDrawEdge(enable) - Sets whether a bright line should be drawn on the moving edge of the cooldown animation

Cooldown:SetDrawSwipe()

Cooldown:SetEdgeScale(edgeScale)

Cooldown:SetEdgeTexture(file or fileDataID, [r, g, b, a]) - Set the texture which 'follows' the moving edge of the cooldown

Cooldown:SetHideCountdownNumbers(hide) - Show or hide text cooldown timer

Cooldown:SetReverse(boolean) - Controls the direction of the cooldown animation.

Cooldown:SetRotation(rotationRadians) - Rotate the entire cooldown a certain radians clockwise

Cooldown:SetSwipeColor(r, g, b, [a]) - Set the color of the swipe

Cooldown:SetSwipeTexture(file or fileDataID, [r, g, b, a]) - Set the swipe texture used for the cooldown

Cooldown:SetUseCircularEdge(boolean) - Sets whether the edge texture should follow a circular pattern instead of square

EditBox

EditBox has all the methods from Frame and FontInstance, plus the following:

EditBox:AddHistoryLine(text) - Add text to the edit history.

EditBox:ClearFocus()

EditBox:ClearHistory()

EditBox:ClearHighlightText()

EditBox:Disable()

EditBox:Enable()

EditBox:GetAltArrowKeyMode() - Return whether only alt+arrow keys work for navigating the edit box, not arrow keys alone.

EditBox:GetBlinkSpeed() - Gets the blink speed of the EditBox in seconds - New in 1.11.

EditBox:GetCursorPosition() - Gets the position of the cursor inside the EditBox - New in 2.3.

EditBox:GetDisplayText()

EditBox:GetHighlightColor()

EditBox:GetHistoryLines() - Get the number of history lines for this edit box

EditBox:GetInputLanguage() - Get the input language (locale based not in-game)

EditBox:GetMaxBytes() - Gets the maximum number bytes allowed in the EditBox - New in 1.11.

EditBox:GetMaxLetters() - Gets the maximum number of letters allowed in the EditBox - New in 1.11.

EditBox:GetNumLetters() - Gets the number of letters in the box.

EditBox:GetNumber()

EditBox:GetText() - Get the current text contained in the edit box.

EditBox:GetTextInsets() - Gets the text display insets for the EditBox - New in 1.11.

EditBox:GetUTF8CursorPosition()

EditBox:GetVisibleTextByteLimit()

EditBox:HasFocus() - Returns whether the edit box is currently being edited (has edit focus).

EditBox:HighlightText([startPos, endPos]) - Set the highlight to all or some of the edit box text.

EditBox:Insert(text) - Insert text into the edit box.

EditBox:IsAutoFocus() - Determine if the EditBox has autofocus enabled - New in 1.11.

EditBox:IsCountInvisibleLetters()

EditBox:IsEnabled()

EditBox:IsInIMECompositionMode()

EditBox:IsMultiLine() - Determine if the EditBox accepts multiple lines - New in 1.11.

EditBox:IsNumeric() - Determine if the EditBox only accepts numeric input - New in 1.11.

EditBox:IsPassword() - Determine if the EditBox performs password masking - New in 1.11.

EditBox:IsSecureText()

EditBox:SetAltArrowKeyMode(enable) - Make only alt+arrow keys work for navigating the edit box, not arrow keys alone.

EditBox:SetAutoFocus(state) - Set whether or not the editbox will attempt to get input focus when it gets shown (default: yes) - New in 1.11.

EditBox:SetBlinkSpeed(speed)

EditBox:SetCountInvisibleLetters()

EditBox:SetCursorPosition(position) - Set the position of the cursor within the EditBox - New in 2.3.

EditBox:SetEnabled()

EditBox:SetFocus() - Move input focus (the cursor) to this editbox

EditBox:SetHighlightColor()

EditBox:SetHistoryLines(numLines) - Set the number of history lines to remember.

EditBox:SetMaxBytes(maxBytes) - Set the maximum byte size for entered text.

EditBox:SetMaxLetters(maxLetters) - Set the maximum number of letters for entered text.

EditBox:SetMultiLine(state) - Set the EditBox's multi-line state - New in 1.11.

EditBox:SetNumber(number)

EditBox:SetNumeric(state) - Set if the EditBox only accepts numeric input - New in 1.11.

EditBox:SetPassword(state) - Set the EditBox's password masking state - New in 1.11.

EditBox:SetSecureText()

EditBox:SetSecurityDisablePaste()

EditBox:SetSecurityDisableSetText()

EditBox:SetText(text) - Set the text contained in the edit box.

EditBox:SetTextInsets(l, r, t, b)

EditBox:SetVisibleTextByteLimit(maxVisibleBytes)

EditBox:ToggleInputLanguage()

FogOfWarFrame

FogOfWarFrame has all the methods from Frame, plus the following:

FogOfWarFrame:GetFogOfWarBackgroundAtlas()

FogOfWarFrame:GetFogOfWarBackgroundTexture()

FogOfWarFrame:GetFogOfWarMaskAtlas()

FogOfWarFrame:GetFogOfWarMaskTexture()

FogOfWarFrame:GetMaskScalar()

FogOfWarFrame:GetUiMapID()

FogOfWarFrame:SetFogOfWarBackgroundAtlas(atlasName)

FogOfWarFrame:SetFogOfWarBackgroundTexture(textureName or FileDataID, [horizontalTile, verticalTile])

FogOfWarFrame:SetFogOfWarMaskAtlas(atlasName)

FogOfWarFrame:SetFogOfWarMaskTexture(textureName)

FogOfWarFrame:SetMaskScalar(mapID)

FogOfWarFrame:SetUiMapID()

GameTooltip

[Edit GameTooltip]

GameTooltip (inherits from Frame) formats a tooltip. There is one named _G["GameTooltip"], but others are created with CreateFrame("GameTooltip") or <GameTooltip>.

GameTooltip:AddAtlas(atlas [, minx, maxx, miny, maxy] or [, textureInfoTable])

GameTooltip:AddDoubleLine(textL, textR, rL, gL, bL, rR, gR, bR)

GameTooltip:AddFontStrings(leftstring, rightstring) - Dynamically expands the size of a tooltip - New in 1.11.

GameTooltip:AddLine(tooltipText [, r, g, b [, wrapText]]) - Appends the new line to the tooltip.

GameTooltip:AddSpellByID(spellID)

GameTooltip:AddTexture(texture) - Add a texture to the last line added.

GameTooltip:AdvanceSecondaryCompareItem()

GameTooltip:AppendText(text) - Append text to the end of the first line of the tooltip.

GameTooltip:ClearLines() - Clear all lines of tooltip (both left and right ones)

GameTooltip:CopyTooltip()

GameTooltip:FadeOut()

GameTooltip:GetAnchorType() - Returns the current anchoring type.

GameTooltip:GetAzeritePowerID()

GameTooltip:GetCustomLineSpacing()

GameTooltip:GetItem() - Returns name, link.

GameTooltip:GetMinimumWidth()

GameTooltip:GetOwner() - Returns owner frame, anchor.

GameTooltip:GetPadding()

GameTooltip:GetSpell() - Returns name, rank, id.

GameTooltip:GetUnit() - Returns unit name, unit id.

GameTooltip:IsEquippedItem()

GameTooltip:IsOwned(frame)

GameTooltip:IsUnit(unit) - Returns bool.

GameTooltip:NumLines() - Get the number of lines in the tooltip.

GameTooltip:ResetSecondaryCompareItem()

GameTooltip:SetAchievementByID(id)

GameTooltip:SetAction(slot) - Shows the tooltip for the specified action button.

GameTooltip:SetAllowShowWithNoLines(bool)

GameTooltip:SetAnchorType(anchorType [,Xoffset] [,Yoffset])

GameTooltip:SetArtifactItem()

GameTooltip:SetArtifactPowerByID()

GameTooltip:SetAzeriteEssence(essenceID)

GameTooltip:SetAzeriteEssenceSlot(slot)

GameTooltip:SetAzeritePower(itemID, itemLevel, powerID[, owningItemLink])

GameTooltip:SetBackpackToken(id)

GameTooltip:SetBagItem(bag, slot)

GameTooltip:SetBagItemChild()

GameTooltip:SetBuybackItem(slot)

GameTooltip:SetCompanionPet()

GameTooltip:SetCompareAzeritePower(itemID, itemLevel, powerID[, owningItemLink])

GameTooltip:SetCompareItem(shoppingTooltipTwo, primaryMouseover)

GameTooltip:SetConduit(id, rank)

GameTooltip:SetCurrencyByID(id)

GameTooltip:SetCurrencyToken(tokenId) - Shows the tooltip for the specified token

GameTooltip:SetCurrencyTokenByID(currencyID)

GameTooltip:SetEquipmentSet(name) - Shows details for the equipment manager set identified by "name".

GameTooltip:SetCustomLineSpacing(spacing)

GameTooltip:SetEnhancedConduit(conduitID, conduitRank)

GameTooltip:SetExistingSocketGem(index, [toDestroy])

GameTooltip:SetFrameStack(showhidden) - Shows the mouseover frame stack, used for debugging.

GameTooltip:SetGuildBankItem(tab, id) - Shows the tooltip for the specified guild bank item

GameTooltip:SetHeirloomByItemID(itemID)

GameTooltip:SetHyperlink(itemString or itemLink) - Changes the item which is displayed in the tooltip according to the passed argument.

GameTooltip:SetInboxItem(index) - Shows the tooltip for the specified mail inbox item.

GameTooltip:SetInstanceLockEncountersComplete(index)

GameTooltip:SetInventoryItem(unit, slot[, nameOnly, hideUselessStats])

GameTooltip:SetInventoryItemByID(itemID)

GameTooltip:SetItemByID(itemID) - Shows the tooltip for a specified Item ID. (added in 4.2.0.14002 along with the Encounter Journal)

GameTooltip:SetItemKey(itemID, itemLevel, itemSuffix)

GameTooltip:SetLFGDungeonReward(dungeonID, lootIndex)

GameTooltip:SetLFGDungeonShortageReward(dungeonID, shortageSeverity, lootIndex)

GameTooltip:SetLootCurrency(lootSlot)

GameTooltip:SetLootItem(lootSlot)

GameTooltip:SetLootRollItem(id) - Shows the tooltip for the specified loot roll item.

GameTooltip:SetMerchantCostItem(index, item)

GameTooltip:SetMerchantItem(merchantSlot)

GameTooltip:SetMinimumWidth(width) - (Formerly SetMoneyWidth)

GameTooltip:SetMountBySpellID()

GameTooltip:SetOwnedItemByID(ID)

GameTooltip:SetOwner(owner, anchor[, x, y])

GameTooltip:SetPadding(width, height)

GameTooltip:SetPetAction(slot) - Shows the tooltip for the specified pet action.

GameTooltip:SetPossession(slot)

GameTooltip:SetPvpBrawl()

GameTooltip:SetPvpTalent(talentID[, talentIndex])

GameTooltip:SetQuestCurrency(type, index)

GameTooltip:SetQuestItem(type, index)

GameTooltip:SetQuestLogCurrency(type, index)

GameTooltip:SetQuestLogItem(type, index)

GameTooltip:SetQuestLogRewardSpell(rewardSpellIndex[, questID])

GameTooltip:SetQuestLogSpecialItem(index)

GameTooltip:SetQuestPartyProgress(questID, omitTitle, ignoreActivePlayer)

GameTooltip:SetQuestRewardSpell(rewardSpellIndex)

GameTooltip:SetRecipeRankInfo(recipeID, learnedRank)

GameTooltip:SetRecipeReagentItem(recipeID, reagentIndex)

GameTooltip:SetRecipeResultItem(recipeID)

GameTooltip:SetRuneforgeResultItem(itemID, itemLevel [, powerID, modifiers])

GameTooltip:SetSendMailItem()

GameTooltip:SetShapeshift(slot) - Shows the tooltip for the specified shapeshift form.

GameTooltip:SetShrinkToFitWrapped()

GameTooltip:SetSocketedItem()

GameTooltip:SetSocketedRelic(relicSlotIndex)

GameTooltip:SetSocketGem(index)

GameTooltip:SetSpecialPvpBrawl()

GameTooltip:SetSpellBookItem(spellId, bookType) - Shows the tooltip for the specified spell in the spellbook.

GameTooltip:SetSpellByID(spellId) - Shows the tooltip for the specified spell by global spell ID.

GameTooltip:SetTalent(talentIndex [, isInspect, talentGroup, inspectedUnit, classId]) - Shows the tooltip for the specified talent.

GameTooltip:SetText(text, r, g, b[, alphaValue[, textWrap]]) - Set the text of the tooltip.

GameTooltip:SetTotem(slot)

GameTooltip:SetToyByItemID(itemID)

GameTooltip:SetTradePlayerItem(tradeSlot)

GameTooltip:SetTradeTargetItem(tradeSlot)

GameTooltip:SetTrainerService(index)

GameTooltip:SetTransmogrifyItem(slotId) - Shows the tooltip when there is a pending (de)transmogrification

GameTooltip:SetUnit(unit[, hideStatus])

GameTooltip:SetUnitAura(unit, auraIndex [, filter]) - Shows the tooltip for a unit's aura. (Exclusive to 3.x.x / WotLK)

GameTooltip:SetUnitBuff(unit, buffIndex [, raidFilter]) - Shows the tooltip for a unit's buff.

GameTooltip:SetUnitDebuff(unit, buffIndex [, raidFilter]) - Shows the tooltip for a unit's debuff.

GameTooltip:SetUpgradeItem()

GameTooltip:SetVoidDepositItem(slotIndex) - Shows the tooltip for the specified Void Transfer deposit slot (added in 4.3.0)

GameTooltip:SetVoidItem(slotIndex) - Shows the tooltip for the specified Void Storage slot (added in 4.3.0)

GameTooltip:SetVoidWithdrawalItem(slotIndex) - Shows the tooltip for the specified Void Transfer withdrawal slot (added in 4.3.0)

GameTooltip:SetWeeklyReward(itemDBID)

GameTooltip:SetAuctionItem(type, index) - Shows the tooltip for the specified auction item.

GameTooltip:SetAuctionSellItem()

GameTooltip:SetCraftItem(index, reagent)

GameTooltip:SetCraftSpell(index)

GameTooltip:SetTrackingSpell()

GameTooltip:SetTradeSkillItem(index [, reagent])

MessageFrame

MessageFrame has all the methods from Frame and FontInstance, plus the following:

MessageFrame:AddMessage(text, r, g, b, messageGroup, holdTime) - Add a message to the frame which will fade eventually.

MessageFrame:Clear() - Clear the messages from the frame - New in 1.11.

MessageFrame:GetFadeDuration() - Gets the fade duration in seconds - New in 1.11.

MessageFrame:GetFadePower()

MessageFrame:GetFading() - Get whether the frame is fading - New in 1.11.

MessageFrame:GetFontStringByID(messageID)

MessageFrame:GetInsertMode() - Get the insert mode for the frame - New in 1.11.

MessageFrame:GetTimeVisible() - Get the message visibility time in seconds - New in 1.11.

MessageFrame:HasMessageByID()

MessageFrame:ResetMessageFadeByID(messageID)

MessageFrame:SetFadeDuration(seconds) - Set the fade duration - New in 1.11.

MessageFrame:SetFadePower(power)

MessageFrame:SetFading(status) - Set whether the frame fades messages - New in 1.11.

MessageFrame:SetInsertMode(TOP or BOTTOM) - Set where new messages are inserted - New in 1.11.

MessageFrame:SetTimeVisible(seconds) - Sets the message visibility time - New in 1.11.

Minimap

[Edit Minimap]

Minimap (inherits from Frame) displays a player's immediate surroundings. The only Minimap is named _G["Minimap"].

Minimap:GetPingPosition() - Get the last ping location.

Minimap:GetZoom() - Get the current zoom level.

Minimap:GetZoomLevels() - Get the maximum zoom level.

Minimap:PingLocation(x, y) - Perform a ping at the specified location.

Minimap:SetArchBlobInsideAlpha(alpha)

Minimap:SetArchBlobInsideTexture(textureFile)

Minimap:SetArchBlobOutsideAlpha(alpha)

Minimap:SetArchBlobOutsideTexture(textureFile)

Minimap:SetArchBlobRingAlpha(alpha)

Minimap:SetArchBlobRingScalar(scalar)

Minimap:SetArchBlobRingTexture(textureFile)

Minimap:SetBlipTexture(textureFile) - Set the file to use for blips (ObjectIcons)

Minimap:SetCorpsePOIArrowTexture(textureFile)

Minimap:SetIconTexture(textureFile)

Minimap:SetMaskTexture(file or fileDataID)

Minimap:SetPOIArrowTexture(textureFile)

Minimap:SetPlayerTexture(textureFile) - Set the file to use for the player arrow texture.

Minimap:SetQuestBlobInsideAlpha(alpha)

Minimap:SetQuestBlobInsideTexture(textureFile)

Minimap:SetQuestBlobOutsideAlpha(alpha)

Minimap:SetQuestBlobOutsideSelectedTexture(textureFile)

Minimap:SetQuestBlobOutsideTexture(textureFile)

Minimap:SetQuestBlobRingAlpha(alpha)

Minimap:SetQuestBlobRingScalar(scalar)

Minimap:SetQuestBlobRingTexture(textureFile)

Minimap:SetStaticPOIArrowTexture(textureFile)

Minimap:SetTaskBlobInsideAlpha(alpha)

Minimap:SetTaskBlobInsideTexture(textureFile)

Minimap:SetTaskBlobOutsideAlpha(alpha)

Minimap:SetTaskBlobOutsideSelectedTexture(file)

Minimap:SetTaskBlobOutsideTexture(textureFile)

Minimap:SetTaskBlobRingAlpha(alpha)

Minimap:SetTaskBlobRingScalar(scalar)

Minimap:SetTaskBlobRingTexture(textureFile)

Minimap:SetZoom(level) - Set the current zoom level.

Minimap:UpdateBlips()

Model

Used to display real 3D-mesh geometry as part of the UI.

Model has all the methods from Frame, plus the following:

Model:AdvanceTime()

Model:ClearFog() - Removes all fogging effects currently active in rendering.

Model:ClearModel() - Removes all geometry from the Model (i.e. makes it empty)

Model:ClearTransform()

Model:GetCameraDistance()

Model:GetCameraFacing()

Model:GetCameraPosition()

Model:GetCameraRoll()

Model:GetCameraTarget()

Model:GetDesaturation()

Model:GetFacing() - Returns the direction the model is facing.

Model:GetFogColor() - Gets the fog color (r, g, b, a) - New in 1.11.

Model:GetFogFar() - Gets the fog far distance - New in 1.11.

Model:GetFogNear() - Gets the fog near distance - New in 1.11.

Model:GetLight() - Gets the light specification for the model, returns a list of results compatible with the SetLight method - New in 1.11.

Model:GetModelAlpha()

Model:GetModelDrawLayer()

Model:GetModelFileID() - Gets the model file ID for this Model - New in 7.0, replaces Model:GetModel().

Model:GetModelScale() - Returns the current mesh scaling factor.

Model:GetPaused()

Model:GetPitch()

Model:GetPosition() - Returns the current position of the mesh as x, y, z

Model:GetRoll()

Model:GetShadowEffect()

Model:GetViewInsets()

Model:GetViewTranslation()

Model:GetWorldScale()

Model:HasAttachmentPoints()

Model:HasCustomCamera()

Model:IsUsingModelCenterToTransform()

Model:MakeCurrentCameraCustom()

Model:ReplaceIconTexture(texture or fileDataID)

Model:SetCamera(index) - Select a pre-defined camera.

Model:SetCameraDistance(distance)

Model:SetCameraFacing(radians)

Model:SetCameraPosition(x, y, z)

Model:SetCameraRoll(radians)

Model:SetCameraTarget(x, y, z)

Model:SetCustomCamera(defaultIndex)

Model:SetDesaturation(strength)

Model:SetFacing(facing) - Set the direction that the model is facing.

Model:SetFogColor(r, g, b[, a]) - Set the fog color and enable fogging.

Model:SetFogFar(value) - Set the far-clipping plane distance for fogging.

Model:SetFogNear(value) - Set the near-clipping plane distance for fogging.

Model:SetGlow(...)

Model:SetLight(enabled[, omni, dirX, dirY, dirZ, ambIntensity[, ambR, ambG, ambB[, dirIntensity[, dirR, dirG, dirB]]]]) - Place the light source used for rendering

Model:SetModel(file) - Set the mesh that is displayed in the frame.

Model:SetModelAlpha(alpha)

Model:SetModelDrawLayer(layer)

Model:SetModelScale(scale) - Sets the scale factor for the mesh before rendering.

Model:SetParticlesEnabled(bool)

Model:SetPaused(bool)

Model:SetPitch(pitch)

Model:SetPosition(x, y, z) - Set the position of the mesh inside the frame's coordinate system.

Model:SetRoll(roll)

Model:SetSequence(sequence) - Set the animation to be played.

Model:SetSequenceTime(sequence, time)

Model:SetShadowEffect(strength)

Model:SetTransform()

Model:SetViewInsets(l, r, t, b)

Model:SetViewTranslation(x, y)

Model:TransformCameraSpaceToModelSpace(positionX, positionY, positionZ)

Model:UseModelCenterToTransform()

PlayerModel

PlayerModel has all the methods from Model, plus the following:

PlayerModel:ApplySpellVisualKit(id, [oneShot])

PlayerModel:CanSetUnit(unit)

PlayerModel:FreezeAnimation(animation, variation, frame)

PlayerModel:GetDisplayInfo()

PlayerModel:GetDoBlend()

PlayerModel:GetKeepModelOnHide()

PlayerModel:HasAnimation(animation)

PlayerModel:PlayAnimKit(id, [loop])

PlayerModel:RefreshCamera()

PlayerModel:RefreshUnit()

PlayerModel:SetAnimation(animation[, variation])

PlayerModel:SetBarberShopAlternateForm()

PlayerModel:SetCamDistanceScale(scale)

PlayerModel:SetCreature(CreatureId)

PlayerModel:SetCustomRace(raceId [, sexId])

PlayerModel:SetDisplayInfo(displayID)

PlayerModel:SetDoBlend()

PlayerModel:SetItem(itemID[, appearanceModID, itemVisualID])

PlayerModel:SetItemAppearance(itemAppearanceID[, itemVisualID])

PlayerModel:SetKeepModelOnHide(bool)

PlayerModel:SetPortraitZoom(zoom)

PlayerModel:SetRotation(rotationRadians)

PlayerModel:SetUnit(unit)

PlayerModel:StopAnimKit()

PlayerModel:ZeroCachedCenterXY()

CinematicModel

CinematicModel was added in Patch 6.0.2 and has all the methods from PlayerModel, plus the following:

CinematicModel:EquipItem(itemID)

CinematicModel:InitializeCamera()

CinematicModel:InitializePanCamera()

CinematicModel:SetAnimOffset(offset)

CinematicModel:SetCreatureData(creatureID)

CinematicModel:SetFacingLeft(isFacingLeft)

CinematicModel:SetFadeTimes(fadeIn, fadeOut)

CinematicModel:SetHeightFactor(factor)

CinematicModel:SetJumpInfo(length, height)

CinematicModel:SetPanDistance(scale)

CinematicModel:SetSpellVisualKit(kitID)

CinematicModel:SetTargetDistance(scale)

CinematicModel:StartPan(panType, timeInSeconds[, doFade, visualKitID])

CinematicModel:StopPan()

CinematicModel:UnequipItems()

DressUpModel

DressUpModel has all the methods from PlayerModel, plus the following:

DressUpModel:Dress() - Sets the model to reflect the character's current inventory.

DressUpModel:GetAutoDress()

DressUpModel:GetItemTransmogInfo(slotID)

DressUpModel:GetItemTransmogInfoList()

DressUpModel:GetObeyHideInTransmogFlag()

DressUpModel:GetSheathed()

DressUpModel:GetUseTransmogChoices()

DressUpModel:GetUseTransmogSkin()

DressUpModel:SetAutoDress(bool)

DressUpModel:SetItemTransmogInfo(itemTransmogInfo [, weaponSlotID])

DressUpModel:SetObeyHideInTransmogFlag(bool)

DressUpModel:SetSheathed(bool)

DressUpModel:SetUseTransmogChoices(bool)

DressUpModel:SetUseTransmogSkin(bool)

DressUpModel:TryOn(itemID or sourceID [, slotName, illusionID]) - Adds the specified item to the model by sourceID.

DressUpModel:Undress() - Sets the model to reflect the character without inventory.

DressUpModel:UndressSlot(slotIndex)

TabardModel

TabardModel has all the methods from PlayerModel, plus the following:

TabardModel:CanSaveTabardNow() - Indicate if the tabard can be saved.

TabardModel:CycleVariation(variationIndex, delta)

TabardModel:GetLowerBackgroundFileName()

TabardModel:GetLowerEmblemFile()

TabardModel:GetLowerEmblemTexture(textureName)

TabardModel:GetUpperBackgroundFileName()

TabardModel:GetUpperEmblemFile()

TabardModel:GetUpperEmblemTexture(textureName)

TabardModel:InitializeTabardColors()

TabardModel:Save() - Save the tabard.

ModelScene

ModelScene has all the methods from Frame, plus the following:

ModelScene:ClearFog()

ModelScene:CreateActor([name, template])

ModelScene:GetActorAtIndex(actorIndex)

ModelScene:GetCameraFarClip()

ModelScene:GetCameraFieldOfView()

ModelScene:GetCameraForward()

ModelScene:GetCameraNearClip()

ModelScene:GetCameraPosition()

ModelScene:GetCameraRight()

ModelScene:GetCameraUp()

ModelScene:GetDrawLayer()

ModelScene:GetFogColor()

ModelScene:GetFogFar()

ModelScene:GetFogNear()

ModelScene:GetItemTransmogInfo(slotID)

ModelScene:GetItemTransmogInfoList()

ModelScene:GetLightAmbientColor()

ModelScene:GetLightDiffuseColor()

ModelScene:GetLightDirection()

ModelScene:GetLightPosition()

ModelScene:GetLightType()

ModelScene:GetNumActors()

ModelScene:GetViewInsets()

ModelScene:GetViewTranslation()

ModelScene:IsLightVisible()

ModelScene:Project3DPointTo2D(x, y, z)

ModelScene:SetCameraFarClip(value)

ModelScene:SetCameraFieldOfView(radians)

ModelScene:SetCameraNearClip(value)

ModelScene:SetCameraOrientationByAxisVectors(forwardX, forwardY, forwardZ, rightX, rightY, rightZ, upX, upY, upZ) each vector must be orthonormal

ModelScene:SetCameraOrientationByYawPitchRoll(yaw, pitch, roll)

ModelScene:SetCameraPosition(x, y, z)

ModelScene:SetDrawLayer(layer)

ModelScene:SetFogColor(r, g, b)

ModelScene:SetFogFar(value)

ModelScene:SetFogNear(value)

ModelScene:SetItemTransmogInfo(itemTransmogInfo [, weaponSlotID])

ModelScene:SetLightAmbientColor(r, g, b)

ModelScene:SetLightDiffuseColor(r, g, b)

ModelScene:SetLightDirection(x, y, z)

ModelScene:SetLightPosition(x, y, z)

ModelScene:SetLightType(LE_MODEL_LIGHT_TYPE)

ModelScene:SetLightVisible()

ModelScene:SetPaused(paused, [affectsGlobalPause])

ModelScene:SetViewInsets(l, r, t, b)

ModelScene:SetViewTranslation(x, y)

ModelScene:TakeActor()

ModelSceneActor

ModelSceneActor can be created from ModelScene:CreateActor. It has the following methods:

ModelSceneActor:AttachToMount()

ModelSceneActor:CalculateMountScale()

ModelSceneActor:ClearModel()

ModelSceneActor:Dress()

ModelSceneActor:GetActiveBoundingBox()

ModelSceneActor:GetAlpha()

ModelSceneActor:GetAnimation()

ModelSceneActor:GetAnimationBlendOperation()

ModelSceneActor:GetAnimationVariation()

ModelSceneActor:GetAutoDress()

ModelSceneActor:GetDebugName()

ModelSceneActor:GetDesaturation()

ModelSceneActor:GetMaxBoundingBox()

ModelSceneActor:GetModelFileID()

ModelSceneActor:GetModelPath()

ModelSceneActor:GetModelUnitGUID()

ModelSceneActor:GetObeyHideInTransmogFlag()

ModelSceneActor:GetParent()

ModelSceneActor:GetParticleOverrideScale()

ModelSceneActor:GetPaused()

ModelSceneActor:GetPitch()

ModelSceneActor:GetPosition()

ModelSceneActor:GetRoll()

ModelSceneActor:GetScale()

ModelSceneActor:GetSheathed()

ModelSceneActor:GetSpellVisualKit()

ModelSceneActor:GetUseTransmogChoices()

ModelSceneActor:GetUseTransmogSkin()

ModelSceneActor:GetYaw()

ModelSceneActor:Hide()

ModelSceneActor:IsForbidden()

ModelSceneActor:IsLoaded()

ModelSceneActor:IsShown()

ModelSceneActor:IsUsingCenterForOrigin()

ModelSceneActor:IsVisible()

ModelSceneActor:PlayAnimationKit(id [, loop])

ModelSceneActor:SetAlpha(alpha)

ModelSceneActor:SetAnimation(animation [, variation, animSpeed, timeOffsetSecs])

ModelSceneActor:SetAnimationBlendOperation(LE_MODEL_BLEND_OPERATION)

ModelSceneActor:SetAutoDress(true/false)

ModelSceneActor:SetDesaturation(strength)

ModelSceneActor:SetForbidden() - Protected

ModelSceneActor:SetModelByCreatureDisplayID(creatureDisplayID)

ModelSceneActor:SetModelByFileID(fileID [, enableMips])

ModelSceneActor:SetModelByPath(filePath [, enableMips])

ModelSceneActor:SetModelByUnit("unit" [,sheatheWeapons, autoDress])

ModelSceneActor:SetObeyHideInTransmogFlag(bool)

ModelSceneActor:SetParticleOverrideScale()

ModelSceneActor:SetPaused(paused [, affectsGlobalPause = true])

ModelSceneActor:SetPitch(pitch)

ModelSceneActor:SetPlayerModelFromGlues()

ModelSceneActor:SetPosition(x, y, z)

ModelSceneActor:SetRoll(roll)

ModelSceneActor:SetScale(scale)

ModelSceneActor:SetSheathed(true/false)

ModelSceneActor:SetShown(true/false)

ModelSceneActor:SetSpellVisualKit()

ModelSceneActor:SetUseCenterForOrigin()

ModelSceneActor:SetUseTransmogChoices(bool)

ModelSceneActor:SetUseTransmogSkin(true/false)

ModelSceneActor:SetYaw(facing)

ModelSceneActor:Show()

ModelSceneActor:StopAnimationKit()

ModelSceneActor:TryOn()

ModelSceneActor:Undress()

ModelSceneActor:UndressSlot(slotIndex)

MovieFrame

MovieFrame has all the methods from Frame, plus the following:

MovieFrame:EnableSubtitles(enable) - Enables or disables subtitles for movies played in the frame.

MovieFrame:StartMovie(movieID [, loop]) - Plays a specified movie in the frame

MovieFrame:StopMovie(enable) - Stops the movie currently playing in the frame

OffScreenFrame

OffScreenFrame has all the methods from Frame, plus the following:

OffScreenFrame:ApplySnapshot(texture, ID)

OffScreenFrame:Flush()

OffScreenFrame:GetMaxSnapshots()

OffScreenFrame:IsSnapshotValid(ID)

OffScreenFrame:SetMaxSnapshots(maxSnapshots)

OffScreenFrame:TakeSnapshot()

OffScreenFrame:UsesNPOT()

POIFrame

POIFrame is an abstract object type for points of interest on the map and has all the methods from Frame, plus the following:

POIFrame:DrawAll()

POIFrame:DrawBlob()

POIFrame:DrawNone()

POIFrame:EnableMerging()

POIFrame:EnableSmoothing()

POIFrame:GetMapID()

POIFrame:SetBorderAlpha()

POIFrame:SetBorderScalar()

POIFrame:SetBorderTexture([texture or fileDataID])

POIFrame:SetFillAlpha()

POIFrame:SetFillTexture()

POIFrame:SetMapID()

POIFrame:SetMergeThreshold()

POIFrame:SetNumSplinePoints()

ArchaeologyDigSiteFrame

ArchaeologyDigSiteFrame has all the methods from POIFrame but does not have any other methods.

QuestPOIFrame

QuestPOIFrame has all the methods from POIFrame, plus the following:

QuestPOIFrame:GetNumTooltips()

QuestPOIFrame:GetTooltipIndex()

QuestPOIFrame:UpdateMouseOverTooltip()

ScenarioPOIFrame

ScenarioPOIFrame has all the methods from POIFrame, plus the following:

ScenarioPOIFrame:GetScenarioTooltipText()

ScenarioPOIFrame:UpdateMouseOverTooltip()

ScrollFrame

[Edit ScrollFrame]

ScrollFrame (inherits from Frame) may be customized to vertically or horizontally scroll other widgets.

ScrollFrame:GetHorizontalScroll()

ScrollFrame:GetHorizontalScrollRange()

ScrollFrame:GetScrollChild() - Returns the frame that scrolls when moving the scroll bar(s)

ScrollFrame:GetVerticalScroll()

ScrollFrame:GetVerticalScrollRange()

ScrollFrame:SetHorizontalScroll(offset)

ScrollFrame:SetScrollChild(frame) - Assigns the frame to scroll when moving the scroll bar(s).

ScrollFrame:SetVerticalScroll(offset)

ScrollFrame:UpdateScrollChildRect() - no longer required after patch 2.3

ScrollingMessageFrame

ScrollingMessageFrame is an intrinsic frame.

It has all the methods from Frame, FontInstance and ScrollingMessageFrameMixin.

SimpleHTML

SimpleHTML has all the methods from Frame and FontInstance, plus the following:

SimpleHTML:GetContentHeight()

SimpleHTML:GetHyperlinkFormat() - Set the string.format format to use for displaying hyperlinks - New in 1.11.

SimpleHTML:GetTextData()

SimpleHTML:SetHyperlinkFormat(format) - Set the string.format format to use for displaying hyperlinks.

SimpleHTML:SetText(text) - Set the HTML markup to be displayed (note: if there is any markup error, it will be displayed as plain text)

Slider

Slider has all the methods from Frame, plus the following:

Slider:Disable() - Disables the slider

Slider:Enable() - Enables the slider

Slider:GetMinMaxValues() - Get the current bounds of the slider.

Slider:GetObeyStepOnDrag() - Returns whether the slider constrains values to value steps when dragged.

Slider:GetOrientation() - Returns "HORIZONTAL" or "VERTICAL".

Slider:GetStepsPerPage() - Returns the number of steps the slider's value changes by when the slider is clicked.

Slider:GetThumbTexture() - Get the texture for this slider's thumb - New in 1.11.

Slider:GetValue() - Get the current value of the slider.

Slider:GetValueStep() - Get the current step size of the slider.

Slider:IsDraggingThumb()

Slider:IsEnabled() - Returns enabled status of the slider.

Slider:SetEnabled()

Slider:SetMinMaxValues(min, max) - Set the bounds of the slider.

Slider:SetObeyStepOnDrag(obeyStep) - Sets whether the slider constrains values to to value steps when dragged.

Slider:SetOrientation(orientation) - "HORIZONTAL" or "VERTICAL".

Slider:SetStepsPerPage(steps) - Controls slider behavior when the user clicks within the slider's tracking area.

Slider:SetThumbTexture(texture or fileDataIDbool)

Slider:SetValue(value) - Set the value of the slider. Also causes the thumb to show on the first call.

Slider:SetValueStep(value) - Set the step size of the slider.

StatusBar

StatusBar has all the methods from Frame, plus the following:

StatusBar:GetFillStyle()

StatusBar:GetMinMaxValues() - Get the current bounds of the bar.

StatusBar:GetOrientation()

StatusBar:GetReverseFill()

StatusBar:GetRotatesTexture()

StatusBar:GetStatusBarAtlas()

StatusBar:GetStatusBarColor()

StatusBar:GetStatusBarTexture() - Returns the texture object for the bar - Before 1.11 it returned the filename.

StatusBar:GetValue() - Get the current value of the bar.

StatusBar:SetFillStyle(style) - Set the style in which the bar will be filled.

StatusBar:SetMinMaxValues(min, max) - Set the bounds of the bar.

StatusBar:SetOrientation(orientation) - "HORIZONTAL" or "VERTICAL".

StatusBar:SetReverseFill(state) - Sets the fill direction.

StatusBar:SetRotatesTexture()

StatusBar:SetStatusBarAtlas(atlasName)

StatusBar:SetStatusBarColor(r, g, b[, alpha]) - Set the color of the bar.

StatusBar:SetStatusBarTexture(texture or fileDataIDbool [, layer[, subLayer]]) - Sets the texture of the bar - Added texture as valid arg in 1.11.

StatusBar:SetValue(value) - Set the value of the bar.

UnitPositionFrame

UnitPositionFrame has all the methods from Frame, plus the following:

UnitPositionFrame:AddUnit(unit, texture, width, height, r, g, b, a, subLayer, showFacing)

UnitPositionFrame:AddUnitAtlas(unit, texture, width, height, r, g, b, a, subLayer)

UnitPositionFrame:AddUnitFileID(unit, fileID, width, height, r, g, b, a, subLayer, showFacing)

UnitPositionFrame:ClearUnits()

UnitPositionFrame:FinalizeUnits()

UnitPositionFrame:GetMouseOverUnits()

UnitPositionFrame:GetPlayerPingScale()

UnitPositionFrame:GetUiMapID()

UnitPositionFrame:SetPlayerPingScale(scale)

UnitPositionFrame:SetPlayerPingTexture(textureIndex, textureName or fileDataID, [width, height])

UnitPositionFrame:SetUiMapID(mapID)

UnitPositionFrame:SetUnitColor(unit, r, g, b, a)

UnitPositionFrame:StartPlayerPing()

UnitPositionFrame:StopPlayerPing()

WorldFrame

[Edit WorldFrame]

WorldFrame is a unique frame and renders the 3D world.

See also

Removed or no longer used:

• TaxiRouteFrame