Widget API

Main Menu

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.

Widget hierarchy
/fstack and /tinspect

Note: This list is up to date as of Patch 10.2.6 (53840) Mar 18 2024

Base

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:ClearParentKey() - Clears the parent key.

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 [, clearOtherKeys]) - Sets a key on the parent to the child object.

ScriptObject

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

ScriptObject:HasScript(scriptName) : hasScript - Returns true if the region supports the given script type.

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

ScriptObject:SetScript(scriptTypeName [, script]) - Sets the widget script handler.

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 to the bottom edge of the region.

ScriptRegion:GetCenter() : x, y #restrictedframe - Returns the offset to the center of the region.

ScriptRegion:GetHeight([ignoreRect]) : height - Returns the height of the region.

ScriptRegion:GetLeft() : left #restrictedframe - Returns the offset 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 to the right edge of the region.

ScriptRegion:GetScaledRect() : left, bottom, width, height - Returns the scaled coords and size of the region.

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 to the top edge of the region.

ScriptRegion:GetWidth([ignoreRect]) : width - Returns the width of the region.

ScriptRegion:Hide() #secureframe - Hides the region.

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

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.

Textures

TextureBase

TextureBase:ClearTextureSlice()

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:GetTextureSliceMargins() : left, top, right, bottom

TextureBase:GetTextureSliceMode() : sliceMode

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, top, bottom) - 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:SetTextureSliceMargins(left, top, right, bottom)

TextureBase:SetTextureSliceMode(sliceMode)

TextureBase:SetVertTile([tiling]) - Sets whether the texture should tile vertically.

TextureBase:SetVertexOffset(vertexIndex, offsetX, offsetY) - Sets a vertex offset for the texture.

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:GetHitRectThickness() : thickness

Line:GetStartPoint() : relativePoint, relativeTo, offsetX, offsetY

Line:GetThickness() : thickness

Line:SetEndPoint(relativePoint, relativeTo [, offsetX, offsetY])

Line:SetHitRectThickness(thickness)

Line:SetStartPoint(relativePoint, relativeTo [, offsetX, offsetY])

Line:SetThickness(thickness)

Fonts

FontInstance

FontInstance:GetFont() : fontFile, height, flags - Returns the font path, height, and flags.

FontInstance:GetFontObject() : font - Returns the "parent" font object.

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

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

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

FontInstance:GetShadowColor() : colorR, colorG, colorB, colorA - Sets the text shadow color.

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

FontInstance:GetSpacing() : spacing - Returns the line spacing.

FontInstance:GetTextColor() : colorR, colorG, colorB, colorA - Returns the default text color.

FontInstance:SetFont(fontFile, height, flags) - Sets the basic font properties.

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

FontInstance:SetIndentedWordWrap(wordWrap) - Sets the indentation when text wraps beyond the first line.

FontInstance:SetJustifyH(justifyH) - Sets the horizontal text justification

FontInstance:SetJustifyV(justifyV) - Sets the vertical text justification.

FontInstance:SetShadowColor(colorR, colorG, colorB [, a]) - Returns the color of text shadow.

FontInstance:SetShadowOffset(offsetX, offsetY) - Sets the text shadow offset.

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

FontInstance:SetTextColor(colorR, colorG, colorB [, a]) - Sets the default text color.

Font

Font:CopyFontObject(sourceFont)

Font:GetAlpha() : alpha

Font:SetAlpha(alpha)

FontString

FontString:CalculateScreenAreaFromCharacterSpan(leftIndex, rightIndex) : areas

FontString:CanNonSpaceWrap() : wrap

FontString:CanWordWrap() : wrap

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

FontString:GetFieldSize() : fieldSize

FontString:GetLineHeight() : lineHeight

FontString:GetMaxLines() : maxLines

FontString:GetNumLines() : numLines

FontString:GetRotation() : radians

FontString:GetStringHeight() : height

FontString:GetStringWidth() : width

FontString:GetText() : text

FontString:GetTextScale() : textScale

FontString:GetUnboundedStringWidth() : width

FontString:GetWrappedWidth() : width

FontString:IsTruncated() : isTruncated

FontString:SetAlphaGradient(start, length) : isWithinText

FontString:SetFixedColor(fixedColor)

FontString:SetFormattedText(text)

FontString:SetMaxLines(maxLines)

FontString:SetNonSpaceWrap(wrap)

FontString:SetRotation(radians)

FontString:SetText([text])

FontString:SetTextHeight(height)

FontString:SetTextScale(textScale)

FontString:SetWordWrap(wrap)

Animations

AnimationGroup

AnimationGroup:CreateAnimation([animationType, name, templateName]) : anim - Returns an animation as a child of this group.

AnimationGroup:Finish() - Notifies the animationgroup to stop playing once the current loop cycle is done.

AnimationGroup:GetAnimationSpeedMultiplier() : animationSpeedMultiplier

AnimationGroup:GetAnimations() : scriptObject, ...

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

AnimationGroup:GetElapsed() : elapsedSec

AnimationGroup:GetLoopState() : loopState - Returns the current loop state of the group.

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

AnimationGroup:GetProgress() : progress - Returns the progress of this animation.

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

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

AnimationGroup:IsPendingFinish() : isPendingFinish

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

AnimationGroup:IsReverse() : isReverse

AnimationGroup:IsSetToFinalAlpha() : isSetToFinalAlpha

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

AnimationGroup:Play([reverse, offset]) - Starts playing the animations in this group.

AnimationGroup:RemoveAnimations()

AnimationGroup:Restart([reverse, offset])

AnimationGroup:SetAnimationSpeedMultiplier(animationSpeedMultiplier)

AnimationGroup:SetLooping(loopType) - Sets the type of looping for the group.

AnimationGroup:SetPlaying(play)

AnimationGroup:SetToFinalAlpha(setToFinalAlpha)

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

Animation

Animation:GetDuration() : durationSec - Returns the number of seconds it takes for the animation to progress from start to finish.

Animation:GetElapsed() : elapsedSec - Returns the amount of time in seconds that the animation has been playing for.

Animation:GetEndDelay() : delaySec - Returns the number of seconds the animation delays after finishing.

Animation:GetOrder() : order - Returns the order of the animation within its parent group.

Animation:GetProgress() : progress - Returns the progress of the animation.

Animation:GetRegionParent() : region - Returns the Region object that the animation operates on.

Animation:GetSmoothProgress() : progress - Returns a smoothed progress value for the animation.

Animation:GetSmoothing() : weights - Returns the smoothing type for the animation.

Animation:GetStartDelay() : delaySec - Sets the number of seconds that the animation delays before it starts to progress.

Animation:GetTarget() : target

Animation:IsDelaying() : isDelaying - Returns true if the animation is in the middle of a start or end delay.

Animation:IsDone() : isDone - Returns true if the animation has finished playing.

Animation:IsPaused() : isPaused - Returns true if the animation is paused.

Animation:IsPlaying() : isPlaying

Animation:IsStopped() : isStopped - Returns true if the animation is stopped.

Animation:Pause() - Pauses the animation.

Animation:Play() - Plays the animation.

Animation:Restart()

Animation:SetChildKey(childKey) : success

Animation:SetDuration(durationSec [, recomputeGroupDuration]) - Sets the number of seconds it takes for the animation to progress from start to finish.

Animation:SetEndDelay(delaySec [, recomputeGroupDuration]) - Sets the number of seconds the animation delays after finishing.

Animation:SetOrder(newOrder) - Sets the order that the animation plays within its parent group.

Animation:SetParent(parent [, order]) - Sets the parent for the animation.

Animation:SetPlaying(play)

Animation:SetSmoothProgress(durationSec) - Sets the smoothing type for the animation.

Animation:SetSmoothing(weights)

Animation:SetStartDelay(delaySec [, recomputeGroupDuration]) - Returns the number of seconds that the animation delays before it starts to progress.

Animation:SetTarget(target) : success

Animation:SetTargetKey(key) : success

