Wowpedia

We have moved to Warcraft Wiki. Click here for information and the new URL.

READ MORE

Wowpedia
Register
Advertisement

Widgets are graphical elements created in Lua with CreateFrame() or via XML. Widget objects can be extended with templates, mixins and intrinsics. The user interface may be inspected with /fstack, /tinspect and development addons like DevTool and Spew.

Note
Note: This list is up to date as of Patch 10.1.0 (49365) Apr 27 2023
Warning Warning: The docs are being migrated to Blizzard's official documentation

Abstract Classes[]

FrameScriptObject[]

FrameScriptObject:GetName() : name - Returns the object's global name.
FrameScriptObject:GetObjectType() : objectType - Returns the object's widget type.
FrameScriptObject:IsForbidden() : isForbidden - Returns true if insecure interaction with the object is forbidden.
FrameScriptObject:IsObjectType(objectType) : isType - Returns true if the object belongs to a given widget type or its subtypes.
FrameScriptObject:SetForbidden() #protected - Sets the object to be forbidden from an insecure execution path.

Object[]

Object:GetDebugName([preferParentKey]) : debugName - Returns the object's debug name.
Object:GetParent() : parent - Returns the parent object.
Object:GetParentKey() : parentKey - Returns the key on the parent that references this object.
Object:SetParentKey(parentKey) - Sets a key on the parent to the child object.

ScriptRegion[]

ScriptRegion:CanChangeProtectedState() : canChange - Returns true if protected properties of the region can be changed by non-secure scripts.
ScriptRegion:EnableMouse([enable]) - Sets whether the region should receive mouse input.
ScriptRegion:EnableMouseMotion([enable]) - Sets whether the region should receive mouse hover events.
ScriptRegion:EnableMouseWheel([enable]) - Sets whether the region should receive mouse wheel input.
ScriptRegion:GetBottom() : bottom #restrictedframe - Returns the offset in pixels to the bottom edge of the region.
ScriptRegion:GetCenter() : x, y #restrictedframe - Returns the offset in pixels to the center of the region.
ScriptRegion:GetHeight([ignoreRect]) : height - Returns the height of the region.
ScriptRegion:GetLeft() : left #restrictedframe - Returns the offset in pixels to the left edge of the region.
ScriptRegion:GetRect() : left, bottom, width, height #restrictedframe - Returns the coords and size of the region.
ScriptRegion:GetRight() : right #restrictedframe - Returns the offset in pixels to the right edge of the region.
ScriptRegion:GetScaledRect() : left, bottom, width, height - Returns the scaled coords and size of the region.
ScriptRegion:GetScript(scriptTypeName [, bindingType]) : script - Returns the widget script handler.
ScriptRegion:GetSize([ignoreRect]) : width, height - Returns the width and height of the region.
ScriptRegion:GetSourceLocation() : location - Returns the script name and line number where the region was created.
ScriptRegion:GetTop() : top #restrictedframe - Returns the offset in pixels to the top edge of the region.
ScriptRegion:GetWidth([ignoreRect]) : width - Returns the width of the region.
ScriptRegion:HasScript(scriptName) : hasScript - Returns true if the region supports the given script type.
ScriptRegion:Hide() #secureframe - Hides the region.
ScriptRegion:HookScript(scriptTypeName, script [, bindingType]) - Securely post-hooks a widget script handler.
ScriptRegion:IsAnchoringRestricted() : isRestricted - Returns true if the region has cross-region anchoring restrictions applied.
ScriptRegion:IsDragging() : isDragging - Returns true if the region is being dragged.
ScriptRegion:IsMouseClickEnabled() : enabled - Returns true if the region can receive mouse clicks.
ScriptRegion:IsMouseEnabled() : enabled - Returns true if the region can receive mouse input.
ScriptRegion:IsMouseMotionEnabled() : enabled - Returns true if the region can receive mouse hover events.
ScriptRegion:IsMouseMotionFocus() : isMouseMotionFocus - Returns true if the mouse cursor is hovering over the region.
ScriptRegion:IsMouseOver([offsetTop, offsetBottom, offsetLeft, offsetRight]) : isMouseOver - Returns true if the mouse cursor is hovering over the region.
ScriptRegion:IsMouseWheelEnabled() : enabled - Returns true if the region can receive mouse wheel input.
ScriptRegion:IsProtected() : isProtected, isProtectedExplicitly - Returns whether the region is currently protected.
ScriptRegion:IsRectValid() : isValid - Returns true if the region can be positioned on the screen.
ScriptRegion:IsShown() : isShown - Returns true if the region should be shown; it depends on the parents if it's visible.
ScriptRegion:IsVisible() : isVisible - Returns true if the region and its parents are shown.
ScriptRegion:SetMouseClickEnabled([enabled]) - Sets whether the region should receive mouse clicks.
ScriptRegion:SetMouseMotionEnabled([enabled]) - Sets whether the region should receive mouse hover events.
ScriptRegion:SetParent([parent]) - Sets the parent of the region.
ScriptRegion:SetPassThroughButtons([button1, ...]) #nocombat - Allows the region to propagate mouse clicks to underlying regions or the world frame.
ScriptRegion:SetScript(scriptTypeName [, script]) - Sets the widget script handler.
ScriptRegion:SetShown([show]) #secureframe - Shows or hides the region.
ScriptRegion:Show() #secureframe - Shows the region.
ScriptRegionResizing:AdjustPointsOffset(x, y) #secureframe - Adjusts the x and y offset of the region.
ScriptRegionResizing:ClearAllPoints() - Removes all anchor points from the region.
ScriptRegionResizing:ClearPoint(point) - Removes an anchor point from the region by name.
ScriptRegionResizing:ClearPointsOffset() #secureframe - Resets the x and y offset on the region to zero.
ScriptRegionResizing:GetNumPoints() : numPoints - Returns the number of anchor points for the region.
ScriptRegionResizing:GetPoint([anchorIndex]) : point, relativeTo, relativePoint, offsetX, offsetY #restrictedframe - Returns an anchor point for the region.
ScriptRegionResizing:GetPointByName(point) : point, relativeTo, relativePoint, offsetX, offsetY - Returns an anchor point by name for the region.
ScriptRegionResizing:SetAllPoints(relativeTo [, doResize]) - Positions the region the same as another region.
ScriptRegionResizing:SetHeight(height) - Sets the height of the region.
ScriptRegionResizing:SetPoint(point, relativeTo, relativePoint, offsetX, offsetY) #anchorfamily - Sets an anchor point for the region.
ScriptRegionResizing:SetSize(x, y) - Sets the width and height of the region.
ScriptRegionResizing:SetWidth(width) - Sets the width of the region.
AnimatableObject:CreateAnimationGroup([name, templateName]) : group - Creates an animation group.
AnimatableObject:GetAnimationGroups() : scriptObject, ... - Returns the animation groups of this region.
AnimatableObject:StopAnimating() - Stops any active animations on this region.

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.

