Skip to content

Object API · LIVE

LIVE

Object API from ESOUIDocumentationP49.txt with 49 objects.

AddOnManager

AddRelevantFilter

(string relevantFilter)

AreAddOnsEnabled

()

  • # Returns: bool areAddOnsEnabled

ClearForceDisabledAddOnNotification

(luaindex disabledAddonIndex)

ClearUnusedAddOnSavedVariables

()

ClearWarnOutOfDateAddOns

()

GetAddOnDependencyInfo

(luaindex addOnIndex, luaindex addOnDependencyIndex)

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

GetAddOnFilter

()

  • # Returns: string settingFilter

GetAddOnInfo

(luaindex addOnIndex)

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

GetAddOnNumDependencies

(luaindex addOnIndex)

  • # Returns: integer numDependencies

GetAddOnRootDirectoryPath

(luaindex addOnIndex)

  • # Returns: string directoryPath

GetAddOnVersion

(luaindex addOnIndex)

  • # Returns: integer version

GetForceDisabledAddOnInfo

(luaindex disabledAddonIndex)

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

GetLoadOutOfDateAddOns

()

  • # Returns: bool loadOutOfDateAddons

GetNumAddOns

()

  • # Returns: integer numAddOns

GetNumForceDisabledAddOns

()

  • # Returns: integer numDisabledAddons

GetTotalUnusedAddOnSavedVariablesDiskUsageMB

()

  • # Returns: number totalUnusedAddOnSavedVariablesDiskUsageMB

GetTotalUserAddOnSavedVariablesDiskCapacityMB

()

  • # Returns: number totalUserAddOnSavedVariablesDiskCapacityMB

GetTotalUserAddOnSavedVariablesDiskUsageMB

()

  • # Returns: number totalUserAddOnSavedVariablesDiskUsageMB

GetUserAddOnSavedVariablesDiskUsageMB

(luaindex addOnIndex)

  • # Returns: number userAddOnSavedVariablesDiskUsageMB

RemoveAddOnFilter

()

RequestAddOnSavedVariablesPrioritySave

(string addOnName)

ResetRelevantFilters

()

SetAddOnEnabled

(luaindex addOnIndex, bool enabled)

SetAddOnFilter

(string settingFilter)

SetAddOnsEnabled

(bool enabled)

ShouldWarnOutOfDateAddOns

()

  • # Returns: bool warnOutOfDateAddons

WasAddOnDetected

(string addOnName)

  • # Returns: bool wasDetected

AnimationObject

GetAnimatedControl

()

  • # Returns: object animatedControl

GetApplyToChildControlName

()

  • # Returns: string applyToChildControlName

GetDuration

()

  • # Returns: integer durationMs

GetEasingFunction

()

  • # Returns: function functionRef

GetHandler

(string eventName, string name)

  • # Returns: function functionRef

GetTimeline

()

  • # Returns: object owningTimeline

GetType

()

IsEnabled

()

  • # Returns: bool isEnabled

IsPlaying

()

  • # Returns: bool isPlaying

SetAnimatedControl

(object animatedControl)

SetApplyToChildControlName

(string applyToChildControlName)

SetDuration

(integer durationMs)

SetEasingFunction

(function functionRef)

SetEnabled

(bool enabled)

SetHandler

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

SetOffsetInParent

(integer offset)

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

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

SetDeltaOffsetX

(number deltaX, TranslateAnimationDeltaType translateAnimationDeltaType)

SetDeltaOffsetY

(number deltaY, TranslateAnimationDeltaType translateAnimationDeltaType)

SetDeltaOffsetZ

(number deltaZ, 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, TranslateAnimationDeltaType translateAnimationDeltaType)

SetTranslateOffsets

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

AnimationObjectColor

GetApplyAlpha

()

  • # Returns: bool applyAlpha

GetEndColor

()

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

GetStartColor

()

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

SetApplyAlpha

(bool applyAlpha)

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)

AnimationObjectTransformOffset

GetEndOffset

()

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

GetStartOffset

()

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

SetEndOffset

(layout_measurement endX, layout_measurement endY, layout_measurement endZ)

SetEndOffsetX

(layout_measurement endX)

SetEndOffsetY

(layout_measurement endY)

SetEndOffsetZ

(layout_measurement endZ)

SetOffsets

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

SetStartOffset

(layout_measurement startX, layout_measurement startY, layout_measurement startZ)

SetStartOffsetX

(layout_measurement startX)

SetStartOffsetY

(layout_measurement startY)

SetStartOffsetZ

(layout_measurement startZ)

AnimationObjectTransformRotation

SetEndRotation

(number endXRadians, number endYRadians, number endZRadians)

SetEndX

(number endXRadians)

SetEndY

(number endYRadians)

SetEndZ

(number endZRadians)

SetMode

(RotationAnimationMode mode)

SetRotations

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

SetStartRotation

(number startXRadians, number startYRadians, number startZRadians)

SetStartX

(number startXRadians)

SetStartY

(number startYRadians)

SetStartZ

(number startZRadians)

AnimationObjectTranslate

GetAnchorIndex

()

  • # Returns: integer 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

(integer anchorIndex)

SetDeltaOffsetX

(layout_measurement deltaX, TranslateAnimationDeltaType translateAnimationDeltaType)

SetDeltaOffsetXFromEnd

(layout_measurement deltaX)

SetDeltaOffsetXFromStart

(layout_measurement deltaX)

SetDeltaOffsetY

(layout_measurement deltaY, TranslateAnimationDeltaType translateAnimationDeltaType)

SetDeltaOffsetYFromEnd

(layout_measurement deltaY)

SetDeltaOffsetYFromStart

(layout_measurement deltaY)

SetEndOffsetX

(layout_measurement endX)

SetEndOffsetY

(layout_measurement endY)

SetStartOffsetX

(layout_measurement startX)

SetStartOffsetY

(layout_measurement startY)

SetTranslateDeltas

(layout_measurement deltaX, layout_measurement deltaY, TranslateAnimationDeltaType translateAnimationDeltaType)

SetTranslateOffsets

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

AnimationTimeline

ApplyAllAnimationsToControl

(object animatedControl)

ClearAllCallbacks

()

ClearAnimatedControlFromAllAnimations

()

GetAnimation

(luaindex animationIndex)

  • # Returns: object animation

GetAnimationOffset

(object animation)

  • # Returns: integer offset

GetAnimationTimeline

(luaindex timelineIndex)

  • # Returns: object timeline

GetAnimationTimelineOffset

(object animation)

  • # Returns: integer offset

GetDuration

()

  • # Returns: integer duration

GetFirstAnimation

()

  • # Returns: object animation

GetFirstAnimationOfType