Animation:SetTargetName(name) : success

Animation:SetTargetParent() : success

Animation:Stop() - Stops the animation.

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() : controlPoint, ...

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)

VertexColor

VertexColor:GetEndColor() : color

VertexColor:GetStartColor() : color

VertexColor:SetEndColor(color)

VertexColor:SetStartColor(color)

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:GetRaisedFrameLevel() : frameLevel

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:GetWindow() : window

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:LockHighlight() - Sets the frame or button to always be drawn highlighted.

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:SetHighlightLocked(locked)

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:SetWindow([window])

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:UnlockHighlight() - Sets the frame or button to not always be drawn highlighted.

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:RegisterForClicks([button1, ...]) - Registers the button widget to receive OnClick script events.

Button:RegisterForMouse([button1, ...]) - Registers the button widget to receive OnMouse script events.

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: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.

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:ApplySpellVisualKit(spellVisualKitID [, oneShot])

PlayerModel:CanSetUnit(unit)

PlayerModel:FreezeAnimation(anim, variation, frame) - Freezes an animation at a specific animation frame on the model.

PlayerModel:GetDisplayInfo() : displayID

PlayerModel:GetDoBlend() : doBlend

PlayerModel:GetKeepModelOnHide() : keepModelOnHide

PlayerModel:HasAnimation(anim) : hasAnimation - Returns true if the currently displayed model supports the given animation ID.

PlayerModel:PlayAnimKit(animKit [, loop])

PlayerModel:RefreshCamera()

PlayerModel:RefreshUnit()

PlayerModel:SetAnimation(anim [, variation]) - Sets the animation to be played by the model.

PlayerModel:SetBarberShopAlternateForm()

PlayerModel:SetCamDistanceScale(scale)

PlayerModel:SetCreature(creatureID [, displayID])

PlayerModel:SetDisplayInfo(displayID [, mountDisplayID])

PlayerModel:SetDoBlend([doBlend])

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

PlayerModel:SetItemAppearance(itemAppearanceID [, itemVisualID, itemSubclass])

PlayerModel:SetKeepModelOnHide(keepModelOnHide)

PlayerModel:SetPortraitZoom(zoom)

PlayerModel:SetRotation(radians [, animate])

PlayerModel:SetUnit(unit [, blend, useNativeForm]) : success - Sets the model to display the specified unit.

PlayerModel:StopAnimKit()

PlayerModel:ZeroCachedCenterXY()

CinematicModel

CinematicModel:EquipItem(itemID)

CinematicModel:InitializeCamera([scaleFactor])

CinematicModel:InitializePanCamera([scaleFactor])

CinematicModel:RefreshCamera()

CinematicModel:SetAnimOffset(offset)

CinematicModel:SetCameraPosition(positionX, positionY, positionZ) -> Model:SetCameraPosition

CinematicModel:SetCameraTarget(positionX, positionY, positionZ)

CinematicModel:SetCreatureData(creatureID)

CinematicModel:SetFacingLeft([isFacingLeft])

CinematicModel:SetFadeTimes(fadeInSeconds, fadeOutSeconds)

CinematicModel:SetHeightFactor(factor)

CinematicModel:SetJumpInfo(jumpLength, jumpHeight)

CinematicModel:SetPanDistance(scale)

CinematicModel:SetSpellVisualKit(visualKitID)

CinematicModel:SetTargetDistance(scale)

CinematicModel:StartPan(panType, durationSeconds [, doFade, visKitID, startPositionScale, speedMultiplier])

CinematicModel:StopPan()

CinematicModel:UnequipItems()

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)

TabardModel

TabardModel:GetLowerBackgroundFileName() : file

TabardModel:GetLowerEmblemFile() : file

TabardModel:GetUpperBackgroundFileName() : file

TabardModel:GetUpperEmblemFile() : file

TabardModelBase:CanSaveTabardNow() : canSave

TabardModelBase:CycleVariation(variationIndex, delta)

TabardModelBase:GetLowerEmblemTexture(texture)