TextureBase[]

TextureBase:GetAtlas() : atlas - Returns the atlas for the texture.
TextureBase:GetBlendMode() : blendMode - Returns the blend mode of the texture.
TextureBase:GetDesaturation() : desaturation - Returns the desaturation level of the texture.
TextureBase:GetHorizTile() : tiling - Returns true if the texture is tiling horizontally.
TextureBase:GetRotation() : radians, normalizedRotationPoint - Returns the rotation of the texture.
TextureBase:GetTexCoord() : ULx, ULy, LLx, LLy, URx, URy, LRx, LRy - Returns the texture space coordinates of the texture.
TextureBase:GetTexelSnappingBias() : bias - Returns the texel snapping bias for the texture.
TextureBase:GetTexture() : textureFile - Returns the FileID for the texture.
TextureBase:GetTextureFileID() : textureFile - Returns the FileID for the texture.
TextureBase:GetTextureFilePath() : textureFile - Returns the FileID for the texture.
TextureBase:GetVertTile() : tiling - Returns true if the texture is tiling vertically.
TextureBase:GetVertexOffset(vertexIndex) : offsetX, offsetY - Returns a vertex offset for the texture.
TextureBase:IsBlockingLoadRequested() : blocking
TextureBase:IsDesaturated() : desaturated - Returns true if the texture is desaturated.
TextureBase:IsSnappingToPixelGrid() : snap - Returns true if the texture is snapping to the pixel grid.
TextureBase:SetAtlas(atlas [, useAtlasSize, filterMode, resetTexCoords]) - Sets the texture to an atlas.
TextureBase:SetBlendMode(blendMode) - Sets the blend mode of the texture.
TextureBase:SetBlockingLoadsRequested([blocking])
TextureBase:SetColorTexture(colorR, colorG, colorB [, a]) - Sets the texture to a solid color.
TextureBase:SetDesaturated([desaturated]) - Sets the texture to be desaturated.
TextureBase:SetDesaturation(desaturation) - Sets the desaturation level of the texture.
TextureBase:SetGradient(orientation, minColor, maxColor) - Sets a gradient color shading for the texture.
TextureBase:SetHorizTile([tiling]) - Sets whether the texture should tile horizontally.
TextureBase:SetMask(file) - Applies a mask to the texture.
TextureBase:SetRotation(radians [, normalizedRotationPoint]) - Applies a rotation to the texture.
TextureBase:SetSnapToPixelGrid([snap]) - Sets the texture to snap to the pixel grid.
TextureBase:SetTexCoord(left, right, bottom, top) - Sets the coordinates for cropping or transforming the texture.
TextureBase:SetTexelSnappingBias(bias) - Returns the texel snapping bias for the texture.
TextureBase:SetTexture([textureAsset, wrapModeHorizontal, wrapModeVertical, filterMode]) - Sets the texture to an image.
TextureBase:SetVertTile([tiling]) - Sets whether the texture should tile vertically.
TextureBase:SetVertexOffset(vertexIndex, offsetX, offsetY) - Sets a vertex offset for the texture.

Textures[]

Texture[]

Texture:AddMaskTexture(mask)
Texture:GetMaskTexture(index) : mask
Texture:GetNumMaskTextures() : count
Texture:RemoveMaskTexture(mask)

MaskTexture[]

Line[]

Line:ClearAllPoints()
Line:GetEndPoint() : relativePoint, relativeTo, offsetX, offsetY
Line:GetStartPoint() : relativePoint, relativeTo, offsetX, offsetY
Line:GetThickness() : thickness
Line:SetEndPoint(relativePoint, relativeTo [, offsetX, offsetY])
Line:SetStartPoint(relativePoint, relativeTo [, offsetX, offsetY])
Line:SetThickness(thickness)