(AnimationType animationType)

  • # Returns: object animation

GetFirstAnimationTimeline

()

  • # Returns: object timeline

GetFullProgress

()

  • # Returns: number progress

GetHandler

(string eventName, string name)

  • # Returns: function functionRef

GetLastAnimation

()

  • # Returns: object animation

GetLastAnimationTimeline

()

  • # Returns: object timeline

GetMinDuration

()

  • # Returns: integer minDuration

GetNumAnimationTimelines

()

  • # Returns: integer numTimelines

GetNumAnimations

()

  • # Returns: integer numAnimations

GetParent

()

  • # Returns: object timeline

GetPlaybackLoopsRemaining

()

  • # Returns: integer loopsRemaining

GetProgress

()

  • # Returns: number progress

GetSkipAnimationsBehindPlayheadOnInitialPlay

()

  • # Returns: bool skipAnimations

InsertAnimation

(AnimationType animationType, object animatedControl, integer offset)

  • # Returns: object animation

InsertAnimationFromVirtual

(string animationVirtualName, object animatedControl)

  • # Returns: object animation

InsertAnimationTimeline

(integer offset, object animatedControl)

  • # Returns: object animation

InsertAnimationTimelineFromVirtual

(string animationVirtualName, object animatedControl)

  • # Returns: object animation

InsertCallback

(function functionRef, integer offset)

  • # Returns: function functionRefRet

IsEnabled

()

  • # Returns: bool isEnabled

IsPaused

()

  • # Returns: bool isPaused

IsPlaying

()

  • # Returns: bool isPlaying

IsPlayingBackward

()

  • # Returns: bool reversed

Pause

()

PlayBackward

()

PlayForward

()

PlayFromEnd

(integer offsetMs)

PlayFromStart

(integer offsetMs)

PlayInstantlyToEnd

(bool ignoreCallbacks)

PlayInstantlyToStart

(bool ignoreCallbacks)

Resume

()

SetAllAnimationOffsets

(integer offset)

SetAnimationOffset

(object animation, integer offset)

SetAnimationTimelineOffset

(object animation, integer offset)

SetCallbackOffset

(function callback, integer offset)

SetEnabled

(bool enabled)

SetHandler

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

SetMinDuration

(integer minDuration)

SetOffsetInParent

(integer offset)

SetPlaybackLoopCount

(integer maxLoopCount)

SetPlaybackLoopsRemaining

(integer loopsRemaining)

SetPlaybackType

(AnimationPlayback playbackType, integer maxLoopCount)

SetProgress

(number progress)

SetSkipAnimationsBehindPlayheadOnInitialPlay

(bool skipAnimations)

Stop

()

BackdropControl

GetBlendMode

()

GetCenterColor

()

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

GetCenterTextureFileName

()

  • # Returns: string filename

GetEdgeColor

()

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

GetEdgeTextureFileName

()

  • # Returns: string filename

IsPixelRoundingEnabled

()

  • # Returns: bool pixelRoundingEnabled

SetBlendMode

(TextureBlendMode blendMode)

SetCenterColor

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

SetCenterTexture

(string filename, layout_measurement tilingInterval, TextureAddressMode addressMode)

SetCenterTextureFileName

(string filename)

SetEdgeColor

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

SetEdgeTexture

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

SetEdgeTextureFileName

(string filename)

SetInsets

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

SetIntegralWrapping

(bool integralWrappingEnabled)

SetPixelRoundingEnabled

(bool enabled)

SetTextureReleaseOption

(ReleaseReferenceOptions releaseOption)

ButtonControl

EnableMouseButton

(MouseButtonIndex button, bool enabled)

GetHorizontalAlignment

()

GetLabelControl

()

  • # Returns: object labelControl

GetState

()

GetVerticalAlignment

()

IsPixelRoundingEnabled

()

  • # Returns: bool 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

(bool enabled)

SetEndCapWidth

(layout_measurement endCapWidth)

SetFont

(string text)

SetHorizontalAlignment

(TextAlignment horizontalAlign)

SetModifyTextType

(ModifyTextType modifyTextType)

SetMouseOverBlendMode

(TextureBlendMode blendMode)

SetMouseOverFontColor

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

SetMouseOverTexture

(string textureFilename)

SetNormalFontColor

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

SetNormalOffset

(layout_measurement x, layout_measurement y)

SetNormalTexture

(string textureFilename)

SetPixelRoundingEnabled

(bool pixelRoundingEnabled)

SetPressedFontColor

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

SetPressedMouseOverTexture

(string textureFilename)

SetPressedOffset

(layout_measurement x, layout_measurement y)

SetPressedTexture

(string textureFilename)

SetShowingHighlight

(bool showingHighlight)

SetState

(ButtonState newState, bool locked)

SetText

(string text)

SetTextureCoords

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

SetTextureReleaseOption

(ReleaseReferenceOptions releaseOption)

SetVerticalAlignment

(TextAlignment verticalAlign)

CanvasControl

Arc

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

ArcTo

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

BeginPath

()

Circle

(number x, number y, number radius)

Clear

()

ClosePath

()

ComputeCurrentPathLength

()

  • # Returns: number length

Fill

()

FillRect

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

GetObjectFit

()

LineTo

(number x, number y)

MoveTo

(number x, number y)

QuadraticCurveTo

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

Rect

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

RoundRect

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

SetCanvasSize

(number width, number height)

SetFillColor

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

SetObjectFit

(ObjectFit objectFit)

SetStrokeCapStyle

(StrokeCapStyle capStyle)

SetStrokeColor

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

SetStrokeJoinType

(StrokeJoinType joinType, number miterLimit)

SetStrokeLineDash

(number lineDashArray)

SetStrokeLineDashOffset

(number lineDashOffset)

SetStrokeWidth

(number width)

Stroke

()

StrokeRect

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

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

GetAlphaDropoffBehavior

(MapDisplayPinType pinType)

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

GetCenterOveredPinDescription

(luaindex centerOveredPinIndex)

  • # Returns: string description

GetCenterOveredPinDistance

(luaindex centerOveredPinIndex)

  • # Returns: number distanceFromPlayerCM

GetCenterOveredPinInfo

(luaindex centerOveredPinIndex)

GetCenterOveredPinLayerAndLevel

(luaindex centerOveredPinIndex)

GetCenterOveredPinType

(luaindex centerOveredPinIndex)

GetNumCenterOveredPins

()

  • # Returns: integer numCenterOveredPins

GetScaleDropoffBehavior

(MapDisplayPinType pinType)

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

IsCenterOveredPinSuppressed

(luaindex centerOveredPinIndex)

  • # Returns: bool suppressed

SetAlphaDropoffBehavior

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

