Controls

From ESOUI Wiki

(Difference between revisions)
Jump to: navigation, search
(Imported from older doc)
(Update controls, with formatting, arguments, etc.)
Line 1: Line 1:
-
===== AddOnManager =====
+
=== AddOnManager ===
-
  * AddRelevantFilter (string relevantFilter)
+
* AddRelevantFilter('''string''' ''relevantFilter'')
-
  * GetAddOnFilter ()
+
-
    * Returns: string settingFilter
+
-
  * GetAddOnInfo (luaindex addOnIndex)
+
-
    * Returns: string name, string title, bool enabled, integer state
+
-
  * GetNumAddOns ()
+
-
    * Returns: integer numAddOns
+
-
  * RemoveAddOnFilter ()
+
-
  * ResetRelevantFilters ()
+
-
  * SetAddOnEnabled (luaindex addOnIndex, bool enabled)
+
-
  * SetAddOnFilter (string settingFilter)
+
-
===== AnimationManager =====
+
-
  * CreateTimeline ()
+
-
    * Returns: object timeline
+
-
  * CreateTimelineFromVirtual (string timelineName, object animatedControl)
+
-
    * Returns: object timeline
+
-
===== AnimationObject =====
+
-
Objects that inherit behavior from AnimationObject: [[#AnimationObjectAlpha]], [[#AnimationObjectCustom]], [[#AnimationObjectScale]], [[#AnimationObjectScroll]], [[#AnimationObjectSize]], [[#AnimationObjectTexture]], [[#AnimationObjectTextureRotate]], [[#AnimationObjectTextureSlide]], [[#AnimationObjectTranslate]]
+
-
  * GetAnimatedControl ()
+
-
    * Returns: object animatedControl
+
-
  * GetDuration ()
+
-
    * Returns: integer durationMs
+
-
  * GetEasingFunction ()
+
-
    * Returns: function functionRef
+
-
  * GetHandler (string [[../events/|EventName]])
+
-
    * Returns: function FunctionRef
+
-
  * GetTimeline ()
+
-
    * Returns: object owningTimeline
+
-
  * IsPlaying ()
+
-
    * Returns: bool isPlaying
+
-
  * SetAnimatedControl (object animatedControl)
+
-
  * SetDuration (integer durationMs)
+
-
  * SetEasingFunction (function functionRef)
+
-
  * SetHandler (string [[../events/|EventName]], function FunctionRef)
+
-
===== AnimationObjectAlpha =====
+
* GetAddOnDependencyInfo('''luaindex''' ''addOnIndex'', '''luaindex''' ''addOnDependencyIndex'')
-
  * SetAlphaValues (number startAlpha, number endAlpha)
+
** ''Returns:'' '''string''' ''name'', '''bool''' ''active''
-
===== AnimationObjectCustom =====
+
 
-
  * SetUpdateFunction (function functionRef)
+
* GetAddOnFilter()
-
===== AnimationObjectScale =====
+
** ''Returns:'' '''string''' ''settingFilter''
-
  * SetScaleValues (number startScale, number endScale)
+
 
-
===== AnimationObjectScroll =====
+
* GetAddOnInfo('''luaindex''' ''addOnIndex'')
-
  * SetHorizontalEnd (number endX)
+
** ''Returns:'' '''string''' ''name'', '''string''' ''title'', '''string''' ''author'', '''string''' ''description'', '''bool''' ''enabled'', '''[AddOnLoadState|#AddOnLoadState]''' ''state'', '''bool''' ''isOutOfDate''
-
  * SetHorizontalRelative (number offsetX)
+
 
-
  * SetHorizontalStartAndEnd (number startX, number endX)
+
* GetAddOnNumDependencies('''luaindex''' ''addOnIndex'')
-
  * SetVerticalEnd (number endY)
+
** ''Returns:'' '''integer''' ''numDependencies''
-
  * SetVerticalRelative (number offsetY)
+
 
-
  * SetVerticalStartAndEnd (number startY, number endY)
+
* GetLoadOutOfDateAddOns()
-
===== AnimationObjectSize =====
+
** ''Returns:'' '''bool''' ''loadOutOfDateAddons''
-
  * SetHeightEnd (number endHeight)
+
 
-
  * SetHeightRelative (number heightOffset)
+
* GetNumAddOns()
-
  * SetHeightStartAndEnd (number startHeight, number endHeight)
+
** ''Returns:'' '''integer''' ''numAddOns''
-
  * SetWidthEnd (number endWidth)
+
 
-
  * SetWidthRelative (number widthOffset)
+
* RemoveAddOnFilter()
-
  * SetWidthStartAndEnd (number startWidth, number endWidth)
+
 
-
===== AnimationObjectTexture =====
+
* ResetRelevantFilters()
-
  * IsMirroringAlongX ()
+
 
-
    * Returns: bool mirroring
+
* SetAddOnEnabled('''luaindex''' ''addOnIndex'', '''bool''' ''enabled'')
-
  * IsMirroringAlongY ()
+
 
-
    * Returns: bool mirroring
+
* SetAddOnFilter('''string''' ''settingFilter'')
-
  * SetFramerate (number framesPerSecond)
+
 
-
  * SetImageData (integer aNumCellsWide, integer aNumCellsHigh)
+
* SetLoadOutOfDateAddOns('''bool''' ''loadOutOfDateAddons'')
-
  * SetMirrorAlongX (bool mirroring)
+
 
-
  * SetMirrorAlongY (bool mirroring)
+
 
-
===== AnimationObjectTextureRotate =====
+
=== AnimationManager ===
-
  * SetRotationValues (number startRadians, number endRadians)
+
* CreateTimeline()
-
===== AnimationObjectTextureSlide =====
+
** ''Returns:'' '''object''' ''timeline''
-
  * SetSlideDistances (number slideDistanceU, number slideDistanceV)
+
 
-
===== AnimationObjectTranslate =====
+
* CreateTimelineFromVirtual('''string''' ''timelineName'', '''object''' ''animatedControl'')
-
  * SetAnchorIndex (integer anchorIndex)
+
** ''Returns:'' '''object''' ''timeline''
-
  * SetTranslateDeltas (number deltaX, number deltaY)
+
 
-
  * SetTranslateOffsets (number startX, number startY, number endX, number endY)
+
 
-
===== AnimationTimeline =====
+
=== AnimationObject ===
-
  * ApplyAllAnimationsToControl (object animatedControl)
+
 
-
  * ClearAllCallbacks ()
+
* GetAnimatedControl()
-
  * GetAnimation (luaindex animationIndex)
+
** ''Returns:'' '''object''' ''animatedControl''
-
    * Returns: object animation
+
 
-
  * GetAnimationOffset (object animation)
+
* GetDuration()
-
    * Returns: integer offset
+
** ''Returns:'' '''integer''' ''durationMs''
-
  * GetAnimationTimeline (luaindex timelineIndex)
+
 
-
    * Returns: object timeline
+
* GetEasingFunction()
-
  * GetAnimationTimelineOffset (object animation)
+
** ''Returns:'' '''function''' ''functionRef''
-
    * Returns: integer offset
+
 
-
  * GetDuration ()
+
* GetHandler('''string''' ''EventName'')
-
    * Returns: integer duration
+
** ''Returns:'' '''function''' ''FunctionRef''
-
  * GetFirstAnimation ()
+
 
-
    * Returns: object animation
+
* GetTimeline()
-
  * GetFirstAnimationTimeline ()
+
** ''Returns:'' '''object''' ''owningTimeline''
-
    * Returns: object timeline
+
 
-
  * GetFullProgress ()
+
* IsPlaying()
-
    * Returns: number progress
+
** ''Returns:'' '''bool''' ''isPlaying''
-
  * GetHandler (string EventName)
+
 
-
    * Returns: function FunctionRef
+
* SetAnimatedControl('''object''' ''animatedControl'')
-
  * GetLastAnimation ()
+
 
-
    * Returns: object animation
+
* SetDuration('''integer''' ''durationMs'')
-
  * GetLastAnimationTimeline ()
+
 
-
    * Returns: object timeline
+
* SetEasingFunction('''function''' ''functionRef'')
-
  * GetNumAnimationTimelines ()
+
 
-
    * Returns: integer numTimelines
+
* SetHandler('''string''' ''EventName'', '''function''' ''FunctionRef'')
-
  * GetNumAnimations ()
+
 
-
    * Returns: integer numAnimations
+
==== Objects that inherit behavior from '''AnimationObject''' ====
-
  * GetParent ()
+
 
-
    * Returns: object timeline
+
* [[#AnimationObjectAlpha|AnimationObjectAlpha]]
-
  * GetProgress ()
+
* [[#AnimationObjectColor|AnimationObjectColor]]
-
    * Returns: number progress
+
* [[#AnimationObjectCustom|AnimationObjectCustom]]
-
  * InsertAnimation (integer animationType, object animatedControl, integer offset)
+
* [[#AnimationObjectScale|AnimationObjectScale]]
-
    * Returns: object animation
+
* [[#AnimationObjectScroll|AnimationObjectScroll]]
-
  * InsertAnimationFromVirtual (string animationVirtualName, object animatedControl)
+
* [[#AnimationObjectSize|AnimationObjectSize]]
-
    * Returns: object animation
+
* [[#AnimationObjectTexture|AnimationObjectTexture]]
-
  * InsertAnimationTimeline (integer offset, object animatedControl)
+
* [[#AnimationObjectTextureRotate|AnimationObjectTextureRotate]]
-
    * Returns: object animation
+
* [[#AnimationObjectTextureSlide|AnimationObjectTextureSlide]]
-
  * InsertAnimationTimelineFromVirtual (string animationVirtualName, object animatedControl)
+
* [[#AnimationObjectTranslate|AnimationObjectTranslate]]
-
    * Returns: object animation
+
 
-
  * InsertCallback (function functionRef, integer offset)
+
 
-
    * Returns: function functionRefRet
+
=== AnimationObjectAlpha ===
-
  * IsPlaying ()
+
* GetEndAlpha()
-
    * Returns: bool isPlaying
+
** ''Returns:'' '''number''' ''endAlpha''
-
  * IsPlayingBackward ()
+
 
-
    * Returns: bool reversed
+
* GetStartAlpha()
-
  * PlayBackward ()
+
** ''Returns:'' '''number''' ''startAlpha''
-
  * PlayForward ()
+
 
-
  * PlayFromEnd (integer offsetMs)
+
* SetAlphaValues('''number''' ''startAlpha'', '''number''' ''endAlpha'')
-
  * PlayFromStart (integer offsetMs)
+
 
-
  * SetAnimationOffset (object animation, integer offset)
+
* SetEndAlpha('''number''' ''endAlpha'')
-
  * SetAnimationTimelineOffset (object animation, integer offset)
+
 
-
  * SetCallbackOffset (function callback, integer offset)
+
* SetStartAlpha('''number''' ''startAlpha'')
-
  * SetHandler (string EventName, function FunctionRef)
+
 
-
  * SetPlaybackType (integer playbackType, integer maxLoopCount)
+
 
-
  * SetProgress (number progress)
+
=== AnimationObjectColor ===
-
  * Stop ()
+
* GetEndColor()
-
===== BackdropControl =====
+
** ''Returns:'' '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA''
-
  * GetCenterColor ()
+
 
-
    * Returns: number r, number g, number b, number a
+
* GetStartColor()
-
  * SetCenterColor (number r, number g, number b, number a)
+
** ''Returns:'' '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA''
-
  * SetCenterTexture (string filename, integer tileSize, integer addressMode)
+
 
-
  * SetEdgeColor (number r, number g, number b, number a)
+
* SetColorValues('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
-
  * SetEdgeTexture (string filename, integer imageWidth, integer imageHeight, integer edgeSize)
+
 
-
  * SetInsets (number left, number top, number right, number bottom)
+
* SetEndColor('''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
-
===== BrowserControl =====
+
 
-
  * Open (integer param1, integer param2, integer param3)
+
* SetStartColor('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'')
-
===== ButtonControl =====
+
 
-
  * EnableMouseButton (integer buttonNum, bool enabled)
+
 
-
  * GetLabelControl ()
+
=== AnimationObjectCustom ===
-
    * Returns: object labelControl
+
* SetUpdateFunction('''function''' ''functionRef'')
-
  * GetState ()
+
 
-
    * Returns: integer state
+
 
-
  * SetClickSound (string clickSound)
+
=== AnimationObjectScale ===
-
  * SetDesaturation (number desaturation)
+
* GetEndScale()
-
  * SetDisabledFontColor (number r, number g, number b, number a)
+
** ''Returns:'' '''number''' ''endScale''
-
  * SetDisabledPressedFontColor (number r, number g, number b, number a)
+
 
-
  * SetDisabledPressedTexture (string textureFilename)
+
* GetStartScale()
-
  * SetDisabledTexture (string textureFilename)
+
** ''Returns:'' '''number''' ''startScale''
-
  * SetEnabled (bool enabled)
+
 
-
  * SetEndCapWidth (integer endCapWidth)
+
* SetEndScale('''number''' ''endScale'')
-
  * SetFont (string text)
+
 
-
  * SetHorizontalAlignment (integer horizontalAlign)
+
* SetScaleValues('''number''' ''startScale'', '''number''' ''endScale'')
-
  * SetMouseOverBlendMode (integer blendMode)
+
 
-
  * SetMouseOverFontColor (number r, number g, number b, number a)
+
* SetStartScale('''number''' ''startScale'')
-
  * SetMouseOverTexture (string textureFilename)
+
 
-
  * SetNormalFontColor (number r, number g, number b, number a)
+
 
-
  * SetNormalOffset (number x, number y)
+
=== AnimationObjectScroll ===
-
  * SetNormalTexture (string textureFilename)
+
* SetHorizontalEnd('''number''' ''endX'')
-
  * SetPressedFontColor (number r, number g, number b, number a)
+
 
-
  * SetPressedMouseOverTexture (string textureFilename)
+
* SetHorizontalRelative('''number''' ''offsetX'')
-
  * SetPressedOffset (number x, number y)
+
 
-
  * SetPressedTexture (string textureFilename)
+
* SetHorizontalStartAndEnd('''number''' ''startX'', '''number''' ''endX'')
-
  * SetState (integer newState, bool locked)
+
 
-
  * SetText (string text)
+
* SetVerticalEnd('''number''' ''endY'')
-
  * SetTextureCoords (number left, number right, number top, number bottom)
+
 
-
  * SetVerticalAlignment (integer verticalAlign)
+
* SetVerticalRelative('''number''' ''offsetY'')
-
===== ColorSelectControl =====
+
 
-
  * GetColorAsHSV ()
+
* SetVerticalStartAndEnd('''number''' ''startY'', '''number''' ''endY'')
-
    * Returns: number hue, number saturation, number value
+
 
-
  * GetColorAsRGB ()
+
 
-
    * Returns: number red, number green, number blue
+
=== AnimationObjectSize ===
-
  * GetColorWheelTextureControl ()
+
* SetEndHeight('''number''' ''endHeight'')
-
    * Returns: object textureControl
+
 
-
  * GetColorWheelThumbTextureControl ()
+
* SetEndWidth('''number''' ''endWidth'')
-
    * Returns: object textureControl
+
 
-
  * GetFullValuedColorAsRGB ()
+
* SetStartAndEndHeight('''number''' ''startHeight'', '''number''' ''endHeight'')
-
    * Returns: number red, number green, number blue
+
 
-
  * GetValue ()
+
* SetStartAndEndWidth('''number''' ''startWidth'', '''number''' ''endWidth'')
-
    * Returns: number value
+
 
-
  * SetColorAsHSV (number hue, number saturation, number value)
+
* SetStartHeight('''number''' ''startHeight'')
-
  * SetColorAsRGB (number red, number green, number blue)
+
 
-
  * SetColorWheelThumbTextureControl (object textureControl)
+
* SetStartWidth('''number''' ''startWidth'')
-
  * SetValue (number value)
+
 
-
===== CompassDisplayControl =====
+
 
-
  * GetAlphaCoefficients ()
+
=== AnimationObjectTexture ===
-
    * Returns: number leadingCoefficient, number coefficient, number constant
+
* GetCellsHigh()
-
  * GetCenterOveredPinInfo (luaindex centerOveredPinIndex)
+
** ''Returns:'' '''integer''' ''aNumCellsHigh''
-
    * Returns: string description, integer type, number distance, DrawLayer drawLayer, bool suppressed
+
 
-
  * GetMinVisibleAlpha ()
+
* GetCellsWide()
-
    * Returns: number minVisibleAlpha
+
** ''Returns:'' '''integer''' ''aNumCellsWide''
-
  * GetMinVisibleScale ()
+
 
-
    * Returns: number minVisibleScale
+
* IsMirroringAlongX()
-
  * GetNumCenterOveredPins ()
+
** ''Returns:'' '''bool''' ''mirroring''
-
    * Returns: integer numCenterOveredPins
+
 
-
  * GetScaleCoefficients ()
+
* IsMirroringAlongY()
-
    * Returns: number leadingCoefficient, number coefficient, number constant
+
** ''Returns:'' '''bool''' ''mirroring''
-
  * SetAlphaCoefficients (number leadingCoefficient, number coefficient, number constant)
+
 
-
  * SetCardinalDirection (string directionName, string font, integer cardinalDirection)
+
* SetCellsHigh('''integer''' ''aNumCellsHigh'')
-
  * SetMinVisibleAlpha (number minVisibleAlpha)
+
 
-
  * SetMinVisibleScale (number minVisibleScale)
+
* SetCellsWide('''integer''' ''aNumCellsWide'')
-
  * SetScaleCoefficients (number leadingCoefficient, number coefficient, number constant)
+
 
-
===== Control =====
+
* SetFramerate('''number''' ''framesPerSecond'')
-
Objects that inherit behavior from Control
+
 
-
BackdropControl, BrowserControl, ButtonControl, ColorSelectControl, CompassDisplayControl, CooldownControl, DebugTextControl, EditControl, LabelControl, LineControl, MapDisplayControl, RootWindow, ScrollControl, SliderControl, StatusBarControl, TextBufferControl, TextureControl, TooltipControl, TopLevelWindow
+
* SetImageData('''integer''' ''aNumCellsWide'', '''integer''' ''aNumCellsHigh'')
-
  * ClearAnchors protected-attributes ()
+
 
-
  * CreateControl (string arg1, integer type)
+
* SetMirrorAlongX('''bool''' ''mirroring'')
-
    * Returns: object apRet
+
 
-
  * GetAlpha ()
+
* SetMirrorAlongY('''bool''' ''mirroring'')
-
    * Returns: number alpha
+
 
-
  * GetAnchor (integer anchorIndex)
+
 
-
    * Returns: bool isValidAnchor, integer point, object relativeTo, integer relativePoint, number offsetX, number offsetY
+
=== AnimationObjectTextureRotate ===
-
  * GetBottom ()
+
* GetEndRotation()
-
    * Returns: number bottom
+
** ''Returns:'' '''number''' ''endRadians''
-
  * GetCenter ()
+
 
-
    * Returns: number centerX, number centerY
+
* GetStartRotation()
-
  * GetChild (luaindex childIndex)
+
** ''Returns:'' '''number''' ''startRadians''
-
    * Returns: object childControl
+
 
-
  * GetClampedToScreen ()
+
* SetEndRotation('''number''' ''endRadians'')
-
    * Returns: bool clamped
+
 
-
  * GetClampedToScreenInsets ()
+
* SetRotationValues('''number''' ''startRadians'', '''number''' ''endRadians'')
-
    * Returns: number left, number top, number right, number bottom
+
 
-
  * GetDesiredHeight ()
+
* SetStartRotation('''number''' ''startRadians'')
-
    * Returns: number height
+
 
-
  * GetDesiredWidth ()
+
 
-
    * Returns: number width
+
=== AnimationObjectTextureSlide ===
-
  * GetDimensionConstraints ()
+
* SetSlideDistances('''number''' ''slideDistanceU'', '''number''' ''slideDistanceV'')
-
    * Returns: number minWidth, number minHeight, number maxWidth, number maxHeight
+
 
-
  * GetDimensions ()
+
 
-
    * Returns: number width, number height
+
=== AnimationObjectTranslate ===
-
  * GetDrawLayer ()
+
* GetDeltaOffsetX()
-
    * Returns: integer layer
+
** ''Returns:'' '''number''' ''deltaX''
-
  * GetDrawLevel ()
+
 
-
    * Returns: integer level
+
* GetDeltaOffsetY()
-
  * GetDrawTier ()
+
** ''Returns:'' '''number''' ''deltaY''
-
    * Returns: integer tier
+
 
-
  * GetExcludeFromResizeToFitExtents ()
+
* GetEndOffsetX()
-
    * Returns: bool excludes
+
** ''Returns:'' '''number''' ''endX''
-
  * GetHandler (string EventName)
+
 
-
    * Returns: function FunctionRef
+
* GetEndOffsetY()
-
  * GetHeight ()
+
** ''Returns:'' '''number''' ''endY''
-
    * Returns: number height
+
 
-
  * GetHitInsets ()
+
* GetStartOffsetX()
-
    * Returns: number left, number top, number right, number bottom
+
** ''Returns:'' '''number''' ''startX''
-
  * GetId ()
+
 
-
    * Returns: integer id
+
* GetStartOffsetY()
-
  * GetInheritsAlpha ()
+
** ''Returns:'' '''number''' ''startY''
-
    * Returns: bool inheritAlpha
+
 
-
  * GetInheritsScale ()
+
* GetTranslateDeltas()
-
    * Returns: bool inheritScale
+
** ''Returns:'' '''number''' ''deltaX'', '''number''' ''deltaY''
-
  * GetLeft ()
+
 
-
    * Returns: number left
+
* SetAnchorIndex('''integer''' ''anchorIndex'')
-
  * GetName ()
+
 
-
    * Returns: string name
+
* SetDeltaOffsetX('''number''' ''deltaX'')
-
  * GetNamedChild (string childName)
+
 
-
    * Returns: object returnedControl
+
* SetDeltaOffsetY('''number''' ''deltaY'')
-
  * GetNumChildren ()
+
 
-
    * Returns: integer numChildren
+
* SetEndOffsetX('''number''' ''endX'')
-
  * GetOwningWindow ()
+
 
-
    * Returns: object OwningTopLevelWindow
+
* SetEndOffsetY('''number''' ''endY'')
-
  * GetParent ()
+
 
-
    * Returns: object ret1
+
* SetStartOffsetX('''number''' ''startX'')
-
  * GetResizeToFitDescendents ()
+
 
-
    * Returns: bool resizes
+
* SetStartOffsetY('''number''' ''startY'')
-
  * GetResizeToFitPadding ()
+
 
-
    * Returns: number width, number height
+
* SetTranslateDeltas('''number''' ''deltaX'', '''number''' ''deltaY'')
-
  * GetRight ()
+
 
-
    * Returns: number right
+
* SetTranslateOffsets('''number''' ''startX'', '''number''' ''startY'', '''number''' ''endX'', '''number''' ''endY'')
-
  * GetScale ()
+
 
-
    * Returns: number scale
+
 
-
  * GetScreenRect ()
+
=== AnimationTimeline ===
-
    * Returns: number left, number top, number right, number bottom
+
* ApplyAllAnimationsToControl('''object''' ''animatedControl'')
-
  * GetTop ()
+
 
-
    * Returns: number top
+
* ClearAllCallbacks()
-
  * GetType ()
+
 
-
    * Returns: integer type
+
* GetAnimation('''luaindex''' ''animationIndex'')
-
  * GetWidth ()
+
** ''Returns:'' '''object''' ''animation''
-
    * Returns: number width
+
 
-
  * IsChildOf (object desiredParent)
+
* GetAnimationOffset('''object''' ''animation'')
-
    * Returns: bool isChild
+
** ''Returns:'' '''integer''' ''offset''
-
  * IsControlHidden ()
+
 
-
    * Returns: bool hidden
+
* GetAnimationTimeline('''luaindex''' ''timelineIndex'')
-
  * IsHidden ()
+
** ''Returns:'' '''object''' ''timeline''
-
    * Returns: bool hidden
+
 
-
  * IsMouseEnabled ()
+
* GetAnimationTimelineOffset('''object''' ''animation'')
-
    * Returns: bool enabled
+
** ''Returns:'' '''integer''' ''offset''
-
  * RegisterForEvent (integer event, function callback)
+
 
-
    * Returns: bool success
+
* GetDuration()
-
  * SetAlpha protected-attributes (number alpha)
+
** ''Returns:'' '''integer''' ''duration''
-
  * SetAnchor protected-attributes (integer whereOnMe, object anchorTargetControl, integer whereOnTarget, number offsetX, number offsetY)
+
 
-
  * SetAnchorFill protected-attributes (object anchorTargetControl)
+
* GetFirstAnimation()
-
  * SetClampedToScreen (bool clamped)
+
** ''Returns:'' '''object''' ''animation''
-
  * SetClampedToScreenInsets (number left, number top, number right, number bottom)
+
 
-
  * SetDimensionConstraints (number minWidth, number minHeight, number maxWidth, number maxHeight)
+
* GetFirstAnimationTimeline()
-
  * SetDimensions protected-attributes (number width, number height)
+
** ''Returns:'' '''object''' ''timeline''
-
  * SetDrawLayer protected-attributes (integer layer)
+
 
-
  * SetDrawLevel protected-attributes (integer level)
+
* GetFullProgress()
-
  * SetDrawTier protected-attributes (integer tier)
+
** ''Returns:'' '''number''' ''progress''
-
  * SetExcludeFromResizeToFitExtents protected-attributes (bool exclude)
+
 
-
  * SetHandler (string EventName, function FunctionRef)
+
* GetHandler('''string''' ''EventName'')
-
  * SetHeight protected-attributes (number height)
+
** ''Returns:'' '''function''' ''FunctionRef''
-
  * SetHidden protected-attributes (bool aHidden)
+
 
-
  * SetHitInsets (number left, number top, number right, number bottom)
+
* GetLastAnimation()
-
  * SetId (integer id)
+
** ''Returns:'' '''object''' ''animation''
-
  * SetInheritAlpha (bool inheritAlpha)
+
 
-
  * SetInheritScale (bool inheritScale)
+
* GetLastAnimationTimeline()
-
  * SetMouseEnabled protected-attributes (bool enabled)
+
** ''Returns:'' '''object''' ''timeline''
-
  * SetMovable (bool isMovable)
+
 
-
  * SetParent protected-attributes (object newParent)
+
* GetNumAnimationTimelines()
-
  * SetResizeHandleSize (number handleSize)
+
** ''Returns:'' '''integer''' ''numTimelines''
-
  * SetResizeToFitDescendents protected-attributes (bool resize)
+
 
-
  * SetResizeToFitPadding (number width, number height)
+
* GetNumAnimations()
-
  * SetScale protected-attributes (number scale)
+
** ''Returns:'' '''integer''' ''numAnimations''
-
  * SetShapeType public (integer shapeType)
+
 
-
  * SetSimpleAnchor protected-attributes (object anchorTargetControl, number offsetX, number offsetY)
+
* GetParent()
-
  * SetSimpleAnchorParent protected-attributes (number offsetX, number offsetY)
+
** ''Returns:'' '''object''' ''timeline''
-
  * SetWidth protected-attributes (number width)
+
 
-
  * StartMoving protected-attributes ()
+
* GetProgress()
-
    * Returns: bool isMoving
+
** ''Returns:'' '''number''' ''progress''
-
  * StopMovingOrResizing protected-attributes ()
+
 
-
  * UnregisterForEvent (integer event)
+
* InsertAnimation('''integer''' ''animationType'', '''object''' ''animatedControl'', '''integer''' ''offset'')
-
    * Returns: bool success
+
** ''Returns:'' '''object''' ''animation''
-
===== CooldownControl =====
+
 
-
  * GetDuration ()
+
* InsertAnimationFromVirtual('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
-
    * Returns: integer duration
+
** ''Returns:'' '''object''' ''animation''
-
  * GetTimeLeft ()
+
 
-
    * Returns: integer time
+
* InsertAnimationTimeline('''integer''' ''offset'', '''object''' ''animatedControl'')
-
  * ResetCooldown ()
+
** ''Returns:'' '''object''' ''animation''
-
  * SetCooldownRemainTime (integer remain)
+
 
-
  * SetFillColor (number r, number g, number b, number a)
+
* InsertAnimationTimelineFromVirtual('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
-
  * SetLeadingEdgeTexture (string filename)
+
** ''Returns:'' '''object''' ''animation''
-
  * SetTexture (string filename)
+
 
-
  * SetVerticalCooldownLeadingEdgeHeight (integer leadingEdgeHeight)
+
* InsertCallback('''function''' ''functionRef'', '''integer''' ''offset'')
-
  * StartCooldown (integer remain, integer duration, integer cooldownType, integer cooldownTimeType, bool drawLeadingEdge)
+
** ''Returns:'' '''function''' ''functionRefRet''
-
===== DebugTextControl =====
+
 
-
  * Clear ()
+
* IsPlaying()
-
  * SetFont (string fontStr)
+
** ''Returns:'' '''bool''' ''isPlaying''
-
===== EditControl =====
+
 
-
  * AddValidCharacter (string validCharacter)
+
* IsPlayingBackward()
-
  * Clear ()
+
** ''Returns:'' '''bool''' ''reversed''
-
  * ClearSelection ()
+
 
-
  * CopyAllTextToClipboard ()
+
* PlayBackward()
-
  * GetCopyEnabled ()
+
 
-
    * Returns: bool enabled
+
* PlayForward()
-
  * GetCursorPosition ()
+
 
-
    * Returns: integer cursorPosition
+
* PlayFromEnd('''integer''' ''offsetMs'')
-
  * GetEditEnabled ()
+
 
-
    * Returns: bool enabled
+
* PlayFromStart('''integer''' ''offsetMs'')
-
  * GetFontHeight ()
+
 
-
    * Returns: number fontHeight
+
* PlayInstantlyToEnd()
-
  * GetNewLineEnabled ()
+
 
-
    * Returns: bool enabled
+
* PlayInstantlyToStart()
-
  * GetPasteEnabled ()
+
 
-
    * Returns: bool enabled
+
* SetAnimationOffset('''object''' ''animation'', '''integer''' ''offset'')
-
  * GetText ()
+
 
-
    * Returns: string apRet
+
* SetAnimationTimelineOffset('''object''' ''animation'', '''integer''' ''offset'')
-
  * HasFocus ()
+
 
-
    * Returns: bool aRet
+
* SetCallbackOffset('''function''' ''callback'', '''integer''' ''offset'')
-
  * HasSelection ()
+
 
-
    * Returns: bool hasSelection
+
* SetHandler('''string''' ''EventName'', '''function''' ''FunctionRef'')
-
  * InsertText (string aText)
+
 
-
  * IsMultiLine ()
+
* SetPlaybackType('''integer''' ''playbackType'', '''integer''' ''maxLoopCount'')
-
    * Returns: bool isMultiLine
+
 
-
  * LoseFocus ()
+
* SetProgress('''number''' ''progress'')
-
  * SelectAll ()
+
 
-
  * SetColor (number r, number g, number b, number a)
+
* Stop()
-
  * SetCopyEnabled (bool enabled)
+
 
-
  * SetCursorPosition (integer cursorPosition)
+
 
-
  * SetEditEnabled (bool enabled)
+
=== BackdropControl ===
-
  * SetFont (string font)
+
* GetCenterColor()
-
  * SetMaxInputChars (integer maxChars)
+
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
-
  * SetMultiLine (bool isMultiLine)
+
 
-
  * SetNewLineEnabled (bool enabled)
+
* SetCenterColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
  * SetPasteEnabled (bool enabled)
+
 
-
  * SetSelection (integer selectionStartIndex, integer selectionEndIndex)
+
* SetCenterTexture('''string''' ''filename'', '''integer''' ''tileSize'', '''integer''' ''addressMode'')
-
  * SetSelectionColor (number r, number g, number b, number a)
+
 
-
  * SetText (string aText)
+
* SetEdgeColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
  * SetTextType (integer textType)
+
 
-
  * TakeFocus ()
+
* SetEdgeTexture('''string''' ''filename'', '''integer''' ''edgeFileWidth'', '''integer''' ''edgeFileHeight'', '''integer''' ''edgeSize'', '''integer''' ''edgeFilePadding'')
-
===== FontObject =====
+
 
-
  * GetFontInfo ()
+
* SetInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
-
    * Returns: string face, integer size, string option
+
 
-
  * SetFont (string fontDescriptor)
+
* SetIntegralWrapping('''bool''' ''integralWrappingEnabled'')
-
===== LabelControl =====
+
 
-
  * DidLineWrap ()
+
* SetPixelRoundingEnabled('''bool''' ''enabled'')
-
    * Returns: bool didLineWrap
+
 
-
  * GetColor ()
+
 
-
    * Returns: number r, number g, number b, number a
+
=== BrowserControl ===
-
  * GetFontHeight ()
+
* Open('''integer''' ''param1'', '''integer''' ''param2'', '''integer''' ''param3'', '''string''' ''text'')
-
    * Returns: number fontHeight
+
 
-
  * GetHorizontalAlignment ()
+
 
-
    * Returns: integer align
+
=== ButtonControl ===
-
  * GetModifyTextType ()
+
* EnableMouseButton('''integer''' ''buttonNum'', '''bool''' ''enabled'')
-
    * Returns: ModifyTextType modifyTextType
+
 
-
  * GetStyleColor ()
+
* GetLabelControl()
-
    * Returns: number r, number g, number b, number a
+
** ''Returns:'' '''object''' ''labelControl''
-
  * GetText ()
+
 
-
    * Returns: string apRet
+
* GetState()
-
  * GetTextDimensions ()
+
** ''Returns:'' '''integer''' ''state''
-
    * Returns: number stringWidth, number stringHeight
+
 
-
  * GetTextHeight ()
+
* SetClickSound('''string''' ''clickSound'')
-
    * Returns: number stringHeight
+
 
-
  * GetTextWidth ()
+
* SetDesaturation('''number''' ''desaturation'')
-
    * Returns: number stringWidth
+
 
-
  * GetVerticalAlignment ()
+
* SetDisabledFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
    * Returns: integer align
+
 
-
  * SetColor (number r, number g, number b, number a)
+
* SetDisabledPressedFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
  * SetFont (string fontString)
+
 
-
  * SetHorizontalAlignment (integer align)
+
* SetDisabledPressedTexture('''string''' ''textureFilename'')
-
  * SetModifyTextType (ModifyTextType modifyTextType)
+
 
-
  * SetNewLineX (number newLineX)
+
* SetDisabledTexture('''string''' ''textureFilename'')
-
  * SetStyleColor (number r, number g, number b, number a)
+
 
-
  * SetText (string aText)
+
* SetEnabled('''bool''' ''enabled'')
-
  * SetVerticalAlignment (integer verticalAlign)
+
 
-
  * SetWrapMode (integer wrapMode)
+
* SetEndCapWidth('''integer''' ''endCapWidth'')
-
  * WasTruncated ()
+
 
-
    * Returns: bool wasTruncated
+
* SetFont('''string''' ''text'')
-
===== LineControl =====
+
 
-
  * GetColor ()
+
* SetHorizontalAlignment('''integer''' ''horizontalAlign'')
-
    * Returns: number r, number g, number b, number a
+
 
-
  * GetTextureInfo ()
+
* SetMouseOverBlendMode('''integer''' ''blendMode'')
-
    * Returns: string filename, integer addressMode, integer blendMode, number desaturation, number left, number right, number top, number bottom, number r, number g, number b, number a, integer pixelWidth, integer pixelHeight
+
 
-
  * SetBlendMode (integer blendMode)
+
* SetMouseOverFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
  * SetColor (number r, number g, number b, number a)
+
 
-
  * SetDesaturation (number desaturation)
+
* SetMouseOverTexture('''string''' ''textureFilename'')
-
  * SetGradientColors (integer orientation, number startR, number startG, number startB, number startA, number endR, number endG, number endB, number endA)
+
 
-
  * SetTexture (string filename)
+
* SetNormalFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
  * SetTextureCoords (number left, number right, number top, number bottom)
+
 
-
  * SetThickness (number thickness)
+
* SetNormalOffset('''number''' ''x'', '''number''' ''y'')
-
  * SetVertexColors (integer vertexPoints, number red, number green, number blue, number alpha)
+
 
-
===== MapDisplayControl =====
+
* SetNormalTexture('''string''' ''textureFilename'')
-
  * GetZoom ()
+
 
-
    * Returns: number normalizedRadius
+
* SetPressedFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
  * SetPinFont (string pinFont)
+
 
-
  * SetZoom (number normalizedRadius)
+
* SetPressedMouseOverTexture('''string''' ''textureFilename'')
-
===== RootWindow =====
+
 
-
===== ScrollControl =====
+
* SetPressedOffset('''number''' ''x'', '''number''' ''y'')
-
  * GetScrollExtents ()
+
 
-
    * Returns: number horizontal, number vertical
+
* SetPressedTexture('''string''' ''textureFilename'')
-
  * GetScrollOffsets ()
+
 
-
    * Returns: number horizontal, number vertical
+
* SetState('''integer''' ''newState'', '''bool''' ''locked'')
-
  * RestoreToExtents (integer duration)
+
 
-
  * SetFadeGradient (luaindex gradientIndex, number normalX, number normalY, number gradientLength)
+
* SetText('''string''' ''text'')
-
  * SetHorizontalScroll (number offset)
+
 
-
  * SetScrollBounding (integer bounding)
+
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
-
  * SetVerticalScroll (number offset)
+
 
-
===== SliderControl =====
+
* SetVerticalAlignment('''integer''' ''verticalAlign'')
-
  * GetEnabled ()
+
 
-
    * Returns: bool isEnabled
+
 
-
  * GetMinMax ()
+
=== ColorSelectControl ===
-
    * Returns: number min, number max
+
* GetColorAsHSV()
-
  * GetOrientation ()
+
** ''Returns:'' '''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value''
-
    * Returns: integer orientation
+
 
-
  * GetThumbTextureControl ()
+
* GetColorAsRGB()
-
    * Returns: object textureControl
+
** ''Returns:'' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
-
  * GetValue ()
+
 
-
    * Returns: number value
+
* GetColorWheelTextureControl()
-
  * GetValueStep ()
+
** ''Returns:'' '''object''' ''textureControl''
-
    * Returns: number step
+
 
-
  * SetBackgroundBottomTexture (string fileName, number texTop, number texLeft, number texBottom, number texRight)
+
* GetColorWheelThumbTextureControl()
-
  * SetBackgroundMiddleTexture (string fileName, number texTop, number texLeft, number texBottom, number texRight)
+
** ''Returns:'' '''object''' ''textureControl''
-
  * SetBackgroundTopTexture (string fileName, number texTop, number texLeft, number texBottom, number texRight)
+
 
-
  * SetEnabled (bool enable)
+
* GetFullValuedColorAsRGB()
-
  * SetMinMax (number min, number max)
+
** ''Returns:'' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
-
  * SetOrientation (integer orientation)
+
 
-
  * SetThumbTexture (string filename, string disabledFilename, string highlightedFilename, number thumbWidth, number thumbHeight, number texTop, number texLeft, number texBottom, number texRight)
+
* GetValue()
-
  * SetThumbTextureHeight (number height)
+
** ''Returns:'' '''number''' ''value''
-
  * SetValue (number value)
+
 
-
  * SetValueStep (number step)
+
* SetColorAsHSV('''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value'')
-
===== StatusBarControl =====
+
 
-
  * ClearFadeOutLossAdjustedTopValue ()
+
* SetColorAsRGB('''number''' ''red'', '''number''' ''green'', '''number''' ''blue'')
-
  * EnableFadeOut (bool enabled)
+
 
-
  * EnableLeadingEdge (bool enabled)
+
* SetColorWheelThumbTextureControl('''object''' ''textureControl'')
-
  * EnableScrollingOverlay (bool enabled)
+
 
-
  * GetMinMax ()
+
* SetValue('''number''' ''value'')
-
    * Returns: number min, number max
+
 
-
  * GetValue ()
+
 
-
    * Returns: number value
+
=== CompassDisplayControl ===
-
  * SetBarAlignment (integer barAlignment)
+
* GetAlphaCoefficients('''[MapDisplayPinType|#MapDisplayPinType]''' ''pinType'')
-
  * SetColor (number r, number g, number b, number a)
+
** ''Returns:'' '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant''
-
  * SetFadeOutGainColor (number r, number g, number b, number a)
+
 
-
  * SetFadeOutLossAdjustedTopValue (number topValue)
+
* GetCenterOveredPinInfo('''luaindex''' ''centerOveredPinIndex'')
-
  * SetFadeOutLossColor (number r, number g, number b, number a)
+
** ''Returns:'' '''string''' ''description'', '''integer''' ''type'', '''number''' ''distance'', '''[DrawLayer|#DrawLayer]''' ''drawLayer'', '''bool''' ''suppressed''
-
  * SetFadeOutLossSetValueToAdjust (number adjustValue)
+
 
-
  * SetFadeOutTexture (string filename)
+
* GetMinVisibleAlpha('''[MapDisplayPinType|#MapDisplayPinType]''' ''pinType'')
-
  * SetFadeOutTime (number fadeOutSeconds, number fadeOutDelaySeconds)
+
** ''Returns:'' '''number''' ''minVisibleAlpha''
-
  * SetGradientColors (number startR, number startG, number startB, number startA, number endR, number endG, number endB, number endA)
+
 
-
  * SetLeadingEdge (string textureFile, number width, number height)
+
* GetMinVisibleScale('''[MapDisplayPinType|#MapDisplayPinType]''' ''pinType'')
-
  * SetLeadingEdgeTextureCoords (number left, number right, number top, number bottom)
+
** ''Returns:'' '''number''' ''minVisibleScale''
-
  * SetMinMax (number aMin, number aMax)
+
 
-
  * SetOrientation (integer orientation)
+
* GetNumCenterOveredPins()
-
  * SetTexture (string filename)
+
** ''Returns:'' '''integer''' ''numCenterOveredPins''
-
  * SetTextureCoords (number left, number right, number top, number bottom)
+
 
-
  * SetValue (number aValue)
+
* GetScaleCoefficients('''[MapDisplayPinType|#MapDisplayPinType]''' ''pinType'')
-
  * SetupScrollingOverlay (string textureFile, number width, number height, integer duration)
+
** ''Returns:'' '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant''
-
===== TextBufferControl =====
+
 
-
  * AddMessage (string aText, number r, number g, number b, integer colorId)
+
* SetAlphaCoefficients('''[MapDisplayPinType|#MapDisplayPinType]''' ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
-
  * Clear ()
+
 
-
  * GetDrawLastEntryIfOutOfRoom ()
+
* SetCardinalDirection('''string''' ''directionName'', '''string''' ''font'', '''integer''' ''cardinalDirection'')
-
    * Returns: bool drawLastIfOutOfRoom
+
 
-
  * GetLineFade ()
+
* SetMinVisibleAlpha('''[MapDisplayPinType|#MapDisplayPinType]''' ''pinType'', '''number''' ''minVisibleAlpha'')
-
    * Returns: number timeBeforeLineBeginsToFade, number timeItTakesLineToFade
+
 
-
  * GetLinkEnabled ()
+
* SetMinVisibleScale('''[MapDisplayPinType|#MapDisplayPinType]''' ''pinType'', '''number''' ''minVisibleScale'')
-
    * Returns: bool linkEnabed
+
 
-
  * GetMaxHistoryLines ()
+
* SetScaleCoefficients('''[MapDisplayPinType|#MapDisplayPinType]''' ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
-
    * Returns: integer numLines
+
 
-
  * GetNumHistoryLines ()
+
 
-
    * Returns: integer numLines
+
=== Control ===
-
  * GetNumVisibleLines ()
+
Objects that inherit behavior from '''Control'''
-
    * Returns: integer numLines
+
[BackdropControl|#BackdropControl], [BrowserControl|#BrowserControl], [ButtonControl|#ButtonControl], [ColorSelectControl|#ColorSelectControl], [CompassDisplayControl|#CompassDisplayControl], [CooldownControl|#CooldownControl], [DebugTextControl|#DebugTextControl], [EditControl|#EditControl], [LabelControl|#LabelControl], [LineControl|#LineControl], [MapDisplayControl|#MapDisplayControl], [RootWindow|#RootWindow], [ScrollControl|#ScrollControl], [SliderControl|#SliderControl], [StatusBarControl|#StatusBarControl], [TextBufferControl|#TextBufferControl], [TextureControl|#TextureControl], [TooltipControl|#TooltipControl], [TopLevelWindow|#TopLevelWindow]
-
  * GetScrollPosition ()
+
 
-
    * Returns: integer scrollPosition
+
* ClearAnchors '''protected-attributes''' ()
-
  * IsSplittingLongMessages ()
+
 
-
    * Returns: bool isSplitting
+
* CreateControl('''string''' ''arg1'', '''integer''' ''type'')
-
  * MoveScrollPosition (integer numLines)
+
** ''Returns:'' '''object''' ''apRet''
-
  * SetClearBufferAfterFadeout (bool clearAfterFade)
+
 
-
  * SetColorById (integer colorId, number r, number g, number b)
+
* GetAlpha()
-
  * SetDrawLastEntryIfOutOfRoom (bool drawLastIfOutOfRoom)
+
** ''Returns:'' '''number''' ''alpha''
-
  * SetFont (string fontString)
+
 
-
  * SetHorizontalAlignment (integer align)
+
* GetAnchor('''integer''' ''anchorIndex'')
-
  * SetLineFade (number timeBeforeLineFadeBegins, number timeForLineToFade)
+
** ''Returns:'' '''bool''' ''isValidAnchor'', '''integer''' ''point'', '''object''' ''relativeTo'', '''integer''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY''
-
  * SetLinkEnabled (bool linkEnabed)
+
 
-
  * SetMaxHistoryLines (integer numLines)
+
* GetBottom()
-
  * SetScrollPosition (integer line)
+
** ''Returns:'' '''number''' ''bottom''
-
  * SetSplitLongMessages (bool splitLongMessages)
+
 
-
  * ShowFadedLines ()
+
* GetCenter()
-
===== TextureControl =====
+
** ''Returns:'' '''number''' ''centerX'', '''number''' ''centerY''
-
  * GetColor ()
+
 
-
    * Returns: number r, number g, number b, number a
+
* GetChild('''luaindex''' ''childIndex'')
-
  * GetResizeToFitFile ()
+
** ''Returns:'' '''object''' ''childControl''
-
    * Returns: bool resizesToFitFile
+
 
-
  * GetTextureInfo ()
+
* GetClampedToScreen()
-
    * Returns: string filename, integer addressMode, integer blendMode, number desaturation, number left, number right, number top, number bottom, number r, number g, number b, number a, integer pixelWidth, integer pixelHeight
+
** ''Returns:'' '''bool''' ''clamped''
-
  * SetAddressMode (integer addressMode)
+
 
-
  * SetAutoAdjustWrappedCoords (bool enabled)
+
* GetClampedToScreenInsets()
-
  * SetBlendMode (integer blendMode)
+
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
-
  * SetColor (number r, number g, number b, number a)
+
 
-
  * SetDesaturation (number desaturation)
+
* GetDesiredHeight()
-
  * SetGradientColors (integer orientation, number startR, number startG, number startB, number startA, number endR, number endG, number endB, number endA)
+
** ''Returns:'' '''number''' ''height''
-
  * SetPixelRounding (bool pixelRoundingEnabled)
+
 
-
  * SetResizeToFitFile (bool resizesToFitFile)
+
* GetDesiredWidth()
-
  * SetTexture (string filename)
+
** ''Returns:'' '''number''' ''width''
-
  * SetTextureCoords (number left, number right, number top, number bottom)
+
 
-
  * SetTextureCoordsRotation (number angleInRadians)
+
* GetDimensionConstraints()
-
  * SetTextureRotation (number angleInRadians, number normalizedRotationPointX, number normalizedRotationPointY)
+
** ''Returns:'' '''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight''
-
  * SetVertexColors (integer vertexPoints, number red, number green, number blue, number alpha) -- vertexpoints is a bitmask of TL=1,TR=2,BR=4,BL=8. So, 15=all. Colors are 0..1.
+
 
-
===== TooltipControl =====
+
* GetDimensions()
-
  * AddControl (object control, integer cell, bool useLastRow)
+
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
-
  * AddCornerLine (string text, string font, integer corner, number r, number g, number b)
+
 
-
  * AddLine (string text, string font, number r, number g, number b)
+
* GetDrawLayer()
-
  * AddVerticalPadding (number paddingY)
+
** ''Returns:'' '''integer''' ''layer''
-
  * AppendAvAObjective (integer queryType, integer keepId, integer objectiveId, bool isSpawnPosition)
+
 
-
  * AppendMapPing (integer pingType, string unitTag)
+
* GetDrawLevel()
-
  * AppendQuestCondition (luaindex questIndex, luaindex stepIndex, luaindex conditionIndex)
+
** ''Returns:'' '''integer''' ''level''
-
  * AppendQuestEnding (luaindex questIndex)
+
 
-
  * AppendUnitName (string unitTag)
+
* GetDrawTier()
-
  * AppendYourCorpse ()
+
** ''Returns:'' '''integer''' ''tier''
-
  * ClearLines ()
+
 
-
  * GetCornerLineOffsets ()
+
* GetExcludeFromResizeToFitExtents()
-
    * Returns: number upperleft, number upperRight, number bottomLeft, number bottomRight
+
** ''Returns:'' '''bool''' ''excludes''
-
  * GetOwner ()
+
 
-
    * Returns: object owner
+
* GetHandler('''string''' ''handlerName'')
-
  * HideComparativeTooltips ()
+
** ''Returns:'' '''function''' ''functionRef''
-
  * SetAbility (luaindex aAbilityIndex, bool aShowBase)
+
 
-
  * SetAchievement (integer aAchievementId)
+
* GetHeight()
-
  * SetAchievementRewardItem (integer aAchievementId, luaindex aRewardItem)
+
** ''Returns:'' '''number''' ''height''
-
  * SetAction (luaindex aSlotId)
+
 
-
  * SetAsComparativeTooltip1 ()
+
* GetHitInsets()
-
  * SetAsComparativeTooltip2 ()
+
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
-
  * SetAttachedMailItem (id64 aMailId, luaindex aAttachSlot)
+
 
-
  * SetAttributePassive (integer attribute, luaindex passiveIndex)
+
* GetId()
-
  * SetBagItem (integer bagIndex, integer slotIndex)
+
** ''Returns:'' '''integer''' ''id''
-
  * SetBook (luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)
+
 
-
  * SetBuff (integer aBuffSlotId, string unitTag)
+
* GetInheritsAlpha()
-
  * SetBuybackItem (luaindex entryIndex)
+
** ''Returns:'' '''bool''' ''inheritAlpha''
-
  * SetComponentItem (integer componentId)
+
 
-
  * SetCornerLineOffsets (number upperleft, number upperRight, number bottomLeft, number bottomRight)
+
* GetInheritsScale()
-
  * SetCraftingPreview (integer craftingSkill, luaindex:nilable craftToolIndex, luaindex:nilable patternIndex, luaindex:nilable styleIndex, integer ingredientComponentId1, integer ingredientQuantity1, integer ingredientComponentId2, integer ingredientQuantity2, integer additiveComponentId1, integer additiveQuantity1, integer additiveComponentId2, integer additiveQuantity2, integer additiveComponentId3, integer additiveQuantity3)
+
** ''Returns:'' '''bool''' ''inheritScale''
-
  * SetEmperorBonusAbility (integer campaignId, integer alliance)
+
 
-
  * SetFont (string fontStr)
+
* GetLeft()
-
  * SetHookPointStoreEntry (luaindex hookPointIndex, luaindex storeIndex)
+
** ''Returns:'' '''number''' ''left''
-
  * SetItemUsingEnchantment (integer itemBagIndex, integer itemSlotIndex, integer enchantmentBagIndex, integer enchantmentSlotIndex)
+
 
-
  * SetKeepBonusAbility (luaindex bonusIndex)
+
* GetName()
-
  * SetLastCraftedItem ()
+
** ''Returns:'' '''string''' ''name''
-
  * SetLastDeconstructedItem ()
+
 
-
  * SetLastRefinementItem ()
+
* GetNamedChild('''string''' ''childName'')
-
  * SetLink (string aLink)
+
** ''Returns:'' '''object''' ''returnedControl''
-
  * SetLootItem (integer lootId)
+
 
-
  * SetMount (luaindex aStableIndex)
+
* GetNumChildren()
-
  * SetOwner (object owner, integer position, number offsetX, number offsetY, integer relativePoint)
+
** ''Returns:'' '''integer''' ''numChildren''
-
  * SetPlugItem (integer bagIndex, integer slotIndex, luaindex socketIndex)
+
 
-
  * SetProgressionAbility (luaindex aProgressionIndex, integer aMorph, integer aRank)
+
* GetOwningWindow()
-
  * SetQuestItem (luaindex questIndex, luaindex stepIndex, luaindex conditionIndex)
+
** ''Returns:'' '''object''' ''OwningTopLevelWindow''
-
  * SetQuestReward (luaindex aPerkIndex)
+
 
-
  * SetQuestTool (luaindex questIndex, luaindex toolIndex)
+
* GetParent()
-
  * SetRefinementResult (integer craftingType, integer componentId)
+
** ''Returns:'' '''object''' ''ret1''
-
  * SetScrollBonusAbility (integer alliance, integer artifactType, luaindex bonusIndex)
+
 
-
  * SetSiegeFire ()
+
* GetResizeToFitDescendents()
-
  * SetSkillAbility (integer skillType, luaindex skillIndex, luaindex abilityIndex)
+
** ''Returns:'' '''bool''' ''resizes''
-
  * SetSkillLine (integer skillType, luaindex skillIndex)
+
 
-
  * SetSocketingItem (integer bagIndex, integer slotIndex)
+
* GetResizeToFitPadding()
-
  * SetStoreAlternateCurrencyItem (luaindex entryIndex, integer offset)
+
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
-
  * SetStoreItem (luaindex entryIndex)
+
 
-
  * SetSynergyBuff (integer aBuffSlotId)
+
* GetRight()
-
  * SetTradeItem (integer aWho, luaindex aTradeIndex)
+
** ''Returns:'' '''number''' ''right''
-
  * SetTradingHouseItem (luaindex tradingHouseIndex)
+
 
-
  * SetTradingHouseListing (luaindex tradingHouseIndex)
+
* GetScale()
-
  * SetUnit (string aUnitTag)
+
** ''Returns:'' '''number''' ''scale''
-
  * SetWeaponSetAbility (luaindex aWeaponSet, integer aRank)
+
 
-
  * SetWornItem (integer equipSlot)
+
* GetScreenRect()
-
  * ShowComparativeTooltips ()
+
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
-
===== TopLevelWindow =====
+
 
-
  * AllowBringToTop ()
+
* GetTop()
-
    * Returns: bool allow
+
** ''Returns:'' '''number''' ''top''
-
  * BringWindowToTop protected-attributes ()
+
 
-
  * SetAllowBringToTop protected-attributes (bool allow)
+
* GetType()
-
  * SetDrawWhenGuiHidden private (bool drawWhenHidden)
+
** ''Returns:'' '''integer''' ''type''
-
  * SetTopmost protected-attributes (bool isTopmost)
+
 
-
===== WindowManager =====
+
* GetWidth()
-
  * CreateControl (string arg1, object parent, integer type)
+
** ''Returns:'' '''number''' ''width''
-
    * Returns: object apRet
+
 
-
  * CreateControlFromVirtual (string controlName, object parent, string virtualName)
+
* IsChildOf('''object''' ''desiredParent'')
-
    * Returns: object apRet
+
** ''Returns:'' '''bool''' ''isChild''
-
  * CreateTopLevelWindow (string arg1)
+
 
-
    * Returns: object apRet
+
* IsControlHidden()
-
  * GetControlByName (string name, string suffix)
+
** ''Returns:'' '''bool''' ''hidden''
-
    * Returns: object ret
+
 
-
  * GetFocusControl ()
+
* IsHandlerSet('''string''' ''handlerName'')
-
    * Returns: object focusControl
+
** ''Returns:'' '''bool''' ''isSet''
-
  * GetMouseOverControl ()
+
 
-
    * Returns: object mouseOverControl
+
* IsHidden()
-
  * IsHandlingHardwareEvent ()
+
** ''Returns:'' '''bool''' ''hidden''
-
    * Returns: bool isHandlingHardwareEvent
+
 
-
  * IsMouseOverWorld ()
+
* IsKeyboardEnabled()
-
    * Returns: bool isMouseOverWorld
+
** ''Returns:'' '''bool''' ''enabled''
-
  * SetFocusByName (string name)
+
 
-
  * SetMouseCursor (integer cursorType)
+
* IsMouseEnabled()
 +
** ''Returns:'' '''bool''' ''enabled''
 +
 
 +
* RegisterForEvent('''integer''' ''event'', '''function''' ''callback'')
 +
** ''Returns:'' '''bool''' ''success''
 +
 
 +
* SetAlpha '''protected-attributes''' ('''number''' ''alpha'')
 +
 
 +
* SetAnchor '''protected-attributes''' ('''integer''' ''whereOnMe'', '''object''' ''anchorTargetControl'', '''integer''' ''whereOnTarget'', '''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 
 +
* SetAnchorFill '''protected-attributes''' ('''object''' ''anchorTargetControl'')
 +
 
 +
* SetClampedToScreen('''bool''' ''clamped'')
 +
 
 +
* SetClampedToScreenInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 
 +
* SetDimensionConstraints('''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight'')
 +
 
 +
* SetDimensions '''protected-attributes''' ('''number''' ''width'', '''number''' ''height'')
 +
 
 +
* SetDrawLayer '''protected-attributes''' ('''integer''' ''layer'')
 +
 
 +
* SetDrawLevel '''protected-attributes''' ('''integer''' ''level'')
 +
 
 +
* SetDrawTier '''protected-attributes''' ('''integer''' ''tier'')
 +
 
 +
* SetExcludeFromResizeToFitExtents '''protected-attributes''' ('''bool''' ''exclude'')
 +
 
 +
* SetHandler('''string''' ''handlerName'', '''function''' ''functionRef'')
 +
 
 +
* SetHeight '''protected-attributes''' ('''number''' ''height'')
 +
 
 +
* SetHidden '''protected-attributes''' ('''bool''' ''aHidden'')
 +
 
 +
* SetHitInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 
 +
* SetId('''integer''' ''id'')
 +
 
 +
* SetInheritAlpha('''bool''' ''inheritAlpha'')
 +
 
 +
* SetInheritScale('''bool''' ''inheritScale'')
 +
 
 +
* SetKeyboardEnabled '''protected-attributes''' ('''bool''' ''enabled'')
 +
 
 +
* SetMouseEnabled '''protected-attributes''' ('''bool''' ''enabled'')
 +
 
 +
* SetMovable('''bool''' ''isMovable'')
 +
 
 +
* SetParent '''protected-attributes''' ('''object''' ''newParent'')
 +
 
 +
* SetResizeHandleSize('''number''' ''handleSize'')
 +
 
 +
* SetResizeToFitDescendents '''protected-attributes''' ('''bool''' ''resize'')
 +
 
 +
* SetResizeToFitPadding('''number''' ''width'', '''number''' ''height'')
 +
 
 +
* SetScale '''protected-attributes''' ('''number''' ''scale'')
 +
 
 +
* SetShapeType '''public''' ('''integer''' ''shapeType'')
 +
 
 +
* SetSimpleAnchor '''protected-attributes''' ('''object''' ''anchorTargetControl'', '''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 
 +
* SetSimpleAnchorParent '''protected-attributes''' ('''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 
 +
* SetWidth '''protected-attributes''' ('''number''' ''width'')
 +
 
 +
* StartMoving '''protected-attributes''' ()
 +
** ''Returns:'' '''bool''' ''isMoving''
 +
 
 +
* StopMovingOrResizing '''protected-attributes''' ()
 +
 
 +
* ToggleHidden '''protected-attributes''' ()
 +
 
 +
* UnregisterForEvent('''integer''' ''event'')
 +
** ''Returns:'' '''bool''' ''success''
 +
 
 +
 
 +
=== CooldownControl ===
 +
* GetDuration()
 +
** ''Returns:'' '''integer''' ''duration''
 +
 
 +
* GetTimeLeft()
 +
** ''Returns:'' '''integer''' ''time''
 +
 
 +
* ResetCooldown()
 +
 
 +
* SetBlendMode('''integer''' ''blendMode'')
 +
 
 +
* SetCooldownRemainTime('''integer''' ''remain'')
 +
 
 +
* SetFillColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetLeadingEdgeTexture('''string''' ''filename'')
 +
 
 +
* SetTexture('''string''' ''filename'')
 +
 
 +
* SetVerticalCooldownLeadingEdgeHeight('''integer''' ''leadingEdgeHeight'')
 +
 
 +
* StartCooldown('''integer''' ''remain'', '''integer''' ''duration'', '''integer''' ''cooldownType'', '''integer''' ''cooldownTimeType'', '''bool''' ''drawLeadingEdge'')
 +
 
 +
 
 +
=== DebugTextControl ===
 +
* Clear()
 +
 
 +
* SetFont('''string''' ''fontStr'')
 +
 
 +
 
 +
=== EditControl ===
 +
* AddValidCharacter('''string''' ''validCharacter'')
 +
 
 +
* Clear()
 +
 
 +
* ClearSelection()
 +
 
 +
* CopyAllTextToClipboard()
 +
 
 +
* GetCopyEnabled()
 +
** ''Returns:'' '''bool''' ''enabled''
 +
 
 +
* GetCursorPosition()
 +
** ''Returns:'' '''integer''' ''cursorPosition''
 +
 
 +
* GetEditEnabled()
 +
** ''Returns:'' '''bool''' ''enabled''
 +
 
 +
* GetFontHeight()
 +
** ''Returns:'' '''number''' ''fontHeight''
 +
 
 +
* GetNewLineEnabled()
 +
** ''Returns:'' '''bool''' ''enabled''
 +
 
 +
* GetPasteEnabled()
 +
** ''Returns:'' '''bool''' ''enabled''
 +
 
 +
* GetText()
 +
** ''Returns:'' '''string''' ''apRet''
 +
 
 +
* HasFocus()
 +
** ''Returns:'' '''bool''' ''aRet''
 +
 
 +
* HasSelection()
 +
** ''Returns:'' '''bool''' ''hasSelection''
 +
 
 +
* InsertText('''string''' ''aText'')
 +
 
 +
* IsMultiLine()
 +
** ''Returns:'' '''bool''' ''isMultiLine''
 +
 
 +
* LoseFocus()
 +
 
 +
* SelectAll()
 +
 
 +
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetCopyEnabled('''bool''' ''enabled'')
 +
 
 +
* SetCursorPosition('''integer''' ''cursorPosition'')
 +
 
 +
* SetEditEnabled('''bool''' ''enabled'')
 +
 
 +
* SetFont('''string''' ''font'')
 +
 
 +
* SetMaxInputChars('''integer''' ''maxChars'')
 +
 
 +
* SetMultiLine('''bool''' ''isMultiLine'')
 +
 
 +
* SetNewLineEnabled('''bool''' ''enabled'')
 +
 
 +
* SetPasteEnabled('''bool''' ''enabled'')
 +
 
 +
* SetSelection('''integer''' ''selectionStartIndex'', '''integer''' ''selectionEndIndex'')
 +
 
 +
* SetSelectionColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetText('''string''' ''aText'')
 +
 
 +
* SetTextType('''integer''' ''textType'')
 +
 
 +
* TakeFocus()
 +
 
 +
 
 +
=== FontObject ===
 +
* GetFontInfo()
 +
** ''Returns:'' '''string''' ''face'', '''integer''' ''size'', '''string''' ''option''
 +
 
 +
* SetFont('''string''' ''fontDescriptor'')
 +
 
 +
 
 +
=== LabelControl ===
 +
* AnchorToBaseline('''object''' ''toLabel'', '''number''' ''offsetX'', '''[AnchorPosition|#AnchorPosition]''' ''anchorSide'')
 +
 
 +
* ClearAnchorToBaseline('''object''' ''toLabel'')
 +
 
 +
* DidLineWrap()
 +
** ''Returns:'' '''bool''' ''didLineWrap''
 +
 
 +
* GetColor()
 +
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* GetFontHeight()
 +
** ''Returns:'' '''number''' ''fontHeight''
 +
 
 +
* GetHorizontalAlignment()
 +
** ''Returns:'' '''integer''' ''align''
 +
 
 +
* GetModifyTextType()
 +
** ''Returns:'' '''[ModifyTextType|#ModifyTextType]''' ''modifyTextType''
 +
 
 +
* GetStringWidth('''string''' ''text'')
 +
** ''Returns:'' '''number''' ''width''
 +
 
 +
* GetStyleColor()
 +
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* GetText()
 +
** ''Returns:'' '''string''' ''apRet''
 +
 
 +
* GetTextDimensions()
 +
** ''Returns:'' '''number''' ''stringWidth'', '''number''' ''stringHeight''
 +
 
 +
* GetTextHeight()
 +
** ''Returns:'' '''number''' ''stringHeight''
 +
 
 +
* GetTextWidth()
 +
** ''Returns:'' '''number''' ''stringWidth''
 +
 
 +
* GetVerticalAlignment()
 +
** ''Returns:'' '''integer''' ''align''
 +
 
 +
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetFont('''string''' ''fontString'')
 +
 
 +
* SetHorizontalAlignment('''integer''' ''align'')
 +
 
 +
* SetLineSpacing('''integer''' ''newLineX'')
 +
 
 +
* SetModifyTextType('''[ModifyTextType|#ModifyTextType]''' ''modifyTextType'')
 +
 
 +
* SetNewLineX('''number''' ''newLineX'')
 +
 
 +
* SetStyleColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetText('''string''' ''aText'')
 +
 
 +
* SetVerticalAlignment('''integer''' ''verticalAlign'')
 +
 
 +
* SetWrapMode('''integer''' ''wrapMode'')
 +
 
 +
* WasTruncated()
 +
** ''Returns:'' '''bool''' ''wasTruncated''
 +
 
 +
 
 +
=== LineControl ===
 +
* GetColor()
 +
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* GetTextureInfo()
 +
** ''Returns:'' '''string''' ''filename'', '''integer''' ''addressMode'', '''integer''' ''blendMode'', '''number''' ''desaturation'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'', '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
 +
 
 +
* SetBlendMode('''integer''' ''blendMode'')
 +
 
 +
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetDesaturation('''number''' ''desaturation'')
 +
 
 +
* SetGradientColors('''integer''' ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* SetTexture('''string''' ''filename'')
 +
 
 +
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* SetThickness('''number''' ''thickness'')
 +
 
 +
* SetVertexColors('''integer''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
 +
 
 +
 
 +
=== MapDisplayControl ===
 +
* GetZoom()
 +
** ''Returns:'' '''number''' ''normalizedRadius''
 +
 
 +
* SetPinFont('''string''' ''pinFont'')
 +
 
 +
* SetZoom('''number''' ''normalizedRadius'')
 +
 
 +
 
 +
=== RootWindow ===
 +
 
 +
=== ScrollControl ===
 +
* GetScrollExtents()
 +
** ''Returns:'' '''number''' ''horizontal'', '''number''' ''vertical''
 +
 
 +
* GetScrollOffsets()
 +
** ''Returns:'' '''number''' ''horizontal'', '''number''' ''vertical''
 +
 
 +
* RestoreToExtents('''integer''' ''duration'')
 +
 
 +
* SetFadeGradient('''luaindex''' ''gradientIndex'', '''number''' ''normalX'', '''number''' ''normalY'', '''number''' ''gradientLength'')
 +
 
 +
* SetHorizontalScroll('''number''' ''offset'')
 +
 
 +
* SetScrollBounding('''integer''' ''bounding'')
 +
 
 +
* SetVerticalScroll('''number''' ''offset'')
 +
 
 +
 
 +
=== SliderControl ===
 +
* DoesAllowDraggingFromThumb()
 +
** ''Returns:'' '''bool''' ''allow''
 +
 
 +
* GetEnabled()
 +
** ''Returns:'' '''bool''' ''isEnabled''
 +
 
 +
* GetMinMax()
 +
** ''Returns:'' '''number''' ''min'', '''number''' ''max''
 +
 
 +
* GetOrientation()
 +
** ''Returns:'' '''integer''' ''orientation''
 +
 
 +
* GetThumbTextureControl()
 +
** ''Returns:'' '''object''' ''textureControl''
 +
 
 +
* GetValue()
 +
** ''Returns:'' '''number''' ''value''
 +
 
 +
* GetValueStep()
 +
** ''Returns:'' '''number''' ''step''
 +
 
 +
* IsThumbFlushWithExtents()
 +
** ''Returns:'' '''bool''' ''flush''
 +
 
 +
* SetAllowDraggingFromThumb('''bool''' ''allow'')
 +
 
 +
* SetBackgroundBottomTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
 +
 
 +
* SetBackgroundMiddleTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
 +
 
 +
* SetBackgroundTopTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
 +
 
 +
* SetEnabled('''bool''' ''enable'')
 +
 
 +
* SetMinMax('''number''' ''min'', '''number''' ''max'')
 +
 
 +
* SetOrientation('''integer''' ''orientation'')
 +
 
 +
* SetThumbFlushWithExtents('''bool''' ''flush'')
 +
 
 +
* SetThumbTexture('''string''' ''filename'', '''string''' ''disabledFilename'', '''string''' ''highlightedFilename'', '''number''' ''thumbWidth'', '''number''' ''thumbHeight'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
 +
 
 +
* SetThumbTextureHeight('''number''' ''height'')
 +
 
 +
* SetValue('''number''' ''value'')
 +
 
 +
* SetValueStep('''number''' ''step'')
 +
 
 +
 
 +
=== StatusBarControl ===
 +
* ClearFadeOutLossAdjustedTopValue()
 +
 
 +
* EnableFadeOut('''bool''' ''enabled'')
 +
 
 +
* EnableLeadingEdge('''bool''' ''enabled'')
 +
 
 +
* EnableScrollingOverlay('''bool''' ''enabled'')
 +
 
 +
* GetMinMax()
 +
** ''Returns:'' '''number''' ''min'', '''number''' ''max''
 +
 
 +
* GetValue()
 +
** ''Returns:'' '''number''' ''value''
 +
 
 +
* SetBarAlignment('''integer''' ''barAlignment'')
 +
 
 +
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetFadeOutGainColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetFadeOutLossAdjustedTopValue('''number''' ''topValue'')
 +
 
 +
* SetFadeOutLossColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetFadeOutLossSetValueToAdjust('''number''' ''adjustValue'')
 +
 
 +
* SetFadeOutTexture('''string''' ''filename'')
 +
 
 +
* SetFadeOutTime('''number''' ''fadeOutSeconds'', '''number''' ''fadeOutDelaySeconds'')
 +
 
 +
* SetGradientColors('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* SetLeadingEdge('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'')
 +
 
 +
* SetLeadingEdgeTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* SetMinMax('''number''' ''aMin'', '''number''' ''aMax'')
 +
 
 +
* SetOrientation('''integer''' ''orientation'')
 +
 
 +
* SetTexture('''string''' ''filename'')
 +
 
 +
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* SetValue('''number''' ''aValue'')
 +
 
 +
* SetupScrollingOverlay('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'', '''integer''' ''duration'')
 +
 
 +
 
 +
=== TextBufferControl ===
 +
* AddMessage('''string''' ''aText'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''integer''' ''colorId'')
 +
 
 +
* Clear()
 +
 
 +
* GetDrawLastEntryIfOutOfRoom()
 +
** ''Returns:'' '''bool''' ''drawLastIfOutOfRoom''
 +
 
 +
* GetLineFade()
 +
** ''Returns:'' '''number''' ''timeBeforeLineBeginsToFade'', '''number''' ''timeItTakesLineToFade''
 +
 
 +
* GetLinkEnabled()
 +
** ''Returns:'' '''bool''' ''linkEnabed''
 +
 
 +
* GetMaxHistoryLines()
 +
** ''Returns:'' '''integer''' ''numLines''
 +
 
 +
* GetNumHistoryLines()
 +
** ''Returns:'' '''integer''' ''numLines''
 +
 
 +
* GetNumVisibleLines()
 +
** ''Returns:'' '''integer''' ''numLines''
 +
 
 +
* GetScrollPosition()
 +
** ''Returns:'' '''integer''' ''scrollPosition''
 +
 
 +
* IsSplittingLongMessages()
 +
** ''Returns:'' '''bool''' ''isSplitting''
 +
 
 +
* MoveScrollPosition('''integer''' ''numLines'')
 +
 
 +
* SetClearBufferAfterFadeout('''bool''' ''clearAfterFade'')
 +
 
 +
* SetColorById('''integer''' ''colorId'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
 +
 
 +
* SetDrawLastEntryIfOutOfRoom('''bool''' ''drawLastIfOutOfRoom'')
 +
 
 +
* SetFont('''string''' ''fontString'')
 +
 
 +
* SetHorizontalAlignment('''integer''' ''align'')
 +
 
 +
* SetLineFade('''number''' ''timeBeforeLineFadeBegins'', '''number''' ''timeForLineToFade'')
 +
 
 +
* SetLinkEnabled('''bool''' ''linkEnabed'')
 +
 
 +
* SetMaxHistoryLines('''integer''' ''numLines'')
 +
 
 +
* SetScrollPosition('''integer''' ''line'')
 +
 
 +
* SetSplitLongMessages('''bool''' ''splitLongMessages'')
 +
 
 +
* ShowFadedLines()
 +
 
 +
 
 +
=== TextureControl ===
 +
* GetColor()
 +
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* GetResizeToFitFile()
 +
** ''Returns:'' '''bool''' ''resizesToFitFile''
 +
 
 +
* GetTextureFileDimensions()
 +
** ''Returns:'' '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
 +
 
 +
* GetTextureInfo()
 +
** ''Returns:'' '''string''' ''filename'', '''integer''' ''addressMode'', '''integer''' ''blendMode'', '''number''' ''desaturation'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'', '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
 +
 
 +
* IsTextureLoaded()
 +
** ''Returns:'' '''bool''' ''loaded''
 +
 
 +
* SetAddressMode('''integer''' ''addressMode'')
 +
 
 +
* SetAutoAdjustWrappedCoords('''bool''' ''enabled'')
 +
 
 +
* SetBlendMode('''integer''' ''blendMode'')
 +
 
 +
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetDesaturation('''number''' ''desaturation'')
 +
 
 +
* SetGradientColors('''integer''' ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* SetPixelRounding('''bool''' ''pixelRoundingEnabled'')
 +
 
 +
* SetResizeToFitFile('''bool''' ''resizesToFitFile'')
 +
 
 +
* SetTexture('''string''' ''filename'')
 +
 
 +
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* SetTextureCoordsRotation('''number''' ''angleInRadians'')
 +
 
 +
* SetTextureRotation('''number''' ''angleInRadians'', '''number''' ''normalizedRotationPointX'', '''number''' ''normalizedRotationPointY'')
 +
 
 +
* SetVertexColors('''integer''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
 +
 
 +
 
 +
=== TooltipControl ===
 +
* AddControl('''object''' ''control'', '''integer''' ''cell'', '''bool''' ''useLastRow'')
 +
 
 +
* AddHeaderControl('''object''' ''control'', '''integer''' ''headerRow'', '''[TooltipHeaderSide|#TooltipHeaderSide]''' ''headerSide'')
 +
 
 +
* AddHeaderLine('''string''' ''text'', '''string''' ''font'', '''integer''' ''headerRow'', '''[TooltipHeaderSide|#TooltipHeaderSide]''' ''headerSide'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
 +
 
 +
* AddLine('''string''' ''text'', '''string''' ''font'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''[AnchorPosition|#AnchorPosition]''' ''lineAnchor'', '''[ModifyTextType|#ModifyTextType]''' ''modifyTextType'', '''[TextAlignment|#TextAlignment]''' ''textAlignment'', '''bool''' ''setToFullSize'')
 +
 
 +
* AddVerticalPadding('''number''' ''paddingY'')
 +
 
 +
* AppendAvAObjective('''integer''' ''queryType'', '''integer''' ''keepId'', '''integer''' ''objectiveId'', '''bool''' ''isSpawnPosition'')
 +
 
 +
* AppendMapPing('''integer''' ''pingType'', '''string''' ''unitTag'')
 +
 
 +
* AppendQuestCondition('''luaindex''' ''questIndex'', '''luaindex''' ''stepIndex'', '''luaindex''' ''conditionIndex'')
 +
 
 +
* AppendQuestEnding('''luaindex''' ''questIndex'')
 +
 
 +
* AppendUnitName('''string''' ''unitTag'')
 +
 
 +
* AppendYourCorpse()
 +
 
 +
* ClearLines()
 +
 
 +
* GetOwner()
 +
** ''Returns:'' '''object''' ''owner''
 +
 
 +
* HideComparativeTooltips()
 +
 
 +
* SetAbility('''luaindex''' ''aAbilityIndex'', '''bool''' ''aShowBase'')
 +
 
 +
* SetAchievement('''integer''' ''aAchievementId'')
 +
 
 +
* SetAchievementRewardItem('''integer''' ''aAchievementId'', '''luaindex''' ''aRewardItem'')
 +
 
 +
* SetAction('''luaindex''' ''aSlotId'')
 +
 
 +
* SetAsComparativeTooltip1()
 +
 
 +
* SetAsComparativeTooltip2()
 +
 
 +
* SetAttachedMailItem('''id64''' ''aMailId'', '''luaindex''' ''aAttachSlot'')
 +
 
 +
* SetAttributePassive('''integer''' ''attribute'', '''luaindex''' ''passiveIndex'')
 +
 
 +
* SetBagItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'')
 +
 
 +
* SetBook('''luaindex''' ''categoryIndex'', '''luaindex''' ''collectionIndex'', '''luaindex''' ''bookIndex'')
 +
 
 +
* SetBuff('''integer''' ''aBuffSlotId'', '''string''' ''unitTag'')
 +
 
 +
* SetBuybackItem('''luaindex''' ''entryIndex'')
 +
 
 +
* SetEmperorBonusAbility('''integer''' ''campaignId'', '''integer''' ''alliance'')
 +
 
 +
* SetFont('''string''' ''fontStr'')
 +
 
 +
* SetHeaderRowSpacing('''number''' ''spacing'')
 +
 
 +
* SetHeaderVerticalOffset('''number''' ''verticalOffset'')
 +
 
 +
* SetHookPointStoreEntry('''luaindex''' ''hookPointIndex'', '''luaindex''' ''storeIndex'')
 +
 
 +
* SetItemUsingEnchantment('''integer''' ''itemBagIndex'', '''integer''' ''itemSlotIndex'', '''integer''' ''enchantmentBagIndex'', '''integer''' ''enchantmentSlotIndex'')
 +
 
 +
* SetKeepBonusAbility('''luaindex''' ''bonusIndex'')
 +
 
 +
* SetKeepUpgrade('''integer''' ''keepId'', '''integer''' ''battlegroundContext'', '''integer''' ''upgradeLine'', '''integer''' ''level'', '''luaindex''' ''index'')
 +
 
 +
* SetLastCraftingResultItem('''luaindex''' ''resultIndex'')
 +
 
 +
* SetLink('''string''' ''aLink'')
 +
 
 +
* SetLootItem('''integer''' ''lootId'')
 +
 
 +
* SetMinHeaderRowHeight('''number''' ''minRowHeight'')
 +
 
 +
* SetMinHeaderRows('''integer''' ''minRows'')
 +
 
 +
* SetMount('''luaindex''' ''aStableIndex'')
 +
 
 +
* SetOwner('''object''' ''owner'', '''integer''' ''position'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''integer''' ''relativePoint'')
 +
 
 +
* SetPendingAlchemyItem('''integer''' ''solventBagId'', '''integer''' ''solventSlotIndex'', '''integer''' ''reagent1BagId'', '''integer''' ''reagent1SlotIndex'', '''integer''' ''reagent2BagId'', '''integer''' ''reagent2SlotIndex'', '''integer:nilable''' ''reagent3BagId'', '''integer:nilable''' ''reagent3SlotIndex'')
 +
 
 +
* SetPendingEnchantingItem('''integer''' ''potencyRuneBagId'', '''integer''' ''potencyRuneSlotIndex'', '''integer''' ''essenceRuneBagId'', '''integer''' ''essenceRuneSlotIndex'', '''integer''' ''aspectRuneBagId'', '''integer''' ''aspectRuneSlotIndex'')
 +
 
 +
* SetPendingSmithingItem('''luaindex''' ''patternIndex'', '''luaindex''' ''materialIndex'', '''integer''' ''materialQuantity'', '''luaindex''' ''styleIndex'', '''luaindex''' ''traitIndex'')
 +
 
 +
* SetPlugItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'', '''luaindex''' ''socketIndex'')
 +
 
 +
* SetProgressionAbility('''luaindex''' ''aProgressionIndex'', '''integer''' ''aMorph'', '''integer''' ''aRank'')
 +
 
 +
* SetProvisionerIngredientItem('''luaindex''' ''recipeListIndex'', '''luaindex''' ''recipeIndex'', '''luaindex''' ''ingredientIndex'')
 +
 
 +
* SetProvisionerResultItem('''luaindex''' ''recipeListIndex'', '''luaindex''' ''recipeIndex'')
 +
 
 +
* SetQuestItem('''luaindex''' ''questIndex'', '''luaindex''' ''stepIndex'', '''luaindex''' ''conditionIndex'')
 +
 
 +
* SetQuestReward('''luaindex''' ''aPerkIndex'')
 +
 
 +
* SetQuestTool('''luaindex''' ''questIndex'', '''luaindex''' ''toolIndex'')
 +
 
 +
* SetScrollBonusAbility('''integer''' ''alliance'', '''integer''' ''artifactType'', '''luaindex''' ''bonusIndex'')
 +
 
 +
* SetSiegeFire()
 +
 
 +
* SetSkillAbility('''integer''' ''skillType'', '''luaindex''' ''skillIndex'', '''luaindex''' ''abilityIndex'')
 +
 
 +
* SetSkillLine('''integer''' ''skillType'', '''luaindex''' ''skillIndex'')
 +
 
 +
* SetSkillUpgradeAbility('''integer''' ''skillType'', '''luaindex''' ''skillIndex'', '''luaindex''' ''abilityIndex'')
 +
 
 +
* SetSmithingImprovementItem('''integer''' ''craftingSkillType'', '''luaindex''' ''improvementItemIndex'')
 +
 
 +
* SetSmithingImprovementResult('''integer''' ''itemToImproveBagId'', '''integer''' ''itemToImproveSlotIndex'', '''integer''' ''craftingSkillType'')
 +
 
 +
* SetSmithingMaterialItem('''luaindex''' ''patternIndex'', '''luaindex''' ''materialIndex'')
 +
 
 +
* SetSmithingStyleItem('''luaindex''' ''styleItemIndex'')
 +
 
 +
* SetSmithingTraitItem('''luaindex''' ''traitItemIndex'')
 +
 
 +
* SetSocketingItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'')
 +
 
 +
* SetStoreAlternateCurrencyItem('''luaindex''' ''entryIndex'', '''integer''' ''offset'')
 +
 
 +
* SetStoreItem('''luaindex''' ''entryIndex'')
 +
 
 +
* SetSynergyBuff('''integer''' ''aBuffSlotId'')
 +
 
 +
* SetTradeItem('''integer''' ''aWho'', '''luaindex''' ''aTradeIndex'')
 +
 
 +
* SetTradingHouseItem('''luaindex''' ''tradingHouseIndex'')
 +
 
 +
* SetTradingHouseListing('''luaindex''' ''tradingHouseIndex'')
 +
 
 +
* SetUnit('''string''' ''aUnitTag'')
 +
 
 +
* SetWeaponSetAbility('''luaindex''' ''aWeaponSet'', '''integer''' ''aRank'')
 +
 
 +
* SetWornItem('''integer''' ''equipSlot'')
 +
 
 +
* ShowComparativeTooltips()
 +
 
 +
 
 +
=== TopLevelWindow ===
 +
* AllowBringToTop()
 +
** ''Returns:'' '''bool''' ''allow''
 +
 
 +
* BringWindowToTop '''protected-attributes''' ()
 +
 
 +
* SetAllowBringToTop '''protected-attributes''' ('''bool''' ''allow'')
 +
 
 +
* SetDrawWhenGuiHidden '''private''' ('''bool''' ''drawWhenHidden'')
 +
 
 +
* SetTopmost '''protected-attributes''' ('''bool''' ''isTopmost'')
 +
 
 +
 
 +
=== WindowManager ===
 +
* CreateControl('''string''' ''arg1'', '''object''' ''parent'', '''integer''' ''type'')
 +
** ''Returns:'' '''object''' ''apRet''
 +
 
 +
* CreateControlFromVirtual('''string''' ''controlName'', '''object''' ''parent'', '''string''' ''virtualName'')
 +
** ''Returns:'' '''object''' ''apRet''
 +
 
 +
* CreateTopLevelWindow('''string''' ''arg1'')
 +
** ''Returns:'' '''object''' ''apRet''
 +
 
 +
* GetControlByName('''string''' ''name'', '''string''' ''suffix'')
 +
** ''Returns:'' '''object''' ''ret''
 +
 
 +
* GetFocusControl()
 +
** ''Returns:'' '''object''' ''focusControl''
 +
 
 +
* GetMouseOverControl()
 +
** ''Returns:'' '''object''' ''mouseOverControl''
 +
 
 +
* IsHandlingHardwareEvent()
 +
** ''Returns:'' '''bool''' ''isHandlingHardwareEvent''
 +
 
 +
* IsMouseOverWorld()
 +
** ''Returns:'' '''bool''' ''isMouseOverWorld''
 +
 
 +
* SetFocusByName('''string''' ''name'')
 +
 
 +
* SetMouseCursor('''integer''' ''cursorType'')

Revision as of 23:54, 28 February 2014

Contents

AddOnManager


AnimationManager


AnimationObject

Objects that inherit behavior from AnimationObject


AnimationObjectAlpha


AnimationObjectColor


AnimationObjectCustom


AnimationObjectScale


AnimationObjectScroll


AnimationObjectSize


AnimationObjectTexture


AnimationObjectTextureRotate


AnimationObjectTextureSlide


AnimationObjectTranslate


AnimationTimeline


BackdropControl


BrowserControl


ButtonControl


ColorSelectControl


CompassDisplayControl


Control

Objects that inherit behavior from Control [BackdropControl|#BackdropControl], [BrowserControl|#BrowserControl], [ButtonControl|#ButtonControl], [ColorSelectControl|#ColorSelectControl], [CompassDisplayControl|#CompassDisplayControl], [CooldownControl|#CooldownControl], [DebugTextControl|#DebugTextControl], [EditControl|#EditControl], [LabelControl|#LabelControl], [LineControl|#LineControl], [MapDisplayControl|#MapDisplayControl], [RootWindow|#RootWindow], [ScrollControl|#ScrollControl], [SliderControl|#SliderControl], [StatusBarControl|#StatusBarControl], [TextBufferControl|#TextBufferControl], [TextureControl|#TextureControl], [TooltipControl|#TooltipControl], [TopLevelWindow|#TopLevelWindow]


CooldownControl


DebugTextControl


EditControl


FontObject


LabelControl


LineControl


MapDisplayControl


RootWindow

ScrollControl


SliderControl


StatusBarControl


TextBufferControl


TextureControl


TooltipControl


TopLevelWindow


WindowManager

Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox