Skip to content

Object API · LIVE

LIVE

Object API from ESOUIDocumentationP49.txt with 49 objects.

AddOnManager

AddRelevantFilter

AddRelevantFilter(string relevantFilter)

AreAddOnsEnabled

AreAddOnsEnabled()

  • # Returns: bool areAddOnsEnabled

ClearForceDisabledAddOnNotification

ClearForceDisabledAddOnNotification(luaindex disabledAddonIndex)

ClearUnusedAddOnSavedVariables

ClearUnusedAddOnSavedVariables()

ClearWarnOutOfDateAddOns

ClearWarnOutOfDateAddOns()

GetAddOnDependencyInfo

GetAddOnDependencyInfo(luaindex addOnIndex, luaindex addOnDependencyIndex)

  • # Returns: string name, bool exists, bool active, integer minVersion, integer version, bool isLibrary

GetAddOnFilter

GetAddOnFilter()

  • # Returns: string settingFilter

GetAddOnInfo

GetAddOnInfo(luaindex addOnIndex)

  • # Returns: string name, string title, string author, string description, bool enabled, AddOnLoadState state, bool isOutOfDate, bool isLibrary

GetAddOnNumDependencies

GetAddOnNumDependencies(luaindex addOnIndex)

  • # Returns: integer numDependencies

GetAddOnRootDirectoryPath

GetAddOnRootDirectoryPath(luaindex addOnIndex)

  • # Returns: string directoryPath

GetAddOnVersion

GetAddOnVersion(luaindex addOnIndex)

  • # Returns: integer version

GetForceDisabledAddOnInfo

GetForceDisabledAddOnInfo(luaindex disabledAddonIndex)

  • # Returns: string addonName, bool shouldShowNotification, string addonTitle

GetLoadOutOfDateAddOns

GetLoadOutOfDateAddOns()

  • # Returns: bool loadOutOfDateAddons

GetNumAddOns

GetNumAddOns()

  • # Returns: integer numAddOns

GetNumForceDisabledAddOns

GetNumForceDisabledAddOns()

  • # Returns: integer numDisabledAddons

GetTotalUnusedAddOnSavedVariablesDiskUsageMB

GetTotalUnusedAddOnSavedVariablesDiskUsageMB()

  • # Returns: number totalUnusedAddOnSavedVariablesDiskUsageMB

GetTotalUserAddOnSavedVariablesDiskCapacityMB

GetTotalUserAddOnSavedVariablesDiskCapacityMB()

  • # Returns: number totalUserAddOnSavedVariablesDiskCapacityMB

GetTotalUserAddOnSavedVariablesDiskUsageMB

GetTotalUserAddOnSavedVariablesDiskUsageMB()

  • # Returns: number totalUserAddOnSavedVariablesDiskUsageMB

GetUserAddOnSavedVariablesDiskUsageMB

GetUserAddOnSavedVariablesDiskUsageMB(luaindex addOnIndex)

  • # Returns: number userAddOnSavedVariablesDiskUsageMB

RemoveAddOnFilter

RemoveAddOnFilter()

RequestAddOnSavedVariablesPrioritySave

RequestAddOnSavedVariablesPrioritySave(string addOnName)

ResetRelevantFilters

ResetRelevantFilters()

SetAddOnEnabled

SetAddOnEnabled(luaindex addOnIndex, bool enabled)

SetAddOnFilter

SetAddOnFilter(string settingFilter)

SetAddOnsEnabled

SetAddOnsEnabled(bool enabled)

ShouldWarnOutOfDateAddOns

ShouldWarnOutOfDateAddOns()

  • # Returns: bool warnOutOfDateAddons

WasAddOnDetected

WasAddOnDetected(string addOnName)

  • # Returns: bool wasDetected

AnimationObject

GetAnimatedControl

GetAnimatedControl()

  • # Returns: object animatedControl

GetApplyToChildControlName

GetApplyToChildControlName()

  • # Returns: string applyToChildControlName

GetDuration

GetDuration()

  • # Returns: integer durationMs

GetEasingFunction

GetEasingFunction()

  • # Returns: function functionRef

GetHandler

GetHandler(string eventName, string name)

  • # Returns: function functionRef

GetTimeline

GetTimeline()

  • # Returns: object owningTimeline

GetType

GetType()

IsEnabled

IsEnabled()

  • # Returns: bool isEnabled

IsPlaying

IsPlaying()

  • # Returns: bool isPlaying

SetAnimatedControl

SetAnimatedControl(object animatedControl)

SetApplyToChildControlName

SetApplyToChildControlName(string applyToChildControlName)

SetDuration

SetDuration(integer durationMs)

SetEasingFunction

SetEasingFunction(function functionRef)

SetEnabled

SetEnabled(bool enabled)

SetHandler

SetHandler(string eventName, function functionRef, string name, ControlHandlerOrder controlHandlerOrder, string targetName)

SetOffsetInParent

SetOffsetInParent(integer offset)

AnimationObject3DRotate

GetEndPitch

GetEndPitch()

  • # Returns: number endPitchRadians

GetEndRoll

GetEndRoll()

  • # Returns: number endRollRadians

GetEndYaw

GetEndYaw()

  • # Returns: number endYawRadians

GetStartPitch

GetStartPitch()

  • # Returns: number startPitchRadians

GetStartRoll

GetStartRoll()

  • # Returns: number startRollRadians

GetStartYaw

GetStartYaw()

  • # Returns: number startYawRadians

SetEndPitch

SetEndPitch(number endPitchRadians)

SetEndRoll

SetEndRoll(number endRollRadians)

SetEndYaw

SetEndYaw(number endYawRadians)

SetRotationValues

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

SetStartPitch

SetStartPitch(number startPitchRadians)

SetStartRoll

SetStartRoll(number startRollRadians)

SetStartYaw

SetStartYaw(number startYawRadians)

AnimationObject3DTranslate

ClearBezierControlPoints

ClearBezierControlPoints()

GetDeltaOffsetX

GetDeltaOffsetX()

  • # Returns: number deltaX

GetDeltaOffsetY

GetDeltaOffsetY()

  • # Returns: number deltaY

GetDeltaOffsetZ

GetDeltaOffsetZ()

  • # Returns: number deltaZ

GetEndOffsetX

GetEndOffsetX()

  • # Returns: number endX

GetEndOffsetY

GetEndOffsetY()

  • # Returns: number endY

GetEndOffsetZ

GetEndOffsetZ()

  • # Returns: number endZ

GetStartOffsetX

GetStartOffsetX()

  • # Returns: number startX

GetStartOffsetY

GetStartOffsetY()

  • # Returns: number startY

GetStartOffsetZ

GetStartOffsetZ()

  • # Returns: number startZ

GetTranslateDeltas

GetTranslateDeltas()

  • # Returns: number deltaX, number deltaY, number deltaZ

SetBezierControlPoint

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

SetDeltaOffsetX

SetDeltaOffsetX(number deltaX, TranslateAnimationDeltaType translateAnimationDeltaType)

SetDeltaOffsetY

SetDeltaOffsetY(number deltaY, TranslateAnimationDeltaType translateAnimationDeltaType)

SetDeltaOffsetZ

SetDeltaOffsetZ(number deltaZ, TranslateAnimationDeltaType translateAnimationDeltaType)

SetEndOffsetX

SetEndOffsetX(number endX)

SetEndOffsetY

SetEndOffsetY(number endY)

SetEndOffsetZ

SetEndOffsetZ(number endZ)

SetStartOffsetX

SetStartOffsetX(number startX)

SetStartOffsetY

SetStartOffsetY(number startY)

SetStartOffsetZ

SetStartOffsetZ(number startZ)

SetTranslateDeltas

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

SetTranslateOffsets

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

AnimationObjectColor

GetApplyAlpha

GetApplyAlpha()

  • # Returns: bool applyAlpha

GetEndColor

GetEndColor()

  • # Returns: number endR, number endG, number endB, number endA

GetStartColor

GetStartColor()

  • # Returns: number startR, number startG, number startB, number startA

SetApplyAlpha

SetApplyAlpha(bool applyAlpha)

SetColorValues

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

SetEndColor

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

SetStartColor

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

AnimationObjectTexture

GetCellsHigh

GetCellsHigh()

  • # Returns: integer aNumCellsHigh

GetCellsWide

GetCellsWide()

  • # Returns: integer aNumCellsWide

IsMirroringAlongX

IsMirroringAlongX()

  • # Returns: bool mirroring

IsMirroringAlongY

IsMirroringAlongY()

  • # Returns: bool mirroring

SetCellsHigh

SetCellsHigh(integer aNumCellsHigh)

SetCellsWide

SetCellsWide(integer aNumCellsWide)

SetFramerate

SetFramerate(number framesPerSecond)

SetImageData

SetImageData(integer aNumCellsWide, integer aNumCellsHigh)

SetMirrorAlongX

SetMirrorAlongX(bool mirroring)

SetMirrorAlongY

SetMirrorAlongY(bool mirroring)

AnimationObjectTransformOffset

GetEndOffset

GetEndOffset()

  • # Returns: number:nilable endX, number:nilable endY, number:nilable endZ

GetStartOffset

GetStartOffset()

  • # Returns: number:nilable startX, number:nilable startY, number:nilable startZ

SetEndOffset

SetEndOffset(layout_measurement endX, layout_measurement endY, layout_measurement endZ)

SetEndOffsetX

SetEndOffsetX(layout_measurement endX)

SetEndOffsetY

SetEndOffsetY(layout_measurement endY)

SetEndOffsetZ

SetEndOffsetZ(layout_measurement endZ)

SetOffsets

SetOffsets(layout_measurement startX, layout_measurement startY, layout_measurement startZ, layout_measurement endX, layout_measurement endY, layout_measurement endZ)

SetStartOffset

SetStartOffset(layout_measurement startX, layout_measurement startY, layout_measurement startZ)

SetStartOffsetX

SetStartOffsetX(layout_measurement startX)

SetStartOffsetY

SetStartOffsetY(layout_measurement startY)

SetStartOffsetZ

SetStartOffsetZ(layout_measurement startZ)

AnimationObjectTransformRotation

SetEndRotation

SetEndRotation(number endXRadians, number endYRadians, number endZRadians)

SetEndX

SetEndX(number endXRadians)

SetEndY

SetEndY(number endYRadians)

SetEndZ

SetEndZ(number endZRadians)

SetMode

SetMode(RotationAnimationMode mode)

SetRotations

SetRotations(number startXRadians, number startYRadians, number startZRadians, number endXRadians, number endYRadians, number endZRadians)

SetStartRotation

SetStartRotation(number startXRadians, number startYRadians, number startZRadians)

SetStartX

SetStartX(number startXRadians)

SetStartY

SetStartY(number startYRadians)

SetStartZ

SetStartZ(number startZRadians)

AnimationObjectTranslate

GetAnchorIndex

GetAnchorIndex()

  • # Returns: integer anchorIndex

GetDeltaOffsetX

GetDeltaOffsetX()

  • # Returns: number deltaX

GetDeltaOffsetY

GetDeltaOffsetY()

  • # Returns: number deltaY

GetEndOffsetX

GetEndOffsetX()

  • # Returns: number endX

GetEndOffsetY

GetEndOffsetY()

  • # Returns: number endY

GetStartOffsetX

GetStartOffsetX()

  • # Returns: number startX

GetStartOffsetY

GetStartOffsetY()

  • # Returns: number startY

GetTranslateDeltas

GetTranslateDeltas()

  • # Returns: number deltaX, number deltaY

SetAnchorIndex

SetAnchorIndex(integer anchorIndex)

SetDeltaOffsetX

SetDeltaOffsetX(layout_measurement deltaX, TranslateAnimationDeltaType translateAnimationDeltaType)

SetDeltaOffsetXFromEnd

SetDeltaOffsetXFromEnd(layout_measurement deltaX)