SetCardinalDirection

(string directionName, string font, integer cardinalDirection)

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

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

Control

AddFilterForEvent

(integer event, variant filterParameter)

  • # Returns: bool success

AddTransformRotation

(number deltaXRadians, number deltaYRadians, number deltaZRadians)

AddTransformRotationX

(number deltaXRadians)

AddTransformRotationY

(number deltaYRadians)

AddTransformRotationZ

(number deltaZRadians)

AppendChild

protected-attributes (object childControl)

ClearAnchors

protected-attributes ()

ClearCircularClip

()

ClearClips

()

ClearDimensions

protected-attributes ()

ClearFadeGradients

()

ClearMask

()

ClearRectangularClip

()

ClearShaderEffectOptions

()

ClearSuggestedDimensions

protected-attributes ()

ClearTransform

()

ClearTransformOffset

()

ClearTransformRotation

()

ClearTransformScale

()

ClearTransformSkew

()

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 childControlName, ControlType childControlType)

  • # Returns: object childControl

Destroy3DRenderSpace

()

Does3DRenderSpaceUseDepthBuffer

()

  • # Returns: bool usesDepthBuffer

DoesControlDescendFrom

(object root)

  • # Returns: bool doesControlDescendFromRoot

Get3DRenderSpaceAxisRotationOrder

()

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

()

Get3DRenderSpaceUp

()

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

GetAlpha

()

  • # Returns: number alpha

GetAncestor

(luaindex ancestorIndex)

  • # Returns: object ancestorControl

GetAnchor

(integer anchorIndex)

GetAutoRectClipChildren

()

  • # Returns: bool autoRectClipChildren

GetBottom

()

  • # Returns: number bottom

GetCaustic

()

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

GetCausticOffset

()

  • # Returns: number offset

GetCenter

()

  • # Returns: number centerX, number centerY

GetChild

(luaindex childIndex)

  • # Returns: object childControl

GetChildFlexContentAlignment

()

GetChildFlexDirection

()

GetChildFlexItemAlignment

()

GetChildFlexJustification

()

GetChildFlexWrap

()

GetChildLayout

()

GetClampedToScreen

()

  • # Returns: bool clamped

GetClampedToScreenInsets

()

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

GetControlAlpha

()

  • # Returns: number alpha

GetControlScale

()

  • # Returns: number scale

GetControlSpace

()

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

()

GetDrawLevel

()

  • # Returns: integer level

GetDrawTier

()

GetExcludeFromFlexbox

()

  • # Returns: bool exclude

GetExcludeFromResizeToFitExtents

()

  • # Returns: bool excludes

GetFadeGradient

(luaindex gradientIndex)

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

GetFlex

()

  • # Returns: number:nilable growOrShrink

GetFlexAlignSelf

()

GetFlexBasis

()

  • # Returns: number basis

GetFlexGrow

()

  • # Returns: number grow

GetFlexMargin

(FlexEdge edge)

  • # Returns: number margin

GetFlexPadding

(FlexEdge edge)

  • # Returns: number padding

GetFlexShrink

()

  • # Returns: number shrink

GetGaussianBlur

()

  • # Returns: integer kernelSize, number factor

GetHandler

(string handlerName, string name)

  • # Returns: function functionRef

GetHeight

()

  • # Returns: number height

GetHitInsets

()

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

GetId

()

  • # Returns: integer id

GetInheritsAlpha

()

  • # Returns: bool inheritAlpha

GetInheritsScale

()

  • # Returns: bool inheritScale

GetLeft

()

  • # Returns: number left

GetMaskThresholdThickness

()

  • # Returns: number normalizedThickness

GetMaskThresholdZeroAlphaEdge

()

  • # Returns: number normalizedEdge

GetMotionBlur

()

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

GetName

()

  • # Returns: string name

GetNamedChild

(string childName)

  • # Returns: object returnedControl

GetNamedSibling

(string siblingName)

  • # Returns: object returnedControl

GetNormal

()

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

GetNormalizedCameraFacing

()

  • # Returns: number normalizedCameraFacingValue

GetNumAnchors

()

  • # Returns: integer numAnchors

GetNumChildren

()

  • # Returns: integer numChildren

GetOwningWindow

()

  • # Returns: object OwningTopLevelWindow

GetParent

()

  • # Returns: object parentControl

GetRadialBlur

()

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

GetResizeToFitConstrains

()

GetResizeToFitDescendents

()

  • # Returns: bool 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

GetSpace

()

GetSuggestedDimensions

()

  • # Returns: number width, number height

GetSuggestedHeight

()

  • # Returns: number height

GetSuggestedWidth

()

  • # Returns: number width

GetTop

()

  • # Returns: number top

GetTransformNormalizedOriginPoint

()

  • # Returns: number normalizedX, number normalizedY

GetTransformOffset

()

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

GetTransformRotation

()

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

GetTransformRotationAxisOrder

()

GetTransformScale

()

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

GetTransformSkew

()

  • # Returns: number skewXRadians, number skewYRadians

GetType

()

GetWave

()

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

GetWaveAngle

()

  • # Returns: number angleRadians

GetWaveBounds

()

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

GetWaveDampingCoefficients

()

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

GetWaveFrequency

()

  • # Returns: number frequency

GetWaveOffset

()

  • # Returns: number offset

GetWaveSpeed

()

  • # Returns: number speed

GetWidth

()

  • # Returns: number width

Has3DRenderSpace

()

  • # Returns: bool has3DRenderSpace

InsertChildBefore

protected-attributes (object childControl, object nextChild)

IsChildOf

(object desiredParent)

  • # Returns: bool isChild

IsControlHidden

()

  • # Returns: bool hidden

IsHandlerSet

(string handlerName, string name)

  • # Returns: bool isSet

IsHidden

()

  • # Returns: bool hidden

IsKeyboardEnabled

()

  • # Returns: bool enabled

IsMouseEnabled

()

  • # Returns: bool enabled

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

()

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

ProjectRectToScreenAndBuildAABB

()

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

ProjectRectToScreenAndComputeAABBPoint

(AnchorPosition point)

  • # Returns: number screenX, number screenY

ProjectRectToScreenAndComputeClampedAABBPoint

(AnchorPosition point)

  • # Returns: number screenX, number screenY

ProjectToScreen

(number normalizedX, number normalizedY)

  • # Returns: number screenX, number screenY

RegisterForEvent

(integer event, function callback, bool doOnce)

  • # Returns: bool success

ResetTransformNormalizedOriginPoint

()

Set3DRenderSpaceAxisRotationOrder

(AxisRotationOrder axisRotationOrder)

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

(GuiRender3DSpaceSystem system)

Set3DRenderSpaceUp

