Wikia

WoWWiki

Changes: Widget API

Edit

Back to page

(Root Widgets)
m
 
(57 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{widget}}
+
__NOWYSIWYG__{{widget}}
This [[Widget API]] reference and the term [[Widget]] refer to the UIObject Lua API and the specific APIs of those Lua UIObjects found in WoW. This is a list of all of the '''Widget API''' UIObject specific functions found by scanning the in-game environment. You may also be interested in the various [[Widget handlers]] and [[XML UI]].
+
This [[Widget API]] reference, and the term [[Widget]], refer to the UIObject Lua API, and the specific APIs of the actual UIObjects found in WoW. This is a list of all of the '''Widget API''' UIObject specific functions found by scanning the in-game environment. You may also be interested in the various [[Widget handlers]] and [[XML UI]].
  +
  +
''Can click on each the secion heading for Lua class details''
   
 
== Root Widgets ==
 
== Root Widgets ==
   
 
=== [[UIOBJECT UIObject|UIObject]] ===
 
=== [[UIOBJECT UIObject|UIObject]] ===
This is an abstract UI object type which cannot actually be created. It's a base of all UI objects and gathers together some of common methods which have identical behaviours across all widget types.
+
This is an abstract UI object type which cannot actually be created. Is base type for ''all'' widget types.
See [[UIOBJECT UIObject|UIObject object information]] for details.
 
   
 
: [[API Object GetParent|Object:GetParent]]() - Moved from Region:GetParent(). This is essentially the same as the old version, except that you can no longer assume that your object has a Frame type in its hierarchy somewhere.
 
: [[API Object GetParent|Object:GetParent]]() - Moved from Region:GetParent(). This is essentially the same as the old version, except that you can no longer assume that your object has a Frame type in its hierarchy somewhere.
Line 11: Line 11:
 
: [[API UIObject GetName|UIObject:GetName]]() - Return the name of the object.
 
: [[API UIObject GetName|UIObject:GetName]]() - Return the name of the object.
 
: [[API UIObject GetObjectType|UIObject:GetObjectType]]() - Get the type of this object.
 
: [[API UIObject GetObjectType|UIObject:GetObjectType]]() - Get the type of this object.
  +
: [[API UIObject IsForbidden|UIObject:IsForbidden]]() - Return bool indicating is secure widget instance.
 
: [[API UIObject IsObjectType|UIObject:IsObjectType]]("type") - Determine if this object is of the specified type, or a subclass of that type.
 
: [[API UIObject IsObjectType|UIObject:IsObjectType]]("type") - Determine if this object is of the specified type, or a subclass of that type.
 
: [[API UIObject SetAlpha|UIObject:SetAlpha]](alpha) - Set the object's alpha (transparency) value.
 
: [[API UIObject SetAlpha|UIObject:SetAlpha]](alpha) - Set the object's alpha (transparency) value.
   
 
== UIObject Derivatives ==
 