SetDeltaOffsetXFromStart

SetDeltaOffsetXFromStart(layout_measurement deltaX)

SetDeltaOffsetY

SetDeltaOffsetY(layout_measurement deltaY, TranslateAnimationDeltaType translateAnimationDeltaType)

SetDeltaOffsetYFromEnd

SetDeltaOffsetYFromEnd(layout_measurement deltaY)

SetDeltaOffsetYFromStart

SetDeltaOffsetYFromStart(layout_measurement deltaY)

SetEndOffsetX

SetEndOffsetX(layout_measurement endX)

SetEndOffsetY

SetEndOffsetY(layout_measurement endY)

SetStartOffsetX

SetStartOffsetX(layout_measurement startX)

SetStartOffsetY

SetStartOffsetY(layout_measurement startY)

SetTranslateDeltas

SetTranslateDeltas(layout_measurement deltaX, layout_measurement deltaY, TranslateAnimationDeltaType translateAnimationDeltaType)

SetTranslateOffsets

SetTranslateOffsets(layout_measurement startX, layout_measurement startY, layout_measurement endX, layout_measurement endY)

AnimationTimeline

ApplyAllAnimationsToControl

ApplyAllAnimationsToControl(object animatedControl)

ClearAllCallbacks

ClearAllCallbacks()

ClearAnimatedControlFromAllAnimations

ClearAnimatedControlFromAllAnimations()

GetAnimation

GetAnimation(luaindex animationIndex)

  • # Returns: object animation

GetAnimationOffset

GetAnimationOffset(object animation)

  • # Returns: integer offset

GetAnimationTimeline

GetAnimationTimeline(luaindex timelineIndex)

  • # Returns: object timeline

GetAnimationTimelineOffset

GetAnimationTimelineOffset(object animation)

  • # Returns: integer offset

GetDuration

GetDuration()

  • # Returns: integer duration

GetFirstAnimation

GetFirstAnimation()

  • # Returns: object animation

GetFirstAnimationOfType

GetFirstAnimationOfType(AnimationType animationType)

  • # Returns: object animation

GetFirstAnimationTimeline

GetFirstAnimationTimeline()

  • # Returns: object timeline

GetFullProgress

GetFullProgress()

  • # Returns: number progress

GetHandler

GetHandler(string eventName, string name)

  • # Returns: function functionRef

GetLastAnimation

GetLastAnimation()

  • # Returns: object animation

GetLastAnimationTimeline

GetLastAnimationTimeline()

  • # Returns: object timeline

GetMinDuration

GetMinDuration()

  • # Returns: integer minDuration

GetNumAnimationTimelines

GetNumAnimationTimelines()

  • # Returns: integer numTimelines

GetNumAnimations

GetNumAnimations()

  • # Returns: integer numAnimations

GetParent

GetParent()

  • # Returns: object timeline

GetPlaybackLoopsRemaining

GetPlaybackLoopsRemaining()

  • # Returns: integer loopsRemaining

GetProgress

GetProgress()

  • # Returns: number progress

GetSkipAnimationsBehindPlayheadOnInitialPlay

GetSkipAnimationsBehindPlayheadOnInitialPlay()

  • # Returns: bool skipAnimations

InsertAnimation

InsertAnimation(AnimationType animationType, object animatedControl, integer offset)

  • # Returns: object animation

InsertAnimationFromVirtual

InsertAnimationFromVirtual(string animationVirtualName, object animatedControl)

  • # Returns: object animation

InsertAnimationTimeline

InsertAnimationTimeline(integer offset, object animatedControl)

  • # Returns: object animation

InsertAnimationTimelineFromVirtual

InsertAnimationTimelineFromVirtual(string animationVirtualName, object animatedControl)

  • # Returns: object animation

InsertCallback

InsertCallback(function functionRef, integer offset)

  • # Returns: function functionRefRet

IsEnabled

IsEnabled()

  • # Returns: bool isEnabled

IsPaused

IsPaused()

  • # Returns: bool isPaused

IsPlaying

IsPlaying()

  • # Returns: bool isPlaying

IsPlayingBackward

IsPlayingBackward()

  • # Returns: bool reversed

Pause

Pause()

PlayBackward

PlayBackward()

PlayForward

PlayForward()

PlayFromEnd

PlayFromEnd(integer offsetMs)

PlayFromStart

PlayFromStart(integer offsetMs)

PlayInstantlyToEnd

PlayInstantlyToEnd(bool ignoreCallbacks)

PlayInstantlyToStart

PlayInstantlyToStart(bool ignoreCallbacks)

Resume

Resume()

SetAllAnimationOffsets

SetAllAnimationOffsets(integer offset)

SetAnimationOffset

SetAnimationOffset(object animation, integer offset)

SetAnimationTimelineOffset

SetAnimationTimelineOffset(object animation, integer offset)

SetCallbackOffset

SetCallbackOffset(function callback, integer offset)

SetEnabled

SetEnabled(bool enabled)

SetHandler

SetHandler(string eventName, function functionRef, string name, ControlHandlerOrder controlHandlerOrder, string targetName)

SetMinDuration

SetMinDuration(integer minDuration)

SetOffsetInParent

SetOffsetInParent(integer offset)

SetPlaybackLoopCount

SetPlaybackLoopCount(integer maxLoopCount)

SetPlaybackLoopsRemaining

SetPlaybackLoopsRemaining(integer loopsRemaining)

SetPlaybackType

SetPlaybackType(AnimationPlayback playbackType, integer maxLoopCount)

SetProgress

SetProgress(number progress)

SetSkipAnimationsBehindPlayheadOnInitialPlay

SetSkipAnimationsBehindPlayheadOnInitialPlay(bool skipAnimations)

Stop

Stop()

BackdropControl

GetBlendMode

GetBlendMode()

GetCenterColor

GetCenterColor()

  • # Returns: number r, number g, number b, number a

GetCenterTextureFileName

GetCenterTextureFileName()

  • # Returns: string filename

GetEdgeColor

GetEdgeColor()

  • # Returns: number r, number g, number b, number a

GetEdgeTextureFileName

GetEdgeTextureFileName()

  • # Returns: string filename

IsPixelRoundingEnabled

IsPixelRoundingEnabled()

  • # Returns: bool pixelRoundingEnabled

SetBlendMode

SetBlendMode(TextureBlendMode blendMode)

SetCenterColor

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

SetCenterTexture

SetCenterTexture(string filename, layout_measurement tilingInterval, TextureAddressMode addressMode)

SetCenterTextureFileName

SetCenterTextureFileName(string filename)

SetEdgeColor

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

SetEdgeTexture

SetEdgeTexture(string filename, integer edgeFileWidth, integer edgeFileHeight, layout_measurement cornerSize, integer edgeFilePadding)

SetEdgeTextureFileName

SetEdgeTextureFileName(string filename)

SetInsets

SetInsets(layout_measurement left, layout_measurement top, layout_measurement right, layout_measurement bottom)

SetIntegralWrapping

SetIntegralWrapping(bool integralWrappingEnabled)

SetPixelRoundingEnabled

SetPixelRoundingEnabled(bool enabled)

SetTextureReleaseOption

SetTextureReleaseOption(ReleaseReferenceOptions releaseOption)

ButtonControl

EnableMouseButton

EnableMouseButton(MouseButtonIndex button, bool enabled)

GetHorizontalAlignment

GetHorizontalAlignment()

GetLabelControl

GetLabelControl()

  • # Returns: object labelControl

GetState

GetState()

GetVerticalAlignment

GetVerticalAlignment()

IsPixelRoundingEnabled

IsPixelRoundingEnabled()

  • # Returns: bool pixelRoundingEnabled

SetClickSound

SetClickSound(string clickSound)

SetDesaturation

SetDesaturation(number desaturation)

SetDisabledFontColor

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

SetDisabledPressedFontColor

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

SetDisabledPressedTexture

SetDisabledPressedTexture(string textureFilename)

SetDisabledTexture

SetDisabledTexture(string textureFilename)

SetEnabled

SetEnabled(bool enabled)

SetEndCapWidth

SetEndCapWidth(layout_measurement endCapWidth)

SetFont

SetFont(string text)

SetHorizontalAlignment

SetHorizontalAlignment(TextAlignment horizontalAlign)

SetModifyTextType

SetModifyTextType(ModifyTextType modifyTextType)

SetMouseOverBlendMode

SetMouseOverBlendMode(TextureBlendMode blendMode)

SetMouseOverFontColor

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

SetMouseOverTexture

SetMouseOverTexture(string textureFilename)

SetNormalFontColor

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

SetNormalOffset

SetNormalOffset(layout_measurement x, layout_measurement y)

SetNormalTexture

SetNormalTexture(string textureFilename)

SetPixelRoundingEnabled

SetPixelRoundingEnabled(bool pixelRoundingEnabled)

SetPressedFontColor

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

SetPressedMouseOverTexture

SetPressedMouseOverTexture(string textureFilename)

SetPressedOffset

SetPressedOffset(layout_measurement x, layout_measurement y)

SetPressedTexture

SetPressedTexture(string textureFilename)

SetShowingHighlight

SetShowingHighlight(bool showingHighlight)

SetState

SetState(ButtonState newState, bool locked)

SetText

SetText(string text)

SetTextureCoords

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

SetTextureReleaseOption

SetTextureReleaseOption(ReleaseReferenceOptions releaseOption)

SetVerticalAlignment

SetVerticalAlignment(TextAlignment verticalAlign)

CanvasControl

Arc

Arc(number centerX, number centerY, number radius, number startAngle, number endAngle, bool isCounterClockwise)

ArcTo

ArcTo(number controlPoint1X, number controlPoint1Y, number controlPoint2X, number controlPoint2Y, number radius)

BeginPath

BeginPath()

Circle

Circle(number x, number y, number radius)

Clear

Clear()

ClosePath

ClosePath()

ComputeCurrentPathLength

ComputeCurrentPathLength()

  • # Returns: number length

Fill

Fill()

FillRect

FillRect(number x, number y, number width, number height)

GetObjectFit

GetObjectFit()

LineTo

LineTo(number x, number y)

MoveTo

MoveTo(number x, number y)

QuadraticCurveTo

QuadraticCurveTo(number controlPointX, number controlPointY, number endPointX, number endPointY)

Rect

Rect(number x, number y, number width, number height)

RoundRect

RoundRect(number x, number y, number width, number height, number upperLeftRadius, number upperRightRadius, number lowerRightRadius, number lowerLeftRadius)

SetCanvasSize

SetCanvasSize(number width, number height)

SetFillColor

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

SetObjectFit

SetObjectFit(ObjectFit objectFit)

SetStrokeCapStyle

SetStrokeCapStyle(StrokeCapStyle capStyle)

SetStrokeColor

SetStrokeColor(number r, number g, number b, number a)

SetStrokeJoinType

SetStrokeJoinType(StrokeJoinType joinType, number miterLimit)

SetStrokeLineDash

SetStrokeLineDash(number lineDashArray)

SetStrokeLineDashOffset

SetStrokeLineDashOffset(number lineDashOffset)

SetStrokeWidth

SetStrokeWidth(number width)

Stroke

Stroke()

StrokeRect

StrokeRect(number x, number y, number width, number height)

ColorSelectControl

GetColorAsHSV

GetColorAsHSV()

  • # Returns: number hue, number saturation, number value

GetColorAsRGB

GetColorAsRGB()

  • # Returns: number red, number green, number blue

GetColorWheelTextureControl

GetColorWheelTextureControl()

  • # Returns: object textureControl

GetColorWheelThumbTextureControl

GetColorWheelThumbTextureControl()

  • # Returns: object textureControl

GetFullValuedColorAsRGB

GetFullValuedColorAsRGB()

  • # Returns: number red, number green, number blue

GetThumbNormalizedPosition

GetThumbNormalizedPosition()

  • # Returns: number normalizedX, number normalizedY