(number x, number y, number z)

Set3DRenderSpaceUsesDepthBuffer

(bool usesDepthBuffer)

SetAlpha

protected-attributes (number alpha)

SetAnchor

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

SetAnchorFill

protected-attributes (object anchorTargetControl)

SetAnchorOffsets

(layout_measurement offsetX, layout_measurement offsetY, luaindex anchorIndex)

SetAutoRectClipChildren

(bool autoRectClipChildren)

SetCaustic

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

SetCausticOffset

(number offset)

SetChildFlexContentAlignment

(FlexAlignment alignment)

SetChildFlexDirection

(FlexDirection direction)

SetChildFlexItemAlignment

(FlexAlignment alignment)

SetChildFlexJustification

(FlexJustification justification)

SetChildFlexWrap

(FlexWrap wrap)

SetChildLayout

(ChildLayoutType childLayoutType)

SetCircularClip

(number centerX, number centerY, number radius)

SetClampedToScreen

(bool clamped)

SetClampedToScreenInsets

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

SetControlAlpha

protected-attributes (number alpha)

SetControlScale

protected-attributes (number scale)

SetDimensionConstraints

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

SetDimensions

protected-attributes (layout_measurement width, layout_measurement height)

SetDrawLayer

protected-attributes (DrawLayer layer)

SetDrawLevel

protected-attributes (integer level)

SetDrawTier

protected-attributes (DrawTier tier)

SetExcludeFromFlexbox

(bool exclude)

SetExcludeFromResizeToFitExtents

protected-attributes (bool exclude)

SetFadeGradient

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

SetFlex

(number:nilable growOrShrink)

SetFlexAlignSelf

(FlexAlignment alignment)

SetFlexBasis

(number basis)

SetFlexGrow

(number grow)

SetFlexMargin

(FlexEdge edge, number margin)

SetFlexMargins

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

SetFlexPaddings

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

SetFlexShrink

(number shrink)

SetGaussianBlur

(integer kernelSize, number factor)

SetHandler

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

SetHeight

protected-attributes (layout_measurement height)

SetHidden

protected-attributes (bool hidden)

SetHitInsets

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

SetId

(integer id)

SetInheritAlpha

(bool inheritAlpha)

SetInheritScale

(bool inheritScale)

SetKeyboardEnabled

protected-attributes (bool enabled)

SetMaskMode

(ControlMaskMode maskMode)

SetMaskTexture

(string fileName)

SetMaskTextureReleaseOption

(ReleaseReferenceOptions releaseOption)

SetMaskThresholdThickness

(number normalizedThickness)

SetMaskThresholdZeroAlphaEdge

(number normalizedEdge)

SetMotionBlur

(number blurVectorXAsAPercentageOfControlWidth, number blurVectorYAsAPercentageOfControlHeight, integer numSamples)

SetMouseEnabled

protected-attributes (bool enabled)

SetMovable

(bool isMovable)

SetParent

protected-attributes (object newParent)

SetRadialBlur

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

SetRectangularClip

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

SetResizeHandleSize

(number handleSize)

SetResizeToFitConstrains

(AnchorConstrains constrains)

SetResizeToFitDescendents

protected-attributes (bool resize)

SetResizeToFitPadding

(layout_measurement width, layout_measurement height)

SetScale

protected-attributes (number scale)

SetShapeType

(integer shapeType)

SetSimpleAnchor

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

SetSimpleAnchorParent

protected-attributes (number offsetX, number offsetY)

SetSpace

(Space:nilable space)

SetTransformNormalizedOriginPoint

(number normalizedX, number normalizedY)

SetTransformOffset

(layout_measurement x, layout_measurement y, layout_measurement z)

SetTransformOffsetX

(layout_measurement x)

SetTransformOffsetY

(layout_measurement y)

SetTransformOffsetZ

(layout_measurement z)

SetTransformRotation

(number xRadians, number yRadians, number zRadians)

SetTransformRotationAndOrder

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

SetTransformRotationAxisOrder

(AxisRotationOrder order)

SetTransformRotationX

(number xRadians)

SetTransformRotationY

(number yRadians)

SetTransformRotationZ

(number zRadians)

SetTransformScale

(number scale)

SetTransformScaleX

(number scaleX)

SetTransformScaleY

(number scaleY)

SetTransformScaleZ

(number scaleZ)

SetTransformSkew

(number skewXRadians, number skewYRadians)

SetTransformSkewX

(number skewXRadians)

SetTransformSkewY

(number skewYRadians)

SetWave

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

SetWaveAngle

(number angleRadians)

SetWaveBounds

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

SetWaveDampingCoefficients

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

SetWaveFrequency

(number frequency)

SetWaveOffset

(number offset)

SetWaveSpeed

(number speed)

SetWidth

protected-attributes (layout_measurement width)

StartMoving

protected-attributes ()

  • # Returns: bool isMoving

StopMovingOrResizing

protected-attributes ()

SuggestDimensions

protected-attributes (number width, number height)

SuggestHeight

protected-attributes (number height)

SuggestWidth

protected-attributes (number width)

ToggleHidden

protected-attributes ()

UnregisterForEvent

(integer event)

  • # Returns: bool success

CooldownControl

GetDuration

()

  • # Returns: integer duration

GetPercentCompleteFixed

()

  • # Returns: number percentComplete

GetTimeLeft

()

  • # Returns: integer time

ResetCooldown

()

SetBlendMode

(integer blendMode)

SetCooldownRemainTime

(integer remain)

SetDesaturation

(number desaturation)

SetFillColor

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

SetLeadingEdgeTexture

(string filename)

SetPercentCompleteFixed

(number percentComplete)

SetRadialCooldownClockwise

(bool clockwise)

SetRadialCooldownGradient

(number startAlpha, number angularDistance)

SetRadialCooldownOriginAngle

(number originAngle)

SetTexture

(string filename)

SetTextureReleaseOption

(ReleaseReferenceOptions releaseOption)

SetVerticalCooldownLeadingEdgeHeight

(integer leadingEdgeHeight)

StartCooldown

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

StartFixedCooldown

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

EditControl

AddValidCharacter

(string validCharacter)

Clear

()

ClearSelection

()

CopyAllTextToClipboard

private ()

GetAllowMarkupType

()

GetCopyEnabled

()

  • # Returns: bool enabled

GetCursorPosition

()

  • # Returns: integer cursorPosition

GetDefaultText

()

  • # Returns: string defaultText

GetEditEnabled

()

  • # Returns: bool enabled

GetFont

()

  • # Returns: string text

GetFontFaceName

()

  • # Returns: string text

GetFontHeight

()

  • # Returns: number fontHeightUIUnits

GetFontSize

