Controls

From ESOUI Wiki

Page up-to-date to API Version 100021

Introduction

This is the list of the different functions (methods) of the UI Objects of Elder Scrolls Online. Objects can be defined throught XML or in Lua

Object creation

XML

<!-- Basic -->
<Label name="objectName" />
 
 
<!-- With few elements -->
<Label name="Name" font="ZoFontGame" verticalAlignment="CENTER">
	<Dimensions x="350" y="48" />
	<Anchor point="TOPLEFT" relativeTo="$(parent)" />
</Label>

LUA

-- Will create a new control without any parent.
CreateControl("ControlName", CT_LABEL ) -- See http://wiki.esoui.com/Globals#ControlType

Then, you can call any of the methods listed under :

For our LabelControl :

objectName:SetText("Something") -- Object defined in the XML snippet.
Name:SetColor(1, 1, 1) -- Object defined in the XML snippet.
local text = ControlName:GetText() -- Object defined in the Lua snippet.

Objects Types and their methods

All UI elements are inheriting the functions defined in Control.

AddOnManager

• AddRelevantFilter(string relevantFilter)

• GetAddOnDependencyInfo(number addOnIndex, number addOnDependencyIndex)
  • Returns: string name, boolean active

• GetAddOnFilter()
  • Returns: string settingFilter

• GetAddOnInfo(number addOnIndex)
  • Returns: string name, string title, string author, string description, boolean enabled, number AddOnLoadState state, boolean isOutOfDate

• GetAddOnNumDependencies(number addOnIndex)
  • Returns: number numDependencies

• GetLoadOutOfDateAddOns()
  • Returns: boolean loadOutOfDateAddons

• GetNumAddOns()
  • Returns: number numAddOns

• RemoveAddOnFilter()

• ResetRelevantFilters()

• SetAddOnEnabled(number addOnIndex, boolean enabled)

• SetAddOnFilter(string settingFilter)

• SetLoadOutOfDateAddOns(boolean loadOutOfDateAddons)

AnimationManager

• CreateTimeline()
  • Returns: object timeline

• CreateTimelineFromVirtual(string timelineName, object animatedControl)
  • Returns: object timeline

AnimationObject

Objects that inherit behavior from AnimationObject

• AnimationObject3DRotate,
• AnimationObject3DTranslate,
• AnimationObjectAlpha,
• AnimationObjectColor,
• AnimationObjectCustom,
• AnimationObjectScale,
• AnimationObjectScroll,
• AnimationObjectSize,
• AnimationObjectTexture,
• AnimationObjectTextureRotate,
• AnimationObjectTextureSlide,
• AnimationObjectTranslate

• GetAnimatedControl()
  • Returns: object animatedControl

• GetDuration()
  • Returns: number durationMs

• GetEasingFunction()
  • Returns: function functionRef

• GetHandler(string EventName)
  • Returns: function FunctionRef

• GetTimeline()
  • Returns: object owningTimeline

• IsPlaying()
  • Returns: boolean isPlaying

• SetAnimatedControl(object animatedControl)

• SetDuration(number durationMs)

• SetEasingFunction(function functionRef)

• SetHandler(string EventName, function FunctionRef)

AnimationObject3DRotate

• GetEndPitch()
  • Returns: number endPitchRadians

• GetEndRoll()
  • Returns: number endRollRadians

• GetEndYaw()
  • Returns: number endYawRadians

• GetStartPitch()
  • Returns: number startPitchRadians

• GetStartRoll()
  • Returns: number startRollRadians

• GetStartYaw()
  • Returns: number startYawRadians

• SetEndPitch(number endPitchRadians)

• SetEndRoll(number endRollRadians)

• SetEndYaw(number endYawRadians)

• SetRotationValues(number startPitchRadians, number startYawRadians, number startRollRadians, number endPitchRadians, number endYawRadians, number endRollRadians)

• SetStartPitch(number startPitchRadians)

• SetStartRoll(number startRollRadians)

• SetStartYaw(number startYawRadians)

AnimationObject3DTranslate

• ClearBezierControlPoints()

• GetDeltaOffsetX()
  • Returns: number deltaX

• GetDeltaOffsetY()
  • Returns: number deltaY

• GetDeltaOffsetZ()
  • Returns: number deltaZ

• GetEndOffsetX()
  • Returns: number endX

• GetEndOffsetY()
  • Returns: number endY

• GetEndOffsetZ()
  • Returns: number endZ

• GetStartOffsetX()
  • Returns: number startX

• GetStartOffsetY()
  • Returns: number startY

• GetStartOffsetZ()
  • Returns: number startZ

• GetTranslateDeltas()
  • Returns: number deltaX, number deltaY, number deltaZ

• SetBezierControlPoint(number index, number x, number y, number z)

• SetDeltaOffsetX(number deltaX, number TranslateAnimationDeltaType translateAnimationDeltaType)

• SetDeltaOffsetY(number deltaY, number TranslateAnimationDeltaType translateAnimationDeltaType)

• SetDeltaOffsetZ(number deltaZ, number TranslateAnimationDeltaType translateAnimationDeltaType)

• SetEndOffsetX(number endX)

• SetEndOffsetY(number endY)

• SetEndOffsetZ(number endZ)

• SetStartOffsetX(number startX)

• SetStartOffsetY(number startY)

• SetStartOffsetZ(number startZ)