GetValue

GetValue()

  • # Returns: number value

SetColorAsHSV

SetColorAsHSV(number hue, number saturation, number value)

SetColorAsRGB

SetColorAsRGB(number red, number green, number blue)

SetColorWheelThumbTextureControl

SetColorWheelThumbTextureControl(object textureControl)

SetThumbNormalizedPosition

SetThumbNormalizedPosition(number normalizedX, number normalizedY)

SetValue

SetValue(number value)

CompassDisplayControl

GetAlphaDropoffBehavior

GetAlphaDropoffBehavior(MapDisplayPinType pinType)

  • # Returns: number closeAlpha, number farAlpha, number closeAlphaDistanceM, number farAlphaDistanceM

GetCenterOveredPinDescription

GetCenterOveredPinDescription(luaindex centerOveredPinIndex)

  • # Returns: string description

GetCenterOveredPinDistance

GetCenterOveredPinDistance(luaindex centerOveredPinIndex)

  • # Returns: number distanceFromPlayerCM

GetCenterOveredPinInfo

GetCenterOveredPinInfo(luaindex centerOveredPinIndex)

GetCenterOveredPinLayerAndLevel

GetCenterOveredPinLayerAndLevel(luaindex centerOveredPinIndex)

GetCenterOveredPinType

GetCenterOveredPinType(luaindex centerOveredPinIndex)

GetNumCenterOveredPins

GetNumCenterOveredPins()

  • # Returns: integer numCenterOveredPins

GetScaleDropoffBehavior

GetScaleDropoffBehavior(MapDisplayPinType pinType)

  • # Returns: number closeScale, number farScale, number closeScaleDistanceM, number farScaleDistanceM

IsCenterOveredPinSuppressed

IsCenterOveredPinSuppressed(luaindex centerOveredPinIndex)

  • # Returns: bool suppressed

SetAlphaDropoffBehavior

SetAlphaDropoffBehavior(MapDisplayPinType pinType, number closeAlpha, number farAlpha, number closeAlphaDistanceM, number farAlphaDistanceM)

SetCardinalDirection

SetCardinalDirection(string directionName, string font, integer cardinalDirection)

SetPinInfo

SetPinInfo(MapDisplayPinType type, number pinSize, string pinTexture, string areaTexture, string aboveTexture, string belowTexture, string linkTexture, bool clamped, bool allowUpdatesWhenAnimating, number maxDistanceM, number closeScale, number farScale, number closeScaleDistanceM, number farScaleDistanceM, number closeAlpha, number farAlpha, number closeAlphaDistanceM, number farAlphaDistanceM, string animation, string addedAnimation, string removedAnimation, DrawLayer layer, integer drawLevelOffsetBase)

SetScaleDropoffBehavior

SetScaleDropoffBehavior(MapDisplayPinType pinType, number closeScale, number farScale, number closeScaleDistanceM, number farScaleDistanceM)

Control

AddFilterForEvent

AddFilterForEvent(integer event, variant filterParameter)

  • # Returns: bool success

AddTransformRotation

AddTransformRotation(number deltaXRadians, number deltaYRadians, number deltaZRadians)

AddTransformRotationX

AddTransformRotationX(number deltaXRadians)

AddTransformRotationY

AddTransformRotationY(number deltaYRadians)

AddTransformRotationZ

AddTransformRotationZ(number deltaZRadians)

AppendChild *protected-attributes* (*object* _childControl_)

AppendChild protected-attributes (object childControl)

ClearAnchors *protected-attributes* ()

ClearAnchors protected-attributes ()

ClearCircularClip

ClearCircularClip()

ClearClips

ClearClips()

ClearDimensions *protected-attributes* ()

ClearDimensions protected-attributes ()

ClearFadeGradients

ClearFadeGradients()

ClearMask

ClearMask()

ClearRectangularClip

ClearRectangularClip()

ClearShaderEffectOptions

ClearShaderEffectOptions()

ClearSuggestedDimensions *protected-attributes* ()

ClearSuggestedDimensions protected-attributes ()

ClearTransform

ClearTransform()

ClearTransformOffset

ClearTransformOffset()

ClearTransformRotation

ClearTransformRotation()

ClearTransformScale

ClearTransformScale()

ClearTransformSkew

ClearTransformSkew()

Convert3DLocalOrientationToWorldOrientation

Convert3DLocalOrientationToWorldOrientation(number localPitch, number localYaw, number localRoll)

  • # Returns: number worldPitch, number worldYaw, number worldRoll

Convert3DLocalPositionToWorldPosition

Convert3DLocalPositionToWorldPosition(number localX, number localY, number localZ)

  • # Returns: number worldX, number worldY, number worldZ

Convert3DWorldOrientationToLocalOrientation

Convert3DWorldOrientationToLocalOrientation(number worldPitch, number worldYaw, number worldRoll)

  • # Returns: number localPitch, number localYaw, number localRoll

Convert3DWorldPositionToLocalPosition

Convert3DWorldPositionToLocalPosition(number worldX, number worldY, number worldZ)

  • # Returns: number localX, number localY, number localZ

Create3DRenderSpace

Create3DRenderSpace()

CreateControl

CreateControl(string childControlName, ControlType childControlType)

  • # Returns: object childControl

Destroy3DRenderSpace

Destroy3DRenderSpace()

Does3DRenderSpaceUseDepthBuffer

Does3DRenderSpaceUseDepthBuffer()

  • # Returns: bool usesDepthBuffer

DoesControlDescendFrom

DoesControlDescendFrom(object root)

  • # Returns: bool doesControlDescendFromRoot

Get3DRenderSpaceAxisRotationOrder

Get3DRenderSpaceAxisRotationOrder()

Get3DRenderSpaceForward

Get3DRenderSpaceForward()

  • # Returns: number x, number y, number z

Get3DRenderSpaceOrientation

Get3DRenderSpaceOrientation()

  • # Returns: number pitchRadians, number yawRadians, number rollRadians

Get3DRenderSpaceOrigin

Get3DRenderSpaceOrigin()

  • # Returns: number x, number y, number z

Get3DRenderSpaceRight

Get3DRenderSpaceRight()

  • # Returns: number x, number y, number z

Get3DRenderSpaceSystem

Get3DRenderSpaceSystem()

Get3DRenderSpaceUp

Get3DRenderSpaceUp()

  • # Returns: number x, number y, number z

GetAlpha

GetAlpha()

  • # Returns: number alpha

GetAncestor

GetAncestor(luaindex ancestorIndex)

  • # Returns: object ancestorControl

GetAnchor

GetAnchor(integer anchorIndex)

GetAutoRectClipChildren

GetAutoRectClipChildren()

  • # Returns: bool autoRectClipChildren

GetBottom

GetBottom()

  • # Returns: number bottom

GetCaustic

GetCaustic()

  • # Returns: number frequencyX, number frequencyY, number speed, number offset

GetCausticOffset

GetCausticOffset()

  • # Returns: number offset

GetCenter

GetCenter()

  • # Returns: number centerX, number centerY

GetChild

GetChild(luaindex childIndex)

  • # Returns: object childControl

GetChildFlexContentAlignment

GetChildFlexContentAlignment()

GetChildFlexDirection

GetChildFlexDirection()

GetChildFlexItemAlignment

GetChildFlexItemAlignment()

GetChildFlexJustification

GetChildFlexJustification()

GetChildFlexWrap

GetChildFlexWrap()

GetChildLayout

GetChildLayout()

GetClampedToScreen

GetClampedToScreen()

  • # Returns: bool clamped

GetClampedToScreenInsets

GetClampedToScreenInsets()

  • # Returns: number left, number top, number right, number bottom

GetControlAlpha

GetControlAlpha()

  • # Returns: number alpha

GetControlScale

GetControlScale()

  • # Returns: number scale

GetControlSpace

GetControlSpace()

GetDesiredHeight

GetDesiredHeight()

  • # Returns: number height

GetDesiredWidth

GetDesiredWidth()

  • # Returns: number width

GetDimensionConstraints

GetDimensionConstraints()

  • # Returns: number minWidth, number minHeight, number maxWidth, number maxHeight

GetDimensions

GetDimensions()

  • # Returns: number width, number height

GetDrawLayer

GetDrawLayer()

GetDrawLevel

GetDrawLevel()

  • # Returns: integer level

GetDrawTier

GetDrawTier()

GetExcludeFromFlexbox

GetExcludeFromFlexbox()

  • # Returns: bool exclude

GetExcludeFromResizeToFitExtents

GetExcludeFromResizeToFitExtents()

  • # Returns: bool excludes

GetFadeGradient

GetFadeGradient(luaindex gradientIndex)

  • # Returns: number normalX, number normalY, number gradientLength

GetFlex

GetFlex()

  • # Returns: number:nilable growOrShrink

GetFlexAlignSelf

GetFlexAlignSelf()

GetFlexBasis

GetFlexBasis()

  • # Returns: number basis

GetFlexGrow

GetFlexGrow()

  • # Returns: number grow

GetFlexMargin

GetFlexMargin(FlexEdge edge)

  • # Returns: number margin

GetFlexPadding

GetFlexPadding(FlexEdge edge)

  • # Returns: number padding

GetFlexShrink

GetFlexShrink()

  • # Returns: number shrink

GetGaussianBlur

GetGaussianBlur()

  • # Returns: integer kernelSize, number factor

GetHandler

GetHandler(string handlerName, string name)

  • # Returns: function functionRef

GetHeight

GetHeight()

  • # Returns: number height

GetHitInsets

GetHitInsets()

  • # Returns: number left, number top, number right, number bottom

GetId

GetId()

  • # Returns: integer id

GetInheritsAlpha

GetInheritsAlpha()

  • # Returns: bool inheritAlpha

GetInheritsScale

GetInheritsScale()

  • # Returns: bool inheritScale

GetLeft

GetLeft()

  • # Returns: number left

GetMaskThresholdThickness

GetMaskThresholdThickness()

  • # Returns: number normalizedThickness

GetMaskThresholdZeroAlphaEdge

GetMaskThresholdZeroAlphaEdge()

  • # Returns: number normalizedEdge

GetMotionBlur

GetMotionBlur()

  • # Returns: number blurVectorXAsAPercentageOfControlWidth, number blurVectorYAsAPercentageOfControlHeight, integer numSamples

GetName

GetName()

  • # Returns: string name

GetNamedChild

GetNamedChild(string childName)

  • # Returns: object returnedControl

GetNamedSibling

GetNamedSibling(string siblingName)

  • # Returns: object returnedControl

GetNormal

GetNormal()

  • # Returns: number normalX, number normalY, number normalZ

GetNormalizedCameraFacing

GetNormalizedCameraFacing()

  • # Returns: number normalizedCameraFacingValue

GetNumAnchors

GetNumAnchors()

  • # Returns: integer numAnchors

GetNumChildren

GetNumChildren()

  • # Returns: integer numChildren

GetOwningWindow

GetOwningWindow()

  • # Returns: object OwningTopLevelWindow

GetParent

GetParent()

  • # Returns: object parentControl

GetRadialBlur

GetRadialBlur()

  • # Returns: number originX, number originY, integer numSamples, number blurRadius, number offsetRadius

GetResizeToFitConstrains

GetResizeToFitConstrains()

GetResizeToFitDescendents

GetResizeToFitDescendents()

  • # Returns: bool resizes

GetResizeToFitPadding

GetResizeToFitPadding()

  • # Returns: number width, number height

GetRight

GetRight()

  • # Returns: number right

GetScale

GetScale()

  • # Returns: number scale

GetScreenRect

GetScreenRect()

  • # Returns: number left, number top, number right, number bottom

GetSpace

GetSpace()

GetSuggestedDimensions

GetSuggestedDimensions()

  • # Returns: number width, number height

GetSuggestedHeight

GetSuggestedHeight()

  • # Returns: number height

GetSuggestedWidth

GetSuggestedWidth()

  • # Returns: number width

GetTop

GetTop()

  • # Returns: number top

GetTransformNormalizedOriginPoint

GetTransformNormalizedOriginPoint()

  • # Returns: number normalizedX, number normalizedY

GetTransformOffset

GetTransformOffset()

  • # Returns: number x, number y, number z

GetTransformRotation

GetTransformRotation()

  • # Returns: number xRadians, number yRadians, number zRadians

GetTransformRotationAxisOrder

GetTransformRotationAxisOrder()

GetTransformScale

GetTransformScale()

  • # Returns: number scaleX, number scaleY, number scaleZ

GetTransformSkew

GetTransformSkew()

  • # Returns: number skewXRadians, number skewYRadians

GetType

GetType()

GetWave

GetWave()

  • # Returns: number angleRadians, number frequency, number speed, number offset

GetWaveAngle

GetWaveAngle()

  • # Returns: number angleRadians

GetWaveBounds

GetWaveBounds()

  • # Returns: number minX, number maxX, number minY, number maxY

GetWaveDampingCoefficients

GetWaveDampingCoefficients()

  • # Returns: number minX, number maxX, number minY, number maxY

GetWaveFrequency

GetWaveFrequency()

  • # Returns: number frequency

GetWaveOffset

GetWaveOffset()

  • # Returns: number offset

GetWaveSpeed

GetWaveSpeed()

  • # Returns: number speed

GetWidth

GetWidth()

  • # Returns: number width

Has3DRenderSpace

Has3DRenderSpace()

  • # Returns: bool has3DRenderSpace

InsertChildBefore *protected-attributes* (*object* _childControl_, *object* _nextChild_)

InsertChildBefore protected-attributes (object childControl, object nextChild)

IsChildOf

IsChildOf(object desiredParent)

  • # Returns: bool isChild

IsControlHidden

IsControlHidden()

  • # Returns: bool hidden

IsHandlerSet

IsHandlerSet(string handlerName, string name)

  • # Returns: bool isSet

IsHidden

IsHidden()

  • # Returns: bool hidden

IsKeyboardEnabled

IsKeyboardEnabled()

  • # Returns: bool enabled

IsMouseEnabled

IsMouseEnabled()

  • # Returns: bool enabled

IsPointInside

IsPointInside(layout_measurement x, layout_measurement y, layout_measurement:nilable leftOffset, layout_measurement:nilable topOffset, layout_measurement:nilable rightOffset, layout_measurement:nilable bottomOffset)

  • # Returns: bool isInside

ProjectRectToScreen

ProjectRectToScreen()

  • # Returns: number x1, number y1, number x2, number y2, number x3, number y3, number x4, number y4

ProjectRectToScreenAndBuildAABB

ProjectRectToScreenAndBuildAABB()

  • # Returns: number left, number top, number right, number bottom

ProjectRectToScreenAndComputeAABBPoint

ProjectRectToScreenAndComputeAABBPoint(AnchorPosition point)

  • # Returns: number screenX, number screenY

ProjectRectToScreenAndComputeClampedAABBPoint

ProjectRectToScreenAndComputeClampedAABBPoint(AnchorPosition point)

  • # Returns: number screenX, number screenY

ProjectToScreen

ProjectToScreen(number normalizedX, number normalizedY)

  • # Returns: number screenX, number screenY

RegisterForEvent

RegisterForEvent(integer event, function callback, bool doOnce)

  • # Returns: bool success

ResetTransformNormalizedOriginPoint

ResetTransformNormalizedOriginPoint()

Set3DRenderSpaceAxisRotationOrder

Set3DRenderSpaceAxisRotationOrder(AxisRotationOrder axisRotationOrder)

Set3DRenderSpaceForward

Set3DRenderSpaceForward(number x, number y, number z)

Set3DRenderSpaceOrientation

Set3DRenderSpaceOrientation(number pitchRadians, number yawRadians, number rollRadians)

Set3DRenderSpaceOrigin

Set3DRenderSpaceOrigin(number xM, number yM, number zM)

Set3DRenderSpaceRight

Set3DRenderSpaceRight(number x, number y, number z)

Set3DRenderSpaceSystem

Set3DRenderSpaceSystem(GuiRender3DSpaceSystem system)

Set3DRenderSpaceUp

Set3DRenderSpaceUp(number x, number y, number z)

Set3DRenderSpaceUsesDepthBuffer

Set3DRenderSpaceUsesDepthBuffer(bool usesDepthBuffer)

SetAlpha *protected-attributes* (*number* _alpha_)

SetAlpha protected-attributes (number alpha)

SetAnchor *protected-attributes* (*[AnchorPosition|#AnchorPosition]* _point_, *object* _relativeTo_, *[AnchorPosition|#AnchorPosition]* _relativePoint_, *layout_measurement* _offsetX_, *layout_measurement* _offsetY_, *[AnchorConstrains|#AnchorConstrains]* _anchorConstrains_)

SetAnchor protected-attributes (AnchorPosition point, object relativeTo, AnchorPosition relativePoint, layout_measurement offsetX, layout_measurement offsetY, AnchorConstrains anchorConstrains)

SetAnchorFill *protected-attributes* (*object* _anchorTargetControl_)

SetAnchorFill protected-attributes (object anchorTargetControl)

SetAnchorOffsets

SetAnchorOffsets(layout_measurement offsetX, layout_measurement offsetY, luaindex anchorIndex)

SetAutoRectClipChildren

SetAutoRectClipChildren(bool autoRectClipChildren)

SetCaustic

SetCaustic(number frequencyX, number frequencyY, number speed, number offset)

SetCausticOffset

SetCausticOffset(number offset)

SetChildFlexContentAlignment

SetChildFlexContentAlignment(FlexAlignment alignment)

SetChildFlexDirection

SetChildFlexDirection(FlexDirection direction)

SetChildFlexItemAlignment

SetChildFlexItemAlignment(FlexAlignment alignment)

SetChildFlexJustification

SetChildFlexJustification(FlexJustification justification)

SetChildFlexWrap

SetChildFlexWrap(FlexWrap wrap)

SetChildLayout

SetChildLayout(ChildLayoutType childLayoutType)

SetCircularClip

SetCircularClip(number centerX, number centerY, number radius)

SetClampedToScreen

SetClampedToScreen(bool clamped)

SetClampedToScreenInsets

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

SetControlAlpha *protected-attributes* (*number* _alpha_)

SetControlAlpha protected-attributes (number alpha)

SetControlScale *protected-attributes* (*number* _scale_)

SetControlScale protected-attributes (number scale)

SetDimensionConstraints

SetDimensionConstraints(layout_measurement minWidth, layout_measurement minHeight, layout_measurement maxWidth, layout_measurement maxHeight)

SetDimensions *protected-attributes* (*layout_measurement* _width_, *layout_measurement* _height_)

SetDimensions protected-attributes (layout_measurement width, layout_measurement height)

SetDrawLayer *protected-attributes* (*[DrawLayer|#DrawLayer]* _layer_)

SetDrawLayer protected-attributes (DrawLayer layer)

SetDrawLevel *protected-attributes* (*integer* _level_)

SetDrawLevel protected-attributes (integer level)

SetDrawTier *protected-attributes* (*[DrawTier|#DrawTier]* _tier_)

SetDrawTier protected-attributes (DrawTier tier)

SetExcludeFromFlexbox

SetExcludeFromFlexbox(bool exclude)

SetExcludeFromResizeToFitExtents *protected-attributes* (*bool* _exclude_)

SetExcludeFromResizeToFitExtents protected-attributes (bool exclude)

SetFadeGradient

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

SetFlex

SetFlex(number:nilable growOrShrink)

SetFlexAlignSelf

SetFlexAlignSelf(FlexAlignment alignment)

SetFlexBasis

SetFlexBasis(number basis)

SetFlexGrow

SetFlexGrow(number grow)

SetFlexMargin

SetFlexMargin(FlexEdge edge, number margin)

SetFlexMargins

SetFlexMargins(number left, number top, number right, number bottom)

SetFlexPaddings

SetFlexPaddings(number left, number top, number right, number bottom)

SetFlexShrink

SetFlexShrink(number shrink)

SetGaussianBlur

SetGaussianBlur(integer kernelSize, number factor)

SetHandler

SetHandler(string handlerName, function functionRef, string name, ControlHandlerOrder controlHandlerOrder, string targetName)

SetHeight *protected-attributes* (*layout_measurement* _height_)

SetHeight protected-attributes (layout_measurement height)

SetHidden *protected-attributes* (*bool* _hidden_)

SetHidden protected-attributes (bool hidden)

SetHitInsets

SetHitInsets(layout_measurement left, layout_measurement top, layout_measurement right, layout_measurement bottom)

SetId

SetId(integer id)

SetInheritAlpha

SetInheritAlpha(bool inheritAlpha)

SetInheritScale

SetInheritScale(bool inheritScale)

SetKeyboardEnabled *protected-attributes* (*bool* _enabled_)

SetKeyboardEnabled protected-attributes (bool enabled)

SetMaskMode

SetMaskMode(ControlMaskMode maskMode)

SetMaskTexture

SetMaskTexture(string fileName)

SetMaskTextureReleaseOption

SetMaskTextureReleaseOption(ReleaseReferenceOptions releaseOption)

SetMaskThresholdThickness

SetMaskThresholdThickness(number normalizedThickness)

SetMaskThresholdZeroAlphaEdge

SetMaskThresholdZeroAlphaEdge(number normalizedEdge)

SetMotionBlur

SetMotionBlur(number blurVectorXAsAPercentageOfControlWidth, number blurVectorYAsAPercentageOfControlHeight, integer numSamples)

SetMouseEnabled *protected-attributes* (*bool* _enabled_)

SetMouseEnabled protected-attributes (bool enabled)

SetMovable

SetMovable(bool isMovable)

SetParent *protected-attributes* (*object* _newParent_)

SetParent protected-attributes (object newParent)

SetRadialBlur

SetRadialBlur(number originX, number originY, integer numSamples, number blurRadius, number offsetRadius)

SetRectangularClip

SetRectangularClip(number left, number top, number right, number bottom)

SetResizeHandleSize

SetResizeHandleSize(number handleSize)

SetResizeToFitConstrains

SetResizeToFitConstrains(AnchorConstrains constrains)

SetResizeToFitDescendents *protected-attributes* (*bool* _resize_)

SetResizeToFitDescendents protected-attributes (bool resize)

SetResizeToFitPadding

SetResizeToFitPadding(layout_measurement width, layout_measurement height)

SetScale *protected-attributes* (*number* _scale_)

SetScale protected-attributes (number scale)

SetShapeType

SetShapeType(integer shapeType)

SetSimpleAnchor *protected-attributes* (*object* _anchorTargetControl_, *number* _offsetX_, *number* _offsetY_)

SetSimpleAnchor protected-attributes (object anchorTargetControl, number offsetX, number offsetY)

SetSimpleAnchorParent *protected-attributes* (*number* _offsetX_, *number* _offsetY_)

SetSimpleAnchorParent protected-attributes (number offsetX, number offsetY)

SetSpace

SetSpace(Space:nilable space)

SetTransformNormalizedOriginPoint

SetTransformNormalizedOriginPoint(number normalizedX, number normalizedY)

SetTransformOffset

SetTransformOffset(layout_measurement x, layout_measurement y, layout_measurement z)

SetTransformOffsetX

SetTransformOffsetX(layout_measurement x)

SetTransformOffsetY

SetTransformOffsetY(layout_measurement y)

SetTransformOffsetZ

SetTransformOffsetZ(layout_measurement z)

SetTransformRotation

SetTransformRotation(number xRadians, number yRadians, number zRadians)

SetTransformRotationAndOrder

SetTransformRotationAndOrder(number deltaXRadians, number deltaYRadians, number deltaZRadians, AxisRotationOrder order)

SetTransformRotationAxisOrder

SetTransformRotationAxisOrder(AxisRotationOrder order)

SetTransformRotationX

SetTransformRotationX(number xRadians)

SetTransformRotationY

SetTransformRotationY(number yRadians)

SetTransformRotationZ

SetTransformRotationZ(number zRadians)

SetTransformScale

SetTransformScale(number scale)

SetTransformScaleX

SetTransformScaleX(number scaleX)

SetTransformScaleY

SetTransformScaleY(number scaleY)

SetTransformScaleZ

SetTransformScaleZ(number scaleZ)

SetTransformSkew

SetTransformSkew(number skewXRadians, number skewYRadians)

SetTransformSkewX

SetTransformSkewX(number skewXRadians)

SetTransformSkewY

SetTransformSkewY(number skewYRadians)

SetWave

SetWave(number angleRadians, number frequency, number speed, number offset)

SetWaveAngle

SetWaveAngle(number angleRadians)

SetWaveBounds

SetWaveBounds(number minX, number maxX, number minY, number maxY)

SetWaveDampingCoefficients

SetWaveDampingCoefficients(number minX, number maxX, number minY, number maxY)

SetWaveFrequency

SetWaveFrequency(number frequency)

SetWaveOffset

SetWaveOffset(number offset)

SetWaveSpeed

SetWaveSpeed(number speed)

SetWidth *protected-attributes* (*layout_measurement* _width_)

SetWidth protected-attributes (layout_measurement width)

StartMoving *protected-attributes* ()

StartMoving protected-attributes ()

  • # Returns: bool isMoving

StopMovingOrResizing *protected-attributes* ()

StopMovingOrResizing protected-attributes ()

SuggestDimensions *protected-attributes* (*number* _width_, *number* _height_)

SuggestDimensions protected-attributes (number width, number height)

SuggestHeight *protected-attributes* (*number* _height_)

SuggestHeight protected-attributes (number height)

SuggestWidth *protected-attributes* (*number* _width_)

SuggestWidth protected-attributes (number width)

ToggleHidden *protected-attributes* ()

ToggleHidden protected-attributes ()

UnregisterForEvent

UnregisterForEvent(integer event)

  • # Returns: bool success

CooldownControl

GetDuration

GetDuration()

  • # Returns: integer duration

GetPercentCompleteFixed

GetPercentCompleteFixed()

  • # Returns: number percentComplete

GetTimeLeft

GetTimeLeft()

  • # Returns: integer time

ResetCooldown

ResetCooldown()

SetBlendMode

SetBlendMode(integer blendMode)

SetCooldownRemainTime

SetCooldownRemainTime(integer remain)

SetDesaturation

SetDesaturation(number desaturation)

SetFillColor

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

SetLeadingEdgeTexture

SetLeadingEdgeTexture(string filename)

SetPercentCompleteFixed

SetPercentCompleteFixed(number percentComplete)

SetRadialCooldownClockwise

SetRadialCooldownClockwise(bool clockwise)

SetRadialCooldownGradient

SetRadialCooldownGradient(number startAlpha, number angularDistance)

SetRadialCooldownOriginAngle

SetRadialCooldownOriginAngle(number originAngle)

SetTexture

SetTexture(string filename)

SetTextureReleaseOption

SetTextureReleaseOption(ReleaseReferenceOptions releaseOption)

SetVerticalCooldownLeadingEdgeHeight

SetVerticalCooldownLeadingEdgeHeight(integer leadingEdgeHeight)

StartCooldown

StartCooldown(integer remain, integer duration, integer cooldownType, integer cooldownTimeType, bool drawLeadingEdge)

StartFixedCooldown

StartFixedCooldown(number percentComplete, integer cooldownType, integer cooldownTimeType, bool drawLeadingEdge)

EditControl

AddValidCharacter

AddValidCharacter(string validCharacter)

Clear

Clear()

ClearSelection

ClearSelection()

CopyAllTextToClipboard *private* ()

CopyAllTextToClipboard private ()

GetAllowMarkupType

GetAllowMarkupType()

GetCopyEnabled

GetCopyEnabled()

  • # Returns: bool enabled

GetCursorPosition

GetCursorPosition()

  • # Returns: integer cursorPosition

GetDefaultText

GetDefaultText()

  • # Returns: string defaultText

GetEditEnabled

GetEditEnabled()

  • # Returns: bool enabled

GetFont

GetFont()

  • # Returns: string text

GetFontFaceName

GetFontFaceName()

  • # Returns: string text

GetFontHeight

GetFontHeight()

  • # Returns: number fontHeightUIUnits

GetFontSize

GetFontSize()

  • # Returns: number fontSize

GetFontStyle

GetFontStyle()

  • # Returns: string text

GetIMECompositionExclusionArea

GetIMECompositionExclusionArea()

  • # Returns: number leftControlSpace, number topControlSpace, number rightControlSpace, number bottomControlSpace

GetMaxInputChars

GetMaxInputChars()

  • # Returns: integer maxChars

GetNewLineEnabled

GetNewLineEnabled()

  • # Returns: bool enabled

GetPasteEnabled

GetPasteEnabled()

  • # Returns: bool enabled

GetScrollExtents

GetScrollExtents()

  • # Returns: integer numLines

GetSelectAllOnFocus

GetSelectAllOnFocus()

  • # Returns: bool enabled

GetText

GetText()

  • # Returns: string text

GetTextType

GetTextType()

GetTopLineIndex

GetTopLineIndex()

  • # Returns: luaindex index

HasFocus

HasFocus()

  • # Returns: bool focused

HasSelection

HasSelection()

  • # Returns: bool hasSelection

InsertText

InsertText(string text)

IsComposingIMEText

IsComposingIMEText()

  • # Returns: bool isComposing

IsMultiLine

IsMultiLine()

  • # Returns: bool isMultiLine

IsPassword

IsPassword()

  • # Returns: bool isPassword

LoseFocus

LoseFocus()

RemoveAllValidCharacters

RemoveAllValidCharacters()

SelectAll

SelectAll()

SetAllowMarkupType

SetAllowMarkupType(AllowMarkupType allowMarkupType)

SetAsPassword

SetAsPassword(bool isPassword)

SetColor

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

SetCopyEnabled

SetCopyEnabled(bool enabled)

SetCursorPosition

SetCursorPosition(integer cursorPosition)

SetDefaultText

SetDefaultText(string defaultText)

SetDefaultTextColor

SetDefaultTextColor(number r, number g, number b, number a)

SetEditEnabled

SetEditEnabled(bool enabled)

SetFont

SetFont(string font)

SetMaxInputChars

SetMaxInputChars(integer maxChars)

SetMultiLine

SetMultiLine(bool isMultiLine)

SetNewLineEnabled

SetNewLineEnabled(bool enabled)

SetPasteEnabled

SetPasteEnabled(bool enabled)

SetSelectAllOnFocus

SetSelectAllOnFocus(bool enabled)

SetSelection

SetSelection(integer selectionStartIndex, integer selectionEndIndex)

SetSelectionColor

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

SetText

SetText(string text, bool suppressCallbackHandler)

SetTextType

SetTextType(TextType textType)

SetTopLineIndex

SetTopLineIndex(luaindex index)

SetVirtualKeyboardType

SetVirtualKeyboardType(VirtualKeyboardType keyboardType)

TakeFocus

TakeFocus()

WasLastChangeVirtualKeyboard

WasLastChangeVirtualKeyboard()

  • # Returns: bool fromVirtual

LabelControl

AnchorToBaseline

AnchorToBaseline(object toLabel, layout_measurement offsetX, AnchorPosition anchorSide)

Clean

Clean()

ClearAnchorToBaseline

ClearAnchorToBaseline(object toLabel)

DidLineWrap

DidLineWrap()

  • # Returns: bool didLineWrap

GetColor

GetColor()

  • # Returns: number r, number g, number b, number a

GetControlColor

GetControlColor()

  • # Returns: number r, number g, number b, number a

GetFont

GetFont()

  • # Returns: string text

GetFontFaceName

GetFontFaceName()

  • # Returns: string text

GetFontHeight

GetFontHeight()

  • # Returns: number fontHeightUIUnits

GetFontSize

GetFontSize()

  • # Returns: number fontSize

GetFontStyle

GetFontStyle()

  • # Returns: string text

GetHorizontalAlignment

GetHorizontalAlignment()

GetLinkEnabled

GetLinkEnabled()

  • # Returns: bool linkEnabed

GetModifyTextType

GetModifyTextType()

GetNumLines

GetNumLines()

  • # Returns: integer numLines

GetShaderEffectType

GetShaderEffectType()

GetStringWidth

GetStringWidth(string text)

  • # Returns: number scaledWidthTextLayoutNative

GetStyleColor

GetStyleColor()

  • # Returns: number r, number g, number b, number a

GetText

GetText()

  • # Returns: string text

GetTextDimensions

GetTextDimensions()

  • # Returns: number stringWidthUIUnits, number stringHeightUIUnits

GetTextForLines

GetTextForLines(luaindex startLine, luaindex endLine)

  • # Returns: string text

GetTextHeight

GetTextHeight()

  • # Returns: number stringHeightUIUnits

GetTextWidth

GetTextWidth()

  • # Returns: number stringWidthUIUnits

GetVerticalAlignment

GetVerticalAlignment()

SetColor

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

SetControlColor

SetControlColor(number r, number g, number b, number a)

SetDesaturation

SetDesaturation(number desaturation)

SetFont

SetFont(string fontString)

SetHorizontalAlignment

SetHorizontalAlignment(TextAlignment align)

SetLineSpacing

SetLineSpacing(layout_measurement lineSpacing)

SetLinkEnabled

SetLinkEnabled(bool linkEnabed)

SetMaxLineCount

SetMaxLineCount(integer maxLineCount)

SetMinLineCount

SetMinLineCount(integer minLineCount)

SetModifyTextType

SetModifyTextType(ModifyTextType modifyTextType)

SetNewLineX

SetNewLineX(layout_measurement newLineX)

SetPixelRoundingEnabled

SetPixelRoundingEnabled(bool pixelRoundingEnabled)

SetShaderEffectType

SetShaderEffectType(ShaderEffectType shaderEffectType)

SetSmallCaps

SetSmallCaps(bool smallCaps)

SetStoreLineEndingCharacterIndices

SetStoreLineEndingCharacterIndices(bool storeLineEndingCharacterIndices)

SetStrikethrough

SetStrikethrough(bool strikethrough)

SetStyleColor

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

SetText

SetText(string text)

SetTracking

SetTracking(number textTrackingEm)

SetUnderline

SetUnderline(bool underline)

SetVerticalAlignment

SetVerticalAlignment(TextAlignment align)

SetWrapMode

SetWrapMode(integer wrapMode)

WasTruncated

WasTruncated()

  • # Returns: bool wasTruncated

LineControl

ClearGradientColors

ClearGradientColors()

GetBlendMode

GetBlendMode()

GetColor

GetColor()

  • # Returns: number r, number g, number b, number a

GetDesaturation

GetDesaturation()

  • # Returns: number desaturation

GetTextureCoords

GetTextureCoords()

  • # Returns: number left, number right, number top, number bottom

GetTextureCoordsInPixels

GetTextureCoordsInPixels()

  • # Returns: integer left, integer right, integer top, integer bottom

GetTextureFileDimensions

GetTextureFileDimensions()

  • # Returns: integer pixelWidth, integer pixelHeight

GetTextureFileName

GetTextureFileName()

  • # Returns: string filename

GetThickness

GetThickness()

  • # Returns: number thickness

IsPixelRoundingEnabled

IsPixelRoundingEnabled()

  • # Returns: bool pixelRoundingEnabled

IsTextureLoaded

IsTextureLoaded()

  • # Returns: bool loaded

SetBlendMode

SetBlendMode(TextureBlendMode blendMode)

SetColor

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

SetDesaturation

SetDesaturation(number desaturation)

SetGradientColors

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

SetPixelRoundingEnabled

SetPixelRoundingEnabled(bool pixelRoundingEnabled)

SetTexture

SetTexture(string filename)

SetTextureCoords

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

SetThickness

SetThickness(layout_measurement thickness)

SetVertexColors

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

MapDisplayControl

GetZoom

GetZoom()

  • # Returns: number normalizedRadius

SetBasePinData

SetBasePinData(MapDisplayPinType pinType, MapArrowType arrowType, number pinSize, number pinXInset, number pinYInset, number arrowSize, string textureFilename, string arrowTextureFilename, string areaTextureFilename, string aboveTextureFilename, string belowTextureFilename, string linkTextureFilename, string animation, string addedAnimation, string removedAnimation, MapPinAnimationTarget animationTarget)

SetGutterOffsetAndSize

SetGutterOffsetAndSize(number offset, number size)

SetPinFont

SetPinFont(string pinFont)

SetZoom

SetZoom(number normalizedRadius)

PolygonControl

AddPoint

AddPoint(number normalizedX, number normalizedY)

ClearPoints

ClearPoints()

GetBorderBlendMode

GetBorderBlendMode()

GetBorderDesaturation

GetBorderDesaturation()

  • # Returns: number desaturation

GetBorderDirection

GetBorderDirection()

GetBorderTexture

GetBorderTexture()

  • # Returns: string textureFile

GetBorderThickness

GetBorderThickness()

  • # Returns: number mins, number max, number percent

GetCenterBlendMode

GetCenterBlendMode()

GetCenterColor

GetCenterColor()

  • # Returns: number r, number g, number b, number a

GetCenterDesaturation

GetCenterDesaturation()

  • # Returns: number desaturation

GetCenterTexture

GetCenterTexture()

  • # Returns: string textureFile

GetCenterTextureAddressMode

GetCenterTextureAddressMode()

GetCenterTextureCoords

GetCenterTextureCoords()

  • # Returns: number left, number right, number top, number bottom

GetNumPoints

GetNumPoints()

  • # Returns: integer numPoints

GetPoint

GetPoint(luaindex index)

  • # Returns: number normalizedX, number normalizedY

GetPointLayout

GetPointLayout()

IsSmoothingEnabled

IsSmoothingEnabled()

  • # Returns: bool isSmoothingEnabled

SetBorder

SetBorder(layout_measurement minThickness, layout_measurement maxThickness, number thicknessPercent, string color, string textureFile, number desaturation, TextureBlendMode blendMode, PolygonBorderDirection direction)

SetBorderBlendMode

SetBorderBlendMode(TextureBlendMode blendMode)

SetBorderColor

SetBorderColor(number r, number g, number b, number a)

SetBorderDesaturation

SetBorderDesaturation(number desaturation)

SetBorderDirection

SetBorderDirection(PolygonBorderDirection direction)

SetBorderTexture

SetBorderTexture(string textureFile)

SetBorderThickness

SetBorderThickness(layout_measurement min, layout_measurement max, number percent)

SetCenterBlendMode

SetCenterBlendMode(TextureBlendMode blendMode)

SetCenterColor

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

SetCenterDesaturation

SetCenterDesaturation(number desaturation)

SetCenterTexture

SetCenterTexture(string textureFile)

SetCenterTextureAddressMode

SetCenterTextureAddressMode(TextureAddressMode addressMode)

SetCenterTextureCoords

SetCenterTextureCoords(number left, number right, number top, number bottom)

SetPoint

SetPoint(luaindex index, number normalizedX, number normalizedY)

SetPointLayout

SetPointLayout(PolygonPointLayout pointLayout)

SetSmoothingEnabled

SetSmoothingEnabled(bool isSmoothingEnabled)

ScrollControl

GetHorizontalScroll

GetHorizontalScroll()

  • # Returns: number offset

GetHorizontalScrollExtent

GetHorizontalScrollExtent()

  • # Returns: number horizontal

GetScrollBounding

GetScrollBounding()

GetScrollExtents

GetScrollExtents()

  • # Returns: number horizontal, number vertical

GetScrollOffsets

GetScrollOffsets()

  • # Returns: number horizontal, number vertical

GetVerticalScroll

GetVerticalScroll()

  • # Returns: number offset

GetVerticalScrollExtent

GetVerticalScrollExtent()

  • # Returns: number vertical

RestoreToExtents

RestoreToExtents(integer duration)

SetHorizontalScroll

SetHorizontalScroll(layout_measurement offset)

SetScrollBounding

SetScrollBounding(ScrollBounding bounding)

SetVerticalScroll

SetVerticalScroll(layout_measurement offset)

SliderControl

DoesAllowDraggingFromThumb

DoesAllowDraggingFromThumb()

  • # Returns: bool allow

GetEnabled

GetEnabled()

  • # Returns: bool isEnabled

GetMinMax

GetMinMax()

  • # Returns: number min, number max

GetOrientation

GetOrientation()

GetThumbTextureControl

GetThumbTextureControl()

  • # Returns: object textureControl

GetValue

GetValue()

  • # Returns: number value

GetValueStep

GetValueStep()

  • # Returns: number step

IsThumbFlushWithExtents

IsThumbFlushWithExtents()

  • # Returns: bool flush

SetAllowDraggingFromThumb

SetAllowDraggingFromThumb(bool allow)

SetBackgroundBottomTexture

SetBackgroundBottomTexture(string fileName, number texTop, number texLeft, number texBottom, number texRight)

SetBackgroundMiddleTexture

SetBackgroundMiddleTexture(string fileName, number texTop, number texLeft, number texBottom, number texRight)

SetBackgroundTopTexture

SetBackgroundTopTexture(string fileName, number texTop, number texLeft, number texBottom, number texRight)

SetColor

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

SetEnabled

SetEnabled(bool enable)

SetMinMax

SetMinMax(number min, number max)

SetOrientation

SetOrientation(ControlOrientation orientation)

SetThumbFlushWithExtents

SetThumbFlushWithExtents(bool flush)

SetThumbTexture

SetThumbTexture(string filename, string disabledFilename, string highlightedFilename, layout_measurement thumbWidth, layout_measurement thumbHeight, number texTop, number texLeft, number texBottom, number texRight)

SetThumbTextureAndFlush

SetThumbTextureAndFlush(string filename, string disabledFilename, string highlightedFilename, layout_measurement thumbWidth, layout_measurement thumbHeight, number texTop, number texLeft, number texBottom, number texRight, bool flush)

SetThumbTextureHeight

SetThumbTextureHeight(layout_measurement height)

SetValue

SetValue(number value)

SetValueStep

SetValueStep(number step)

StatusBarControl

CalculateSizeWithoutLeadingEdgeForValue

CalculateSizeWithoutLeadingEdgeForValue(number value)

  • # Returns: number mainBarSize

ClearFadeOutLossAdjustedTopValue

ClearFadeOutLossAdjustedTopValue()

EnableFadeOut

EnableFadeOut(bool enabled)

EnableLeadingEdge

EnableLeadingEdge(bool enabled)

EnableScrollingOverlay

EnableScrollingOverlay(bool enabled)

GetMinMax

GetMinMax()

  • # Returns: number min, number max

GetValue

GetValue()

  • # Returns: number value

IsPixelRoundingEnabled

IsPixelRoundingEnabled()

  • # Returns: bool pixelRoundingEnabled

SetBarAlignment

SetBarAlignment(BarAlignment barAlignment)

SetColor

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

SetFadeOutGainColor

SetFadeOutGainColor(number r, number g, number b, number a)

SetFadeOutLossAdjustedTopValue

SetFadeOutLossAdjustedTopValue(number topValue)

SetFadeOutLossColor

SetFadeOutLossColor(number r, number g, number b, number a)

SetFadeOutLossSetValueToAdjust

SetFadeOutLossSetValueToAdjust(number adjustValue)

SetFadeOutTexture

SetFadeOutTexture(string filename)

SetFadeOutTime

SetFadeOutTime(number fadeOutSeconds, number fadeOutDelaySeconds)

SetGradientColors

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

SetLeadingEdge

SetLeadingEdge(string textureFile, number width, number height)

SetLeadingEdgeTextureCoords

SetLeadingEdgeTextureCoords(number left, number right, number top, number bottom)

SetMinMax

SetMinMax(number aMin, number aMax)

SetOrientation

SetOrientation(ControlOrientation orientation)

SetPixelRoundingEnabled

SetPixelRoundingEnabled(bool pixelRoundingEnabled)

SetTexture

SetTexture(string filename)

SetTextureCoords

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

SetValue

SetValue(number aValue)

SetupScrollingOverlay

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

TextBufferControl

AddMessage

AddMessage(string text, number r, number g, number b, integer colorId)

Clear

Clear()

GetDrawLastEntryIfOutOfRoom

GetDrawLastEntryIfOutOfRoom()

  • # Returns: bool drawLastIfOutOfRoom

GetHorizontalAlignment

GetHorizontalAlignment()

GetLineFade

GetLineFade()

  • # Returns: number timeBeforeLineBeginsToFade, number timeItTakesLineToFade

GetLinkEnabled

GetLinkEnabled()

  • # Returns: bool linkEnabed

GetMaxHistoryLines

GetMaxHistoryLines()

  • # Returns: integer numLines

GetNumHistoryLines

GetNumHistoryLines()

  • # Returns: integer numLines

GetNumVisibleLines

GetNumVisibleLines()

  • # Returns: integer numLines

GetScrollPosition

GetScrollPosition()

  • # Returns: integer scrollPosition

IsSplittingLongMessages

IsSplittingLongMessages()

  • # Returns: bool isSplitting

MoveScrollPosition

MoveScrollPosition(integer numLines)

SetClearBufferAfterFadeout

SetClearBufferAfterFadeout(bool clearAfterFade)

SetColorById

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

SetDrawLastEntryIfOutOfRoom

SetDrawLastEntryIfOutOfRoom(bool drawLastIfOutOfRoom)

SetFont

SetFont(string fontString)

SetHorizontalAlignment

SetHorizontalAlignment(TextAlignment horizontalAlign)

SetLineFade

SetLineFade(number timeBeforeLineFadeBegins, number timeForLineToFade)

SetLinesInheritAlpha

SetLinesInheritAlpha(bool linesInheritAlpha)

SetLinkEnabled

SetLinkEnabled(bool linkEnabed)

SetMaxHistoryLines

SetMaxHistoryLines(integer numLines)

SetScrollPosition

SetScrollPosition(integer line)

SetSplitLongMessages

SetSplitLongMessages(bool splitLongMessages)

ShowFadedLines

ShowFadedLines()

TextureCompositeControl

AddSurface

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

  • # Returns: luaindex surfaceIndex

ClearAllSurfaces

ClearAllSurfaces()

GetBlendMode

GetBlendMode()

GetColor

GetColor(luaindex surfaceIndex)

  • # Returns: number r, number g, number b, number a

GetDesaturation

GetDesaturation()

  • # Returns: number desaturation

GetInsets

GetInsets(luaindex surfaceIndex)

  • # Returns: number left, number right, number top, number bottom

GetNumSurfaces

GetNumSurfaces()

  • # Returns: integer surfaces

GetSurfaceAlpha

GetSurfaceAlpha(luaindex surfaceIndex)

  • # Returns: number a

GetTextureCoords

GetTextureCoords(luaindex surfaceIndex)

  • # Returns: number left, number right, number top, number bottom

GetTextureFileDimensions

GetTextureFileDimensions()

  • # Returns: integer pixelWidth, integer pixelHeight

GetTextureFileName

GetTextureFileName()

  • # Returns: string filename

IsPixelRoundingEnabled

IsPixelRoundingEnabled()

  • # Returns: bool pixelRoundingEnabled

IsSurfaceHidden

IsSurfaceHidden(luaindex surfaceIndex)

  • # Returns: bool hidden

IsTextureLoaded

IsTextureLoaded()

  • # Returns: bool loaded

RemoveSurface

RemoveSurface(luaindex surfaceIndex)

SetBlendMode

SetBlendMode(TextureBlendMode blendMode)

SetColor

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

SetDesaturation

SetDesaturation(number desaturation)

SetInsets

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

SetPixelRoundingEnabled

SetPixelRoundingEnabled(bool pixelRoundingEnabled)

SetSurfaceAlpha

SetSurfaceAlpha(luaindex surfaceIndex, number a)

SetSurfaceHidden

SetSurfaceHidden(luaindex surfaceIndex, bool hidden)

SetSurfaceScale

SetSurfaceScale(luaindex surfaceIndex, number scale)

SetSurfaceTextureRotation

SetSurfaceTextureRotation(luaindex surfaceIndex, number angleInRadians, number normalizedRotationPointX, number normalizedRotationPointY)

SetTexture

SetTexture(string filename)

SetTextureCoords

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

SetTextureReleaseOption

SetTextureReleaseOption(ReleaseReferenceOptions releaseOption)

TextureControl

ClearGradientColors

ClearGradientColors()

Get3DLocalDimensions

Get3DLocalDimensions()

  • # Returns: number width, number height

GetAddressMode

GetAddressMode()

GetBlendMode

GetBlendMode()

GetColor

GetColor()

  • # Returns: number r, number g, number b, number a

GetControlColor

GetControlColor()

  • # Returns: number r, number g, number b, number a

GetDesaturation

GetDesaturation()

  • # Returns: number desaturation

GetResizeToFitFile

GetResizeToFitFile()

  • # Returns: bool resizesToFitFile

GetShaderEffectType

GetShaderEffectType()

GetTextureCoords

GetTextureCoords()

  • # Returns: number left, number right, number top, number bottom

GetTextureCoordsInPixels

GetTextureCoordsInPixels()

  • # Returns: integer left, integer right, integer top, integer bottom

GetTextureFileDimensions

GetTextureFileDimensions()

  • # Returns: integer pixelWidth, integer pixelHeight

GetTextureFileName

GetTextureFileName()

  • # Returns: string filename

GetVertexUV

GetVertexUV(VERTEX_POINTS vertex)

  • # Returns: number u, number v

Is3DQuadFacingCamera

Is3DQuadFacingCamera()

  • # Returns: bool isFacing

IsPixelRoundingEnabled

IsPixelRoundingEnabled()

  • # Returns: bool pixelRoundingEnabled

IsTextureLoaded

IsTextureLoaded()

  • # Returns: bool loaded

Set3DLocalDimensions

Set3DLocalDimensions(number width, number height)

SetAddressMode

SetAddressMode(TextureAddressMode addressMode)

SetAutoAdjustWrappedCoords

SetAutoAdjustWrappedCoords(bool enabled)

SetBlendMode

SetBlendMode(TextureBlendMode blendMode)

SetColor

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

SetControlColor

SetControlColor(number r, number g, number b, number a)

SetDesaturation

SetDesaturation(number desaturation)

SetGradientColors

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

SetPixelRoundingEnabled

SetPixelRoundingEnabled(bool pixelRoundingEnabled)

SetResizeToFitFile

SetResizeToFitFile(bool resizesToFitFile)

SetShaderEffectType

SetShaderEffectType(ShaderEffectType shaderEffectType)

SetTexture

SetTexture(string filename)

SetTextureCoords

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

SetTextureCoordsRotation

SetTextureCoordsRotation(number angleInRadians)

SetTextureFileName

SetTextureFileName(string filename)

SetTextureFromGuiTexture

SetTextureFromGuiTexture(object guiTexture)

SetTextureReleaseOption

SetTextureReleaseOption(ReleaseReferenceOptions releaseOption)

SetTextureRotation

SetTextureRotation(number angleInRadians, number normalizedRotationPointX, number normalizedRotationPointY)

SetTextureSampleProcessingWeight

SetTextureSampleProcessingWeight(TextureSampleProcessing sampleProcessingType, number weight)

SetVertexColors

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

SetVertexUV

SetVertexUV(VERTEX_POINTS vertex, number u, number v)

TooltipControl

AddControl

AddControl(object control, integer cell, bool useLastRow)

AddHeaderControl

AddHeaderControl(object control, integer headerRow, TooltipHeaderSide headerSide)

AddHeaderLine

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

AddLine

AddLine(string text, string font, number r, number g, number b, AnchorPosition lineAnchor, ModifyTextType modifyTextType, TextAlignment textAlignment, bool setToFullSize, number minWidth, layout_measurement lineSpacing)

AddVerticalPadding

AddVerticalPadding(number paddingY)

AppendAvAObjective

AppendAvAObjective(integer queryType, integer keepId, integer objectiveId, ObjectivePinTier objectivePinTier)

AppendDigSiteAntiquities

AppendDigSiteAntiquities(integer digSiteId)

AppendMapPing

AppendMapPing(integer pingType, string unitTag)

AppendQuestCondition

AppendQuestCondition(luaindex questIndex, luaindex stepIndex, luaindex conditionIndex)

AppendQuestEnding

AppendQuestEnding(luaindex questIndex)

AppendQuestName

AppendQuestName(luaindex questIndex)

AppendSkyshardHint

AppendSkyshardHint(integer skyshardId)

AppendTeamScore

AppendTeamScore(TeamType teamType, integer teamValue)

AppendUnitName

AppendUnitName(string unitTag)

AppendZoneSpectacleTooltip

AppendZoneSpectacleTooltip(integer spectacleId)

ClearLines

ClearLines()

GetOwner

GetOwner()

  • # Returns: object owner

HideComparativeTooltips

HideComparativeTooltips()

SetAbility

SetAbility(luaindex abilityIndex, bool showBase)

SetAbilityId

SetAbilityId(integer abilityId)

SetAchievement

SetAchievement(integer achievementId)

SetAchievementRewardItem

SetAchievementRewardItem(integer achievementId)

SetAction

SetAction(luaindex slotId, HotBarCategory:nilable hotbarCategory)

SetActiveSkill

SetActiveSkill(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex, MorphSlot morphSlot, bool isPurchased, bool isAdvised, bool isBadMorph, integer numAvailableSkillPoints, bool showSkillPointCost, bool showUpgradeText, bool showAdvised, bool showBadMorph, integer:nilable overrideRank, integer:nilable overrideAbilityId)

SetAdventureZoneBoss

SetAdventureZoneBoss(AdventureZoneBoss boss)

SetAntiquityLead

SetAntiquityLead(integer antiquityId)

SetAntiquitySetFragment

SetAntiquitySetFragment(integer antiquityId)

SetAsComparativeTooltip1

SetAsComparativeTooltip1()

SetAsComparativeTooltip2

SetAsComparativeTooltip2()

SetAttachedMailItem

SetAttachedMailItem(id64 mailId, luaindex attachSlot)

SetBagItem

SetBagItem(Bag bagIndex, integer slotIndex, ItemTooltipDisplayFlags displayFlags)

SetBook

SetBook(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)

SetBuff

SetBuff(integer buffSlotId, string unitTag)

SetBuybackItem

SetBuybackItem(luaindex entryIndex)

SetChampionSkill

SetChampionSkill(integer championSkillId, integer numPendingPoints, integer nextJumpPoint, bool isPendingSlotted)

SetCollectible

SetCollectible(integer collectibleId, bool addNickname, bool showPurchasableHint, bool showBlockReason, GameplayActorCategory actorCategory)

SetCompanionSkill

SetCompanionSkill(integer abilityId)

SetCraftedAbility

SetCraftedAbility(integer craftedAbilityId, integer primaryScriptId, integer secondaryScriptId, integer tertiaryScriptId, ScribingTooltipDisplayFlags displayFlags)

SetCraftedAbilityScript

SetCraftedAbilityScript(integer craftedAbilityId, integer craftedAbilityScriptId, integer primaryScriptId, integer secondaryScriptId, integer tertiaryScriptId, ScribingTooltipDisplayFlags displayFlags)

SetCrownCrateReward

SetCrownCrateReward(luaindex rewardIndex)

SetCurrency

SetCurrency(CurrencyType currencyType, integer quantity)

SetDailyLoginRewardEntry

SetDailyLoginRewardEntry(luaindex rewardIndex)

SetEdgeKeepBonusAbility

SetEdgeKeepBonusAbility(luaindex bonusIndex)

SetEmperorBonusAbility

SetEmperorBonusAbility(integer rankIndex)

SetEndlessDungeonBuff

SetEndlessDungeonBuff(integer buffAbilityId, bool includeLifetimeStacks)

SetFont

SetFont(string fontStr)

SetGenericItemSet

SetGenericItemSet(integer itemSetId)

SetGuildSpecificItem

SetGuildSpecificItem(luaindex guildSpecificItemIndex)

SetHeaderCellEmptyHorizontalSpace

SetHeaderCellEmptyHorizontalSpace(number headerCellEmptyHorizontalSpace)

SetHeaderRowSpacing

SetHeaderRowSpacing(number spacing)

SetHeaderVerticalOffset

SetHeaderVerticalOffset(number verticalOffset)

SetItemSetCollectionPieceLink(string link, bool hideTrait)

SetItemUsingEnchantment

SetItemUsingEnchantment(Bag itemBagIndex, integer itemSlotIndex, Bag enchantmentBagIndex, integer enchantmentSlotIndex)

SetKeepBonusAbility

SetKeepBonusAbility(luaindex bonusIndex)

SetKeepUpgrade

SetKeepUpgrade(integer keepId, BattlegroundQueryContextType battlegroundContext, integer upgradeLine, integer level, luaindex index)

SetLastCraftingResultItem

SetLastCraftingResultItem(luaindex resultIndex)

SetLink(string link)

SetLootItem

SetLootItem(integer lootId)

SetMarketProduct

SetMarketProduct(integer marketProductId, bool showCollectiblePurchasableHint)

SetMarketProductListing

SetMarketProductListing(integer marketProductId, luaindex:nilable presentationIndex)

SetMinHeaderRowHeight

SetMinHeaderRowHeight(number minRowHeight)

SetMinHeaderRows

SetMinHeaderRows(integer minRows)

SetOwner

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

SetPassiveSkill

SetPassiveSkill(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex, integer rank, integer purchasedToRank, integer numAvailableSkillPoints, bool showSkillPointCost)

SetPendingAlchemyItem

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

SetPendingEnchantingItem

SetPendingEnchantingItem(Bag potencyRuneBagId, integer potencyRuneSlotIndex, Bag essenceRuneBagId, integer essenceRuneSlotIndex, Bag aspectRuneBagId, integer aspectRuneSlotIndex)

SetPendingRetraitItem

SetPendingRetraitItem(Bag bagIndex, integer slotIndex, ItemTraitType pendingTrait)

SetPendingSmithingItem

SetPendingSmithingItem(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, integer itemStyleId, luaindex traitIndex)

SetPlacedFurniture

SetPlacedFurniture(id64 placedFurnitureId)

SetProgressionAbility

SetProgressionAbility(luaindex progressionIndex, integer morph, integer rank, bool showAdvice, bool advised)

SetProvisionerIngredientItem

SetProvisionerIngredientItem(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex)

SetProvisionerResultItem

SetProvisionerResultItem(luaindex recipeListIndex, luaindex recipeIndex)

SetQuestItem

SetQuestItem(luaindex questIndex, luaindex stepIndex, luaindex conditionIndex)

SetQuestReward

SetQuestReward(luaindex perkIndex)

SetQuestTool

SetQuestTool(luaindex questIndex, luaindex toolIndex)

SetReward

SetReward(integer rewardId, integer quantity, RewardDisplayFlags displayFlags)

SetRewardList

SetRewardList(integer rewardListId)

SetScrollBonusAbility

SetScrollBonusAbility(Alliance alliance, ObjectiveType artifactType, luaindex bonusIndex)

SetSkillAbility

SetSkillAbility(integer skillType, luaindex skillLineIndex, luaindex skillIndex, bool badMorph)

SetSkillLine

SetSkillLine(SkillType skillType, luaindex skillLineIndex)

SetSkillLineAbilityId

SetSkillLineAbilityId(integer abilityId, SkillType skillType, luaindex skillLineIndex, luaindex skillLineAbilityIndex, integer morphChoice)

SetSkillLineById

SetSkillLineById(integer skillLineId)

SetSkillUpgradeAbility

SetSkillUpgradeAbility(integer skillType, luaindex skillLineIndex, luaindex skillIndex)

SetSmithingImprovementItem

SetSmithingImprovementItem(integer craftingSkillType, luaindex improvementItemIndex)

SetSmithingImprovementResult

SetSmithingImprovementResult(Bag itemToImproveBagId, integer itemToImproveSlotIndex, integer craftingSkillType)

SetSmithingMaterialItem

SetSmithingMaterialItem(luaindex patternIndex, luaindex materialIndex)

SetSmithingStyleItem

SetSmithingStyleItem(integer itemStyleId)

SetSmithingTraitItem

SetSmithingTraitItem(luaindex traitItemIndex)

SetStoreItem

SetStoreItem(luaindex entryIndex)

SetSubclassingSkillLineById

SetSubclassingSkillLineById(integer skillLineId)

SetTradeItem

SetTradeItem(integer who, luaindex tradeIndex)

SetTradingHouseItem

SetTradingHouseItem(luaindex tradingHouseIndex)

SetTradingHouseListing

SetTradingHouseListing(luaindex tradingHouseIndex)

SetTributeBoardLocationPatrons

SetTributeBoardLocationPatrons(TributeBoardLocation boardLocation)

SetTributeCard

SetTributeCard(integer patronId, integer cardId)

SetTributeLeaderboardRewardList

SetTributeLeaderboardRewardList(integer rewardListId)

SetTributePatron

SetTributePatron(integer patronId, bool highlightActiveFavorState, bool suppressNotCollectibleWarning, bool showAcquireHint, bool showLore)

SetTributePatronDockCard

SetTributePatronDockCard(integer patronId, luaindex cardIndex, bool showUpgrade)

SetTributePatronStarterCard

SetTributePatronStarterCard(integer patronId, luaindex cardIndex)

SetTributePatronWithFavorState

SetTributePatronWithFavorState(integer patronId, TributePatronPerspectiveFavorState highlightFavorState)

SetTributeSeasonRewardList

SetTributeSeasonRewardList(TributeTier tributeTier, integer rewardListId)

SetVengeancePerk

SetVengeancePerk(luaindex perkIndex, VengeanceActionResult:nilable actionResult, luaindex:nilable roleIndex)

SetVengeancePerkId

SetVengeancePerkId(integer perkDefId)

SetVerticalPadding

SetVerticalPadding(number paddingY)

SetWornItem

SetWornItem(EquipSlot equipSlot, Bag bagId)

ShowComparativeTooltips

ShowComparativeTooltips()

WindowManager

ApplyTemplateToControl

ApplyTemplateToControl(object control, string virtualName)

CompareControlVisualOrder

CompareControlVisualOrder(object controlA, object controlB)

  • # Returns: integer order

CreateControl

CreateControl(string name, object parent, ControlType type)

  • # Returns: object control

CreateControlFromVirtual

CreateControlFromVirtual(string controlName, object parent, string virtualName, string optionalSuffix)

  • # Returns: object control

CreateCursor

CreateCursor(layout_measurement x, layout_measurement y)

  • # Returns: integer cursorId

CreateTopLevelWindow

CreateTopLevelWindow(string name)

  • # Returns: object control

DestroyCursor

DestroyCursor(integer cursorId)

GetControlAtCursor

GetControlAtCursor(integer cursorId, HitTestingDesiredHandlers desiredHandlers)

  • # Returns: object controlAtCursor

GetControlByName

GetControlByName(string name, string suffix)

  • # Returns: object ret

GetCursorPosition

GetCursorPosition(integer cursorId)

  • # Returns: number x, number y

GetFocusControl

GetFocusControl()

  • # Returns: object focusControl

GetHandler

GetHandler(string handlerName, string name)

  • # Returns: function functionRef

GetIMECandidate

GetIMECandidate(luaindex index)

  • # Returns: string candidate

GetIMECandidatePageInfo

GetIMECandidatePageInfo()

  • # Returns: luaindex selectedIndex, luaindex pageStartIndex, integer pageSize

GetMouseFocusControl

GetMouseFocusControl()

  • # Returns: object mouseFocusControl

GetMouseOverControl

GetMouseOverControl()

  • # Returns: object mouseOverControl

GetNumIMECandidates

GetNumIMECandidates()

  • # Returns: integer numCandidates

GetUIMousePosition

GetUIMousePosition()

  • # Returns: number x, number y

HasFocusControl

HasFocusControl()

  • # Returns: bool hasFocusControl

IsChoosingIMECandidate

IsChoosingIMECandidate()

  • # Returns: bool isChoosingCandidate

IsHandlingHardwareEvent

IsHandlingHardwareEvent()

  • # Returns: bool isHandlingHardwareEvent

IsMouseOverWorld

IsMouseOverWorld()

  • # Returns: bool isMouseOverWorld

IsSecureRenderModeEnabled

IsSecureRenderModeEnabled()

  • # Returns: bool secureRenderModeEnabled

IsUsingCustomCandidateList

IsUsingCustomCandidateList()

  • # Returns: bool isUsingCustomCandidateList

SetFocusByName

SetFocusByName(string name)

SetHandler

SetHandler(string handlerName, function functionRef, string name, ControlHandlerOrder controlHandlerOrder, string targetName)

SetMouseCursor

SetMouseCursor(MouseCursorType cursorType)

SetMouseFocusByName

SetMouseFocusByName(string name)

UpdateCursorPosition

UpdateCursorPosition(integer cursorId, layout_measurement x, layout_measurement y)

GetWindowManager

GetWindowManager()

  • # Returns: object windowManager

MouseIsOver

MouseIsOver(object control, number leftOffset, number topOffset, number rightOffset, number bottomOffset)

  • # Returns: bool isOver

MouseIsInside

MouseIsInside(object control, number leftOffset, number topOffset, number rightOffset, number bottomOffset)

  • # Returns: bool isInside

GetUIMouseDeltas

GetUIMouseDeltas()

  • # Returns: number deltaX, number deltaY

GetUIGlobalScale

GetUIGlobalScale()

  • # Returns: number scale

GetUICustomScale

GetUICustomScale()

  • # Returns: number scale

LocalizeString

LocalizeString(string formatString, string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7)

  • # Returns: string localizedString

GetAnimationManager

GetAnimationManager()

  • # Returns: object animationManager

GetAddOnManager

GetAddOnManager()

  • # Returns: object addOnManager

RedirectTexture

RedirectTexture(string originalTexture, string newTexture)

EscapeMarkup

EscapeMarkup(string text, AllowMarkupType allowMarkupType)

  • # Returns: string escapedText

CreateFont

CreateFont(string fontSymbolName, string fontDescriptor)

  • # Returns: object fontObject

GetNumControlCreatingSources

GetNumControlCreatingSources()

  • # Returns: integer numFiles

GetControlCreatingSourceName

GetControlCreatingSourceName(luaindex index)

  • # Returns: string sourceName

GetNumControlCreatingSourceCallSites

GetNumControlCreatingSourceCallSites(string sourceName)

  • # Returns: integer numCallSites

GetControlCreatingSourceCallSiteInfo

GetControlCreatingSourceCallSiteInfo(string sourceName, luaindex index)

  • # Returns: string creationStack, integer count

StartScriptProfiler

StartScriptProfiler()

StopScriptProfiler

StopScriptProfiler()

IsScriptProfilerEnabled

IsScriptProfilerEnabled()

  • # Returns: bool enabled

GetScriptProfilerNumFrames

GetScriptProfilerNumFrames()

  • # Returns: integer numFrames

GetScriptProfilerFrameNumRecords

GetScriptProfilerFrameNumRecords(luaindex frameIndex)

  • # Returns: integer numRecords

GetScriptProfilerRecordInfo

GetScriptProfilerRecordInfo(luaindex frameIndex, luaindex recordIndex)

  • # Returns: luaindex recordDataIndex, number startTimeNS, number endTimeNS, luaindex:nilable callerRecordIndex, ScriptProfilerRecordDataType recordDataType

GetScriptProfilerNumClosures

GetScriptProfilerNumClosures()

  • # Returns: integer numClosures

GetScriptProfilerClosureInfo

GetScriptProfilerClosureInfo(luaindex recordDataIndex)

  • # Returns: string displayName, string fileName, integer fileLineNumber

GetScriptProfilerNumCFunctions

GetScriptProfilerNumCFunctions()

  • # Returns: integer numCFunctions

GetScriptProfilerCFunctionInfo

GetScriptProfilerCFunctionInfo(luaindex recordDataIndex)

  • # Returns: string functionName

GetScriptProfilerNumGarbageCollectionTypes

GetScriptProfilerNumGarbageCollectionTypes()

  • # Returns: integer numGarbageCollectionTypes

GetScriptProfilerGarbageCollectionInfo

GetScriptProfilerGarbageCollectionInfo(luaindex recordDataIndex)

RecordScriptProfilerUserEvent

RecordScriptProfilerUserEvent(string userEventData)

GetScriptProfilerNumUserEvents

GetScriptProfilerNumUserEvents()

  • # Returns: integer numUserEvents

GetScriptProfilerUserEventInfo

GetScriptProfilerUserEventInfo(luaindex recordDataIndex)

  • # Returns: string userEventData

GetCameraForward

GetCameraForward(Space space)

  • # Returns: number forwardX, number forwardY, number forwardZ

GetMinUICanvasWidth

GetMinUICanvasWidth()

  • # Returns: number minWidth

GetMinUICanvasHeight

GetMinUICanvasHeight()

  • # Returns: number minHeight

GetInterfaceVerticalFieldOfView

GetInterfaceVerticalFieldOfView()

  • # Returns: number FoVYRadians

SetInterfaceVerticalFieldOfView

SetInterfaceVerticalFieldOfView(number FoVYRadians)

CopyToClipboard *private* (*string* _text_)

CopyToClipboard private (string text)

GetFontStyleString

GetFontStyleString(FontStyle fontStyle)

  • # Returns: string fontStyleString

ConvertRGBToHSV

ConvertRGBToHSV(number red, number green, number blue)

  • # Returns: number hue, number saturation, number value

ConvertRGBToHSL

ConvertRGBToHSL(number red, number green, number blue)

  • # Returns: number hue, number saturation, number lightness

ScriptEventManager

AddFilterForEvent

AddFilterForEvent(string name, integer event, variant filterParameter)

  • # Returns: bool success

RegisterForAllEvents

RegisterForAllEvents(string name, function callback)

  • # Returns: bool ret

RegisterForEvent

RegisterForEvent(string name, integer event, function callback, bool doOnce)

  • # Returns: bool ret

RegisterForPostEffectsUpdate

RegisterForPostEffectsUpdate(string name, integer minInterval, function callback)

  • # Returns: bool ret

RegisterForUpdate

RegisterForUpdate(string name, integer minInterval, function callback)

  • # Returns: bool ret

UnregisterForAllEvents

UnregisterForAllEvents(string name)

  • # Returns: bool ret

UnregisterForEvent

UnregisterForEvent(string name, integer event)

  • # Returns: bool ret

UnregisterForPostEffectsUpdate

UnregisterForPostEffectsUpdate(string name)

  • # Returns: bool ret

UnregisterForUpdate

UnregisterForUpdate(string name)

  • # Returns: bool ret