TabardModelBase:GetUpperEmblemTexture(texture)

TabardModelBase:InitializeTabardColors()

TabardModelBase:IsGuildTabard() : isGuildTabard

TabardModelBase:Save()

ModelScene

ModelScene:CreateActor([name, template]) : actor

ModelScene:GetActorAtIndex(index) : actor

ModelScene:GetCameraFarClip() : farClip

ModelScene:GetCameraFieldOfView() : fov

ModelScene:GetCameraForward() : forwardX, forwardY, forwardZ

ModelScene:GetCameraNearClip() : nearClip

ModelScene:GetCameraRight() : rightX, rightY, rightZ

ModelScene:GetCameraUp() : upX, upY, upZ

ModelScene:GetDrawLayer() : layer, sublevel

ModelScene:GetLightAmbientColor() : colorR, colorG, colorB

ModelScene:GetLightDiffuseColor() : colorR, colorG, colorB

ModelScene:GetLightDirection() : directionX, directionY, directionZ

ModelScene:GetLightPosition() : positionX, positionY, positionZ

ModelScene:GetLightType() : lightType

ModelScene:GetNumActors() : numActors

ModelScene:IsLightVisible() : isVisible

ModelScene:Project3DPointTo2D(pointX, pointY, pointZ) : point2DX, point2DY, depth - Converts a 3 dimensional point into clip space using the model scene camera properties.

ModelScene:SetCameraFarClip(farClip)

ModelScene:SetCameraFieldOfView(fov)

ModelScene:SetCameraNearClip(nearClip)

ModelScene:SetCameraOrientationByAxisVectors(forwardX, forwardY, forwardZ, rightX, rightY, rightZ, upX, upY, upZ)

ModelScene:SetCameraOrientationByYawPitchRoll(yaw, pitch, roll)

ModelScene:SetDrawLayer(layer)

ModelScene:SetLightAmbientColor(colorR, colorG, colorB)

ModelScene:SetLightDiffuseColor(colorR, colorG, colorB)

ModelScene:SetLightDirection(directionX, directionY, directionZ)

ModelScene:SetLightPosition(positionX, positionY, positionZ)

ModelScene:SetLightType(lightType)

ModelScene:SetLightVisible([visible])

ModelScene:SetPaused(paused [, affectsGlobalPause])

ModelScene:TakeActor()

ModelSceneActor

ModelSceneActor:AttachToMount(rider, animation [, spellKitVisualID]) : success

ModelSceneActor:CalculateMountScale(rider) : scale

ModelSceneActor:GetPaused() : paused, globalPaused

ModelSceneActor:ReleaseFrontEndCharacterDisplays() : success

ModelSceneActor:ResetNextHandSlot()

ModelSceneActor:SetFrontEndLobbyModelFromDefaultCharacterDisplay(characterIndex) : success

ModelSceneActor:SetModelByHyperlink(link) : success

ModelSceneActor:SetPaused(paused [, affectsGlobalPause])

ModelSceneActor:SetPlayerModelFromGlues([sheatheWeapons, autoDress, hideWeapons, usePlayerNativeForm]) : success

ModelSceneActorBase:GetActiveBoundingBox() : boxBottom, boxTop

ModelSceneActorBase:GetAnimation() : animation

ModelSceneActorBase:GetAnimationBlendOperation() : blendOp

ModelSceneActorBase:GetAnimationVariation() : variation

ModelSceneActorBase:GetMaxBoundingBox() : boxBottom, boxTop

ModelSceneActorBase:GetModelPath() : path

ModelSceneActorBase:GetModelUnitGUID() : guid

ModelSceneActorBase:GetParticleOverrideScale() : scale

ModelSceneActorBase:GetSpellVisualKit() : spellVisualKitID

ModelSceneActorBase:GetYaw() : yaw

ModelSceneActorBase:IsLoaded() : isLoaded

ModelSceneActorBase:IsUsingCenterForOrigin() : x, y, z

ModelSceneActorBase:PlayAnimationKit(animationKit [, isLooping])