Fonts[]

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)

Animations[]

AnimationGroup[]

AnimationGroup:CreateAnimation([animationType, name, templateName]) : anim
AnimationGroup:Finish()
AnimationGroup:GetAnimationSpeedMultiplier() : animationSpeedMultiplier
AnimationGroup:GetAnimations() : scriptObject, ...
AnimationGroup:GetDuration() : durationSec
AnimationGroup:GetElapsed() : elapsedSec
AnimationGroup:GetLoopState() : loopState
AnimationGroup:GetLooping() : loopType
AnimationGroup:GetProgress() : progress
AnimationGroup:GetScript(scriptTypeName [, bindingType]) : script
AnimationGroup:HasScript(scriptName) : hasScript
AnimationGroup:HookScript(scriptTypeName, script [, bindingType])
AnimationGroup:IsDone() : isDone
AnimationGroup:IsPaused() : isPaused
AnimationGroup:IsPendingFinish() : isPendingFinish
AnimationGroup:IsPlaying() : isPlaying
AnimationGroup:IsReverse() : isReverse
AnimationGroup:IsSetToFinalAlpha() : isSetToFinalAlpha
AnimationGroup:Pause()
AnimationGroup:Play([reverse, offset])
AnimationGroup:RemoveAnimations()
AnimationGroup:Restart([reverse, offset])
AnimationGroup:SetAnimationSpeedMultiplier(animationSpeedMultiplier)
AnimationGroup:SetLooping(loopType)
AnimationGroup:SetPlaying(play)
AnimationGroup:SetScript(scriptTypeName [, script])
AnimationGroup:SetToFinalAlpha(setToFinalAlpha)
AnimationGroup:Stop()

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()

Alpha[]

Alpha:GetFromAlpha() : normalizedAlpha
Alpha:GetToAlpha() : normalizedAlpha
Alpha:SetFromAlpha(normalizedAlpha)
Alpha:SetToAlpha(normalizedAlpha)

FlipBook[]

FlipBook:GetFlipBookColumns() : columns
FlipBook:GetFlipBookFrameHeight() : height
FlipBook:GetFlipBookFrameWidth() : width
FlipBook:GetFlipBookFrames() : frames
FlipBook:GetFlipBookRows() : rows
FlipBook:SetFlipBookColumns(columns)
FlipBook:SetFlipBookFrameHeight(height)
FlipBook:SetFlipBookFrameWidth(width)
FlipBook:SetFlipBookFrames(frames)
FlipBook:SetFlipBookRows(rows)

Path[]

Path:CreateControlPoint([name, templateName, order]) : point
Path:GetControlPoints() : scriptObject, ...
Path:GetCurveType() : curveType
Path:GetMaxControlPointOrder() : maxOrder
Path:SetCurveType(curveType)

ControlPoint[]

ControlPoint:GetOffset() : offsetX, offsetY
ControlPoint:GetOrder() : order
ControlPoint:SetOffset(offsetX, offsetY)
ControlPoint:SetOrder(order)
ControlPoint:SetParent(parent [, order])

Rotation[]

Rotation:GetDegrees() : angle
Rotation:GetOrigin() : point, originX, originY
Rotation:GetRadians() : angle
Rotation:SetDegrees(angle)
Rotation:SetOrigin(point, originX, originY)
Rotation:SetRadians(angle)

Scale[]

Scale:GetOrigin() : point, originX, originY
Scale:GetScale() : scaleX, scaleY
Scale:GetScaleFrom() : scaleX, scaleY
Scale:GetScaleTo() : scaleX, scaleY
Scale:SetOrigin(point, originX, originY)
Scale:SetScale(scaleX, scaleY)
Scale:SetScaleFrom(scaleX, scaleY)
Scale:SetScaleTo(scaleX, scaleY)

TextureCoordTranslation[]

TextureCoordTranslation:GetOffset() : offsetU, offsetV
TextureCoordTranslation:SetOffset(offsetU, offsetV)

Translation[]

Translation:GetOffset() : offsetX, offsetY
Translation:SetOffset(offsetX, offsetY)

Frames[]

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.

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()

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)

Model[]