()

  • # Returns: number fontSize

GetFontStyle

()

  • # Returns: string text

GetIMECompositionExclusionArea

()

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

GetMaxInputChars

()

  • # Returns: integer maxChars

GetNewLineEnabled

()

  • # Returns: bool enabled

GetPasteEnabled

()

  • # Returns: bool enabled

GetScrollExtents

()

  • # Returns: integer numLines

GetSelectAllOnFocus

()

  • # Returns: bool enabled

GetText

()

  • # Returns: string text

GetTextType

()

GetTopLineIndex

()

  • # Returns: luaindex index

HasFocus

()

  • # Returns: bool focused

HasSelection

()

  • # Returns: bool hasSelection

InsertText

(string text)

IsComposingIMEText

()

  • # Returns: bool isComposing

IsMultiLine

()

  • # Returns: bool isMultiLine

IsPassword

()

  • # Returns: bool isPassword

LoseFocus

()

RemoveAllValidCharacters

()

SelectAll

()

SetAllowMarkupType

(AllowMarkupType allowMarkupType)

SetAsPassword

(bool isPassword)

SetColor

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

SetCopyEnabled

(bool enabled)

SetCursorPosition

(integer cursorPosition)

SetDefaultText

(string defaultText)

SetDefaultTextColor

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

SetEditEnabled

(bool enabled)

SetFont

(string font)

SetMaxInputChars

(integer maxChars)

SetMultiLine

(bool isMultiLine)

SetNewLineEnabled

(bool enabled)

SetPasteEnabled

(bool enabled)

SetSelectAllOnFocus

(bool enabled)

SetSelection

(integer selectionStartIndex, integer selectionEndIndex)

SetSelectionColor

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

SetText

(string text, bool suppressCallbackHandler)

SetTextType

(TextType textType)

SetTopLineIndex

(luaindex index)

SetVirtualKeyboardType

(VirtualKeyboardType keyboardType)

TakeFocus

()

WasLastChangeVirtualKeyboard

()

  • # Returns: bool fromVirtual

LabelControl

AnchorToBaseline

(object toLabel, layout_measurement offsetX, AnchorPosition anchorSide)

Clean

()

ClearAnchorToBaseline

(object toLabel)

DidLineWrap

()

  • # Returns: bool didLineWrap

GetColor

()

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

GetControlColor

()

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

GetFont

()

  • # Returns: string text

GetFontFaceName

()

  • # Returns: string text

GetFontHeight

()

  • # Returns: number fontHeightUIUnits

GetFontSize

()

  • # Returns: number fontSize

GetFontStyle

()

  • # Returns: string text

GetHorizontalAlignment

()

GetLinkEnabled

()

  • # Returns: bool linkEnabed

GetModifyTextType

()

GetNumLines

()

  • # Returns: integer numLines

GetShaderEffectType

()

GetStringWidth

(string text)

  • # Returns: number scaledWidthTextLayoutNative

GetStyleColor

()

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

GetText

()

  • # Returns: string text

GetTextDimensions

()

  • # Returns: number stringWidthUIUnits, number stringHeightUIUnits

GetTextForLines

(luaindex startLine, luaindex endLine)

  • # Returns: string text

GetTextHeight

()

  • # Returns: number stringHeightUIUnits

GetTextWidth

()

  • # Returns: number stringWidthUIUnits

GetVerticalAlignment

()

SetColor

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

SetControlColor

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

SetDesaturation

(number desaturation)

SetFont

(string fontString)

SetHorizontalAlignment

(TextAlignment align)

SetLineSpacing

(layout_measurement lineSpacing)

SetLinkEnabled

(bool linkEnabed)

SetMaxLineCount

(integer maxLineCount)

SetMinLineCount

(integer minLineCount)

SetModifyTextType

(ModifyTextType modifyTextType)

SetNewLineX

(layout_measurement newLineX)

SetPixelRoundingEnabled

(bool pixelRoundingEnabled)

SetShaderEffectType

(ShaderEffectType shaderEffectType)

SetSmallCaps

(bool smallCaps)

SetStoreLineEndingCharacterIndices

(bool storeLineEndingCharacterIndices)

SetStrikethrough

(bool strikethrough)

SetStyleColor

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

SetText

(string text)

SetTracking

(number textTrackingEm)

SetUnderline

(bool underline)

SetVerticalAlignment

(TextAlignment align)

SetWrapMode

(integer wrapMode)

WasTruncated

()

  • # Returns: bool wasTruncated

LineControl

ClearGradientColors

()

GetBlendMode

()

GetColor

()

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

GetDesaturation

()

  • # Returns: number desaturation

GetTextureCoords

()

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

GetTextureCoordsInPixels

()

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

GetTextureFileDimensions

()

  • # Returns: integer pixelWidth, integer pixelHeight

GetTextureFileName

()

  • # Returns: string filename

GetThickness

()

  • # Returns: number thickness

IsPixelRoundingEnabled

()

  • # Returns: bool pixelRoundingEnabled

IsTextureLoaded

()

  • # Returns: bool loaded

SetBlendMode

(TextureBlendMode blendMode)

SetColor

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

SetDesaturation

(number desaturation)

SetGradientColors

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

SetPixelRoundingEnabled

(bool pixelRoundingEnabled)

SetTexture

(string filename)

SetTextureCoords

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

SetThickness

(layout_measurement thickness)

SetVertexColors

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

MapDisplayControl

GetZoom

()

  • # Returns: number normalizedRadius

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

(number offset, number size)

SetPinFont

(string pinFont)

SetZoom

(number normalizedRadius)

PolygonControl

AddPoint

(number normalizedX, number normalizedY)

ClearPoints

()

GetBorderBlendMode

()

GetBorderDesaturation

()

  • # Returns: number desaturation

GetBorderDirection

()

GetBorderTexture

()

  • # Returns: string textureFile

GetBorderThickness

()

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

GetCenterBlendMode

()

GetCenterColor

()

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

GetCenterDesaturation

()

  • # Returns: number desaturation

GetCenterTexture

()

  • # Returns: string textureFile

GetCenterTextureAddressMode

()

GetCenterTextureCoords

()

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

GetNumPoints

()

  • # Returns: integer numPoints

GetPoint

(luaindex index)

  • # Returns: number normalizedX, number normalizedY

GetPointLayout

()

IsSmoothingEnabled

()

  • # Returns: bool isSmoothingEnabled

SetBorder

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

SetBorderBlendMode

(TextureBlendMode blendMode)

SetBorderColor

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

SetBorderDesaturation

(number desaturation)

SetBorderDirection

(PolygonBorderDirection direction)

SetBorderTexture

(string textureFile)

SetBorderThickness

(layout_measurement min, layout_measurement max, number percent)

SetCenterBlendMode

(TextureBlendMode blendMode)

SetCenterColor

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

SetCenterDesaturation

(number desaturation)

SetCenterTexture

(string textureFile)

SetCenterTextureAddressMode

(TextureAddressMode addressMode)

SetCenterTextureCoords

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

SetPoint

(luaindex index, number normalizedX, number normalizedY)

SetPointLayout

(PolygonPointLayout pointLayout)

SetSmoothingEnabled

(bool isSmoothingEnabled)

ScrollControl

GetHorizontalScroll

()

  • # Returns: number offset

GetHorizontalScrollExtent

()

  • # Returns: number horizontal

GetScrollBounding

()

GetScrollExtents

()

  • # Returns: number horizontal, number vertical

GetScrollOffsets

()

  • # Returns: number horizontal, number vertical

GetVerticalScroll

()

  • # Returns: number offset

GetVerticalScrollExtent

()

  • # Returns: number vertical

RestoreToExtents

(integer duration)

SetHorizontalScroll

(layout_measurement offset)

SetScrollBounding

(ScrollBounding bounding)

SetVerticalScroll

(layout_measurement offset)

SliderControl

DoesAllowDraggingFromThumb

()

  • # Returns: bool allow

GetEnabled

()

  • # Returns: bool isEnabled

GetMinMax

()

  • # Returns: number min, number max

GetOrientation

()

GetThumbTextureControl

()

  • # Returns: object textureControl

GetValue

()

  • # Returns: number value

GetValueStep

()

  • # Returns: number step

IsThumbFlushWithExtents

()

  • # Returns: bool flush

SetAllowDraggingFromThumb

(bool allow)

SetBackgroundBottomTexture

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

SetBackgroundMiddleTexture

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

SetBackgroundTopTexture

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

SetColor

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

SetEnabled

(bool enable)

SetMinMax

(number min, number max)

SetOrientation

(ControlOrientation orientation)

SetThumbFlushWithExtents

(bool flush)

SetThumbTexture

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

SetThumbTextureAndFlush

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

SetThumbTextureHeight

(layout_measurement height)

SetValue

(number value)

SetValueStep

(number step)

StatusBarControl

CalculateSizeWithoutLeadingEdgeForValue

(number value)

  • # Returns: number mainBarSize

ClearFadeOutLossAdjustedTopValue

()

EnableFadeOut

(bool enabled)

EnableLeadingEdge

(bool enabled)

EnableScrollingOverlay

(bool enabled)

GetMinMax

()

  • # Returns: number min, number max

GetValue

()

  • # Returns: number value

IsPixelRoundingEnabled

()

  • # Returns: bool pixelRoundingEnabled

SetBarAlignment

(BarAlignment 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

(ControlOrientation orientation)

SetPixelRoundingEnabled

(bool pixelRoundingEnabled)

SetTexture

(string filename)

SetTextureCoords

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

SetValue

(number aValue)

SetupScrollingOverlay

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

TextBufferControl

AddMessage

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

Clear

()

GetDrawLastEntryIfOutOfRoom

()

  • # Returns: bool drawLastIfOutOfRoom

GetHorizontalAlignment

()

GetLineFade

()

  • # Returns: number timeBeforeLineBeginsToFade, number timeItTakesLineToFade

GetLinkEnabled

()

  • # Returns: bool linkEnabed

GetMaxHistoryLines

()

  • # Returns: integer numLines

GetNumHistoryLines

()

  • # Returns: integer numLines

GetNumVisibleLines

()

  • # Returns: integer numLines

GetScrollPosition

()

  • # Returns: integer scrollPosition

IsSplittingLongMessages

()

  • # Returns: bool isSplitting

MoveScrollPosition

(integer numLines)

SetClearBufferAfterFadeout

(bool clearAfterFade)

SetColorById

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

SetDrawLastEntryIfOutOfRoom

(bool drawLastIfOutOfRoom)

SetFont

(string fontString)

SetHorizontalAlignment

(TextAlignment horizontalAlign)

SetLineFade

(number timeBeforeLineFadeBegins, number timeForLineToFade)

SetLinesInheritAlpha

(bool linesInheritAlpha)

SetLinkEnabled

(bool linkEnabed)

SetMaxHistoryLines

(integer numLines)

SetScrollPosition

(integer line)

SetSplitLongMessages

(bool splitLongMessages)

ShowFadedLines

()

TextureCompositeControl

AddSurface

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

  • # Returns: luaindex surfaceIndex

ClearAllSurfaces

()

GetBlendMode

()

GetColor

(luaindex surfaceIndex)

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

GetDesaturation

()

  • # Returns: number desaturation

GetInsets

(luaindex surfaceIndex)

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

GetNumSurfaces

()

  • # Returns: integer surfaces

GetSurfaceAlpha

(luaindex surfaceIndex)

  • # Returns: number a

GetTextureCoords

(luaindex surfaceIndex)

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

GetTextureFileDimensions

()

  • # Returns: integer pixelWidth, integer pixelHeight

GetTextureFileName

()

  • # Returns: string filename

IsPixelRoundingEnabled

()

  • # Returns: bool pixelRoundingEnabled

IsSurfaceHidden

(luaindex surfaceIndex)

  • # Returns: bool hidden

IsTextureLoaded

()

  • # Returns: bool loaded

RemoveSurface

(luaindex surfaceIndex)

SetBlendMode

(TextureBlendMode blendMode)

SetColor

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

SetDesaturation

(number desaturation)

SetInsets

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

SetPixelRoundingEnabled

(bool pixelRoundingEnabled)

SetSurfaceAlpha

(luaindex surfaceIndex, number a)

SetSurfaceHidden

(luaindex surfaceIndex, bool hidden)

SetSurfaceScale

(luaindex surfaceIndex, number scale)

SetSurfaceTextureRotation

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

SetTexture

(string filename)

SetTextureCoords

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

SetTextureReleaseOption

(ReleaseReferenceOptions releaseOption)

TextureControl

ClearGradientColors

()

Get3DLocalDimensions

()

  • # Returns: number width, number height

GetAddressMode

()

GetBlendMode

()

GetColor

()

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

GetControlColor

()

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

GetDesaturation

()

  • # Returns: number desaturation

GetResizeToFitFile

()

  • # Returns: bool resizesToFitFile

GetShaderEffectType

()

GetTextureCoords

()

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

GetTextureCoordsInPixels

()

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

GetTextureFileDimensions

()

  • # Returns: integer pixelWidth, integer pixelHeight

GetTextureFileName

()

  • # Returns: string filename

GetVertexUV

(VERTEX_POINTS vertex)

  • # Returns: number u, number v

Is3DQuadFacingCamera

()

  • # Returns: bool isFacing

IsPixelRoundingEnabled

()

  • # Returns: bool pixelRoundingEnabled

IsTextureLoaded

()

  • # Returns: bool loaded

Set3DLocalDimensions

(number width, number height)

SetAddressMode

(TextureAddressMode addressMode)

SetAutoAdjustWrappedCoords

(bool enabled)

SetBlendMode

(TextureBlendMode blendMode)

SetColor

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

SetControlColor

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

SetDesaturation

(number desaturation)

SetGradientColors

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

SetPixelRoundingEnabled

(bool pixelRoundingEnabled)

SetResizeToFitFile

(bool resizesToFitFile)

SetShaderEffectType

(ShaderEffectType shaderEffectType)

SetTexture

(string filename)

SetTextureCoords

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

SetTextureCoordsRotation

(number angleInRadians)

SetTextureFileName

(string filename)

SetTextureFromGuiTexture

(object guiTexture)

SetTextureReleaseOption

(ReleaseReferenceOptions releaseOption)

SetTextureRotation

(number angleInRadians, number normalizedRotationPointX, number normalizedRotationPointY)

SetTextureSampleProcessingWeight

(TextureSampleProcessing sampleProcessingType, number weight)

SetVertexColors

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

SetVertexUV

(VERTEX_POINTS vertex, number u, number v)

TooltipControl

AddControl

(object control, integer cell, bool useLastRow)

AddHeaderControl

(object control, integer headerRow, TooltipHeaderSide headerSide)

AddHeaderLine

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

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

(number paddingY)

AppendAvAObjective

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

AppendDigSiteAntiquities

(integer digSiteId)

AppendMapPing

(integer pingType, string unitTag)

AppendQuestCondition

(luaindex questIndex, luaindex stepIndex, luaindex conditionIndex)

AppendQuestEnding

(luaindex questIndex)

AppendQuestName

(luaindex questIndex)

AppendSkyshardHint

(integer skyshardId)

AppendTeamScore

(TeamType teamType, integer teamValue)

AppendUnitName

(string unitTag)

AppendZoneSpectacleTooltip

(integer spectacleId)

ClearLines

()

GetOwner

()

  • # Returns: object owner

HideComparativeTooltips

()

SetAbility

(luaindex abilityIndex, bool showBase)

SetAbilityId

(integer abilityId)

SetAchievement

(integer achievementId)

SetAchievementRewardItem

(integer achievementId)

SetAction

(luaindex slotId, HotBarCategory:nilable hotbarCategory)

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

(AdventureZoneBoss boss)

SetAntiquityLead

(integer antiquityId)

SetAntiquitySetFragment

(integer antiquityId)

SetAsComparativeTooltip1

()

SetAsComparativeTooltip2

()

SetAttachedMailItem

(id64 mailId, luaindex attachSlot)

SetBagItem

(Bag bagIndex, integer slotIndex, ItemTooltipDisplayFlags displayFlags)

SetBook

(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)

SetBuff

(integer buffSlotId, string unitTag)

SetBuybackItem

(luaindex entryIndex)

SetChampionSkill

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

SetCollectible

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

SetCompanionSkill

(integer abilityId)

SetCraftedAbility

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

SetCraftedAbilityScript

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

SetCrownCrateReward

(luaindex rewardIndex)

SetCurrency

(CurrencyType currencyType, integer quantity)

SetDailyLoginRewardEntry

(luaindex rewardIndex)

SetEdgeKeepBonusAbility

(luaindex bonusIndex)

SetEmperorBonusAbility

(integer rankIndex)

SetEndlessDungeonBuff

(integer buffAbilityId, bool includeLifetimeStacks)

SetFont

(string fontStr)

SetGenericItemSet

(integer itemSetId)

SetGuildSpecificItem

(luaindex guildSpecificItemIndex)

SetHeaderCellEmptyHorizontalSpace

(number headerCellEmptyHorizontalSpace)

SetHeaderRowSpacing

(number spacing)

SetHeaderVerticalOffset

(number verticalOffset)

(string link, bool hideTrait)

SetItemUsingEnchantment

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

SetKeepBonusAbility

(luaindex bonusIndex)

SetKeepUpgrade

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

SetLastCraftingResultItem

(luaindex resultIndex)

(string link)

SetLootItem

(integer lootId)

SetMarketProduct

(integer marketProductId, bool showCollectiblePurchasableHint)

SetMarketProductListing

(integer marketProductId, luaindex:nilable presentationIndex)

SetMinHeaderRowHeight

(number minRowHeight)

SetMinHeaderRows

(integer minRows)

SetOwner

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

SetPassiveSkill

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

SetPendingAlchemyItem

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

SetPendingEnchantingItem

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

SetPendingRetraitItem

(Bag bagIndex, integer slotIndex, ItemTraitType pendingTrait)

SetPendingSmithingItem

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

SetPlacedFurniture

(id64 placedFurnitureId)

SetProgressionAbility

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

SetProvisionerIngredientItem

(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex)

SetProvisionerResultItem

(luaindex recipeListIndex, luaindex recipeIndex)

SetQuestItem

(luaindex questIndex, luaindex stepIndex, luaindex conditionIndex)

SetQuestReward

(luaindex perkIndex)

SetQuestTool

(luaindex questIndex, luaindex toolIndex)

SetReward

(integer rewardId, integer quantity, RewardDisplayFlags displayFlags)

SetRewardList

(integer rewardListId)

SetScrollBonusAbility

(Alliance alliance, ObjectiveType artifactType, luaindex bonusIndex)

SetSkillAbility

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

SetSkillLine

(SkillType skillType, luaindex skillLineIndex)

SetSkillLineAbilityId

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

SetSkillLineById

(integer skillLineId)

SetSkillUpgradeAbility

(integer skillType, luaindex skillLineIndex, luaindex skillIndex)

SetSmithingImprovementItem

(integer craftingSkillType, luaindex improvementItemIndex)

SetSmithingImprovementResult

(Bag itemToImproveBagId, integer itemToImproveSlotIndex, integer craftingSkillType)

SetSmithingMaterialItem

(luaindex patternIndex, luaindex materialIndex)

SetSmithingStyleItem

(integer itemStyleId)

SetSmithingTraitItem

(luaindex traitItemIndex)

SetStoreItem

(luaindex entryIndex)

SetSubclassingSkillLineById

(integer skillLineId)

SetTradeItem

(integer who, luaindex tradeIndex)

SetTradingHouseItem

(luaindex tradingHouseIndex)

SetTradingHouseListing

(luaindex tradingHouseIndex)

SetTributeBoardLocationPatrons

(TributeBoardLocation boardLocation)

SetTributeCard

(integer patronId, integer cardId)

SetTributeLeaderboardRewardList

(integer rewardListId)

SetTributePatron

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

SetTributePatronDockCard

(integer patronId, luaindex cardIndex, bool showUpgrade)

SetTributePatronStarterCard

(integer patronId, luaindex cardIndex)

SetTributePatronWithFavorState

(integer patronId, TributePatronPerspectiveFavorState highlightFavorState)

SetTributeSeasonRewardList

(TributeTier tributeTier, integer rewardListId)

SetVengeancePerk

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

SetVengeancePerkId

(integer perkDefId)

SetVerticalPadding

(number paddingY)

SetWornItem

(EquipSlot equipSlot, Bag bagId)

ShowComparativeTooltips

()

WindowManager

ApplyTemplateToControl

(object control, string virtualName)

CompareControlVisualOrder

(object controlA, object controlB)

  • # Returns: integer order

CreateControl

(string name, object parent, ControlType type)

  • # Returns: object control

CreateControlFromVirtual

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

  • # Returns: object control

CreateCursor

(layout_measurement x, layout_measurement y)

  • # Returns: integer cursorId

CreateTopLevelWindow

(string name)

  • # Returns: object control

DestroyCursor

(integer cursorId)

GetControlAtCursor

(integer cursorId, HitTestingDesiredHandlers desiredHandlers)

  • # Returns: object controlAtCursor

GetControlByName

(string name, string suffix)

  • # Returns: object ret

GetCursorPosition

(integer cursorId)

  • # Returns: number x, number y

GetFocusControl

()

  • # Returns: object focusControl

GetHandler

(string handlerName, string name)

  • # Returns: function functionRef

GetIMECandidate

(luaindex index)

  • # Returns: string candidate

GetIMECandidatePageInfo

()

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

GetMouseFocusControl

()

  • # Returns: object mouseFocusControl

GetMouseOverControl

()

  • # Returns: object mouseOverControl

GetNumIMECandidates

()

  • # Returns: integer numCandidates

GetUIMousePosition

()

  • # Returns: number x, number y

HasFocusControl

()

  • # Returns: bool hasFocusControl

IsChoosingIMECandidate

()

  • # Returns: bool isChoosingCandidate

IsHandlingHardwareEvent

()

  • # Returns: bool isHandlingHardwareEvent

IsMouseOverWorld

()

  • # Returns: bool isMouseOverWorld

IsSecureRenderModeEnabled

()

  • # Returns: bool secureRenderModeEnabled

IsUsingCustomCandidateList

()

  • # Returns: bool isUsingCustomCandidateList

SetFocusByName

(string name)

SetHandler

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

SetMouseCursor

(MouseCursorType cursorType)

SetMouseFocusByName

(string name)

UpdateCursorPosition

(integer cursorId, layout_measurement x, layout_measurement y)

GetWindowManager

()

  • # Returns: object windowManager

MouseIsOver

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

  • # Returns: bool isOver

MouseIsInside

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

  • # Returns: bool isInside

GetUIMouseDeltas

()

  • # Returns: number deltaX, number deltaY

GetUIGlobalScale

()

  • # Returns: number scale

GetUICustomScale

()

  • # Returns: number scale

LocalizeString

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

  • # Returns: string localizedString

GetAnimationManager

()

  • # Returns: object animationManager

GetAddOnManager

()

  • # Returns: object addOnManager

RedirectTexture

(string originalTexture, string newTexture)

EscapeMarkup

(string text, AllowMarkupType allowMarkupType)

  • # Returns: string escapedText

CreateFont

(string fontSymbolName, string fontDescriptor)

  • # Returns: object fontObject

GetNumControlCreatingSources

()

  • # Returns: integer numFiles

GetControlCreatingSourceName

(luaindex index)

  • # Returns: string sourceName

GetNumControlCreatingSourceCallSites

(string sourceName)

  • # Returns: integer numCallSites

GetControlCreatingSourceCallSiteInfo

(string sourceName, luaindex index)

  • # Returns: string creationStack, integer count

StartScriptProfiler

()

StopScriptProfiler

()

IsScriptProfilerEnabled

()

  • # Returns: bool enabled

GetScriptProfilerNumFrames

()

  • # Returns: integer numFrames

GetScriptProfilerFrameNumRecords

(luaindex frameIndex)

  • # Returns: integer numRecords

GetScriptProfilerRecordInfo

(luaindex frameIndex, luaindex recordIndex)

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

GetScriptProfilerNumClosures

()

  • # Returns: integer numClosures

GetScriptProfilerClosureInfo

(luaindex recordDataIndex)

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

GetScriptProfilerNumCFunctions

()

  • # Returns: integer numCFunctions

GetScriptProfilerCFunctionInfo

(luaindex recordDataIndex)

  • # Returns: string functionName

GetScriptProfilerNumGarbageCollectionTypes

()

  • # Returns: integer numGarbageCollectionTypes

GetScriptProfilerGarbageCollectionInfo

(luaindex recordDataIndex)

RecordScriptProfilerUserEvent

(string userEventData)

GetScriptProfilerNumUserEvents

()

  • # Returns: integer numUserEvents

GetScriptProfilerUserEventInfo

(luaindex recordDataIndex)

  • # Returns: string userEventData

GetCameraForward

(Space space)

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

GetMinUICanvasWidth

()

  • # Returns: number minWidth

GetMinUICanvasHeight

()

  • # Returns: number minHeight

GetInterfaceVerticalFieldOfView

()

  • # Returns: number FoVYRadians

SetInterfaceVerticalFieldOfView

(number FoVYRadians)

CopyToClipboard

private (string text)

GetFontStyleString

(FontStyle fontStyle)

  • # Returns: string fontStyleString

ConvertRGBToHSV

(number red, number green, number blue)

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

ConvertRGBToHSL

(number red, number green, number blue)

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

ScriptEventManager

AddFilterForEvent

(string name, integer event, variant filterParameter)

  • # Returns: bool success

RegisterForAllEvents

(string name, function callback)

  • # Returns: bool ret

RegisterForEvent

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

  • # Returns: bool ret

RegisterForPostEffectsUpdate

(string name, integer minInterval, function callback)

  • # Returns: bool ret

RegisterForUpdate

(string name, integer minInterval, function callback)

  • # Returns: bool ret

UnregisterForAllEvents

(string name)

  • # Returns: bool ret

UnregisterForEvent

(string name, integer event)

  • # Returns: bool ret

UnregisterForPostEffectsUpdate

(string name)

  • # Returns: bool ret

UnregisterForUpdate

(string name)

  • # Returns: bool ret