m
Move page script moved page Widget API to WoW:Widget API without leaving a redirect
(→GameTooltip: Add missing 2.0.3 methods.) |
m (Move page script moved page Widget API to WoW:Widget API without leaving a redirect) |
||
| (43 intermediate revisions by 43 users not shown) | |||
| Line 1: | Line 1: | ||
__NOWYSIWYG__{{widget}} | |||
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. See also [[Widget handlers]] and [[XML UI]]. | |||
''Can click on each the secion heading for Lua class details'' | |||
== Root Widgets == | |||
=== [[UIOBJECT Object|Object]] === | |||
This is an abstract UI object type which cannot actually be created. Is base type for ''all'' types. | |||
: {{id|API|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 UIObject|UIObject]] === | |||
This is an abstract UI object type which cannot actually be created. Is base type for ''all'' widget types. | |||
: {{id|API|UIObject|GetAlpha}}() - Return this object's alpha (transparency) value. | |||
: {{id|API|UIObject|GetName}}() - Return the name of the object. | |||
: {{id|API|UIObject|GetObjectType}}() - Get the type of this object. | |||
: {{id|API|UIObject|IsForbidden}}() - Return bool indicating is secure widget instance. | |||
: {{id|API|UIObject|IsObjectType}}("type") - Determine if this object is of the specified type, or a subclass of that type. | |||
: {{id|API|UIObject|SetAlpha}}(alpha) - Set the object's alpha (transparency) value. | |||
== UIObject Derivatives == | |||
Have all of the methods from [[#UIObject|UIObject]], plus the following: | |||
=== [[UIOBJECT AnimationGroup|AnimationGroup]] === | |||
This manages playback, order, and looping of its child Animations. (added 3.1.0) | |||
: {{id|API|AnimationGroup|Play}}() - Start playing the animations in this group. | |||
: {{id|API|AnimationGroup|Pause}}() - Pause the animations in this group. | |||
: {{id|API|AnimationGroup|Stop}}() - Stop all animations in this group. | |||
: {{id|API|AnimationGroup|Finish}}() - Notify this group to stop playing once the current loop cycle is done. | |||
: {{id|API|AnimationGroup|GetProgress}}() - Returns the progress of this animation as a unit value [0,1]. | |||
: {{id|API|AnimationGroup|IsDone}}() - Returns true if the group has finished playing. | |||
: {{id|API|AnimationGroup|IsPlaying}}() - Returns true if the group is playing. | |||
: {{id|API|AnimationGroup|IsPaused}}() - Returns true if the group is paused. | |||
: {{id|API|AnimationGroup|GetDuration}}() - Gets the total duration for one loop cycle of all child Animations. | |||
: {{id|API|AnimationGroup|SetLooping}}(loopType) - Sets the group loop type [NONE, REPEAT, BOUNCE] | |||
: {{id|API|AnimationGroup|GetLooping}}() - Gets the group loop type. | |||
: {{id|API|AnimationGroup|GetLoopState}}() - Gets the current group loop state [NONE, FORWARD, REVERSE] | |||
: {{id|API|AnimationGroup|CreateAnimation}}("animationType", ["name"[,"inheritsFrom"]]) - Create and return an Animation as a child of this group. | |||
: {{id|API|AnimationGroup|HasScript}}("handler") - Same as Frame:HasScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]. | |||
: {{id|API|AnimationGroup|GetScript}}("handler") - Same as Frame:GetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]. | |||
: {{id|API|AnimationGroup|SetScript}}("handler", function) - Same as Frame:SetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]. | |||
=== [[UIOBJECT Animation|Animation]] === | |||
Is the base animation type for animations in an AnimationGroup. (added 3.1.0) | |||
: {{id|API|Animation|Play}}() - Play the animation. | |||
: {{id|API|Animation|Pause}}() - Pause the animation. | |||
: {{id|API|Animation|Stop}}() - Stop the animation. | |||
: {{id|API|Animation|IsDone}}() - Returns true if the animation has finished playing. | |||
: {{id|API|Animation|IsPlaying}}() - Returns true if the animation is playing. | |||
: {{id|API|Animation|IsPaused}}() - Returns true if the animation is paused. | |||
: {{id|API|Animation|IsStopped}}() - Returns true if the animation is stopped. | |||
: {{id|API|Animation|IsDelaying}}() - Returns true if the animation is in the middle of a start or end delay. | |||
: {{id|API|Animation|GetElapsed}}() - Gets the amount of time in seconds that the animation has been playing for. | |||
: {{id|API|Animation|SetStartDelay}}(delaySec) - Set the seconds that the animation delays before it starts to progress. | |||
: {{id|API|Animation|GetStartDelay}}() - Get the seconds that the animation delays before it starts to progress. | |||
: {{id|API|Animation|SetEndDelay}}(delaySec) - Set the number of seconds the animation delays after finishing. | |||
: {{id|API|Animation|GetEndDelay}}() - Get the number of seconds the animation delays after finishing. | |||
: {{id|API|Animation|SetDuration}}(durationSec) - Set the seconds it takes for the animation to progress from start to finish. | |||
: {{id|API|Animation|GetDuration}}() - Get the seconds it takes for the animation to progress from start to finish. | |||
: {{id|API|Animation|GetProgress}}() - Returns the progress of the animation as a unit value [0,1]. Ignores start and end delay. | |||
: {{id|API|Animation|GetSmoothProgress}}() - Returns a smoothed, [0,1] progress value for the animation. | |||
: {{id|API|Animation|GetProgressWithDelay}}() - Returns the progress of the animation combined with its start and end delay. | |||
: {{id|API|Animation|SetMaxFramerate}}(framerate) - Sets the maximum fps that the animation will update its progress. | |||
: {{id|API|Animation|GetMaxFramerate}}() - Gets the maximum fps that the animation will update its progress. | |||
: {{id|API|Animation|SetOrder}}(order) - Sets the order that the animation plays within its parent group. Range is [1,100]. | |||
: {{id|API|Animation|GetOrder}}() - Gets the order of the animation within its parent group. | |||
: {{id|API|Animation|SetSmoothing}}(smoothType) - Sets the smoothing type for the animation [IN,OUT,IN_OUT,OUT_IN] | |||
: {{id|API|Animation|GetSmoothing}}() - Gets the smoothing type for the animation. | |||
: {{id|API|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. | |||
: {{id|API|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). | |||
: {{id|API|Animation|HasScript}}("handler") - Same as Frame:HasScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate] | |||
: {{id|API|Animation|GetScript}}("handler") - Same as Frame:GetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate] | |||
: {{id|API|Animation|SetScript}}("handler") - Same as Frame:SetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate] | |||
=== [[UIOBJECT FontInstance|FontInstance]] === | |||
This is an abstract object type that provides font related methods. | |||
: {{id|API|FontInstance|GetFont}}() - Return the font file, height, and flags. | |||
: {{id|API|FontInstance|GetFontObject}}() - Return the 'parent' Font object, or nil if none. | |||
: {{id|API|FontInstance|GetJustifyH}}() - Return the horizontal text justification. | |||
: {{id|API|FontInstance|GetJustifyV}}() - Return thevertical text justification. | |||
: {{id|API|FontInstance|GetShadowColor}}() - Returns the color of text shadow (r, g, b, a). | |||
: {{id|API|FontInstance|GetShadowOffset}}() - Returns the text shadow offset (x, y). | |||
: {{id|API|FontInstance|GetSpacing}}() - Returns the text spacing. | |||
: {{id|API|FontInstance|GetTextColor}}() - Returns the default text color. | |||
: {{id|API|FontInstance|SetFont}}("path", height[,"flags"]) - Sets the font to use for text, returns 1 if the path was valid, nil otherwise (no change occurs). | |||
: {{id|API|FontInstance|SetFontObject}}(fontObject) - Sets the 'parent' Font object from which this object inherits properties. | |||
: {{id|API|FontInstance|SetJustifyH}}("justifyH") - Sets horizontal text justification ("LEFT","RIGHT", or "CENTER") | |||
: {{id|API|FontInstance|SetJustifyV}}("justifyV") - Sets vertical text justification ("TOP","BOTTOM", or "MIDDLE") | |||
: {{id|API|FontInstance|SetShadowColor}}(r, g, b[, a]) - Sets the text shadow color. | |||
: {{id|API|FontInstance|SetShadowOffset}}(x, y) - Sets the text shadow offset. | |||
: {{id|API|FontInstance|SetSpacing}}(spacing) - Sets the spacing between lines of text in the object. | |||
: {{id|API|FontInstance|SetTextColor}}(r, g, b[, a]) - Sets the default text color. | |||
=== [[UIOBJECT Region|Region]] === | |||
This is an abstract object type which cannot actually be created. Defines a potentially visible area. | |||
: {{id|API|Region|ClearAllPoints}}() - Clear all attachment points for this object. | |||
: {{id|API|Region|CreateAnimationGroup}}(["name"[,"inheritsFrom"]]) - Create and return a new AnimationGroup as a child of this Region. (added 3.1.0) | |||
: {{id|API|Region|GetAnimationGroups}}() - Returns all AnimationGroups that are children of this Region. (added 3.1.0) | |||
: {{id|API|Region|GetBottom}}() - Get the y location of the bottom edge of this frame - Moved in 1.10. | |||
: {{id|API|Region|GetCenter}}() - Get the coordinates of the center of this frame - Moved in 1.10. | |||
: {{id|API|Region|GetHeight}}() - Get the height of this object. | |||
: {{id|API|Region|GetLeft}}() - Get the x location of the left edge of this frame - Moved in 1.10. | |||
: {{id|API|Region|GetNumPoints}}() - Get the number of anchor points for this frame (added 1.10) | |||
: {{id|API|Region|GetPoint}}(pointNum) - Get details for an anchor point for this frame (point, relativeTo, relativePoint, xofs, yofs) (added 1.10) | |||
: {{id|API|Region|GetRect}}() - Get frame's left, bottom, width, height. | |||
: {{id|API|Region|GetRight}}() - Get the x location of the right edge of this frame - Moved in 1.10. | |||
: {{id|API|Region|GetSize}}() - Get the width and height of the frame | |||
: {{id|API|Region|GetTop}}() - Get the y location of the top edge of this frame - Moved in 1.10. | |||
: {{id|API|Region|GetWidth}}() - Get the width of this object. | |||
: {{id|API|Region|Hide}}() - Set this object to hidden (it and all of its children will disappear). | |||
: {{id|API|Region|IsDragging}}() - True if this Region or its Parent is being dragged. (added 3.1.0) | |||
: {{id|API|Region|IsProtected}}() - Determine if this object can be manipulated in certain ways by tainted code in combat or not | |||
: {{id|API|Region|IsShown}}() - Determine if this object is shown (would be visible if its parent was visible). | |||
: {{id|API|Region|IsVisible}}() - Get whether the object is visible on screen (logically (IsShown() and GetParent():IsVisible())); | |||
: {{id|API|Region|SetAllPoints}}(frame or "frameName") - Set all anchors to match edges of specified frame - Moved in 1.10. | |||
: {{id|API|Region|SetHeight}}(height) - Set the height of the object. | |||
: {{id|API|Region|SetParent}}(parent or "parentName") - Set the parent for this frame - Moved in 1.10. | |||
: {{id|API|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 | |||
: {{id|API|Region|SetSize}}(width, height) - Set the region's width and height | |||
: {{id|API|Region|SetWidth}}(width) - Set the width of the object. | |||
: {{id|API|Region|Show}}() - Set this object to shown (it will appear if its parent is visible). | |||
: {{id|API|Region|StopAnimating}}() - Stops any active animations on the Region and its children. (added 3.1.0) | |||
== Animation Derivatives == | |||
Have all of the methods of [[#UIObject|UIObject]] and [[#Animation|Animation]], plus the following: | |||
=== [[UIOBJECT Alpha|Alpha]] === | |||
This animation changes the alpha value of its parent region. | |||
: {{id|API|Alpha|SetChange}}(change) - Sets the amount that the alpha value of this animation's parent Region changes by. | |||
: {{id|API|Alpha|GetChange}}() - Gets the amount that the alpha value of this animation's parent Region changes by. | |||
=== [[UIOBJECT Path|Path]] === | |||
This animation combines multiple animation translations. | |||
: {{id|API|Path|CreateControlPoint}}(["name" [, "template" [, order]]]) - Adds a new path control point. | |||
: {{id|API|Path|GetControlPoints}}() - Returns an arg list of current path control points. | |||
: {{id|API|Path|GetCurve}}() - Returns the path 'curveType'. | |||
: {{id|API|Path|GetMaxOrder}}() - Returns highest 'orderId' currently set for any of the control points . | |||
: {{id|API|Path|SetCurve}}("curveType") - Sets the path 'curveType'. | |||
=== [[UIOBJECT Rotation|Rotation]] === | |||
This is an affine transformation that rotates a parent Region about an origin. | |||
: {{id|API|Rotation|SetDegrees}}(degrees) - Sets the amount of degrees that the animation's parent Region would rotate. | |||
: {{id|API|Rotation|GetDegrees}}() - Gets the amount of degrees that the animation's parent Region would rotate. | |||
: {{id|API|Rotation|SetRadians}}(radians) - Sets the amount of radians that the animation's parent Region would travel. | |||
: {{id|API|Rotation|GetRadians}}() - Gets the amount of radians that the animation's parent Region would travel. | |||
: {{id|API|Rotation|SetOrigin}}(point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region. | |||
: {{id|API|Rotation|GetOrigin}}() - Gets the point, Xoffset, and Yoffset for animation's rotation origin in its parent Region. | |||
=== [[UIOBJECT Scale|Scale]] === | |||
This is an affine transformation that scales a parent Region about an origin. The scale can be non-uniform. | |||
: {{id|API|Scale|SetScale}}(x, y) - Sets the X scalar and the Y scalar that the animation's parent Region should scale by. | |||
: {{id|API|Scale|GetScale}}() - Gets the X scalar and the Y scalar that the animation's parent Region should scale by. | |||
: {{id|API|Scale|SetOrigin}}(point, offsetX, offsetY) - Sets the animation's origin of rotation for its parent Region. | |||
: {{id|API|Scale|GetOrigin}}() - Gets the point, X offset, and Y offset of the animation's origin of rotation for its parent Region. | |||
=== [[UIOBJECT Translation|Translation]] === | |||
This is an affine transformation that moves a parent [[#Region|Region]] by an offset. | |||
: {{id|API|Translation|SetOffset}}(x, y) - Sets the offset that the animation's parent Region would travel. | |||
: {{id|API|Translation|GetOffset}}() - Gets the offset that the animation's parent Region would travel. | |||
== FontInstance Derivatives == | |||
Have 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) | |||
: {{id|API|Font|CopyFontObject}}(otherFont) - Set this Font's attributes to be a copy of the otherFont font object's. | |||
== Region Derivatives == | |||
Have all of the methods from [[#UIObject|UIObject]] and [[#Region|Region]], plus the following: | |||
=== [[UIOBJECT Frame|Frame]] === | |||
: {{id|API|Frame|CreateFontString}}(["name"[,"[[layer]]"[,"inheritsFrom"]]]) - Create and return FontString as a child of this Frame (added 'InheritsFrom' 1.11) | |||
: {{id|API|Frame|CreateTexture}}(["name"[,"[[layer]]"]][,"inheritsFrom"]) - Create and return Texture as a child of this Frame. Good for solid colors. - (added 'InheritsFrom' 1.11) | |||
: {{id|API|Frame|CreateTitleRegion}}() - Create a title region for the frame if it does not have one. (added 1.11) | |||
: {{id|API|Frame|DisableDrawLayer}}("[[layer]]") - Disable rendering of "regions" (fontstrings, textures) in the specified draw layer. | |||
: {{id|API|Frame|EnableDrawLayer}}("[[layer]]") - Enable rendering of "regions" (fontstrings, textures) in the specified draw layer. | |||
: {{id|API|Frame|EnableKeyboard}}(enableFlag) - Set whether this frame will get keyboard input. | |||
: {{id|API|Frame|EnableMouse}}(enableFlag) - Set whether this frame will get mouse input. | |||
: {{id|API|Frame|EnableMouseWheel}}(enableFlag) - Set whether this frame will get mouse wheel notifications. | |||
: {{id|API|Frame|GetAttribute}}(prefix, name, suffix) - Returns the first existing attribute of (prefix..name..suffix), ("*"..name..suffix), (prefix..name.."*"), ("*"..name.."*"), (name). | |||
: {{id|API|Frame|GetBackdrop}}() - Creates and returns a backdrop table suitable for use in SetBackdrop (added 1.11) | |||
: {{id|API|Frame|GetBackdropBorderColor}}() - Gets the frame's backdrop border color (r, g, b, a) (added 1.11) | |||
: {{id|API|Frame|GetBackdropColor}}() - Gets the frame's backdrop color (r, g, b, a) (added 1.11) | |||
: {{id|API|Frame|GetChildren}}() - Get the list of "children" (frames and things derived from frames) of this frame. | |||
: {{id|API|Frame|GetClampRectInsets}}() - Gets the modifiers to the frame's rectangle used for clamping the frame to screen. | |||
: {{id|API|Frame|GetDepth}}() (added 3.0.8) | |||
: {{id|API|Frame|GetEffectiveAlpha}}() - Returns the effective alpha of a frame. (added 2.1) | |||
: {{id|API|Frame|GetEffectiveDepth}}() (added 3.0.8) | |||
: {{id|API|Frame|GetEffectiveScale}}() - Get the scale factor of this object relative to the root window. | |||
: {{id|API|Frame|GetFrameLevel}}() - Get the level of this frame. | |||
: {{id|API|Frame|GetFrameStrata}}() - Get the strata of this frame. | |||
: {{id|API|Frame|GetFrameType}}() - Get the type of this frame. | |||
: {{id|API|Frame|GetHitRectInsets}}() - Gets the frame's hit rectangle inset distances (l, r, t, b) (added 1.11) | |||
: {{id|API|Frame|GetID}}() - Get the ID of this frame. | |||
: {{id|API|Frame|GetMaxResize}}() - Gets the frame's maximum allowed resize bounds (w, h) (added 1.11) | |||
: {{id|API|Frame|GetMinResize}}() - Gets the frame's minimum allowed resize bounds (w, h) (added 1.11) | |||
: {{id|API|Frame|GetNumChildren}}() - Get the number of "children" (frames and things derived from frames) this frame has. | |||
: {{id|API|Frame|GetNumRegions}}() - Return the number of "regions" (fontstrings, textures) belonging to this frame. | |||
: {{id|API|Frame|GetRegions}}() - Return the "regions" (fontstrings, textures) of the frame (multiple return values) belonging to this frame. | |||
: {{id|API|Frame|GetScale}}() - Get the scale factor of this object relative to its parent. | |||
: {{id|API|Frame|GetScript}}("handler") - Get the function for one of this frame's handlers. | |||
: {{id|API|Frame|GetTitleRegion}}() - Return the frame's title region (added 1.11) | |||
: {{id|API|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) | |||
: {{id|API|Frame|HookScript}}("handler", function) - Hook a secure frame script. - Since 2.1. | |||
: {{id|API|Frame|IgnoreDepth}}(ignoreFlag) (added 3.0.8) | |||
: {{id|API|Frame|IsClampedToScreen}}() - Gets whether the frame is prohibited from being dragged off screen (added 1.11) | |||
: {{id|API|Frame|IsEventRegistered}}("event") - Returns true if the given event is registered to the frame. (added 2.3) | |||
: {{id|API|Frame|IsFrameType}}("type") - Determine if this frame is of the specified type, or a subclass of that type. | |||
: {{id|API|Frame|IsIgnoringDepth}}() (added 3.0.8) | |||
: {{id|API|Frame|IsKeyboardEnabled}}() - Get whether this frame will get keyboard input. (added 1.11) | |||
: {{id|API|Frame|IsMouseEnabled}}() - Get whether this frame will get mouse input. (added 1.11) | |||
: {{id|API|Frame|IsMouseWheelEnabled}}() - Get whether this frame will get mouse wheel notifications. (added 1.11) | |||
: {{id|API|Frame|IsMovable}}() - Determine if the frame can be moved. | |||
: {{id|API|Frame|IsResizable}}() - Determine if the frame can be resized. | |||
: {{id|API|Frame|IsToplevel}}() - Get whether the frame is set as toplevel (added 1.10.2) | |||
: {{id|API|Frame|IsUserPlaced}}() - Determine if this frame has been relocated by the user. | |||
: {{id|API|Frame|Lower}}() - Lower this frame behind other frames. | |||
: {{id|API|Frame|Raise}}() - Raise this frame above other frames. | |||
: {{id|API|Frame|RegisterAllEvents}}() - Register this frame to receive all events (For debugging purposes only!) (added 1.11) | |||
: {{id|API|Frame|RegisterEvent}}("event") - Indicate that this frame should be notified when event occurs. | |||
: {{id|API|Frame|RegisterForDrag}}("buttonType"[,"buttonType"...]) - Inidicate that this frame should be notified of drag events for the specified buttons. | |||
: {{id|API|Frame|SetBackdrop}}([backdropTable]) - Set the backdrop of the frame according to the specification provided. | |||
: {{id|API|Frame|SetBackdropBorderColor}}(r, g, b[, a]) - Set the frame's backdrop's border's color. | |||
: {{id|API|Frame|SetBackdropColor}}(r, g, b[, a]) - Set the frame's backdrop color. | |||
: {{id|API|Frame|SetClampedToScreen}}(clamped) - Set whether the frame is prohibited from being dragged off screen (added 1.11) | |||
: {{id|API|Frame|SetClampRectInsets}}(left, right, top, bottom) - Modify the frame's rectangle used to prevent dragging offscreen. | |||
: {{id|API|Frame|SetDepth}}(depth) (added 3.0.8) | |||
: {{id|API|Frame|SetFrameLevel}}(level) - Set the level of this frame (determines which of overlapping frames shows on top). | |||
: {{id|API|Frame|SetFrameStrata}}("strata") - Set the strata of this frame. | |||
: {{id|API|Frame|SetHitRectInsets}}(left, right, top, bottom) - Set the inset distances for the frame's hit rectangle (added 1.11) | |||
: {{id|API|Frame|SetID}}(id) - Set the ID of this frame. | |||
: {{id|API|Frame|SetMaxResize}}(maxWidth, maxHeight) - Set the maximum dimensions this frame can be resized to. | |||
: {{id|API|Frame|SetMinResize}}(minWidth, minHeight) - Set the minimum dimensions this frame can be resized to. | |||
: {{id|API|Frame|SetMovable}}(isMovable) - Set whether the frame can be moved. | |||
: {{id|API|Frame|SetResizable}}(isResizable) - Set whether the frame can be resized. | |||
: {{id|API|Frame|SetScale}}(scale) - Set the scale factor of this frame relative to its parent. | |||
: {{id|API|Frame|SetScript}}("handler", function) - Set the function to use for a handler on this frame. | |||
: {{id|API|Frame|SetToplevel}}(isTopLevel) - Set whether the frame should raise itself when clicked (added 1.10.2) | |||
: {{id|API|Frame|SetUserPlaced}}(isUserPlaced) - Set whether the frame has been relocated by the user, and will thus be saved in the layout cache. | |||
: {{id|API|Frame|StartMoving}}() - Start moving this frame. | |||
: {{id|API|Frame|StartSizing}}("point") - Start sizing this frame using the specified anchor point. | |||
: {{id|API|Frame|StopMovingOrSizing}}() - Stop moving and/or sizing this frame. | |||
: {{id|API|Frame|UnregisterAllEvents}}() - Indicate that this frame should no longer be notified when any events occur. | |||
: {{id|API|Frame|UnregisterEvent}}("event") - Indicate that this frame should no longer be notified when event occurs. | |||
=== [[UIOBJECT LayeredRegion|LayeredRegion]] === | |||
An abstract type for objects that represent a potentially visible area defined in a layer. | |||
: {{id|API|LayeredRegion|GetDrawLayer}}() - Returns the [[Layer|draw layer]] for the Region (added 1.10) | |||
: {{id|API|LayeredRegion|SetDrawLayer}}("layer") - Sets the [[Layer|draw layer]] for the Region (added 1.10) | |||
: {{id|API|LayeredRegion|SetVertexColor}}(r, g, b[, alpha]) | |||
== Frame Derivatives == | |||
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#Frame|Frame]], plus the following: | |||
=== [[UIOBJECT Button|Button]] === | |||
: {{id|API|Button|Click}}() - Execute the click action of the button. | |||
: {{id|API|Button|Disable}}() - Disable the Button so that it cannot be clicked. | |||
: {{id|API|Button|Enable}}() - Enable to the Button so that it may be clicked. | |||
: {{id|API|Button|GetButtonState}}() - Return the current state ("PUSHED","NORMAL") of the Button. | |||
: {{id|API|Button|GetDisabledFontObject}}() - Return the font object for the Button when disabled (added 1.10) | |||
: REMOVED {{id|API|Button|GetDisabledTextColor}}() - Get the color of this button's text when disabled (r, g, b, a) (added 1.11)(removed 3.0.2) | |||
: {{id|API|Button|GetDisabledTexture}}() - Get the texture for this button when disabled (added 1.11) | |||
: REMOVED {{id|API|Button|GetFont}}() - Returns the font, size, and flags currently used for display on the Button. (removed 3.0.2) | |||
: {{id|API|Button|GetFontString}}() - Get this button's label FontString (added 1.11) | |||
: {{id|API|Button|GetHighlightFontObject}}() - Return the font object for the Button when highlighted (added 1.10) | |||
: REMOVED {{id|API|Button|GetHighlightTextColor}}() - Get the color of this button's text when highlighted (r, g, b, a) (added 1.11)(removed 3.0.2) | |||
: {{id|API|Button|GetHighlightTexture}}() - Get the texture for this button when highlighted (added 1.11) | |||
: {{id|API|Button|GetNormalTexture}}() - Get the normal texture for this button (added 1.11) | |||
: {{id|API|Button|GetNormalFontObject}}() - Get the Normal Font Object of the button (added 3.0.0) | |||
: {{id|API|Button|GetPushedTextOffset}}() - Get the text offset when this button is pushed (x, y) (added 1.11) | |||
: {{id|API|Button|GetPushedTexture}}() - Get the texture for this button when pushed (added 1.11) | |||
: {{id|API|Button|GetText}}() - Get the text label for the Button. | |||
: REMOVED {{id|API|Button|GetTextColor}}() - Get the normal color of this button's text (r, g, b, a) (added 1.11) (removed 3.0.2) | |||
: REMOVED {{id|API|Button|GetTextFontObject}}() - Return the font object for the Button's normal text (added 1.10)(removed 3.0.2) | |||
: {{id|API|Button|GetTextHeight}}() - Get the height of the Button's text. | |||
: {{id|API|Button|GetTextWidth}}() - Get the width of the Button's text. | |||
: {{id|API|Button|IsEnabled}}() - Determine whether the Button is enabled. | |||
: {{id|API|Button|LockHighlight}}() - Set the Button to always be drawn highlighted. | |||
: {{id|API|Button|RegisterForClicks}}("clickType"[,"clickType"...]) - Specify which mouse button up/down actions cause receive an OnClick notification. | |||
: {{id|API|Button|SetButtonState}}("state"[, lock]) - Set the state of the Button ("PUSHED", "NORMAL") and whether it is locked. | |||
: {{id|API|Button|SetDisabledFontObject}}([font]) - Set the font object for settings when disabled (added 1.10) | |||
: REMOVED {{id|API|Button|SetDisabledTextColor}}(r, g, b[, a]) - Set the disabled text color for the Button. (removed 4.0.1) | |||
: {{id|API|Button|SetDisabledTexture}}(texture or "texturePath") - Set the disabled texture for the Button (updated in 1.10) | |||
: {{id|API|Button|SetFont}}("font", size[,"flags"]) - Set the font to use for display. | |||
: {{id|API|Button|SetFontString}}(fontString) - Set the button's label FontString (added 1.11) | |||
: {{id|API|Button|SetFormattedText}}("formatstring"[, ...]) - Set the formatted text label for the Button. (added 2.3) | |||
: {{id|API|Button|SetHighlightFontObject}}([font]) - Set the font object for settings when highlighted (added 1.10) | |||
: REMOVED {{id|API|Button|SetHighlightTextColor}}(r, g, b[, a]) - Set the highlight text color for the Button. (removed 4.0.1) | |||
: {{id|API|Button|SetHighlightTexture}}(texture or "texturePath"[,alphaMode]) - Set the highlight texture for the Button (updated in 1.10) | |||
: {{id|API|Button|SetNormalTexture}}(texture or "texturePath") - Set the normal texture for the Button (updated in 1.10) | |||
: {{id|API|Button|SetNormalFontObject}}(FontString) - Replaces SetTextFontObject (updated in 3.0) | |||
: {{id|API|Button|SetPushedTextOffset}}(x, y) - Set the text offset for this button when pushed (added 1.11) | |||
: {{id|API|Button|SetPushedTexture}}(texture or "texturePath") - Set the pushed texture for the Button (updated in 1.10) | |||
: {{id|API|Button|SetText}}("text") - Set the text label for the Button. | |||
: REMOVED {{id|API|Button|SetTextColor}}(r, g, b) - Set the text color for the Button. (removed 3.0.2) | |||
: REMOVED {{id|API|Button|SetTextFontObject}}([font]) - Set the font object to get settings from for this Button's normal state (added 1.10)(removed 3.0.2) | |||
: {{id|API|Button|UnlockHighlight}}() - Set the Button to not always be drawn highlighted. | |||
=== [[UIOBJECT Cooldown|Cooldown]] === | |||
: {{id|API|Cooldown|GetReverse}}() - returns true or false | |||
: {{id|API|Cooldown|SetCooldown}}(Start, Duration) | |||
: {{id|API|Cooldown|SetReverse}}(boolean) | |||
=== [[UIOBJECT ColorSelect|ColorSelect]] === | |||
: {{id|API|ColorSelect|GetColorHSV}}() - Get the HSV values of the selected color. | |||
: {{id|API|ColorSelect|GetColorRGB}}() - Get the RGB values of the selected color. | |||
: {{id|API|ColorSelect|GetColorValueTexture}}() - Get the texture used to show color value (added 1.11) | |||
: {{id|API|ColorSelect|GetColorValueThumbTexture}}() - Get the texture for the color value thumb (added 1.11) | |||
: {{id|API|ColorSelect|GetColorWheelTexture}}() - Get the texture for the color wheel (added 1.11) | |||
: {{id|API|ColorSelect|GetColorWheelThumbTexture}}() - Get the texture for the color wheel thumb (added 1.11) | |||
: {{id|API|ColorSelect|SetColorHSV}}(h, s, v) - Set to a specific HSV color. | |||
: {{id|API|ColorSelect|SetColorRGB}}(r, g, b) - Set to a specific RGB color. | |||
: {{id|API|ColorSelect|SetColorValueTexture}}(texture or nil) - Set the texture used to show color value (added 1.11) | |||
: {{id|API|ColorSelect|SetColorValueThumbTexture}}(texture or "texture" or nil) - Set the texture for the color value thumb (added 1.11) | |||
: {{id|API|ColorSelect|SetColorWheelTexture}}(texture or nil) - Set the texture for the color wheel (added 1.11) | |||
: {{id|API|ColorSelect|SetColorWheelThumbTexture}}(texture or "texture" or nil) - Set the texture for the color wheel thumb (added 1.11) | |||
=== [[UIOBJECT EditBox|EditBox]] === | |||
EditBox additionally has all of the methods from [[#FontInstance|FontInstance]], plus the following: | |||
: {{id|API|EditBox|AddHistoryLine}}("text") - Add text to the edit history. | |||
: {{id|API|EditBox|ClearFocus}}() | |||
: {{id|API|EditBox|GetAltArrowKeyMode}}() - Return whether only alt+arrow keys work for navigating the edit box, not arrow keys alone. | |||
: {{id|API|EditBox|GetBlinkSpeed}}() - Gets the blink speed of the EditBox in seconds (added 1.11) | |||
: {{id|API|EditBox|GetCursorPosition}}() - Gets the position of the cursor inside the EditBox (added 2.3) | |||
: {{id|API|EditBox|GetHistoryLines}}() - Get the number of history lines for this edit box | |||
: {{id|API|EditBox|GetHyperlinksEnabled}}() (added 3.0.8) | |||
: {{id|API|EditBox|GetInputLanguage}}() - Get the input language. locale based, not in-game. | |||
: {{id|API|EditBox|GetMaxBytes}}() - Gets the maximum number bytes allowed in the EditBox (added 1.11) | |||
: {{id|API|EditBox|GetMaxLetters}}() - Gets the maximum number of letters allowed in the EditBox (added 1.11) | |||
: {{id|API|EditBox|GetNumLetters}}() - Gets the number of letters in the box. | |||
: {{id|API|EditBox|GetNumber}}() | |||
: {{id|API|EditBox|GetText}}() - Get the current text contained in the edit box. | |||
: {{id|API|EditBox|GetTextInsets}}() - Gets the text display insets for the EditBox (added 1.11) | |||
: {{id|API|EditBox|HighlightText}}([startPos, endPos]) - Set the highlight to all or some of the edit box text. | |||
: {{id|API|EditBox|Insert}}("text") - Insert text into the edit box. | |||
: {{id|API|EditBox|IsAutoFocus}}() - Determine if the EditBox has autofocus enabled (added 1.11) | |||
: {{id|API|EditBox|IsMultiLine}}() - Determine if the EditBox accepts multiple lines (added 1.11) | |||
: {{id|API|EditBox|IsNumeric}}() - Determine if the EditBox only accepts numeric input (added 1.11) | |||
: {{id|API|EditBox|IsPassword}}() - Determine if the EditBox performs password masking (added 1.11) | |||
: {{id|API|EditBox|SetAltArrowKeyMode}}(enable) - Make only alt+arrow keys work for navigating the edit box, not arrow keys alone. | |||
: {{id|API|EditBox|SetAutoFocus}}(state) - Set whether or not the editbox will attempt to get input focus when it gets shown. default: true (added 1.11) | |||
: {{id|API|EditBox|SetBlinkSpeed}} | |||
: {{id|API|EditBox|SetCursorPosition}}(position) - Set the position of the cursor within the EditBox (added 2.3) | |||
: {{id|API|EditBox|SetFocus}}() - Move input focus (the cursor) to this editbox | |||
: {{id|API|EditBox|SetFont}}("font", size[,"flags"]) - Set the font to use for display. | |||
: {{id|API|EditBox|SetHistoryLines}}() - Set the number of history lines to remember. | |||
: {{id|API|EditBox|SetHyperlinksEnabled}}(enableFlag) (added 3.0.8) | |||
: {{id|API|EditBox|SetMaxBytes}}(maxBytes) - Set the maximum byte size for entered text. | |||
: {{id|API|EditBox|SetMaxLetters}}(maxLetters) - Set the maximum number of letters for entered text. | |||
: {{id|API|EditBox|SetMultiLine}}(state) - Set the EditBox's multi-line state (added 1.11) | |||
: {{id|API|EditBox|SetNumber}}(number) | |||
: {{id|API|EditBox|SetNumeric}}(state) - Set if the EditBox only accepts numeric input (added 1.11) | |||
: {{id|API|EditBox|SetPassword}}(state) - Set the EditBox's password masking state (added 1.11) | |||
: {{id|API|EditBox|SetText}}("text") - Set the text contained in the edit box. | |||
: {{id|API|EditBox|SetTextInsets}}(l, r, t, b) | |||
: {{id|API|EditBox|ToggleInputLanguage}}() | |||
=== [[UIOBJECT GameTooltip|GameTooltip]] === | |||
The tooltip automatically resizes itself when its Show() method is called. | |||
: {{id|API|GameTooltip|AddDoubleLine}}(textL, textR, rL, gL, bL, rR, gR, bR) | |||
: {{id|API|GameTooltip|AddFontStrings}}(leftstring, rightstring) - Dynamically expands the size of a tooltip (added 1.11) | |||
: {{id|API|GameTooltip|AddLine}}("text" [, red, green, blue [, wrapText]]) - Appends a new line to the tooltip. | |||
: {{id|API|GameTooltip|AddTexture}}("texture") - Add a texture to the last line added. | |||
: {{id|API|GameTooltip|AppendText}}("text") - Append text to the end of the first line of the tooltip. | |||
: {{id|API|GameTooltip|ClearLines}}() - Clear all lines of tooltip (both left and right ones) | |||
: {{id|API|GameTooltip|FadeOut}} | |||
: {{id|API|GameTooltip|GetAnchorType}}() - Returns the current anchoring type. | |||
: {{id|API|GameTooltip|GetItem}}() - Returns name, link. | |||
: {{id|API|GameTooltip|GetMinimumWidth}}() - | |||
: {{id|API|GameTooltip|GetSpell}}() - Returns name, rank. | |||
: {{id|API|GameTooltip|GetOwner}}() - Returns owner frame, anchor. | |||
: {{id|API|GameTooltip|GetUnit}}() - Returns unit name, unit id. | |||
: {{id|API|GameTooltip|IsUnit}}("unit") - Returns bool. | |||
: {{id|API|GameTooltip|NumLines}}() - Get the number of lines in the tooltip. | |||
: {{id|API|GameTooltip|SetAction}}(slot) - Shows the tooltip for the specified action button. | |||
: {{id|API|GameTooltip|SetAuctionCompareItem}}("type", index[, offset]) | |||
: {{id|API|GameTooltip|SetAuctionItem}}("type", index) - Shows the tooltip for the specified auction item. | |||
: {{id|API|GameTooltip|SetAuctionSellItem}} | |||
: {{id|API|GameTooltip|SetBackpackToken}}(id) - | |||
: {{id|API|GameTooltip|SetBagItem}}(bag, slot) | |||
: {{id|API|GameTooltip|SetBuybackItem}} | |||
: REMOVED {{id|API|GameTooltip|SetCraftItem}} (removed 3.0.2) | |||
: REMOVED {{id|API|GameTooltip|SetCraftSpell}} (removed 3.0.2) | |||
: {{id|API|GameTooltip|SetCurrencyToken}}(tokenId) - Shows the tooltip for the specified token | |||
: {{id|API|GameTooltip|SetFrameStack}}(showhidden) - Shows the mouseover frame stack, used for debugging. | |||
: {{id|API|GameTooltip|SetGlyph}}(id) - | |||
: {{id|API|GameTooltip|SetGuildBankItem}}(tab, id) - Shows the tooltip for the specified guild bank item | |||
: {{id|API|GameTooltip|SetHyperlink}}("itemString" or "itemLink") - Changes the item which is displayed in the tooltip according to the passed argument. | |||
: {{id|API|GameTooltip|SetHyperlinkCompareItem}}("itemLink", index) - Sets a comparison tooltip for the index. returns true if comparison. [index 1 .. 3] | |||
: {{id|API|GameTooltip|SetInboxItem}}(index) - Shows the tooltip for the specified mail inbox item. | |||
: {{id|API|GameTooltip|SetInventoryItem}}(unit, slot[, nameOnly]) | |||
: {{id|API|GameTooltip|SetLootItem}} | |||
: {{id|API|GameTooltip|SetLootRollItem}}(id) - Shows the tooltip for the specified loot roll item. | |||
: {{id|API|GameTooltip|SetMerchantCompareItem}}("slot"[, offset]) | |||
: {{id|API|GameTooltip|SetMerchantItem}} | |||
: {{id|API|GameTooltip|SetMinimumWidth}}(width) - (Formerly SetMoneyWidth) | |||
: {{id|API|GameTooltip|SetOwner}}(owner, "anchor"[, +x, +y]) | |||
: {{id|API|GameTooltip|SetPadding}} | |||
: {{id|API|GameTooltip|SetPetAction}}(slot) - Shows the tooltip for the specified pet action. | |||
: REMOVED {{id|API|GameTooltip|SetPlayerBuff}}(buffIndex) - Direct the tooltip to show information about a player's buff. (removed 3.0.2) | |||
: {{id|API|GameTooltip|SetQuestItem}} | |||
: {{id|API|GameTooltip|SetQuestLogItem}} | |||
: {{id|API|GameTooltip|SetQuestLogRewardSpell}} - Shows the tooltip for the spell reward of the currently selected quest. | |||
: {{id|API|GameTooltip|SetQuestRewardSpell}} | |||
: {{id|API|GameTooltip|SetSendMailItem}} | |||
: {{id|API|GameTooltip|SetShapeshift}}(slot) - Shows the tooltip for the specified shapeshift form. | |||
: {{id|API|GameTooltip|SetSpell}}(spellId, bookType) - Shows the tooltip for the specified spell. | |||
: {{id|API|GameTooltip|SetTalent}}(tabIndex, talentIndex) - Shows the tooltip for the specified talent. | |||
: {{id|API|GameTooltip|SetText}}("text"[, red, green, blue[, alpha[, textWrap]]]) - Set the text of the tooltip. | |||
: {{id|API|GameTooltip|SetTracking}} | |||
: {{id|API|GameTooltip|SetTradePlayerItem}} | |||
: {{id|API|GameTooltip|SetTradeSkillItem}} | |||
: {{id|API|GameTooltip|SetTradeTargetItem}} | |||
: {{id|API|GameTooltip|SetTrainerService}} | |||
: {{id|API|GameTooltip|SetUnit}} | |||
: {{id|API|GameTooltip|SetUnitAura}}("[[unitId]]", auraIndex[, filter]) - Shows the tooltip for a unit's aura. (Exclusive to 3.x.x / WotLK) | |||
: {{id|API|GameTooltip|SetUnitBuff}}("[[unitId]]", buffIndex[, raidFilter]) - Shows the tooltip for a unit's buff. | |||
: {{id|API|GameTooltip|SetUnitDebuff}}("[[unitId]]", buffIndex[, raidFilter]) - Shows the tooltip for a unit's debuff. | |||
=== [[UIOBJECT MessageFrame|MessageFrame]] === | |||
MessageFrame additionally has all of the methods from [[#FontInstance|FontInstance]], plus the following: | |||
: {{id|API|MessageFrame|AddMessage}}("text", r, g, b, messageGroup, holdTime) - Add a message to the frame which will fade eventually. | |||
: {{id|API|MessageFrame|Clear}}() - Clear the messages from the frame (added 1.11) | |||
: {{id|API|MessageFrame|GetFadeDuration}}() - Gets the fade duration in seconds (added 1.11) | |||
: {{id|API|MessageFrame|GetFading}}() - Get whether the frame is fading (added 1.11) | |||
: {{id|API|MessageFrame|GetInsertMode}}() - Get the insert mode for the frame (added 1.11) | |||
: {{id|API|MessageFrame|GetTimeVisible}}() - Get the message visibility time in seconds (added 1.11) | |||
: {{id|API|MessageFrame|SetFadeDuration}}(seconds) - Set the fade duration (added 1.11) | |||
: {{id|API|MessageFrame|SetFading}}(status) - Set whether the frame fades messages (added 1.11) | |||
: {{id|API|MessageFrame|SetInsertMode}}("TOP" or "BOTTOM") - Set where new messages are inserted (added 1.11) | |||
: {{id|API|MessageFrame|SetTimeVisible}}(seconds) - Sets the message visibility time (added 1.11) | |||
=== [[UIOBJECT Minimap|Minimap]] === | |||
: {{id|API|Minimap|GetPingPosition}}() - Get the last ping location. | |||
: {{id|API|Minimap|GetZoom}}() - Get the current zoom level. | |||
: {{id|API|Minimap|GetZoomLevels}}() - Get the maximum zoom level. | |||
: {{id|API|Minimap|PingLocation}}(x, y) - Perform a ping at the specified location. As of 2.4.2 protected while targeting area of effect spells. | |||
: {{id|API|Minimap|SetArrowModel}}("file") - Set the file to use for the arrow model (added 1.11) | |||
: {{id|API|Minimap|SetBlipTexture}} - Set the file to use for blips (ObjectIcons) | |||
: {{id|API|Minimap|SetIconTexture}} | |||
: {{id|API|Minimap|SetMaskTexture}} | |||
: {{id|API|Minimap|SetPlayerModel}}("file") - Set the file to use for the player model (added 1.11) | |||
: {{id|API|Minimap|SetZoom}}(level) - Set the current zoom level. | |||
=== [[UIOBJECT Model|Model]] === | |||
Used to display real 3D-mesh geometry as part of the UI. | |||
: {{id|API|Model|AdvanceTime}}() | |||
: {{id|API|Model|ClearFog}}() - Removes all fogging effects currently active in rendering. | |||
: {{id|API|Model|ClearModel}}() - Removes all geometry from the Model, i.e. makes it empty. | |||
: {{id|API|Model|GetFacing}}() - Returns the direction the model is facing. | |||
: {{id|API|Model|GetFogColor}}() - Gets the fog color as r,g,b,a. (added 1.11) | |||
: {{id|API|Model|GetFogFar}}() - Gets the fog far distance (added 1.11) | |||
: {{id|API|Model|GetFogNear}}() - Gets the fog near distance (added 1.11) | |||
: {{id|API|Model|GetLight}}() - Gets the light spec for the model, returns a arg list compatible with SetLight (added 1.11) | |||
: {{id|API|Model|GetModel}}() - Gets the model file for this Model (added 1.11) | |||
: {{id|API|Model|GetModelScale}}() - Returns the current mesh scaling factor. | |||
: {{id|API|Model|GetPosition}}() - Returns the current position of the mesh as x, y, z | |||
: {{id|API|Model|ReplaceIconTexture}}("texture") | |||
: {{id|API|Model|SetCamera}}(index) - Select a pre-defined camera. | |||
: {{id|API|Model|SetFacing}}(facing) - Set the direction that the model is facing. | |||
: {{id|API|Model|SetFogColor}}(r, g, b[, a]) - Set the fog color and enable fogging. | |||
: {{id|API|Model|SetFogFar}}(value) - Set the far-clipping plane distance for fogging. | |||
: {{id|API|Model|SetFogNear}}(value) - Set the near-clipping plane distance for fogging. | |||
: {{id|API|Model|SetGlow}}(..) - | |||
: {{id|API|Model|SetLight}}(enabled[, omni, dirX, dirY, dirZ, ambIntensity[, ambR, ambG, ambB[, dirIntensity[, dirR, dirG, dirB]]]]) - place light source | |||
: {{id|API|Model|SetModel}}("file") - Set the mesh that is displayed in the frame. | |||
: {{id|API|Model|SetModelScale}}(scale) - Sets the scale factor for the mesh before rendering. | |||
: {{id|API|Model|SetPosition}}(x, y, z) - Set the position of the mesh inside the frame's coordinate system. | |||
: {{id|API|Model|SetSequence}}(sequence) - Set the animation to be played. | |||
: {{id|API|Model|SetSequenceTime}}(sequence, time) | |||
=== [[UIOBJECT ScrollFrame|ScrollFrame]] === | |||
: {{id|API|ScrollFrame|GetHorizontalScroll}}() | |||
: {{id|API|ScrollFrame|GetHorizontalScrollRange}}() | |||
: {{id|API|ScrollFrame|GetScrollChild}} | |||
: {{id|API|ScrollFrame|GetVerticalScroll}}() | |||
: {{id|API|ScrollFrame|GetVerticalScrollRange}}() | |||
: {{id|API|ScrollFrame|SetHorizontalScroll}}(offset) | |||
: {{id|API|ScrollFrame|SetScrollChild}} | |||
: {{id|API|ScrollFrame|SetVerticalScroll}}(offset) | |||
: {{id|API|ScrollFrame|UpdateScrollChildRect}}() - no longer required after patch 2.3 | |||
=== [[UIOBJECT ScrollingMessageFrame|ScrollingMessageFrame]] === | |||
ScrollingMessageFrame additionally has all of the methods from [[#FontInstance|FontInstance]], plus the following: | |||
: {{id|API|ScrollingMessageFrame|AddMessage}}("text"[, r, g, b[, id][, addToStart]]) - Add a message to the frame with an optional color, ID (updated 2.4.2) | |||
: {{id|API|ScrollingMessageFrame|AtBottom}}() - Test whether frame is at the bottom. | |||
: {{id|API|ScrollingMessageFrame|AtTop}}() - Test whether frame is at the top (added 1.11) | |||
: {{id|API|ScrollingMessageFrame|Clear}}() - Clear all lines from the frame. | |||
: {{id|API|ScrollingMessageFrame|GetCurrentLine}}() - Returns the line number that was printed last, starting from 0. | |||
: <s>{{id|API|ScrollingMessageFrame|GetCurrentScroll}}() - Get number messages upward that are scrolled. (renamed 7.1.0 to GetScrollOffset)</s> | |||
: {{id|API|ScrollingMessageFrame|GetFadeDuration}}() | |||
: {{id|API|ScrollingMessageFrame|GetFading}}() | |||
: {{id|API|ScrollingMessageFrame|GetHyperlinksEnabled}}() (added 3.0.8) | |||
: {{id|API|ScrollingMessageFrame|GetInsertMode}}() - Gets the current insert mode for a frame. (added 2.3) | |||
: {{id|API|ScrollingMessageFrame|GetMaxLines}}() - Get the maximum number of lines the frame can display. | |||
: {{id|API|ScrollingMessageFrame|GetNumLinesDisplayed}}() | |||
: {{id|API|ScrollingMessageFrame|GetNumMessages}}() | |||
: {{id|API|ScrollingMessageFrame|GetScrollOffset}}() - Get number messages upward that are scrolled. (renamed 7.1.0 from GetCurrentScroll) | |||
: {{id|API|ScrollingMessageFrame|GetTimeVisible}}() | |||
: {{id|API|ScrollingMessageFrame|PageDown}}() | |||
: {{id|API|ScrollingMessageFrame|PageUp}}() | |||
: {{id|API|ScrollingMessageFrame|ScrollDown}}() | |||
: {{id|API|ScrollingMessageFrame|ScrollToBottom}}() | |||
: {{id|API|ScrollingMessageFrame|ScrollToTop}}() | |||
: {{id|API|ScrollingMessageFrame|ScrollUp}}() | |||
: {{id|API|ScrollingMessageFrame|SetFadeDuration}}(seconds) - Set the fade duration. | |||
: {{id|API|ScrollingMessageFrame|SetFading}}([isEnabled]) - Set whether fading is enabled (renamed 1.11) | |||
: {{id|API|ScrollingMessageFrame|SetHyperlinksEnabled}}(enableFlag) (added 3.0.8) | |||
: {{id|API|ScrollingMessageFrame|SetInsertMode}}("mode") - Set location for new strings added to the frame ["TOP", "BOTTOM"] (added 2.3) | |||
: {{id|API|ScrollingMessageFrame|SetMaxLines}}(lines) - Set maximum number of history lines, and resets messages already within frame | |||
: {{id|API|ScrollingMessageFrame|SetScrollOffset}}(offset) (renamed 2.3) | |||
: {{id|API|ScrollingMessageFrame|SetTimeVisible}}(seconds) - Sets how long lines remain visible. | |||
: {{id|API|ScrollingMessageFrame|UpdateColorByID}}(id, r, g, b) | |||
=== [[UIOBJECT SimpleHTML|SimpleHTML]] === | |||
: {{id|API|SimpleHTML|GetFont}}(["element"]) | |||
: {{id|API|SimpleHTML|GetFontObject}}(["element"]) | |||
: {{id|API|SimpleHTML|GetHyperlinkFormat}}() - Set the string.format format to use for displaying hyperlinks (added 1.11) | |||
: {{id|API|SimpleHTML|GetHyperlinksEnabled}}() (added 3.0.8) | |||
: {{id|API|SimpleHTML|GetJustifyH}}(["element"]) | |||
: {{id|API|SimpleHTML|GetJustifyV}}(["element"]) | |||
: {{id|API|SimpleHTML|GetShadowColor}}(["element"]) | |||
: {{id|API|SimpleHTML|GetShadowOffset}}(["element"]) | |||
: {{id|API|SimpleHTML|GetSpacing}}(["element"]) | |||
: {{id|API|SimpleHTML|GetTextColor}}(["element"]) | |||
: {{id|API|SimpleHTML|SetFont}}(["element",] "path", height[,"flags"]) | |||
: {{id|API|SimpleHTML|SetFontObject}}(["element",] fontObject) | |||
: {{id|API|SimpleHTML|SetHyperlinkFormat}}("format") - Set the string.format format to use for displaying hyperlinks. | |||
: {{id|API|SimpleHTML|SetHyperlinksEnabled}}(enableFlag) (added 3.0.8) | |||
: {{id|API|SimpleHTML|SetJustifyH}}(["element",] "justifyH") | |||
: {{id|API|SimpleHTML|SetJustifyV}}(["element",] "justifyV") | |||
: {{id|API|SimpleHTML|SetShadowColor}}(["element",] r, g, b[, a]) | |||
: {{id|API|SimpleHTML|SetShadowOffset}}(["element",] x, y) | |||
: {{id|API|SimpleHTML|SetSpacing}}(["element",] lineSpacing) | |||
: {{id|API|SimpleHTML|SetText}}("text") - Set the HTML markup to be displayed (note: if there is ''any'' markup error, it will be displayed as plain text) | |||
: {{id|API|SimpleHTML|SetTextColor}}(["element",] r, g, b[, a]) | |||
=== [[UIOBJECT Slider|Slider]] === | |||
: {{id|API|Slider|Disable}}() - Disables the slider | |||
: {{id|API|Slider|Enable}}() - Enables the slider | |||
: {{id|API|Slider|GetMinMaxValues}}() - Get the current bounds of the slider. | |||
: {{id|API|Slider|GetOrientation}}() - Returns "HORIZONTAL" or "VERTICAL". | |||
: {{id|API|Slider|GetStepsPerPage}}() - Get the current page step size of the slider. (added 5.4.0) | |||
: {{id|API|Slider|GetThumbTexture}}() - Get the texture for this slider's thumb. (added 1.11.0) | |||
: {{id|API|Slider|GetValue}}() - Get the current value of the slider. | |||
: {{id|API|Slider|GetValueStep}}() - Get the current step size of the slider. | |||
: {{id|API|Slider|IsEnabled}}() - Returns enabled status of the slider. | |||
: {{id|API|Slider|SetMinMaxValues}}(min, max) - Set the bounds of the slider. | |||
: {{id|API|Slider|SetOrientation}}("orientation") - "HORIZONTAL" or "VERTICAL". | |||
: {{id|API|Slider|SetStepsPerPage}}(value) - Set the page step size of the slider. (added 5.4.0) | |||
: {{id|API|Slider|SetThumbTexture}}(texture or "texturePath") Set texture for this slider's thumb. (added 1.11.0) | |||
: {{id|API|Slider|SetValue}}(value) - Set the value of the slider. Also causes the thumb to show on the first call. | |||
: {{id|API|Slider|SetValueStep}}(value) - Set the step size of the slider. | |||
=== [[UIOBJECT StatusBar|StatusBar]] === | |||
: {{id|API|StatusBar|GetMinMaxValues}}() - Get the current bounds of the bar. | |||
: {{id|API|StatusBar|GetOrientation}} | |||
: {{id|API|StatusBar|GetStatusBarColor}} | |||
: {{id|API|StatusBar|GetStatusBarTexture}}() - Returns the texture object for the bar | |||
: {{id|API|StatusBar|GetValue}}() - Get the current value of the bar. | |||
: {{id|API|StatusBar|SetMinMaxValues}}(min, max) - Set the bounds of the bar. | |||
: {{id|API|StatusBar|SetOrientation}}("orientation") - "HORIZONTAL" or "VERTICAL". | |||
: {{id|API|StatusBar|SetStatusBarColor}}(r, g, b[, alpha]) - Set the color of the bar. | |||
: {{id|API|StatusBar|SetStatusBarTexture}}("file" or texture[,"layer"]) - Sets the texture of the bar (added 'texture' 1.11) | |||
: {{id|API|StatusBar|SetValue}}(value) - Set the value of the bar. | |||
== Button Derivatives == | |||
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]] and [[#Button|Button]], plus the following: | |||
=== [[UIOBJECT CheckButton|CheckButton]] === | |||
: {{id|API|CheckButton|GetChecked}}() - Get the status of the checkbox. | |||
: {{id|API|CheckButton|GetCheckedTexture}}() - Get the texture used for a checked box (added 1.11) | |||
: {{id|API|CheckButton|GetDisabledCheckedTexture}}() - Get the texture used for a disabled checked box (added 1.11) | |||
: {{id|API|CheckButton|SetChecked}}([state]) - Set the status of the checkbox. | |||
: {{id|API|CheckButton|SetCheckedTexture}}(texture) - Set the texture to use for a checked box. | |||
: {{id|API|CheckButton|SetDisabledCheckedTexture}}(texture) - Set the texture to use for a disabled but checked box. | |||
=== [[UIOBJECT LootButton|LootButton]] === | |||
: {{id|API|LootButton|SetSlot}}(index) - Set which the item to loot if the button is clicked. | |||
== Model Derivatives == | |||
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]] and [[#Model|Model]], plus the following: | |||
=== [[UIOBJECT PlayerModel|PlayerModel]] === | |||
: {{id|API|PlayerModel|RefreshUnit}}() | |||
: {{id|API|PlayerModel|SetCreature}}(CreatureId) | |||
: {{id|API|PlayerModel|SetRotation}}(rotationRadians) | |||
: {{id|API|PlayerModel|SetUnit}}("[[unitId]]") | |||
== PlayerModel Derivatives == | |||
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]], [[#Frame|Frame]], [[#Model|Model]] and [[#PlayerModel|PlayerModel]], plus the following: | |||
=== [[UIOBJECT DressUpModel|DressUpModel]] === | |||
: {{id|API|DressUpModel|Dress}}() - Set the model to reflect the character's current inventory. | |||
: {{id|API|DressUpModel|TryOn}}("item") - Add the specified item to the model. | |||
: {{id|API|DressUpModel|Undress}}() - Set the model to reflect the character without inventory. | |||
=== [[UIOBJECT TabardModel|TabardModel]] === | |||
: {{id|API|TabardModel|CanSaveTabardNow}}() - Indicate if the tabard can be saved. | |||
: {{id|API|TabardModel|CycleVariation}}(variationIndex, delta) | |||
: {{id|API|TabardModel|GetLowerBackgroundFileName}} | |||
: {{id|API|TabardModel|GetLowerEmblemFileName}} | |||
: {{id|API|TabardModel|GetLowerEmblemTexture}}("textureName") | |||
: {{id|API|TabardModel|GetUpperBackgroundFileName}} | |||
: {{id|API|TabardModel|GetUpperEmblemFileName}} | |||
: {{id|API|TabardModel|GetUpperEmblemTexture}}("textureName") | |||
: {{id|API|TabardModel|InitializeTabardColors}}() | |||
: {{id|API|TabardModel|Save}}() - Save the tabard. | |||
== LayeredRegion Derivatives == | |||
Have all of the methods from [[#UIObject|UIObject]], [[#Region|Region]] and [[#LayeredRegion|LayeredRegion]], plus the following: | |||
=== [[UIOBJECT Texture|Texture]] === | |||
: {{id|API|Texture|GetBlendMode}}() - Return the blend mode set by SetBlendMode() | |||
: {{id|API|Texture|GetTexCoord}}() - Gets the 8 texture coordinates that map to the Texture's corners (added 1.11) | |||
: REMOVED (3.3.3) {{id|API|Texture|GetTexCoordModifiesRect}}() - Get the SetTexCoordModifiesRect setting (added 1.11) | |||
: {{id|API|Texture|GetTexture}}() - Gets this texture's current texture path. | |||
: {{id|API|Texture|GetVertexColor}}() - Gets the vertex color for the Texture. | |||
: {{id|API|Texture|IsDesaturated}}() - Gets the desaturation state of this Texture. (added 1.11) | |||
: {{id|API|Texture|SetBlendMode}}("mode") - Set the [[alphaMode]] of the texture. | |||
: {{id|API|Texture|SetDesaturated}}(flag) - If should be displayed with no saturation. has a return value. | |||
: {{id|API|Texture|SetGradient}}("orientation", minR, minG, minB, maxR, maxG, maxB) | |||
: {{id|API|Texture|SetGradientAlpha}}("orientation", minR, minG, minB, minA, maxR, maxG, maxB, maxA) | |||
: {{id|API|Texture|SetRotation}}(angle, [,cx, cy]) - Shorthand for the appropriate 8 argument SetTexCoord rotation (in C++ so it's fast) | |||
: {{id|API|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) {{id|API|Texture|SetTexCoordModifiesRect}}(enableFlag) - if operations modify the rectangle or stretch the texture. (added 1.11) | |||
: {{id|API|Texture|SetTexture}}("texturePath") - Sets the texture to be displayed from a file. | |||
: {{id|API|Texture|SetColorTexture}}(r, g, b[, a]) - Sets the texture to be displayed to a solid color. | |||
=== [[UIOBJECT FontString|FontString]] === | |||
FontString has additional methods from [[#FontInstance|FontInstance]], plus the following: | |||
: {{id|API|FontString|CanNonSpaceWrap}}() - Get whether long strings without spaces are wrapped or truncated (added 1.11) | |||
: {{id|API|FontString|GetStringHeight}}() - Returns the height in pixels of the current string in the current font, without line wrapping. (added 2.3) | |||
: {{id|API|FontString|GetStringWidth}}() - Returns the width in pixels of the current string in the current font, without line wrapping. | |||
: {{id|API|FontString|GetText}}() - Get the displayed text. | |||
: {{id|API|FontString|SetAlphaGradient}}(start, length) - Create or remove an alpha gradient over the text. | |||
: {{id|API|FontString|SetFormattedText}}("formatstring"[, ...]) - Set the formatted display text. (added 2.3) | |||
: {{id|API|FontString|SetNonSpaceWrap}}(wrapFlag) - Set whether long strings without spaces are wrapped or truncated. | |||
: {{id|API|FontString|SetText}}("text") - Set the displayed text. | |||
: {{id|API|FontString|SetTextHeight}}(pixelHeight) - Set the height of the text by scaling graphics Note that can distort text. | |||
== Special == | |||
=== [[UIOBJECT WorldFrame|WorldFrame]] === | |||
WorldFrame is the frame which is used to display 3D world itself. | |||
Inherits methods from [[#Frame|Frame]]. | |||
=== [[UIOBJECT Templates|Templates]]=== | |||
These are nota type per se, but objects generated form XML that can be used as templates UIObject Lua code. | |||
[[Category:Widgets]] | |||