Model:AdvanceTime()
Model:ClearFog()
Model:ClearModel()
Model:ClearTransform()
Model:GetCameraDistance() : distance
Model:GetCameraFacing() : radians
Model:GetCameraPosition() : positionX, positionY, positionZ
Model:GetCameraRoll() : radians
Model:GetCameraTarget() : targetX, targetY, targetZ
Model:GetDesaturation() : strength
Model:GetFacing() : facing - Returns the offset of the rotation angle.
Model:GetFogColor() : colorR, colorG, colorB, colorA
Model:GetFogFar() : fogFar
Model:GetFogNear() : fogNear
Model:GetLight() : enabled, light
Model:GetModelAlpha() : alpha
Model:GetModelDrawLayer() : layer, sublayer
Model:GetModelFileID() : modelFileID - Returns the file ID associated with the currently displayed model.
Model:GetModelScale() : scale
Model:GetPaused() : paused
Model:GetPitch() : pitch
Model:GetPosition() : positionX, positionY, positionZ
Model:GetRoll() : roll
Model:GetShadowEffect() : strength
Model:GetViewInsets() : left, right, top, bottom
Model:GetViewTranslation() : x, y
Model:GetWorldScale() : worldScale
Model:HasAttachmentPoints() : hasAttachmentPoints
Model:HasCustomCamera() : hasCustomCamera
Model:IsUsingModelCenterToTransform() : useCenter
Model:MakeCurrentCameraCustom()
Model:ReplaceIconTexture(asset)
Model:SetCamera(cameraIndex) - Selects a predefined camera.
Model:SetCameraDistance(distance)
Model:SetCameraFacing(radians)
Model:SetCameraPosition(positionX, positionY, positionZ)
Model:SetCameraRoll(radians)
Model:SetCameraTarget(targetX, targetY, targetZ)
Model:SetCustomCamera(cameraIndex)
Model:SetDesaturation(strength)
Model:SetFacing(facing) - Rotates the displayed model for the given angle in counter-clockwise direction.
Model:SetFogColor(colorR, colorG, colorB [, a]) - Sets the color used for the fogging in the model frame.
Model:SetFogFar(fogFar) - Sets the far clipping plane for fogging.
Model:SetFogNear(fogNear) - Sets the near clipping plane for fogging.
Model:SetGlow(glow)
Model:SetLight(enabled, light) - Specifies model lighting.
Model:SetModel(asset [, noMip]) - Sets the model to display a certain mesh.
Model:SetModelAlpha(alpha)
Model:SetModelDrawLayer(layer)
Model:SetModelScale(scale)
Model:SetParticlesEnabled(enabled)
Model:SetPaused(paused)
Model:SetPitch(pitch)
Model:SetPosition(positionX, positionY, positionZ) - Positions a model relative to the bottom-left corner.
Model:SetRoll(roll)
Model:SetSequence(sequence) - Sets the animation-sequence to be played.
Model:SetSequenceTime(sequence, timeOffset)
Model:SetShadowEffect(strength)
Model:SetTransform([translation, rotation, scale])
Model:SetViewInsets(left, right, top, bottom)
Model:SetViewTranslation(x, y)
Model:TransformCameraSpaceToModelSpace(cameraPosition) : modelPosition
Model:UseModelCenterToTransform(useCenter)

PlayerModel[]

PlayerModel is officially documented as CharacterModelBase.

CharacterModelBase:ApplySpellVisualKit(spellVisualKitID [, oneShot])
CharacterModelBase:CanSetUnit(unit)
CharacterModelBase:FreezeAnimation(anim, variation, frame) - Freezes an animation at a specific animation frame on the model.
CharacterModelBase:GetDisplayInfo() : displayID
CharacterModelBase:GetDoBlend() : doBlend
CharacterModelBase:GetKeepModelOnHide() : keepModelOnHide
CharacterModelBase:HasAnimation(anim) : hasAnimation - Returns true if the currently displayed model supports the given animation ID.
CharacterModelBase:PlayAnimKit(animKit [, loop])
CharacterModelBase:RefreshCamera()
CharacterModelBase:RefreshUnit()
CharacterModelBase:SetAnimation(anim [, variation]) - Sets the animation to be played by the model.
CharacterModelBase:SetBarberShopAlternateForm()
CharacterModelBase:SetCamDistanceScale(scale)
CharacterModelBase:SetCreature(creatureID [, displayID])
CharacterModelBase:SetDisplayInfo(displayID [, mountDisplayID])
CharacterModelBase:SetDoBlend([doBlend])
CharacterModelBase:SetItem(itemID [, appearanceModID, itemVisualID])
CharacterModelBase:SetItemAppearance(itemAppearanceID [, itemVisualID, itemSubclass])
CharacterModelBase:SetKeepModelOnHide(keepModelOnHide)
CharacterModelBase:SetPortraitZoom(zoom)
CharacterModelBase:SetRotation(radians [, animate])
CharacterModelBase:SetUnit(unit [, blend, useNativeForm]) : success - Sets the model to display the specified unit.
CharacterModelBase:StopAnimKit()
CharacterModelBase:ZeroCachedCenterXY()

DressUpModel[]

DressUpModel:Dress()
DressUpModel:GetAutoDress() : enabled
DressUpModel:GetItemTransmogInfo(inventorySlot) : itemTransmogInfo
DressUpModel:GetItemTransmogInfoList() : infoList
DressUpModel:GetObeyHideInTransmogFlag() : enabled
DressUpModel:GetSheathed() : sheathed
DressUpModel:GetUseTransmogChoices() : enabled
DressUpModel:GetUseTransmogSkin() : enabled
DressUpModel:IsGeoReady() : ready
DressUpModel:IsSlotAllowed(slot) : allowed
DressUpModel:IsSlotVisible(slot) : visible
DressUpModel:SetAutoDress([enabled])
DressUpModel:SetItemTransmogInfo(itemTransmogInfo [, inventorySlot, ignoreChildItems]) : result
DressUpModel:SetObeyHideInTransmogFlag([enabled])
DressUpModel:SetSheathed([sheathed, hideWeapons])
DressUpModel:SetUseTransmogChoices([enabled])
DressUpModel:SetUseTransmogSkin([enabled])
DressUpModel:TryOn(linkOrItemModifiedAppearanceID [, handSlotName, spellEnchantID]) : result - Previews an item on the model.
DressUpModel:Undress()
DressUpModel:UndressSlot(inventorySlot)

