Lore archive · Warcraft Wiki, 2023 dump
Widget API
Last wiki revision 2023-10-16
Widgets are graphical elements created in Lua with or via XML. Widget objects can be extended with templates, mixins and intrinsics. The user interface may be inspected with, and development addons like DevTool and Spew.
PlayerModel is officially documented as.
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 event as well as a subset of backwards-compatible methods for retrieving or populating tooltip contents from the new C_TooltipInfo APIs.
See also C_TooltipInfo
unique widget
These widget types have yet to be documented on the wiki. <!-- == UIObject ==
AnimationGroups (inherits from ParentedObject and ScriptObject, created with ) control how various animations are actually applied to a region.
- AnimationGroup:CreateAnimation( animationType, [name[,inheritsFrom]] ) - Create and return an Animation as a child of this group.
- AnimationGroup:Finish - Notify this group to stop playing once the current loop cycle is done. Does nothing if this group is not playing.
- AnimationGroup:GetAnimations
- AnimationGroup:GetDuration - Gets the total duration across all child Animations that the group will take to complete one loop cycle.
- AnimationGroup:GetLoopState - Gets the current loop state of the group. Output is [NONE, FORWARD, or REVERSE].
- AnimationGroup:GetLooping - Gets the type of looping for the group.
- AnimationGroup:GetProgress - Returns the progress of this animation as a unit value [0,1].
- AnimationGroup:IsDone - Returns true if the group has finished playing.
- AnimationGroup:IsPaused - Returns true if the group is paused.
- AnimationGroup:IsPendingFinish
- AnimationGroup:IsPlaying - Returns true if the group is playing.
- AnimationGroup:IsSetToFinalAlpha
- AnimationGroup:Pause - Pause the animations in this group.
- AnimationGroup:Play - Start playing the animations in this group.
- AnimationGroup:RemoveAnimations
- AnimationGroup:Restart
- AnimationGroup:SetLooping( loopType ) - Sets the type of looping for the group. Input is [NONE, REPEAT, or BOUNCE].
- AnimationGroup:SetPlaying( play )
- AnimationGroup:SetToFinalAlpha - Apply the animations final resulting alpha to all animating regions.
- AnimationGroup:Stop - Stop all animations in this group.
This animation changes the alpha value of its parent region.
Alpha has all the methods from Animation, plus the following:
- Alpha:GetFromAlpha - Gets the start value that the alpha of this animation's parent Region changes by.
- Alpha:GetToAlpha - Gets the end value that the alpha of this animation's parent Region changes by.
- Alpha:SetFromAlpha( fromAlpha ) - Sets the start value from which the alpha of this animation's parent Region changes by.
- Alpha:SetToAlpha( toAlpha ) - Sets the end value from which the alpha of this animation's parent Region changes by.
This is an affine transformation that scales a parent Region about an origin. The scale can be non-uniform.
Scale has all the methods from Animation, plus the following:
- Scale:GetFromScale - Gets the X scalar and the Y scalar that the animation will scale from if set.
- Scale:GetOrigin - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.
- Scale:GetScale - Gets the X scalar and the Y scalar that the animation's parent Region should scale by.
- Scale:GetToScale - Gets the X scalar and the Y scalar that the animation will scale to if set.
- Scale:SetFromScale( x, y ) - Sets the X scalar and the Y scalar that the animation will scale from.
- Scale:SetOrigin( point, offsetX, offsetY ) - Sets the animation's origin of rotation for its parent Region.
- Scale:SetScale( x, y ) - Sets the X scalar and the Y scalar that the animation's parent Region should scale by.
- Scale:SetToScale( x, y ) - Sets the X scalar and the Y scalar that the animation will scale to.
LineScale has the same methods as Scale.
This is an affine transformation that moves a parent Region by an offset. Translation has all the methods from Animation, plus the following:
- Translation:GetOffset - Gets the offset that the animation's parent Region would travel.
- Translation:SetOffset( x, y ) - Sets the offset that the animation's parent Region would travel.
LineTranslation has the same methods as Translation.
This is a set of translations, which lets you move a frame smoothly along a path.
Path has all the methods from Animation, plus the following:
- Path:CreateControlPoint( [name [, template [, order]]] ) - Creates a new control point.
- Path:GetControlPoints - Gets the control points of the Path.
- Path:GetCurve - Gets the current curve type.
- Path:GetMaxOrder - Gets the maximum order of the Path.
- Path:SetCurve( curveType ) - Sets the curve type, which can be "SMOOTH" or "NONE".
This is an affine transformation that rotates a parent Region about an origin.
Rotation has all the methods from Animation, plus the following:
- Rotation:GetDegrees - Gets the amount of degrees that the animation's parent Region would rotate.
- Rotation:GetOrigin - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.
- Rotation:GetRadians - Gets the amount of radians that the animation's parent Region would travel.
- Rotation:SetDegrees( degrees ) - Sets the amount of degrees that the animation's parent Region would rotate.
- Rotation:SetOrigin( point, offsetX, offsetY ) - Sets the animation's origin of rotation for its parent Region.
- Rotation:SetRadians( radians ) - Sets the amount of radians that the animation's parent Region would travel.
TextureCoordTranslation has all the methods from Animation but does not have any other methods.
ControlPoint can be created from Path:CreateControlPoint and has all the methods from UIObject, plus the following:
- ControlPoint:GetOffset
- ControlPoint:GetOrder
- ControlPoint:SetOffset
- ControlPoint:SetOrder( order )
- ControlPoint:SetParent
MaskTexture has the same methods as except the texture mask API. It is created from.
The Region methods regarding Points (SetAllPoints, SetPoint, etc.) and Size (SetSize, SetWidth, etc.) are not included in this widget, thus those attributes for a Line must be done solely through the below listed methods. Edge methods are still available. Line can be created from Frame:CreateLine and has almost all the methods from Texture, plus the following:
- Line:GetEndPoint - Gets the point at which the line ends.
- Line:GetStartPoint - Gets the point from where the line starts.
- Line:GetThickness - Gets this line's thickness.
- Line:SetEndPoint( relativePoint [,relativeFrame or relativeObject [, xOfs [, yOfs]]] ) - Sets the point at which the line ends.
- Line:SetStartPoint( relativePoint [,relativeFrame or relativeObject [, xOfs [, yOfs]]] ) - Sets the point from where the line starts.
- Line:SetThickness( thickness ) - Sets this line's thickness.
Browser has all the methods from Frame, plus the following:
- Browser:ClearFocus
- Browser:CopyExternalLink
- Browser:DeleteCookies
- Browser:NavigateBack
- Browser:NavigateForward
- Browser:NavigateHome( tag )
- Browser:NavigateReload
- Browser:NavigateStop
- Browser:OpenExternalLink
- Browser:OpenTicket( index )
- Browser:SetFocus
- Browser:SetZoom( zoom )
ItemButton is an intrinsic frame.
It has all the methods from Button and ItemButtonMixin.
Checkout has all the methods from Frame, plus the following:
- Checkout:CancelOpenCheckout
- Checkout:ClearFocus
- Checkout:CloseCheckout
- Checkout:CopyExternalLink
- Checkout:OpenCheckout
- Checkout:OpenExternalLink
- Checkout:SetFocus
- Checkout:SetZoom
- REMOVED (8.2.0) Checkout:ClearRenderSize
- REMOVED (8.2.0) Checkout:SetRenderSize
ColorSelect has all the methods from Frame, plus the following:
- ColorSelect:GetColorHSV - Get the HSV values of the selected color.
- ColorSelect:GetColorRGB - Get the RGB values of the selected color.
- ColorSelect:GetColorValueTexture - Get the texture used to show color value - new in 1.11.
- ColorSelect:GetColorValueThumbTexture - Get the texture for the color value thumb - New in 1.11.
- ColorSelect:GetColorWheelTexture - Get the texture for the color wheel - New in 1.11.
- ColorSelect:GetColorWheelThumbTexture - Get the texture for the color wheel thumb - New in 1.11.
- ColorSelect:SetColorHSV( h, s, v ) - Set to a specific HSV color.
- ColorSelect:SetColorRGB( r, g, b ) - Set to a specific RGB color.
- ColorSelect:SetColorValueTexture( texturebool ) - Set the texture used to show color value - New in 1.11.
- ColorSelect:SetColorValueThumbTexture( texturebool ) - Set the texture for the color value thumb - New in 1.11.
- ColorSelect:SetColorWheelTexture( texturebool ) - Set the texture for the color wheel - New in 1.11.
- ColorSelect:SetColorWheelThumbTexture( texturebool ) - Set the texture for the color wheel thumb - New in 1.11.
EditBox has all the methods from Frame and FontInstance, plus the following:
- EditBox:AddHistoryLine( text ) - Add text to the edit history.
- EditBox:ClearFocus
- EditBox:ClearHistory
- EditBox:ClearHighlightText
- EditBox:Disable
- EditBox:Enable
- EditBox:GetAltArrowKeyMode - Return whether only alt+arrow keys work for navigating the edit box, not arrow keys alone.
- EditBox:GetBlinkSpeed - Gets the blink speed of the EditBox in seconds - New in 1.11.
- EditBox:GetCursorPosition - Gets the position of the cursor inside the EditBox - New in 2.3.
- EditBox:GetDisplayText
- EditBox:GetHighlightColor
- EditBox:GetHistoryLines - Get the number of history lines for this edit box
- EditBox:GetInputLanguage - Get the input language (locale based not in-game)
- EditBox:GetMaxBytes - Gets the maximum number bytes allowed in the EditBox - New in 1.11.
- EditBox:GetMaxLetters - Gets the maximum number of letters allowed in the EditBox - New in 1.11.
- EditBox:GetNumLetters - Gets the number of letters in the box.
- EditBox:GetNumber
- EditBox:GetText - Get the current text contained in the edit box.
- EditBox:GetTextInsets - Gets the text display insets for the EditBox - New in 1.11.
- EditBox:GetUTF8CursorPosition
- EditBox:GetVisibleTextByteLimit
- EditBox:HasFocus - Returns whether the edit box is currently being edited (has edit focus).
- EditBox:HighlightText( [startPos, endPos] ) - Set the highlight to all or some of the edit box text.
- EditBox:Insert( text ) - Insert text into the edit box.
- EditBox:IsAutoFocus - Determine if the EditBox has autofocus enabled - New in 1.11.
- EditBox:IsCountInvisibleLetters
- EditBox:IsEnabled
- EditBox:IsInIMECompositionMode
- EditBox:IsMultiLine - Determine if the EditBox accepts multiple lines - New in 1.11.
- EditBox:IsNumeric - Determine if the EditBox only accepts numeric input - New in 1.11.
- EditBox:IsPassword - Determine if the EditBox performs password masking - New in 1.11.
- EditBox:IsSecureText
- EditBox:SetAltArrowKeyMode( enable ) - Make only alt+arrow keys work for navigating the edit box, not arrow keys alone.
- EditBox:SetAutoFocus( state ) - Set whether or not the editbox will attempt to get input focus when it gets shown (default: yes) - New in 1.11.
- EditBox:SetBlinkSpeed( speed )
- EditBox:SetCountInvisibleLetters( state ) - Sets if invisible characters should count towards max letter count.
- EditBox:SetCursorPosition( position ) - Set the position of the cursor within the EditBox - New in 2.3.
- EditBox:SetEnabled
- EditBox:SetFocus - Move input focus (the cursor) to this editbox
- EditBox:SetHighlightColor
- EditBox:SetHistoryLines(numLines) - Set the number of history lines to remember.
- EditBox:SetMaxBytes( maxBytes ) - Set the maximum byte size for entered text.
- EditBox:SetMaxLetters( maxLetters ) - Set the maximum number of letters for entered text.
- EditBox:SetMultiLine( state ) - Set the EditBox's multi-line state - New in 1.11.
- EditBox:SetNumber( number )
- EditBox:SetNumeric( state ) - Set if the EditBox only accepts numeric input - New in 1.11.
- EditBox:SetPassword( state ) - Set the EditBox's password masking state - New in 1.11.
- EditBox:SetSecureText
- EditBox:SetSecurityDisablePaste
- EditBox:SetSecurityDisableSetText
- EditBox:SetText( text ) - Set the text contained in the edit box.
- EditBox:SetTextInsets( l, r, t, b )
- EditBox:SetVisibleTextByteLimit( maxVisibleBytes )
- EditBox:ToggleInputLanguage
MessageFrame has all the methods from Frame and FontInstance, plus the following:
- MessageFrame:AddMessage( text, r, g, b, messageGroup, holdTime ) - Add a message to the frame which will fade eventually.
- MessageFrame:Clear - Clear the messages from the frame - New in 1.11.
- MessageFrame:GetFadeDuration - Gets the fade duration in seconds - New in 1.11.
- MessageFrame:GetFadePower
- MessageFrame:GetFading - Get whether the frame is fading - New in 1.11.
- MessageFrame:GetFontStringByID( messageID )
- MessageFrame:GetInsertMode - Get the insert mode for the frame - New in 1.11.
- MessageFrame:GetTimeVisible - Get the message visibility time in seconds - New in 1.11.
- MessageFrame:HasMessageByID
- MessageFrame:ResetMessageFadeByID( messageID )
- MessageFrame:SetFadeDuration( seconds ) - Set the fade duration - New in 1.11.
- MessageFrame:SetFadePower( power )
- MessageFrame:SetFading( status ) - Set whether the frame fades messages - New in 1.11.
- MessageFrame:SetInsertMode( TOP or BOTTOM ) - Set where new messages are inserted - New in 1.11.
- MessageFrame:SetTimeVisible( seconds ) - Sets the message visibility time - New in 1.11.
-->
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 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 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 can be created from ModelScene:CreateActor. It has the following methods: <!-- ===MovieFrame=== MovieFrame has all the methods from Frame, plus the following:
- 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 )
- MovieFrame:EnableSubtitles( enable ) - Enables or disables subtitles for movies played in the frame.
- MovieFrame:StartMovie( movieID [, loop] ) - Plays a specified movie in the frame
- MovieFrame:StopMovie( enable ) - Stops the movie currently playing in the frame
OffScreenFrame has all the methods from Frame, plus the following:
- OffScreenFrame:ApplySnapshot( texture, ID )
- OffScreenFrame:Flush
- OffScreenFrame:GetMaxSnapshots
- OffScreenFrame:IsSnapshotValid( ID )
- OffScreenFrame:SetMaxSnapshots( maxSnapshots )
- OffScreenFrame:TakeSnapshot
- OffScreenFrame:UsesNPOT
POIFrame is an abstract object type for points of interest on the map and has all the methods from Frame, plus the following:
- POIFrame:DrawAll
- POIFrame:DrawBlob
- POIFrame:DrawNone
- POIFrame:EnableMerging
- POIFrame:EnableSmoothing
- POIFrame:GetMapID
- POIFrame:SetBorderAlpha
- POIFrame:SetBorderScalar
- POIFrame:SetBorderTexture( [texture or fileDataID] )
- POIFrame:SetFillAlpha
- POIFrame:SetFillTexture
- POIFrame:SetMapID
- POIFrame:SetMergeThreshold
- POIFrame:SetNumSplinePoints
ArchaeologyDigSiteFrame has all the methods from POIFrame but does not have any other methods.
QuestPOIFrame has all the methods from POIFrame, plus the following:
- QuestPOIFrame:GetNumTooltips
- QuestPOIFrame:GetTooltipIndex
- QuestPOIFrame:UpdateMouseOverTooltip
ScenarioPOIFrame has all the methods from POIFrame, plus the following:
- ScenarioPOIFrame:GetScenarioTooltipText
- ScenarioPOIFrame:UpdateMouseOverTooltip
ScrollingMessageFrame is an intrinsic frame.
It has all the methods from Frame, FontInstance and ScrollingMessageFrameMixin.
SimpleHTML has all the methods from Frame and FontInstance, plus the following:
- SimpleHTML:GetContentHeight
- SimpleHTML:GetHyperlinkFormat - Set the string.format format to use for displaying hyperlinks - New in 1.11.
- SimpleHTML:GetTextData
- SimpleHTML:SetHyperlinkFormat( format ) - Set the string.format format to use for displaying hyperlinks.
- SimpleHTML:SetText( text ) - Set the HTML markup to be displayed (note: if there is any markup error, it will be displayed as plain text)
Slider has all the methods from Frame, plus the following:
- Slider:Disable - Disables the slider
- Slider:Enable - Enables the slider
- Slider:GetMinMaxValues - Get the current bounds of the slider.
- Slider:GetObeyStepOnDrag - Returns whether the slider constrains values to value steps when dragged.
- Slider:GetOrientation - Returns "HORIZONTAL" or "VERTICAL".
- Slider:GetStepsPerPage - Returns the number of steps the slider's value changes by when the slider is clicked.
- Slider:GetThumbTexture - Get the texture for this slider's thumb - New in 1.11.
- Slider:GetValue - Get the current value of the slider.
- Slider:GetValueStep - Get the current step size of the slider.
- Slider:IsDraggingThumb
- Slider:IsEnabled - Returns enabled status of the slider.
- Slider:SetEnabled
- Slider:SetMinMaxValues( min, max ) - Set the bounds of the slider.
- Slider:SetObeyStepOnDrag( obeyStep ) - Sets whether the slider constrains values to to value steps when dragged.
- Slider:SetOrientation( orientation ) - "HORIZONTAL" or "VERTICAL".
- Slider:SetStepsPerPage( steps ) - Controls slider behavior when the user clicks within the slider's tracking area.
- Slider:SetThumbTexture( texture or fileDataIDbool )
- Slider:SetValue( value ) - Set the value of the slider. Also causes the thumb to show on the first call.
- Slider:SetValueStep( value ) - Set the step size of the slider.
StatusBar has all the methods from Frame, plus the following:
- StatusBar:GetFillStyle
- StatusBar:GetMinMaxValues - Get the current bounds of the bar.
- StatusBar:GetOrientation
- StatusBar:GetReverseFill
- StatusBar:GetRotatesTexture
- StatusBar:GetStatusBarAtlas
- StatusBar:GetStatusBarColor
- StatusBar:GetStatusBarTexture - Returns the texture object for the bar - Before 1.11 it returned the filename.
- StatusBar:GetValue - Get the current value of the bar.
- StatusBar:SetFillStyle( style ) - Set the style in which the bar will be filled.
- StatusBar:SetMinMaxValues( min, max ) - Set the bounds of the bar.
- StatusBar:SetOrientation( orientation ) - "HORIZONTAL" or "VERTICAL".
- StatusBar:SetReverseFill( state ) - Sets the fill direction.
- StatusBar:SetRotatesTexture
- StatusBar:SetStatusBarAtlas( atlasName )
- StatusBar:SetStatusBarColor( r, g, b[, alpha] ) - Set the color of the bar.
- StatusBar:SetStatusBarTexture( texture or fileDataIDbool [, layer[, subLayer]] ) - Sets the texture of the bar - Added texture as valid arg in 1.11.
- StatusBar:SetValue( value ) - Set the value of the bar. -->
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 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
Categories
- Widgets
- Widget methods
Source
https://warcraft.wiki.gg/wiki/Widget_API · retrieved 2023-11-13 · CC BY-SA 4.0
Converted from wikitext with templates, tables and images removed, so some sentences may be missing values.
This archive predates WoW: Forever. For collected gameplay facts see the Forever database. Search the archive.