ModelSceneActorBase:SetAnimation(animation [, variation, animSpeed, animOffsetSeconds])

ModelSceneActorBase:SetAnimationBlendOperation(blendOp)

ModelSceneActorBase:SetModelByCreatureDisplayID(creatureDisplayID [, useActivePlayerCustomizations]) : success

ModelSceneActorBase:SetModelByFileID(asset [, useMips]) : success

ModelSceneActorBase:SetModelByPath(asset [, useMips]) : success

ModelSceneActorBase:SetModelByUnit(unit [, sheatheWeapons, autoDress, hideWeapons, usePlayerNativeForm, holdBowString]) : success

ModelSceneActorBase:SetParticleOverrideScale([scale])

ModelSceneActorBase:SetSpellVisualKit([spellVisualKitID, oneShot])

ModelSceneActorBase:SetUseCenterForOrigin([x, y, z])

ModelSceneActorBase:SetYaw(yaw)

ModelSceneActorBase:StopAnimationKit()

EditBox

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

EditBox:ClearFocus() - Removes text input focus from this editbox element.

EditBox:ClearHighlightText()

EditBox:ClearHistory()

EditBox:Disable()

EditBox:Enable()

EditBox:GetAltArrowKeyMode() : altMode

EditBox:GetBlinkSpeed() : cursorBlinkSpeedSec - Returns the blink speed.

EditBox:GetCursorPosition() : cursorPosition - Returns the cursor position in the editbox.

EditBox:GetDisplayText() : displayText

EditBox:GetHighlightColor() : colorR, colorG, colorB, colorA

EditBox:GetHistoryLines() : numHistoryLines - Returns the number of history lines for this editbox.

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

EditBox:GetMaxBytes() : maxBytes

EditBox:GetMaxLetters() : maxLetters

EditBox:GetNumLetters() : numLetters - Returns the number of letters in the editbox.

EditBox:GetNumber() : number - Returns the number entered in the editbox, or 0 if editbox text is not a number.

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

EditBox:GetTextInsets() : left, right, top, bottom - Returns a list of left,right,top,bottom text insets.

EditBox:GetUTF8CursorPosition() : cursorPosition

EditBox:GetVisibleTextByteLimit() : maxVisibleBytes

EditBox:HasFocus() : hasFocus - Returns true if the edit box has the focus.

EditBox:HasText() : hasText

EditBox:HighlightText([start, stop]) - Highlights all or some of the edit box text.

EditBox:Insert(text) - Insert text into the editbox.

EditBox:IsAlphabeticOnly() : enabled

EditBox:IsAutoFocus() : autoFocus

EditBox:IsCountInvisibleLetters() : countInvisibleLetters

EditBox:IsEnabled() : isEnabled

EditBox:IsInIMECompositionMode() : isInIMECompositionMode

EditBox:IsMultiLine() : multiline

EditBox:IsNumeric() : isNumeric

EditBox:IsNumericFullRange() : isNumeric

EditBox:IsPassword() : isPassword

EditBox:IsSecureText() : isSecure

EditBox:ResetInputMode()

EditBox:SetAlphabeticOnly([enabled])

EditBox:SetAltArrowKeyMode([altMode])

EditBox:SetAutoFocus([autoFocus])

EditBox:SetBlinkSpeed(cursorBlinkSpeedSec)

EditBox:SetCountInvisibleLetters([countInvisibleLetters])

EditBox:SetCursorPosition(cursorPosition) - Sets the cursor position in the editbox.

EditBox:SetEnabled([enabled])

EditBox:SetFocus()

EditBox:SetHighlightColor(colorR, colorG, colorB [, a])

EditBox:SetHistoryLines(numHistoryLines) - Sets the number of history lines to remember.

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

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

EditBox:SetMultiLine([multiline])

EditBox:SetNumber(number)

EditBox:SetNumeric([isNumeric])

EditBox:SetNumericFullRange([isNumeric])

EditBox:SetPassword([isPassword])

EditBox:SetSecureText([isSecure])

EditBox:SetSecurityDisablePaste()