ColorSelect[]

ColorSelect:ClearColorWheelTexture()
ColorSelect:GetColorHSV() : hsvX, hsvY, hsvZ - Returns the HSV values of the selected color.
ColorSelect:GetColorRGB() : rgbR, rgbG, rgbB - Returns the RGB values of the selected color.
ColorSelect:GetColorValueTexture() : texture - Returns the texture for the color picker's value slider background.
ColorSelect:GetColorValueThumbTexture() : texture - Returns the texture for the color picker's value slider thumb.
ColorSelect:GetColorWheelTexture() : texture - Returns the texture for the color picker's hue/saturation wheel.
ColorSelect:GetColorWheelThumbTexture() : texture - Returns the texture for the selection indicator on the color picker's hue/saturation wheel.
ColorSelect:SetColorHSV(hsvX, hsvY, hsvZ) - Selects this HSV color in the color picker.
ColorSelect:SetColorRGB(rgbR, rgbG, rgbB) - Selects this RGB color in the color picker.
ColorSelect:SetColorValueTexture(texture) - Sets the texture used to display the color picker's value slider.
ColorSelect:SetColorValueThumbTexture(texture) - Sets the texture for the color picker's value slider thumb.
ColorSelect:SetColorWheelTexture(texture) - Sets the texture used to display the color picker's hue/saturation wheel.
ColorSelect:SetColorWheelThumbTexture(texture) - Sets the texture for the selection indicator on the color picker's hue/saturation wheel.

Cooldown[]

Cooldown:Clear()
Cooldown:GetCooldownDisplayDuration() : duration
Cooldown:GetCooldownDuration() : duration
Cooldown:GetCooldownTimes() : start, duration
Cooldown:GetDrawBling() : drawBling
Cooldown:GetDrawEdge() : drawEdge
Cooldown:GetDrawSwipe() : drawSwipe
Cooldown:GetEdgeScale() : edgeScale
Cooldown:GetReverse() : reverse
Cooldown:GetRotation() : rotationRadians
Cooldown:IsPaused() : isPaused
Cooldown:Pause()
Cooldown:Resume()
Cooldown:SetBlingTexture(texture, colorR, colorG, colorB, colorA)
Cooldown:SetCooldown(start, duration, modRate?)
Cooldown:SetCooldownDuration(duration, modRate?)
Cooldown:SetCooldownUNIX(start, duration, modRate?)
Cooldown:SetCountdownAbbrevThreshold(seconds)
Cooldown:SetCountdownFont(fontName)
Cooldown:SetDrawBling(drawBling?)
Cooldown:SetDrawEdge(drawEdge?)
Cooldown:SetDrawSwipe(drawSwipe?)
Cooldown:SetEdgeScale(scale)
Cooldown:SetEdgeTexture(texture, colorR, colorG, colorB, colorA)
Cooldown:SetHideCountdownNumbers(hideNumbers?)
Cooldown:SetReverse(reverse?)
Cooldown:SetRotation(rotationRadians)
Cooldown:SetSwipeColor(colorR, colorG, colorB, a?)
Cooldown:SetSwipeTexture(texture, colorR, colorG, colorB, colorA)
Cooldown:SetTexCoordRange(low, high)
Cooldown:SetUseCircularEdge(useCircularEdge?)

EditBox[]