• SetTranslateDeltas(number deltaX, number deltaY, number deltaZ, number TranslateAnimationDeltaType translateAnimationDeltaType)

• SetTranslateOffsets(number startX, number startY, number startZ, number endX, number endY, number endZ)

AnimationObjectAlpha

• GetEndAlpha()
  • Returns: number endAlpha

• GetStartAlpha()
  • Returns: number startAlpha

• SetAlphaValues(number startAlpha, number endAlpha)

• SetEndAlpha(number endAlpha)

• SetStartAlpha(number startAlpha)

AnimationObjectColor

• GetEndColor()
  • Returns: number endR, number endG, number endB, number endA

• GetStartColor()
  • Returns: number startR, number startG, number startB, number startA

• SetColorValues(number startR, number startG, number startB, number startA, number endR, number endG, number endB, number endA)

• SetEndColor(number endR, number endG, number endB, number endA)

• SetStartColor(number startR, number startG, number startB, number startA)

AnimationObjectCustom

• SetUpdateFunction(function functionRef)

AnimationObjectScale

• GetEndScale()
  • Returns: number endScale

• GetStartScale()
  • Returns: number startScale

• SetEndScale(number endScale)

• SetScaleValues(number startScale, number endScale)

• SetStartScale(number startScale)

AnimationObjectScroll

• SetHorizontalEnd(number endX)

• SetHorizontalRelative(number offsetX)

• SetHorizontalStartAndEnd(number startX, number endX)

• SetVerticalEnd(number endY)

• SetVerticalRelative(number offsetY)

• SetVerticalStartAndEnd(number startY, number endY)

AnimationObjectSize

• SetEndHeight(number endHeight)

• SetEndWidth(number endWidth)

• SetStartAndEndHeight(number startHeight, number endHeight)

• SetStartAndEndWidth(number startWidth, number endWidth)

• SetStartHeight(number startHeight)

• SetStartWidth(number startWidth)

AnimationObjectTexture

• GetCellsHigh()
  • Returns: number aNumCellsHigh

• GetCellsWide()
  • Returns: number aNumCellsWide

• IsMirroringAlongX()
  • Returns: boolean mirroring

• IsMirroringAlongY()
  • Returns: boolean mirroring

• SetCellsHigh(number aNumCellsHigh)

• SetCellsWide(number aNumCellsWide)

• SetFramerate(number framesPerSecond)

• SetImageData(number aNumCellsWide, number aNumCellsHigh)

• SetMirrorAlongX(boolean mirroring)

• SetMirrorAlongY(boolean mirroring)

AnimationObjectTextureRotate

• GetEndRotation()
  • Returns: number endRadians

• GetStartRotation()
  • Returns: number startRadians

• SetEndRotation(number endRadians)

• SetRotationValues(number startRadians, number endRadians)

• SetStartRotation(number startRadians)

AnimationObjectTextureSlide

• SetSlideDistances(number slideDistanceU, number slideDistanceV)

AnimationObjectTranslate

• GetAnchorIndex()
  • Returns: number anchorIndex

• GetDeltaOffsetX()
  • Returns: number deltaX

• GetDeltaOffsetY()
  • Returns: number deltaY

• GetEndOffsetX()
  • Returns: number endX

• GetEndOffsetY()
  • Returns: number endY

• GetStartOffsetX()
  • Returns: number startX

• GetStartOffsetY()
  • Returns: number startY

• GetTranslateDeltas()
  • Returns: number deltaX, number deltaY

• SetAnchorIndex(number anchorIndex)

• SetDeltaOffsetX(number deltaX, number TranslateAnimationDeltaType translateAnimationDeltaType)

• SetDeltaOffsetY(number deltaY, number TranslateAnimationDeltaType translateAnimationDeltaType)

• SetEndOffsetX(number endX)

• SetEndOffsetY(number endY)

• SetStartOffsetX(number startX)

• SetStartOffsetY(number startY)

• SetTranslateDeltas(number deltaX, number deltaY, number TranslateAnimationDeltaType translateAnimationDeltaType)

• SetTranslateOffsets(number startX, number startY, number endX, number endY)

AnimationTimeline

• ApplyAllAnimationsToControl(object animatedControl)

• ClearAllCallbacks()

• GetAnimation(number animationIndex)
  • Returns: object animation

• GetAnimationOffset(object animation)
  • Returns: number offset

• GetAnimationTimeline(number timelineIndex)
  • Returns: object timeline

• GetAnimationTimelineOffset(object animation)
  • Returns: number offset

• GetDuration()
  • Returns: number duration

• GetFirstAnimation()
  • Returns: object animation

• GetFirstAnimationTimeline()
  • Returns: object timeline

• GetFullProgress()
  • Returns: number progress

• GetHandler(string EventName)
  • Returns: function FunctionRef

• GetLastAnimation()
  • Returns: object animation

• GetLastAnimationTimeline()
  • Returns: object timeline

• GetNumAnimationTimelines()
  • Returns: number numTimelines

• GetNumAnimations()
  • Returns: number numAnimations

• GetParent()
  • Returns: object timeline

• GetPlaybackLoopsRemaining()
  • Returns: number loopsRemaining

• GetProgress()
  • Returns: number progress

• GetSkipAnimationsBehindPlayheadOnInitialPlay()
  • Returns: boolean skipAnimations