EditBox:SetSecurityDisableSetText()

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

EditBox:SetTextInsets(left, right, top, bottom)

EditBox:SetVisibleTextByteLimit(maxVisibleBytes)

EditBox:ToggleInputLanguage()

MessageFrame

MessageFrame:AddMessage(text, colorR, colorG, colorB [, a, messageID])

MessageFrame:Clear()

MessageFrame:GetFadeDuration() : fadeDurationSeconds

MessageFrame:GetFadePower() : fadePower

MessageFrame:GetFading() : isFading

MessageFrame:GetFontStringByID(messageID) : fontString

MessageFrame:GetInsertMode() : mode

MessageFrame:GetTimeVisible() : timeVisibleSeconds

MessageFrame:HasMessageByID(messageID) : hasMessage

MessageFrame:ResetMessageFadeByID(messageID)

MessageFrame:SetFadeDuration(fadeDurationSeconds)

MessageFrame:SetFadePower(fadePower)

MessageFrame:SetFading(fading)

MessageFrame:SetInsertMode(mode)

MessageFrame:SetTimeVisible(timeVisibleSeconds)

SimpleHTML

SimpleHTML:GetContentHeight() : height

SimpleHTML:GetHyperlinkFormat() : format

SimpleHTML:GetTextData() : content

SimpleHTML:SetHyperlinkFormat(format)

SimpleHTML:SetText(text [, ignoreMarkup])

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

GameTooltip:AddDoubleLine(leftText, rightText [, leftR, leftG, leftB [, rightR, rightG, rightB]])

GameTooltip:AddFontStrings(leftstring, rightstring)

GameTooltip:AddLine(tooltipText [, r, g, b, wrapText])

GameTooltip:AddTexture(texture)

GameTooltip:AppendText(text)

GameTooltip:ClearLines()

GameTooltip:CopyTooltip()

GameTooltip:FadeOut()

GameTooltip:GetAnchorType() : anchorType

GameTooltip:GetCustomLineSpacing() : spacing

GameTooltip:GetMinimumWidth() : width, force

GameTooltip:GetOwner() : owner

GameTooltip:GetPadding() : right, bottom, left, top

GameTooltip:IsOwned(frame) : bool

GameTooltip:NumLines() : lines

GameTooltip:SetAllowShowWithNoLines([bool])

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

GameTooltip:SetCustomLineSpacing([spacing])

GameTooltip:SetCustomWordWrapMinWidth([width)

GameTooltip:SetFrameStack([showHidden, showRegion, highlightIndexChanged])

GameTooltip:SetMinimumWidth(width [, force])

GameTooltip:SetObjectTooltipPosition()

GameTooltip:SetOwner(owner, anchor [, ofsX, ofsY])

GameTooltip:SetPadding(right, bottom [, left, top])

GameTooltip:SetShrinkToFitWrapped()

GameTooltip:SetText(text [, r, g, b, alpha, textWrap])

-- mixins GameTooltipDataMixin, TooltipDataHandlerMixin and data accessors
CreateFrame("GameTooltip", nil, nil, "GameTooltipTemplate")

ColorSelect

ColorSelect:ClearColorWheelTexture()

ColorSelect:GetColorAlpha() : alpha

ColorSelect:GetColorAlphaTexture() : texture

ColorSelect:GetColorAlphaThumbTexture() : texture

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:SetColorAlpha(alpha)

ColorSelect:SetColorAlphaTexture(texture)

ColorSelect:SetColorAlphaThumbTexture(texture)

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() - Clears the currently active cooldown of the widget.

Cooldown:GetCooldownDisplayDuration() : duration

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

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

Cooldown:GetDrawBling() : drawBling

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

Cooldown:GetDrawSwipe() : drawSwipe

Cooldown:GetEdgeScale() : edgeScale

Cooldown:GetReverse() : reverse - Returns true if the bright and dark portions of the cooldown animation should be inverted.

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

Cooldown:IsPaused() : isPaused - Returns true if the cooldown is currently paused.

Cooldown:Pause() - Pauses the cooldown.

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

Cooldown:SetBlingTexture(texture [, colorR, colorG, colorB, colorA])

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

Cooldown:SetCooldownDuration(duration [, modRate])

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

Cooldown:SetCountdownAbbrevThreshold(seconds)

Cooldown:SetCountdownFont(fontName)

Cooldown:SetDrawBling([drawBling])

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

Cooldown:SetDrawSwipe([drawSwipe])

Cooldown:SetEdgeScale(scale)

Cooldown:SetEdgeTexture(texture [, colorR, colorG, colorB, colorA]) - Sets the texture which 'follows' the moving edge of the cooldown.

Cooldown:SetHideCountdownNumbers([hideNumbers]) - Show or hide text cooldown timer.

Cooldown:SetReverse([reverse]) - Controls the direction of the cooldown animation.

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

Cooldown:SetSwipeColor(colorR, colorG, colorB [, a]) - Sets the color of the swipe

Cooldown:SetSwipeTexture(texture [, colorR, colorG, colorB, colorA]) - Sets the swipe texture used for the cooldown

Cooldown:SetTexCoordRange(low, high)

Cooldown:SetUseCircularEdge([useCircularEdge]) - Sets whether the edge texture should follow a circular pattern instead of square.

Minimap

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

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

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

Minimap:PingLocation([locationX, locationY]) - Perform a ping at the specified location.

Minimap:SetArchBlobInsideAlpha(alpha)

Minimap:SetArchBlobInsideTexture(asset)

Minimap:SetArchBlobOutsideAlpha(alpha)

Minimap:SetArchBlobOutsideTexture(asset)

Minimap:SetArchBlobRingAlpha(alpha)

Minimap:SetArchBlobRingScalar(scalar)

Minimap:SetArchBlobRingTexture(asset)

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

Minimap:SetCorpsePOIArrowTexture(asset)

Minimap:SetIconTexture(asset)

Minimap:SetMaskTexture(asset)

Minimap:SetPOIArrowTexture(asset)

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

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) - Set the current zoom level.

Minimap:UpdateBlips()

MovieFrame

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

MovieFrame:StartMovie(movieID [, looping]) : success, returnCode - Plays a specified movie in the frame.

MovieFrame:StartMovieByName(movieName [, looping, resolution]) : success, returnCode - This method is deprecated and does nothing.

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

ScrollFrame

ScrollFrame:GetHorizontalScroll() : offset

ScrollFrame:GetHorizontalScrollRange() : range

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

ScrollFrame:GetVerticalScroll() : offset

ScrollFrame:GetVerticalScrollRange() : range

ScrollFrame:SetHorizontalScroll(offset)

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

ScrollFrame:SetVerticalScroll(offset)

ScrollFrame:UpdateScrollChildRect()

Slider

Slider:Disable() - Disables the slider.

Slider:Enable() - Enables the slider

Slider:GetMinMaxValues() : minValue, maxValue - Returns the current bounds of the slider.

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

Slider:GetOrientation() : orientation - Returns the slider orientation.

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

Slider:GetThumbTexture() : texture - Returns the texture for this slider's thumb,

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

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

Slider:IsDraggingThumb() : isDraggingThumb

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

Slider:SetEnabled(enabled)

Slider:SetMinMaxValues(minValue, maxValue) - Sets the bounds of the slider.

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

Slider:SetOrientation(orientation) - Sets the orientation of the slider.

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

Slider:SetThumbTexture(asset)

Slider:SetValue(value [, treatAsMouseEvent]) - Sets the value of the slider.

Slider:SetValueStep(valueStep) - Sets the step size of the slider.

StatusBar

StatusBar:GetFillStyle() : fillStyle

StatusBar:GetMinMaxValues() : minValue, maxValue - Returns the current bounds of the statusbar.

StatusBar:GetOrientation() : orientation

StatusBar:GetReverseFill() : isReverseFill

StatusBar:GetRotatesTexture() : rotatesTexture

StatusBar:GetStatusBarColor() : colorR, colorG, colorB, colorA