== UIObject Derivatives ==
=== AnimationGroup ===
+
Have all of the methods from [[#UIObject|UIObject]], plus the following:
This manages playback, order, and looping of its child Animations. Animations in a group will play in ascending order according to their order fields (accessible via SetOrder and GetOrder). If two or more Animations have the same order value, then they will play simultaneously. The next animation will not play until all Animations with that order value are done. New in 3.1.0
+
  +
=== [[UIOBJECT AnimationGroup|AnimationGroup]] ===
  +
This manages playback, order, and looping of its child Animations. (added 3.1.0)
   
 
: [[API AnimationGroup Play|AnimationGroup:Play]]() - Start playing the animations in this group.
 
: [[API AnimationGroup Play|AnimationGroup:Play]]() - Start playing the animations in this group.
 
: [[API AnimationGroup Pause|AnimationGroup:Pause]]() - Pause the animations in this group.
 
: [[API AnimationGroup Pause|AnimationGroup:Pause]]() - Pause the animations in this group.
 
: [[API AnimationGroup Stop|AnimationGroup:Stop]]() - Stop all animations in this group.
 
: [[API AnimationGroup Stop|AnimationGroup:Stop]]() - Stop all animations in this group.
: [[API AnimationGroup Finish|AnimationGroup:Finish]]() - Notify this group to stop playing once the current loop cycle is done. Does nothing if this group is not playing.
+
: [[API AnimationGroup Finish|AnimationGroup:Finish]]() - Notify this group to stop playing once the current loop cycle is done.
 
: [[API AnimationGroup GetProgress|AnimationGroup:GetProgress]]() - Returns the progress of this animation as a unit value [0,1].
 
: [[API AnimationGroup GetProgress|AnimationGroup:GetProgress]]() - Returns the progress of this animation as a unit value [0,1].
 
: [[API AnimationGroup IsDone|AnimationGroup:IsDone]]() - Returns true if the group has finished playing.
 
: [[API AnimationGroup IsDone|AnimationGroup:IsDone]]() - Returns true if the group has finished playing.
 
: [[API AnimationGroup IsPlaying|AnimationGroup:IsPlaying]]() - Returns true if the group is playing.
 
: [[API AnimationGroup IsPlaying|AnimationGroup:IsPlaying]]() - Returns true if the group is playing.
 
: [[API AnimationGroup IsPaused|AnimationGroup:IsPaused]]() - Returns true if the group is paused.
 
: [[API AnimationGroup IsPaused|AnimationGroup:IsPaused]]() - Returns true if the group is paused.
: [[API AnimationGroup GetDuration|AnimationGroup:GetDuration]]() - Gets the total duration across all child Animations that the group will take to complete one loop cycle.
+
: [[API AnimationGroup GetDuration|AnimationGroup:GetDuration]]() - Gets the total duration for one loop cycle of all child Animations.
: [[API AnimationGroup SetLooping|AnimationGroup:SetLooping]](loopType) - Sets the type of looping for the group. Input is [NONE, REPEAT, or BOUNCE].
+
: [[API AnimationGroup SetLooping|AnimationGroup:SetLooping]](loopType) - Sets the group loop type [NONE, REPEAT, BOUNCE]
: [[API AnimationGroup GetLooping|AnimationGroup:GetLooping]]() - Gets the type of looping for the group.
+
: [[API AnimationGroup GetLooping|AnimationGroup:GetLooping]]() - Gets the group loop type.
: [[API AnimationGroup GetLoopState|AnimationGroup:GetLoopState]]() - Gets the current loop state of the group. Output is [NONE, FORWARD, or REVERSE].
+
: [[API AnimationGroup GetLoopState|AnimationGroup:GetLoopState]]() - Gets the current group loop state [NONE, FORWARD, REVERSE]
 
: [[API AnimationGroup CreateAnimation|AnimationGroup:CreateAnimation]]("animationType", ["name"[,"inheritsFrom"]]) - Create and return an Animation as a child of this group.
 
: [[API AnimationGroup CreateAnimation|AnimationGroup:CreateAnimation]]("animationType", ["name"[,"inheritsFrom"]]) - Create and return an Animation as a child of this group.
: [[API AnimationGroup HasScript|AnimationGroup:HasScript]]("handler") - Same as Frame:HasScript. Input is [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
+
: [[API AnimationGroup HasScript|AnimationGroup:HasScript]]("handler") - Same as Frame:HasScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
: [[API AnimationGroup GetScript|AnimationGroup:GetScript]]("handler") - Same as Frame:GetScript. Input is [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
+
: [[API AnimationGroup GetScript|AnimationGroup:GetScript]]("handler") - Same as Frame:GetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
: [[API AnimationGroup SetScript|AnimationGroup:SetScript]]("handler", function) - Same as Frame:SetScript. Input is [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
+
: [[API AnimationGroup SetScript|AnimationGroup:SetScript]]("handler", function) - Same as Frame:SetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
   
=== Animation ===
+
=== [[UIOBJECT Animation|Animation]] ===
+
Is the base animation type for animations in an AnimationGroup. (added 3.1.0)
This is a base animation type. This handles all animation timing and bookkeeping. An animation tag must always be parented by an AnimationGroup tag.
 
   
 
: [[API Animation Play|Animation:Play]]() - Play the animation.
 
: [[API Animation Play|Animation:Play]]() - Play the animation.
Line 47: Line 48:
 
: [[API Animation IsDelaying|Animation:IsDelaying]]() - Returns true if the animation is in the middle of a start or end delay.
 
: [[API Animation IsDelaying|Animation:IsDelaying]]() - Returns true if the animation is in the middle of a start or end delay.
 
: [[API Animation GetElapsed|Animation:GetElapsed]]() - Gets the amount of time in seconds that the animation has been playing for.
 
: [[API Animation GetElapsed|Animation:GetElapsed]]() - Gets the amount of time in seconds that the animation has been playing for.
: [[API Animation SetStartDelay|Animation:SetStartDelay]](delaySec) - Set the number of seconds that the animation delays before it starts to progress.
+
: [[API Animation SetStartDelay|Animation:SetStartDelay]](delaySec) - Set the seconds that the animation delays before it starts to progress.
: [[API Animation GetStartDelay|Animation:GetStartDelay]]() - Get the number of seconds that the animation delays before it starts to progress.
+
: [[API Animation GetStartDelay|Animation:GetStartDelay]]() - Get the seconds that the animation delays before it starts to progress.
 
: [[API Animation SetEndDelay|Animation:SetEndDelay]](delaySec) - Set the number of seconds the animation delays after finishing.
 
: [[API Animation SetEndDelay|Animation:SetEndDelay]](delaySec) - Set the number of seconds the animation delays after finishing.
 
: [[API Animation GetEndDelay|Animation:GetEndDelay]]() - Get the number of seconds the animation delays after finishing.
 
: [[API Animation GetEndDelay|Animation:GetEndDelay]]() - Get the number of seconds the animation delays after finishing.
: [[API Animation SetDuration|Animation:SetDuration]](durationSec) - Set the number of seconds it takes for the animation to progress from start to finish.
+
: [[API Animation SetDuration|Animation:SetDuration]](durationSec) - Set the seconds it takes for the animation to progress from start to finish.
: [[API Animation GetDuration|Animation:GetDuration]]() - Get the number of seconds it takes for the animation to progress from start to finish.
+
: [[API Animation GetDuration|Animation:GetDuration]]() - Get the seconds it takes for the animation to progress from start to finish.
 
: [[API Animation GetProgress|Animation:GetProgress]]() - Returns the progress of the animation as a unit value [0,1]. Ignores start and end delay.
 
: [[API Animation GetProgress|Animation:GetProgress]]() - Returns the progress of the animation as a unit value [0,1]. Ignores start and end delay.
 
: [[API Animation GetSmoothProgress|Animation:GetSmoothProgress]]() - Returns a smoothed, [0,1] progress value for the animation.
 
: [[API Animation GetSmoothProgress|Animation:GetSmoothProgress]]() - Returns a smoothed, [0,1] progress value for the animation.
 
: [[API Animation GetProgressWithDelay|Animation:GetProgressWithDelay]]() - Returns the progress of the animation combined with its start and end delay.
 
: [[API Animation GetProgressWithDelay|Animation:GetProgressWithDelay]]() - Returns the progress of the animation combined with its start and end delay.
: [[API Animation SetMaxFramerate|Animation:SetMaxFramerate]](framerate) - Sets the maximum frames per second that the animation will update its progress.
+
: [[API Animation SetMaxFramerate|Animation:SetMaxFramerate]](framerate) - Sets the maximum fps that the animation will update its progress.
: [[API Animation GetMaxFramerate|Animation:GetMaxFramerate]]() - Gets the maximum frames per second that the animation will update its progress.
+
: [[API Animation GetMaxFramerate|Animation:GetMaxFramerate]]() - Gets the maximum fps that the animation will update its progress.
 
: [[API Animation SetOrder|Animation:SetOrder]](order) - Sets the order that the animation plays within its parent group. Range is [1,100].
 
: [[API Animation SetOrder|Animation:SetOrder]](order) - Sets the order that the animation plays within its parent group. Range is [1,100].
 
: [[API Animation GetOrder|Animation:GetOrder]]() - Gets the order of the animation within its parent group.
 
: [[API Animation GetOrder|Animation:GetOrder]]() - Gets the order of the animation within its parent group.
: [[API Animation SetSmoothing|Animation:SetSmoothing]](smoothType) - Sets the smoothing type for the animation. Input is [IN,OUT,IN_OUT, or OUT_IN].
+
: [[API Animation SetSmoothing|Animation:SetSmoothing]](smoothType) - Sets the smoothing type for the animation [IN,OUT,IN_OUT,OUT_IN]
 
: [[API Animation GetSmoothing|Animation:GetSmoothing]]() - Gets the smoothing type for the animation.
 
: [[API Animation GetSmoothing|Animation:GetSmoothing]]() - Gets the smoothing type for the animation.
 
: [[API Animation SetParent|Animation:SetParent]](animGroup or "animGroupName") - Sets the parent for the animation. If the animation was not already a child of the parent, the parent will insert the animation into the proper order amongst its children.
 
: [[API Animation SetParent|Animation:SetParent]](animGroup or "animGroupName") - Sets the parent for the animation. If the animation was not already a child of the parent, the parent will insert the animation into the proper order amongst its children.
 
: [[API Animation GetRegionParent|Animation:GetRegionParent]]() - Gets the Region object that the animation operates on. The region object is this Animation's parent's parent (the AnimationGroup's parent).
 
: [[API Animation GetRegionParent|Animation:GetRegionParent]]() - Gets the Region object that the animation operates on. The region object is this Animation's parent's parent (the AnimationGroup's parent).
: [[API Animation HasScript|Animation:HasScript]]("handler") - Same as Frame:HasScript, Input is [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
+
: [[API Animation HasScript|Animation:HasScript]]("handler") - Same as Frame:HasScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]
: [[API Animation GetScript|Animation:GetScript]]("handler") - Same as Frame:GetScript, Input is [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
+
: [[API Animation GetScript|Animation:GetScript]]("handler") - Same as Frame:GetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]
: [[API Animation SetScript|Animation:SetScript]]("handler") - Same as Frame:SetScript, Input is [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
+
: [[API Animation SetScript|Animation:SetScript]]("handler") - Same as Frame:SetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]
 
=== FontInstance ===
 
This is another abstract object type that groups together a number of font related methods that are used by multiple other widget types. This doesn't have a direct correlation to a UI object. See [[UIOBJECT FontInstance|FontInstance object information]] for details.
 
   
FontInstance has all of the methods from [[#UIObject|UIObject]], plus the following:
+
=== [[UIOBJECT FontInstance|FontInstance]] ===
  +
This is an abstract object type that provides font related methods.
   
 
: [[API FontInstance GetFont|FontInstance:GetFont]]() - Return the font file, height, and flags.
 
: [[API FontInstance GetFont|FontInstance:GetFont]]() - Return the font file, height, and flags.
Line 87: Line 88:
 
: [[API FontInstance SetTextColor|FontInstance:SetTextColor]](r, g, b[, a]) - Sets the default text color.
 
: [[API FontInstance SetTextColor|FontInstance:SetTextColor]](r, g, b[, a]) - Sets the default text color.
   
=== Region ===
+
=== [[UIOBJECT Region|Region]] ===
This is an abstract object type which cannot actually be created. It gathers together a number of common methods which have identical behaviours across all widget types. This object contains a collection of methods that are related to the size, location and visibility of a widget. Note that it is not directly related to Frame:GetRegions() et al. See [[UIOBJECT Region|Region object information]] for details.
+
This is an abstract object type which cannot actually be created. Defines a potentially visible area.
 
Region has all of the methods from [[#UIObject|UIObject]], plus the following:
 
   
 
: [[API Region ClearAllPoints|Region:ClearAllPoints]]() - Clear all attachment points for this object.
 
: [[API Region ClearAllPoints|Region:ClearAllPoints]]() - Clear all attachment points for this object.
: [[API Region CreateAnimationGroup|Region:CreateAnimationGroup]](["name"[,"inheritsFrom"]]) - Create and return a new AnimationGroup as a child of this Region. - New in 3.1.0
+
: [[API Region CreateAnimationGroup|Region:CreateAnimationGroup]](["name"[,"inheritsFrom"]]) - Create and return a new AnimationGroup as a child of this Region. (added 3.1.0)
: [[API Region GetAnimationGroups|Region:GetAnimationGroups]]() - Returns all AnimationGroups that are children of this Region. - New in 3.1.0
+
: [[API Region GetAnimationGroups|Region:GetAnimationGroups]]() - Returns all AnimationGroups that are children of this Region. (added 3.1.0)
 
: [[API Region GetBottom|Region:GetBottom]]() - Get the y location of the bottom edge of this frame - Moved in 1.10.
 
: [[API Region GetBottom|Region:GetBottom]]() - Get the y location of the bottom edge of this frame - Moved in 1.10.
 
: [[API Region GetCenter|Region:GetCenter]]() - Get the coordinates of the center of this frame - Moved in 1.10.
 
: [[API Region GetCenter|Region:GetCenter]]() - Get the coordinates of the center of this frame - Moved in 1.10.
 
: [[API Region GetHeight|Region:GetHeight]]() - Get the height of this object.
 
: [[API Region GetHeight|Region:GetHeight]]() - Get the height of this object.
 
: [[API Region GetLeft|Region:GetLeft]]() - Get the x location of the left edge of this frame - Moved in 1.10.
 
: [[API Region GetLeft|Region:GetLeft]]() - Get the x location of the left edge of this frame - Moved in 1.10.
: [[API Region GetNumPoints|Region:GetNumPoints]]() - Get the number of anchor points for this frame - New in 1.10.
+
: [[API Region GetNumPoints|Region:GetNumPoints]]() - Get the number of anchor points for this frame (added 1.10)
: [[API Region GetPoint|Region:GetPoint]](pointNum) - Get details for an anchor point for this frame (point, relativeTo, relativePoint, xofs, yofs) - New in 1.10.
+
: [[API Region GetPoint|Region:GetPoint]](pointNum) - Get details for an anchor point for this frame (point, relativeTo, relativePoint, xofs, yofs) (added 1.10)
 
: [[API Region GetRect|Region:GetRect]]() - Get frame's left, bottom, width, height.
 
: [[API Region GetRect|Region:GetRect]]() - Get frame's left, bottom, width, height.
 
: [[API Region GetRight|Region:GetRight]]() - Get the x location of the right edge of this frame - Moved in 1.10.
 
: [[API Region GetRight|Region:GetRight]]() - Get the x location of the right edge of this frame - Moved in 1.10.
Line 105: Line 106:
 
: [[API Region GetWidth|Region:GetWidth]]() - Get the width of this object.
 
: [[API Region GetWidth|Region:GetWidth]]() - Get the width of this object.
 
: [[API Region Hide|Region:Hide]]() - Set this object to hidden (it and all of its children will disappear).
 
: [[API Region Hide|Region:Hide]]() - Set this object to hidden (it and all of its children will disappear).
: [[API Region IsDragging|Region:IsDragging]]() - True if this Region or its Parent is being dragged. - New in 3.1.0
+
: [[API Region IsDragging|Region:IsDragging]]() - True if this Region or its Parent is being dragged. (added 3.1.0)
 
: [[API Region IsProtected|Region:IsProtected]]() - Determine if this object can be manipulated in certain ways by tainted code in combat or not
 
: [[API Region IsProtected|Region:IsProtected]]() - Determine if this object can be manipulated in certain ways by tainted code in combat or not
 
: [[API Region IsShown|Region:IsShown]]() - Determine if this object is shown (would be visible if its parent was visible).
 
: [[API Region IsShown|Region:IsShown]]() - Determine if this object is shown (would be visible if its parent was visible).
Line 116: Line 117:
 
: [[API Region SetWidth|Region:SetWidth]](width) - Set the width of the object.
 
: [[API Region SetWidth|Region:SetWidth]](width) - Set the width of the object.
 
: [[API Region Show|Region:Show]]() - Set this object to shown (it will appear if its parent is visible).
 
: [[API Region Show|Region:Show]]() - Set this object to shown (it will appear if its parent is visible).
: [[API Region StopAnimating|Region:StopAnimating]]() - Stops any active animations on the Region and its children. - New in 3.1.0
+
: [[API Region StopAnimating|Region:StopAnimating]]() - Stops any active animations on the Region and its children. (added 3.1.0)
   
 
== Animation Derivatives ==
 
== Animation Derivatives ==
  +
Have all of the methods of [[#UIObject|UIObject]] and [[#Animation|Animation]], plus the following:
   
=== Translation ===
+
=== [[UIOBJECT Alpha|Alpha]] ===
  +
This animation changes the alpha value of its parent region.
   
This is an affine transformation that moves a parent Region by an offset. Translation has all of the methods of Animation, plus the following:
+
: [[API Alpha SetChange|Alpha:SetChange]](change) - Sets the amount that the alpha value of this animation's parent Region changes by.
  +
: [[API Alpha GetChange|Alpha:GetChange]]() - Gets the amount that the alpha value of this animation's parent Region changes by.
   
: [[API Translation SetOffset|Translation:SetOffset]](x, y) - Sets the offset that the animation's parent Region would travel.
+
=== [[UIOBJECT Path|Path]] ===
: [[API Translation GetOffset|Translation:GetOffset]]() - Gets the offset that the animation's parent Region would travel.
+
This animation combines multiple animation translations.
   
=== Rotation ===
+
: [[API Path CreateControlPoint|Path:CreateControlPoint]](["name" [, "template" [, order]]]) - Adds a new path control point.
  +
: [[API Path GetControlPoints|Path:GetControlPoints]]() - Returns an arg list of current path control points.
  +
: [[API Path GetCurve|Path:GetCurve]]() - Returns the path 'curveType'.
  +
: [[API Path GetMaxOrder|Path:GetMaxOrder]]() - Returns highest 'orderId' currently set for any of the control points .
  +
: [[API Path SetCurve|Path:SetCurve]]("curveType") - Sets the path 'curveType'.
   
This is an affine transformation that rotates a parent Region about an origin. Rotation has all of the methods of Animation, plus the following:
+
=== [[UIOBJECT Rotation|Rotation]] ===
  +
This is an affine transformation that rotates a parent Region about an origin.
   
 
: [[API Rotation SetDegrees|Rotation:SetDegrees]](degrees) - Sets the amount of degrees that the animation's parent Region would rotate.
 
: [[API Rotation SetDegrees|Rotation:SetDegrees]](degrees) - Sets the amount of degrees that the animation's parent Region would rotate.
Line 136: Line 138:
 
: [[API Rotation GetRadians|Rotation:GetRadians]]() - Gets the amount of radians that the animation's parent Region would travel.
 
: [[API Rotation GetRadians|Rotation:GetRadians]]() - Gets the amount of radians that the animation's parent Region would travel.
 
: [[API Rotation SetOrigin|Rotation:SetOrigin]](point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region.
 
: [[API Rotation SetOrigin|Rotation:SetOrigin]](point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region.
: [[API Rotation GetOrigin|Rotation:GetOrigin]]() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.
+
: [[API Rotation GetOrigin|Rotation:GetOrigin]]() - Gets the point, Xoffset, and Yoffset for animation's rotation origin in its parent Region.
   
=== Scale ===
+
=== [[UIOBJECT Scale|Scale]] ===
+
This is an affine transformation that scales a parent Region about an origin. The scale can be non-uniform.
This is an affine transformation that scales a parent Region about an origin. The scale can be non-uniform. Scale has all of the methods of Animation, plus the following:
 
   
 
: [[API Scale SetScale|Scale:SetScale]](x, y) - Sets the X scalar and the Y scalar that the animation's parent Region should scale by.
 
: [[API Scale SetScale|Scale:SetScale]](x, y) - Sets the X scalar and the Y scalar that the animation's parent Region should scale by.
Line 146: Line 148:
 
: [[API Scale GetOrigin|Scale:GetOrigin]]() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.
 
: [[API Scale GetOrigin|Scale:GetOrigin]]() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.
   
=== Alpha ===
+
=== [[UIOBJECT Translation|Translation]] ===
  +
This is an affine transformation that moves a parent [[#Region|Region]] by an offset.
   
This animation changes the alpha value of its parent region. Alpha has all of the methods of Animation plus the following:
+
: [[API Translation SetOffset|Translation:SetOffset]](x, y) - Sets the offset that the animation's parent Region would travel.
+
: [[API Translation GetOffset|Translation:GetOffset]]() - Gets the offset that the animation's parent Region would travel.
: [[API Alpha SetChange|Alpha:SetChange]](change) - Sets the amount that the alpha value of this animation's parent Region changes by.
 
: [[API Alpha GetChange|Alpha:GetChange]]() - Gets the amount that the alpha value of this animation's parent Region changes by.
 
   
 
== FontInstance Derivatives ==
 
== FontInstance Derivatives ==
=== Font ===
+
Have all of the methods from [[#UIObject|UIObject]] and [[#FontInstance|FontInstance]], plus the following:
This object was introduced in 1.10 to replace virtual FontStrings, it allows for dynamic inheritance of font template changes. The standard UI fonts such as GameFontNormal are now Font objects. See [[UIOBJECT Font|Font object information]] for details.
 
   
Font has all of the methods from [[#UIObject|UIObject]] and [[#FontInstance|FontInstance]], plus the following:
+
=== [[UIOBJECT Font|Font]] ===
  +
Allows base font information to be defined, rather than creating a full-blown [[#FontString|FontString]]. (added 1.10)
   
 
: [[API Font CopyFontObject|Font:CopyFontObject]](otherFont) - Set this Font's attributes to be a copy of the otherFont font object's.
 
: [[API Font CopyFontObject|Font:CopyFontObject]](otherFont) - Set this Font's attributes to be a copy of the otherFont font object's.
 
The following [[#Frame Derivatives|Frame Derivatives]] also inherit all of the functions of the [[#FontInstance|FontInstance]] type:
 
* [[#EditBox|EditBox]]
 
* [[#MessageFrame|MessageFrame]]
 
* [[#ScrollingMessageFrame|ScrollingMessageFrame]]
 
 
The following [[#LayeredRegion Derivatives|LayeredRegion Derivatives]] also inherit all of the functions of the [[#FontInstance|FontInstance]] type:
 
* [[#FontString|FontString]]
 
   
 
== Region Derivatives ==
 
== Region Derivatives ==
=== Frame ===
+
Have all of the methods from [[#UIObject|UIObject]] and [[#Region|Region]], plus the following:
See [[UIOBJECT Frame|Frame object information]] for details.
 
   
Frame has all of the methods from [[#UIObject|UIObject]] and [[#Region|Region]], plus the following:
+
=== [[UIOBJECT Frame|Frame]] ===
   
: [[API Frame CreateFontString|Frame:CreateFontString]](["name"[,"[[layer]]"[,"inheritsFrom"]]]) - Create and return a new FontString as a child of this Frame - Can instantiate virtuals in 1.11.
+
: [[API Frame CreateFontString|Frame:CreateFontString]](["name"[,"[[layer]]"[,"inheritsFrom"]]]) - Create and return FontString as a child of this Frame (added 'InheritsFrom' 1.11)
: [[API Frame CreateTexture|Frame:CreateTexture]](["name"[,"[[layer]]"]][,"inheritsFrom"]) - Create and return a new Texture as a child of this Frame. Good for solid colors. - Can instantiate virtuals in 1.11.
+
: [[API Frame CreateTexture|Frame:CreateTexture]](["name"[,"[[layer]]"]][,"inheritsFrom"]) - Create and return Texture as a child of this Frame. Good for solid colors. -  (added 'InheritsFrom' 1.11)
: [[API Frame CreateTitleRegion|Frame:CreateTitleRegion]]() - Create a title region for the frame if it does not have one. - New in 1.11
+
: [[API Frame CreateTitleRegion|Frame:CreateTitleRegion]]() - Create a title region for the frame if it does not have one. (added 1.11)
 
: [[API Frame DisableDrawLayer|Frame:DisableDrawLayer]]("[[layer]]") - Disable rendering of "regions" (fontstrings, textures) in the specified draw layer.
 
: [[API Frame DisableDrawLayer|Frame:DisableDrawLayer]]("[[layer]]") - Disable rendering of "regions" (fontstrings, textures) in the specified draw layer.
 
: [[API Frame EnableDrawLayer|Frame:EnableDrawLayer]]("[[layer]]") - Enable rendering of "regions" (fontstrings, textures) in the specified draw layer.
 
: [[API Frame EnableDrawLayer|Frame:EnableDrawLayer]]("[[layer]]") - Enable rendering of "regions" (fontstrings, textures) in the specified draw layer.
Line 180: Line 174:
 
: [[API Frame EnableMouseWheel|Frame:EnableMouseWheel]](enableFlag) - Set whether this frame will get mouse wheel notifications.
 
: [[API Frame EnableMouseWheel|Frame:EnableMouseWheel]](enableFlag) - Set whether this frame will get mouse wheel notifications.
 
: [[API Frame GetAttribute|Frame:GetAttribute]](prefix, name, suffix) - Returns the first existing attribute of (prefix..name..suffix), ("*"..name..suffix), (prefix..name.."*"), ("*"..name.."*"), (name).
 
: [[API Frame GetAttribute|Frame:GetAttribute]](prefix, name, suffix) - Returns the first existing attribute of (prefix..name..suffix), ("*"..name..suffix), (prefix..name.."*"), ("*"..name.."*"), (name).
: [[API Frame GetBackdrop|Frame:GetBackdrop]]() - Creates and returns a backdrop table suitable for use in SetBackdrop - New in 1.11.
+
: [[API Frame GetBackdrop|Frame:GetBackdrop]]() - Creates and returns a backdrop table suitable for use in SetBackdrop (added 1.11)
: [[API Frame GetBackdropBorderColor|Frame:GetBackdropBorderColor]]() - Gets the frame's backdrop border color (r, g, b, a)- New in 1.11.
+
: [[API Frame GetBackdropBorderColor|Frame:GetBackdropBorderColor]]() - Gets the frame's backdrop border color (r, g, b, a) (added 1.11)
: [[API Frame GetBackdropColor|Frame:GetBackdropColor]]() - Gets the frame's backdrop color (r, g, b, a)- New in 1.11.
+
: [[API Frame GetBackdropColor|Frame:GetBackdropColor]]() - Gets the frame's backdrop color (r, g, b, a) (added 1.11)
 
: [[API Frame GetChildren|Frame:GetChildren]]() - Get the list of "children" (frames and things derived from frames) of this frame.
 
: [[API Frame GetChildren|Frame:GetChildren]]() - Get the list of "children" (frames and things derived from frames) of this frame.
 
: [[API Frame GetClampRectInsets|Frame:GetClampRectInsets]]() - Gets the modifiers to the frame's rectangle used for clamping the frame to screen.
 
: [[API Frame GetClampRectInsets|Frame:GetClampRectInsets]]() - Gets the modifiers to the frame's rectangle used for clamping the frame to screen.
   
: [[API Frame GetDepth|Frame:GetDepth]]() - New in 3.0.8
+
: [[API Frame GetDepth|Frame:GetDepth]]() (added 3.0.8)
: [[API Frame GetEffectiveAlpha|Frame:GetEffectiveAlpha]]() - Returns the effective alpha of a frame. - Since 2.1.
+
: [[API Frame GetEffectiveAlpha|Frame:GetEffectiveAlpha]]() - Returns the effective alpha of a frame. (added 2.1)
: [[API Frame GetEffectiveDepth|Frame:GetEffectiveDepth]]() - New in 3.0.8
+
: [[API Frame GetEffectiveDepth|Frame:GetEffectiveDepth]]() (added 3.0.8)
 
: [[API Frame GetEffectiveScale|Frame:GetEffectiveScale]]() - Get the scale factor of this object relative to the root window.
 
: [[API Frame GetEffectiveScale|Frame:GetEffectiveScale]]() - Get the scale factor of this object relative to the root window.
 
: [[API Frame GetFrameLevel|Frame:GetFrameLevel]]() - Get the level of this frame.
 
: [[API Frame GetFrameLevel|Frame:GetFrameLevel]]() - Get the level of this frame.
 
: [[API Frame GetFrameStrata|Frame:GetFrameStrata]]() - Get the strata of this frame.
 
: [[API Frame GetFrameStrata|Frame:GetFrameStrata]]() - Get the strata of this frame.
 
: [[API Frame GetFrameType|Frame:GetFrameType]]() - Get the type of this frame.
 
: [[API Frame GetFrameType|Frame:GetFrameType]]() - Get the type of this frame.
: [[API Frame GetHitRectInsets|Frame:GetHitRectInsets]]() - Gets the frame's hit rectangle inset distances (l, r, t, b) - new in 1.11.
+
: [[API Frame GetHitRectInsets|Frame:GetHitRectInsets]]() - Gets the frame's hit rectangle inset distances (l, r, t, b) (added 1.11)
 
: [[API Frame GetID|Frame:GetID]]() - Get the ID of this frame.
 
: [[API Frame GetID|Frame:GetID]]() - Get the ID of this frame.
: [[API Frame GetMaxResize|Frame:GetMaxResize]]() - Gets the frame's maximum allowed resize bounds (w, h) - new in 1.11.
+
: [[API Frame GetMaxResize|Frame:GetMaxResize]]() - Gets the frame's maximum allowed resize bounds (w, h) (added 1.11)
: [[API Frame GetMinResize|Frame:GetMinResize]]() - Gets the frame's minimum allowed resize bounds (w, h) - new in 1.11.
+
: [[API Frame GetMinResize|Frame:GetMinResize]]() - Gets the frame's minimum allowed resize bounds (w, h) (added 1.11)
 
: [[API Frame GetNumChildren|Frame:GetNumChildren]]() - Get the number of "children" (frames and things derived from frames) this frame has.
 
: [[API Frame GetNumChildren|Frame:GetNumChildren]]() - Get the number of "children" (frames and things derived from frames) this frame has.
 
: [[API Frame GetNumRegions|Frame:GetNumRegions]]() - Return the number of "regions" (fontstrings, textures) belonging to this frame.
 
: [[API Frame GetNumRegions|Frame:GetNumRegions]]() - Return the number of "regions" (fontstrings, textures) belonging to this frame.
Line 202: Line 196:
 
: [[API Frame GetScale|Frame:GetScale]]() - Get the scale factor of this object relative to its parent.
 
: [[API Frame GetScale|Frame:GetScale]]() - Get the scale factor of this object relative to its parent.
 
: [[API Frame GetScript|Frame:GetScript]]("handler") - Get the function for one of this frame's handlers.
 
: [[API Frame GetScript|Frame:GetScript]]("handler") - Get the function for one of this frame's handlers.
: [[API Frame GetTitleRegion|Frame:GetTitleRegion]]() - Return the frame's title region - New in 1.11.
+
: [[API Frame GetTitleRegion|Frame:GetTitleRegion]]() - Return the frame's title region (added 1.11)
: [[API Frame HasScript|Frame:HasScript]]("handler") - Return true if the frame can be given a handler of the specified type (NOT whether it actually HAS one, use GetScript for that) - Since 1.8.
+
: [[API Frame HasScript|Frame:HasScript]]("handler") - Return true if the frame can be given a handler of the specified type (NOT whether it actually HAS one, use GetScript for that) (added 1.8)
 
: [[API Frame HookScript|Frame:HookScript]]("handler", function) - Hook a secure frame script. - Since 2.1.
 
: [[API Frame HookScript|Frame:HookScript]]("handler", function) - Hook a secure frame script. - Since 2.1.
: [[API Frame IgnoreDepth|Frame:IgnoreDepth]](ignoreFlag) - New in 3.0.8
+
: [[API Frame IgnoreDepth|Frame:IgnoreDepth]](ignoreFlag) (added 3.0.8)
: [[API Frame IsClampedToScreen|Frame:IsClampedToScreen]]() - Gets whether the frame is prohibited from being dragged off screen - New in 1.11.
+
: [[API Frame IsClampedToScreen|Frame:IsClampedToScreen]]() - Gets whether the frame is prohibited from being dragged off screen (added 1.11)
: [[API Frame IsEventRegistered|Frame:IsEventRegistered]]("event") - Returns true if the given event is registered to the frame. - New in 2.3
+
: [[API Frame IsEventRegistered|Frame:IsEventRegistered]]("event") - Returns true if the given event is registered to the frame. (added 2.3)
 
: [[API Frame IsFrameType|Frame:IsFrameType]]("type") - Determine if this frame is of the specified type, or a subclass of that type.
 
: [[API Frame IsFrameType|Frame:IsFrameType]]("type") - Determine if this frame is of the specified type, or a subclass of that type.
: [[API Frame IsIgnoringDepth|Frame:IsIgnoringDepth]]() - New in 3.0.8
+
: [[API Frame IsIgnoringDepth|Frame:IsIgnoringDepth]]() (added 3.0.8)
: [[API Frame IsKeyboardEnabled|Frame:IsKeyboardEnabled]]() - Get whether this frame will get keyboard input. - New in 1.11.
+
: [[API Frame IsKeyboardEnabled|Frame:IsKeyboardEnabled]]() - Get whether this frame will get keyboard input. (added 1.11)
: [[API Frame IsMouseEnabled|Frame:IsMouseEnabled]]() - Get whether this frame will get mouse input. - New in 1.11.
+
: [[API Frame IsMouseEnabled|Frame:IsMouseEnabled]]() - Get whether this frame will get mouse input. (added 1.11)
: [[API Frame IsMouseWheelEnabled|Frame:IsMouseWheelEnabled]]() - Get whether this frame will get mouse wheel notifications. New in 1.11.
+
: [[API Frame IsMouseWheelEnabled|Frame:IsMouseWheelEnabled]]() - Get whether this frame will get mouse wheel notifications. (added 1.11)
 
: [[API Frame IsMovable|Frame:IsMovable]]() - Determine if the frame can be moved.
 
: [[API Frame IsMovable|Frame:IsMovable]]() - Determine if the frame can be moved.
 
: [[API Frame IsResizable|Frame:IsResizable]]() - Determine if the frame can be resized.
 
: [[API Frame IsResizable|Frame:IsResizable]]() - Determine if the frame can be resized.
: [[API Frame IsToplevel|Frame:IsToplevel]]() - Get whether the frame is set as toplevel - New in 1.10.2.
+
: [[API Frame IsToplevel|Frame:IsToplevel]]() - Get whether the frame is set as toplevel (added 1.10.2)
 
: [[API Frame IsUserPlaced|Frame:IsUserPlaced]]() - Determine if this frame has been relocated by the user.
 
: [[API Frame IsUserPlaced|Frame:IsUserPlaced]]() - Determine if this frame has been relocated by the user.
 
: [[API Frame Lower|Frame:Lower]]() - Lower this frame behind other frames.
 
: [[API Frame Lower|Frame:Lower]]() - Lower this frame behind other frames.
 
: [[API Frame Raise|Frame:Raise]]() - Raise this frame above other frames.
 
: [[API Frame Raise|Frame:Raise]]() - Raise this frame above other frames.
: [[API Frame RegisterAllEvents|Frame:RegisterAllEvents]]() - Register this frame to receive all events (For debugging purposes only!) - New in 1.11.
+
: [[API Frame RegisterAllEvents|Frame:RegisterAllEvents]]() - Register this frame to receive all events (For debugging purposes only!) (added 1.11)
 
: [[API Frame RegisterEvent|Frame:RegisterEvent]]("event") - Indicate that this frame should be notified when event occurs.
 
: [[API Frame RegisterEvent|Frame:RegisterEvent]]("event") - Indicate that this frame should be notified when event occurs.
 
: [[API Frame RegisterForDrag|Frame:RegisterForDrag]]("buttonType"[,"buttonType"...]) - Inidicate that this frame should be notified of drag events for the specified buttons.
 
: [[API Frame RegisterForDrag|Frame:RegisterForDrag]]("buttonType"[,"buttonType"...]) - Inidicate that this frame should be notified of drag events for the specified buttons.
Line 225: Line 219:
 
: [[API Frame SetBackdropBorderColor|Frame:SetBackdropBorderColor]](r, g, b[, a]) - Set the frame's backdrop's border's color.
 
: [[API Frame SetBackdropBorderColor|Frame:SetBackdropBorderColor]](r, g, b[, a]) - Set the frame's backdrop's border's color.
 
: [[API Frame SetBackdropColor|Frame:SetBackdropColor]](r, g, b[, a]) - Set the frame's backdrop color.
 
: [[API Frame SetBackdropColor|Frame:SetBackdropColor]](r, g, b[, a]) - Set the frame's backdrop color.
: [[API Frame SetClampedToScreen|Frame:SetClampedToScreen]](clamped) - Set whether the frame is prohibited from being dragged off screen - New in 1.11.
+
: [[API Frame SetClampedToScreen|Frame:SetClampedToScreen]](clamped) - Set whether the frame is prohibited from being dragged off screen (added 1.11)
 
: [[API Frame SetClampRectInsets|Frame:SetClampRectInsets]](left, right, top, bottom) - Modify the frame's rectangle used to prevent dragging offscreen.
 
: [[API Frame SetClampRectInsets|Frame:SetClampRectInsets]](left, right, top, bottom) - Modify the frame's rectangle used to prevent dragging offscreen.
: [[API Frame SetDepth|Frame:SetDepth]](depth) - New in 3.0.8
+
: [[API Frame SetDepth|Frame:SetDepth]](depth) (added 3.0.8)
 
: [[API Frame SetFrameLevel|Frame:SetFrameLevel]](level) - Set the level of this frame (determines which of overlapping frames shows on top).
 
: [[API Frame SetFrameLevel|Frame:SetFrameLevel]](level) - Set the level of this frame (determines which of overlapping frames shows on top).
 
: [[API Frame SetFrameStrata|Frame:SetFrameStrata]]("strata") - Set the strata of this frame.
 
: [[API Frame SetFrameStrata|Frame:SetFrameStrata]]("strata") - Set the strata of this frame.
: [[API Frame SetHitRectInsets|Frame:SetHitRectInsets]](left, right, top, bottom) - Set the inset distances for the frame's hit rectangle - New in 1.11.
+
: [[API Frame SetHitRectInsets|Frame:SetHitRectInsets]](left, right, top, bottom) - Set the inset distances for the frame's hit rectangle (added 1.11)
 
: [[API Frame SetID|Frame:SetID]](id) - Set the ID of this frame.
 
: [[API Frame SetID|Frame:SetID]](id) - Set the ID of this frame.
 
: [[API Frame SetMaxResize|Frame:SetMaxResize]](maxWidth, maxHeight) - Set the maximum dimensions this frame can be resized to.
 
: [[API Frame SetMaxResize|Frame:SetMaxResize]](maxWidth, maxHeight) - Set the maximum dimensions this frame can be resized to.
Line 238: Line 232:
 
: [[API Frame SetScale|Frame:SetScale]](scale) - Set the scale factor of this frame relative to its parent.
 
: [[API Frame SetScale|Frame:SetScale]](scale) - Set the scale factor of this frame relative to its parent.
 
: [[API Frame SetScript|Frame:SetScript]]("handler", function) - Set the function to use for a handler on this frame.
 
: [[API Frame SetScript|Frame:SetScript]]("handler", function) - Set the function to use for a handler on this frame.
: [[API Frame SetToplevel|Frame:SetToplevel]](isTopLevel) - Set whether the frame should raise itself when clicked - New in 1.10.2.
+
: [[API Frame SetToplevel|Frame:SetToplevel]](isTopLevel) - Set whether the frame should raise itself when clicked (added 1.10.2)
: [[API Frame SetUserPlaced|Frame:SetUserPlaced]](isUserPlaced) - Set whether the frame has been relocated by the user (and will thus be saved in the layout cache).
+
: [[API Frame SetUserPlaced|Frame:SetUserPlaced]](isUserPlaced) - Set whether the frame has been relocated by the user, and will thus be saved in the layout cache.
 
: [[API Frame StartMoving|Frame:StartMoving]]() - Start moving this frame.
 
: [[API Frame StartMoving|Frame:StartMoving]]() - Start moving this frame.
 
: [[API Frame StartSizing|Frame:StartSizing]]("point") - Start sizing this frame using the specified anchor point.
 
: [[API Frame StartSizing|Frame:StartSizing]]("point") - Start sizing this frame using the specified anchor point.
Line 246: Line 240:
 
: [[API Frame UnregisterEvent|Frame:UnregisterEvent]]("event") - Indicate that this frame should no longer be notified when event occurs.
 
: [[API Frame UnregisterEvent|Frame:UnregisterEvent]]("event") - Indicate that this frame should no longer be notified when event occurs.
   
=== LayeredRegion ===
+
=== [[UIOBJECT LayeredRegion|LayeredRegion]] ===
Another abstract type, for objects that represent only a rendering process onto the screen, rather than a full blown frame.
+
An abstract type for objects that represent a potentially visible area defined in a layer.
(See [[UIOBJECT LayeredRegion|LayeredRegion object information]] for details) LayeredRegion has all of the methods from [[#UIObject|UIObject]] and [[#Region|Region]], plus the following:
 
   
: [[API LayeredRegion GetDrawLayer|LayeredRegion:GetDrawLayer]]() - Returns the [[Layer|draw layer]] for the Region - New in 1.10.
+
: [[API LayeredRegion GetDrawLayer|LayeredRegion:GetDrawLayer]]() - Returns the [[Layer|draw layer]] for the Region (added 1.10)
: [[API LayeredRegion SetDrawLayer|LayeredRegion:SetDrawLayer]]("layer") - Sets the [[Layer|draw layer]] for the Region - New in 1.10.
+
: [[API LayeredRegion SetDrawLayer|LayeredRegion:SetDrawLayer]]("layer") - Sets the [[Layer|draw layer]] for the Region (added 1.10)
 
: [[API LayeredRegion SetVertexColor|LayeredRegion:SetVertexColor]](r, g, b[, alpha])
 
: [[API LayeredRegion SetVertexColor|LayeredRegion:SetVertexColor]](r, g, b[, alpha])
   
 
== Frame Derivatives ==
 
== Frame Derivatives ==
=== Button ===
+
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
See [[UIOBJECT Button|Button object information]] for details.
 
   
Button has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
+
=== [[UIOBJECT Button|Button]] ===
   
 
: [[API Button Click|Button:Click]]() - Execute the click action of the button.
 
: [[API Button Click|Button:Click]]() - Execute the click action of the button.
Line 262: Line 256:
 
: [[API Button Enable|Button:Enable]]() - Enable to the Button so that it may be clicked.
 
: [[API Button Enable|Button:Enable]]() - Enable to the Button so that it may be clicked.
 
: [[API Button GetButtonState|Button:GetButtonState]]() - Return the current state ("PUSHED","NORMAL") of the Button.
 
: [[API Button GetButtonState|Button:GetButtonState]]() - Return the current state ("PUSHED","NORMAL") of the Button.
: [[API Button GetDisabledFontObject|Button:GetDisabledFontObject]]() - Return the font object for the Button when disabled - New in 1.10.
+
: [[API Button GetDisabledFontObject|Button:GetDisabledFontObject]]() - Return the font object for the Button when disabled (added 1.10)
: REMOVED [[API Button GetDisabledTextColor|Button:GetDisabledTextColor]]() - Get the color of this button's text when disabled (r, g, b, a) - New in 1.11. (removed 3.0.2)
+
: REMOVED [[API Button GetDisabledTextColor|Button:GetDisabledTextColor]]() - Get the color of this button's text when disabled (r, g, b, a) (added 1.11)(removed 3.0.2)
: [[API Button GetDisabledTexture|Button:GetDisabledTexture]]() - Get the texture for this button when disabled - New in 1.11.
+
: [[API Button GetDisabledTexture|Button:GetDisabledTexture]]() - Get the texture for this button when disabled (added 1.11)
 
: REMOVED [[API Button GetFont|Button:GetFont]]() - Returns the font, size, and flags currently used for display on the Button. (removed 3.0.2)
 
: REMOVED [[API Button GetFont|Button:GetFont]]() - Returns the font, size, and flags currently used for display on the Button. (removed 3.0.2)
: [[API Button GetFontString|Button:GetFontString]]() - Get this button's label FontString - New in 1.11.
+
: [[API Button GetFontString|Button:GetFontString]]() - Get this button's label FontString (added 1.11)
: [[API Button GetHighlightFontObject|Button:GetHighlightFontObject]]() - Return the font object for the Button when highlighted - New in 1.10.
+
: [[API Button GetHighlightFontObject|Button:GetHighlightFontObject]]() - Return the font object for the Button when highlighted (added 1.10)
: REMOVED [[API Button GetHighlightTextColor|Button:GetHighlightTextColor]]() - Get the color of this button's text when highlighted (r, g, b, a) - New in 1.11. (removed 3.0.2)
+
: REMOVED [[API Button GetHighlightTextColor|Button:GetHighlightTextColor]]() - Get the color of this button's text when highlighted (r, g, b, a) (added 1.11)(removed 3.0.2)
: [[API Button GetHighlightTexture|Button:GetHighlightTexture]]() - Get the texture for this button when highlighted - New in 1.11.
+
: [[API Button GetHighlightTexture|Button:GetHighlightTexture]]() - Get the texture for this button when highlighted (added 1.11)
: [[API Button GetNormalTexture|Button:GetNormalTexture]]() - Get the normal texture for this button - New in 1.11.
+
: [[API Button GetNormalTexture|Button:GetNormalTexture]]() - Get the normal texture for this button (added 1.11)
: [[API Button GetNormalFontObject|Button:GetNormalFontObject]]() - Get the Normal Font Object of the button - new in 3.0.0.
+
: [[API Button GetNormalFontObject|Button:GetNormalFontObject]]() - Get the Normal Font Object of the button (added 3.0.0)
: [[API Button GetPushedTextOffset|Button:GetPushedTextOffset]]() - Get the text offset when this button is pushed (x, y) - New in 1.11.
+
: [[API Button GetPushedTextOffset|Button:GetPushedTextOffset]]() - Get the text offset when this button is pushed (x, y) (added 1.11)
: [[API Button GetPushedTexture|Button:GetPushedTexture]]() - Get the texture for this button when pushed - New in 1.11.
+
: [[API Button GetPushedTexture|Button:GetPushedTexture]]() - Get the texture for this button when pushed (added 1.11)
 
: [[API Button GetText|Button:GetText]]() - Get the text label for the Button.
 
: [[API Button GetText|Button:GetText]]() - Get the text label for the Button.
: REMOVED [[API Button GetTextColor|Button:GetTextColor]]() - Get the normal color of this button's text (r, g, b, a) - New in 1.11. (removed 3.0.2)
+
: REMOVED [[API Button GetTextColor|Button:GetTextColor]]() - Get the normal color of this button's text (r, g, b, a) (added 1.11) (removed 3.0.2)
: REMOVED [[API Button GetTextFontObject|Button:GetTextFontObject]]() - Return the font object for the Button's normal text - New in 1.10. (removed 3.0.2)
+
: REMOVED [[API Button GetTextFontObject|Button:GetTextFontObject]]() - Return the font object for the Button's normal text (added 1.10)(removed 3.0.2)
 
: [[API Button GetTextHeight|Button:GetTextHeight]]() - Get the height of the Button's text.
 
: [[API Button GetTextHeight|Button:GetTextHeight]]() - Get the height of the Button's text.
 
: [[API Button GetTextWidth|Button:GetTextWidth]]() - Get the width of the Button's text.
 
: [[API Button GetTextWidth|Button:GetTextWidth]]() - Get the width of the Button's text.
 
: [[API Button IsEnabled|Button:IsEnabled]]() - Determine whether the Button is enabled.
 
: [[API Button IsEnabled|Button:IsEnabled]]() - Determine whether the Button is enabled.
 
: [[API Button LockHighlight|Button:LockHighlight]]() - Set the Button to always be drawn highlighted.
 
: [[API Button LockHighlight|Button:LockHighlight]]() - Set the Button to always be drawn highlighted.
: [[API Button RegisterForClicks|Button:RegisterForClicks]]("clickType"[,"clickType"...]) - Specify which mouse button up/down actions cause this button to receive an OnClick notification.
+
: [[API Button RegisterForClicks|Button:RegisterForClicks]]("clickType"[,"clickType"...]) - Specify which mouse button up/down actions cause receive an OnClick notification.
 
: [[API Button SetButtonState|Button:SetButtonState]]("state"[, lock]) - Set the state of the Button ("PUSHED", "NORMAL") and whether it is locked.
 
: [[API Button SetButtonState|Button:SetButtonState]]("state"[, lock]) - Set the state of the Button ("PUSHED", "NORMAL") and whether it is locked.
: [[API Button SetDisabledFontObject|Button:SetDisabledFontObject]]([font]) - Set the font object for settings when disabled - New in 1.10.
+
: [[API Button SetDisabledFontObject|Button:SetDisabledFontObject]]([font]) - Set the font object for settings when disabled (added 1.10)
 
: REMOVED [[API Button SetDisabledTextColor|Button:SetDisabledTextColor]](r, g, b[, a]) - Set the disabled text color for the Button. (removed 4.0.1)
 
: REMOVED [[API Button SetDisabledTextColor|Button:SetDisabledTextColor]](r, g, b[, a]) - Set the disabled text color for the Button. (removed 4.0.1)
: [[API Button SetDisabledTexture|Button:SetDisabledTexture]](texture or "texturePath") - Set the disabled texture for the Button - Updated in 1.10.
+
: [[API Button SetDisabledTexture|Button:SetDisabledTexture]](texture or "texturePath") - Set the disabled texture for the Button (updated in 1.10)
 
: [[API Button SetFont|Button:SetFont]]("font", size[,"flags"]) - Set the font to use for display.
 
: [[API Button SetFont|Button:SetFont]]("font", size[,"flags"]) - Set the font to use for display.
: [[API Button SetFontString|Button:SetFontString]](fontString) - Set the button's label FontString - New in 1.11.
+
: [[API Button SetFontString|Button:SetFontString]](fontString) - Set the button's label FontString (added 1.11)
: [[API Button SetFormattedText|Button:SetFormattedText]]("formatstring"[, ...]) - Set the formatted text label for the Button. - New in 2.3.
+
: [[API Button SetFormattedText|Button:SetFormattedText]]("formatstring"[, ...]) - Set the formatted text label for the Button. (added 2.3)
: [[API Button SetHighlightFontObject|Button:SetHighlightFontObject]]([font]) - Set the font object for settings when highlighted - New in 1.10.
+
: [[API Button SetHighlightFontObject|Button:SetHighlightFontObject]]([font]) - Set the font object for settings when highlighted (added 1.10)
 
: REMOVED [[API Button SetHighlightTextColor|Button:SetHighlightTextColor]](r, g, b[, a]) - Set the highlight text color for the Button. (removed 4.0.1)
 
: REMOVED [[API Button SetHighlightTextColor|Button:SetHighlightTextColor]](r, g, b[, a]) - Set the highlight text color for the Button. (removed 4.0.1)
: [[API Button SetHighlightTexture|Button:SetHighlightTexture]](texture or "texturePath"[,alphaMode]) - Set the highlight texture for the Button - Updated in 1.10.
+
: [[API Button SetHighlightTexture|Button:SetHighlightTexture]](texture or "texturePath"[,alphaMode]) - Set the highlight texture for the Button (updated in 1.10)
: [[API Button SetNormalTexture|Button:SetNormalTexture]](texture or "texturePath") - Set the normal texture for the Button - Updated in 1.10.
+
: [[API Button SetNormalTexture|Button:SetNormalTexture]](texture or "texturePath") - Set the normal texture for the Button (updated in 1.10)
: [[API Button SetNormalFontObject|Button:SetNormalFontObject]](FontString) - Replaces SetTextFontObject - Updated in 3.00
+
: [[API Button SetNormalFontObject|Button:SetNormalFontObject]](FontString) - Replaces SetTextFontObject (updated in 3.0)
: [[API Button SetPushedTextOffset|Button:SetPushedTextOffset]](x, y) - Set the text offset for this button when pushed - New in 1.11.
+
: [[API Button SetPushedTextOffset|Button:SetPushedTextOffset]](x, y) - Set the text offset for this button when pushed (added 1.11)
: [[API Button SetPushedTexture|Button:SetPushedTexture]](texture or "texturePath") - Set the pushed texture for the Button - Updated in 1.10.
+
: [[API Button SetPushedTexture|Button:SetPushedTexture]](texture or "texturePath") - Set the pushed texture for the Button (updated in 1.10)
 
: [[API Button SetText|Button:SetText]]("text") - Set the text label for the Button.
 
: [[API Button SetText|Button:SetText]]("text") - Set the text label for the Button.
 
: REMOVED [[API Button SetTextColor|Button:SetTextColor]](r, g, b) - Set the text color for the Button. (removed 3.0.2)
 
: REMOVED [[API Button SetTextColor|Button:SetTextColor]](r, g, b) - Set the text color for the Button. (removed 3.0.2)
: REMOVED [[API Button SetTextFontObject|Button:SetTextFontObject]]([font]) - Set the font object from which to get settings for this Button's normal state - New in 1.10. (removed 3.0.2)
+
: REMOVED [[API Button SetTextFontObject|Button:SetTextFontObject]]([font]) - Set the font object to get settings from for this Button's normal state (added 1.10)(removed 3.0.2)
 
: [[API Button UnlockHighlight|Button:UnlockHighlight]]() - Set the Button to not always be drawn highlighted.
 
: [[API Button UnlockHighlight|Button:UnlockHighlight]]() - Set the Button to not always be drawn highlighted.
   
=== Cooldown ===
+
=== [[UIOBJECT Cooldown|Cooldown]] ===
Cooldown has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
  +
: [[API Cooldown GetReverse|Cooldown:GetReverse]]() - returns true or false
 
: [[API Cooldown SetCooldown|Cooldown:SetCooldown]](Start, Duration)
 
: [[API Cooldown SetCooldown|Cooldown:SetCooldown]](Start, Duration)
 
: [[API Cooldown SetReverse|Cooldown:SetReverse]](boolean)
 
: [[API Cooldown SetReverse|Cooldown:SetReverse]](boolean)
   
=== ColorSelect ===
+
=== [[UIOBJECT ColorSelect|ColorSelect]] ===
See [[UIOBJECT ColorSelect|ColorSelect object information]] for details.
 
 
ColorSelect has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
 
: [[API ColorSelect GetColorHSV|ColorSelect:GetColorHSV]]() - Get the HSV values of the selected color.
 
: [[API ColorSelect GetColorHSV|ColorSelect:GetColorHSV]]() - Get the HSV values of the selected color.
 
: [[API ColorSelect GetColorRGB|ColorSelect:GetColorRGB]]() - Get the RGB values of the selected color.
 
: [[API ColorSelect GetColorRGB|ColorSelect:GetColorRGB]]() - Get the RGB values of the selected color.
: [[API ColorSelect GetColorValueTexture|ColorSelect:GetColorValueTexture]]() - Get the texture used to show color value - new in 1.11.
+
: [[API ColorSelect GetColorValueTexture|ColorSelect:GetColorValueTexture]]() - Get the texture used to show color value (added 1.11)
: [[API ColorSelect GetColorValueThumbTexture|ColorSelect:GetColorValueThumbTexture]]() - Get the texture for the color value thumb - New in 1.11.
+
: [[API ColorSelect GetColorValueThumbTexture|ColorSelect:GetColorValueThumbTexture]]() - Get the texture for the color value thumb (added 1.11)
: [[API ColorSelect GetColorWheelTexture|ColorSelect:GetColorWheelTexture]]() - Get the texture for the color wheel - New in 1.11.
+
: [[API ColorSelect GetColorWheelTexture|ColorSelect:GetColorWheelTexture]]() - Get the texture for the color wheel (added 1.11)
: [[API ColorSelect GetColorWheelThumbTexture|ColorSelect:GetColorWheelThumbTexture]]() - Get the texture for the color wheel thumb - New in 1.11.
+
: [[API ColorSelect GetColorWheelThumbTexture|ColorSelect:GetColorWheelThumbTexture]]() - Get the texture for the color wheel thumb (added 1.11)
 
: [[API ColorSelect SetColorHSV|ColorSelect:SetColorHSV]](h, s, v) - Set to a specific HSV color.
 
: [[API ColorSelect SetColorHSV|ColorSelect:SetColorHSV]](h, s, v) - Set to a specific HSV color.
 
: [[API ColorSelect SetColorRGB|ColorSelect:SetColorRGB]](r, g, b) - Set to a specific RGB color.
 
: [[API ColorSelect SetColorRGB|ColorSelect:SetColorRGB]](r, g, b) - Set to a specific RGB color.
: [[API ColorSelect SetColorValueTexture|ColorSelect:SetColorValueTexture]](texture or nil) - Set the texture used to show color value - New in 1.11.
+
: [[API ColorSelect SetColorValueTexture|ColorSelect:SetColorValueTexture]](texture or nil) - Set the texture used to show color value (added 1.11)
: [[API ColorSelect SetColorValueThumbTexture|ColorSelect:SetColorValueThumbTexture]](texture or "texture" or nil) - Set the texture for the color value thumb - New in 1.11.
+
: [[API ColorSelect SetColorValueThumbTexture|ColorSelect:SetColorValueThumbTexture]](texture or "texture" or nil) - Set the texture for the color value thumb (added 1.11)
: [[API ColorSelect SetColorWheelTexture|ColorSelect:SetColorWheelTexture]](texture or nil) - Set the texture for the color wheel - New in 1.11.
+
: [[API ColorSelect SetColorWheelTexture|ColorSelect:SetColorWheelTexture]](texture or nil) - Set the texture for the color wheel (added 1.11)
: [[API ColorSelect SetColorWheelThumbTexture|ColorSelect:SetColorWheelThumbTexture]](texture or "texture" or nil) - Set the texture for the color wheel thumb - New in 1.11.
+
: [[API ColorSelect SetColorWheelThumbTexture|ColorSelect:SetColorWheelThumbTexture]](texture or "texture" or nil) - Set the texture for the color wheel thumb (added 1.11)
   
=== EditBox ===
+
=== [[UIOBJECT EditBox|EditBox]] ===
See [[UIOBJECT EditBox|EditBox object information]] for details.
 
   
EditBox has all of the methods from [[#UIObject|UIObject]], [[#FontInstance|FontInstance]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
+
EditBox additionally has all of the methods from [[#FontInstance|FontInstance]], plus the following:
   
 
: [[API EditBox AddHistoryLine|EditBox:AddHistoryLine]]("text") - Add text to the edit history.
 
: [[API EditBox AddHistoryLine|EditBox:AddHistoryLine]]("text") - Add text to the edit history.
 
: [[API EditBox ClearFocus|EditBox:ClearFocus]]()
 
: [[API EditBox ClearFocus|EditBox:ClearFocus]]()
 
: [[API EditBox GetAltArrowKeyMode|EditBox:GetAltArrowKeyMode]]() - Return whether only alt+arrow keys work for navigating the edit box, not arrow keys alone.
 
: [[API EditBox GetAltArrowKeyMode|EditBox:GetAltArrowKeyMode]]() - Return whether only alt+arrow keys work for navigating the edit box, not arrow keys alone.
: [[API EditBox GetBlinkSpeed|EditBox:GetBlinkSpeed]]() - Gets the blink speed of the EditBox in seconds - New in 1.11.
+
: [[API EditBox GetBlinkSpeed|EditBox:GetBlinkSpeed]]() - Gets the blink speed of the EditBox in seconds (added 1.11)
: [[API EditBox GetCursorPosition|EditBox:GetCursorPosition]]() - Gets the position of the cursor inside the EditBox - New in 2.3.
+
: [[API EditBox GetCursorPosition|EditBox:GetCursorPosition]]() - Gets the position of the cursor inside the EditBox (added 2.3)
 
: [[API EditBox GetHistoryLines|EditBox:GetHistoryLines]]() - Get the number of history lines for this edit box
 
: [[API EditBox GetHistoryLines|EditBox:GetHistoryLines]]() - Get the number of history lines for this edit box
: [[API EditBox GetHyperlinksEnabled|EditBox:GetHyperlinksEnabled]]() - New in 3.0.8
+
: [[API EditBox GetHyperlinksEnabled|EditBox:GetHyperlinksEnabled]]() (added 3.0.8)
: [[API EditBox GetInputLanguage|EditBox:GetInputLanguage]]() - Get the input language (locale based not in-game)
+
: [[API EditBox GetInputLanguage|EditBox:GetInputLanguage]]() - Get the input language. locale based, not in-game.
: [[API EditBox GetMaxBytes|EditBox:GetMaxBytes]]() - Gets the maximum number bytes allowed in the EditBox - New in 1.11.
+
: [[API EditBox GetMaxBytes|EditBox:GetMaxBytes]]() - Gets the maximum number bytes allowed in the EditBox (added 1.11)
: [[API EditBox GetMaxLetters|EditBox:GetMaxLetters]]() - Gets the maximum number of letters allowed in the EditBox - New in 1.11.
+
: [[API EditBox GetMaxLetters|EditBox:GetMaxLetters]]() - Gets the maximum number of letters allowed in the EditBox (added 1.11)
 
: [[API EditBox GetNumLetters|EditBox:GetNumLetters]]() - Gets the number of letters in the box.
 
: [[API EditBox GetNumLetters|EditBox:GetNumLetters]]() - Gets the number of letters in the box.
 
: [[API EditBox GetNumber|EditBox:GetNumber]]()
 
: [[API EditBox GetNumber|EditBox:GetNumber]]()
 
: [[API EditBox GetText|EditBox:GetText]]() - Get the current text contained in the edit box.
 
: [[API EditBox GetText|EditBox:GetText]]() - Get the current text contained in the edit box.
: [[API EditBox GetTextInsets|EditBox:GetTextInsets]]() - Gets the text display insets for the EditBox - New in 1.11.
+
: [[API EditBox GetTextInsets|EditBox:GetTextInsets]]() - Gets the text display insets for the EditBox (added 1.11)
 
: [[API EditBox HighlightText|EditBox:HighlightText]]([startPos, endPos]) - Set the highlight to all or some of the edit box text.
 
: [[API EditBox HighlightText|EditBox:HighlightText]]([startPos, endPos]) - Set the highlight to all or some of the edit box text.
 
: [[API EditBox Insert|EditBox:Insert]]("text") - Insert text into the edit box.
 
: [[API EditBox Insert|EditBox:Insert]]("text") - Insert text into the edit box.
: [[API EditBox IsAutoFocus|EditBox:IsAutoFocus]]() - Determine if the EditBox has autofocus enabled - New in 1.11.
+
: [[API EditBox IsAutoFocus|EditBox:IsAutoFocus]]() - Determine if the EditBox has autofocus enabled (added 1.11)
: [[API EditBox IsMultiLine|EditBox:IsMultiLine]]() - Determine if the EditBox accepts multiple lines - New in 1.11.
+
: [[API EditBox IsMultiLine|EditBox:IsMultiLine]]() - Determine if the EditBox accepts multiple lines (added 1.11)
: [[API EditBox IsNumeric|EditBox:IsNumeric]]() - Determine if the EditBox only accepts numeric input - New in 1.11.
+
: [[API EditBox IsNumeric|EditBox:IsNumeric]]() - Determine if the EditBox only accepts numeric input (added 1.11)
: [[API EditBox IsPassword|EditBox:IsPassword]]() - Determine if the EditBox performs password masking - New in 1.11.
+
: [[API EditBox IsPassword|EditBox:IsPassword]]() - Determine if the EditBox performs password masking (added 1.11)
 
: [[API EditBox SetAltArrowKeyMode|EditBox:SetAltArrowKeyMode]](enable) - Make only alt+arrow keys work for navigating the edit box, not arrow keys alone.
 
: [[API EditBox SetAltArrowKeyMode|EditBox:SetAltArrowKeyMode]](enable) - Make only alt+arrow keys work for navigating the edit box, not arrow keys alone.
: [[API EditBox SetAutoFocus|EditBox:SetAutoFocus]](state) - Set whether or not the editbox will attempt to get input focus when it gets shown (default: true) - New in 1.11.
+
: [[API EditBox SetAutoFocus|EditBox:SetAutoFocus]](state) - Set whether or not the editbox will attempt to get input focus when it gets shown. default: true (added 1.11)
 
: [[API EditBox SetBlinkSpeed|EditBox:SetBlinkSpeed]]
 
: [[API EditBox SetBlinkSpeed|EditBox:SetBlinkSpeed]]
: [[API EditBox SetCursorPosition|EditBox:SetCursorPosition]](position) - Set the position of the cursor within the EditBox - New in 2.3.
+
: [[API EditBox SetCursorPosition|EditBox:SetCursorPosition]](position) - Set the position of the cursor within the EditBox (added 2.3)
 
: [[API EditBox SetFocus|EditBox:SetFocus]]() - Move input focus (the cursor) to this editbox
 
: [[API EditBox SetFocus|EditBox:SetFocus]]() - Move input focus (the cursor) to this editbox
 
: [[API EditBox SetFont|EditBox:SetFont]]("font", size[,"flags"]) - Set the font to use for display.
 
: [[API EditBox SetFont|EditBox:SetFont]]("font", size[,"flags"]) - Set the font to use for display.
 
: [[API EditBox SetHistoryLines|EditBox:SetHistoryLines]]() - Set the number of history lines to remember.
 
: [[API EditBox SetHistoryLines|EditBox:SetHistoryLines]]() - Set the number of history lines to remember.
: [[API EditBox SetHyperlinksEnabled|EditBox:SetHyperlinksEnabled]](enableFlag) - New in 3.0.8
+
: [[API EditBox SetHyperlinksEnabled|EditBox:SetHyperlinksEnabled]](enableFlag) (added 3.0.8)
 
: [[API EditBox SetMaxBytes|EditBox:SetMaxBytes]](maxBytes) - Set the maximum byte size for entered text.
 
: [[API EditBox SetMaxBytes|EditBox:SetMaxBytes]](maxBytes) - Set the maximum byte size for entered text.
 
: [[API EditBox SetMaxLetters|EditBox:SetMaxLetters]](maxLetters) - Set the maximum number of letters for entered text.
 
: [[API EditBox SetMaxLetters|EditBox:SetMaxLetters]](maxLetters) - Set the maximum number of letters for entered text.
: [[API EditBox SetMultiLine|EditBox:SetMultiLine]](state) - Set the EditBox's multi-line state - New in 1.11.
+
: [[API EditBox SetMultiLine|EditBox:SetMultiLine]](state) - Set the EditBox's multi-line state (added 1.11)
   
 
: [[API EditBox SetNumber|EditBox:SetNumber]](number)
 
: [[API EditBox SetNumber|EditBox:SetNumber]](number)
: [[API EditBox SetNumeric|EditBox:SetNumeric]](state) - Set if the EditBox only accepts numeric input - New in 1.11.
+
: [[API EditBox SetNumeric|EditBox:SetNumeric]](state) - Set if the EditBox only accepts numeric input (added 1.11)
: [[API EditBox SetPassword|EditBox:SetPassword]](state) - Set the EditBox's password masking state - New in 1.11.
+
: [[API EditBox SetPassword|EditBox:SetPassword]](state) - Set the EditBox's password masking state (added 1.11)
   
 
: [[API EditBox SetText|EditBox:SetText]]("text") - Set the text contained in the edit box.
 
: [[API EditBox SetText|EditBox:SetText]]("text") - Set the text contained in the edit box.
Line 365: Line 360:
 
: [[API EditBox ToggleInputLanguage|EditBox:ToggleInputLanguage]]()
 
: [[API EditBox ToggleInputLanguage|EditBox:ToggleInputLanguage]]()
   
=== GameTooltip ===
+
=== [[UIOBJECT GameTooltip|GameTooltip]] ===
The tooltip automatically resizes itself when its Show() method is called. See [[UIOBJECT GameTooltip|GameTooltip object information]] for details.
+
The tooltip automatically resizes itself when its Show() method is called.
 
GameTooltip has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
 
: [[API GameTooltip AddDoubleLine|GameTooltip:AddDoubleLine]](textL, textR, rL, gL, bL, rR, gR, bR)
 
: [[API GameTooltip AddDoubleLine|GameTooltip:AddDoubleLine]](textL, textR, rL, gL, bL, rR, gR, bR)
: [[API GameTooltip AddFontStrings|GameTooltip:AddFontStrings]](leftstring, rightstring) - Dynamically expands the size of a tooltip - New in 1.11.
+
: [[API GameTooltip AddFontStrings|GameTooltip:AddFontStrings]](leftstring, rightstring) - Dynamically expands the size of a tooltip (added 1.11)
 
: [[API GameTooltip AddLine|GameTooltip:AddLine]]("tooltipText" [, textColor.r, textColor.g, textColor.b [, wrapText]]) - Appends the new line to the tooltip.
 
: [[API GameTooltip AddLine|GameTooltip:AddLine]]("tooltipText" [, textColor.r, textColor.g, textColor.b [, wrapText]]) - Appends the new line to the tooltip.
 
: [[API GameTooltip AddTexture|GameTooltip:AddTexture]]("texture") - Add a texture to the last line added.
 
: [[API GameTooltip AddTexture|GameTooltip:AddTexture]]("texture") - Add a texture to the last line added.
Line 400: Line 395:
 
: [[API GameTooltip SetGuildBankItem|GameTooltip:SetGuildBankItem]](tab, id) - Shows the tooltip for the specified guild bank item
 
: [[API GameTooltip SetGuildBankItem|GameTooltip:SetGuildBankItem]](tab, id) - Shows the tooltip for the specified guild bank item
 
: [[API GameTooltip SetHyperlink|GameTooltip:SetHyperlink]]("itemString" or "itemLink") - Changes the item which is displayed in the tooltip according to the passed argument.
 
: [[API GameTooltip SetHyperlink|GameTooltip:SetHyperlink]]("itemString" or "itemLink") - Changes the item which is displayed in the tooltip according to the passed argument.
: [[API GameTooltip SetHyperlinkCompareItem|GameTooltip:SetHyperlinkCompareItem]]("itemLink", index) - Sets a comparison tooltip to show the index'th comparison item to the item specified as link. Will return a true value if there is an index'th comparison item (index is 1 through 3)
+
: [[API GameTooltip SetHyperlinkCompareItem|GameTooltip:SetHyperlinkCompareItem]]("itemLink", index) - Sets a comparison tooltip for the index. returns true if comparison. [index 1 .. 3]
 
: [[API GameTooltip SetInboxItem|GameTooltip:SetInboxItem]](index) - Shows the tooltip for the specified mail inbox item.
 
: [[API GameTooltip SetInboxItem|GameTooltip:SetInboxItem]](index) - Shows the tooltip for the specified mail inbox item.
 
: [[API GameTooltip SetInventoryItem|GameTooltip:SetInventoryItem]](unit, slot[, nameOnly])
 
: [[API GameTooltip SetInventoryItem|GameTooltip:SetInventoryItem]](unit, slot[, nameOnly])
Line 431: Line 426:
 
: [[API GameTooltip SetUnitDebuff|GameTooltip:SetUnitDebuff]]("[[unitId]]", buffIndex[, raidFilter]) - Shows the tooltip for a unit's debuff.
 
: [[API GameTooltip SetUnitDebuff|GameTooltip:SetUnitDebuff]]("[[unitId]]", buffIndex[, raidFilter]) - Shows the tooltip for a unit's debuff.
   
=== MessageFrame ===
+
=== [[UIOBJECT MessageFrame|MessageFrame]] ===
See [[UIOBJECT MessageFrame|MessageFrame object information]] for details.
+
MessageFrame additionally has all of the methods from [[#FontInstance|FontInstance]], plus the following:
 
MessageFrame has all of the methods from [[#UIObject|UIObject]], [[#FontInstance|FontInstance]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
 
: [[API MessageFrame AddMessage|MessageFrame:AddMessage]]("text", r, g, b, messageGroup, holdTime) - Add a message to the frame which will fade eventually.
 
: [[API MessageFrame AddMessage|MessageFrame:AddMessage]]("text", r, g, b, messageGroup, holdTime) - Add a message to the frame which will fade eventually.
: [[API MessageFrame Clear|MessageFrame:Clear]]() - Clear the messages from the frame - New in 1.11.
+
: [[API MessageFrame Clear|MessageFrame:Clear]]() - Clear the messages from the frame (added 1.11)
: [[API MessageFrame GetFadeDuration|MessageFrame:GetFadeDuration]]() - Gets the fade duration in seconds - New in 1.11.
+
: [[API MessageFrame GetFadeDuration|MessageFrame:GetFadeDuration]]() - Gets the fade duration in seconds (added 1.11)
: [[API MessageFrame GetFading|MessageFrame:GetFading]]() - Get whether the frame is fading - New in 1.11.
+
: [[API MessageFrame GetFading|MessageFrame:GetFading]]() - Get whether the frame is fading (added 1.11)
: [[API MessageFrame GetInsertMode|MessageFrame:GetInsertMode]]() - Get the insert mode for the frame - New in 1.11.
+
: [[API MessageFrame GetInsertMode|MessageFrame:GetInsertMode]]() - Get the insert mode for the frame (added 1.11)
: [[API MessageFrame GetTimeVisible|MessageFrame:GetTimeVisible]]() - Get the message visibility time in seconds - New in 1.11.
+
: [[API MessageFrame GetTimeVisible|MessageFrame:GetTimeVisible]]() - Get the message visibility time in seconds (added 1.11)
: [[API MessageFrame SetFadeDuration|MessageFrame:SetFadeDuration]](seconds) - Set the fade duration - New in 1.11.
+
: [[API MessageFrame SetFadeDuration|MessageFrame:SetFadeDuration]](seconds) - Set the fade duration (added 1.11)
: [[API MessageFrame SetFading|MessageFrame:SetFading]](status) - Set whether the frame fades messages - New in 1.11.
+
: [[API MessageFrame SetFading|MessageFrame:SetFading]](status) - Set whether the frame fades messages (added 1.11)
: [[API MessageFrame SetInsertMode|MessageFrame:SetInsertMode]]("TOP" or "BOTTOM") - Set where new messages are inserted - New in 1.11.
+
: [[API MessageFrame SetInsertMode|MessageFrame:SetInsertMode]]("TOP" or "BOTTOM") - Set where new messages are inserted (added 1.11)
: [[API MessageFrame SetTimeVisible|MessageFrame:SetTimeVisible]](seconds) - Sets the message visibility time - New in 1.11.
+
: [[API MessageFrame SetTimeVisible|MessageFrame:SetTimeVisible]](seconds) - Sets the message visibility time (added 1.11)
 
=== Minimap ===
 
See [[UIOBJECT Minimap|Minimap object information]] for details
 
* Note: Tracking dots malfunction if you have multiple instances of this widget that are different sizes/zooms.
 
* Note: (Mac OS X only) Modifying the Minimap opacity via SetAlpha() will make it turn black indoors.
 
   
Minimap has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
+
=== [[UIOBJECT Minimap|Minimap]] ===
   
 
: [[API Minimap GetPingPosition|Minimap:GetPingPosition]]() - Get the last ping location.
 
: [[API Minimap GetPingPosition|Minimap:GetPingPosition]]() - Get the last ping location.
Line 451: Line 446:
 
: [[API Minimap GetZoomLevels|Minimap:GetZoomLevels]]() - Get the maximum zoom level.
 
: [[API Minimap GetZoomLevels|Minimap:GetZoomLevels]]() - Get the maximum zoom level.
 
: [[API Minimap PingLocation|Minimap:PingLocation]](x, y) - Perform a ping at the specified location. As of 2.4.2 protected while targeting area of effect spells.
 
: [[API Minimap PingLocation|Minimap:PingLocation]](x, y) - Perform a ping at the specified location. As of 2.4.2 protected while targeting area of effect spells.
: [[API Minimap SetArrowModel|Minimap:SetArrowModel]]("file") - Set the file to use for the arrow model - New in 1.11.
+
: [[API Minimap SetArrowModel|Minimap:SetArrowModel]]("file") - Set the file to use for the arrow model (added 1.11)
 
: [[API Minimap SetBlipTexture|Minimap:SetBlipTexture]] - Set the file to use for blips (ObjectIcons)
 
: [[API Minimap SetBlipTexture|Minimap:SetBlipTexture]] - Set the file to use for blips (ObjectIcons)
 
: [[API Minimap SetIconTexture|Minimap:SetIconTexture]]
 
: [[API Minimap SetIconTexture|Minimap:SetIconTexture]]
 
: [[API Minimap SetMaskTexture|Minimap:SetMaskTexture]]
 
: [[API Minimap SetMaskTexture|Minimap:SetMaskTexture]]
: [[API Minimap SetPlayerModel|Minimap:SetPlayerModel]]("file") - Set the file to use for the player model - New in 1.11.
+
: [[API Minimap SetPlayerModel|Minimap:SetPlayerModel]]("file") - Set the file to use for the player model (added 1.11)
 
: [[API Minimap SetZoom|Minimap:SetZoom]](level) - Set the current zoom level.
 
: [[API Minimap SetZoom|Minimap:SetZoom]](level) - Set the current zoom level.
   
=== Model ===
+
=== [[UIOBJECT Model|Model]] ===
Used to display real 3D-mesh geometry as part of the UI. See [[UIOBJECT Model|Model object information]] for details.
+
Used to display real 3D-mesh geometry as part of the UI.
 
Model has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
 
: [[API Model AdvanceTime|Model:AdvanceTime]]()
 
: [[API Model AdvanceTime|Model:AdvanceTime]]()
 
: [[API Model ClearFog|Model:ClearFog]]() - Removes all fogging effects currently active in rendering.
 
: [[API Model ClearFog|Model:ClearFog]]() - Removes all fogging effects currently active in rendering.
: [[API Model ClearModel|Model:ClearModel]]() - Removes all geometry from the Model (i.e. makes it empty)
+
: [[API Model ClearModel|Model:ClearModel]]() - Removes all geometry from the Model, i.e. makes it empty.
 
: [[API Model GetFacing|Model:GetFacing]]() - Returns the direction the model is facing.
 
: [[API Model GetFacing|Model:GetFacing]]() - Returns the direction the model is facing.
: [[API Model GetFogColor|Model:GetFogColor]]() - Gets the fog color (r, g, b, a) - New in 1.11.
+
: [[API Model GetFogColor|Model:GetFogColor]]() - Gets the fog color as r,g,b,a. (added 1.11)
: [[API Model GetFogFar|Model:GetFogFar]]() - Gets the fog far distance - New in 1.11.
+
: [[API Model GetFogFar|Model:GetFogFar]]() - Gets the fog far distance (added 1.11)
: [[API Model GetFogNear|Model:GetFogNear]]() - Gets the fog near distance - New in 1.11.
+
: [[API Model GetFogNear|Model:GetFogNear]]() - Gets the fog near distance (added 1.11)
: [[API Model GetLight|Model:GetLight]]() - Gets the light specification for the model, returns a list of results compatible with the SetLight method - New in 1.11.
+
: [[API Model GetLight|Model:GetLight]]() - Gets the light spec for the model, returns a arg list compatible with SetLight (added 1.11)
: [[API Model GetModel|Model:GetModel]]() - Gets the model file for this Model - New in 1.11.
+
: [[API Model GetModel|Model:GetModel]]() - Gets the model file for this Model (added 1.11)
 
: [[API Model GetModelScale|Model:GetModelScale]]() - Returns the current mesh scaling factor.
 
: [[API Model GetModelScale|Model:GetModelScale]]() - Returns the current mesh scaling factor.
 
: [[API Model GetPosition|Model:GetPosition]]() - Returns the current position of the mesh as x, y, z
 
: [[API Model GetPosition|Model:GetPosition]]() - Returns the current position of the mesh as x, y, z
Line 478: Line 473:
 
: [[API Model SetFogFar|Model:SetFogFar]](value) - Set the far-clipping plane distance for fogging.
 
: [[API Model SetFogFar|Model:SetFogFar]](value) - Set the far-clipping plane distance for fogging.
 
: [[API Model SetFogNear|Model:SetFogNear]](value) - Set the near-clipping plane distance for fogging.
 
: [[API Model SetFogNear|Model:SetFogNear]](value) - Set the near-clipping plane distance for fogging.
: [[API Model SetGlow|Model:SetGlow]](...) -
+
: [[API Model SetGlow|Model:SetGlow]](..) -
+
: [[API Model SetLight|Model:SetLight]](enabled[, omni, dirX, dirY, dirZ, ambIntensity[, ambR, ambG, ambB[, dirIntensity[, dirR, dirG, dirB]]]]) - place light source
: [[API Model SetLight|Model:SetLight]](enabled[, omni, dirX, dirY, dirZ, ambIntensity[, ambR, ambG, ambB[, dirIntensity[, dirR, dirG, dirB]]]]) - Place the light source used for rendering
 
 
: [[API Model SetModel|Model:SetModel]]("file") - Set the mesh that is displayed in the frame.
 
: [[API Model SetModel|Model:SetModel]]("file") - Set the mesh that is displayed in the frame.
 
: [[API Model SetModelScale|Model:SetModelScale]](scale) - Sets the scale factor for the mesh before rendering.
 
: [[API Model SetModelScale|Model:SetModelScale]](scale) - Sets the scale factor for the mesh before rendering.
Line 486: Line 481:
 
: [[API Model SetSequenceTime|Model:SetSequenceTime]](sequence, time)
 
: [[API Model SetSequenceTime|Model:SetSequenceTime]](sequence, time)
   
=== ScrollFrame ===
+
=== [[UIOBJECT ScrollFrame|ScrollFrame]] ===
See [[UIOBJECT ScrollFrame|ScrollFrame object information]] for details.
 
 
ScrollFrame has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
 
: [[API ScrollFrame GetHorizontalScroll|ScrollFrame:GetHorizontalScroll]]()
 
: [[API ScrollFrame GetHorizontalScroll|ScrollFrame:GetHorizontalScroll]]()
Line 498: Line 493:
 
: [[API ScrollFrame UpdateScrollChildRect|ScrollFrame:UpdateScrollChildRect]]() - no longer required after patch 2.3
 
: [[API ScrollFrame UpdateScrollChildRect|ScrollFrame:UpdateScrollChildRect]]() - no longer required after patch 2.3
   
=== ScrollingMessageFrame ===
+
=== [[UIOBJECT ScrollingMessageFrame|ScrollingMessageFrame]] ===
See [[UIOBJECT ScrollingMessageFrame|ScrollingMessageFrame object information]] for details.
+
ScrollingMessageFrame additionally has all of the methods from [[#FontInstance|FontInstance]], plus the following:
 
ScrollingMessageFrame has all of the methods from [[#UIObject|UIObject]], [[#FontInstance|FontInstance]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
: [[API ScrollingMessageFrame AddMessage|ScrollingMessageFrame:AddMessage]]("text"[, r, g, b[, id][, addToStart]]) - Add a message to the frame, with an optional color ID.- Updated in 2.4.2
+
: [[API ScrollingMessageFrame AddMessage|ScrollingMessageFrame:AddMessage]]("text"[, r, g, b[, id][, addToStart]]) - Add a message to the frame with an optional color, ID (updated 2.4.2)
 
: [[API ScrollingMessageFrame AtBottom|ScrollingMessageFrame:AtBottom]]() - Test whether frame is at the bottom.
 
: [[API ScrollingMessageFrame AtBottom|ScrollingMessageFrame:AtBottom]]() - Test whether frame is at the bottom.
: [[API ScrollingMessageFrame AtTop|ScrollingMessageFrame:AtTop]]() - Test whether frame is at the top - New in 1.11.
+
: [[API ScrollingMessageFrame AtTop|ScrollingMessageFrame:AtTop]]() - Test whether frame is at the top (added 1.11)
 
: [[API ScrollingMessageFrame Clear|ScrollingMessageFrame:Clear]]() - Clear all lines from the frame.
 
: [[API ScrollingMessageFrame Clear|ScrollingMessageFrame:Clear]]() - Clear all lines from the frame.
 
: [[API ScrollingMessageFrame GetCurrentLine|ScrollingMessageFrame:GetCurrentLine]]() - Returns the line number that was printed last, starting from 0.
 
: [[API ScrollingMessageFrame GetCurrentLine|ScrollingMessageFrame:GetCurrentLine]]() - Returns the line number that was printed last, starting from 0.
: [[API ScrollingMessageFrame GetCurrentScroll|ScrollingMessageFrame:GetCurrentScroll]]() -- Returns the amount of messages from the end message (GetNumMessages()) that the user has scrolled.
+
: [[API ScrollingMessageFrame GetCurrentScroll|ScrollingMessageFrame:GetCurrentScroll]]() -- Returns number of messages from the end message, that the user has scrolled.
 
: [[API ScrollingMessageFrame GetFadeDuration|ScrollingMessageFrame:GetFadeDuration]]()
 
: [[API ScrollingMessageFrame GetFadeDuration|ScrollingMessageFrame:GetFadeDuration]]()
 
: [[API ScrollingMessageFrame GetFading|ScrollingMessageFrame:GetFading]]()
 
: [[API ScrollingMessageFrame GetFading|ScrollingMessageFrame:GetFading]]()
: [[API ScrollingMessageFrame GetHyperlinksEnabled|ScrollingMessageFrame:GetHyperlinksEnabled]]() - New in 3.0.8
+
: [[API ScrollingMessageFrame GetHyperlinksEnabled|ScrollingMessageFrame:GetHyperlinksEnabled]]() (added 3.0.8)
: [[API ScrollingMessageFrame GetInsertMode|ScrollingMessageFrame:GetInsertMode]]() - Gets the current insert mode for a frame. - New in 2.3.
+
: [[API ScrollingMessageFrame GetInsertMode|ScrollingMessageFrame:GetInsertMode]]() - Gets the current insert mode for a frame. (added 2.3)
 
: [[API ScrollingMessageFrame GetMaxLines|ScrollingMessageFrame:GetMaxLines]]() - Get the maximum number of lines the frame can display.
 
: [[API ScrollingMessageFrame GetMaxLines|ScrollingMessageFrame:GetMaxLines]]() - Get the maximum number of lines the frame can display.
 
: [[API ScrollingMessageFrame GetNumLinesDisplayed|ScrollingMessageFrame:GetNumLinesDisplayed]]()
 
: [[API ScrollingMessageFrame GetNumLinesDisplayed|ScrollingMessageFrame:GetNumLinesDisplayed]]()
Line 522: Line 517:
 
: [[API ScrollingMessageFrame ScrollUp|ScrollingMessageFrame:ScrollUp]]()
 
: [[API ScrollingMessageFrame ScrollUp|ScrollingMessageFrame:ScrollUp]]()
 
: [[API ScrollingMessageFrame SetFadeDuration|ScrollingMessageFrame:SetFadeDuration]](seconds) - Set the fade duration.
 
: [[API ScrollingMessageFrame SetFadeDuration|ScrollingMessageFrame:SetFadeDuration]](seconds) - Set the fade duration.
: [[API ScrollingMessageFrame SetFading|ScrollingMessageFrame:SetFading]]([isEnabled]) - Set whether fading is enabled - Renamed in 1.11.
+
: [[API ScrollingMessageFrame SetFading|ScrollingMessageFrame:SetFading]]([isEnabled]) - Set whether fading is enabled (renamed 1.11)
: [[API ScrollingMessageFrame SetHyperlinksEnabled|ScrollingMessageFrame:SetHyperlinksEnabled]](enableFlag) - New in 3.0.8
+
: [[API ScrollingMessageFrame SetHyperlinksEnabled|ScrollingMessageFrame:SetHyperlinksEnabled]](enableFlag) (added 3.0.8)
: [[API ScrollingMessageFrame SetInsertMode|ScrollingMessageFrame:SetInsertMode]]("mode") - Sets the location into which new strings are added to the frame, mode is one of "TOP" or "BOTTOM". - New in 2.3.
+
: [[API ScrollingMessageFrame SetInsertMode|ScrollingMessageFrame:SetInsertMode]]("mode") - Sets the location for new strings added to the frame ["TOP", "BOTTOM"] (added 2.3)
: [[API ScrollingMessageFrame SetMaxLines|ScrollingMessageFrame:SetMaxLines]](lines) - Set the maximum number of displayed lines. Tested successfully with values up to a million. Resets the messages already within the frame.
+
: [[API ScrollingMessageFrame SetMaxLines|ScrollingMessageFrame:SetMaxLines]](lines) - Set the maximum number of history lines, and resets the messages already within the frame.
: [[API ScrollingMessageFrame SetScrollOffset|ScrollingMessageFrame:SetScrollOffset]](offset) - Renamed in 2.3.
+
: [[API ScrollingMessageFrame SetScrollOffset|ScrollingMessageFrame:SetScrollOffset]](offset) (renamed 2.3)
 
: [[API ScrollingMessageFrame SetTimeVisible|ScrollingMessageFrame:SetTimeVisible]](seconds) - Sets how long lines remain visible.
 
: [[API ScrollingMessageFrame SetTimeVisible|ScrollingMessageFrame:SetTimeVisible]](seconds) - Sets how long lines remain visible.
 
: [[API ScrollingMessageFrame UpdateColorByID|ScrollingMessageFrame:UpdateColorByID]](id, r, g, b)
 
: [[API ScrollingMessageFrame UpdateColorByID|ScrollingMessageFrame:UpdateColorByID]](id, r, g, b)
   
=== SimpleHTML ===
+
=== [[UIOBJECT SimpleHTML|SimpleHTML]] ===
See [[UIOBJECT SimpleHTML|SimpleHTML object information]] for details.
 
 
SimpleHTML has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
 
SimpleHTML ''appears'' to have all the methods of [[#FontInstance|FontInstance]], and they can indeed be used in the same way to set the default font, but they all have an optional first parameter for which element's font to set ("h1", "h2", "p", etc). The Font instance methods are not reflected in the SimpleHTML frame until you SetText on the frame. It also appears that you can only supply the block elements and not the inline elements (ie Hyperlinks cannot be colored a different color). Other than that, see FontInstance for documentation of these methods.
 
   
 
: [[API SimpleHTML GetFont|SimpleHTML:GetFont]](["element"])
 
: [[API SimpleHTML GetFont|SimpleHTML:GetFont]](["element"])
 
: [[API SimpleHTML GetFontObject|SimpleHTML:GetFontObject]](["element"])
 
: [[API SimpleHTML GetFontObject|SimpleHTML:GetFontObject]](["element"])
: [[API SimpleHTML GetHyperlinkFormat|SimpleHTML:GetHyperlinkFormat]]() - Set the string.format format to use for displaying hyperlinks - New in 1.11.
+
: [[API SimpleHTML GetHyperlinkFormat|SimpleHTML:GetHyperlinkFormat]]() - Set the string.format format to use for displaying hyperlinks (added 1.11)
: [[API SimpleHTML GetHyperlinksEnabled|SimpleHTML:GetHyperlinksEnabled]]() - New in 3.0.8
+
: [[API SimpleHTML GetHyperlinksEnabled|SimpleHTML:GetHyperlinksEnabled]]() (added 3.0.8)
 
: [[API SimpleHTML GetJustifyH|SimpleHTML:GetJustifyH]](["element"])
 
: [[API SimpleHTML GetJustifyH|SimpleHTML:GetJustifyH]](["element"])
 
: [[API SimpleHTML GetJustifyV|SimpleHTML:GetJustifyV]](["element"])
 
: [[API SimpleHTML GetJustifyV|SimpleHTML:GetJustifyV]](["element"])
Line 545: Line 540:
 
: [[API SimpleHTML SetFontObject|SimpleHTML:SetFontObject]](["element",] fontObject)
 
: [[API SimpleHTML SetFontObject|SimpleHTML:SetFontObject]](["element",] fontObject)
 
: [[API SimpleHTML SetHyperlinkFormat|SimpleHTML:SetHyperlinkFormat]]("format") - Set the string.format format to use for displaying hyperlinks.
 
: [[API SimpleHTML SetHyperlinkFormat|SimpleHTML:SetHyperlinkFormat]]("format") - Set the string.format format to use for displaying hyperlinks.
: [[API SimpleHTML SetHyperlinksEnabled|SimpleHTML:SetHyperlinksEnabled]](enableFlag) - New in 3.0.8
+
: [[API SimpleHTML SetHyperlinksEnabled|SimpleHTML:SetHyperlinksEnabled]](enableFlag) (added 3.0.8)
 
: [[API SimpleHTML SetJustifyH|SimpleHTML:SetJustifyH]](["element",] "justifyH")
 
: [[API SimpleHTML SetJustifyH|SimpleHTML:SetJustifyH]](["element",] "justifyH")
 
: [[API SimpleHTML SetJustifyV|SimpleHTML:SetJustifyV]](["element",] "justifyV")
 
: [[API SimpleHTML SetJustifyV|SimpleHTML:SetJustifyV]](["element",] "justifyV")
Line 554: Line 549:
 
: [[API SimpleHTML SetTextColor|SimpleHTML:SetTextColor]](["element",] r, g, b[, a])
 
: [[API SimpleHTML SetTextColor|SimpleHTML:SetTextColor]](["element",] r, g, b[, a])
   
=== Slider ===
+
=== [[UIOBJECT Slider|Slider]] ===
See [[UIOBJECT Slider|Slider object information]] for details.
 
 
Slider has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
 
: [[API Slider Disable|Slider:Disable]]() - Disables the slider
 
: [[API Slider Disable|Slider:Disable]]() - Disables the slider
Line 560: Line 555:
 
: [[API Slider GetMinMaxValues|Slider:GetMinMaxValues]]() - Get the current bounds of the slider.
 
: [[API Slider GetMinMaxValues|Slider:GetMinMaxValues]]() - Get the current bounds of the slider.
 
: [[API Slider GetOrientation|Slider:GetOrientation]]() - Returns "HORIZONTAL" or "VERTICAL".
 
: [[API Slider GetOrientation|Slider:GetOrientation]]() - Returns "HORIZONTAL" or "VERTICAL".
: [[API Slider GetThumbTexture|Slider:GetThumbTexture]]() - Get the texture for this slider's thumb - New in 1.11.
+
: [[API Slider GetStepsPerPage|Slider:GetStepsPerPage]]() - Get the current page step size of the slider. (added 5.4.0)
  +
: [[API Slider GetThumbTexture|Slider:GetThumbTexture]]() - Get the texture for this slider's thumb. (added 1.11.0)
 
: [[API Slider GetValue|Slider:GetValue]]() - Get the current value of the slider.
 
: [[API Slider GetValue|Slider:GetValue]]() - Get the current value of the slider.
 
: [[API Slider GetValueStep|Slider:GetValueStep]]() - Get the current step size of the slider.
 
: [[API Slider GetValueStep|Slider:GetValueStep]]() - Get the current step size of the slider.
Line 566: Line 561:
 
: [[API Slider SetMinMaxValues|Slider:SetMinMaxValues]](min, max) - Set the bounds of the slider.
 
: [[API Slider SetMinMaxValues|Slider:SetMinMaxValues]](min, max) - Set the bounds of the slider.
 
: [[API Slider SetOrientation|Slider:SetOrientation]]("orientation") - "HORIZONTAL" or "VERTICAL".
 
: [[API Slider SetOrientation|Slider:SetOrientation]]("orientation") - "HORIZONTAL" or "VERTICAL".
: [[API Slider SetThumbTexture|Slider:SetThumbTexture]](texture or "texturePath")
+
: [[API Slider SetStepsPerPage|Slider:SetStepsPerPage]](value) - Set the page step size of the slider. (added 5.4.0)
  +
: [[API Slider SetThumbTexture|Slider:SetThumbTexture]](texture or "texturePath") Set texture for this slider's thumb. (added 1.11.0)
 
: [[API Slider SetValue|Slider:SetValue]](value) - Set the value of the slider. Also causes the thumb to show on the first call.
 
: [[API Slider SetValue|Slider:SetValue]](value) - Set the value of the slider. Also causes the thumb to show on the first call.
 
: [[API Slider SetValueStep|Slider:SetValueStep]](value) - Set the step size of the slider.
 
: [[API Slider SetValueStep|Slider:SetValueStep]](value) - Set the step size of the slider.
   
=== StatusBar ===
+
=== [[UIOBJECT StatusBar|StatusBar]] ===
See [[UIOBJECT StatusBar|StatusBar object information]] for details.
 
 
StatusBar has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following:
 
   
 
: [[API StatusBar GetMinMaxValues|StatusBar:GetMinMaxValues]]() - Get the current bounds of the bar.
 
: [[API StatusBar GetMinMaxValues|StatusBar:GetMinMaxValues]]() - Get the current bounds of the bar.
 
: [[API StatusBar GetOrientation|StatusBar:GetOrientation]]
 
: [[API StatusBar GetOrientation|StatusBar:GetOrientation]]
 
: [[API StatusBar GetStatusBarColor|StatusBar:GetStatusBarColor]]
 
: [[API StatusBar GetStatusBarColor|StatusBar:GetStatusBarColor]]
: [[API StatusBar GetStatusBarTexture|StatusBar:GetStatusBarTexture]]() - Returns the texture object for the bar - Before 1.11 it returned the filename.
+
: [[API StatusBar GetStatusBarTexture|StatusBar:GetStatusBarTexture]]() - Returns the texture object for the bar
 
: [[API StatusBar GetValue|StatusBar:GetValue]]() - Get the current value of the bar.
 
: [[API StatusBar GetValue|StatusBar:GetValue]]() - Get the current value of the bar.
 
: [[API StatusBar SetMinMaxValues|StatusBar:SetMinMaxValues]](min, max) - Set the bounds of the bar.
 
: [[API StatusBar SetMinMaxValues|StatusBar:SetMinMaxValues]](min, max) - Set the bounds of the bar.
 
: [[API StatusBar SetOrientation|StatusBar:SetOrientation]]("orientation") - "HORIZONTAL" or "VERTICAL".
 
: [[API StatusBar SetOrientation|StatusBar:SetOrientation]]("orientation") - "HORIZONTAL" or "VERTICAL".
 
: [[API StatusBar SetStatusBarColor|StatusBar:SetStatusBarColor]](r, g, b[, alpha]) - Set the color of the bar.
 
: [[API StatusBar SetStatusBarColor|StatusBar:SetStatusBarColor]](r, g, b[, alpha]) - Set the color of the bar.
: [[API StatusBar SetStatusBarTexture|StatusBar:SetStatusBarTexture]]("file" or texture[,"layer"]) - Sets the texture of the bar - Added texture as valid arg in 1.11.
+
: [[API StatusBar SetStatusBarTexture|StatusBar:SetStatusBarTexture]]("file" or texture[,"layer"]) - Sets the texture of the bar (added 'texture' 1.11)
 
: [[API StatusBar SetValue|StatusBar:SetValue]](value) - Set the value of the bar.
 
: [[API StatusBar SetValue|StatusBar:SetValue]](value) - Set the value of the bar.
   
 
== Button Derivatives ==
 
== Button Derivatives ==
  +
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]] and [[#Button|Button]], plus the following:
   
=== CheckButton ===
+
=== [[UIOBJECT CheckButton|CheckButton]] ===
See [[UIOBJECT CheckButton|CheckButton object information]] for details.
 
 
CheckButton has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]] and [[#Button|Button]], plus the following:
 
   
 
: [[API CheckButton GetChecked|CheckButton:GetChecked]]() - Get the status of the checkbox.
 
: [[API CheckButton GetChecked|CheckButton:GetChecked]]() - Get the status of the checkbox.
: [[API CheckButton GetCheckedTexture|CheckButton:GetCheckedTexture]]() - Get the texture used for a checked box - New in 1.11.
+
: [[API CheckButton GetCheckedTexture|CheckButton:GetCheckedTexture]]() - Get the texture used for a checked box (added 1.11)
: [[API CheckButton GetDisabledCheckedTexture|CheckButton:GetDisabledCheckedTexture]]() - Get the texture used for a disabled checked box - New in 1.11.
+
: [[API CheckButton GetDisabledCheckedTexture|CheckButton:GetDisabledCheckedTexture]]() - Get the texture used for a disabled checked box (added 1.11)
 
: [[API CheckButton SetChecked|CheckButton:SetChecked]]([state]) - Set the status of the checkbox.
 
: [[API CheckButton SetChecked|CheckButton:SetChecked]]([state]) - Set the status of the checkbox.
 
: [[API CheckButton SetCheckedTexture|CheckButton:SetCheckedTexture]](texture) - Set the texture to use for a checked box.
 
: [[API CheckButton SetCheckedTexture|CheckButton:SetCheckedTexture]](texture) - Set the texture to use for a checked box.
 
: [[API CheckButton SetDisabledCheckedTexture|CheckButton:SetDisabledCheckedTexture]](texture) - Set the texture to use for a disabled but checked box.
 
: [[API CheckButton SetDisabledCheckedTexture|CheckButton:SetDisabledCheckedTexture]](texture) - Set the texture to use for a disabled but checked box.
   
=== LootButton ===
+
=== [[UIOBJECT LootButton|LootButton]] ===
(See [[UIOBJECT LootButton|LootButton object information]] for details) LootButton has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]] and [[#Button|Button]], plus the following:
 
   
 
: [[API LootButton SetSlot|LootButton:SetSlot]](index) - Set which the item to loot if the button is clicked.
 
: [[API LootButton SetSlot|LootButton:SetSlot]](index) - Set which the item to loot if the button is clicked.
   
 
== Model Derivatives ==
 
== Model Derivatives ==
=== PlayerModel ===
+
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]] and [[#Model|Model]], plus the following:
See [[UIOBJECT PlayerModel|PlayerModel object information]] for details.
 
   
PlayerModel has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]] and [[#Model|Model]], plus the following:
+
=== [[UIOBJECT PlayerModel|PlayerModel]] ===
   
 
: [[API PlayerModel RefreshUnit|PlayerModel:RefreshUnit]]()
 
: [[API PlayerModel RefreshUnit|PlayerModel:RefreshUnit]]()
Line 609: Line 605:
   
 
== PlayerModel Derivatives ==
 
== PlayerModel Derivatives ==
=== DressUpModel ===
+
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]], [[#Model|Model]] and [[#PlayerModel|PlayerModel]], plus the following:
See [[UIOBJECT DressUpModel|DressUpModel object information]] for details.
 
   
DressUpModel has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]], [[#Model|Model]] and [[#PlayerModel|PlayerModel]], plus the following:
+
=== [[UIOBJECT DressUpModel|DressUpModel]] ===
   
 
: [[API DressUpModel Dress|DressUpModel:Dress]]() - Set the model to reflect the character's current inventory.
 
: [[API DressUpModel Dress|DressUpModel:Dress]]() - Set the model to reflect the character's current inventory.
Line 617: Line 613:
 
: [[API DressUpModel Undress|DressUpModel:Undress]]() - Set the model to reflect the character without inventory.
 
: [[API DressUpModel Undress|DressUpModel:Undress]]() - Set the model to reflect the character without inventory.
   
=== TabardModel ===
+
=== [[UIOBJECT TabardModel|TabardModel]] ===
See [[UIOBJECT TabardModel|TabardModel object information]] for details.
 
 
TabardModel has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]], [[#Model|Model]] and [[#PlayerModel|PlayerModel]], plus the following:
 
   
 
: [[API TabardModel CanSaveTabardNow|TabardModel:CanSaveTabardNow]]() - Indicate if the tabard can be saved.
 
: [[API TabardModel CanSaveTabardNow|TabardModel:CanSaveTabardNow]]() - Indicate if the tabard can be saved.
Line 631: Line 627:
   
 
== LayeredRegion Derivatives ==
 
== LayeredRegion Derivatives ==
=== Texture ===
+
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#LayeredRegion|LayeredRegion]], plus the following:
See [[UIOBJECT Texture|Texture object information]] for details.
 
   
Texture has all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#LayeredRegion|LayeredRegion]], plus the following:
+
=== [[UIOBJECT Texture|Texture]] ===
 
Note, the game will not find image files that did not exist when it was started, you may need to restart the game for the texture to appear.
 
   
 
: [[API Texture GetBlendMode|Texture:GetBlendMode]]() - Return the blend mode set by SetBlendMode()
 
: [[API Texture GetBlendMode|Texture:GetBlendMode]]() - Return the blend mode set by SetBlendMode()
: [[API Texture GetTexCoord|Texture:GetTexCoord]]() - Gets the 8 texture coordinates that map to the Texture's corners - New in 1.11.
+
: [[API Texture GetTexCoord|Texture:GetTexCoord]]() - Gets the 8 texture coordinates that map to the Texture's corners (added 1.11)
: REMOVED (3.3.3) [[API Texture GetTexCoordModifiesRect|Texture:GetTexCoordModifiesRect]]() - Get the SetTexCoordModifiesRect setting - New in 1.11
+
: REMOVED (3.3.3) [[API Texture GetTexCoordModifiesRect|Texture:GetTexCoordModifiesRect]]() - Get the SetTexCoordModifiesRect setting (added 1.11)
 
: [[API Texture GetTexture|Texture:GetTexture]]() - Gets this texture's current texture path.
 
: [[API Texture GetTexture|Texture:GetTexture]]() - Gets this texture's current texture path.
 
: [[API Texture GetVertexColor|Texture:GetVertexColor]]() - Gets the vertex color for the Texture.
 
: [[API Texture GetVertexColor|Texture:GetVertexColor]]() - Gets the vertex color for the Texture.
: [[API Texture IsDesaturated|Texture:IsDesaturated]]() - Gets the desaturation state of this Texture. - New in 1.11
+
: [[API Texture IsDesaturated|Texture:IsDesaturated]]() - Gets the desaturation state of this Texture. (added 1.11)
 
: [[API Texture SetBlendMode|Texture:SetBlendMode]]("mode") - Set the [[alphaMode]] of the texture.
 
: [[API Texture SetBlendMode|Texture:SetBlendMode]]("mode") - Set the [[alphaMode]] of the texture.
: [[API Texture SetDesaturated|Texture:SetDesaturated]](flag) - Set whether this texture should be displayed with no saturation ('''Note''': This has a return value)
+
: [[API Texture SetDesaturated|Texture:SetDesaturated]](flag) - If should be displayed with no saturation. has a return value.
 
: [[API Texture SetGradient|Texture:SetGradient]]("orientation", minR, minG, minB, maxR, maxG, maxB)
 
: [[API Texture SetGradient|Texture:SetGradient]]("orientation", minR, minG, minB, maxR, maxG, maxB)
 
: [[API Texture SetGradientAlpha|Texture:SetGradientAlpha]]("orientation", minR, minG, minB, minA, maxR, maxG, maxB, maxA)
 
: [[API Texture SetGradientAlpha|Texture:SetGradientAlpha]]("orientation", minR, minG, minB, minA, maxR, maxG, maxB, maxA)
: [[API Texture SetRotation|Texture:SetRotation]](angle, [,cx, cy]) - This is simply a shorthand for the appropriate 8 argument SetTexCoord rotation (in C++ so it's fast)
+
: [[API Texture SetRotation|Texture:SetRotation]](angle, [,cx, cy]) - Shorthand for the appropriate 8 argument SetTexCoord rotation (in C++ so it's fast)
 
: [[API Texture SetTexCoord|Texture:SetTexCoord]](minX, maxX, minY, maxY or ULx, ULy, LLx, LLy, URx, URy, LRx, LRy) - Set the corner coordinates for texture display.
 
: [[API Texture SetTexCoord|Texture:SetTexCoord]](minX, maxX, minY, maxY or ULx, ULy, LLx, LLy, URx, URy, LRx, LRy) - Set the corner coordinates for texture display.
: REMOVED (3.3.3) [[API Texture SetTexCoordModifiesRect|Texture:SetTexCoordModifiesRect]](enableFlag) - Set whether future SetTexCoord operations should modify the display rectangle rather than stretch the texture. - New in 1.11
+
: REMOVED (3.3.3) [[API Texture SetTexCoordModifiesRect|Texture:SetTexCoordModifiesRect]](enableFlag) - if operations modify the rectangle or stretch the texture. (added 1.11)
 
: [[API Texture SetTexture|Texture:SetTexture]]("texturePath" or r, g, b[, a]) - Sets the texture to be displayed from a file or to a solid color.
 
: [[API Texture SetTexture|Texture:SetTexture]]("texturePath" or r, g, b[, a]) - Sets the texture to be displayed from a file or to a solid color.
   
The following 2 functions are not included in Texture object's metatables and as such cannot be used as methods, however they impact texture appearance directly and as such included here:
+
=== [[UIOBJECT FontString|FontString]] ===
+
FontString has additional methods from [[#FontInstance|FontInstance]], plus the following:
: [[API SetPortraitTexture|SetPortraitTexture]](texture,"[[unitId|unit]]") - Paint a Texture object with the specified unit's portrait.
 
: [[API SetPortraitToTexture|SetPortraitToTexture]](texture or "texture", "texturePath") - Sets the texture to be displayed from a file applying circular opacity mask making it look round like portraits.
 
 
=== FontString ===
 
See [[UIOBJECT FontString|FontString object information]] for details.
 
 
FontString has all of the methods from [[#UIObject|UIObject]], [[#FontInstance|FontInstance]], [[#Region|Region]] and [[#LayeredRegion|LayeredRegion]], plus the following:
 
 
Note that FontString:Get/SetWidth() and Get/SetHeight() behave very differently for fontstrings; see the object information.
 
   
: [[API FontString CanNonSpaceWrap|FontString:CanNonSpaceWrap]]() - Get whether long strings without spaces are wrapped or truncated - New in 1.11.
+
: [[API FontString CanNonSpaceWrap|FontString:CanNonSpaceWrap]]() - Get whether long strings without spaces are wrapped or truncated (added 1.11)
: [[API FontString GetStringHeight|FontString:GetStringHeight]]() - Returns the height in pixels of the current string in the current font (without line wrapping). - New in 2.3.
+
: [[API FontString GetStringHeight|FontString:GetStringHeight]]() - Returns the height in pixels of the current string in the current font, without line wrapping. (added 2.3)
: [[API FontString GetStringWidth|FontString:GetStringWidth]]() - Returns the width in pixels of the current string in the current font (without line wrapping).
+
: [[API FontString GetStringWidth|FontString:GetStringWidth]]() - Returns the width in pixels of the current string in the current font, without line wrapping.
 
: [[API FontString GetText|FontString:GetText]]() - Get the displayed text.
 
: [[API FontString GetText|FontString:GetText]]() - Get the displayed text.
 
: [[API FontString SetAlphaGradient|FontString:SetAlphaGradient]](start, length) - Create or remove an alpha gradient over the text.
 
: [[API FontString SetAlphaGradient|FontString:SetAlphaGradient]](start, length) - Create or remove an alpha gradient over the text.
: [[API FontString SetFormattedText|FontString:SetFormattedText]]("formatstring"[, ...]) - Set the formatted display text. - New in 2.3.
+
: [[API FontString SetFormattedText|FontString:SetFormattedText]]("formatstring"[, ...]) - Set the formatted display text. (added 2.3)
 
: [[API FontString SetNonSpaceWrap|FontString:SetNonSpaceWrap]](wrapFlag) - Set whether long strings without spaces are wrapped or truncated.
 
: [[API FontString SetNonSpaceWrap|FontString:SetNonSpaceWrap]](wrapFlag) - Set whether long strings without spaces are wrapped or truncated.
 
: [[API FontString SetText|FontString:SetText]]("text") - Set the displayed text.
 
: [[API FontString SetText|FontString:SetText]]("text") - Set the displayed text.
: [[API FontString SetTextHeight|FontString:SetTextHeight]](pixelHeight) - Set the height of the text by scaling graphics (Note: Can distort text).
+
: [[API FontString SetTextHeight|FontString:SetTextHeight]](pixelHeight) - Set the height of the text by scaling graphics Note that can distort text.
   
 
== Special ==
 
== Special ==
=== WorldFrame ===
 
WorldFrame is the frame which is used to display 3D world itself; it inherits methods of a normal frame widget. The frame is initially nonprotected, but because nameplates are protected children of the world frame, becomes protected when the first nameplate is seen. No additional WorldFrames may be created by addons.
 
   
The 3D content of this frame is rendered while keeping the '''vertical''' field of vision. So, if you widen (or flatten) WorldFrame, you'll indeed gain a wider horizontal vision angle. Also, if you're designing interface elements covering large areas of valuable screen estate, you might consider sizing WorldFrame down and thus moving it out from under your interface, so that they do not overlap too much.
+
=== [[UIOBJECT WorldFrame|WorldFrame]] ===
  +
WorldFrame is the frame which is used to display 3D world itself.
  +
Inherits methods from [[#Frame|Frame]].
   
=== FrameXML virtual frames ===
+
=== [[UIOBJECT Templates|Templates]]===
There are several different FrameXML frame templates that are worth pointing out:
+
These are nota type per se, but objects generated form XML that can be used as templates UIObject Lua code.
* [[SecureTemplates]] and [[SecureHandlerTemplates]] are a set of protected button and frame templates that enable addons to perform secure actions like spell casting or targetting.
 
* [[UI Object UIDropDownMenu|UIDropDownMenu]] allows you to create drop-down list boxes.
 
 
[[Category:Widgets]]
 
[[Category:Widgets]]

Latest revision as of 20:35, September 23, 2013

This Widget API reference, and the term Widget, refer to the UIObject Lua API, and the specific APIs of the actual UIObjects found in WoW. This is a list of all of the Widget API UIObject specific functions found by scanning the in-game environment. You may also be interested in the various Widget handlers and XML UI.

Can click on each the secion heading for Lua class details

Root Widgets Edit

UIObject Edit

This is an abstract UI object type which cannot actually be created. Is base type for all widget types.

Object:GetParent() - Moved from Region:GetParent(). This is essentially the same as the old version, except that you can no longer assume that your object has a Frame type in its hierarchy somewhere.
UIObject:GetAlpha() - Return this object's alpha (transparency) value.
UIObject:GetName() - Return the name of the object.
UIObject:GetObjectType() - Get the type of this object.
UIObject:IsForbidden() - Return bool indicating is secure widget instance.
UIObject:IsObjectType("type") - Determine if this object is of the specified type, or a subclass of that type.
UIObject:SetAlpha(alpha) - Set the object's alpha (transparency) value.

UIObject Derivatives Edit

Have all of the methods from UIObject, plus the following:

AnimationGroup Edit

This manages playback, order, and looping of its child Animations. (added 3.1.0)

AnimationGroup:Play() - Start playing the animations in this group.
AnimationGroup:Pause() - Pause the animations in this group.
AnimationGroup:Stop() - Stop all animations in this group.
AnimationGroup:Finish() - Notify this group to stop playing once the current loop cycle is done.
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:IsPlaying() - Returns true if the group is playing.
AnimationGroup:IsPaused() - Returns true if the group is paused.
AnimationGroup:GetDuration() - Gets the total duration for one loop cycle of all child Animations.
AnimationGroup:SetLooping(loopType) - Sets the group loop type [NONE, REPEAT, BOUNCE]
AnimationGroup:GetLooping() - Gets the group loop type.
AnimationGroup:GetLoopState() - Gets the current group loop state [NONE, FORWARD, REVERSE]
AnimationGroup:CreateAnimation("animationType", ["name"[,"inheritsFrom"]]) - Create and return an Animation as a child of this group.
AnimationGroup:HasScript("handler") - Same as Frame:HasScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
AnimationGroup:GetScript("handler") - Same as Frame:GetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
AnimationGroup:SetScript("handler", function) - Same as Frame:SetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].

Animation Edit

Is the base animation type for animations in an AnimationGroup. (added 3.1.0)

Animation:Play() - Play the animation.
Animation:Pause() - Pause the animation.
Animation:Stop() - Stop the animation.
Animation:IsDone() - Returns true if the animation has finished playing.
Animation:IsPlaying() - Returns true if the animation is playing.
Animation:IsPaused() - Returns true if the animation is paused.
Animation:IsStopped() - Returns true if the animation is stopped.
Animation:IsDelaying() - Returns true if the animation is in the middle of a start or end delay.
Animation:GetElapsed() - Gets the amount of time in seconds that the animation has been playing for.
Animation:SetStartDelay(delaySec) - Set the seconds that the animation delays before it starts to progress.
Animation:GetStartDelay() - Get the seconds that the animation delays before it starts to progress.
Animation:SetEndDelay(delaySec) - Set the number of seconds the animation delays after finishing.
Animation:GetEndDelay() - Get the number of seconds the animation delays after finishing.
Animation:SetDuration(durationSec) - Set the seconds it takes for the animation to progress from start to finish.
Animation:GetDuration() - Get the seconds it takes for the animation to progress from start to finish.
Animation:GetProgress() - Returns the progress of the animation as a unit value [0,1]. Ignores start and end delay.
Animation:GetSmoothProgress() - Returns a smoothed, [0,1] progress value for the animation.
Animation:GetProgressWithDelay() - Returns the progress of the animation combined with its start and end delay.
Animation:SetMaxFramerate(framerate) - Sets the maximum fps that the animation will update its progress.
Animation:GetMaxFramerate() - Gets the maximum fps that the animation will update its progress.
Animation:SetOrder(order) - Sets the order that the animation plays within its parent group. Range is [1,100].
Animation:GetOrder() - Gets the order of the animation within its parent group.
Animation:SetSmoothing(smoothType) - Sets the smoothing type for the animation [IN,OUT,IN_OUT,OUT_IN]
Animation:GetSmoothing() - Gets the smoothing type for the animation.
Animation:SetParent(animGroup or "animGroupName") - Sets the parent for the animation. If the animation was not already a child of the parent, the parent will insert the animation into the proper order amongst its children.
Animation:GetRegionParent() - Gets the Region object that the animation operates on. The region object is this Animation's parent's parent (the AnimationGroup's parent).
Animation:HasScript("handler") - Same as Frame:HasScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]
Animation:GetScript("handler") - Same as Frame:GetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]
Animation:SetScript("handler") - Same as Frame:SetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]

FontInstance Edit

This is an abstract object type that provides font related methods.

FontInstance:GetFont() - Return the font file, height, and flags.
FontInstance:GetFontObject() - Return the 'parent' Font object, or nil if none.
FontInstance:GetJustifyH() - Return the horizontal text justification.
FontInstance:GetJustifyV() - Return thevertical text justification.
FontInstance:GetShadowColor() - Returns the color of text shadow (r, g, b, a).
FontInstance:GetShadowOffset() - Returns the text shadow offset (x, y).
FontInstance:GetSpacing() - Returns the text spacing.
FontInstance:GetTextColor() - Returns the default text color.
FontInstance:SetFont("path", height[,"flags"]) - Sets the font to use for text, returns 1 if the path was valid, nil otherwise (no change occurs).
FontInstance:SetFontObject(fontObject) - Sets the 'parent' Font object from which this object inherits properties.
FontInstance:SetJustifyH("justifyH") - Sets horizontal text justification ("LEFT","RIGHT", or "CENTER")
FontInstance:SetJustifyV("justifyV") - Sets vertical text justification ("TOP","BOTTOM", or "MIDDLE")
FontInstance:SetShadowColor(r, g, b[, a]) - Sets the text shadow color.
FontInstance:SetShadowOffset(x, y) - Sets the text shadow offset.
FontInstance:SetSpacing(spacing) - Sets the spacing between lines of text in the object.
FontInstance:SetTextColor(r, g, b[, a]) - Sets the default text color.

Region Edit

This is an abstract object type which cannot actually be created. Defines a potentially visible area.

Region:ClearAllPoints() - Clear all attachment points for this object.
Region:CreateAnimationGroup(["name"[,"inheritsFrom"]]) - Create and return a new AnimationGroup as a child of this Region. (added 3.1.0)
Region:GetAnimationGroups() - Returns all AnimationGroups that are children of this Region. (added 3.1.0)
Region:GetBottom() - Get the y location of the bottom edge of this frame - Moved in 1.10.
Region:GetCenter() - Get the coordinates of the center of this frame - Moved in 1.10.
Region:GetHeight() - Get the height of this object.
Region:GetLeft() - Get the x location of the left edge of this frame - Moved in 1.10.
Region:GetNumPoints() - Get the number of anchor points for this frame (added 1.10)
Region:GetPoint(pointNum) - Get details for an anchor point for this frame (point, relativeTo, relativePoint, xofs, yofs) (added 1.10)
Region:GetRect() - Get frame's left, bottom, width, height.
Region:GetRight() - Get the x location of the right edge of this frame - Moved in 1.10.
Region:GetSize() - Get the width and height of the frame
Region:GetTop() - Get the y location of the top edge of this frame - Moved in 1.10.
Region:GetWidth() - Get the width of this object.
Region:Hide() - Set this object to hidden (it and all of its children will disappear).
Region:IsDragging() - True if this Region or its Parent is being dragged. (added 3.1.0)
Region:IsProtected() - Determine if this object can be manipulated in certain ways by tainted code in combat or not
Region:IsShown() - Determine if this object is shown (would be visible if its parent was visible).
Region:IsVisible() - Get whether the object is visible on screen (logically (IsShown() and GetParent():IsVisible()));
Region:SetAllPoints(frame or "frameName") - Set all anchors to match edges of specified frame - Moved in 1.10.
Region:SetHeight(height) - Set the height of the object.
Region:SetParent(parent or "parentName") - Set the parent for this frame - Moved in 1.10.
Region:SetPoint("point","relativeFrame" or relativeObject,"relativePoint"[, xOfs, yOfs]) - Set an attachment point of this object - Updated in 1.10. Since 2.2 cooordinates are now relative to the closest anchor point
Region:SetSize(width, height) - Set the region's width and height
Region:SetWidth(width) - Set the width of the object.
Region:Show() - Set this object to shown (it will appear if its parent is visible).
Region:StopAnimating() - Stops any active animations on the Region and its children. (added 3.1.0)

Animation Derivatives Edit

Have all of the methods of UIObject and Animation, plus the following:

Alpha Edit

This animation changes the alpha value of its parent region.

Alpha:SetChange(change) - Sets the amount that the alpha value of this animation's parent Region changes by.
Alpha:GetChange() - Gets the amount that the alpha value of this animation's parent Region changes by.

Path Edit

This animation combines multiple animation translations.

Path:CreateControlPoint(["name" [, "template" [, order]]]) - Adds a new path control point.
Path:GetControlPoints() - Returns an arg list of current path control points.
Path:GetCurve() - Returns the path 'curveType'.
Path:GetMaxOrder() - Returns highest 'orderId' currently set for any of the control points .
Path:SetCurve("curveType") - Sets the path 'curveType'.

Rotation Edit

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

Rotation:SetDegrees(degrees) - Sets the amount of degrees that the animation's parent Region would rotate.
Rotation:GetDegrees() - Gets the amount of degrees that the animation's parent Region would rotate.
Rotation:SetRadians(radians) - Sets the amount of radians that the animation's parent Region would travel.
Rotation:GetRadians() - Gets the amount of radians that the animation's parent Region would travel.
Rotation:SetOrigin(point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region.
Rotation:GetOrigin() - Gets the point, Xoffset, and Yoffset for animation's rotation origin in its parent Region.

Scale Edit

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

Scale:SetScale(x, y) - Sets the X scalar and the Y scalar that the animation's parent Region should scale by.
Scale:GetScale() - Gets the X scalar and the Y scalar that the animation's parent Region should scale by.
Scale:SetOrigin(point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region.
Scale:GetOrigin() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region.

Translation Edit

This is an affine transformation that moves a parent Region by an offset.

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

FontInstance Derivatives Edit

Have all of the methods from UIObject and FontInstance, plus the following:

Font Edit

Allows base font information to be defined, rather than creating a full-blown FontString. (added 1.10)

Font:CopyFontObject(otherFont) - Set this Font's attributes to be a copy of the otherFont font object's.

Region Derivatives Edit

Have all of the methods from UIObject and Region, plus the following:

Frame Edit

Frame:CreateFontString(["name"[,"layer"[,"inheritsFrom"]]]) - Create and return FontString as a child of this Frame (added 'InheritsFrom' 1.11)
Frame:CreateTexture(["name"[,"layer"]][,"inheritsFrom"]) - Create and return Texture as a child of this Frame. Good for solid colors. -  (added 'InheritsFrom' 1.11)
Frame:CreateTitleRegion() - Create a title region for the frame if it does not have one. (added 1.11)
Frame:DisableDrawLayer("layer") - Disable rendering of "regions" (fontstrings, textures) in the specified draw layer.
Frame:EnableDrawLayer("layer") - Enable rendering of "regions" (fontstrings, textures) in the specified draw layer.
Frame:EnableKeyboard(enableFlag) - Set whether this frame will get keyboard input.
Frame:EnableMouse(enableFlag) - Set whether this frame will get mouse input.
Frame:EnableMouseWheel(enableFlag) - Set whether this frame will get mouse wheel notifications.
Frame:GetAttribute(prefix, name, suffix) - Returns the first existing attribute of (prefix..name..suffix), ("*"..name..suffix), (prefix..name.."*"), ("*"..name.."*"), (name).
Frame:GetBackdrop() - Creates and returns a backdrop table suitable for use in SetBackdrop (added 1.11)
Frame:GetBackdropBorderColor() - Gets the frame's backdrop border color (r, g, b, a) (added 1.11)
Frame:GetBackdropColor() - Gets the frame's backdrop color (r, g, b, a) (added 1.11)
Frame:GetChildren() - Get the list of "children" (frames and things derived from frames) of this frame.
Frame:GetClampRectInsets() - Gets the modifiers to the frame's rectangle used for clamping the frame to screen.
Frame:GetDepth() (added 3.0.8)
Frame:GetEffectiveAlpha() - Returns the effective alpha of a frame. (added 2.1)
Frame:GetEffectiveDepth() (added 3.0.8)
Frame:GetEffectiveScale() - Get the scale factor of this object relative to the root window.
Frame:GetFrameLevel() - Get the level of this frame.
Frame:GetFrameStrata() - Get the strata of this frame.
Frame:GetFrameType() - Get the type of this frame.
Frame:GetHitRectInsets() - Gets the frame's hit rectangle inset distances (l, r, t, b) (added 1.11)
Frame:GetID() - Get the ID of this frame.
Frame:GetMaxResize() - Gets the frame's maximum allowed resize bounds (w, h) (added 1.11)
Frame:GetMinResize() - Gets the frame's minimum allowed resize bounds (w, h) (added 1.11)
Frame:GetNumChildren() - Get the number of "children" (frames and things derived from frames) this frame has.
Frame:GetNumRegions() - Return the number of "regions" (fontstrings, textures) belonging to this frame.
Frame:GetRegions() - Return the "regions" (fontstrings, textures) of the frame (multiple return values) belonging to this frame.
Frame:GetScale() - Get the scale factor of this object relative to its parent.
Frame:GetScript("handler") - Get the function for one of this frame's handlers.
Frame:GetTitleRegion() - Return the frame's title region (added 1.11)
Frame:HasScript("handler") - Return true if the frame can be given a handler of the specified type (NOT whether it actually HAS one, use GetScript for that) (added 1.8)
Frame:HookScript("handler", function) - Hook a secure frame script. - Since 2.1.
Frame:IgnoreDepth(ignoreFlag) (added 3.0.8)
Frame:IsClampedToScreen() - Gets whether the frame is prohibited from being dragged off screen (added 1.11)
Frame:IsEventRegistered("event") - Returns true if the given event is registered to the frame. (added 2.3)
Frame:IsFrameType("type") - Determine if this frame is of the specified type, or a subclass of that type.
Frame:IsIgnoringDepth() (added 3.0.8)
Frame:IsKeyboardEnabled() - Get whether this frame will get keyboard input. (added 1.11)
Frame:IsMouseEnabled() - Get whether this frame will get mouse input. (added 1.11)
Frame:IsMouseWheelEnabled() - Get whether this frame will get mouse wheel notifications. (added 1.11)
Frame:IsMovable() - Determine if the frame can be moved.
Frame:IsResizable() - Determine if the frame can be resized.
Frame:IsToplevel() - Get whether the frame is set as toplevel (added 1.10.2)
Frame:IsUserPlaced() - Determine if this frame has been relocated by the user.
Frame:Lower() - Lower this frame behind other frames.
Frame:Raise() - Raise this frame above other frames.
Frame:RegisterAllEvents() - Register this frame to receive all events (For debugging purposes only!) (added 1.11)
Frame:RegisterEvent("event") - Indicate that this frame should be notified when event occurs.
Frame:RegisterForDrag("buttonType"[,"buttonType"...]) - Inidicate that this frame should be notified of drag events for the specified buttons.
Frame:SetBackdrop([backdropTable]) - Set the backdrop of the frame according to the specification provided.
Frame:SetBackdropBorderColor(r, g, b[, a]) - Set the frame's backdrop's border's color.
Frame:SetBackdropColor(r, g, b[, a]) - Set the frame's backdrop color.
Frame:SetClampedToScreen(clamped) - Set whether the frame is prohibited from being dragged off screen (added 1.11)
Frame:SetClampRectInsets(left, right, top, bottom) - Modify the frame's rectangle used to prevent dragging offscreen.
Frame:SetDepth(depth) (added 3.0.8)
Frame:SetFrameLevel(level) - Set the level of this frame (determines which of overlapping frames shows on top).
Frame:SetFrameStrata("strata") - Set the strata of this frame.
Frame:SetHitRectInsets(left, right, top, bottom) - Set the inset distances for the frame's hit rectangle (added 1.11)
Frame:SetID(id) - Set the ID of this frame.
Frame:SetMaxResize(maxWidth, maxHeight) - Set the maximum dimensions this frame can be resized to.
Frame:SetMinResize(minWidth, minHeight) - Set the minimum dimensions this frame can be resized to.
Frame:SetMovable(isMovable) - Set whether the frame can be moved.
Frame:SetResizable(isResizable) - Set whether the frame can be resized.
Frame:SetScale(scale) - Set the scale factor of this frame relative to its parent.
Frame:SetScript("handler", function) - Set the function to use for a handler on this frame.
Frame:SetToplevel(isTopLevel) - Set whether the frame should raise itself when clicked (added 1.10.2)
Frame:SetUserPlaced(isUserPlaced) - Set whether the frame has been relocated by the user, and will thus be saved in the layout cache.
Frame:StartMoving() - Start moving this frame.
Frame:StartSizing("point") - Start sizing this frame using the specified anchor point.
Frame:StopMovingOrSizing() - Stop moving and/or sizing this frame.
Frame:UnregisterAllEvents() - Indicate that this frame should no longer be notified when any events occur.
Frame:UnregisterEvent("event") - Indicate that this frame should no longer be notified when event occurs.

LayeredRegion Edit

An abstract type for objects that represent a potentially visible area defined in a layer.

LayeredRegion:GetDrawLayer() - Returns the draw layer for the Region (added 1.10)
LayeredRegion:SetDrawLayer("layer") - Sets the draw layer for the Region (added 1.10)
LayeredRegion:SetVertexColor(r, g, b[, alpha])

Frame Derivatives Edit

Have all of the methods from UIObject, Region and Frame, plus the following:

Button Edit

Button:Click() - Execute the click action of the button.
Button:Disable() - Disable the Button so that it cannot be clicked.
Button:Enable() - Enable to the Button so that it may be clicked.
Button:GetButtonState() - Return the current state ("PUSHED","NORMAL") of the Button.
Button:GetDisabledFontObject() - Return the font object for the Button when disabled (added 1.10)
REMOVED Button:GetDisabledTextColor() - Get the color of this button's text when disabled (r, g, b, a) (added 1.11)(removed 3.0.2)
Button:GetDisabledTexture() - Get the texture for this button when disabled (added 1.11)
REMOVED Button:GetFont() - Returns the font, size, and flags currently used for display on the Button. (removed 3.0.2)
Button:GetFontString() - Get this button's label FontString (added 1.11)
Button:GetHighlightFontObject() - Return the font object for the Button when highlighted (added 1.10)
REMOVED Button:GetHighlightTextColor() - Get the color of this button's text when highlighted (r, g, b, a) (added 1.11)(removed 3.0.2)
Button:GetHighlightTexture() - Get the texture for this button when highlighted (added 1.11)
Button:GetNormalTexture() - Get the normal texture for this button (added 1.11)
Button:GetNormalFontObject() - Get the Normal Font Object of the button (added 3.0.0)
Button:GetPushedTextOffset() - Get the text offset when this button is pushed (x, y) (added 1.11)
Button:GetPushedTexture() - Get the texture for this button when pushed (added 1.11)
Button:GetText() - Get the text label for the Button.
REMOVED Button:GetTextColor() - Get the normal color of this button's text (r, g, b, a) (added 1.11) (removed 3.0.2)
REMOVED Button:GetTextFontObject() - Return the font object for the Button's normal text (added 1.10)(removed 3.0.2)
Button:GetTextHeight() - Get the height of the Button's text.
Button:GetTextWidth() - Get the width of the Button's text.
Button:IsEnabled() - Determine whether the Button is enabled.
Button:LockHighlight() - Set the Button to always be drawn highlighted.
Button:RegisterForClicks("clickType"[,"clickType"...]) - Specify which mouse button up/down actions cause receive an OnClick notification.
Button:SetButtonState("state"[, lock]) - Set the state of the Button ("PUSHED", "NORMAL") and whether it is locked.
Button:SetDisabledFontObject([font]) - Set the font object for settings when disabled (added 1.10)
REMOVED Button:SetDisabledTextColor(r, g, b[, a]) - Set the disabled text color for the Button. (removed 4.0.1)
Button:SetDisabledTexture(texture or "texturePath") - Set the disabled texture for the Button (updated in 1.10)
Button:SetFont("font", size[,"flags"]) - Set the font to use for display.
Button:SetFontString(fontString) - Set the button's label FontString (added 1.11)
Button:SetFormattedText("formatstring"[, ...]) - Set the formatted text label for the Button. (added 2.3)
Button:SetHighlightFontObject([font]) - Set the font object for settings when highlighted (added 1.10)
REMOVED Button:SetHighlightTextColor(r, g, b[, a]) - Set the highlight text color for the Button. (removed 4.0.1)
Button:SetHighlightTexture(texture or "texturePath"[,alphaMode]) - Set the highlight texture for the Button (updated in 1.10)
Button:SetNormalTexture(texture or "texturePath") - Set the normal texture for the Button (updated in 1.10)
Button:SetNormalFontObject(FontString) - Replaces SetTextFontObject (updated in 3.0)
Button:SetPushedTextOffset(x, y) - Set the text offset for this button when pushed (added 1.11)
Button:SetPushedTexture(texture or "texturePath") - Set the pushed texture for the Button (updated in 1.10)
Button:SetText("text") - Set the text label for the Button.
REMOVED Button:SetTextColor(r, g, b) - Set the text color for the Button. (removed 3.0.2)
REMOVED Button:SetTextFontObject([font]) - Set the font object to get settings from for this Button's normal state (added 1.10)(removed 3.0.2)
Button:UnlockHighlight() - Set the Button to not always be drawn highlighted.

Cooldown Edit

Cooldown:GetReverse() - returns true or false
Cooldown:SetCooldown(Start, Duration)
Cooldown:SetReverse(boolean)

ColorSelect Edit

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 (added 1.11)
ColorSelect:GetColorValueThumbTexture() - Get the texture for the color value thumb (added 1.11)
ColorSelect:GetColorWheelTexture() - Get the texture for the color wheel (added 1.11)
ColorSelect:GetColorWheelThumbTexture() - Get the texture for the color wheel thumb (added 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(texture or nil) - Set the texture used to show color value (added 1.11)
ColorSelect:SetColorValueThumbTexture(texture or "texture" or nil) - Set the texture for the color value thumb (added 1.11)
ColorSelect:SetColorWheelTexture(texture or nil) - Set the texture for the color wheel (added 1.11)
ColorSelect:SetColorWheelThumbTexture(texture or "texture" or nil) - Set the texture for the color wheel thumb (added 1.11)

EditBox Edit

EditBox additionally has all of the methods from FontInstance, plus the following:

EditBox:AddHistoryLine("text") - Add text to the edit history.
EditBox:ClearFocus()
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 (added 1.11)
EditBox:GetCursorPosition() - Gets the position of the cursor inside the EditBox (added 2.3)
EditBox:GetHistoryLines() - Get the number of history lines for this edit box
EditBox:GetHyperlinksEnabled() (added 3.0.8)
EditBox:GetInputLanguage() - Get the input language. locale based, not in-game.
EditBox:GetMaxBytes() - Gets the maximum number bytes allowed in the EditBox (added 1.11)
EditBox:GetMaxLetters() - Gets the maximum number of letters allowed in the EditBox (added 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 (added 1.11)
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 (added 1.11)
EditBox:IsMultiLine() - Determine if the EditBox accepts multiple lines (added 1.11)
EditBox:IsNumeric() - Determine if the EditBox only accepts numeric input (added 1.11)
EditBox:IsPassword() - Determine if the EditBox performs password masking (added 1.11)
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: true (added 1.11)
EditBox:SetBlinkSpeed
EditBox:SetCursorPosition(position) - Set the position of the cursor within the EditBox (added 2.3)
EditBox:SetFocus() - Move input focus (the cursor) to this editbox
EditBox:SetFont("font", size[,"flags"]) - Set the font to use for display.
EditBox:SetHistoryLines() - Set the number of history lines to remember.
EditBox:SetHyperlinksEnabled(enableFlag) (added 3.0.8)
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 (added 1.11)
EditBox:SetNumber(number)
EditBox:SetNumeric(state) - Set if the EditBox only accepts numeric input (added 1.11)
EditBox:SetPassword(state) - Set the EditBox's password masking state (added 1.11)
EditBox:SetText("text") - Set the text contained in the edit box.
EditBox:SetTextInsets(l, r, t, b)
EditBox:ToggleInputLanguage()

GameTooltip Edit

The tooltip automatically resizes itself when its Show() method is called.

GameTooltip:AddDoubleLine(textL, textR, rL, gL, bL, rR, gR, bR)
GameTooltip:AddFontStrings(leftstring, rightstring) - Dynamically expands the size of a tooltip (added 1.11)
GameTooltip:AddLine("tooltipText" [, textColor.r, textColor.g, textColor.b [, wrapText]]) - Appends the new line to the tooltip.
GameTooltip:AddTexture("texture") - Add a texture to the last line added.
GameTooltip:AppendText("text") - Append text to the end of the first line of the tooltip.
GameTooltip:ClearLines() - Clear all lines of tooltip (both left and right ones)
GameTooltip:FadeOut
GameTooltip:GetAnchorType() - Returns the current anchoring type.
GameTooltip:GetItem() - Returns name, link.
GameTooltip:GetMinimumWidth() -
GameTooltip:GetSpell() - Returns name, rank.
GameTooltip:GetOwner() - Returns owner frame, anchor.
GameTooltip:GetUnit() - Returns unit name, unit id.
GameTooltip:IsUnit("unit") - Returns bool.
GameTooltip:NumLines() - Get the number of lines in the tooltip.
GameTooltip:SetAction(slot) - Shows the tooltip for the specified action button.
GameTooltip:SetAuctionCompareItem("type", index[, offset])
GameTooltip:SetAuctionItem("type", index) - Shows the tooltip for the specified auction item.
GameTooltip:SetAuctionSellItem
GameTooltip:SetBackpackToken(id) -
GameTooltip:SetBagItem(bag, slot)
GameTooltip:SetBuybackItem
REMOVED GameTooltip:SetCraftItem (removed 3.0.2)
REMOVED GameTooltip:SetCraftSpell (removed 3.0.2)
GameTooltip:SetCurrencyToken(tokenId) - Shows the tooltip for the specified token
GameTooltip:SetFrameStack(showhidden) - Shows the mouseover frame stack, used for debugging.
GameTooltip:SetGlyph(id) -
GameTooltip:SetGuildBankItem(tab, id) - Shows the tooltip for the specified guild bank item
GameTooltip:SetHyperlink("itemString" or "itemLink") - Changes the item which is displayed in the tooltip according to the passed argument.
GameTooltip:SetHyperlinkCompareItem("itemLink", index) - Sets a comparison tooltip for the index. returns true if comparison. [index 1 .. 3]
GameTooltip:SetInboxItem(index) - Shows the tooltip for the specified mail inbox item.
GameTooltip:SetInventoryItem(unit, slot[, nameOnly])
GameTooltip:SetLootItem
GameTooltip:SetLootRollItem(id) - Shows the tooltip for the specified loot roll item.
GameTooltip:SetMerchantCompareItem("slot"[, offset])
GameTooltip:SetMerchantItem
GameTooltip:SetMinimumWidth(width) - (Formerly SetMoneyWidth)
GameTooltip:SetOwner(owner, "anchor"[, +x, +y])
GameTooltip:SetPadding
GameTooltip:SetPetAction(slot) - Shows the tooltip for the specified pet action.
REMOVED GameTooltip:SetPlayerBuff(buffIndex) - Direct the tooltip to show information about a player's buff. (removed 3.0.2)
GameTooltip:SetQuestItem
GameTooltip:SetQuestLogItem
GameTooltip:SetQuestLogRewardSpell - Shows the tooltip for the spell reward of the currently selected quest.
GameTooltip:SetQuestRewardSpell
GameTooltip:SetSendMailItem
GameTooltip:SetShapeshift(slot) - Shows the tooltip for the specified shapeshift form.
GameTooltip:SetSpell(spellId, bookType) - Shows the tooltip for the specified spell.
GameTooltip:SetTalent(tabIndex, talentIndex) - Shows the tooltip for the specified talent.
GameTooltip:SetText("text", r, g, b[, alphaValue[, textWrap]]) - Set the text of the tooltip.
GameTooltip:SetTracking
GameTooltip:SetTradePlayerItem
GameTooltip:SetTradeSkillItem
GameTooltip:SetTradeTargetItem
GameTooltip:SetTrainerService
GameTooltip:SetUnit
GameTooltip:SetUnitAura("unitId", auraIndex[, filter]) - Shows the tooltip for a unit's aura. (Exclusive to 3.x.x / WotLK)
GameTooltip:SetUnitBuff("unitId", buffIndex[, raidFilter]) - Shows the tooltip for a unit's buff.
GameTooltip:SetUnitDebuff("unitId", buffIndex[, raidFilter]) - Shows the tooltip for a unit's debuff.

MessageFrame Edit

MessageFrame additionally has all of the methods from 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 (added 1.11)
MessageFrame:GetFadeDuration() - Gets the fade duration in seconds (added 1.11)
MessageFrame:GetFading() - Get whether the frame is fading (added 1.11)
MessageFrame:GetInsertMode() - Get the insert mode for the frame (added 1.11)
MessageFrame:GetTimeVisible() - Get the message visibility time in seconds (added 1.11)
MessageFrame:SetFadeDuration(seconds) - Set the fade duration (added 1.11)
MessageFrame:SetFading(status) - Set whether the frame fades messages (added 1.11)
MessageFrame:SetInsertMode("TOP" or "BOTTOM") - Set where new messages are inserted (added 1.11)
MessageFrame:SetTimeVisible(seconds) - Sets the message visibility time (added 1.11)

Minimap Edit

Minimap:GetPingPosition() - Get the last ping location.
Minimap:GetZoom() - Get the current zoom level.
Minimap:GetZoomLevels() - Get the maximum zoom level.
Minimap:PingLocation(x, y) - Perform a ping at the specified location. As of 2.4.2 protected while targeting area of effect spells.
Minimap:SetArrowModel("file") - Set the file to use for the arrow model (added 1.11)
Minimap:SetBlipTexture - Set the file to use for blips (ObjectIcons)
Minimap:SetIconTexture
Minimap:SetMaskTexture
Minimap:SetPlayerModel("file") - Set the file to use for the player model (added 1.11)
Minimap:SetZoom(level) - Set the current zoom level.

Model Edit

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

Model:AdvanceTime()
Model:ClearFog() - Removes all fogging effects currently active in rendering.
Model:ClearModel() - Removes all geometry from the Model, i.e. makes it empty.
Model:GetFacing() - Returns the direction the model is facing.
Model:GetFogColor() - Gets the fog color as r,g,b,a. (added 1.11)
Model:GetFogFar() - Gets the fog far distance (added 1.11)
Model:GetFogNear() - Gets the fog near distance (added 1.11)
Model:GetLight() - Gets the light spec for the model, returns a arg list compatible with SetLight (added 1.11)
Model:GetModel() - Gets the model file for this Model (added 1.11)
Model:GetModelScale() - Returns the current mesh scaling factor.
Model:GetPosition() - Returns the current position of the mesh as x, y, z
Model:ReplaceIconTexture("texture")
Model:SetCamera(index) - Select a pre-defined camera.
Model:SetFacing(facing) - Set the direction that the model is facing.
Model:SetFogColor(r, g, b[, a]) - Set the fog color and enable fogging.
Model:SetFogFar(value) - Set the far-clipping plane distance for fogging.
Model:SetFogNear(value) - Set the near-clipping plane distance for fogging.
Model:SetGlow(..) -
Model:SetLight(enabled[, omni, dirX, dirY, dirZ, ambIntensity[, ambR, ambG, ambB[, dirIntensity[, dirR, dirG, dirB]]]]) - place light source
Model:SetModel("file") - Set the mesh that is displayed in the frame.
Model:SetModelScale(scale) - Sets the scale factor for the mesh before rendering.
Model:SetPosition(x, y, z) - Set the position of the mesh inside the frame's coordinate system.
Model:SetSequence(sequence) - Set the animation to be played.
Model:SetSequenceTime(sequence, time)

ScrollFrame Edit

ScrollFrame:GetHorizontalScroll()
ScrollFrame:GetHorizontalScrollRange()
ScrollFrame:GetScrollChild
ScrollFrame:GetVerticalScroll()
ScrollFrame:GetVerticalScrollRange()
ScrollFrame:SetHorizontalScroll(offset)
ScrollFrame:SetScrollChild
ScrollFrame:SetVerticalScroll(offset)
ScrollFrame:UpdateScrollChildRect() - no longer required after patch 2.3

ScrollingMessageFrame Edit

ScrollingMessageFrame additionally has all of the methods from FontInstance, plus the following:

ScrollingMessageFrame:AddMessage("text"[, r, g, b[, id][, addToStart]]) - Add a message to the frame with an optional color, ID (updated 2.4.2)
ScrollingMessageFrame:AtBottom() - Test whether frame is at the bottom.
ScrollingMessageFrame:AtTop() - Test whether frame is at the top (added 1.11)
ScrollingMessageFrame:Clear() - Clear all lines from the frame.
ScrollingMessageFrame:GetCurrentLine() - Returns the line number that was printed last, starting from 0.
ScrollingMessageFrame:GetCurrentScroll() -- Returns number of messages from the end message, that the user has scrolled.
ScrollingMessageFrame:GetFadeDuration()
ScrollingMessageFrame:GetFading()
ScrollingMessageFrame:GetHyperlinksEnabled() (added 3.0.8)
ScrollingMessageFrame:GetInsertMode() - Gets the current insert mode for a frame. (added 2.3)
ScrollingMessageFrame:GetMaxLines() - Get the maximum number of lines the frame can display.
ScrollingMessageFrame:GetNumLinesDisplayed()
ScrollingMessageFrame:GetNumMessages()
ScrollingMessageFrame:GetTimeVisible()
ScrollingMessageFrame:PageDown()
ScrollingMessageFrame:PageUp()
ScrollingMessageFrame:ScrollDown()
ScrollingMessageFrame:ScrollToBottom()
ScrollingMessageFrame:ScrollToTop()
ScrollingMessageFrame:ScrollUp()
ScrollingMessageFrame:SetFadeDuration(seconds) - Set the fade duration.
ScrollingMessageFrame:SetFading([isEnabled]) - Set whether fading is enabled (renamed 1.11)
ScrollingMessageFrame:SetHyperlinksEnabled(enableFlag) (added 3.0.8)
ScrollingMessageFrame:SetInsertMode("mode") - Sets the location for new strings added to the frame ["TOP", "BOTTOM"] (added 2.3)
ScrollingMessageFrame:SetMaxLines(lines) - Set the maximum number of history lines, and resets the messages already within the frame.
ScrollingMessageFrame:SetScrollOffset(offset) (renamed 2.3)
ScrollingMessageFrame:SetTimeVisible(seconds) - Sets how long lines remain visible.
ScrollingMessageFrame:UpdateColorByID(id, r, g, b)

SimpleHTML Edit

SimpleHTML:GetFont(["element"])
SimpleHTML:GetFontObject(["element"])
SimpleHTML:GetHyperlinkFormat() - Set the string.format format to use for displaying hyperlinks (added 1.11)
SimpleHTML:GetHyperlinksEnabled() (added 3.0.8)
SimpleHTML:GetJustifyH(["element"])
SimpleHTML:GetJustifyV(["element"])
SimpleHTML:GetShadowColor(["element"])
SimpleHTML:GetShadowOffset(["element"])
SimpleHTML:GetSpacing(["element"])
SimpleHTML:GetTextColor(["element"])
SimpleHTML:SetFont(["element",] "path", height[,"flags"])
SimpleHTML:SetFontObject(["element",] fontObject)
SimpleHTML:SetHyperlinkFormat("format") - Set the string.format format to use for displaying hyperlinks.
SimpleHTML:SetHyperlinksEnabled(enableFlag) (added 3.0.8)
SimpleHTML:SetJustifyH(["element",] "justifyH")
SimpleHTML:SetJustifyV(["element",] "justifyV")
SimpleHTML:SetShadowColor(["element",] r, g, b[, a])
SimpleHTML:SetShadowOffset(["element",] x, y)
SimpleHTML:SetSpacing(["element",] lineSpacing)
SimpleHTML:SetText("text") - Set the HTML markup to be displayed (note: if there is any markup error, it will be displayed as plain text)
SimpleHTML:SetTextColor(["element",] r, g, b[, a])

Slider Edit

Slider:Disable() - Disables the slider
Slider:Enable() - Enables the slider
Slider:GetMinMaxValues() - Get the current bounds of the slider.
Slider:GetOrientation() - Returns "HORIZONTAL" or "VERTICAL".
Slider:GetStepsPerPage() - Get the current page step size of the slider. (added 5.4.0)
Slider:GetThumbTexture() - Get the texture for this slider's thumb. (added 1.11.0)
Slider:GetValue() - Get the current value of the slider.
Slider:GetValueStep() - Get the current step size of the slider.
Slider:IsEnabled() - Returns enabled status of the slider.
Slider:SetMinMaxValues(min, max) - Set the bounds of the slider.
Slider:SetOrientation("orientation") - "HORIZONTAL" or "VERTICAL".
Slider:SetStepsPerPage(value) - Set the page step size of the slider. (added 5.4.0)
Slider:SetThumbTexture(texture or "texturePath") Set texture for this slider's thumb. (added 1.11.0)
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 Edit

StatusBar:GetMinMaxValues() - Get the current bounds of the bar.
StatusBar:GetOrientation
StatusBar:GetStatusBarColor
StatusBar:GetStatusBarTexture() - Returns the texture object for the bar
StatusBar:GetValue() - Get the current value of the bar.
StatusBar:SetMinMaxValues(min, max) - Set the bounds of the bar.
StatusBar:SetOrientation("orientation") - "HORIZONTAL" or "VERTICAL".
StatusBar:SetStatusBarColor(r, g, b[, alpha]) - Set the color of the bar.
StatusBar:SetStatusBarTexture("file" or texture[,"layer"]) - Sets the texture of the bar (added 'texture' 1.11)
StatusBar:SetValue(value) - Set the value of the bar.

Button Derivatives Edit

Have all of the methods from UIObject, Region, Frame and Button, plus the following:

CheckButton Edit

CheckButton:GetChecked() - Get the status of the checkbox.
CheckButton:GetCheckedTexture() - Get the texture used for a checked box (added 1.11)
CheckButton:GetDisabledCheckedTexture() - Get the texture used for a disabled checked box (added 1.11)
CheckButton:SetChecked([state]) - Set the status of the checkbox.
CheckButton:SetCheckedTexture(texture) - Set the texture to use for a checked box.
CheckButton:SetDisabledCheckedTexture(texture) - Set the texture to use for a disabled but checked box.

LootButton Edit

LootButton:SetSlot(index) - Set which the item to loot if the button is clicked.

Model Derivatives Edit

Have all of the methods from UIObject, Region, Frame and Model, plus the following:

PlayerModel Edit

PlayerModel:RefreshUnit()
PlayerModel:SetCreature(CreatureId)
PlayerModel:SetRotation(rotationRadians)
PlayerModel:SetUnit("unitId")

PlayerModel Derivatives Edit

Have all of the methods from UIObject, Region, Frame, Model and PlayerModel, plus the following:

DressUpModel Edit

DressUpModel:Dress() - Set the model to reflect the character's current inventory.
DressUpModel:TryOn("item") - Add the specified item to the model.
DressUpModel:Undress() - Set the model to reflect the character without inventory.

TabardModel Edit

TabardModel:CanSaveTabardNow() - Indicate if the tabard can be saved.
TabardModel:CycleVariation(variationIndex, delta)
TabardModel:GetLowerBackgroundFileName
TabardModel:GetLowerEmblemFileName
TabardModel:GetLowerEmblemTexture("textureName")
TabardModel:GetUpperBackgroundFileName
TabardModel:GetUpperEmblemFileName
TabardModel:GetUpperEmblemTexture("textureName")
TabardModel:InitializeTabardColors()
TabardModel:Save() - Save the tabard.

LayeredRegion Derivatives Edit

Have all of the methods from UIObject, Region and LayeredRegion, plus the following:

Texture Edit

Texture:GetBlendMode() - Return the blend mode set by SetBlendMode()
Texture:GetTexCoord() - Gets the 8 texture coordinates that map to the Texture's corners (added 1.11)
REMOVED (3.3.3) Texture:GetTexCoordModifiesRect() - Get the SetTexCoordModifiesRect setting (added 1.11)
Texture:GetTexture() - Gets this texture's current texture path.
Texture:GetVertexColor() - Gets the vertex color for the Texture.
Texture:IsDesaturated() - Gets the desaturation state of this Texture. (added 1.11)
Texture:SetBlendMode("mode") - Set the alphaMode of the texture.
Texture:SetDesaturated(flag) - If should be displayed with no saturation. has a return value.
Texture:SetGradient("orientation", minR, minG, minB, maxR, maxG, maxB)
Texture:SetGradientAlpha("orientation", minR, minG, minB, minA, maxR, maxG, maxB, maxA)
Texture:SetRotation(angle, [,cx, cy]) - Shorthand for the appropriate 8 argument SetTexCoord rotation (in C++ so it's fast)
Texture:SetTexCoord(minX, maxX, minY, maxY or ULx, ULy, LLx, LLy, URx, URy, LRx, LRy) - Set the corner coordinates for texture display.
REMOVED (3.3.3) Texture:SetTexCoordModifiesRect(enableFlag) - if operations modify the rectangle or stretch the texture. (added 1.11)
Texture:SetTexture("texturePath" or r, g, b[, a]) - Sets the texture to be displayed from a file or to a solid color.

FontString Edit

FontString has additional methods from FontInstance, plus the following:

FontString:CanNonSpaceWrap() - Get whether long strings without spaces are wrapped or truncated (added 1.11)
FontString:GetStringHeight() - Returns the height in pixels of the current string in the current font, without line wrapping. (added 2.3)
FontString:GetStringWidth() - Returns the width in pixels of the current string in the current font, without line wrapping.
FontString:GetText() - Get the displayed text.
FontString:SetAlphaGradient(start, length) - Create or remove an alpha gradient over the text.
FontString:SetFormattedText("formatstring"[, ...]) - Set the formatted display text. (added 2.3)
FontString:SetNonSpaceWrap(wrapFlag) - Set whether long strings without spaces are wrapped or truncated.
FontString:SetText("text") - Set the displayed text.
FontString:SetTextHeight(pixelHeight) - Set the height of the text by scaling graphics Note that can distort text.

Special Edit

WorldFrame Edit

WorldFrame is the frame which is used to display 3D world itself. Inherits methods from Frame.

TemplatesEdit

These are nota type per se, but objects generated form XML that can be used as templates UIObject Lua code.

Around Wikia's network

Random Wiki