• InsertAnimation(number animationType, object animatedControl, number offset)
  • Returns: object animation

• InsertAnimationFromVirtual(string animationVirtualName, object animatedControl)
  • Returns: object animation

• InsertAnimationTimeline(number offset, object animatedControl)
  • Returns: object animation

• InsertAnimationTimelineFromVirtual(string animationVirtualName, object animatedControl)
  • Returns: object animation

• InsertCallback(function functionRef, number offset)
  • Returns: function functionRefRet

• IsPlaying()
  • Returns: boolean isPlaying

• IsPlayingBackward()
  • Returns: boolean reversed

• PlayBackward()

• PlayForward()

• PlayFromEnd(number offsetMs)

• PlayFromStart(number offsetMs)

• PlayInstantlyToEnd()

• PlayInstantlyToStart()

• SetAnimationOffset(object animation, number offset)

• SetAnimationTimelineOffset(object animation, number offset)

• SetCallbackOffset(function callback, number offset)

• SetHandler(string EventName, function FunctionRef)

• SetPlaybackLoopCount(number maxLoopCount)

• SetPlaybackLoopsRemaining(number loopsRemaining)

• SetPlaybackType(number playbackType, number maxLoopCount)

• SetProgress(number progress)

• SetSkipAnimationsBehindPlayheadOnInitialPlay(boolean skipAnimations)

• Stop()

BackdropControl

• GetCenterColor()
  • Returns: number r, number g, number b, number a

• IsPixelRoundingEnabled()
  • Returns: boolean pixelRoundingEnabled

• SetCenterColor(number r, number g, number b, number a)

• SetCenterTexture(string filename, number tileSize, number addressMode)

• SetEdgeColor(number r, number g, number b, number a)

• SetEdgeTexture(string filename, number edgeFileWidth, number edgeFileHeight, number edgeSize, number edgeFilePadding)

• SetInsets(number left, number top, number right, number bottom)

• SetIntegralWrapping(boolean integralWrappingEnabled)

• SetPixelRoundingEnabled(boolean enabled)

• SetTextureReleaseOption(number ReleaseReferenceOptions releaseOption)

ButtonControl

• EnableMouseButton(number buttonNum, boolean enabled)

• GetLabelControl()
  • Returns: object labelControl

• GetState()
  • Returns: number state

• IsPixelRoundingEnabled()
  • Returns: boolean pixelRoundingEnabled

• SetClickSound(string clickSound)

• SetDesaturation(number desaturation)

• SetDisabledFontColor(number r, number g, number b, number a)

• SetDisabledPressedFontColor(number r, number g, number b, number a)

• SetDisabledPressedTexture(string textureFilename)

• SetDisabledTexture(string textureFilename)

• SetEnabled(boolean enabled)

• SetEndCapWidth(number endCapWidth)

• SetFont(string text)

• SetHorizontalAlignment(number horizontalAlign)

• SetMouseOverBlendMode(number blendMode)

• SetMouseOverFontColor(number r, number g, number b, number a)

• SetMouseOverTexture(string textureFilename)

• SetNormalFontColor(number r, number g, number b, number a)

• SetNormalOffset(number x, number y)

• SetNormalTexture(string textureFilename)

• SetPixelRoundingEnabled(boolean pixelRoundingEnabled)

• SetPressedFontColor(number r, number g, number b, number a)

• SetPressedMouseOverTexture(string textureFilename)

• SetPressedOffset(number x, number y)

• SetPressedTexture(string textureFilename)

• SetShowingHighlight(boolean showingHighlight)

• SetState(number newState, boolean locked)

• SetText(string text)

• SetTextureCoords(number left, number right, number top, number bottom)

• SetTextureReleaseOption(number ReleaseReferenceOptions releaseOption)

• SetVerticalAlignment(number verticalAlign)

ColorSelectControl

• GetColorAsHSV()
  • Returns: number hue, number saturation, number value

• GetColorAsRGB()
  • Returns: number red, number green, number blue

• GetColorWheelTextureControl()
  • Returns: object textureControl

• GetColorWheelThumbTextureControl()
  • Returns: object textureControl

• GetFullValuedColorAsRGB()
  • Returns: number red, number green, number blue

• GetThumbNormalizedPosition()
  • Returns: number normalizedX, number normalizedY

• GetValue()
  • Returns: number value

• SetColorAsHSV(number hue, number saturation, number value)

• SetColorAsRGB(number red, number green, number blue)

• SetColorWheelThumbTextureControl(object textureControl)

• SetThumbNormalizedPosition(number normalizedX, number normalizedY)

• SetValue(number value)

CompassDisplayControl

• GetAlphaCoefficients(number MapDisplayPinType pinType)
  • Returns: number leadingCoefficient, number coefficient, number constant

• GetCenterOveredPinDescription(number centerOveredPinIndex)
  • Returns: string description

• GetCenterOveredPinDistance(number centerOveredPinIndex)
  • Returns: number distance

• GetCenterOveredPinInfo(number centerOveredPinIndex)
  • Returns: string description, number MapDisplayPinType type, number distance, number DrawLayer drawLayer, number drawLevel, boolean suppressed

• GetCenterOveredPinLayerAndLevel(number centerOveredPinIndex)
  • Returns: number DrawLayer drawLayer, number drawLevel

• GetCenterOveredPinType(number centerOveredPinIndex)
  • Returns: number MapDisplayPinType type