StatusBar:GetStatusBarDesaturation() : desaturation

StatusBar:GetStatusBarTexture() : texture - Returns the texture object for the statusbar.

StatusBar:GetValue() : value - Returns the current value of the statusbar.

StatusBar:IsStatusBarDesaturated() : desaturated

StatusBar:SetColorFill(colorR, colorG, colorB [, a])

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

StatusBar:SetMinMaxValues(minValue, maxValue) - Set the bounds of the statusbar.

StatusBar:SetOrientation(orientation) - Sets the orientation of the statusbar.

StatusBar:SetReverseFill(isReverseFill) - Sets the fill direction of the statusbar.

StatusBar:SetRotatesTexture(rotatesTexture) - Set the color of the statusbar.

StatusBar:SetStatusBarColor(colorR, colorG, colorB [, a])

StatusBar:SetStatusBarDesaturated([desaturated])

StatusBar:SetStatusBarDesaturation(desaturation)

StatusBar:SetStatusBarTexture(asset) - Sets the texture of the statusbar.

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

FogOfWarFrame

FogOfWarFrame:GetFogOfWarBackgroundAtlas() : atlas

FogOfWarFrame:GetFogOfWarBackgroundTexture() : asset

FogOfWarFrame:GetFogOfWarMaskAtlas() : atlas

FogOfWarFrame:GetFogOfWarMaskTexture() : asset

FogOfWarFrame:GetMaskScalar() : scalar

FogOfWarFrame:GetUiMapID() : uiMapID

FogOfWarFrame:SetFogOfWarBackgroundAtlas(atlas)

FogOfWarFrame:SetFogOfWarBackgroundTexture(asset, horizontalTile, verticalTile)

FogOfWarFrame:SetFogOfWarMaskAtlas(atlas)

FogOfWarFrame:SetFogOfWarMaskTexture(asset)

FogOfWarFrame:SetMaskScalar(scalar)

FogOfWarFrame:SetUiMapID(uiMapID)

UnitPositionFrame

UnitPositionFrame:AddUnit(unitTokenString, asset [, width, height, r, g, b, a, sublayer, showFacing])

UnitPositionFrame:ClearUnits()

UnitPositionFrame:FinalizeUnits()

UnitPositionFrame:GetMouseOverUnits() : units, ...

UnitPositionFrame:GetPlayerPingScale() : scale

UnitPositionFrame:GetUiMapID() : mapID

UnitPositionFrame:SetPlayerPingScale(scale)

UnitPositionFrame:SetPlayerPingTexture(textureType, asset [, width, height])

UnitPositionFrame:SetUiMapID(mapID)

UnitPositionFrame:SetUnitColor(unit, colorR, colorG, colorB, colorA)

UnitPositionFrame:StartPlayerPing([duration, fadeDuration])

UnitPositionFrame:StopPlayerPing()

Blob

Blob:DrawAll()

Blob:DrawBlob(questID [, draw])

Blob:DrawNone()

Blob:EnableMerging([enable])

Blob:EnableSmoothing([enable])

Blob:GetMapID() : uiMapID

Blob:SetBorderAlpha(alpha)

Blob:SetBorderScalar(scalar)

Blob:SetBorderTexture(asset)

Blob:SetFillAlpha(alpha)

Blob:SetFillTexture(asset)

Blob:SetMapID(uiMapID)

Blob:SetMergeThreshold(threshold)

Blob:SetNumSplinePoints(numSplinePoints)

ArchaeologyDigSiteFrame

Inherits all methods from Blob.

QuestPOIFrame

QuestPOIFrame:GetNumTooltips() : numObjectives

QuestPOIFrame:GetTooltipIndex(index) : objectiveIndex

QuestPOIFrame:UpdateMouseOverTooltip(x, y) : questID, numObjectives

ScenarioPOIFrame

ScenarioPOIFrame:GetScenarioTooltipText() : tooltipText

ScenarioPOIFrame:UpdateMouseOverTooltip(x, y) : hasTooltip

Navigation menu

Search