EditBox:AddHistoryLine(text)
EditBox:ClearFocus()
EditBox:ClearHighlightText()
EditBox:ClearHistory()
EditBox:Disable()
EditBox:Enable()
EditBox:GetAltArrowKeyMode() : altMode
EditBox:GetBlinkSpeed() : cursorBlinkSpeedSec
EditBox:GetCursorPosition() : cursorPosition
EditBox:GetDisplayText() : displayText
EditBox:GetFont() : name, fontHeight, flags
EditBox:GetFontObject() : font
EditBox:GetHighlightColor() : colorR, colorG, colorB, colorA
EditBox:GetHistoryLines() : numHistoryLines
EditBox:GetIndentedWordWrap() : isIndented
EditBox:GetInputLanguage() : language
EditBox:GetJustifyH() : justifyH
EditBox:GetJustifyV() : justifyV
EditBox:GetMaxBytes() : maxBytes
EditBox:GetMaxLetters() : maxLetters
EditBox:GetNumLetters() : numLetters
EditBox:GetNumber() : number?
EditBox:GetShadowColor() : colorR, colorG, colorB, colorA
EditBox:GetShadowOffset() : offsetX, offsetY
EditBox:GetSpacing() : fontHeight
EditBox:GetText() : text
EditBox:GetTextColor() : colorR, colorG, colorB, colorA
EditBox:GetTextInsets() : left, right, top, bottom
EditBox:GetUTF8CursorPosition() : cursorPosition
EditBox:GetVisibleTextByteLimit() : maxVisibleBytes
EditBox:HasFocus() : hasFocus
EditBox:HasText() : hasText
EditBox:HighlightText(start?, stop?)
EditBox:Insert(text)
EditBox:IsAutoFocus() : autoFocus
EditBox:IsCountInvisibleLetters() : countInvisibleLetters
EditBox:IsEnabled() : isEnabled
EditBox:IsInIMECompositionMode() : isInIMECompositionMode
EditBox:IsMultiLine() : multiline
EditBox:IsNumeric() : isNumeric
EditBox:IsPassword() : isPassword
EditBox:IsSecureText() : isSecure
EditBox:SetAltArrowKeyMode(altMode?)
EditBox:SetAutoFocus(autoFocus?)
EditBox:SetBlinkSpeed(cursorBlinkSpeedSec)
EditBox:SetCountInvisibleLetters(countInvisibleLetters?)
EditBox:SetCursorPosition(cursorPosition)
EditBox:SetEnabled(enabled?)
EditBox:SetFocus()
EditBox:SetFont(fontFile, height, flags) : success
EditBox:SetFontObject(font)
EditBox:SetHighlightColor(colorR, colorG, colorB, a?)
EditBox:SetHistoryLines(numHistoryLines)
EditBox:SetIndentedWordWrap(isIndented?)
EditBox:SetJustifyH(justifyH)
EditBox:SetJustifyV(justifyV)
EditBox:SetMaxBytes(maxBytes)
EditBox:SetMaxLetters(maxLetters)
EditBox:SetMultiLine(multiline?)
EditBox:SetNumber(number)
EditBox:SetNumeric(isNumeric?)
EditBox:SetPassword(isPassword?)
EditBox:SetSecureText(isSecure?)
EditBox:SetSecurityDisablePaste()
EditBox:SetSecurityDisableSetText()
EditBox:SetShadowColor(colorR, colorG, colorB, a?)
EditBox:SetShadowOffset(offsetX, offsetY)
EditBox:SetSpacing(fontHeight)
EditBox:SetText(text)
EditBox:SetTextColor(colorR, colorG, colorB, a?)
EditBox:SetTextInsets(left, right, top, bottom)
EditBox:SetVisibleTextByteLimit(maxVisibleBytes)
EditBox:ToggleInputLanguage()

GameTooltip[]

In patch 10.0.2 any addons that are creating GameTooltip frames should now ensure they inherit GameTooltipTemplate. This template has been updated to include the new GameTooltipDataMixin mixin, which provides automatic updates of tooltip contents from the TOOLTIP_DATA_UPDATE event as well as a subset of backwards-compatible methods for retrieving or populating tooltip contents from the new C_TooltipInfo APIs.

CreateFrame("GameTooltip") -- inherits `Frame`
GameTooltip:AddAtlas
GameTooltip:AddDoubleLine
GameTooltip:AddFontStrings
GameTooltip:AddLine
GameTooltip:AddTexture
GameTooltip:AppendText
GameTooltip:ClearLines
GameTooltip:CopyTooltip
GameTooltip:FadeOut
GameTooltip:GetAnchorType
GameTooltip:GetCustomLineSpacing
GameTooltip:GetMinimumWidth
GameTooltip:GetOwner
GameTooltip:GetPadding
GameTooltip:IsOwned
GameTooltip:NumLines
GameTooltip:SetAllowShowWithNoLines
GameTooltip:SetAnchorType
GameTooltip:SetCustomLineSpacing
GameTooltip:SetCustomWordWrapMinWidth
GameTooltip:SetFrameStack
GameTooltip:SetMinimumWidth
GameTooltip:SetObjectTooltipPosition
GameTooltip:SetOwner
GameTooltip:SetPadding
GameTooltip:SetShrinkToFitWrapped
GameTooltip:SetText
CreateFrame("GameTooltip", nil, nil, "GameTooltipTemplate") -- includes `GameTooltipDataMixin`

See also C_TooltipInfo

GameTooltip:SetAchievementByID
GameTooltip:SetAction
GameTooltip:SetArtifactItem
GameTooltip:SetArtifactPowerByID
GameTooltip:SetAzeriteEssence
GameTooltip:SetAzeriteEssenceSlot
GameTooltip:SetAzeritePower
GameTooltip:SetBackpackToken
GameTooltip:SetBagItem
GameTooltip:SetBagItemChild
GameTooltip:SetBuybackItem
GameTooltip:SetCompanionPet
GameTooltip:SetConduit
GameTooltip:SetCurrencyByID
GameTooltip:SetCurrencyToken
GameTooltip:SetEnhancedConduit
GameTooltip:SetEquipmentSet
GameTooltip:SetExistingSocketGem
GameTooltip:SetGuildBankItem
GameTooltip:SetHeirloomByItemID
GameTooltip:SetHyperlink
GameTooltip:SetInboxItem
GameTooltip:SetInstanceLockEncountersComplete
GameTooltip:SetInventoryItem
GameTooltip:SetInventoryItemByID
GameTooltip:SetItemByGUID
GameTooltip:SetItemByID
GameTooltip:SetItemInteractionItem
GameTooltip:SetItemKey
GameTooltip:SetLFGDungeonReward
GameTooltip:SetLFGDungeonShortageReward
GameTooltip:SetLootCurrency
GameTooltip:SetLootItem
GameTooltip:SetLootRollItem
GameTooltip:SetMerchantCostItem
GameTooltip:SetMerchantItem
GameTooltip:SetMinimapMouseover
GameTooltip:SetMountBySpellID
GameTooltip:SetOwnedItemByID
GameTooltip:SetPetAction
GameTooltip:SetPossession
GameTooltip:SetPvpBrawl
GameTooltip:SetPvpTalent
GameTooltip:SetQuestCurrency
GameTooltip:SetQuestItem
GameTooltip:SetQuestLogCurrency
GameTooltip:SetQuestLogItem
GameTooltip:SetQuestLogRewardSpell
GameTooltip:SetQuestLogSpecialItem
GameTooltip:SetQuestPartyProgress
GameTooltip:SetQuestRewardSpell
GameTooltip:SetRecipeRankInfo
GameTooltip:SetRecipeReagentItem
GameTooltip:SetRecipeResultItem
GameTooltip:SetRecipeResultItemForOrder
GameTooltip:SetRuneforgeResultItem
GameTooltip:SetSendMailItem
GameTooltip:SetShapeshift
GameTooltip:SetSlottedKeystone
GameTooltip:SetSocketedItem
GameTooltip:SetSocketedRelic
GameTooltip:SetSocketGem
GameTooltip:SetSpellBookItem
GameTooltip:SetSpellByID
GameTooltip:SetTalent
GameTooltip:SetTotem
GameTooltip:SetToyByItemID
GameTooltip:SetTradePlayerItem
GameTooltip:SetTradeTargetItem
GameTooltip:SetTrainerService
GameTooltip:SetTraitEntry
GameTooltip:SetTransmogrifyItem
GameTooltip:SetUnit
GameTooltip:SetUnitAura
GameTooltip:SetUnitBuff
GameTooltip:SetUnitBuffByAuraInstanceID
GameTooltip:SetUnitDebuff
GameTooltip:SetUnitDebuffByAuraInstanceID
GameTooltip:SetUpgradeItem
GameTooltip:SetVoidDepositItem
GameTooltip:SetVoidItem
GameTooltip:SetVoidWithdrawalItem
GameTooltip:SetWeeklyReward

MessageFrame[]

MessageFrame:AddMessage(text, colorR, colorG, colorB, a?, messageID?)
MessageFrame:Clear()
MessageFrame:GetFadeDuration() : fadeDurationSeconds
MessageFrame:GetFadePower() : fadePower
MessageFrame:GetFading() : isFading
MessageFrame:GetFont() : fontFile, height, flags
MessageFrame:GetFontObject() : font
MessageFrame:GetFontStringByID(messageID) : fontString
MessageFrame:GetIndentedWordWrap() : wordWrap
MessageFrame:GetInsertMode() : mode
MessageFrame:GetJustifyH() : justifyH
MessageFrame:GetJustifyV() : justifyV
MessageFrame:GetShadowColor() : colorR, colorG, colorB, colorA
MessageFrame:GetShadowOffset() : offsetX, offsetY
MessageFrame:GetSpacing() : spacing
MessageFrame:GetTextColor() : colorR, colorG, colorB, colorA
MessageFrame:GetTimeVisible() : timeVisibleSeconds
MessageFrame:HasMessageByID(messageID) : hasMessage
MessageFrame:ResetMessageFadeByID(messageID)
MessageFrame:SetFadeDuration(fadeDurationSeconds)
MessageFrame:SetFadePower(fadePower)
MessageFrame:SetFading(fading)
MessageFrame:SetFont(fontFile, height, flags)
MessageFrame:SetFontObject(font)
MessageFrame:SetIndentedWordWrap(wordWrap)
MessageFrame:SetInsertMode(mode)
MessageFrame:SetJustifyH(justifyH)
MessageFrame:SetJustifyV(justifyV)
MessageFrame:SetShadowColor(colorR, colorG, colorB, a?)
MessageFrame:SetShadowOffset(offsetX, offsetY)
MessageFrame:SetSpacing(spacing)
MessageFrame:SetTextColor(colorR, colorG, colorB, a?)
MessageFrame:SetTimeVisible(timeVisibleSeconds)

Minimap[]

unique widget

Minimap:GetPingPosition() : positionX, positionY
Minimap:GetZoom() : zoomFactor
Minimap:GetZoomLevels() : zoomLevels
Minimap:PingLocation(locationX, locationY)
Minimap:SetArchBlobInsideAlpha(alpha)
Minimap:SetArchBlobInsideTexture(asset)
Minimap:SetArchBlobOutsideAlpha(alpha)
Minimap:SetArchBlobOutsideTexture(asset)
Minimap:SetArchBlobRingAlpha(alpha)
Minimap:SetArchBlobRingScalar(scalar)
Minimap:SetArchBlobRingTexture(asset)
Minimap:SetBlipTexture(asset)
Minimap:SetCorpsePOIArrowTexture(asset)
Minimap:SetIconTexture(asset)
Minimap:SetMaskTexture(asset)
Minimap:SetPOIArrowTexture(asset)
Minimap:SetPlayerTexture(asset)
Minimap:SetQuestBlobInsideAlpha(alpha)
Minimap:SetQuestBlobInsideTexture(asset)
Minimap:SetQuestBlobOutsideAlpha(alpha)
Minimap:SetQuestBlobOutsideTexture(asset)
Minimap:SetQuestBlobRingAlpha(alpha)
Minimap:SetQuestBlobRingScalar(scalar)
Minimap:SetQuestBlobRingTexture(asset)
Minimap:SetStaticPOIArrowTexture(asset)
Minimap:SetTaskBlobInsideAlpha(alpha)
Minimap:SetTaskBlobInsideTexture(asset)
Minimap:SetTaskBlobOutsideAlpha(alpha)
Minimap:SetTaskBlobOutsideTexture(asset)
Minimap:SetTaskBlobRingAlpha(alpha)
Minimap:SetTaskBlobRingScalar(scalar)
Minimap:SetTaskBlobRingTexture(asset)
Minimap:SetZoom(zoomFactor)
Minimap:UpdateBlips()

MovieFrame[]

MovieFrame:EnableSubtitles(enable)
MovieFrame:StartMovie(movieID, looping?) : success, returnCode
MovieFrame:StartMovieByName(movieName, looping?, resolution?) : success, returnCode
MovieFrame:StopMovie()

ScrollFrame[]

ScrollFrame:GetHorizontalScroll() : offset
ScrollFrame:GetHorizontalScrollRange() : range
ScrollFrame:GetScrollChild() : scrollChild
ScrollFrame:GetVerticalScroll() : offset
ScrollFrame:GetVerticalScrollRange() : range
ScrollFrame:SetHorizontalScroll(offset)
ScrollFrame:SetScrollChild(scrollChild)
ScrollFrame:SetVerticalScroll(offset)
ScrollFrame:UpdateScrollChildRect()

SimpleHTML[]

SimpleHTML:GetContentHeight() : height
SimpleHTML:GetFont(textType) : fontFile, height, flags
SimpleHTML:GetFontObject(textType) : font
SimpleHTML:GetHyperlinkFormat() : format
SimpleHTML:GetIndentedWordWrap(textType) : wordWrap
SimpleHTML:GetJustifyH(textType) : justifyH
SimpleHTML:GetJustifyV(textType) : justifyV
SimpleHTML:GetShadowColor(textType) : colorR, colorG, colorB, colorA
SimpleHTML:GetShadowOffset(textType) : offsetX, offsetY
SimpleHTML:GetSpacing(textType) : spacing
SimpleHTML:GetTextColor(textType) : colorR, colorG, colorB, colorA
SimpleHTML:GetTextData() : content
SimpleHTML:SetFont(textType, fontFile, height, flags)
SimpleHTML:SetFontObject(textType, font)
SimpleHTML:SetHyperlinkFormat(format)
SimpleHTML:SetIndentedWordWrap(textType, wordWrap)
SimpleHTML:SetJustifyH(textType, justifyH)
SimpleHTML:SetJustifyV(textType, justifyV)
SimpleHTML:SetShadowColor(textType, colorR, colorG, colorB, a?)
SimpleHTML:SetShadowOffset(textType, offsetX, offsetY)
SimpleHTML:SetSpacing(textType, spacing)
SimpleHTML:SetText(text, ignoreMarkup?)
SimpleHTML:SetTextColor(textType, colorR, colorG, colorB, a?)

Slider[]

Slider:Disable()
Slider:Enable()
Slider:GetMinMaxValues() : minValue, maxValue
Slider:GetObeyStepOnDrag() : isObeyStepOnDrag
Slider:GetOrientation() : orientation
Slider:GetStepsPerPage() : stepsPerPage
Slider:GetThumbTexture() : texture
Slider:GetValue() : value
Slider:GetValueStep() : valueStep
Slider:IsDraggingThumb() : isDraggingThumb
Slider:IsEnabled() : enabled
Slider:SetEnabled(enabled)
Slider:SetMinMaxValues(minValue, maxValue)
Slider:SetObeyStepOnDrag(obeyStepOnDrag)
Slider:SetOrientation(orientation)
Slider:SetStepsPerPage(stepsPerPage)
Slider:SetThumbTexture(asset)
Slider:SetValue(value, treatAsMouseEvent?)
Slider:SetValueStep(valueStep)

StatusBar[]

StatusBar:GetFillStyle() : fillStyle
StatusBar:GetMinMaxValues() : minValue, maxValue
StatusBar:GetOrientation() : orientation
StatusBar:GetReverseFill() : isReverseFill
StatusBar:GetRotatesTexture() : rotatesTexture
StatusBar:GetStatusBarColor() : colorR, colorG, colorB, colorA
StatusBar:GetStatusBarDesaturation() : desaturation
StatusBar:GetStatusBarTexture() : texture
StatusBar:GetValue() : value
StatusBar:IsStatusBarDesaturated() : desaturated
StatusBar:SetColorFill(colorR, colorG, colorB, a?)
StatusBar:SetFillStyle(fillStyle)
StatusBar:SetMinMaxValues(minValue, maxValue)
StatusBar:SetOrientation(orientation)
StatusBar:SetReverseFill(isReverseFill)
StatusBar:SetRotatesTexture(rotatesTexture)
StatusBar:SetStatusBarColor(colorR, colorG, colorB, a?)
StatusBar:SetStatusBarDesaturated(desaturated?)
StatusBar:SetStatusBarDesaturation(desaturation)
StatusBar:SetStatusBarTexture(asset)
StatusBar:SetValue(value)

Undocumented[]

These widget types have yet to be documented on the wiki.

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()

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:ReleaseFrontEndCharacterDisplays()
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:SetFrontEndLobbyModelFromDefaultCharacterDisplay()
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)

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()

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()
Advertisement