• GetMinVisibleAlpha(number MapDisplayPinType pinType)
  • Returns: number minVisibleAlpha

• GetMinVisibleScale(number MapDisplayPinType pinType)
  • Returns: number minVisibleScale

• GetNumCenterOveredPins()
  • Returns: number numCenterOveredPins

• GetScaleCoefficients(number MapDisplayPinType pinType)
  • Returns: number leadingCoefficient, number coefficient, number constant

• IsCenterOveredPinSuppressed(number centerOveredPinIndex)
  • Returns: boolean suppressed

• SetAlphaCoefficients(number MapDisplayPinType pinType, number leadingCoefficient, number coefficient, number constant)

• SetCardinalDirection(string directionName, string font, number cardinalDirection)

• SetMinVisibleAlpha(number MapDisplayPinType pinType, number minVisibleAlpha)

• SetMinVisibleScale(number MapDisplayPinType pinType, number minVisibleScale)

• SetScaleCoefficients(number MapDisplayPinType pinType, number leadingCoefficient, number coefficient, number constant)

Control

Objects that inherit behavior from Control

• BackdropControl,
• ButtonControl,
• ColorSelectControl,
• CompassDisplayControl,
• CooldownControl,
• DebugTextControl,
• EditControl,
• LabelControl,
• LineControl,
• MapDisplayControl,
• RootWindow,
• ScrollControl,
• SliderControl,
• StatusBarControl,
• TextBufferControl,
• TextureCompositeControl,
• TextureControl,
• TooltipControl,
• TopLevelWindow

• AddFilterForEvent(number event)
  • Returns: boolean success

• ClearAnchors()

• Convert3DLocalOrientationToWorldOrientation(number localPitch, number localYaw, number localRoll)
  • Returns: number worldPitch, number worldYaw, number worldRoll

• Convert3DLocalPositionToWorldPosition(number localX, number localY, number localZ)
  • Returns: number worldX, number worldY, number worldZ

• Convert3DWorldOrientationToLocalOrientation(number worldPitch, number worldYaw, number worldRoll)
  • Returns: number localPitch, number localYaw, number localRoll

• Convert3DWorldPositionToLocalPosition(number worldX, number worldY, number worldZ)
  • Returns: number localX, number localY, number localZ

• Create3DRenderSpace()

• CreateControl(string arg1, number type)
  • Returns: object apRet

• Destroy3DRenderSpace()

• Does3DRenderSpaceUseDepthBuffer()
  • Returns: boolean usesDepthBuffer

• Get3DRenderSpaceForward()
  • Returns: number x, number y, number z

• Get3DRenderSpaceOrientation()
  • Returns: number pitchRadians, number yawRadians, number rollRadians

• Get3DRenderSpaceOrigin()
  • Returns: number x, number y, number z

• Get3DRenderSpaceRight()
  • Returns: number x, number y, number z

• Get3DRenderSpaceSystem()
  • Returns: number GuiRender3DSpaceSystem system

• Get3DRenderSpaceUp()
  • Returns: number x, number y, number z

• GetAlpha()
  • Returns: number alpha

• GetAnchor(number anchorIndex)
  • Returns: boolean isValidAnchor, number point, object relativeTo, number relativePoint, number offsetX, number offsetY, number AnchorConstrains anchorConstrains

• GetBottom()
  • Returns: number bottom

• GetCenter()
  • Returns: number centerX, number centerY

• GetChild(number childIndex)
  • Returns: object childControl

• GetClampedToScreen()
  • Returns: boolean clamped

• GetClampedToScreenInsets()
  • Returns: number left, number top, number right, number bottom

• GetControlAlpha()
  • Returns: number alpha

• GetControlScale()
  • Returns: number scale

• GetDesiredHeight()
  • Returns: number height

• GetDesiredWidth()
  • Returns: number width

• GetDimensionConstraints()
  • Returns: number minWidth, number minHeight, number maxWidth, number maxHeight

• GetDimensions()
  • Returns: number width, number height

• GetDrawLayer()
  • Returns: number layer

• GetDrawLevel()
  • Returns: number level

• GetDrawTier()
  • Returns: number tier

• GetExcludeFromResizeToFitExtents()
  • Returns: boolean excludes

• GetHandler(string handlerName)
  • Returns: function functionRef

• GetHeight()
  • Returns: number height

• GetHitInsets()
  • Returns: number left, number top, number right, number bottom

• GetId()
  • Returns: number id

• GetInheritsAlpha()
  • Returns: boolean inheritAlpha

• GetInheritsScale()
  • Returns: boolean inheritScale

• GetLeft()
  • Returns: number left

• GetName()
  • Returns: string name

• GetNamedChild(string childName)
  • Returns: object returnedControl

• GetNumChildren()
  • Returns: number numChildren

• GetOwningWindow()
  • Returns: object OwningTopLevelWindow

• GetParent()
  • Returns: object ret1

• GetResizeToFitDescendents()
  • Returns: boolean resizes

• GetResizeToFitPadding()
  • Returns: number width, number height

• GetRight()
  • Returns: number right

• GetScale()
  • Returns: number scale

• GetScreenRect()
  • Returns: number left, number top, number right, number bottom

• GetTop()
  • Returns: number top

• GetType()
  • Returns: number type

• GetWidth()
  • Returns: number width

• Has3DRenderSpace()
  • Returns: boolean has3DRenderSpace

• IsChildOf(object desiredParent)
  • Returns: boolean isChild

• IsControlHidden()
  • Returns: boolean hidden

• IsHandlerSet(string handlerName)
  • Returns: boolean isSet

• IsHidden()
  • Returns: boolean hidden

• IsKeyboardEnabled()
  • Returns: boolean enabled

• IsMouseEnabled()
  • Returns: boolean enabled

• IsPointInside(number x, number y, number leftOffset, number topOffset, number rightOffset, number bottomOffset)
  • Returns: boolean isInside

• RegisterForEvent(number event, function callback)
  • Returns: boolean success

• Set3DRenderSpaceForward(number x, number y, number z)

• Set3DRenderSpaceOrientation(number pitchRadians, number yawRadians, number rollRadians)

• Set3DRenderSpaceOrigin(number xM, number yM, number zM)

• Set3DRenderSpaceRight(number x, number y, number z)

• Set3DRenderSpaceSystem(number GuiRender3DSpaceSystem system)

• Set3DRenderSpaceUp(number x, number y, number z)

• Set3DRenderSpaceUsesDepthBuffer(boolean usesDepthBuffer)

• SetAlpha(number alpha)

• SetAnchor(number whereOnMe, object anchorTargetControl, number whereOnTarget, number offsetX, number offsetY, number AnchorConstrains anchorConstrains) - http://wiki.esoui.com/Control:SetAnchor

• SetAnchorFill(object anchorTargetControl)

• SetClampedToScreen(boolean clamped)

• SetClampedToScreenInsets(number left, number top, number right, number bottom)

• SetDimensionConstraints(number minWidth, number minHeight, number maxWidth, number maxHeight)

• SetDimensions(number width, number height)

• SetDrawLayer(number layer)

• SetDrawLevel(number level)

• SetDrawTier(number tier)

• SetExcludeFromResizeToFitExtents(boolean exclude)

• SetHandler(string handlerName, function functionRef)

• SetHeight(number height)

• SetHidden(boolean aHidden)

• SetHitInsets(number left, number top, number right, number bottom)

• SetId(number id)

• SetInheritAlpha(boolean inheritAlpha)

• SetInheritScale(boolean inheritScale)

• SetKeyboardEnabled(boolean enabled)

• SetMouseEnabled(boolean enabled)

• SetMovable(boolean isMovable)

• SetParent(object newParent)

• SetResizeHandleSize(number handleSize)

• SetResizeToFitDescendents(boolean resize)

• SetResizeToFitPadding(number width, number height)

• SetScale(number scale)

• SetShapeType (number shapeType)

• SetSimpleAnchor(object anchorTargetControl, number offsetX, number offsetY)

• SetSimpleAnchorParent(number offsetX, number offsetY)

• SetWidth(number width)

• StartMoving()
  • Returns: boolean isMoving

• StopMovingOrResizing()

• ToggleHidden()

• UnregisterForEvent(number event)
  • Returns: boolean success

CooldownControl

• GetDuration()
  • Returns: number duration

• GetPercentCompleteFixed()
  • Returns: number percentComplete

• GetTimeLeft()
  • Returns: number time

• ResetCooldown()

• SetBlendMode(number blendMode)

• SetCooldownRemainTime(number remain)

• SetDesaturation(number desaturation)

• SetFillColor(number r, number g, number b, number a)

• SetLeadingEdgeTexture(string filename)

• SetPercentCompleteFixed(number percentComplete)

• SetRadialCooldownClockwise(boolean clockwise)

• SetRadialCooldownGradient(number startAlpha, number angularDistance)

• SetRadialCooldownOriginAngle(number originAngle)

• SetTexture(string filename)

• SetTextureReleaseOption(number ReleaseReferenceOptions releaseOption)

• SetVerticalCooldownLeadingEdgeHeight(number leadingEdgeHeight)

• StartCooldown(number remain, number duration, number cooldownType, number cooldownTimeType, boolean drawLeadingEdge)

• StartFixedCooldown(number percentComplete, number cooldownType, number cooldownTimeType, boolean drawLeadingEdge)

DebugTextControl

• Clear()

• SetFont(string fontStr)

EditControl

• AddValidCharacter(string validCharacter)

• Clear()

• ClearSelection()

• CopyAllTextToClipboard()

• GetCopyEnabled()
  • Returns: boolean enabled

• GetCursorPosition()
  • Returns: number cursorPosition

• GetEditEnabled()
  • Returns: boolean enabled

• GetFontHeight()
  • Returns: number fontHeightUIUnits

• GetNewLineEnabled()
  • Returns: boolean enabled

• GetPasteEnabled()
  • Returns: boolean enabled

• GetScrollExtents()
  • Returns: number numLines

• GetText()
  • Returns: string apRet

• GetTopLineIndex()
  • Returns: number index

• HasFocus()
  • Returns: boolean aRet

• HasSelection()
  • Returns: boolean hasSelection

• InsertText(string aText)

• IsComposingIMEText()
  • Returns: boolean isComposing

• IsMultiLine()
  • Returns: boolean isMultiLine

• LoseFocus()

• RemoveAllValidCharacters()

• SelectAll()

• SetColor(number r, number g, number b, number a)

• SetCopyEnabled(boolean enabled)

• SetCursorPosition(number cursorPosition)

• SetEditEnabled(boolean enabled)

• SetFont(string font)

• SetMaxInputChars(number maxChars)

• SetMultiLine(boolean isMultiLine)

• SetNewLineEnabled(boolean enabled)

• SetPasteEnabled(boolean enabled)

• SetSelection(number selectionStartIndex, number selectionEndIndex)

• SetSelectionColor(number r, number g, number b, number a)

• SetText(string aText)

• SetTextType(number textType)

• SetTopLineIndex(number index)

• SetVirtualKeyboardType(number VirtualKeyboardType aKeyboardType)

• TakeFocus()

• WasLastChangeVirtualKeyboard()
  • Returns: boolean aRet

FontObject

• GetFontInfo()
  • Returns: string face, number size, string option

• SetFont(string fontDescriptor)

LabelControl

• AnchorToBaseline(object toLabel, number offsetX, number AnchorPosition anchorSide)

• Clean()

• ClearAnchorToBaseline(object toLabel)

• DidLineWrap()
  • Returns: boolean didLineWrap

• GetColor()
  • Returns: number r, number g, number b, number a

• GetFontHeight()
  • Returns: number fontHeightUIUnits

• GetHorizontalAlignment()
  • Returns: number align

• GetModifyTextType()
  • Returns: number ModifyTextType modifyTextType

• GetNumLines()
  • Returns: number numLines

• GetStringWidth(string text)
  • Returns: number pixelWidth

• 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: number align

• SetColor(number r, number g, number b, number a)

• SetDesaturation(number desaturation)

• SetFont(string fontString)

• SetHorizontalAlignment(number align)

• SetLineSpacing(number lineSpacing)

• SetMaxLineCount(number maxLineCount)

• SetModifyTextType(number ModifyTextType modifyTextType)

• SetNewLineX(number newLineX)

• SetPixelRoundingEnabled(boolean pixelRoundingEnabled)

• SetStyleColor(number r, number g, number b, number a)

• SetText(string aText)

• SetVerticalAlignment(number verticalAlign)

• SetWrapMode(number wrapMode)

• WasTruncated()
  • Returns: boolean wasTruncated

LineControl

• GetBlendMode()
  • Returns: number TextureBlendMode blendMode

• GetColor()
  • Returns: number r, number g, number b, number a

• GetDesaturation()
  • Returns: number desaturation

• GetTextureCoords()
  • Returns: number left, number right, number top, number bottom

• GetTextureFileDimensions()
  • Returns: number pixelWidth, number pixelHeight

• GetTextureFileName()
  • Returns: string filename

• IsPixelRoundingEnabled()
  • Returns: boolean pixelRoundingEnabled

• IsTextureLoaded()
  • Returns: boolean loaded

• SetBlendMode(number TextureBlendMode blendMode)

• SetColor(number r, number g, number b, number a)

• SetDesaturation(number desaturation)

• SetGradientColors(number ControlOrientation orientation, number startR, number startG, number startB, number startA, number endR, number endG, number endB, number endA)

• SetPixelRoundingEnabled(boolean pixelRoundingEnabled)

• SetTexture(string filename)

• SetTextureCoords(number left, number right, number top, number bottom)

• SetThickness(number thickness)

• SetVertexColors(number 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(number duration)

• SetFadeGradient(number gradientIndex, number normalX, number normalY, number gradientLength)

• SetHorizontalScroll(number offset)

• SetScrollBounding(number bounding)

• SetVerticalScroll(number offset)

SliderControl

• DoesAllowDraggingFromThumb()
  • Returns: boolean allow

• GetEnabled()
  • Returns: boolean isEnabled

• GetMinMax()
  • Returns: number min, number max

• GetOrientation()
  • Returns: number orientation

• GetThumbTextureControl()
  • Returns: object textureControl

• GetValue()
  • Returns: number value

• GetValueStep()
  • Returns: number step

• IsThumbFlushWithExtents()
  • Returns: boolean flush

• SetAllowDraggingFromThumb(boolean 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)

• SetColor(number r, number g, number b, number a)

• SetEnabled(boolean enable)

• SetMinMax(number min, number max)

• SetOrientation(number orientation)

• SetThumbFlushWithExtents(boolean 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(boolean enabled)

• EnableLeadingEdge(boolean enabled)

• EnableScrollingOverlay(boolean enabled)

• GetMinMax()
  • Returns: number min, number max

• GetValue()
  • Returns: number value

• SetBarAlignment(number 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(number orientation)

• SetTexture(string filename)

• SetTextureCoords(number left, number right, number top, number bottom)

• SetValue(number aValue)

• SetupScrollingOverlay(string textureFile, number width, number height, number duration)

TextBufferControl

• AddMessage(string aText, number r, number g, number b, number colorId)

• Clear()

• GetDrawLastEntryIfOutOfRoom()
  • Returns: boolean drawLastIfOutOfRoom

• GetLineFade()
  • Returns: number timeBeforeLineBeginsToFade, number timeItTakesLineToFade

• GetLinkEnabled()
  • Returns: boolean linkEnabed

• GetMaxHistoryLines()
  • Returns: number numLines

• GetNumHistoryLines()
  • Returns: number numLines

• GetNumVisibleLines()
  • Returns: number numLines

• GetScrollPosition()
  • Returns: number scrollPosition

• IsSplittingLongMessages()
  • Returns: boolean isSplitting

• MoveScrollPosition(number numLines)

• SetClearBufferAfterFadeout(boolean clearAfterFade)

• SetColorById(number colorId, number r, number g, number b)

• SetDrawLastEntryIfOutOfRoom(boolean drawLastIfOutOfRoom)

• SetFont(string fontString)

• SetHorizontalAlignment(number align)

• SetLineFade(number timeBeforeLineFadeBegins, number timeForLineToFade)

• SetLinesInheritAlpha(boolean linesInheritAlpha)

• SetLinkEnabled(boolean linkEnabed)

• SetMaxHistoryLines(number numLines)

• SetScrollPosition(number line)

• SetSplitLongMessages(boolean splitLongMessages)

• ShowFadedLines()

TextureCompositeControl

• AddSurface(number left, number right, number top, number bottom)

• ClearAllSurfaces()

• GetBlendMode()
  • Returns: number TextureBlendMode blendMode

• GetColor(number surfaceIndex)
  • Returns: number r, number g, number b, number a

• GetDesaturation()
  • Returns: number desaturation

• GetInsets(number surfaceIndex)
  • Returns: number left, number right, number top, number bottom

• GetNumSurfaces()
  • Returns: number surfaces

• GetSurfaceAlpha(number surfaceIndex)
  • Returns: number a

• GetTextureCoords(number surfaceIndex)
  • Returns: number left, number right, number top, number bottom

• GetTextureFileDimensions()
  • Returns: number pixelWidth, number pixelHeight

• GetTextureFileName()
  • Returns: string filename

• IsPixelRoundingEnabled()
  • Returns: boolean pixelRoundingEnabled

• IsSurfaceHidden(number surfaceIndex)
  • Returns: boolean hidden

• IsTextureLoaded()
  • Returns: boolean loaded

• RemoveSurface(number surfaceIndex)

• SetBlendMode(number TextureBlendMode blendMode)

• SetColor(number surfaceIndex, number r, number g, number b, number a)

• SetDesaturation(number desaturation)

• SetInsets(number surfaceIndex, number left, number right, number top, number bottom)

• SetPixelRoundingEnabled(boolean pixelRoundingEnabled)

• SetSurfaceAlpha(number surfaceIndex, number a)

• SetSurfaceHidden(number surfaceIndex, boolean hidden)

• SetTexture(string filename)

• SetTextureCoords(number surfaceIndex, number left, number right, number top, number bottom)

• SetTextureReleaseOption(number ReleaseReferenceOptions releaseOption)

TextureControl

• Get3DLocalDimensions()
  • Returns: number width, number height

• GetAddressMode()
  • Returns: number TextureAddressMode addressMode

• GetBlendMode()
  • Returns: number TextureBlendMode blendMode

• GetColor()
  • Returns: number r, number g, number b, number a

• GetDesaturation()
  • Returns: number desaturation

• GetResizeToFitFile()
  • Returns: boolean resizesToFitFile

• GetTextureCoords()
  • Returns: number left, number right, number top, number bottom

• GetTextureFileDimensions()
  • Returns: number pixelWidth, number pixelHeight

• GetTextureFileName()
  • Returns: string filename

• GetVertexUV(number VERTEX_POINTS vertex)
  • Returns: number u, number v

• Is3DQuadFacingCamera()
  • Returns: boolean isFacing

• IsPixelRoundingEnabled()
  • Returns: boolean pixelRoundingEnabled

• IsTextureLoaded()
  • Returns: boolean loaded

• Set3DLocalDimensions(number width, number height)

• SetAddressMode(number TextureAddressMode addressMode)

• SetAutoAdjustWrappedCoords(boolean enabled)

• SetBlendMode(number TextureBlendMode blendMode)

• SetColor(number r, number g, number b, number a)

• SetDesaturation(number desaturation)

• SetGradientColors(number ControlOrientation orientation, number startR, number startG, number startB, number startA, number endR, number endG, number endB, number endA)

• SetPixelRoundingEnabled(boolean pixelRoundingEnabled)

• SetResizeToFitFile(boolean resizesToFitFile)

• SetTexture(string filename)

• SetTextureCoords(number left, number right, number top, number bottom)

• SetTextureCoordsRotation(number angleInRadians)

• SetTextureReleaseOption(number ReleaseReferenceOptions releaseOption)

• SetTextureRotation(number angleInRadians, number normalizedRotationPointX, number normalizedRotationPointY)

• SetTextureSampleProcessingWeight(TextureSampleProcessing sampleProcessingType, number weight)

• SetVertexColors(number vertexPoints, number red, number green, number blue, number alpha)

• SetVertexUV(number VERTEX_POINTS vertex, number u, number v)

TooltipControl

• AddControl(object control, number cell, boolean useLastRow)

• AddHeaderControl(object control, number headerRow, number TooltipHeaderSide headerSide)

• AddHeaderLine(string text, string font, number headerRow, number TooltipHeaderSide headerSide, number r, number g, number b)

• AddLine(string text, string font, number r, number g, number b, number AnchorPosition lineAnchor, number ModifyTextType modifyTextType, number TextAlignment textAlignment, boolean setToFullSize)

• AddVerticalPadding(number paddingY)

• AppendAvAObjective(number queryType, number keepId, number objectiveId, number ObjectivePinTier objectivePinTier)

• AppendMapPing(number pingType, string unitTag)

• AppendQuestCondition(number questIndex, number stepIndex, number conditionIndex)

• AppendQuestEnding(number questIndex)

• AppendUnitName(string unitTag)

• ClearLines()

• GetOwner()
  • Returns: object owner

• HideComparativeTooltips()

• SetAbility(number aAbilityIndex, boolean aShowBase)

• SetAbilityId(number abilityId)

• SetAchievement(number aAchievementId)

• SetAchievementRewardItem(number aAchievementId)

• SetAction(number aSlotId)

• SetAsComparativeTooltip1()

• SetAsComparativeTooltip2()

• SetAttachedMailItem(id64 aMailId, number aAttachSlot)

• SetBagItem(number Bag bagIndex, number slotIndex)

• SetBook(number categoryIndex, number collectionIndex, number bookIndex)

• SetBuff(number aBuffSlotId, string unitTag)

• SetBuybackItem(number entryIndex)

• SetChampionSkillAbility(number disiplineIndex, number skillIndex, number numPendingPoints)

• SetCollectible(number collectibleId, boolean addNickname, boolean showHint, boolean showBlockReason)

• SetEmperorBonusAbility(number campaignId, number Alliance alliance)

• SetFont(string fontStr)

• SetGuildSpecificItem(number guildSpecificItemIndex)

• SetHeaderRowSpacing(number spacing)

• SetHeaderVerticalOffset(number verticalOffset)

• SetItemUsingEnchantment(number Bag itemBagIndex, number itemSlotIndex, number enchantmentBagIndex, number enchantmentSlotIndex)

• SetKeepBonusAbility(number bonusIndex)

• SetKeepUpgrade(number keepId, number BattlegroundQueryContextType battlegroundContext, number upgradeLine, number level, number index)

• SetLastCraftingResultItem(number resultIndex)

• SetLink(string aLink)

• SetLootItem(number lootId)

• SetMarketProduct(number marketProductId)

• SetMinHeaderRowHeight(number minRowHeight)

• SetMinHeaderRows(number minRows)

• SetOwner(object owner, number position, number offsetX, number offsetY, number relativePoint)

• SetPendingAlchemyItem(number Bag solventBagId, number solventSlotIndex, number Bag reagent1BagId, number reagent1SlotIndex, number Bag reagent2BagId, number reagent2SlotIndex, number:nilable Bag reagent3BagId, number:nilable reagent3SlotIndex)

• SetPendingEnchantingItem(number Bag potencyRuneBagId, number potencyRuneSlotIndex, number Bag essenceRuneBagId, number essenceRuneSlotIndex, number Bag aspectRuneBagId, number aspectRuneSlotIndex)

• SetPendingRetraitItem(number Bag bagIndex, number slotIndex, ItemTraitType#ItemTraitType pendingTrait)

• SetPendingSmithingItem(number patternIndex, number materialIndex, number materialQuantity, number styleIndex, number traitIndex)

• SetPlacedFurniture(id64 placedFurnitureId)

• SetProgressionAbility(number aProgressionIndex, number aMorph, number aRank)

• SetProvisionerIngredientItem(number recipeListIndex, number recipeIndex, number ingredientIndex)

• SetProvisionerResultItem(number recipeListIndex, number recipeIndex)

• SetQuestItem(number questIndex, number stepIndex, number conditionIndex)

• SetQuestReward(number aPerkIndex)

• SetQuestTool(number questIndex, number toolIndex)

• SetScrollBonusAbility(number Alliance alliance, number ObjectiveType artifactType, number bonusIndex)

• SetSkillAbility(number skillType, number skillIndex, number abilityIndex)

• SetSkillLine(number skillType, number skillIndex)

• SetSkillUpgradeAbility(number skillType, number skillIndex, number abilityIndex)

• SetSmithingImprovementItem(number craftingSkillType, number improvementItemIndex)

• SetSmithingImprovementResult(number Bag itemToImproveBagId, number itemToImproveSlotIndex, number craftingSkillType)

• SetSmithingMaterialItem(number patternIndex, number materialIndex)

• SetSmithingStyleItem(number itemStyleId)

• SetSmithingTraitItem(number traitItemIndex)

• SetStoreItem(number entryIndex)

• SetTradeItem(number aWho, number aTradeIndex)

• SetTradingHouseItem(number tradingHouseIndex)

• SetTradingHouseListing(number tradingHouseIndex)

• SetVerticalPadding(number paddingY)

• SetWornItem(number equipSlot)

• ShowComparativeTooltips()

TopLevelWindow

• AllowBringToTop()
  • Returns: boolean allow

• BringWindowToTop()

• SetAllowBringToTop(boolean allow)

• SetDrawWhenGuiHidden(boolean drawWhenHidden)

• SetTopmost(boolean isTopmost)

WindowManager

• ApplyTemplateToControl(object control, string virtualName)

• CompareControlVisualOrder(object controlA, object controlB)
  • Returns: number order

• CreateControl(string arg1, object parent, number 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: boolean isHandlingHardwareEvent

• IsMouseOverWorld()
  • Returns: boolean isMouseOverWorld

• IsSecureRenderModeEnabled()
  • Returns: boolean secureRenderModeEnabled

• SetFocusByName(string name)

• SetMouseCursor(number cursorType)

• SetMouseFocusByName(string name)