Controls

From ESOUI Wiki

(Difference between revisions)
Jump to: navigation, search
(→Control)
(24 intermediate revisions not shown)
Line 1: Line 1:
-
=== Control ===
+
''Page up-to-date to API Version [[APIVersion#100028|100028]]''
-
(E.g. <code>WINDOW_MANAGER</code> controls)
+
----
-
* ClearAnchors '''protected-attributes''' ()
 
-
* CreateControl('''string''' ''arg1'', '''integer''' ''type'')
 
-
** ''Returns:'' '''object''' ''apRet''
 
-
* GetAlpha()
 
-
** ''Returns:'' '''number''' ''alpha''
 
-
* GetAnchor('''integer''' ''anchorIndex'')
 
-
** ''Returns:'' '''bool''' ''isValidAnchor'', '''integer''' ''point'', '''object''' ''relativeTo'', '''integer''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY''
 
-
* GetBottom()
+
==Introduction==
-
** ''Returns:'' '''number''' ''bottom''
+
-
* GetCenter()
+
This is the list of the different functions ''(methods)'' of the '''UI Objects''' of Elder Scrolls Online.
-
** ''Returns:'' '''number''' ''centerX'', '''number''' ''centerY''
+
'''Objects''' can be defined throught '''XML''' or in '''Lua'''
-
* GetChild('''luaindex''' ''childIndex'')
+
==A working XML example==
-
** ''Returns:'' '''object''' ''childControl''
+
Check the link for an [[example.xml]]
-
* GetClampedToScreen()
+
==Object creation==
-
** ''Returns:'' '''bool''' ''clamped''
+
-
* GetClampedToScreenInsets()
+
====XML====
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
+
-
* GetDesiredHeight()
+
<source lang="xml">
-
** ''Returns:'' '''number''' ''height''
+
<!-- Basic -->
 +
<Label name="objectName" />
-
* GetDesiredWidth()
 
-
** ''Returns:'' '''number''' ''width''
 
-
* GetDimensionConstraints()
+
<!-- With few elements -->
-
** ''Returns:'' '''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight''
+
<Label name="Name" font="ZoFontGame" verticalAlignment="CENTER">
 +
<Dimensions x="350" y="48" />
 +
<Anchor point="TOPLEFT" relativeTo="$(parent)" />
 +
</Label>
 +
</source>
-
* GetDimensions()
+
====LUA====
-
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
+
<source lang="lua">
 +
-- Will create a new control without any parent.
 +
CreateControl("ControlName", CT_LABEL ) -- See http://wiki.esoui.com/Globals#ControlType
 +
</source>
-
* GetDrawLayer()
 
-
** ''Returns:'' '''integer''' ''layer''
 
-
* GetDrawLevel()
 
-
** ''Returns:'' '''integer''' ''level''
 
-
* GetDrawTier()
+
Then, you can call any of the methods listed under :
-
** ''Returns:'' '''integer''' ''tier''
+
-
* GetExcludeFromResizeToFitExtents()
+
For our '''LabelControl''' :
-
** ''Returns:'' '''bool''' ''excludes''
+
-
* GetHandler('''string''' ''handlerName'')
+
<source lang="lua">
-
** ''Returns:'' '''function''' ''functionRef''
+
objectName:SetText("Something") -- Object defined in the XML snippet.
 +
Name:SetColor(1, 1, 1) -- Object defined in the XML snippet.
 +
local text = ControlName:GetText() -- Object defined in the Lua snippet.
 +
</source>
-
* GetHeight()
+
==Objects Types and their methods==
-
** ''Returns:'' '''number''' ''height''
+
-
* GetHitInsets()
 
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 
-
* GetId()
+
=== All UI elements are inheriting the functions defined in [[#Control|Control]]. ===
-
** ''Returns:'' '''integer''' ''id''
+
-
* GetInheritsAlpha()
 
-
** ''Returns:'' '''bool''' ''inheritAlpha''
 
-
* GetInheritsScale()
+
===AddOnManager===
-
** ''Returns:'' '''bool''' ''inheritScale''
+
* {{GitHubSearch|Search=AddRelevantFilter}} [[AddRelevantFilter]]('''string''' ''relevantFilter'')
-
* GetLeft()
+
* {{GitHubSearch|Search=GetAddOnDependencyInfo}} [[GetAddOnDependencyInfo]]('''number''' ''addOnIndex'', '''number''' ''addOnDependencyIndex'')
-
** ''Returns:'' '''number''' ''left''
+
** '''Returns:''' '''string''' ''name'', '''boolean''' ''exists'', '''boolean''' ''active'', '''number''' ''minVersion'', '''number''' ''version''
-
* GetName()
+
* {{GitHubSearch|Search=GetAddOnFilter}} [[GetAddOnFilter]]()
-
** ''Returns:'' '''string''' ''name''
+
** '''Returns:''' '''string''' ''settingFilter''
-
* GetNamedChild('''string''' ''childName'')
+
* {{GitHubSearch|Search=GetAddOnInfo}} [[GetAddOnInfo]]('''number''' ''addOnIndex'')
-
** ''Returns:'' '''object''' ''returnedControl''
+
** '''Returns:''' '''string''' ''name'', '''string''' ''title'', '''string''' ''author'', '''string''' ''description'', '''boolean''' ''enabled'', '''number''' [[Globals#AddOnLoadState|AddOnLoadState]] ''state'', '''boolean''' ''isOutOfDate'', '''boolean''' ''isLibrary''
-
* GetNumChildren()
+
* {{GitHubSearch|Search=GetAddOnNumDependencies}} [[GetAddOnNumDependencies]]('''number''' ''addOnIndex'')
-
** ''Returns:'' '''integer''' ''numChildren''
+
** '''Returns:''' '''number''' ''numDependencies''
-
* GetOwningWindow()
+
* {{GitHubSearch|Search=GetAddOnRootDirectoryPath}} [[GetAddOnRootDirectoryPath]]('''number''' ''addOnIndex'')
-
** ''Returns:'' '''object''' ''OwningTopLevelWindow''
+
** '''Returns:''' '''string''' ''directoryPath''
-
* GetParent()
+
* {{GitHubSearch|Search=GetAddOnVersion}} [[GetAddOnVersion]]('''number''' ''addOnIndex'')
-
** ''Returns:'' '''object''' ''ret1''
+
** '''Returns:''' '''number''' ''version''
-
* GetResizeToFitDescendents()
+
* {{GitHubSearch|Search=GetLoadOutOfDateAddOns}} [[GetLoadOutOfDateAddOns]]()
-
** ''Returns:'' '''bool''' ''resizes''
+
** '''Returns:''' '''boolean''' ''loadOutOfDateAddons''
-
* GetResizeToFitPadding()
+
* {{GitHubSearch|Search=GetNumAddOns}} [[GetNumAddOns]]()
-
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
+
** '''Returns:''' '''number''' ''numAddOns''
-
* GetRight()
+
* {{GitHubSearch|Search=RemoveAddOnFilter}} [[RemoveAddOnFilter]]()
-
** ''Returns:'' '''number''' ''right''
+
-
* GetScale()
+
* {{GitHubSearch|Search=RequestAddOnSavedVariablesPrioritySave}} [[RequestAddOnSavedVariablesPrioritySave]]('''string''' ''addOnName'')
-
** ''Returns:'' '''number''' ''scale''
+
-
* GetScreenRect()
+
* {{GitHubSearch|Search=ResetRelevantFilters}} [[ResetRelevantFilters]]()
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
+
-
* GetTop()
+
* {{GitHubSearch|Search=SetAddOnEnabled}} [[SetAddOnEnabled]]('''number''' ''addOnIndex'', '''boolean''' ''enabled'')
-
** ''Returns:'' '''number''' ''top''
+
-
* GetType()
+
* {{GitHubSearch|Search=SetAddOnFilter}} [[SetAddOnFilter]]('''string''' ''settingFilter'')
-
** ''Returns:'' '''integer''' ''type''
+
-
* GetWidth()
+
* {{GitHubSearch|Search=SetLoadOutOfDateAddOns}} [[SetLoadOutOfDateAddOns]]('''boolean''' ''loadOutOfDateAddons'')
-
** ''Returns:'' '''number''' ''width''
+
-
* IsChildOf('''object''' ''desiredParent'')
 
-
** ''Returns:'' '''bool''' ''isChild''
 
-
* IsControlHidden()
+
===AnimationManager===
-
** ''Returns:'' '''bool''' ''hidden''
+
* {{GitHubSearch|Search=CreateTimeline}} [[CreateTimeline]]()
 +
** '''Returns:''' '''object''' ''timeline''
-
* IsHandlerSet('''string''' ''handlerName'')
+
* {{GitHubSearch|Search=CreateTimelineFromVirtual}} [[CreateTimelineFromVirtual]]('''string''' ''timelineName'', '''object''' ''animatedControl'')
-
** ''Returns:'' '''bool''' ''isSet''
+
** '''Returns:''' '''object''' ''timeline''
-
* IsHidden()
 
-
** ''Returns:'' '''bool''' ''hidden''
 
-
* IsKeyboardEnabled()
+
===AnimationObject===
-
** ''Returns:'' '''bool''' ''enabled''
+
Objects that inherit behavior from '''AnimationObject'''
 +
* [[Controls#AnimationObject3DRotate|AnimationObject3DRotate]]
 +
* [[Controls#AnimationObject3DTranslate|AnimationObject3DTranslate]]
 +
* [[Controls#AnimationObjectAlpha|AnimationObjectAlpha]]
 +
* [[Controls#AnimationObjectColor|AnimationObjectColor]]
 +
* [[Controls#AnimationObjectCustom|AnimationObjectCustom]]
 +
* [[Controls#AnimationObjectScale|AnimationObjectScale]]
 +
* [[Controls#AnimationObjectScroll|AnimationObjectScroll]]
 +
* [[Controls#AnimationObjectSize|AnimationObjectSize]]
 +
* [[Controls#AnimationObjectTexture|AnimationObjectTexture]]
 +
* [[Controls#AnimationObjectTextureRotate|AnimationObjectTextureRotate]]
 +
* [[Controls#AnimationObjectTextureSlide|AnimationObjectTextureSlide]]
 +
* [[Controls#AnimationObjectTranslate|AnimationObjectTranslate]]
-
* IsMouseEnabled()
 
-
** ''Returns:'' '''bool''' ''enabled''
 
-
* SetAlpha '''protected-attributes''' ('''number''' ''alpha'')
+
* {{GitHubSearch|Search=GetAnimatedControl}} [[GetAnimatedControl]]()
 +
** '''Returns:''' '''object''' ''animatedControl''
-
* [[Control:SetAnchor|SetAnchor]] '''protected-attributes''' ('''integer''' ''whereOnMe'', '''object''' ''anchorTargetControl'', '''integer''' ''whereOnTarget'', '''number''' ''offsetX'', '''number''' ''offsetY'')
+
* {{GitHubSearch|Search=GetApplyToChildControlName}} [[GetApplyToChildControlName]]()
 +
** '''Returns:''' '''string''' ''applyToChildControlName''
-
* SetAnchorFill '''protected-attributes''' ('''object''' ''anchorTargetControl'')
+
* {{GitHubSearch|Search=GetDuration}} [[GetDuration]]()
 +
** '''Returns:''' '''number''' ''durationMs''
-
* [[Control:SetClampedToScreen|SetClampedToScreen]]('''bool''' ''clamped'')
+
* {{GitHubSearch|Search=GetEasingFunction}} [[GetEasingFunction]]()
 +
** '''Returns:''' '''function''' ''functionRef''
-
* SetClampedToScreenInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
+
* {{GitHubSearch|Search=GetHandler}} [[GetHandler]]('''string''' ''EventName'')
 +
** '''Returns:''' '''function''' ''FunctionRef''
-
* SetDimensionConstraints('''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight'')
+
* {{GitHubSearch|Search=GetTimeline}} [[GetTimeline]]()
 +
** '''Returns:''' '''object''' ''owningTimeline''
-
* SetDimensions '''protected-attributes''' ('''number''' ''width'', '''number''' ''height'')
+
* {{GitHubSearch|Search=IsEnabled}} [[IsEnabled]]()
 +
** '''Returns:''' '''boolean''' ''isEnabled''
-
* SetDrawLayer '''protected-attributes''' ('''integer''' ''layer'')
+
* {{GitHubSearch|Search=IsPlaying}} [[IsPlaying]]()
 +
** '''Returns:''' '''boolean''' ''isPlaying''
-
* SetDrawLevel '''protected-attributes''' ('''integer''' ''level'')
+
* {{GitHubSearch|Search=SetAnimatedControl}} [[SetAnimatedControl]]('''object''' ''animatedControl'')
-
* SetDrawTier '''protected-attributes''' ('''integer''' ''tier'')
+
* {{GitHubSearch|Search=SetApplyToChildControlName}} [[SetApplyToChildControlName]]('''string''' ''applyToChildControlName'')
-
* SetExcludeFromResizeToFitExtents '''protected-attributes''' ('''bool''' ''exclude'')
+
* {{GitHubSearch|Search=SetDuration}} [[SetDuration]]('''number''' ''durationMs'')
-
* SetHandler('''string''' ''handlerName'', '''function''' ''functionRef'')
+
* {{GitHubSearch|Search=SetEasingFunction}} [[SetEasingFunction]]('''function''' ''functionRef'')
-
* SetHeight '''protected-attributes''' ('''number''' ''height'')
+
* {{GitHubSearch|Search=SetEnabled}} [[SetEnabled]]('''boolean''' ''enabled'')
-
* SetHidden '''protected-attributes''' ('''bool''' ''aHidden'')
+
* {{GitHubSearch|Search=SetHandler}} [[SetHandler]]('''string''' ''EventName'', '''function''' ''FunctionRef'')
-
* SetHitInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 
-
* SetId('''integer''' ''id'')
+
===AnimationObject3DRotate===
 +
* {{GitHubSearch|Search=GetEndPitch}} [[GetEndPitch]]()
 +
** '''Returns:''' '''number''' ''endPitchRadians''
-
* SetInheritAlpha('''bool''' ''inheritAlpha'')
+
* {{GitHubSearch|Search=GetEndRoll}} [[GetEndRoll]]()
 +
** '''Returns:''' '''number''' ''endRollRadians''
-
* SetInheritScale('''bool''' ''inheritScale'')
+
* {{GitHubSearch|Search=GetEndYaw}} [[GetEndYaw]]()
 +
** '''Returns:''' '''number''' ''endYawRadians''
-
* SetKeyboardEnabled '''protected-attributes''' ('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=GetStartPitch}} [[GetStartPitch]]()
 +
** '''Returns:''' '''number''' ''startPitchRadians''
-
* SetMouseEnabled '''protected-attributes''' ('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=GetStartRoll}} [[GetStartRoll]]()
 +
** '''Returns:''' '''number''' ''startRollRadians''
-
* SetMovable('''bool''' ''isMovable'')
+
* {{GitHubSearch|Search=GetStartYaw}} [[GetStartYaw]]()
 +
** '''Returns:''' '''number''' ''startYawRadians''
-
* SetParent '''protected-attributes''' ('''object''' ''newParent'')
+
* {{GitHubSearch|Search=SetEndPitch}} [[SetEndPitch]]('''number''' ''endPitchRadians'')
-
* SetResizeHandleSize('''number''' ''handleSize'')
+
* {{GitHubSearch|Search=SetEndRoll}} [[SetEndRoll]]('''number''' ''endRollRadians'')
-
* SetResizeToFitDescendents '''protected-attributes''' ('''bool''' ''resize'')
+
* {{GitHubSearch|Search=SetEndYaw}} [[SetEndYaw]]('''number''' ''endYawRadians'')
-
* SetResizeToFitPadding('''number''' ''width'', '''number''' ''height'')
+
* {{GitHubSearch|Search=SetRotationValues}} [[SetRotationValues]]('''number''' ''startPitchRadians'', '''number''' ''startYawRadians'', '''number''' ''startRollRadians'', '''number''' ''endPitchRadians'', '''number''' ''endYawRadians'', '''number''' ''endRollRadians'')
-
* SetScale '''protected-attributes''' ('''number''' ''scale'')
+
* {{GitHubSearch|Search=SetStartPitch}} [[SetStartPitch]]('''number''' ''startPitchRadians'')
-
* SetShapeType '''public''' ('''integer''' ''shapeType'')
+
* {{GitHubSearch|Search=SetStartRoll}} [[SetStartRoll]]('''number''' ''startRollRadians'')
-
* SetSimpleAnchor '''protected-attributes''' ('''object''' ''anchorTargetControl'', '''number''' ''offsetX'', '''number''' ''offsetY'')
+
* {{GitHubSearch|Search=SetStartYaw}} [[SetStartYaw]]('''number''' ''startYawRadians'')
-
* SetSimpleAnchorParent '''protected-attributes''' ('''number''' ''offsetX'', '''number''' ''offsetY'')
 
-
* SetWidth '''protected-attributes''' ('''number''' ''width'')
+
===AnimationObject3DTranslate===
 +
* {{GitHubSearch|Search=ClearBezierControlPoints}} [[ClearBezierControlPoints]]()
-
* StartMoving '''protected-attributes''' ()
+
* {{GitHubSearch|Search=GetDeltaOffsetX}} [[GetDeltaOffsetX]]()
-
** ''Returns:'' '''bool''' ''isMoving''
+
** '''Returns:''' '''number''' ''deltaX''
-
* StopMovingOrResizing '''protected-attributes''' ()
+
* {{GitHubSearch|Search=GetDeltaOffsetY}} [[GetDeltaOffsetY]]()
 +
** '''Returns:''' '''number''' ''deltaY''
-
* ToggleHidden '''protected-attributes''' ()
+
* {{GitHubSearch|Search=GetDeltaOffsetZ}} [[GetDeltaOffsetZ]]()
 +
** '''Returns:''' '''number''' ''deltaZ''
-
==== Objects that inherit behavior from '''Control''' ====
+
* {{GitHubSearch|Search=GetEndOffsetX}} [[GetEndOffsetX]]()
-
* [[#BackdropControl|BackdropControl]]
+
** '''Returns:''' '''number''' ''endX''
-
* [[#BrowserControl|BrowserControl]]
+
-
* [[#ButtonControl|ButtonControl]]
+
-
* [[#ColorSelectControl|ColorSelectControl]]
+
-
* [[#CompassDisplayControl|CompassDisplayControl]]
+
-
* [[#CooldownControl|CooldownControl]]
+
-
* [[#DebugTextControl|DebugTextControl]]
+
-
* [[#EditControl|EditControl]]
+
-
* [[#LabelControl|LabelControl]]
+
-
* [[#LineControl|LineControl]]
+
-
* [[#MapDisplayControl|MapDisplayControl]]
+
-
* [[#RootWindow|RootWindow]]
+
-
* [[#ScrollControl|ScrollControl]]
+
-
* [[#SliderControl|SliderControl]]
+
-
* [[#StatusBarControl|StatusBarControl]]
+
-
* [[#TextBufferControl|TextBufferControl]]
+
-
* [[#TextureControl|TextureControl]]
+
-
* [[#TooltipControl|TooltipControl]]
+
-
* [[#TopLevelWindow|TopLevelWindow]]
+
-
=== AddOnManager ===
+
* {{GitHubSearch|Search=GetEndOffsetY}} [[GetEndOffsetY]]()
-
* AddRelevantFilter('''string''' ''relevantFilter'')
+
** '''Returns:''' '''number''' ''endY''
-
* GetAddOnDependencyInfo('''luaindex''' ''addOnIndex'', '''luaindex''' ''addOnDependencyIndex'')
+
* {{GitHubSearch|Search=GetEndOffsetZ}} [[GetEndOffsetZ]]()
-
** ''Returns:'' '''string''' ''name'', '''bool''' ''active''
+
** '''Returns:''' '''number''' ''endZ''
-
* GetAddOnFilter()
+
* {{GitHubSearch|Search=GetStartOffsetX}} [[GetStartOffsetX]]()
-
** ''Returns:'' '''string''' ''settingFilter''
+
** '''Returns:''' '''number''' ''startX''
-
* GetAddOnInfo('''luaindex''' ''addOnIndex'')
+
* {{GitHubSearch|Search=GetStartOffsetY}} [[GetStartOffsetY]]()
-
** ''Returns:'' '''string''' ''name'', '''string''' ''title'', '''string''' ''author'', '''string''' ''description'', '''bool''' ''enabled'', '''[[Globals#AddOnLoadState|AddOnLoadState]]''' ''state'', '''bool''' ''isOutOfDate''
+
** '''Returns:''' '''number''' ''startY''
-
* GetAddOnNumDependencies('''luaindex''' ''addOnIndex'')
+
* {{GitHubSearch|Search=GetStartOffsetZ}} [[GetStartOffsetZ]]()
-
** ''Returns:'' '''integer''' ''numDependencies''
+
** '''Returns:''' '''number''' ''startZ''
-
* GetLoadOutOfDateAddOns()
+
* {{GitHubSearch|Search=GetTranslateDeltas}} [[GetTranslateDeltas]]()
-
** ''Returns:'' '''bool''' ''loadOutOfDateAddons''
+
** '''Returns:''' '''number''' ''deltaX'', '''number''' ''deltaY'', '''number''' ''deltaZ''
-
* GetNumAddOns()
+
* {{GitHubSearch|Search=SetBezierControlPoint}} [[SetBezierControlPoint]]('''number''' ''index'', '''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
-
** ''Returns:'' '''integer''' ''numAddOns''
+
-
* RemoveAddOnFilter()
+
* {{GitHubSearch|Search=SetDeltaOffsetX}} [[SetDeltaOffsetX]]('''number''' ''deltaX'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
-
* ResetRelevantFilters()
+
* {{GitHubSearch|Search=SetDeltaOffsetY}} [[SetDeltaOffsetY]]('''number''' ''deltaY'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
-
* SetAddOnEnabled('''luaindex''' ''addOnIndex'', '''bool''' ''enabled'')
+
* {{GitHubSearch|Search=SetDeltaOffsetZ}} [[SetDeltaOffsetZ]]('''number''' ''deltaZ'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
-
* SetAddOnFilter('''string''' ''settingFilter'')
+
* {{GitHubSearch|Search=SetEndOffsetX}} [[SetEndOffsetX]]('''number''' ''endX'')
-
* SetLoadOutOfDateAddOns('''bool''' ''loadOutOfDateAddons'')
+
* {{GitHubSearch|Search=SetEndOffsetY}} [[SetEndOffsetY]]('''number''' ''endY'')
 +
* {{GitHubSearch|Search=SetEndOffsetZ}} [[SetEndOffsetZ]]('''number''' ''endZ'')
-
=== AnimationManager ===
+
* {{GitHubSearch|Search=SetStartOffsetX}} [[SetStartOffsetX]]('''number''' ''startX'')
-
* CreateTimeline()
+
-
** ''Returns:'' '''object''' ''timeline''
+
-
* CreateTimelineFromVirtual('''string''' ''timelineName'', '''object''' ''animatedControl'')
+
* {{GitHubSearch|Search=SetStartOffsetY}} [[SetStartOffsetY]]('''number''' ''startY'')
-
** ''Returns:'' '''object''' ''timeline''
+
 +
* {{GitHubSearch|Search=SetStartOffsetZ}} [[SetStartOffsetZ]]('''number''' ''startZ'')
-
=== AnimationObject ===
+
* {{GitHubSearch|Search=SetTranslateDeltas}} [[SetTranslateDeltas]]('''number''' ''deltaX'', '''number''' ''deltaY'', '''number''' ''deltaZ'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
-
* GetAnimatedControl()
+
* {{GitHubSearch|Search=SetTranslateOffsets}} [[SetTranslateOffsets]]('''number''' ''startX'', '''number''' ''startY'', '''number''' ''startZ'', '''number''' ''endX'', '''number''' ''endY'', '''number''' ''endZ'')
-
** ''Returns:'' '''object''' ''animatedControl''
+
-
* GetDuration()
 
-
** ''Returns:'' '''integer''' ''durationMs''
 
-
* GetEasingFunction()
+
===AnimationObjectAlpha===
-
** ''Returns:'' '''function''' ''functionRef''
+
* {{GitHubSearch|Search=GetEndAlpha}} [[GetEndAlpha]]()
 +
** '''Returns:''' '''number''' ''endAlpha''
-
* GetHandler('''string''' ''EventName'')
+
* {{GitHubSearch|Search=GetStartAlpha}} [[GetStartAlpha]]()
-
** ''Returns:'' '''function''' ''FunctionRef''
+
** '''Returns:''' '''number''' ''startAlpha''
-
* GetTimeline()
+
* {{GitHubSearch|Search=SetAlphaValues}} [[SetAlphaValues]]('''number''' ''startAlpha'', '''number''' ''endAlpha'')
-
** ''Returns:'' '''object''' ''owningTimeline''
+
-
* IsPlaying()
+
* {{GitHubSearch|Search=SetEndAlpha}} [[SetEndAlpha]]('''number''' ''endAlpha'')
-
** ''Returns:'' '''bool''' ''isPlaying''
+
-
* SetAnimatedControl('''object''' ''animatedControl'')
+
* {{GitHubSearch|Search=SetStartAlpha}} [[SetStartAlpha]]('''number''' ''startAlpha'')
-
* SetDuration('''integer''' ''durationMs'')
 
-
* SetEasingFunction('''function''' ''functionRef'')
+
===AnimationObjectColor===
 +
* {{GitHubSearch|Search=GetApplyAlpha}} [[GetApplyAlpha]]()
 +
** '''Returns:''' '''boolean''' ''applyAlpha''
-
* SetHandler('''string''' ''EventName'', '''function''' ''FunctionRef'')
+
* {{GitHubSearch|Search=GetEndColor}} [[GetEndColor]]()
 +
** '''Returns:''' '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA''
-
==== Objects that inherit behavior from '''AnimationObject''' ====
+
* {{GitHubSearch|Search=GetStartColor}} [[GetStartColor]]()
 +
** '''Returns:''' '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA''
-
* [[#AnimationObjectAlpha|AnimationObjectAlpha]]
+
* {{GitHubSearch|Search=SetApplyAlpha}} [[SetApplyAlpha]]('''boolean''' ''applyAlpha'')
-
* [[#AnimationObjectColor|AnimationObjectColor]]
+
-
* [[#AnimationObjectCustom|AnimationObjectCustom]]
+
-
* [[#AnimationObjectScale|AnimationObjectScale]]
+
-
* [[#AnimationObjectScroll|AnimationObjectScroll]]
+
-
* [[#AnimationObjectSize|AnimationObjectSize]]
+
-
* [[#AnimationObjectTexture|AnimationObjectTexture]]
+
-
* [[#AnimationObjectTextureRotate|AnimationObjectTextureRotate]]
+
-
* [[#AnimationObjectTextureSlide|AnimationObjectTextureSlide]]
+
-
* [[#AnimationObjectTranslate|AnimationObjectTranslate]]
+
 +
* {{GitHubSearch|Search=SetColorValues}} [[SetColorValues]]('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
-
=== AnimationObjectAlpha ===
+
* {{GitHubSearch|Search=SetEndColor}} [[SetEndColor]]('''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
-
* GetEndAlpha()
+
-
** ''Returns:'' '''number''' ''endAlpha''
+
-
* GetStartAlpha()
+
* {{GitHubSearch|Search=SetStartColor}} [[SetStartColor]]('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'')
-
** ''Returns:'' '''number''' ''startAlpha''
+
-
* SetAlphaValues('''number''' ''startAlpha'', '''number''' ''endAlpha'')
 
-
* SetEndAlpha('''number''' ''endAlpha'')
+
===AnimationObjectCustom===
 +
* {{GitHubSearch|Search=SetUpdateFunction}} [[SetUpdateFunction]]('''function''' ''functionRef'')
-
* SetStartAlpha('''number''' ''startAlpha'')
 
 +
===AnimationObjectScale===
 +
* {{GitHubSearch|Search=GetEndScale}} [[GetEndScale]]()
 +
** '''Returns:''' '''number''' ''endScale''
-
=== AnimationObjectColor ===
+
* {{GitHubSearch|Search=GetStartScale}} [[GetStartScale]]()
-
* GetEndColor()
+
** '''Returns:''' '''number''' ''startScale''
-
** ''Returns:'' '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA''
+
-
* GetStartColor()
+
* {{GitHubSearch|Search=SetEndScale}} [[SetEndScale]]('''number''' ''endScale'')
-
** ''Returns:'' '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA''
+
-
* SetColorValues('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
+
* {{GitHubSearch|Search=SetScaleValues}} [[SetScaleValues]]('''number''' ''startScale'', '''number''' ''endScale'')
-
* SetEndColor('''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
+
* {{GitHubSearch|Search=SetStartScale}} [[SetStartScale]]('''number''' ''startScale'')
-
* SetStartColor('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'')
 
 +
===AnimationObjectScroll===
 +
* {{GitHubSearch|Search=SetHorizontalEnd}} [[SetHorizontalEnd]]('''number''' ''endX'')
-
=== AnimationObjectCustom ===
+
* {{GitHubSearch|Search=SetHorizontalRelative}} [[SetHorizontalRelative]]('''number''' ''offsetX'')
-
* SetUpdateFunction('''function''' ''functionRef'')
+
 +
* {{GitHubSearch|Search=SetHorizontalStartAndEnd}} [[SetHorizontalStartAndEnd]]('''number''' ''startX'', '''number''' ''endX'')
-
=== AnimationObjectScale ===
+
* {{GitHubSearch|Search=SetVerticalEnd}} [[SetVerticalEnd]]('''number''' ''endY'')
-
* GetEndScale()
+
-
** ''Returns:'' '''number''' ''endScale''
+
-
* GetStartScale()
+
* {{GitHubSearch|Search=SetVerticalRelative}} [[SetVerticalRelative]]('''number''' ''offsetY'')
-
** ''Returns:'' '''number''' ''startScale''
+
-
* SetEndScale('''number''' ''endScale'')
+
* {{GitHubSearch|Search=SetVerticalStartAndEnd}} [[SetVerticalStartAndEnd]]('''number''' ''startY'', '''number''' ''endY'')
-
* SetScaleValues('''number''' ''startScale'', '''number''' ''endScale'')
 
-
* SetStartScale('''number''' ''startScale'')
+
===AnimationObjectSize===
 +
* {{GitHubSearch|Search=SetEndHeight}} [[SetEndHeight]]('''number''' ''endHeight'')
 +
* {{GitHubSearch|Search=SetEndWidth}} [[SetEndWidth]]('''number''' ''endWidth'')
-
=== AnimationObjectScroll ===
+
* {{GitHubSearch|Search=SetStartAndEndHeight}} [[SetStartAndEndHeight]]('''number''' ''startHeight'', '''number''' ''endHeight'')
-
* SetHorizontalEnd('''number''' ''endX'')
+
-
* SetHorizontalRelative('''number''' ''offsetX'')
+
* {{GitHubSearch|Search=SetStartAndEndWidth}} [[SetStartAndEndWidth]]('''number''' ''startWidth'', '''number''' ''endWidth'')
-
* SetHorizontalStartAndEnd('''number''' ''startX'', '''number''' ''endX'')
+
* {{GitHubSearch|Search=SetStartHeight}} [[SetStartHeight]]('''number''' ''startHeight'')
-
* SetVerticalEnd('''number''' ''endY'')
+
* {{GitHubSearch|Search=SetStartWidth}} [[SetStartWidth]]('''number''' ''startWidth'')
-
* SetVerticalRelative('''number''' ''offsetY'')
 
-
* SetVerticalStartAndEnd('''number''' ''startY'', '''number''' ''endY'')
+
===AnimationObjectTexture===
 +
* {{GitHubSearch|Search=GetCellsHigh}} [[GetCellsHigh]]()
 +
** '''Returns:''' '''number''' ''aNumCellsHigh''
 +
* {{GitHubSearch|Search=GetCellsWide}} [[GetCellsWide]]()
 +
** '''Returns:''' '''number''' ''aNumCellsWide''
-
=== AnimationObjectSize ===
+
* {{GitHubSearch|Search=IsMirroringAlongX}} [[IsMirroringAlongX]]()
-
* SetEndHeight('''number''' ''endHeight'')
+
** '''Returns:''' '''boolean''' ''mirroring''
-
* SetEndWidth('''number''' ''endWidth'')
+
* {{GitHubSearch|Search=IsMirroringAlongY}} [[IsMirroringAlongY]]()
 +
** '''Returns:''' '''boolean''' ''mirroring''
-
* SetStartAndEndHeight('''number''' ''startHeight'', '''number''' ''endHeight'')
+
* {{GitHubSearch|Search=SetCellsHigh}} [[SetCellsHigh]]('''number''' ''aNumCellsHigh'')
-
* SetStartAndEndWidth('''number''' ''startWidth'', '''number''' ''endWidth'')
+
* {{GitHubSearch|Search=SetCellsWide}} [[SetCellsWide]]('''number''' ''aNumCellsWide'')
-
* SetStartHeight('''number''' ''startHeight'')
+
* {{GitHubSearch|Search=SetFramerate}} [[SetFramerate]]('''number''' ''framesPerSecond'')
-
* SetStartWidth('''number''' ''startWidth'')
+
* {{GitHubSearch|Search=SetImageData}} [[SetImageData]]('''number''' ''aNumCellsWide'', '''number''' ''aNumCellsHigh'')
 +
* {{GitHubSearch|Search=SetMirrorAlongX}} [[SetMirrorAlongX]]('''boolean''' ''mirroring'')
-
=== AnimationObjectTexture ===
+
* {{GitHubSearch|Search=SetMirrorAlongY}} [[SetMirrorAlongY]]('''boolean''' ''mirroring'')
-
* GetCellsHigh()
+
-
** ''Returns:'' '''integer''' ''aNumCellsHigh''
+
-
* GetCellsWide()
 
-
** ''Returns:'' '''integer''' ''aNumCellsWide''
 
-
* IsMirroringAlongX()
+
===AnimationObjectTextureRotate===
-
** ''Returns:'' '''bool''' ''mirroring''
+
* {{GitHubSearch|Search=GetEndRotation}} [[GetEndRotation]]()
 +
** '''Returns:''' '''number''' ''endRadians''
-
* IsMirroringAlongY()
+
* {{GitHubSearch|Search=GetStartRotation}} [[GetStartRotation]]()
-
** ''Returns:'' '''bool''' ''mirroring''
+
** '''Returns:''' '''number''' ''startRadians''
-
* SetCellsHigh('''integer''' ''aNumCellsHigh'')
+
* {{GitHubSearch|Search=SetEndRotation}} [[SetEndRotation]]('''number''' ''endRadians'')
-
* SetCellsWide('''integer''' ''aNumCellsWide'')
+
* {{GitHubSearch|Search=SetRotationValues}} [[SetRotationValues]]('''number''' ''startRadians'', '''number''' ''endRadians'')
-
* SetFramerate('''number''' ''framesPerSecond'')
+
* {{GitHubSearch|Search=SetStartRotation}} [[SetStartRotation]]('''number''' ''startRadians'')
-
* SetImageData('''integer''' ''aNumCellsWide'', '''integer''' ''aNumCellsHigh'')
 
-
* SetMirrorAlongX('''bool''' ''mirroring'')
+
===AnimationObjectTextureSlide===
 +
* {{GitHubSearch|Search=SetSlideDistances}} [[SetSlideDistances]]('''number''' ''slideDistanceU'', '''number''' ''slideDistanceV'')
-
* SetMirrorAlongY('''bool''' ''mirroring'')
 
 +
===AnimationObjectTranslate===
 +
* {{GitHubSearch|Search=GetAnchorIndex}} [[GetAnchorIndex]]()
 +
** '''Returns:''' '''number''' ''anchorIndex''
-
=== AnimationObjectTextureRotate ===
+
* {{GitHubSearch|Search=GetDeltaOffsetX}} [[GetDeltaOffsetX]]()
-
* GetEndRotation()
+
** '''Returns:''' '''number''' ''deltaX''
-
** ''Returns:'' '''number''' ''endRadians''
+
-
* GetStartRotation()
+
* {{GitHubSearch|Search=GetDeltaOffsetY}} [[GetDeltaOffsetY]]()
-
** ''Returns:'' '''number''' ''startRadians''
+
** '''Returns:''' '''number''' ''deltaY''
-
* SetEndRotation('''number''' ''endRadians'')
+
* {{GitHubSearch|Search=GetEndOffsetX}} [[GetEndOffsetX]]()
 +
** '''Returns:''' '''number''' ''endX''
-
* SetRotationValues('''number''' ''startRadians'', '''number''' ''endRadians'')
+
* {{GitHubSearch|Search=GetEndOffsetY}} [[GetEndOffsetY]]()
 +
** '''Returns:''' '''number''' ''endY''
-
* SetStartRotation('''number''' ''startRadians'')
+
* {{GitHubSearch|Search=GetStartOffsetX}} [[GetStartOffsetX]]()
 +
** '''Returns:''' '''number''' ''startX''
 +
* {{GitHubSearch|Search=GetStartOffsetY}} [[GetStartOffsetY]]()
 +
** '''Returns:''' '''number''' ''startY''
-
=== AnimationObjectTextureSlide ===
+
* {{GitHubSearch|Search=GetTranslateDeltas}} [[GetTranslateDeltas]]()
-
* SetSlideDistances('''number''' ''slideDistanceU'', '''number''' ''slideDistanceV'')
+
** '''Returns:''' '''number''' ''deltaX'', '''number''' ''deltaY''
 +
* {{GitHubSearch|Search=SetAnchorIndex}} [[SetAnchorIndex]]('''number''' ''anchorIndex'')
-
=== AnimationObjectTranslate ===
+
* {{GitHubSearch|Search=SetDeltaOffsetX}} [[SetDeltaOffsetX]]('''number''' ''deltaX'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
-
* GetDeltaOffsetX()
+
-
** ''Returns:'' '''number''' ''deltaX''
+
-
* GetDeltaOffsetY()
+
* {{GitHubSearch|Search=SetDeltaOffsetY}} [[SetDeltaOffsetY]]('''number''' ''deltaY'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
-
** ''Returns:'' '''number''' ''deltaY''
+
-
* GetEndOffsetX()
+
* {{GitHubSearch|Search=SetEndOffsetX}} [[SetEndOffsetX]]('''number''' ''endX'')
-
** ''Returns:'' '''number''' ''endX''
+
-
* GetEndOffsetY()
+
* {{GitHubSearch|Search=SetEndOffsetY}} [[SetEndOffsetY]]('''number''' ''endY'')
-
** ''Returns:'' '''number''' ''endY''
+
-
* GetStartOffsetX()
+
* {{GitHubSearch|Search=SetStartOffsetX}} [[SetStartOffsetX]]('''number''' ''startX'')
-
** ''Returns:'' '''number''' ''startX''
+
-
* GetStartOffsetY()
+
* {{GitHubSearch|Search=SetStartOffsetY}} [[SetStartOffsetY]]('''number''' ''startY'')
-
** ''Returns:'' '''number''' ''startY''
+
-
* GetTranslateDeltas()
+
* {{GitHubSearch|Search=SetTranslateDeltas}} [[SetTranslateDeltas]]('''number''' ''deltaX'', '''number''' ''deltaY'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
-
** ''Returns:'' '''number''' ''deltaX'', '''number''' ''deltaY''
+
-
* SetAnchorIndex('''integer''' ''anchorIndex'')
+
* {{GitHubSearch|Search=SetTranslateOffsets}} [[SetTranslateOffsets]]('''number''' ''startX'', '''number''' ''startY'', '''number''' ''endX'', '''number''' ''endY'')
-
* SetDeltaOffsetX('''number''' ''deltaX'')
 
-
* SetDeltaOffsetY('''number''' ''deltaY'')
+
===AnimationTimeline===
 +
* {{GitHubSearch|Search=ApplyAllAnimationsToControl}} [[ApplyAllAnimationsToControl]]('''object''' ''animatedControl'')
-
* SetEndOffsetX('''number''' ''endX'')
+
* {{GitHubSearch|Search=ClearAllCallbacks}} [[ClearAllCallbacks]]()
-
* SetEndOffsetY('''number''' ''endY'')
+
* {{GitHubSearch|Search=GetAnimation}} [[GetAnimation]]('''number''' ''animationIndex'')
 +
** '''Returns:''' '''object''' ''animation''
-
* SetStartOffsetX('''number''' ''startX'')
+
* {{GitHubSearch|Search=GetAnimationOffset}} [[GetAnimationOffset]]('''object''' ''animation'')
 +
** '''Returns:''' '''number''' ''offset''
-
* SetStartOffsetY('''number''' ''startY'')
+
* {{GitHubSearch|Search=GetAnimationTimeline}} [[GetAnimationTimeline]]('''number''' ''timelineIndex'')
 +
** '''Returns:''' '''object''' ''timeline''
-
* SetTranslateDeltas('''number''' ''deltaX'', '''number''' ''deltaY'')
+
* {{GitHubSearch|Search=GetAnimationTimelineOffset}} [[GetAnimationTimelineOffset]]('''object''' ''animation'')
 +
** '''Returns:''' '''number''' ''offset''
-
* SetTranslateOffsets('''number''' ''startX'', '''number''' ''startY'', '''number''' ''endX'', '''number''' ''endY'')
+
* {{GitHubSearch|Search=GetDuration}} [[GetDuration]]()
 +
** '''Returns:''' '''number''' ''duration''
 +
* {{GitHubSearch|Search=GetFirstAnimation}} [[GetFirstAnimation]]()
 +
** '''Returns:''' '''object''' ''animation''
-
=== AnimationTimeline ===
+
* {{GitHubSearch|Search=GetFirstAnimationOfType}} [[GetFirstAnimationOfType]]('''number''' [[Globals#AnimationType|AnimationType]] ''animationType'')
-
* ApplyAllAnimationsToControl('''object''' ''animatedControl'')
+
** '''Returns:''' '''object''' ''animation''
-
* ClearAllCallbacks()
+
* {{GitHubSearch|Search=GetFirstAnimationTimeline}} [[GetFirstAnimationTimeline]]()
 +
** '''Returns:''' '''object''' ''timeline''
-
* GetAnimation('''luaindex''' ''animationIndex'')
+
* {{GitHubSearch|Search=GetFullProgress}} [[GetFullProgress]]()
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''number''' ''progress''
-
* GetAnimationOffset('''object''' ''animation'')
+
* {{GitHubSearch|Search=GetHandler}} [[GetHandler]]('''string''' ''EventName'')
-
** ''Returns:'' '''integer''' ''offset''
+
** '''Returns:''' '''function''' ''FunctionRef''
-
* GetAnimationTimeline('''luaindex''' ''timelineIndex'')
+
* {{GitHubSearch|Search=GetLastAnimation}} [[GetLastAnimation]]()
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''object''' ''animation''
-
* GetAnimationTimelineOffset('''object''' ''animation'')
+
* {{GitHubSearch|Search=GetLastAnimationTimeline}} [[GetLastAnimationTimeline]]()
-
** ''Returns:'' '''integer''' ''offset''
+
** '''Returns:''' '''object''' ''timeline''
-
* GetDuration()
+
* {{GitHubSearch|Search=GetMinDuration}} [[GetMinDuration]]()
-
** ''Returns:'' '''integer''' ''duration''
+
** '''Returns:''' '''number''' ''minDuration''
-
* GetFirstAnimation()
+
* {{GitHubSearch|Search=GetNumAnimationTimelines}} [[GetNumAnimationTimelines]]()
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''number''' ''numTimelines''
-
* GetFirstAnimationTimeline()
+
* {{GitHubSearch|Search=GetNumAnimations}} [[GetNumAnimations]]()
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''number''' ''numAnimations''
-
* GetFullProgress()
+
* {{GitHubSearch|Search=GetParent}} [[GetParent]]()
-
** ''Returns:'' '''number''' ''progress''
+
** '''Returns:''' '''object''' ''timeline''
-
* GetHandler('''string''' ''EventName'')
+
* {{GitHubSearch|Search=GetPlaybackLoopsRemaining}} [[GetPlaybackLoopsRemaining]]()
-
** ''Returns:'' '''function''' ''FunctionRef''
+
** '''Returns:''' '''number''' ''loopsRemaining''
-
* GetLastAnimation()
+
* {{GitHubSearch|Search=GetProgress}} [[GetProgress]]()
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''number''' ''progress''
-
* GetLastAnimationTimeline()
+
* {{GitHubSearch|Search=GetSkipAnimationsBehindPlayheadOnInitialPlay}} [[GetSkipAnimationsBehindPlayheadOnInitialPlay]]()
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''boolean''' ''skipAnimations''
-
* GetNumAnimationTimelines()
+
* {{GitHubSearch|Search=InsertAnimation}} [[InsertAnimation]]('''number''' ''animationType'', '''object''' ''animatedControl'', '''number''' ''offset'')
-
** ''Returns:'' '''integer''' ''numTimelines''
+
** '''Returns:''' '''object''' ''animation''
-
* GetNumAnimations()
+
* {{GitHubSearch|Search=InsertAnimationFromVirtual}} [[InsertAnimationFromVirtual]]('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
-
** ''Returns:'' '''integer''' ''numAnimations''
+
** '''Returns:''' '''object''' ''animation''
-
* GetParent()
+
* {{GitHubSearch|Search=InsertAnimationTimeline}} [[InsertAnimationTimeline]]('''number''' ''offset'', '''object''' ''animatedControl'')
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''object''' ''animation''
-
* GetProgress()
+
* {{GitHubSearch|Search=InsertAnimationTimelineFromVirtual}} [[InsertAnimationTimelineFromVirtual]]('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
-
** ''Returns:'' '''number''' ''progress''
+
** '''Returns:''' '''object''' ''animation''
-
* InsertAnimation('''integer''' ''animationType'', '''object''' ''animatedControl'', '''integer''' ''offset'')
+
* {{GitHubSearch|Search=InsertCallback}} [[InsertCallback]]('''function''' ''functionRef'', '''number''' ''offset'')
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''function''' ''functionRefRet''
-
* InsertAnimationFromVirtual('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
+
* {{GitHubSearch|Search=IsEnabled}} [[IsEnabled]]()
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''boolean''' ''isEnabled''
-
* InsertAnimationTimeline('''integer''' ''offset'', '''object''' ''animatedControl'')
+
* {{GitHubSearch|Search=IsPaused}} [[IsPaused]]()
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''boolean''' ''isPaused''
-
* InsertAnimationTimelineFromVirtual('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
+
* {{GitHubSearch|Search=IsPlaying}} [[IsPlaying]]()
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''boolean''' ''isPlaying''
-
* InsertCallback('''function''' ''functionRef'', '''integer''' ''offset'')
+
* {{GitHubSearch|Search=IsPlayingBackward}} [[IsPlayingBackward]]()
-
** ''Returns:'' '''function''' ''functionRefRet''
+
** '''Returns:''' '''boolean''' ''reversed''
-
* IsPlaying()
+
* {{GitHubSearch|Search=Pause}} [[Pause]]()
-
** ''Returns:'' '''bool''' ''isPlaying''
+
-
* IsPlayingBackward()
+
* {{GitHubSearch|Search=PlayBackward}} [[PlayBackward]]()
-
** ''Returns:'' '''bool''' ''reversed''
+
-
* PlayBackward()
+
* {{GitHubSearch|Search=PlayForward}} [[PlayForward]]()
-
* PlayForward()
+
* {{GitHubSearch|Search=PlayFromEnd}} [[PlayFromEnd]]('''number''' ''offsetMs'')
-
* PlayFromEnd('''integer''' ''offsetMs'')
+
* {{GitHubSearch|Search=PlayFromStart}} [[PlayFromStart]]('''number''' ''offsetMs'')
-
* PlayFromStart('''integer''' ''offsetMs'')
+
* {{GitHubSearch|Search=PlayInstantlyToEnd}} [[PlayInstantlyToEnd]]()
-
* PlayInstantlyToEnd()
+
* {{GitHubSearch|Search=PlayInstantlyToStart}} [[PlayInstantlyToStart]]()
-
* PlayInstantlyToStart()
+
* {{GitHubSearch|Search=Resume}} [[Resume]]()
-
* SetAnimationOffset('''object''' ''animation'', '''integer''' ''offset'')
+
* {{GitHubSearch|Search=SetAllAnimationOffsets}} [[SetAllAnimationOffsets]]('''number''' ''offset'')
-
* SetAnimationTimelineOffset('''object''' ''animation'', '''integer''' ''offset'')
+
* {{GitHubSearch|Search=SetAnimationOffset}} [[SetAnimationOffset]]('''object''' ''animation'', '''number''' ''offset'')
-
* SetCallbackOffset('''function''' ''callback'', '''integer''' ''offset'')
+
* {{GitHubSearch|Search=SetAnimationTimelineOffset}} [[SetAnimationTimelineOffset]]('''object''' ''animation'', '''number''' ''offset'')
-
* SetHandler('''string''' ''EventName'', '''function''' ''FunctionRef'')
+
* {{GitHubSearch|Search=SetCallbackOffset}} [[SetCallbackOffset]]('''function''' ''callback'', '''number''' ''offset'')
-
* SetPlaybackType('''integer''' ''playbackType'', '''integer''' ''maxLoopCount'')
+
* {{GitHubSearch|Search=SetEnabled}} [[SetEnabled]]('''boolean''' ''enabled'')
-
* SetProgress('''number''' ''progress'')
+
* {{GitHubSearch|Search=SetHandler}} [[SetHandler]]('''string''' ''EventName'', '''function''' ''FunctionRef'')
-
* Stop()
+
* {{GitHubSearch|Search=SetMinDuration}} [[SetMinDuration]]('''number''' ''minDuration'')
 +
* {{GitHubSearch|Search=SetPlaybackLoopCount}} [[SetPlaybackLoopCount]]('''number''' ''maxLoopCount'')
-
=== BackdropControl ===
+
* {{GitHubSearch|Search=SetPlaybackLoopsRemaining}} [[SetPlaybackLoopsRemaining]]('''number''' ''loopsRemaining'')
-
* GetCenterColor()
+
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
-
* SetCenterColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetPlaybackType}} [[SetPlaybackType]]('''number''' ''playbackType'', '''number''' ''maxLoopCount'')
-
* SetCenterTexture('''string''' ''filename'', '''integer''' ''tileSize'', '''integer''' ''addressMode'')
+
* {{GitHubSearch|Search=SetProgress}} [[SetProgress]]('''number''' ''progress'')
-
* SetEdgeColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetSkipAnimationsBehindPlayheadOnInitialPlay}} [[SetSkipAnimationsBehindPlayheadOnInitialPlay]]('''boolean''' ''skipAnimations'')
-
* SetEdgeTexture('''string''' ''filename'', '''integer''' ''edgeFileWidth'', '''integer''' ''edgeFileHeight'', '''integer''' ''edgeSize'', '''integer''' ''edgeFilePadding'')
+
* {{GitHubSearch|Search=Stop}} [[Stop]]()
-
* SetInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 
-
* SetIntegralWrapping('''bool''' ''integralWrappingEnabled'')
+
===BackdropControl===
 +
* {{GitHubSearch|Search=GetCenterColor}} [[GetCenterColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
-
* SetPixelRoundingEnabled('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
* {{GitHubSearch|Search=SetCenterColor}} [[SetCenterColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
=== BrowserControl ===
+
* {{GitHubSearch|Search=SetCenterTexture}} [[SetCenterTexture]]('''string''' ''filename'', '''number''' ''tileSize'', '''number''' ''addressMode'')
-
* Open('''integer''' ''param1'', '''integer''' ''param2'', '''integer''' ''param3'', '''string''' ''text'')
+
 +
* {{GitHubSearch|Search=SetEdgeColor}} [[SetEdgeColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
=== ButtonControl ===
+
* {{GitHubSearch|Search=SetEdgeTexture}} [[SetEdgeTexture]]('''string''' ''filename'', '''number''' ''edgeFileWidth'', '''number''' ''edgeFileHeight'', '''number''' ''edgeSize'', '''number''' ''edgeFilePadding'')
-
* EnableMouseButton('''integer''' ''buttonNum'', '''bool''' ''enabled'')
+
-
* GetLabelControl()
+
* {{GitHubSearch|Search=SetInsets}} [[SetInsets]]('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
-
** ''Returns:'' '''object''' ''labelControl''
+
-
* GetState()
+
* {{GitHubSearch|Search=SetIntegralWrapping}} [[SetIntegralWrapping]]('''boolean''' ''integralWrappingEnabled'')
-
** ''Returns:'' '''integer''' ''state''
+
-
* SetClickSound('''string''' ''clickSound'')
+
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''enabled'')
-
* SetDesaturation('''number''' ''desaturation'')
+
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
-
* SetDisabledFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 
-
* SetDisabledPressedFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
===ButtonControl===
 +
* {{GitHubSearch|Search=EnableMouseButton}} [[EnableMouseButton]]('''number''' ''buttonNum'', '''boolean''' ''enabled'')
-
* SetDisabledPressedTexture('''string''' ''textureFilename'')
+
* {{GitHubSearch|Search=GetLabelControl}} [[GetLabelControl]]()
 +
** '''Returns:''' '''object''' ''labelControl''
-
* SetDisabledTexture('''string''' ''textureFilename'')
+
* {{GitHubSearch|Search=GetState}} [[GetState]]()
 +
** '''Returns:''' '''number''' ''state''
-
* SetEnabled('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
-
* SetEndCapWidth('''integer''' ''endCapWidth'')
+
* {{GitHubSearch|Search=SetClickSound}} [[SetClickSound]]('''string''' ''clickSound'')
-
* SetFont('''string''' ''text'')
+
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
-
* SetHorizontalAlignment('''integer''' ''horizontalAlign'')
+
* {{GitHubSearch|Search=SetDisabledFontColor}} [[SetDisabledFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetMouseOverBlendMode('''integer''' ''blendMode'')
+
* {{GitHubSearch|Search=SetDisabledPressedFontColor}} [[SetDisabledPressedFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetMouseOverFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetDisabledPressedTexture}} [[SetDisabledPressedTexture]]('''string''' ''textureFilename'')
-
* SetMouseOverTexture('''string''' ''textureFilename'')
+
* {{GitHubSearch|Search=SetDisabledTexture}} [[SetDisabledTexture]]('''string''' ''textureFilename'')
-
* SetNormalFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetEnabled}} [[SetEnabled]]('''boolean''' ''enabled'')
-
* SetNormalOffset('''number''' ''x'', '''number''' ''y'')
+
* {{GitHubSearch|Search=SetEndCapWidth}} [[SetEndCapWidth]]('''number''' ''endCapWidth'')
-
* SetNormalTexture('''string''' ''textureFilename'')
+
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''text'')
-
* SetPressedFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetHorizontalAlignment}} [[SetHorizontalAlignment]]('''number''' ''horizontalAlign'')
-
* SetPressedMouseOverTexture('''string''' ''textureFilename'')
+
* {{GitHubSearch|Search=SetMouseOverBlendMode}} [[SetMouseOverBlendMode]]('''number''' ''blendMode'')
-
* SetPressedOffset('''number''' ''x'', '''number''' ''y'')
+
* {{GitHubSearch|Search=SetMouseOverFontColor}} [[SetMouseOverFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetPressedTexture('''string''' ''textureFilename'')
+
* {{GitHubSearch|Search=SetMouseOverTexture}} [[SetMouseOverTexture]]('''string''' ''textureFilename'')
-
* SetState('''integer''' ''newState'', '''bool''' ''locked'')
+
* {{GitHubSearch|Search=SetNormalFontColor}} [[SetNormalFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetText('''string''' ''text'')
+
* {{GitHubSearch|Search=SetNormalOffset}} [[SetNormalOffset]]('''number''' ''x'', '''number''' ''y'')
-
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
+
* {{GitHubSearch|Search=SetNormalTexture}} [[SetNormalTexture]]('''string''' ''textureFilename'')
-
* SetVerticalAlignment('''integer''' ''verticalAlign'')
+
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
 +
* {{GitHubSearch|Search=SetPressedFontColor}} [[SetPressedFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
=== ColorSelectControl ===
+
* {{GitHubSearch|Search=SetPressedMouseOverTexture}} [[SetPressedMouseOverTexture]]('''string''' ''textureFilename'')
-
* GetColorAsHSV()
+
-
** ''Returns:'' '''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value''
+
-
* GetColorAsRGB()
+
* {{GitHubSearch|Search=SetPressedOffset}} [[SetPressedOffset]]('''number''' ''x'', '''number''' ''y'')
-
** ''Returns:'' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
+
-
* GetColorWheelTextureControl()
+
* {{GitHubSearch|Search=SetPressedTexture}} [[SetPressedTexture]]('''string''' ''textureFilename'')
-
** ''Returns:'' '''object''' ''textureControl''
+
-
* GetColorWheelThumbTextureControl()
+
* {{GitHubSearch|Search=SetShowingHighlight}} [[SetShowingHighlight]]('''boolean''' ''showingHighlight'')
-
** ''Returns:'' '''object''' ''textureControl''
+
-
* GetFullValuedColorAsRGB()
+
* {{GitHubSearch|Search=SetState}} [[SetState]]('''number''' ''newState'', '''boolean''' ''locked'')
-
** ''Returns:'' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
+
-
* GetValue()
+
* {{GitHubSearch|Search=SetText}} [[SetText]]('''string''' ''text'')
-
** ''Returns:'' '''number''' ''value''
+
-
* SetColorAsHSV('''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value'')
+
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
-
* SetColorAsRGB('''number''' ''red'', '''number''' ''green'', '''number''' ''blue'')
+
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
-
* SetColorWheelThumbTextureControl('''object''' ''textureControl'')
+
* {{GitHubSearch|Search=SetVerticalAlignment}} [[SetVerticalAlignment]]('''number''' ''verticalAlign'')
-
* SetValue('''number''' ''value'')
 
 +
===ColorSelectControl===
 +
* {{GitHubSearch|Search=GetColorAsHSV}} [[GetColorAsHSV]]()
 +
** '''Returns:''' '''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value''
-
=== CompassDisplayControl ===
+
* {{GitHubSearch|Search=GetColorAsRGB}} [[GetColorAsRGB]]()
-
* GetAlphaCoefficients('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'')
+
** '''Returns:''' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
-
** ''Returns:'' '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant''
+
-
* GetCenterOveredPinInfo('''luaindex''' ''centerOveredPinIndex'')
+
* {{GitHubSearch|Search=GetColorWheelTextureControl}} [[GetColorWheelTextureControl]]()
-
** ''Returns:'' '''string''' ''description'', '''integer''' ''type'', '''number''' ''distance'', '''[[Globals#DrawLayer|DrawLayer]]''' ''drawLayer'', '''bool''' ''suppressed''
+
** '''Returns:''' '''object''' ''textureControl''
-
* GetMinVisibleAlpha('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'')
+
* {{GitHubSearch|Search=GetColorWheelThumbTextureControl}} [[GetColorWheelThumbTextureControl]]()
-
** ''Returns:'' '''number''' ''minVisibleAlpha''
+
** '''Returns:''' '''object''' ''textureControl''
-
* GetMinVisibleScale('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'')
+
* {{GitHubSearch|Search=GetFullValuedColorAsRGB}} [[GetFullValuedColorAsRGB]]()
-
** ''Returns:'' '''number''' ''minVisibleScale''
+
** '''Returns:''' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
-
* GetNumCenterOveredPins()
+
* {{GitHubSearch|Search=GetThumbNormalizedPosition}} [[GetThumbNormalizedPosition]]()
-
** ''Returns:'' '''integer''' ''numCenterOveredPins''
+
** '''Returns:''' '''number''' ''normalizedX'', '''number''' ''normalizedY''
-
* GetScaleCoefficients('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'')
+
* {{GitHubSearch|Search=GetValue}} [[GetValue]]()
-
** ''Returns:'' '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant''
+
** '''Returns:''' '''number''' ''value''
-
* SetAlphaCoefficients('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
+
* {{GitHubSearch|Search=SetColorAsHSV}} [[SetColorAsHSV]]('''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value'')
-
* SetCardinalDirection('''string''' ''directionName'', '''string''' ''font'', '''integer''' ''cardinalDirection'')
+
* {{GitHubSearch|Search=SetColorAsRGB}} [[SetColorAsRGB]]('''number''' ''red'', '''number''' ''green'', '''number''' ''blue'')
-
* SetMinVisibleAlpha('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'', '''number''' ''minVisibleAlpha'')
+
* {{GitHubSearch|Search=SetColorWheelThumbTextureControl}} [[SetColorWheelThumbTextureControl]]('''object''' ''textureControl'')
-
* SetMinVisibleScale('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'', '''number''' ''minVisibleScale'')
+
* {{GitHubSearch|Search=SetThumbNormalizedPosition}} [[SetThumbNormalizedPosition]]('''number''' ''normalizedX'', '''number''' ''normalizedY'')
-
* SetScaleCoefficients('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
+
* {{GitHubSearch|Search=SetValue}} [[SetValue]]('''number''' ''value'')
-
=== EventManager ===
+
===CompassDisplayControl===
 +
* {{GitHubSearch|Search=GetAlphaDropoffBehavior}} [[GetAlphaDropoffBehavior]]('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'')
 +
** '''Returns:''' '''number''' ''closeAlpha'', '''number''' ''farAlpha'', '''number''' ''closeAlphaDistanceM'', '''number''' ''farAlphaDistanceM''
-
(E.g. <code>EVENT_MANAGER</code>)
+
* {{GitHubSearch|Search=GetCenterOveredPinDescription}} [[GetCenterOveredPinDescription]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''string''' ''description''
-
* RegisterForEvent('''integer''' ''event'', '''function''' ''callback'')
+
* {{GitHubSearch|Search=GetCenterOveredPinDistance}} [[GetCenterOveredPinDistance]]('''number''' ''centerOveredPinIndex'')
-
** ''Returns:'' '''bool''' ''success''
+
** '''Returns:''' '''number''' ''distanceFromPlayerCM''
-
* UnregisterForEvent('''integer''' ''event'')
+
* {{GitHubSearch|Search=GetCenterOveredPinInfo}} [[GetCenterOveredPinInfo]]('''number''' ''centerOveredPinIndex'')
-
** ''Returns:'' '''bool''' ''success''
+
** '''Returns:''' '''string''' ''description'', '''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''type'', '''number''' ''distanceFromPlayerCM'', '''number''' [[Globals#DrawLayer|DrawLayer]] ''drawLayer'', '''number''' ''drawLevel'', '''boolean''' ''suppressed''
 +
* {{GitHubSearch|Search=GetCenterOveredPinLayerAndLevel}} [[GetCenterOveredPinLayerAndLevel]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''number''' [[Globals#DrawLayer|DrawLayer]] ''drawLayer'', '''number''' ''drawLevel''
-
=== CooldownControl ===
+
* {{GitHubSearch|Search=GetCenterOveredPinType}} [[GetCenterOveredPinType]]('''number''' ''centerOveredPinIndex'')
-
* GetDuration()
+
** '''Returns:''' '''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''type''
-
** ''Returns:'' '''integer''' ''duration''
+
-
* GetTimeLeft()
+
* {{GitHubSearch|Search=GetNumCenterOveredPins}} [[GetNumCenterOveredPins]]()
-
** ''Returns:'' '''integer''' ''time''
+
** '''Returns:''' '''number''' ''numCenterOveredPins''
-
* ResetCooldown()
+
* {{GitHubSearch|Search=GetScaleDropoffBehavior}} [[GetScaleDropoffBehavior]]('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'')
 +
** '''Returns:''' '''number''' ''closeScale'', '''number''' ''farScale'', '''number''' ''closeScaleDistanceM'', '''number''' ''farScaleDistanceM''
-
* SetBlendMode('''integer''' ''blendMode'')
+
* {{GitHubSearch|Search=IsCenterOveredPinSuppressed}} [[IsCenterOveredPinSuppressed]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''boolean''' ''suppressed''
-
* SetCooldownRemainTime('''integer''' ''remain'')
+
* {{GitHubSearch|Search=SetAlphaDropoffBehavior}} [[SetAlphaDropoffBehavior]]('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''closeAlpha'', '''number''' ''farAlpha'', '''number''' ''closeAlphaDistanceM'', '''number''' ''farAlphaDistanceM'')
-
* SetFillColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetCardinalDirection}} [[SetCardinalDirection]]('''string''' ''directionName'', '''string''' ''font'', '''number''' ''cardinalDirection'')
-
* SetLeadingEdgeTexture('''string''' ''filename'')
+
* {{GitHubSearch|Search=SetScaleDropoffBehavior}} [[SetScaleDropoffBehavior]]('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''closeScale'', '''number''' ''farScale'', '''number''' ''closeScaleDistanceM'', '''number''' ''farScaleDistanceM'')
-
* SetTexture('''string''' ''filename'')
 
-
* SetVerticalCooldownLeadingEdgeHeight('''integer''' ''leadingEdgeHeight'')
+
===Control===
 +
Objects that inherit behavior from '''Control'''
 +
* [[Controls#BackdropControl|BackdropControl]]
 +
* [[Controls#ButtonControl|ButtonControl]]
 +
* [[Controls#ColorSelectControl|ColorSelectControl]]
 +
* [[Controls#CompassDisplayControl|CompassDisplayControl]]
 +
* [[Controls#CooldownControl|CooldownControl]]
 +
* [[Controls#DebugTextControl|DebugTextControl]]
 +
* [[Controls#EditControl|EditControl]]
 +
* [[Controls#LabelControl|LabelControl]]
 +
* [[Controls#LineControl|LineControl]]
 +
* [[Controls#MapDisplayControl|MapDisplayControl]]
 +
* [[Controls#RootWindow|RootWindow]]
 +
* [[Controls#ScrollControl|ScrollControl]]
 +
* [[Controls#SliderControl|SliderControl]]
 +
* [[Controls#StatusBarControl|StatusBarControl]]
 +
* [[Controls#TextBufferControl|TextBufferControl]]
 +
* [[Controls#TextureCompositeControl|TextureCompositeControl]]
 +
* [[Controls#TextureControl|TextureControl]]
 +
* [[Controls#TooltipControl|TooltipControl]]
 +
* [[Controls#TopLevelWindow|TopLevelWindow]]
-
* StartCooldown('''integer''' ''remain'', '''integer''' ''duration'', '''integer''' ''cooldownType'', '''integer''' ''cooldownTimeType'', '''bool''' ''drawLeadingEdge'')
 
 +
* {{GitHubSearch|Search=AddFilterForEvent}} [[AddFilterForEvent]]('''number''' ''event'')
 +
** '''Returns:''' '''boolean''' ''success''
-
=== DebugTextControl ===
+
* {{GitHubSearch|Search=ClearAnchors}} {{Protected_attributes}} [[ClearAnchors]]()
-
* Clear()
+
-
* SetFont('''string''' ''fontStr'')
+
* {{GitHubSearch|Search=Convert3DLocalOrientationToWorldOrientation}} [[Convert3DLocalOrientationToWorldOrientation]]('''number''' ''localPitch'', '''number''' ''localYaw'', '''number''' ''localRoll'')
 +
** '''Returns:''' '''number''' ''worldPitch'', '''number''' ''worldYaw'', '''number''' ''worldRoll''
 +
* {{GitHubSearch|Search=Convert3DLocalPositionToWorldPosition}} [[Convert3DLocalPositionToWorldPosition]]('''number''' ''localX'', '''number''' ''localY'', '''number''' ''localZ'')
 +
** '''Returns:''' '''number''' ''worldX'', '''number''' ''worldY'', '''number''' ''worldZ''
-
=== EditControl ===
+
* {{GitHubSearch|Search=Convert3DWorldOrientationToLocalOrientation}} [[Convert3DWorldOrientationToLocalOrientation]]('''number''' ''worldPitch'', '''number''' ''worldYaw'', '''number''' ''worldRoll'')
 +
** '''Returns:''' '''number''' ''localPitch'', '''number''' ''localYaw'', '''number''' ''localRoll''
-
(E.g. <code>ZO_ChatWindowTextEntryEditBox</code>)
+
* {{GitHubSearch|Search=Convert3DWorldPositionToLocalPosition}} [[Convert3DWorldPositionToLocalPosition]]('''number''' ''worldX'', '''number''' ''worldY'', '''number''' ''worldZ'')
 +
** '''Returns:''' '''number''' ''localX'', '''number''' ''localY'', '''number''' ''localZ''
-
* AddValidCharacter('''string''' ''validCharacter'')
+
* {{GitHubSearch|Search=Create3DRenderSpace}} [[Create3DRenderSpace]]()
-
* Clear()
+
* {{GitHubSearch|Search=CreateControl}} [[CreateControl]]('''string''' ''arg1'', '''number''' ''type'')
 +
** '''Returns:''' '''object''' ''apRet''
-
* ClearSelection()
+
* {{GitHubSearch|Search=Destroy3DRenderSpace}} [[Destroy3DRenderSpace]]()
-
* CopyAllTextToClipboard()
+
* {{GitHubSearch|Search=Does3DRenderSpaceUseDepthBuffer}} [[Does3DRenderSpaceUseDepthBuffer]]()
 +
** '''Returns:''' '''boolean''' ''usesDepthBuffer''
-
* GetCopyEnabled()
+
* {{GitHubSearch|Search=Get3DRenderSpaceForward}} [[Get3DRenderSpaceForward]]()
-
** ''Returns:'' '''bool''' ''enabled''
+
** '''Returns:''' '''number''' ''x'', '''number''' ''y'', '''number''' ''z''
-
* GetCursorPosition()
+
* {{GitHubSearch|Search=Get3DRenderSpaceOrientation}} [[Get3DRenderSpaceOrientation]]()
-
** ''Returns:'' '''integer''' ''cursorPosition''
+
** '''Returns:''' '''number''' ''pitchRadians'', '''number''' ''yawRadians'', '''number''' ''rollRadians''
-
* GetEditEnabled()
+
* {{GitHubSearch|Search=Get3DRenderSpaceOrigin}} [[Get3DRenderSpaceOrigin]]()
-
** ''Returns:'' '''bool''' ''enabled''
+
** '''Returns:''' '''number''' ''x'', '''number''' ''y'', '''number''' ''z''
-
* GetFontHeight()
+
* {{GitHubSearch|Search=Get3DRenderSpaceRight}} [[Get3DRenderSpaceRight]]()
-
** ''Returns:'' '''number''' ''fontHeight''
+
** '''Returns:''' '''number''' ''x'', '''number''' ''y'', '''number''' ''z''
-
* GetNewLineEnabled()
+
* {{GitHubSearch|Search=Get3DRenderSpaceSystem}} [[Get3DRenderSpaceSystem]]()
-
** ''Returns:'' '''bool''' ''enabled''
+
** '''Returns:''' '''number''' [[Globals#GuiRender3DSpaceSystem|GuiRender3DSpaceSystem]] ''system''
-
* GetPasteEnabled()
+
* {{GitHubSearch|Search=Get3DRenderSpaceUp}} [[Get3DRenderSpaceUp]]()
-
** ''Returns:'' '''bool''' ''enabled''
+
** '''Returns:''' '''number''' ''x'', '''number''' ''y'', '''number''' ''z''
-
* GetText()
+
* {{GitHubSearch|Search=GetAlpha}} [[GetAlpha]]()
-
** ''Returns:'' '''string''' ''apRet''
+
** '''Returns:''' '''number''' ''alpha''
-
* HasFocus()
+
* {{GitHubSearch|Search=GetAnchor}} [[GetAnchor]]('''number''' ''anchorIndex'')
-
** ''Returns:'' '''bool''' ''aRet''
+
** '''Returns:''' '''boolean''' ''isValidAnchor'', '''number''' ''point'', '''object''' ''relativeTo'', '''number''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' [[Globals#AnchorConstrains|AnchorConstrains]] ''anchorConstrains''
-
* HasSelection()
+
* {{GitHubSearch|Search=GetBottom}} [[GetBottom]]()
-
** ''Returns:'' '''bool''' ''hasSelection''
+
** '''Returns:''' '''number''' ''bottom''
-
* InsertText('''string''' ''aText'')
+
* {{GitHubSearch|Search=GetCenter}} [[GetCenter]]()
 +
** '''Returns:''' '''number''' ''centerX'', '''number''' ''centerY''
-
* IsMultiLine()
+
* {{GitHubSearch|Search=GetChild}} [[GetChild]]('''number''' ''childIndex'')
-
** ''Returns:'' '''bool''' ''isMultiLine''
+
** '''Returns:''' '''object''' ''childControl''
-
* LoseFocus()
+
* {{GitHubSearch|Search=GetClampedToScreen}} [[GetClampedToScreen]]()
 +
** '''Returns:''' '''boolean''' ''clamped''
-
* SelectAll()
+
* {{GitHubSearch|Search=GetClampedToScreenInsets}} [[GetClampedToScreenInsets]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
-
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=GetControlAlpha}} [[GetControlAlpha]]()
 +
** '''Returns:''' '''number''' ''alpha''
-
* SetCopyEnabled('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=GetControlScale}} [[GetControlScale]]()
 +
** '''Returns:''' '''number''' ''scale''
-
* SetCursorPosition('''integer''' ''cursorPosition'')
+
* {{GitHubSearch|Search=GetDesiredHeight}} [[GetDesiredHeight]]()
 +
** '''Returns:''' '''number''' ''height''
-
* SetEditEnabled('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=GetDesiredWidth}} [[GetDesiredWidth]]()
 +
** '''Returns:''' '''number''' ''width''
-
* SetFont('''string''' ''font'')
+
* {{GitHubSearch|Search=GetDimensionConstraints}} [[GetDimensionConstraints]]()
 +
** '''Returns:''' '''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight''
-
* SetMaxInputChars('''integer''' ''maxChars'')
+
* {{GitHubSearch|Search=GetDimensions}} [[GetDimensions]]()
 +
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
-
* SetMultiLine('''bool''' ''isMultiLine'')
+
* {{GitHubSearch|Search=GetDrawLayer}} [[GetDrawLayer]]()
 +
** '''Returns:''' '''number''' ''layer''
-
* SetNewLineEnabled('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=GetDrawLevel}} [[GetDrawLevel]]()
 +
** '''Returns:''' '''number''' ''level''
-
* SetPasteEnabled('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=GetDrawTier}} [[GetDrawTier]]()
 +
** '''Returns:''' '''number''' ''tier''
-
* SetSelection('''integer''' ''selectionStartIndex'', '''integer''' ''selectionEndIndex'')
+
* {{GitHubSearch|Search=GetExcludeFromResizeToFitExtents}} [[GetExcludeFromResizeToFitExtents]]()
 +
** '''Returns:''' '''boolean''' ''excludes''
-
* SetSelectionColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=GetHandler}} [[GetHandler]]('''string''' ''handlerName'')
 +
** '''Returns:''' '''function''' ''functionRef''
-
* SetText('''string''' ''aText'')
+
* {{GitHubSearch|Search=GetHeight}} [[GetHeight]]()
 +
** '''Returns:''' '''number''' ''height''
-
* SetTextType('''integer''' ''textType'')
+
* {{GitHubSearch|Search=GetHitInsets}} [[GetHitInsets]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
-
* TakeFocus()
+
* {{GitHubSearch|Search=GetId}} [[GetId]]()
 +
** '''Returns:''' '''number''' ''id''
 +
* {{GitHubSearch|Search=GetInheritsAlpha}} [[GetInheritsAlpha]]()
 +
** '''Returns:''' '''boolean''' ''inheritAlpha''
-
=== FontObject ===
+
* {{GitHubSearch|Search=GetInheritsScale}} [[GetInheritsScale]]()
-
* GetFontInfo()
+
** '''Returns:''' '''boolean''' ''inheritScale''
-
** ''Returns:'' '''string''' ''face'', '''integer''' ''size'', '''string''' ''option''
+
-
* SetFont('''string''' ''fontDescriptor'')
+
* {{GitHubSearch|Search=GetLeft}} [[GetLeft]]()
 +
** '''Returns:''' '''number''' ''left''
 +
* {{GitHubSearch|Search=GetName}} [[GetName]]()
 +
** '''Returns:''' '''string''' ''name''
-
=== LabelControl ===
+
* {{GitHubSearch|Search=GetNamedChild}} [[GetNamedChild]]('''string''' ''childName'')
-
* AnchorToBaseline('''object''' ''toLabel'', '''number''' ''offsetX'', '''[[Globals#AnchorPosition|AnchorPosition]]''' ''anchorSide'')
+
** '''Returns:''' '''object''' ''returnedControl''
-
* ClearAnchorToBaseline('''object''' ''toLabel'')
+
* {{GitHubSearch|Search=GetNumChildren}} [[GetNumChildren]]()
 +
** '''Returns:''' '''number''' ''numChildren''
-
* DidLineWrap()
+
* {{GitHubSearch|Search=GetOwningWindow}} [[GetOwningWindow]]()
-
** ''Returns:'' '''bool''' ''didLineWrap''
+
** '''Returns:''' '''object''' ''OwningTopLevelWindow''
-
* GetColor()
+
* {{GitHubSearch|Search=GetParent}} [[GetParent]]()
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
** '''Returns:''' '''object''' ''ret1''
-
* GetFontHeight()
+
* {{GitHubSearch|Search=GetResizeToFitDescendents}} [[GetResizeToFitDescendents]]()
-
** ''Returns:'' '''number''' ''fontHeight''
+
** '''Returns:''' '''boolean''' ''resizes''
-
* GetHorizontalAlignment()
+
* {{GitHubSearch|Search=GetResizeToFitPadding}} [[GetResizeToFitPadding]]()
-
** ''Returns:'' '''integer''' ''align''
+
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
-
* GetModifyTextType()
+
* {{GitHubSearch|Search=GetRight}} [[GetRight]]()
-
** ''Returns:'' '''[[Globals#ModifyTextType|ModifyTextType]]''' ''modifyTextType''
+
** '''Returns:''' '''number''' ''right''
-
* GetStringWidth('''string''' ''text'')
+
* {{GitHubSearch|Search=GetScale}} [[GetScale]]()
-
** ''Returns:'' '''number''' ''width''
+
** '''Returns:''' '''number''' ''scale''
-
* GetStyleColor()
+
* {{GitHubSearch|Search=GetScreenRect}} [[GetScreenRect]]()
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
-
* GetText()
+
* {{GitHubSearch|Search=GetTop}} [[GetTop]]()
-
** ''Returns:'' '''string''' ''apRet''
+
** '''Returns:''' '''number''' ''top''
-
* GetTextDimensions()
+
* {{GitHubSearch|Search=GetType}} [[GetType]]()
-
** ''Returns:'' '''number''' ''stringWidth'', '''number''' ''stringHeight''
+
** '''Returns:''' '''number''' ''type''
-
* GetTextHeight()
+
* {{GitHubSearch|Search=GetWidth}} [[GetWidth]]()
-
** ''Returns:'' '''number''' ''stringHeight''
+
** '''Returns:''' '''number''' ''width''
-
* GetTextWidth()
+
* {{GitHubSearch|Search=Has3DRenderSpace}} [[Has3DRenderSpace]]()
-
** ''Returns:'' '''number''' ''stringWidth''
+
** '''Returns:''' '''boolean''' ''has3DRenderSpace''
-
* GetVerticalAlignment()
+
* {{GitHubSearch|Search=IsChildOf}} [[IsChildOf]]('''object''' ''desiredParent'')
-
** ''Returns:'' '''integer''' ''align''
+
** '''Returns:''' '''boolean''' ''isChild''
-
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=IsControlHidden}} [[IsControlHidden]]()
 +
** '''Returns:''' '''boolean''' ''hidden''
-
* SetFont('''string''' ''fontString'')
+
* {{GitHubSearch|Search=IsHandlerSet}} [[IsHandlerSet]]('''string''' ''handlerName'')
 +
** '''Returns:''' '''boolean''' ''isSet''
-
* SetHorizontalAlignment('''integer''' ''align'')
+
* {{GitHubSearch|Search=IsHidden}} [[IsHidden]]()
 +
** '''Returns:''' '''boolean''' ''hidden''
-
* SetLineSpacing('''integer''' ''newLineX'')
+
* {{GitHubSearch|Search=IsKeyboardEnabled}} [[IsKeyboardEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
-
* SetModifyTextType('''[[Globals#ModifyTextType|ModifyTextType]]''' ''modifyTextType'')
+
* {{GitHubSearch|Search=IsMouseEnabled}} [[IsMouseEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
-
* SetNewLineX('''number''' ''newLineX'')
+
* {{GitHubSearch|Search=IsPointInside}} [[IsPointInside]]('''number''' ''x'', '''number''' ''y'', '''number''' ''leftOffset'', '''number''' ''topOffset'', '''number''' ''rightOffset'', '''number''' ''bottomOffset'')
 +
** '''Returns:''' '''boolean''' ''isInside''
-
* SetStyleColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=RegisterForEvent}} [[RegisterForEvent]]('''number''' ''event'', '''function''' ''callback'')
 +
** '''Returns:''' '''boolean''' ''success''
-
* SetText('''string''' ''aText'')
+
* {{GitHubSearch|Search=Set3DRenderSpaceForward}} [[Set3DRenderSpaceForward]]('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
-
* SetVerticalAlignment('''integer''' ''verticalAlign'')
+
* {{GitHubSearch|Search=Set3DRenderSpaceOrientation}} [[Set3DRenderSpaceOrientation]]('''number''' ''pitchRadians'', '''number''' ''yawRadians'', '''number''' ''rollRadians'')
-
* SetWrapMode('''integer''' ''wrapMode'')
+
* {{GitHubSearch|Search=Set3DRenderSpaceOrigin}} [[Set3DRenderSpaceOrigin]]('''number''' ''xM'', '''number''' ''yM'', '''number''' ''zM'')
-
* WasTruncated()
+
* {{GitHubSearch|Search=Set3DRenderSpaceRight}} [[Set3DRenderSpaceRight]]('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
-
** ''Returns:'' '''bool''' ''wasTruncated''
+
 +
* {{GitHubSearch|Search=Set3DRenderSpaceSystem}} [[Set3DRenderSpaceSystem]]('''number''' [[Globals#GuiRender3DSpaceSystem|GuiRender3DSpaceSystem]] ''system'')
-
=== LineControl ===
+
* {{GitHubSearch|Search=Set3DRenderSpaceUp}} [[Set3DRenderSpaceUp]]('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
-
* GetColor()
+
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
-
* GetTextureInfo()
+
* {{GitHubSearch|Search=Set3DRenderSpaceUsesDepthBuffer}} [[Set3DRenderSpaceUsesDepthBuffer]]('''boolean''' ''usesDepthBuffer'')
-
** ''Returns:'' '''string''' ''filename'', '''integer''' ''addressMode'', '''integer''' ''blendMode'', '''number''' ''desaturation'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'', '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
+
-
* SetBlendMode('''integer''' ''blendMode'')
+
* {{GitHubSearch|Search=SetAlpha}} {{Protected_attributes}} [[SetAlpha]]('''number''' ''alpha'')
-
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetAnchor}} {{Protected_attributes}} [[SetAnchor]]('''number''' ''whereOnMe'', '''object''' ''anchorTargetControl'', '''number''' ''whereOnTarget'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' [[Globals#AnchorConstrains|AnchorConstrains]] ''anchorConstrains'') - https://wiki.esoui.com/Control:SetAnchor
-
* SetDesaturation('''number''' ''desaturation'')
+
* {{GitHubSearch|Search=SetAnchorFill}} {{Protected_attributes}} [[SetAnchorFill]]('''object''' ''anchorTargetControl'')
-
* SetGradientColors('''integer''' ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
+
* {{GitHubSearch|Search=SetClampedToScreen}} [[SetClampedToScreen]]('''boolean''' ''clamped'')
-
* SetTexture('''string''' ''filename'')
+
* {{GitHubSearch|Search=SetClampedToScreenInsets}} [[SetClampedToScreenInsets]]('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
-
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
+
* {{GitHubSearch|Search=SetDimensionConstraints}} [[SetDimensionConstraints]]('''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight'')
-
* SetThickness('''number''' ''thickness'')
+
* {{GitHubSearch|Search=SetDimensions}} {{Protected_attributes}} [[SetDimensions]]('''number''' ''width'', '''number''' ''height'')
-
* SetVertexColors('''integer''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
+
* {{GitHubSearch|Search=SetDrawLayer}} {{Protected_attributes}} [[SetDrawLayer]]('''number''' ''layer'')
 +
* {{GitHubSearch|Search=SetDrawLevel}} {{Protected_attributes}} [[SetDrawLevel]]('''number''' ''level'')
-
=== MapDisplayControl ===
+
* {{GitHubSearch|Search=SetDrawTier}} {{Protected_attributes}} [[SetDrawTier]]('''number''' ''tier'')
-
* GetZoom()
+
-
** ''Returns:'' '''number''' ''normalizedRadius''
+
-
* SetPinFont('''string''' ''pinFont'')
+
* {{GitHubSearch|Search=SetExcludeFromResizeToFitExtents}} {{Protected_attributes}} [[SetExcludeFromResizeToFitExtents]]('''boolean''' ''exclude'')
-
* SetZoom('''number''' ''normalizedRadius'')
+
* {{GitHubSearch|Search=SetHandler}} [[SetHandler]]('''string''' ''handlerName'', '''function''' ''functionRef'')
 +
* {{GitHubSearch|Search=SetHeight}} {{Protected_attributes}} [[SetHeight]]('''number''' ''height'')
-
=== RootWindow ===
+
* {{GitHubSearch|Search=SetHidden}} {{Protected_attributes}} [[SetHidden]]('''boolean''' ''aHidden'')
-
=== ScrollControl ===
+
* {{GitHubSearch|Search=SetHitInsets}} [[SetHitInsets]]('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
-
* GetScrollExtents()
+
-
** ''Returns:'' '''number''' ''horizontal'', '''number''' ''vertical''
+
-
* GetScrollOffsets()
+
* {{GitHubSearch|Search=SetId}} [[SetId]]('''number''' ''id'')
-
** ''Returns:'' '''number''' ''horizontal'', '''number''' ''vertical''
+
-
* RestoreToExtents('''integer''' ''duration'')
+
* {{GitHubSearch|Search=SetInheritAlpha}} [[SetInheritAlpha]]('''boolean''' ''inheritAlpha'')
-
* SetFadeGradient('''luaindex''' ''gradientIndex'', '''number''' ''normalX'', '''number''' ''normalY'', '''number''' ''gradientLength'')
+
* {{GitHubSearch|Search=SetInheritScale}} [[SetInheritScale]]('''boolean''' ''inheritScale'')
-
* SetHorizontalScroll('''number''' ''offset'')
+
* {{GitHubSearch|Search=SetKeyboardEnabled}} {{Protected_attributes}} [[SetKeyboardEnabled]]('''boolean''' ''enabled'')
-
* SetScrollBounding('''integer''' ''bounding'')
+
* {{GitHubSearch|Search=SetMouseEnabled}} {{Protected_attributes}} [[SetMouseEnabled]]('''boolean''' ''enabled'')
-
* SetVerticalScroll('''number''' ''offset'')
+
* {{GitHubSearch|Search=SetMovable}} [[SetMovable]]('''boolean''' ''isMovable'')
 +
* {{GitHubSearch|Search=SetParent}} {{Protected_attributes}} [[SetParent]]('''object''' ''newParent'')
-
=== SliderControl ===
+
* {{GitHubSearch|Search=SetResizeHandleSize}} [[SetResizeHandleSize]]('''number''' ''handleSize'')
-
* DoesAllowDraggingFromThumb()
+
-
** ''Returns:'' '''bool''' ''allow''
+
-
* GetEnabled()
+
* {{GitHubSearch|Search=SetResizeToFitDescendents}} {{Protected_attributes}} [[SetResizeToFitDescendents]]('''boolean''' ''resize'')
-
** ''Returns:'' '''bool''' ''isEnabled''
+
-
* GetMinMax()
+
* {{GitHubSearch|Search=SetResizeToFitPadding}} [[SetResizeToFitPadding]]('''number''' ''width'', '''number''' ''height'')
-
** ''Returns:'' '''number''' ''min'', '''number''' ''max''
+
-
* GetOrientation()
+
* {{GitHubSearch|Search=SetScale}} {{Protected_attributes}} [[SetScale]]('''number''' ''scale'')
-
** ''Returns:'' '''integer''' ''orientation''
+
-
* GetThumbTextureControl()
+
* SetShapeType '''public''' ('''number''' ''shapeType'')
-
** ''Returns:'' '''object''' ''textureControl''
+
-
* GetValue()
+
* {{GitHubSearch|Search=SetSimpleAnchor}} {{Protected_attributes}} [[SetSimpleAnchor]]('''object''' ''anchorTargetControl'', '''number''' ''offsetX'', '''number''' ''offsetY'')
-
** ''Returns:'' '''number''' ''value''
+
-
* GetValueStep()
+
* {{GitHubSearch|Search=SetSimpleAnchorParent}} {{Protected_attributes}} [[SetSimpleAnchorParent]]('''number''' ''offsetX'', '''number''' ''offsetY'')
-
** ''Returns:'' '''number''' ''step''
+
-
* IsThumbFlushWithExtents()
+
* {{GitHubSearch|Search=SetWidth}} {{Protected_attributes}} [[SetWidth]]('''number''' ''width'')
-
** ''Returns:'' '''bool''' ''flush''
+
-
* SetAllowDraggingFromThumb('''bool''' ''allow'')
+
* {{GitHubSearch|Search=StartMoving}} {{Protected_attributes}} [[StartMoving]]()
 +
** '''Returns:''' '''boolean''' ''isMoving''
-
* SetBackgroundBottomTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
+
* {{GitHubSearch|Search=StopMovingOrResizing}} {{Protected_attributes}} [[StopMovingOrResizing]]()
-
* SetBackgroundMiddleTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
+
* {{GitHubSearch|Search=ToggleHidden}} {{Protected_attributes}} [[ToggleHidden]]()
-
* SetBackgroundTopTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
+
* {{GitHubSearch|Search=UnregisterForEvent}} [[UnregisterForEvent]]('''number''' ''event'')
 +
** '''Returns:''' '''boolean''' ''success''
-
* SetEnabled('''bool''' ''enable'')
 
-
* SetMinMax('''number''' ''min'', '''number''' ''max'')
+
===CooldownControl===
 +
* {{GitHubSearch|Search=GetDuration}} [[GetDuration]]()
 +
** '''Returns:''' '''number''' ''duration''
-
* SetOrientation('''integer''' ''orientation'')
+
* {{GitHubSearch|Search=GetPercentCompleteFixed}} [[GetPercentCompleteFixed]]()
 +
** '''Returns:''' '''number''' ''percentComplete''
-
* SetThumbFlushWithExtents('''bool''' ''flush'')
+
* {{GitHubSearch|Search=GetTimeLeft}} [[GetTimeLeft]]()
 +
** '''Returns:''' '''number''' ''time''
-
* SetThumbTexture('''string''' ''filename'', '''string''' ''disabledFilename'', '''string''' ''highlightedFilename'', '''number''' ''thumbWidth'', '''number''' ''thumbHeight'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
+
* {{GitHubSearch|Search=ResetCooldown}} [[ResetCooldown]]()
-
* SetThumbTextureHeight('''number''' ''height'')
+
* {{GitHubSearch|Search=SetBlendMode}} [[SetBlendMode]]('''number''' ''blendMode'')
-
* SetValue('''number''' ''value'')
+
* {{GitHubSearch|Search=SetCooldownRemainTime}} [[SetCooldownRemainTime]]('''number''' ''remain'')
-
* SetValueStep('''number''' ''step'')
+
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
* {{GitHubSearch|Search=SetFillColor}} [[SetFillColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
=== StatusBarControl ===
+
* {{GitHubSearch|Search=SetLeadingEdgeTexture}} [[SetLeadingEdgeTexture]]('''string''' ''filename'')
-
* ClearFadeOutLossAdjustedTopValue()
+
-
* EnableFadeOut('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=SetPercentCompleteFixed}} [[SetPercentCompleteFixed]]('''number''' ''percentComplete'')
-
* EnableLeadingEdge('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=SetRadialCooldownClockwise}} [[SetRadialCooldownClockwise]]('''boolean''' ''clockwise'')
-
* EnableScrollingOverlay('''bool''' ''enabled'')
+
* {{GitHubSearch|Search=SetRadialCooldownGradient}} [[SetRadialCooldownGradient]]('''number''' ''startAlpha'', '''number''' ''angularDistance'')
-
* GetMinMax()
+
* {{GitHubSearch|Search=SetRadialCooldownOriginAngle}} [[SetRadialCooldownOriginAngle]]('''number''' ''originAngle'')
-
** ''Returns:'' '''number''' ''min'', '''number''' ''max''
+
-
* GetValue()
+
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
-
** ''Returns:'' '''number''' ''value''
+
-
* SetBarAlignment('''integer''' ''barAlignment'')
+
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
-
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetVerticalCooldownLeadingEdgeHeight}} [[SetVerticalCooldownLeadingEdgeHeight]]('''number''' ''leadingEdgeHeight'')
-
* SetFadeOutGainColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=StartCooldown}} [[StartCooldown]]('''number''' ''remain'', '''number''' ''duration'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', '''boolean''' ''drawLeadingEdge'')
-
* SetFadeOutLossAdjustedTopValue('''number''' ''topValue'')
+
* {{GitHubSearch|Search=StartFixedCooldown}} [[StartFixedCooldown]]('''number''' ''percentComplete'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', '''boolean''' ''drawLeadingEdge'')
-
* SetFadeOutLossColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 
-
* SetFadeOutLossSetValueToAdjust('''number''' ''adjustValue'')
+
===DebugTextControl===
 +
* {{GitHubSearch|Search=Clear}} [[Clear]]()
-
* SetFadeOutTexture('''string''' ''filename'')
+
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontStr'')
-
* SetFadeOutTime('''number''' ''fadeOutSeconds'', '''number''' ''fadeOutDelaySeconds'')
 
-
* SetGradientColors('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
+
===EditControl===
 +
* {{GitHubSearch|Search=AddValidCharacter}} [[AddValidCharacter]]('''string''' ''validCharacter'')
-
* SetLeadingEdge('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'')
+
* {{GitHubSearch|Search=Clear}} [[Clear]]()
-
* SetLeadingEdgeTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
+
* {{GitHubSearch|Search=ClearSelection}} [[ClearSelection]]()
-
* SetMinMax('''number''' ''aMin'', '''number''' ''aMax'')
+
* {{GitHubSearch|Search=CopyAllTextToClipboard}} {{Private function}} [[CopyAllTextToClipboard]]()
-
* SetOrientation('''integer''' ''orientation'')
+
* {{GitHubSearch|Search=GetAllowMarkupType}} [[GetAllowMarkupType]]()
 +
** '''Returns:''' '''number''' [[Globals#AllowMarkupType|AllowMarkupType]] ''allowMarkupType''
-
* SetTexture('''string''' ''filename'')
+
* {{GitHubSearch|Search=GetCopyEnabled}} [[GetCopyEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
-
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
+
* {{GitHubSearch|Search=GetCursorPosition}} [[GetCursorPosition]]()
 +
** '''Returns:''' '''number''' ''cursorPosition''
-
* SetValue('''number''' ''aValue'')
+
* {{GitHubSearch|Search=GetEditEnabled}} [[GetEditEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
-
* SetupScrollingOverlay('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'', '''integer''' ''duration'')
+
* {{GitHubSearch|Search=GetFontHeight}} [[GetFontHeight]]()
 +
** '''Returns:''' '''number''' ''fontHeightUIUnits''
 +
* {{GitHubSearch|Search=GetIMECompositionExclusionArea}} [[GetIMECompositionExclusionArea]]()
 +
** '''Returns:''' '''number''' ''leftControlSpace'', '''number''' ''topControlSpace'', '''number''' ''rightControlSpace'', '''number''' ''bottomControlSpace''
-
=== TextBufferControl ===
+
* {{GitHubSearch|Search=GetNewLineEnabled}} [[GetNewLineEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
-
(E.g. <code>CHAT_SYSTEM</code> windows.)
+
* {{GitHubSearch|Search=GetPasteEnabled}} [[GetPasteEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
-
* AddMessage('''string''' ''aText'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''integer''' ''colorId'')
+
* {{GitHubSearch|Search=GetScrollExtents}} [[GetScrollExtents]]()
 +
** '''Returns:''' '''number''' ''numLines''
-
* Clear()
+
* {{GitHubSearch|Search=GetText}} [[GetText]]()
 +
** '''Returns:''' '''string''' ''apRet''
-
* GetDrawLastEntryIfOutOfRoom()
+
* {{GitHubSearch|Search=GetTopLineIndex}} [[GetTopLineIndex]]()
-
** ''Returns:'' '''bool''' ''drawLastIfOutOfRoom''
+
** '''Returns:''' '''number''' ''index''
-
* GetLineFade()
+
* {{GitHubSearch|Search=HasFocus}} [[HasFocus]]()
-
** ''Returns:'' '''number''' ''timeBeforeLineBeginsToFade'', '''number''' ''timeItTakesLineToFade''
+
** '''Returns:''' '''boolean''' ''aRet''
-
* GetLinkEnabled()
+
* {{GitHubSearch|Search=HasSelection}} [[HasSelection]]()
-
** ''Returns:'' '''bool''' ''linkEnabed''
+
** '''Returns:''' '''boolean''' ''hasSelection''
-
* GetMaxHistoryLines()
+
* {{GitHubSearch|Search=InsertText}} [[InsertText]]('''string''' ''aText'')
-
** ''Returns:'' '''integer''' ''numLines''
+
-
* GetNumHistoryLines()
+
* {{GitHubSearch|Search=IsComposingIMEText}} [[IsComposingIMEText]]()
-
** ''Returns:'' '''integer''' ''numLines''
+
** '''Returns:''' '''boolean''' ''isComposing''
-
* GetNumVisibleLines()
+
* {{GitHubSearch|Search=IsMultiLine}} [[IsMultiLine]]()
-
** ''Returns:'' '''integer''' ''numLines''
+
** '''Returns:''' '''boolean''' ''isMultiLine''
-
* GetScrollPosition()
+
* {{GitHubSearch|Search=LoseFocus}} [[LoseFocus]]()
-
** ''Returns:'' '''integer''' ''scrollPosition''
+
-
* IsSplittingLongMessages()
+
* {{GitHubSearch|Search=RemoveAllValidCharacters}} [[RemoveAllValidCharacters]]()
-
** ''Returns:'' '''bool''' ''isSplitting''
+
-
* MoveScrollPosition('''integer''' ''numLines'')
+
* {{GitHubSearch|Search=SelectAll}} [[SelectAll]]()
-
* SetClearBufferAfterFadeout('''bool''' ''clearAfterFade'')
+
* {{GitHubSearch|Search=SetAllowMarkupType}} [[SetAllowMarkupType]]('''number''' [[Globals#AllowMarkupType|AllowMarkupType]] ''allowMarkupType'')
-
* SetColorById('''integer''' ''colorId'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
+
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetDrawLastEntryIfOutOfRoom('''bool''' ''drawLastIfOutOfRoom'')
+
* {{GitHubSearch|Search=SetCopyEnabled}} [[SetCopyEnabled]]('''boolean''' ''enabled'')
-
* SetFont('''string''' ''fontString'')
+
* {{GitHubSearch|Search=SetCursorPosition}} [[SetCursorPosition]]('''number''' ''cursorPosition'')
-
* SetHorizontalAlignment('''integer''' ''align'')
+
* {{GitHubSearch|Search=SetEditEnabled}} [[SetEditEnabled]]('''boolean''' ''enabled'')
-
* SetLineFade('''number''' ''timeBeforeLineFadeBegins'', '''number''' ''timeForLineToFade'')
+
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''font'')
-
* SetLinkEnabled('''bool''' ''linkEnabed'')
+
* {{GitHubSearch|Search=SetMaxInputChars}} [[SetMaxInputChars]]('''number''' ''maxChars'')
-
* SetMaxHistoryLines('''integer''' ''numLines'')
+
* {{GitHubSearch|Search=SetMultiLine}} [[SetMultiLine]]('''boolean''' ''isMultiLine'')
-
* SetScrollPosition('''integer''' ''line'')
+
* {{GitHubSearch|Search=SetNewLineEnabled}} [[SetNewLineEnabled]]('''boolean''' ''enabled'')
-
* SetSplitLongMessages('''bool''' ''splitLongMessages'')
+
* {{GitHubSearch|Search=SetPasteEnabled}} [[SetPasteEnabled]]('''boolean''' ''enabled'')
-
* ShowFadedLines()
+
* {{GitHubSearch|Search=SetSelection}} [[SetSelection]]('''number''' ''selectionStartIndex'', '''number''' ''selectionEndIndex'')
 +
* {{GitHubSearch|Search=SetSelectionColor}} [[SetSelectionColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
=== TextureControl ===
+
* {{GitHubSearch|Search=SetText}} [[SetText]]('''string''' ''aText'')
-
* GetColor()
+
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
-
* GetResizeToFitFile()
+
* {{GitHubSearch|Search=SetTextType}} [[SetTextType]]('''number''' ''textType'')
-
** ''Returns:'' '''bool''' ''resizesToFitFile''
+
-
* GetTextureFileDimensions()
+
* {{GitHubSearch|Search=SetTopLineIndex}} [[SetTopLineIndex]]('''number''' ''index'')
-
** ''Returns:'' '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
+
-
* GetTextureInfo()
+
* {{GitHubSearch|Search=SetVirtualKeyboardType}} [[SetVirtualKeyboardType]]('''number''' [[Globals#VirtualKeyboardType|VirtualKeyboardType]] ''aKeyboardType'')
-
** ''Returns:'' '''string''' ''filename'', '''integer''' ''addressMode'', '''integer''' ''blendMode'', '''number''' ''desaturation'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'', '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
+
-
* IsTextureLoaded()
+
* {{GitHubSearch|Search=TakeFocus}} [[TakeFocus]]()
-
** ''Returns:'' '''bool''' ''loaded''
+
-
* SetAddressMode('''integer''' ''addressMode'')
+
* {{GitHubSearch|Search=WasLastChangeVirtualKeyboard}} [[WasLastChangeVirtualKeyboard]]()
 +
** '''Returns:''' '''boolean''' ''aRet''
-
* SetAutoAdjustWrappedCoords('''bool''' ''enabled'')
 
-
* SetBlendMode('''integer''' ''blendMode'')
+
===FontObject===
 +
* {{GitHubSearch|Search=GetFontInfo}} [[GetFontInfo]]()
 +
** '''Returns:''' '''string''' ''face'', '''number''' ''size'', '''string''' ''option''
-
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
+
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontDescriptor'')
-
* SetDesaturation('''number''' ''desaturation'')
 
-
* SetGradientColors('''integer''' ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
+
===LabelControl===
 +
* {{GitHubSearch|Search=AnchorToBaseline}} [[AnchorToBaseline]]('''object''' ''toLabel'', '''number''' ''offsetX'', '''number''' [[Globals#AnchorPosition|AnchorPosition]] ''anchorSide'')
-
* SetPixelRounding('''bool''' ''pixelRoundingEnabled'')
+
* {{GitHubSearch|Search=Clean}} [[Clean]]()
-
* SetResizeToFitFile('''bool''' ''resizesToFitFile'')
+
* {{GitHubSearch|Search=ClearAnchorToBaseline}} [[ClearAnchorToBaseline]]('''object''' ''toLabel'')
-
* SetTexture('''string''' ''filename'')
+
* {{GitHubSearch|Search=DidLineWrap}} [[DidLineWrap]]()
 +
** '''Returns:''' '''boolean''' ''didLineWrap''
-
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
+
* {{GitHubSearch|Search=GetColor}} [[GetColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
-
* SetTextureCoordsRotation('''number''' ''angleInRadians'')
+
* {{GitHubSearch|Search=GetFontHeight}} [[GetFontHeight]]()
 +
** '''Returns:''' '''number''' ''fontHeightUIUnits''
-
* SetTextureRotation('''number''' ''angleInRadians'', '''number''' ''normalizedRotationPointX'', '''number''' ''normalizedRotationPointY'')
+
* {{GitHubSearch|Search=GetHorizontalAlignment}} [[GetHorizontalAlignment]]()
 +
** '''Returns:''' '''number''' ''align''
-
* SetVertexColors('''integer''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
+
* {{GitHubSearch|Search=GetLinkEnabled}} [[GetLinkEnabled]]()
 +
** '''Returns:''' '''boolean''' ''linkEnabed''
 +
* {{GitHubSearch|Search=GetModifyTextType}} [[GetModifyTextType]]()
 +
** '''Returns:''' '''number''' [[Globals#ModifyTextType|ModifyTextType]] ''modifyTextType''
-
=== TooltipControl ===
+
* {{GitHubSearch|Search=GetNumLines}} [[GetNumLines]]()
-
* AddControl('''object''' ''control'', '''integer''' ''cell'', '''bool''' ''useLastRow'')
+
** '''Returns:''' '''number''' ''numLines''
-
* AddHeaderControl('''object''' ''control'', '''integer''' ''headerRow'', '''[[Globals#TooltipHeaderSide|TooltipHeaderSide]]''' ''headerSide'')
+
* {{GitHubSearch|Search=GetStringWidth}} [[GetStringWidth]]('''string''' ''text'')
 +
** '''Returns:''' '''number''' ''scaledPixelWidth''
-
* AddHeaderLine('''string''' ''text'', '''string''' ''font'', '''integer''' ''headerRow'', '''[[Globals#TooltipHeaderSide|TooltipHeaderSide]]''' ''headerSide'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
+
* {{GitHubSearch|Search=GetStyleColor}} [[GetStyleColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
-
* AddLine('''string''' ''text'', '''string''' ''font'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''[[Globals#AnchorPosition|AnchorPosition]]''' ''lineAnchor'', '''[[Globals#ModifyTextType|ModifyTextType]]''' ''modifyTextType'', '''[[Globals#TextAlignment|TextAlignment]]''' ''textAlignment'', '''bool''' ''setToFullSize'')
+
* {{GitHubSearch|Search=GetText}} [[GetText]]()
 +
** '''Returns:''' '''string''' ''apRet''
-
* AddVerticalPadding('''number''' ''paddingY'')
+
* {{GitHubSearch|Search=GetTextDimensions}} [[GetTextDimensions]]()
 +
** '''Returns:''' '''number''' ''stringWidthUIUnits'', '''number''' ''stringHeightUIUnits''
-
* AppendAvAObjective('''integer''' ''queryType'', '''integer''' ''keepId'', '''integer''' ''objectiveId'', '''bool''' ''isSpawnPosition'')
+
* {{GitHubSearch|Search=GetTextHeight}} [[GetTextHeight]]()
 +
** '''Returns:''' '''number''' ''stringHeightUIUnits''
-
* AppendMapPing('''integer''' ''pingType'', '''string''' ''unitTag'')
+
* {{GitHubSearch|Search=GetTextWidth}} [[GetTextWidth]]()
 +
** '''Returns:''' '''number''' ''stringWidthUIUnits''
-
* AppendQuestCondition('''luaindex''' ''questIndex'', '''luaindex''' ''stepIndex'', '''luaindex''' ''conditionIndex'')
+
* {{GitHubSearch|Search=GetVerticalAlignment}} [[GetVerticalAlignment]]()
 +
** '''Returns:''' '''number''' ''align''
-
* AppendQuestEnding('''luaindex''' ''questIndex'')
+
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* AppendUnitName('''string''' ''unitTag'')
+
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
-
* AppendYourCorpse()
+
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontString'')
-
* ClearLines()
+
* {{GitHubSearch|Search=SetHorizontalAlignment}} [[SetHorizontalAlignment]]('''number''' ''align'')
-
* GetOwner()
+
* {{GitHubSearch|Search=SetLineSpacing}} [[SetLineSpacing]]('''number''' ''lineSpacingPixels'')
-
** ''Returns:'' '''object''' ''owner''
+
-
* HideComparativeTooltips()
+
* {{GitHubSearch|Search=SetLinkEnabled}} [[SetLinkEnabled]]('''boolean''' ''linkEnabed'')
-
* SetAbility('''luaindex''' ''aAbilityIndex'', '''bool''' ''aShowBase'')
+
* {{GitHubSearch|Search=SetMaxLineCount}} [[SetMaxLineCount]]('''number''' ''maxLineCount'')
-
* SetAchievement('''integer''' ''aAchievementId'')
+
* {{GitHubSearch|Search=SetMinLineCount}} [[SetMinLineCount]]('''number''' ''minLineCount'')
-
* SetAchievementRewardItem('''integer''' ''aAchievementId'', '''luaindex''' ''aRewardItem'')
+
* {{GitHubSearch|Search=SetModifyTextType}} [[SetModifyTextType]]('''number''' [[Globals#ModifyTextType|ModifyTextType]] ''modifyTextType'')
-
* SetAction('''luaindex''' ''aSlotId'')
+
* {{GitHubSearch|Search=SetNewLineX}} [[SetNewLineX]]('''number''' ''newLineXPixels'')
-
* SetAsComparativeTooltip1()
+
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
-
* SetAsComparativeTooltip2()
+
* {{GitHubSearch|Search=SetStyleColor}} [[SetStyleColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetAttachedMailItem('''id64''' ''aMailId'', '''luaindex''' ''aAttachSlot'')
+
* {{GitHubSearch|Search=SetText}} [[SetText]]('''string''' ''aText'')
-
* SetAttributePassive('''integer''' ''attribute'', '''luaindex''' ''passiveIndex'')
+
* {{GitHubSearch|Search=SetVerticalAlignment}} [[SetVerticalAlignment]]('''number''' ''verticalAlign'')
-
* SetBagItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'')
+
* {{GitHubSearch|Search=SetWrapMode}} [[SetWrapMode]]('''number''' ''wrapMode'')
-
* SetBook('''luaindex''' ''categoryIndex'', '''luaindex''' ''collectionIndex'', '''luaindex''' ''bookIndex'')
+
* {{GitHubSearch|Search=WasTruncated}} [[WasTruncated]]()
 +
** '''Returns:''' '''boolean''' ''wasTruncated''
-
* SetBuff('''integer''' ''aBuffSlotId'', '''string''' ''unitTag'')
 
-
* SetBuybackItem('''luaindex''' ''entryIndex'')
+
===LineControl===
 +
* {{GitHubSearch|Search=GetBlendMode}} [[GetBlendMode]]()
 +
** '''Returns:''' '''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
-
* SetEmperorBonusAbility('''integer''' ''campaignId'', '''integer''' ''alliance'')
+
* {{GitHubSearch|Search=GetColor}} [[GetColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
-
* SetFont('''string''' ''fontStr'')
+
* {{GitHubSearch|Search=GetDesaturation}} [[GetDesaturation]]()
 +
** '''Returns:''' '''number''' ''desaturation''
-
* SetHeaderRowSpacing('''number''' ''spacing'')
+
* {{GitHubSearch|Search=GetTextureCoords}} [[GetTextureCoords]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
-
* SetHeaderVerticalOffset('''number''' ''verticalOffset'')
+
* {{GitHubSearch|Search=GetTextureFileDimensions}} [[GetTextureFileDimensions]]()
 +
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
-
* SetHookPointStoreEntry('''luaindex''' ''hookPointIndex'', '''luaindex''' ''storeIndex'')
+
* {{GitHubSearch|Search=GetTextureFileName}} [[GetTextureFileName]]()
 +
** '''Returns:''' '''string''' ''filename''
-
* SetItemUsingEnchantment('''integer''' ''itemBagIndex'', '''integer''' ''itemSlotIndex'', '''integer''' ''enchantmentBagIndex'', '''integer''' ''enchantmentSlotIndex'')
+
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
-
* SetKeepBonusAbility('''luaindex''' ''bonusIndex'')
+
* {{GitHubSearch|Search=IsTextureLoaded}} [[IsTextureLoaded]]()
 +
** '''Returns:''' '''boolean''' ''loaded''
-
* SetKeepUpgrade('''integer''' ''keepId'', '''integer''' ''battlegroundContext'', '''integer''' ''upgradeLine'', '''integer''' ''level'', '''luaindex''' ''index'')
+
* {{GitHubSearch|Search=SetBlendMode}} [[SetBlendMode]]('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
-
* SetLastCraftingResultItem('''luaindex''' ''resultIndex'')
+
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetLink('''string''' ''aLink'')
+
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
-
* SetLootItem('''integer''' ''lootId'')
+
* {{GitHubSearch|Search=SetGradientColors}} [[SetGradientColors]]('''number''' [[Globals#ControlOrientation|ControlOrientation]] ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
-
* SetMinHeaderRowHeight('''number''' ''minRowHeight'')
+
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
-
* SetMinHeaderRows('''integer''' ''minRows'')
+
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
-
* SetMount('''luaindex''' ''aStableIndex'')
+
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
-
* SetOwner('''object''' ''owner'', '''integer''' ''position'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''integer''' ''relativePoint'')
+
* {{GitHubSearch|Search=SetThickness}} [[SetThickness]]('''number''' ''thickness'')
-
* SetPendingAlchemyItem('''integer''' ''solventBagId'', '''integer''' ''solventSlotIndex'', '''integer''' ''reagent1BagId'', '''integer''' ''reagent1SlotIndex'', '''integer''' ''reagent2BagId'', '''integer''' ''reagent2SlotIndex'', '''integer:nilable''' ''reagent3BagId'', '''integer:nilable''' ''reagent3SlotIndex'')
+
* {{GitHubSearch|Search=SetVertexColors}} [[SetVertexColors]]('''number''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
-
* SetPendingEnchantingItem('''integer''' ''potencyRuneBagId'', '''integer''' ''potencyRuneSlotIndex'', '''integer''' ''essenceRuneBagId'', '''integer''' ''essenceRuneSlotIndex'', '''integer''' ''aspectRuneBagId'', '''integer''' ''aspectRuneSlotIndex'')
 
-
* SetPendingSmithingItem('''luaindex''' ''patternIndex'', '''luaindex''' ''materialIndex'', '''integer''' ''materialQuantity'', '''luaindex''' ''styleIndex'', '''luaindex''' ''traitIndex'')
+
===MapDisplayControl===
 +
* {{GitHubSearch|Search=GetZoom}} [[GetZoom]]()
 +
** '''Returns:''' '''number''' ''normalizedRadius''
-
* SetPlugItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'', '''luaindex''' ''socketIndex'')
+
* {{GitHubSearch|Search=SetPinFont}} [[SetPinFont]]('''string''' ''pinFont'')
-
* SetProgressionAbility('''luaindex''' ''aProgressionIndex'', '''integer''' ''aMorph'', '''integer''' ''aRank'')
+
* {{GitHubSearch|Search=SetZoom}} [[SetZoom]]('''number''' ''normalizedRadius'')
-
* SetProvisionerIngredientItem('''luaindex''' ''recipeListIndex'', '''luaindex''' ''recipeIndex'', '''luaindex''' ''ingredientIndex'')
 
-
* SetProvisionerResultItem('''luaindex''' ''recipeListIndex'', '''luaindex''' ''recipeIndex'')
+
===RootWindow===
-
* SetQuestItem('''luaindex''' ''questIndex'', '''luaindex''' ''stepIndex'', '''luaindex''' ''conditionIndex'')
+
===ScrollControl===
 +
* {{GitHubSearch|Search=GetFadeGradient}} [[GetFadeGradient]]('''number''' ''gradientIndex'')
 +
** '''Returns:''' '''number''' ''normalX'', '''number''' ''normalY'', '''number''' ''gradientLength''
-
* SetQuestReward('''luaindex''' ''aPerkIndex'')
+
* {{GitHubSearch|Search=GetScrollExtents}} [[GetScrollExtents]]()
 +
** '''Returns:''' '''number''' ''horizontal'', '''number''' ''vertical''
-
* SetQuestTool('''luaindex''' ''questIndex'', '''luaindex''' ''toolIndex'')
+
* {{GitHubSearch|Search=GetScrollOffsets}} [[GetScrollOffsets]]()
 +
** '''Returns:''' '''number''' ''horizontal'', '''number''' ''vertical''
-
* SetScrollBonusAbility('''integer''' ''alliance'', '''integer''' ''artifactType'', '''luaindex''' ''bonusIndex'')
+
* {{GitHubSearch|Search=RestoreToExtents}} [[RestoreToExtents]]('''number''' ''duration'')
-
* SetSiegeFire()
+
* {{GitHubSearch|Search=SetFadeGradient}} [[SetFadeGradient]]('''number''' ''gradientIndex'', '''number''' ''normalX'', '''number''' ''normalY'', '''number''' ''gradientLength'')
-
* SetSkillAbility('''integer''' ''skillType'', '''luaindex''' ''skillIndex'', '''luaindex''' ''abilityIndex'')
+
* {{GitHubSearch|Search=SetHorizontalScroll}} [[SetHorizontalScroll]]('''number''' ''offset'')
-
* SetSkillLine('''integer''' ''skillType'', '''luaindex''' ''skillIndex'')
+
* {{GitHubSearch|Search=SetScrollBounding}} [[SetScrollBounding]]('''number''' [[Globals#ScrollBounding|ScrollBounding]] ''bounding'')
-
* SetSkillUpgradeAbility('''integer''' ''skillType'', '''luaindex''' ''skillIndex'', '''luaindex''' ''abilityIndex'')
+
* {{GitHubSearch|Search=SetVerticalScroll}} [[SetVerticalScroll]]('''number''' ''offset'')
-
* SetSmithingImprovementItem('''integer''' ''craftingSkillType'', '''luaindex''' ''improvementItemIndex'')
 
-
* SetSmithingImprovementResult('''integer''' ''itemToImproveBagId'', '''integer''' ''itemToImproveSlotIndex'', '''integer''' ''craftingSkillType'')
+
===SliderControl===
 +
* {{GitHubSearch|Search=DoesAllowDraggingFromThumb}} [[DoesAllowDraggingFromThumb]]()
 +
** '''Returns:''' '''boolean''' ''allow''
-
* SetSmithingMaterialItem('''luaindex''' ''patternIndex'', '''luaindex''' ''materialIndex'')
+
* {{GitHubSearch|Search=GetEnabled}} [[GetEnabled]]()
 +
** '''Returns:''' '''boolean''' ''isEnabled''
-
* SetSmithingStyleItem('''luaindex''' ''styleItemIndex'')
+
* {{GitHubSearch|Search=GetMinMax}} [[GetMinMax]]()
 +
** '''Returns:''' '''number''' ''min'', '''number''' ''max''
-
* SetSmithingTraitItem('''luaindex''' ''traitItemIndex'')
+
* {{GitHubSearch|Search=GetOrientation}} [[GetOrientation]]()
 +
** '''Returns:''' '''number''' ''orientation''
-
* SetSocketingItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'')
+
* {{GitHubSearch|Search=GetThumbTextureControl}} [[GetThumbTextureControl]]()
 +
** '''Returns:''' '''object''' ''textureControl''
-
* SetStoreAlternateCurrencyItem('''luaindex''' ''entryIndex'', '''integer''' ''offset'')
+
* {{GitHubSearch|Search=GetValue}} [[GetValue]]()
 +
** '''Returns:''' '''number''' ''value''
-
* SetStoreItem('''luaindex''' ''entryIndex'')
+
* {{GitHubSearch|Search=GetValueStep}} [[GetValueStep]]()
 +
** '''Returns:''' '''number''' ''step''
-
* SetSynergyBuff('''integer''' ''aBuffSlotId'')
+
* {{GitHubSearch|Search=IsThumbFlushWithExtents}} [[IsThumbFlushWithExtents]]()
 +
** '''Returns:''' '''boolean''' ''flush''
-
* SetTradeItem('''integer''' ''aWho'', '''luaindex''' ''aTradeIndex'')
+
* {{GitHubSearch|Search=SetAllowDraggingFromThumb}} [[SetAllowDraggingFromThumb]]('''boolean''' ''allow'')
-
* SetTradingHouseItem('''luaindex''' ''tradingHouseIndex'')
+
* {{GitHubSearch|Search=SetBackgroundBottomTexture}} [[SetBackgroundBottomTexture]]('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
-
* SetTradingHouseListing('''luaindex''' ''tradingHouseIndex'')
+
* {{GitHubSearch|Search=SetBackgroundMiddleTexture}} [[SetBackgroundMiddleTexture]]('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
-
* SetUnit('''string''' ''aUnitTag'')
+
* {{GitHubSearch|Search=SetBackgroundTopTexture}} [[SetBackgroundTopTexture]]('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
-
* SetWeaponSetAbility('''luaindex''' ''aWeaponSet'', '''integer''' ''aRank'')
+
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetWornItem('''integer''' ''equipSlot'')
+
* {{GitHubSearch|Search=SetEnabled}} [[SetEnabled]]('''boolean''' ''enable'')
-
* ShowComparativeTooltips()
+
* {{GitHubSearch|Search=SetMinMax}} [[SetMinMax]]('''number''' ''min'', '''number''' ''max'')
 +
* {{GitHubSearch|Search=SetOrientation}} [[SetOrientation]]('''number''' ''orientation'')
-
=== TopLevelWindow ===
+
* {{GitHubSearch|Search=SetThumbFlushWithExtents}} [[SetThumbFlushWithExtents]]('''boolean''' ''flush'')
-
* AllowBringToTop()
+
-
** ''Returns:'' '''bool''' ''allow''
+
-
* BringWindowToTop '''protected-attributes''' ()
+
* {{GitHubSearch|Search=SetThumbTexture}} [[SetThumbTexture]]('''string''' ''filename'', '''string''' ''disabledFilename'', '''string''' ''highlightedFilename'', '''number''' ''thumbWidth'', '''number''' ''thumbHeight'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
-
* SetAllowBringToTop '''protected-attributes''' ('''bool''' ''allow'')
+
* {{GitHubSearch|Search=SetThumbTextureHeight}} [[SetThumbTextureHeight]]('''number''' ''height'')
-
* SetDrawWhenGuiHidden '''private''' ('''bool''' ''drawWhenHidden'')
+
* {{GitHubSearch|Search=SetValue}} [[SetValue]]('''number''' ''value'')
-
* SetTopmost '''protected-attributes''' ('''bool''' ''isTopmost'')
+
* {{GitHubSearch|Search=SetValueStep}} [[SetValueStep]]('''number''' ''step'')
-
=== WindowManager (WINDOW_MANAGER) ===
+
===StatusBarControl===
-
* CreateControl('''string''' ''arg1'', '''object''' ''parent'', '''integer''' ''type'')
+
* {{GitHubSearch|Search=ClearFadeOutLossAdjustedTopValue}} [[ClearFadeOutLossAdjustedTopValue]]()
-
** ''Returns:'' '''object''' ''apRet''
+
-
* CreateControlFromVirtual('''string''' ''controlName'', '''object''' ''parent'', '''string''' ''virtualName'')
+
* {{GitHubSearch|Search=EnableFadeOut}} [[EnableFadeOut]]('''boolean''' ''enabled'')
-
** ''Returns:'' '''object''' ''apRet''
+
-
* CreateTopLevelWindow('''string''' ''arg1'')
+
* {{GitHubSearch|Search=EnableLeadingEdge}} [[EnableLeadingEdge]]('''boolean''' ''enabled'')
-
** ''Returns:'' '''object''' ''apRet''
+
-
* GetControlByName('''string''' ''name'', '''string''' ''suffix'')
+
* {{GitHubSearch|Search=EnableScrollingOverlay}} [[EnableScrollingOverlay]]('''boolean''' ''enabled'')
-
** ''Returns:'' '''object''' ''ret''
+
-
* GetFocusControl()
+
* {{GitHubSearch|Search=GetMinMax}} [[GetMinMax]]()
-
** ''Returns:'' '''object''' ''focusControl''
+
** '''Returns:''' '''number''' ''min'', '''number''' ''max''
-
* GetMouseOverControl()
+
* {{GitHubSearch|Search=GetValue}} [[GetValue]]()
-
** ''Returns:'' '''object''' ''mouseOverControl''
+
** '''Returns:''' '''number''' ''value''
-
* IsHandlingHardwareEvent()
+
* {{GitHubSearch|Search=SetBarAlignment}} [[SetBarAlignment]]('''number''' ''barAlignment'')
-
** ''Returns:'' '''bool''' ''isHandlingHardwareEvent''
+
-
* IsMouseOverWorld()
+
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
** ''Returns:'' '''bool''' ''isMouseOverWorld''
+
-
* SetFocusByName('''string''' ''name'')
+
* {{GitHubSearch|Search=SetFadeOutGainColor}} [[SetFadeOutGainColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetMouseCursor('''integer''' ''cursorType'')
+
* {{GitHubSearch|Search=SetFadeOutLossAdjustedTopValue}} [[SetFadeOutLossAdjustedTopValue]]('''number''' ''topValue'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutLossColor}} [[SetFadeOutLossColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutLossSetValueToAdjust}} [[SetFadeOutLossSetValueToAdjust]]('''number''' ''adjustValue'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutTexture}} [[SetFadeOutTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutTime}} [[SetFadeOutTime]]('''number''' ''fadeOutSeconds'', '''number''' ''fadeOutDelaySeconds'')
 +
 
 +
* {{GitHubSearch|Search=SetGradientColors}} [[SetGradientColors]]('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* {{GitHubSearch|Search=SetLeadingEdge}} [[SetLeadingEdge]]('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'')
 +
 
 +
* {{GitHubSearch|Search=SetLeadingEdgeTextureCoords}} [[SetLeadingEdgeTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetMinMax}} [[SetMinMax]]('''number''' ''aMin'', '''number''' ''aMax'')
 +
 
 +
* {{GitHubSearch|Search=SetOrientation}} [[SetOrientation]]('''number''' ''orientation'')
 +
 
 +
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetValue}} [[SetValue]]('''number''' ''aValue'')
 +
 
 +
* {{GitHubSearch|Search=SetupScrollingOverlay}} [[SetupScrollingOverlay]]('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'', '''number''' ''duration'')
 +
 
 +
 
 +
===TextBufferControl===
 +
* {{GitHubSearch|Search=AddMessage}} [[AddMessage]]('''string''' ''aText'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''colorId'')
 +
 
 +
* {{GitHubSearch|Search=Clear}} [[Clear]]()
 +
 
 +
* {{GitHubSearch|Search=GetDrawLastEntryIfOutOfRoom}} [[GetDrawLastEntryIfOutOfRoom]]()
 +
** '''Returns:''' '''boolean''' ''drawLastIfOutOfRoom''
 +
 
 +
* {{GitHubSearch|Search=GetLineFade}} [[GetLineFade]]()
 +
** '''Returns:''' '''number''' ''timeBeforeLineBeginsToFade'', '''number''' ''timeItTakesLineToFade''
 +
 
 +
* {{GitHubSearch|Search=GetLinkEnabled}} [[GetLinkEnabled]]()
 +
** '''Returns:''' '''boolean''' ''linkEnabed''
 +
 
 +
* {{GitHubSearch|Search=GetMaxHistoryLines}} [[GetMaxHistoryLines]]()
 +
** '''Returns:''' '''number''' ''numLines''
 +
 
 +
* {{GitHubSearch|Search=GetNumHistoryLines}} [[GetNumHistoryLines]]()
 +
** '''Returns:''' '''number''' ''numLines''
 +
 
 +
* {{GitHubSearch|Search=GetNumVisibleLines}} [[GetNumVisibleLines]]()
 +
** '''Returns:''' '''number''' ''numLines''
 +
 
 +
* {{GitHubSearch|Search=GetScrollPosition}} [[GetScrollPosition]]()
 +
** '''Returns:''' '''number''' ''scrollPosition''
 +
 
 +
* {{GitHubSearch|Search=IsSplittingLongMessages}} [[IsSplittingLongMessages]]()
 +
** '''Returns:''' '''boolean''' ''isSplitting''
 +
 
 +
* {{GitHubSearch|Search=MoveScrollPosition}} [[MoveScrollPosition]]('''number''' ''numLines'')
 +
 
 +
* {{GitHubSearch|Search=SetClearBufferAfterFadeout}} [[SetClearBufferAfterFadeout]]('''boolean''' ''clearAfterFade'')
 +
 
 +
* {{GitHubSearch|Search=SetColorById}} [[SetColorById]]('''number''' ''colorId'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
 +
 
 +
* {{GitHubSearch|Search=SetDrawLastEntryIfOutOfRoom}} [[SetDrawLastEntryIfOutOfRoom]]('''boolean''' ''drawLastIfOutOfRoom'')
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontString'')
 +
 
 +
* {{GitHubSearch|Search=SetHorizontalAlignment}} [[SetHorizontalAlignment]]('''number''' ''align'')
 +
 
 +
* {{GitHubSearch|Search=SetLineFade}} [[SetLineFade]]('''number''' ''timeBeforeLineFadeBegins'', '''number''' ''timeForLineToFade'')
 +
 
 +
* {{GitHubSearch|Search=SetLinesInheritAlpha}} [[SetLinesInheritAlpha]]('''boolean''' ''linesInheritAlpha'')
 +
 
 +
* {{GitHubSearch|Search=SetLinkEnabled}} [[SetLinkEnabled]]('''boolean''' ''linkEnabed'')
 +
 
 +
* {{GitHubSearch|Search=SetMaxHistoryLines}} [[SetMaxHistoryLines]]('''number''' ''numLines'')
 +
 
 +
* {{GitHubSearch|Search=SetScrollPosition}} [[SetScrollPosition]]('''number''' ''line'')
 +
 
 +
* {{GitHubSearch|Search=SetSplitLongMessages}} [[SetSplitLongMessages]]('''boolean''' ''splitLongMessages'')
 +
 
 +
* {{GitHubSearch|Search=ShowFadedLines}} [[ShowFadedLines]]()
 +
 
 +
 
 +
===TextureCompositeControl===
 +
* {{GitHubSearch|Search=AddSurface}} [[AddSurface]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=ClearAllSurfaces}} [[ClearAllSurfaces]]()
 +
 
 +
* {{GitHubSearch|Search=GetBlendMode}} [[GetBlendMode]]()
 +
** '''Returns:''' '''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
 +
 
 +
* {{GitHubSearch|Search=GetColor}} [[GetColor]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetDesaturation}} [[GetDesaturation]]()
 +
** '''Returns:''' '''number''' ''desaturation''
 +
 
 +
* {{GitHubSearch|Search=GetInsets}} [[GetInsets]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetNumSurfaces}} [[GetNumSurfaces]]()
 +
** '''Returns:''' '''number''' ''surfaces''
 +
 
 +
* {{GitHubSearch|Search=GetSurfaceAlpha}} [[GetSurfaceAlpha]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetTextureCoords}} [[GetTextureCoords]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileDimensions}} [[GetTextureFileDimensions]]()
 +
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileName}} [[GetTextureFileName]]()
 +
** '''Returns:''' '''string''' ''filename''
 +
 
 +
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsSurfaceHidden}} [[IsSurfaceHidden]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''boolean''' ''hidden''
 +
 
 +
* {{GitHubSearch|Search=IsTextureLoaded}} [[IsTextureLoaded]]()
 +
** '''Returns:''' '''boolean''' ''loaded''
 +
 
 +
* {{GitHubSearch|Search=RemoveSurface}} [[RemoveSurface]]('''number''' ''surfaceIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetBlendMode}} [[SetBlendMode]]('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''surfaceIndex'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
 
 +
* {{GitHubSearch|Search=SetInsets}} [[SetInsets]]('''number''' ''surfaceIndex'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* {{GitHubSearch|Search=SetSurfaceAlpha}} [[SetSurfaceAlpha]]('''number''' ''surfaceIndex'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetSurfaceHidden}} [[SetSurfaceHidden]]('''number''' ''surfaceIndex'', '''boolean''' ''hidden'')
 +
 
 +
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''surfaceIndex'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
 
 +
===TextureControl===
 +
* {{GitHubSearch|Search=Get3DLocalDimensions}} [[Get3DLocalDimensions]]()
 +
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
 +
 
 +
* {{GitHubSearch|Search=GetAddressMode}} [[GetAddressMode]]()
 +
** '''Returns:''' '''number''' [[Globals#TextureAddressMode|TextureAddressMode]] ''addressMode''
 +
 
 +
* {{GitHubSearch|Search=GetBlendMode}} [[GetBlendMode]]()
 +
** '''Returns:''' '''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
 +
 
 +
* {{GitHubSearch|Search=GetColor}} [[GetColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetDesaturation}} [[GetDesaturation]]()
 +
** '''Returns:''' '''number''' ''desaturation''
 +
 
 +
* {{GitHubSearch|Search=GetResizeToFitFile}} [[GetResizeToFitFile]]()
 +
** '''Returns:''' '''boolean''' ''resizesToFitFile''
 +
 
 +
* {{GitHubSearch|Search=GetShaderEffectType}} [[GetShaderEffectType]]()
 +
** '''Returns:''' '''number''' [[Globals#ShaderEffectType|ShaderEffectType]] ''shaderEffectType''
 +
 
 +
* {{GitHubSearch|Search=GetTextureCoords}} [[GetTextureCoords]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileDimensions}} [[GetTextureFileDimensions]]()
 +
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileName}} [[GetTextureFileName]]()
 +
** '''Returns:''' '''string''' ''filename''
 +
 
 +
* {{GitHubSearch|Search=GetVertexUV}} [[GetVertexUV]]('''number''' [[Globals#VERTEX_POINTS|VERTEX_POINTS]] ''vertex'')
 +
** '''Returns:''' '''number''' ''u'', '''number''' ''v''
 +
 
 +
* {{GitHubSearch|Search=Is3DQuadFacingCamera}} [[Is3DQuadFacingCamera]]()
 +
** '''Returns:''' '''boolean''' ''isFacing''
 +
 
 +
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsTextureLoaded}} [[IsTextureLoaded]]()
 +
** '''Returns:''' '''boolean''' ''loaded''
 +
 
 +
* {{GitHubSearch|Search=Set3DLocalDimensions}} [[Set3DLocalDimensions]]('''number''' ''width'', '''number''' ''height'')
 +
 
 +
* {{GitHubSearch|Search=SetAddressMode}} [[SetAddressMode]]('''number''' [[Globals#TextureAddressMode|TextureAddressMode]] ''addressMode'')
 +
 
 +
* {{GitHubSearch|Search=SetAutoAdjustWrappedCoords}} [[SetAutoAdjustWrappedCoords]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetBlendMode}} [[SetBlendMode]]('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
 
 +
* {{GitHubSearch|Search=SetGradientColors}} [[SetGradientColors]]('''number''' [[Globals#ControlOrientation|ControlOrientation]] ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* {{GitHubSearch|Search=SetResizeToFitFile}} [[SetResizeToFitFile]]('''boolean''' ''resizesToFitFile'')
 +
 
 +
* {{GitHubSearch|Search=SetShaderEffectType}} [[SetShaderEffectType]]('''number''' [[Globals#ShaderEffectType|ShaderEffectType]] ''shaderEffectType'')
 +
 
 +
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoordsRotation}} [[SetTextureCoordsRotation]]('''number''' ''angleInRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureRotation}} [[SetTextureRotation]]('''number''' ''angleInRadians'', '''number''' ''normalizedRotationPointX'', '''number''' ''normalizedRotationPointY'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureSampleProcessingWeight}} [[SetTextureSampleProcessingWeight]]('''number''' [[Globals#TextureSampleProcessing|TextureSampleProcessing]] ''sampleProcessingType'', '''number''' ''weight'')
 +
 
 +
* {{GitHubSearch|Search=SetVertexColors}} [[SetVertexColors]]('''number''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
 +
 
 +
* {{GitHubSearch|Search=SetVertexUV}} [[SetVertexUV]]('''number''' [[Globals#VERTEX_POINTS|VERTEX_POINTS]] ''vertex'', '''number''' ''u'', '''number''' ''v'')
 +
 
 +
 
 +
===TooltipControl===
 +
* {{GitHubSearch|Search=AddControl}} [[AddControl]]('''object''' ''control'', '''number''' ''cell'', '''boolean''' ''useLastRow'')
 +
 
 +
* {{GitHubSearch|Search=AddHeaderControl}} [[AddHeaderControl]]('''object''' ''control'', '''number''' ''headerRow'', '''number''' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'')
 +
 
 +
* {{GitHubSearch|Search=AddHeaderLine}} [[AddHeaderLine]]('''string''' ''text'', '''string''' ''font'', '''number''' ''headerRow'', '''number''' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
 +
 
 +
* {{GitHubSearch|Search=AddLine}} [[AddLine]]('''string''' ''text'', '''string''' ''font'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' [[Globals#AnchorPosition|AnchorPosition]] ''lineAnchor'', '''number''' [[Globals#ModifyTextType|ModifyTextType]] ''modifyTextType'', '''number''' [[Globals#TextAlignment|TextAlignment]] ''textAlignment'', '''boolean''' ''setToFullSize'', '''number''' ''minWidth'')
 +
 
 +
* {{GitHubSearch|Search=AddVerticalPadding}} [[AddVerticalPadding]]('''number''' ''paddingY'')
 +
 
 +
* {{GitHubSearch|Search=AppendAvAObjective}} [[AppendAvAObjective]]('''number''' ''queryType'', '''number''' ''keepId'', '''number''' ''objectiveId'', '''number''' [[Globals#ObjectivePinTier|ObjectivePinTier]] ''objectivePinTier'')
 +
 
 +
* {{GitHubSearch|Search=AppendMapPing}} [[AppendMapPing]]('''number''' ''pingType'', '''string''' ''unitTag'')
 +
 
 +
* {{GitHubSearch|Search=AppendQuestCondition}} [[AppendQuestCondition]]('''number''' ''questIndex'', '''number''' ''stepIndex'', '''number''' ''conditionIndex'')
 +
 
 +
* {{GitHubSearch|Search=AppendQuestEnding}} [[AppendQuestEnding]]('''number''' ''questIndex'')
 +
 
 +
* {{GitHubSearch|Search=AppendUnitName}} [[AppendUnitName]]('''string''' ''unitTag'')
 +
 
 +
* {{GitHubSearch|Search=ClearLines}} [[ClearLines]]()
 +
 
 +
* {{GitHubSearch|Search=GetOwner}} [[GetOwner]]()
 +
** '''Returns:''' '''object''' ''owner''
 +
 
 +
* {{GitHubSearch|Search=HideComparativeTooltips}} [[HideComparativeTooltips]]()
 +
 
 +
* {{GitHubSearch|Search=SetAbility}} [[SetAbility]]('''number''' ''aAbilityIndex'', '''boolean''' ''aShowBase'')
 +
 
 +
* {{GitHubSearch|Search=SetAbilityId}} [[SetAbilityId]]('''number''' ''abilityId'')
 +
 
 +
* {{GitHubSearch|Search=SetAchievement}} [[SetAchievement]]('''number''' ''aAchievementId'')
 +
 
 +
* {{GitHubSearch|Search=SetAchievementRewardItem}} [[SetAchievementRewardItem]]('''number''' ''aAchievementId'')
 +
 
 +
* {{GitHubSearch|Search=SetAction}} [[SetAction]]('''number''' ''aSlotId'')
 +
 
 +
* {{GitHubSearch|Search=SetActiveSkill}} [[SetActiveSkill]]('''number''' [[Globals#SkillType|SkillType]] ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillIndex'', '''number''' [[Globals#MorphSlot|MorphSlot]] ''morphSlot'', '''boolean''' ''isPurchased'', '''boolean''' ''isAdvised'', '''boolean''' ''isBadMorph'', '''number''' ''numAvailableSkillPoints'', '''boolean''' ''showSkillPointCost'', '''boolean''' ''showUpgradeText'', '''boolean''' ''showAdvised'', '''boolean''' ''showBadMorph'', '''number:nilable''' ''overrideRank'', '''number:nilable''' ''overrideAbilityId'')
 +
 
 +
* {{GitHubSearch|Search=SetAsComparativeTooltip1}} [[SetAsComparativeTooltip1]]()
 +
 
 +
* {{GitHubSearch|Search=SetAsComparativeTooltip2}} [[SetAsComparativeTooltip2]]()
 +
 
 +
* {{GitHubSearch|Search=SetAttachedMailItem}} [[SetAttachedMailItem]]('''id64''' ''aMailId'', '''number''' ''aAttachSlot'')
 +
 
 +
* {{GitHubSearch|Search=SetBagItem}} [[SetBagItem]]('''number''' [[Globals#Bag|Bag]] ''bagIndex'', '''number''' ''slotIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetBook}} [[SetBook]]('''number''' ''categoryIndex'', '''number''' ''collectionIndex'', '''number''' ''bookIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetBuff}} [[SetBuff]]('''number''' ''aBuffSlotId'', '''string''' ''unitTag'')
 +
 
 +
* {{GitHubSearch|Search=SetBuybackItem}} [[SetBuybackItem]]('''number''' ''entryIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetChampionSkillAbility}} [[SetChampionSkillAbility]]('''number''' ''disiplineIndex'', '''number''' ''skillIndex'', '''number''' ''numPendingPoints'')
 +
 
 +
* {{GitHubSearch|Search=SetCollectible}} [[SetCollectible]]('''number''' ''collectibleId'', '''boolean''' ''addNickname'', '''boolean''' ''showPurchasableHint'', '''boolean''' ''showBlockReason'')
 +
 
 +
* {{GitHubSearch|Search=SetCurrency}} [[SetCurrency]]('''number''' [[Globals#CurrencyType|CurrencyType]] ''currencyType'', '''number''' ''quantity'')
 +
 
 +
* {{GitHubSearch|Search=SetDailyLoginRewardEntry}} [[SetDailyLoginRewardEntry]]('''number''' ''rewardIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetEdgeKeepBonusAbility}} [[SetEdgeKeepBonusAbility]]('''number''' ''bonusIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetEmperorBonusAbility}} [[SetEmperorBonusAbility]]('''number''' ''campaignId'', '''number''' [[Globals#Alliance|Alliance]] ''alliance'')
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontStr'')
 +
 
 +
* {{GitHubSearch|Search=SetGuildSpecificItem}} [[SetGuildSpecificItem]]('''number''' ''guildSpecificItemIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetHeaderRowSpacing}} [[SetHeaderRowSpacing]]('''number''' ''spacing'')
 +
 
 +
* {{GitHubSearch|Search=SetHeaderVerticalOffset}} [[SetHeaderVerticalOffset]]('''number''' ''verticalOffset'')
 +
 
 +
* {{GitHubSearch|Search=SetItemUsingEnchantment}} [[SetItemUsingEnchantment]]('''number''' [[Globals#Bag|Bag]] ''itemBagIndex'', '''number''' ''itemSlotIndex'', '''number''' [[Globals#Bag|Bag]] ''enchantmentBagIndex'', '''number''' ''enchantmentSlotIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetKeepBonusAbility}} [[SetKeepBonusAbility]]('''number''' ''bonusIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetKeepUpgrade}} [[SetKeepUpgrade]]('''number''' ''keepId'', '''number''' [[Globals#BattlegroundQueryContextType|BattlegroundQueryContextType]] ''battlegroundContext'', '''number''' ''upgradeLine'', '''number''' ''level'', '''number''' ''index'')
 +
 
 +
* {{GitHubSearch|Search=SetLastCraftingResultItem}} [[SetLastCraftingResultItem]]('''number''' ''resultIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetLink}} [[SetLink]]('''string''' ''aLink'')
 +
 
 +
* {{GitHubSearch|Search=SetLootItem}} [[SetLootItem]]('''number''' ''lootId'')
 +
 
 +
* {{GitHubSearch|Search=SetMarketProduct}} [[SetMarketProduct]]('''number''' ''marketProductId'', '''boolean''' ''showCollectiblePurchasableHint'')
 +
 
 +
* {{GitHubSearch|Search=SetMarketProductListing}} [[SetMarketProductListing]]('''number''' ''marketProductId'', '''number:nilable''' ''presentationIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetMinHeaderRowHeight}} [[SetMinHeaderRowHeight]]('''number''' ''minRowHeight'')
 +
 
 +
* {{GitHubSearch|Search=SetMinHeaderRows}} [[SetMinHeaderRows]]('''number''' ''minRows'')
 +
 
 +
* {{GitHubSearch|Search=SetOwner}} [[SetOwner]]('''object''' ''owner'', '''number''' ''position'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' ''relativePoint'')
 +
 
 +
* {{GitHubSearch|Search=SetPassiveSkill}} [[SetPassiveSkill]]('''number''' [[Globals#SkillType|SkillType]] ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillIndex'', '''number''' ''rank'', '''number''' ''purchasedToRank'', '''number''' ''numAvailableSkillPoints'', '''boolean''' ''showSkillPointCost'')
 +
 
 +
* {{GitHubSearch|Search=SetPendingAlchemyItem}} [[SetPendingAlchemyItem]]('''number''' [[Globals#Bag|Bag]] ''solventBagId'', '''number''' ''solventSlotIndex'', '''number''' [[Globals#Bag|Bag]] ''reagent1BagId'', '''number''' ''reagent1SlotIndex'', '''number''' [[Globals#Bag|Bag]] ''reagent2BagId'', '''number''' ''reagent2SlotIndex'', '''number:nilable''' [[Globals#Bag|Bag]] ''reagent3BagId'', '''number:nilable''' ''reagent3SlotIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetPendingEnchantingItem}} [[SetPendingEnchantingItem]]('''number''' [[Globals#Bag|Bag]] ''potencyRuneBagId'', '''number''' ''potencyRuneSlotIndex'', '''number''' [[Globals#Bag|Bag]] ''essenceRuneBagId'', '''number''' ''essenceRuneSlotIndex'', '''number''' [[Globals#Bag|Bag]] ''aspectRuneBagId'', '''number''' ''aspectRuneSlotIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetPendingRetraitItem}} [[SetPendingRetraitItem]]('''number''' [[Globals#Bag|Bag]] ''bagIndex'', '''number''' ''slotIndex'', '''number''' [[Globals#ItemTraitType|ItemTraitType]] ''pendingTrait'')
 +
 
 +
* {{GitHubSearch|Search=SetPendingSmithingItem}} [[SetPendingSmithingItem]]('''number''' ''patternIndex'', '''number''' ''materialIndex'', '''number''' ''materialQuantity'', '''number''' ''itemStyleId'', '''number''' ''traitIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetPlacedFurniture}} [[SetPlacedFurniture]]('''id64''' ''placedFurnitureId'')
 +
 
 +
* {{GitHubSearch|Search=SetProgressionAbility}} [[SetProgressionAbility]]('''number''' ''aProgressionIndex'', '''number''' ''aMorph'', '''number''' ''aRank'', '''boolean''' ''aShowAdvice'', '''boolean''' ''aAdvised'')
 +
 
 +
* {{GitHubSearch|Search=SetProvisionerIngredientItem}} [[SetProvisionerIngredientItem]]('''number''' ''recipeListIndex'', '''number''' ''recipeIndex'', '''number''' ''ingredientIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetProvisionerResultItem}} [[SetProvisionerResultItem]]('''number''' ''recipeListIndex'', '''number''' ''recipeIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetQuestItem}} [[SetQuestItem]]('''number''' ''questIndex'', '''number''' ''stepIndex'', '''number''' ''conditionIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetQuestReward}} [[SetQuestReward]]('''number''' ''aPerkIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetQuestTool}} [[SetQuestTool]]('''number''' ''questIndex'', '''number''' ''toolIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetReward}} [[SetReward]]('''number''' ''rewardId'', '''number''' ''quantity'')
 +
 
 +
* {{GitHubSearch|Search=SetScrollBonusAbility}} [[SetScrollBonusAbility]]('''number''' [[Globals#Alliance|Alliance]] ''alliance'', '''number''' [[Globals#ObjectiveType|ObjectiveType]] ''artifactType'', '''number''' ''bonusIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSkillAbility}} [[SetSkillAbility]]('''number''' ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillIndex'', '''boolean''' ''badMorph'')
 +
 
 +
* {{GitHubSearch|Search=SetSkillLine}} [[SetSkillLine]]('''number''' ''skillType'', '''number''' ''skillLineIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSkillLineAbilityId}} [[SetSkillLineAbilityId]]('''number''' ''abilityId'', '''number''' [[Globals#SkillType|SkillType]] ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillLineAbilityIndex'', '''number''' ''morphChoice'')
 +
 
 +
* {{GitHubSearch|Search=SetSkillUpgradeAbility}} [[SetSkillUpgradeAbility]]('''number''' ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingImprovementItem}} [[SetSmithingImprovementItem]]('''number''' ''craftingSkillType'', '''number''' ''improvementItemIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingImprovementResult}} [[SetSmithingImprovementResult]]('''number''' [[Globals#Bag|Bag]] ''itemToImproveBagId'', '''number''' ''itemToImproveSlotIndex'', '''number''' ''craftingSkillType'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingMaterialItem}} [[SetSmithingMaterialItem]]('''number''' ''patternIndex'', '''number''' ''materialIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingStyleItem}} [[SetSmithingStyleItem]]('''number''' ''itemStyleId'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingTraitItem}} [[SetSmithingTraitItem]]('''number''' ''traitItemIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetStoreItem}} [[SetStoreItem]]('''number''' ''entryIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetTradeItem}} [[SetTradeItem]]('''number''' ''aWho'', '''number''' ''aTradeIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetTradingHouseItem}} [[SetTradingHouseItem]]('''number''' ''tradingHouseIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetTradingHouseListing}} [[SetTradingHouseListing]]('''number''' ''tradingHouseIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalPadding}} [[SetVerticalPadding]]('''number''' ''paddingY'')
 +
 
 +
* {{GitHubSearch|Search=SetWornItem}} [[SetWornItem]]('''number''' ''equipSlot'')
 +
 
 +
* {{GitHubSearch|Search=ShowComparativeTooltips}} [[ShowComparativeTooltips]]()
 +
 
 +
 
 +
===TopLevelWindow===
 +
* {{GitHubSearch|Search=AllowBringToTop}} [[AllowBringToTop]]()
 +
** '''Returns:''' '''boolean''' ''allow''
 +
 
 +
* {{GitHubSearch|Search=BringWindowToTop}} {{Protected_attributes}} [[BringWindowToTop]]()
 +
 
 +
* {{GitHubSearch|Search=SetAllowBringToTop}} {{Protected_attributes}} [[SetAllowBringToTop]]('''boolean''' ''allow'')
 +
 
 +
* {{GitHubSearch|Search=SetDrawWhenGuiHidden}} {{Private function}} [[SetDrawWhenGuiHidden]]('''boolean''' ''drawWhenHidden'')
 +
 
 +
* {{GitHubSearch|Search=SetTopmost}} [[SetTopmost]]('''boolean''' ''isTopmost'')
 +
 
 +
 
 +
===WindowManager===
 +
* {{GitHubSearch|Search=ApplyTemplateToControl}} [[ApplyTemplateToControl]]('''object''' ''control'', '''string''' ''virtualName'')
 +
 
 +
* {{GitHubSearch|Search=CompareControlVisualOrder}} [[CompareControlVisualOrder]]('''object''' ''controlA'', '''object''' ''controlB'')
 +
** '''Returns:''' '''number''' ''order''
 +
 
 +
* {{GitHubSearch|Search=CreateControl}} [[CreateControl]]('''string''' ''name'', '''object''' ''parent'', '''number''' [[Globals#ControlType|ControlType]] ''type'')
 +
** '''Returns:''' '''object''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=CreateControlFromVirtual}} [[CreateControlFromVirtual]]('''string''' ''controlName'', '''object''' ''parent'', '''string''' ''virtualName'', '''string''' ''optionalSuffix'')
 +
** '''Returns:''' '''object''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=CreateTopLevelWindow}} [[CreateTopLevelWindow]]('''string''' ''name'')
 +
** '''Returns:''' '''object''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=GetControlByName}} [[GetControlByName]]('''string''' ''name'', '''string''' ''suffix'')
 +
** '''Returns:''' '''object''' ''ret''
 +
 
 +
* {{GitHubSearch|Search=GetFocusControl}} [[GetFocusControl]]()
 +
** '''Returns:''' '''object''' ''focusControl''
 +
 
 +
* {{GitHubSearch|Search=GetHandler}} [[GetHandler]]('''string''' ''handlerName'')
 +
** '''Returns:''' '''function''' ''functionRef''
 +
 
 +
* {{GitHubSearch|Search=GetIMECandidate}} [[GetIMECandidate]]('''number''' ''index'')
 +
** '''Returns:''' '''string''' ''candidate''
 +
 
 +
* {{GitHubSearch|Search=GetIMECandidatePageInfo}} [[GetIMECandidatePageInfo]]()
 +
** '''Returns:''' '''number''' ''selectedIndex'', '''number''' ''pageStartIndex'', '''number''' ''pageSize''
 +
 
 +
* {{GitHubSearch|Search=GetMouseOverControl}} [[GetMouseOverControl]]()
 +
** '''Returns:''' '''object''' ''mouseOverControl''
 +
 
 +
* {{GitHubSearch|Search=GetNumIMECandidates}} [[GetNumIMECandidates]]()
 +
** '''Returns:''' '''number''' ''numCandidates''
 +
 
 +
* {{GitHubSearch|Search=IsChoosingIMECandidate}} [[IsChoosingIMECandidate]]()
 +
** '''Returns:''' '''boolean''' ''isChoosingCandidate''
 +
 
 +
* {{GitHubSearch|Search=IsHandlingHardwareEvent}} [[IsHandlingHardwareEvent]]()
 +
** '''Returns:''' '''boolean''' ''isHandlingHardwareEvent''
 +
 
 +
* {{GitHubSearch|Search=IsMouseOverWorld}} [[IsMouseOverWorld]]()
 +
** '''Returns:''' '''boolean''' ''isMouseOverWorld''
 +
 
 +
* {{GitHubSearch|Search=IsSecureRenderModeEnabled}} [[IsSecureRenderModeEnabled]]()
 +
** '''Returns:''' '''boolean''' ''secureRenderModeEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsUsingCustomCandidateList}} [[IsUsingCustomCandidateList]]()
 +
** '''Returns:''' '''boolean''' ''isUsingCustomCandidateList''
 +
 
 +
* {{GitHubSearch|Search=SetFocusByName}} [[SetFocusByName]]('''string''' ''name'')
 +
 
 +
* {{GitHubSearch|Search=SetHandler}} [[SetHandler]]('''string''' ''handlerName'', '''function''' ''functionRef'')
 +
 
 +
* {{GitHubSearch|Search=SetMouseCursor}} [[SetMouseCursor]]('''number''' ''cursorType'')
 +
 
 +
* {{GitHubSearch|Search=SetMouseFocusByName}} [[SetMouseFocusByName]]('''string''' ''name'')
 +
 
 +
* {{GitHubSearch|Search=GetWindowManager}} [[GetWindowManager]]()
 +
** '''Returns:''' '''object''' ''apRetWindowManager''
 +
 
 +
* {{GitHubSearch|Search=MouseIsOver}} [[MouseIsOver]]('''object''' ''control'', '''number''' ''leftOffset'', '''number''' ''topOffset'', '''number''' ''rightOffset'', '''number''' ''bottomOffset'')
 +
** '''Returns:''' '''boolean''' ''isOver''
 +
 
 +
* {{GitHubSearch|Search=MouseIsInside}} [[MouseIsInside]]('''object''' ''control'', '''number''' ''leftOffset'', '''number''' ''topOffset'', '''number''' ''rightOffset'', '''number''' ''bottomOffset'')
 +
** '''Returns:''' '''boolean''' ''isInside''
 +
 
 +
* {{GitHubSearch|Search=GetUIMousePosition}} [[GetUIMousePosition]]()
 +
** '''Returns:''' '''number''' ''x'', '''number''' ''y''
 +
 
 +
* {{GitHubSearch|Search=GetUIMouseDeltas}} [[GetUIMouseDeltas]]()
 +
** '''Returns:''' '''number''' ''deltaX'', '''number''' ''deltaY''
 +
 
 +
* {{GitHubSearch|Search=GetUIGlobalScale}} [[GetUIGlobalScale]]()
 +
** '''Returns:''' '''number''' ''scale''
 +
 
 +
* {{GitHubSearch|Search=GetUICustomScale}} [[GetUICustomScale]]()
 +
** '''Returns:''' '''number''' ''scale''
 +
 
 +
* {{GitHubSearch|Search=LuaWarning}} [[LuaWarning]]('''string''' ''message'')
 +
 
 +
* {{GitHubSearch|Search=LocalizeString}} [[LocalizeString]]('''string''' ''formatString'', '''string''' ''arg1'', '''string''' ''arg2'', '''string''' ''arg3'', '''string''' ''arg4'', '''string''' ''arg5'', '''string''' ''arg6'')
 +
** '''Returns:''' '''string''' ''localizedString''
 +
 
 +
* {{GitHubSearch|Search=GetAnimationManager}} [[GetAnimationManager]]()
 +
** '''Returns:''' '''object''' ''apRetAnimationManager''
 +
 
 +
* {{GitHubSearch|Search=GetAddOnManager}} [[GetAddOnManager]]()
 +
** '''Returns:''' '''object''' ''addOnManager''
 +
 
 +
* {{GitHubSearch|Search=RedirectTexture}} [[RedirectTexture]]('''string''' ''originalTexture'', '''string''' ''newTexture'')
 +
 
 +
* {{GitHubSearch|Search=EscapeMarkup}} [[EscapeMarkup]]('''string''' ''text'', '''number''' [[Globals#AllowMarkupType|AllowMarkupType]] ''allowMarkupType'')
 +
** '''Returns:''' '''string''' ''escapedText''
 +
 
 +
* {{GitHubSearch|Search=CreateFont}} [[CreateFont]]('''string''' ''fontSymbolName'', '''string''' ''fontDescriptor'')
 +
** '''Returns:''' '''object''' ''fontObject''
 +
 
 +
* {{GitHubSearch|Search=GetNumControlCreatingSources}} [[GetNumControlCreatingSources]]()
 +
** '''Returns:''' '''number''' ''numFiles''
 +
 
 +
* {{GitHubSearch|Search=GetControlCreatingSourceName}} [[GetControlCreatingSourceName]]('''number''' ''index'')
 +
** '''Returns:''' '''string''' ''sourceName''
 +
 
 +
* {{GitHubSearch|Search=GetNumControlCreatingSourceCallSites}} [[GetNumControlCreatingSourceCallSites]]('''string''' ''sourceName'')
 +
** '''Returns:''' '''number''' ''numCallSites''
 +
 
 +
* {{GitHubSearch|Search=GetControlCreatingSourceCallSiteInfo}} [[GetControlCreatingSourceCallSiteInfo]]('''string''' ''sourceName'', '''number''' ''index'')
 +
** '''Returns:''' '''string''' ''creationStack'', '''number''' ''count''
 +
 
 +
* {{GitHubSearch|Search=StartScriptProfiler}} [[StartScriptProfiler]]()
 +
 
 +
* {{GitHubSearch|Search=StopScriptProfiler}} [[StopScriptProfiler]]()
 +
 
 +
* {{GitHubSearch|Search=IsScriptProfilerEnabled}} [[IsScriptProfilerEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerNumFrames}} [[GetScriptProfilerNumFrames]]()
 +
** '''Returns:''' '''number''' ''numFrames''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerFrameNumRecords}} [[GetScriptProfilerFrameNumRecords]]('''number''' ''frameIndex'')
 +
** '''Returns:''' '''number''' ''numRecords''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerRecordInfo}} [[GetScriptProfilerRecordInfo]]('''number''' ''frameIndex'', '''number''' ''recordIndex'')
 +
** '''Returns:''' '''number''' ''recordDataIndex'', '''number''' ''startTimeNS'', '''number''' ''endTimeNS'', '''number:nilable''' ''callerRecordIndex'', '''number''' [[Globals#ScriptProfilerRecordDataType|ScriptProfilerRecordDataType]] ''recordDataType''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerNumClosures}} [[GetScriptProfilerNumClosures]]()
 +
** '''Returns:''' '''number''' ''numClosures''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerClosureInfo}} [[GetScriptProfilerClosureInfo]]('''number''' ''recordDataIndex'')
 +
** '''Returns:''' '''string''' ''displayName'', '''string''' ''fileName'', '''number''' ''fileLineNumber''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerNumCFunctions}} [[GetScriptProfilerNumCFunctions]]()
 +
** '''Returns:''' '''number''' ''numCFunctions''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerCFunctionInfo}} [[GetScriptProfilerCFunctionInfo]]('''number''' ''recordDataIndex'')
 +
** '''Returns:''' '''string''' ''functionName''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerNumGarbageCollectionTypes}} [[GetScriptProfilerNumGarbageCollectionTypes]]()
 +
** '''Returns:''' '''number''' ''numGarbageCollectionTypes''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerGarbageCollectionInfo}} [[GetScriptProfilerGarbageCollectionInfo]]('''number''' ''recordDataIndex'')
 +
** '''Returns:''' '''number''' [[Globals#ScriptProfilerGarbageCollectionType|ScriptProfilerGarbageCollectionType]] ''GarbageCollectionType''
 +
 
 +
* {{GitHubSearch|Search=RecordScriptProfilerUserEvent}} [[RecordScriptProfilerUserEvent]]('''string''' ''userEventData'')
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerNumUserEvents}} [[GetScriptProfilerNumUserEvents]]()
 +
** '''Returns:''' '''number''' ''numUserEvents''
 +
 
 +
* {{GitHubSearch|Search=GetScriptProfilerUserEventInfo}} [[GetScriptProfilerUserEventInfo]]('''number''' ''recordDataIndex'')
 +
** '''Returns:''' '''string''' ''userEventData''
 +
 
 +
* {{GitHubSearch|Search=GetMinUICanvasWidth}} [[GetMinUICanvasWidth]]()
 +
** '''Returns:''' '''number''' ''minWidth''
 +
 
 +
* {{GitHubSearch|Search=GetMinUICanvasHeight}} [[GetMinUICanvasHeight]]()
 +
** '''Returns:''' '''number''' ''minHeight''
 +
 
 +
* {{GitHubSearch|Search=CopyToClipboard}} {{Private function}} [[CopyToClipboard]]('''string''' ''text'')
 +
 
 +
===AnimationManager===
 +
* {{GitHubSearch|Search=CreateTimeline}} [[CreateTimeline]]()
 +
** '''Returns:''' '''object''' ''timeline''
 +
 
 +
* {{GitHubSearch|Search=CreateTimelineFromVirtual}} [[CreateTimelineFromVirtual]]('''string''' ''timelineName'', '''object''' ''animatedControl'')
 +
** '''Returns:''' '''object''' ''timeline''
 +
 
 +
 
 +
===AnimationObject===
 +
Objects that inherit behavior from '''AnimationObject'''
 +
* [[Controls#AnimationObject3DRotate|AnimationObject3DRotate]]
 +
* [[Controls#AnimationObject3DTranslate|AnimationObject3DTranslate]]
 +
* [[Controls#AnimationObjectAlpha|AnimationObjectAlpha]]
 +
* [[Controls#AnimationObjectColor|AnimationObjectColor]]
 +
* [[Controls#AnimationObjectCustom|AnimationObjectCustom]]
 +
* [[Controls#AnimationObjectScale|AnimationObjectScale]]
 +
* [[Controls#AnimationObjectScroll|AnimationObjectScroll]]
 +
* [[Controls#AnimationObjectSize|AnimationObjectSize]]
 +
* [[Controls#AnimationObjectTexture|AnimationObjectTexture]]
 +
* [[Controls#AnimationObjectTextureRotate|AnimationObjectTextureRotate]]
 +
* [[Controls#AnimationObjectTextureSlide|AnimationObjectTextureSlide]]
 +
* [[Controls#AnimationObjectTranslate|AnimationObjectTranslate]]
 +
 
 +
 
 +
* {{GitHubSearch|Search=GetAnimatedControl}} [[GetAnimatedControl]]()
 +
** '''Returns:''' '''object''' ''animatedControl''
 +
 
 +
* {{GitHubSearch|Search=GetApplyToChildControlName}} [[GetApplyToChildControlName]]()
 +
** '''Returns:''' '''string''' ''applyToChildControlName''
 +
 
 +
* {{GitHubSearch|Search=GetDuration}} [[GetDuration]]()
 +
** '''Returns:''' '''number''' ''durationMs''
 +
 
 +
* {{GitHubSearch|Search=GetEasingFunction}} [[GetEasingFunction]]()
 +
** '''Returns:''' '''function''' ''functionRef''
 +
 
 +
* {{GitHubSearch|Search=GetHandler}} [[GetHandler]]('''string''' ''EventName'')
 +
** '''Returns:''' '''function''' ''FunctionRef''
 +
 
 +
* {{GitHubSearch|Search=GetTimeline}} [[GetTimeline]]()
 +
** '''Returns:''' '''object''' ''owningTimeline''
 +
 
 +
* {{GitHubSearch|Search=IsEnabled}} [[IsEnabled]]()
 +
** '''Returns:''' '''boolean''' ''isEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsPlaying}} [[IsPlaying]]()
 +
** '''Returns:''' '''boolean''' ''isPlaying''
 +
 
 +
* {{GitHubSearch|Search=SetAnimatedControl}} [[SetAnimatedControl]]('''object''' ''animatedControl'')
 +
 
 +
* {{GitHubSearch|Search=SetApplyToChildControlName}} [[SetApplyToChildControlName]]('''string''' ''applyToChildControlName'')
 +
 
 +
* {{GitHubSearch|Search=SetDuration}} [[SetDuration]]('''number''' ''durationMs'')
 +
 
 +
* {{GitHubSearch|Search=SetEasingFunction}} [[SetEasingFunction]]('''function''' ''functionRef'')
 +
 
 +
* {{GitHubSearch|Search=SetEnabled}} [[SetEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetHandler}} [[SetHandler]]('''string''' ''EventName'', '''function''' ''FunctionRef'')
 +
 
 +
 
 +
===AnimationObject3DRotate===
 +
* {{GitHubSearch|Search=GetEndPitch}} [[GetEndPitch]]()
 +
** '''Returns:''' '''number''' ''endPitchRadians''
 +
 
 +
* {{GitHubSearch|Search=GetEndRoll}} [[GetEndRoll]]()
 +
** '''Returns:''' '''number''' ''endRollRadians''
 +
 
 +
* {{GitHubSearch|Search=GetEndYaw}} [[GetEndYaw]]()
 +
** '''Returns:''' '''number''' ''endYawRadians''
 +
 
 +
* {{GitHubSearch|Search=GetStartPitch}} [[GetStartPitch]]()
 +
** '''Returns:''' '''number''' ''startPitchRadians''
 +
 
 +
* {{GitHubSearch|Search=GetStartRoll}} [[GetStartRoll]]()
 +
** '''Returns:''' '''number''' ''startRollRadians''
 +
 
 +
* {{GitHubSearch|Search=GetStartYaw}} [[GetStartYaw]]()
 +
** '''Returns:''' '''number''' ''startYawRadians''
 +
 
 +
* {{GitHubSearch|Search=SetEndPitch}} [[SetEndPitch]]('''number''' ''endPitchRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetEndRoll}} [[SetEndRoll]]('''number''' ''endRollRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetEndYaw}} [[SetEndYaw]]('''number''' ''endYawRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetRotationValues}} [[SetRotationValues]]('''number''' ''startPitchRadians'', '''number''' ''startYawRadians'', '''number''' ''startRollRadians'', '''number''' ''endPitchRadians'', '''number''' ''endYawRadians'', '''number''' ''endRollRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetStartPitch}} [[SetStartPitch]]('''number''' ''startPitchRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetStartRoll}} [[SetStartRoll]]('''number''' ''startRollRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetStartYaw}} [[SetStartYaw]]('''number''' ''startYawRadians'')
 +
 
 +
 
 +
===AnimationObject3DTranslate===
 +
* {{GitHubSearch|Search=ClearBezierControlPoints}} [[ClearBezierControlPoints]]()
 +
 
 +
* {{GitHubSearch|Search=GetDeltaOffsetX}} [[GetDeltaOffsetX]]()
 +
** '''Returns:''' '''number''' ''deltaX''
 +
 
 +
* {{GitHubSearch|Search=GetDeltaOffsetY}} [[GetDeltaOffsetY]]()
 +
** '''Returns:''' '''number''' ''deltaY''
 +
 
 +
* {{GitHubSearch|Search=GetDeltaOffsetZ}} [[GetDeltaOffsetZ]]()
 +
** '''Returns:''' '''number''' ''deltaZ''
 +
 
 +
* {{GitHubSearch|Search=GetEndOffsetX}} [[GetEndOffsetX]]()
 +
** '''Returns:''' '''number''' ''endX''
 +
 
 +
* {{GitHubSearch|Search=GetEndOffsetY}} [[GetEndOffsetY]]()
 +
** '''Returns:''' '''number''' ''endY''
 +
 
 +
* {{GitHubSearch|Search=GetEndOffsetZ}} [[GetEndOffsetZ]]()
 +
** '''Returns:''' '''number''' ''endZ''
 +
 
 +
* {{GitHubSearch|Search=GetStartOffsetX}} [[GetStartOffsetX]]()
 +
** '''Returns:''' '''number''' ''startX''
 +
 
 +
* {{GitHubSearch|Search=GetStartOffsetY}} [[GetStartOffsetY]]()
 +
** '''Returns:''' '''number''' ''startY''
 +
 
 +
* {{GitHubSearch|Search=GetStartOffsetZ}} [[GetStartOffsetZ]]()
 +
** '''Returns:''' '''number''' ''startZ''
 +
 
 +
* {{GitHubSearch|Search=GetTranslateDeltas}} [[GetTranslateDeltas]]()
 +
** '''Returns:''' '''number''' ''deltaX'', '''number''' ''deltaY'', '''number''' ''deltaZ''
 +
 
 +
* {{GitHubSearch|Search=SetBezierControlPoint}} [[SetBezierControlPoint]]('''number''' ''index'', '''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
 +
 
 +
* {{GitHubSearch|Search=SetDeltaOffsetX}} [[SetDeltaOffsetX]]('''number''' ''deltaX'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* {{GitHubSearch|Search=SetDeltaOffsetY}} [[SetDeltaOffsetY]]('''number''' ''deltaY'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* {{GitHubSearch|Search=SetDeltaOffsetZ}} [[SetDeltaOffsetZ]]('''number''' ''deltaZ'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* {{GitHubSearch|Search=SetEndOffsetX}} [[SetEndOffsetX]]('''number''' ''endX'')
 +
 
 +
* {{GitHubSearch|Search=SetEndOffsetY}} [[SetEndOffsetY]]('''number''' ''endY'')
 +
 
 +
* {{GitHubSearch|Search=SetEndOffsetZ}} [[SetEndOffsetZ]]('''number''' ''endZ'')
 +
 
 +
* {{GitHubSearch|Search=SetStartOffsetX}} [[SetStartOffsetX]]('''number''' ''startX'')
 +
 
 +
* {{GitHubSearch|Search=SetStartOffsetY}} [[SetStartOffsetY]]('''number''' ''startY'')
 +
 
 +
* {{GitHubSearch|Search=SetStartOffsetZ}} [[SetStartOffsetZ]]('''number''' ''startZ'')
 +
 
 +
* {{GitHubSearch|Search=SetTranslateDeltas}} [[SetTranslateDeltas]]('''number''' ''deltaX'', '''number''' ''deltaY'', '''number''' ''deltaZ'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* {{GitHubSearch|Search=SetTranslateOffsets}} [[SetTranslateOffsets]]('''number''' ''startX'', '''number''' ''startY'', '''number''' ''startZ'', '''number''' ''endX'', '''number''' ''endY'', '''number''' ''endZ'')
 +
 
 +
 
 +
===AnimationObjectAlpha===
 +
* {{GitHubSearch|Search=GetEndAlpha}} [[GetEndAlpha]]()
 +
** '''Returns:''' '''number''' ''endAlpha''
 +
 
 +
* {{GitHubSearch|Search=GetStartAlpha}} [[GetStartAlpha]]()
 +
** '''Returns:''' '''number''' ''startAlpha''
 +
 
 +
* {{GitHubSearch|Search=SetAlphaValues}} [[SetAlphaValues]]('''number''' ''startAlpha'', '''number''' ''endAlpha'')
 +
 
 +
* {{GitHubSearch|Search=SetEndAlpha}} [[SetEndAlpha]]('''number''' ''endAlpha'')
 +
 
 +
* {{GitHubSearch|Search=SetStartAlpha}} [[SetStartAlpha]]('''number''' ''startAlpha'')
 +
 
 +
 
 +
===AnimationObjectColor===
 +
* {{GitHubSearch|Search=GetApplyAlpha}} [[GetApplyAlpha]]()
 +
** '''Returns:''' '''boolean''' ''applyAlpha''
 +
 
 +
* {{GitHubSearch|Search=GetEndColor}} [[GetEndColor]]()
 +
** '''Returns:''' '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA''
 +
 
 +
* {{GitHubSearch|Search=GetStartColor}} [[GetStartColor]]()
 +
** '''Returns:''' '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA''
 +
 
 +
* {{GitHubSearch|Search=SetApplyAlpha}} [[SetApplyAlpha]]('''boolean''' ''applyAlpha'')
 +
 
 +
* {{GitHubSearch|Search=SetColorValues}} [[SetColorValues]]('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* {{GitHubSearch|Search=SetEndColor}} [[SetEndColor]]('''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* {{GitHubSearch|Search=SetStartColor}} [[SetStartColor]]('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'')
 +
 
 +
 
 +
===AnimationObjectCustom===
 +
* {{GitHubSearch|Search=SetUpdateFunction}} [[SetUpdateFunction]]('''function''' ''functionRef'')
 +
 
 +
 
 +
===AnimationObjectScale===
 +
* {{GitHubSearch|Search=GetEndScale}} [[GetEndScale]]()
 +
** '''Returns:''' '''number''' ''endScale''
 +
 
 +
* {{GitHubSearch|Search=GetStartScale}} [[GetStartScale]]()
 +
** '''Returns:''' '''number''' ''startScale''
 +
 
 +
* {{GitHubSearch|Search=SetEndScale}} [[SetEndScale]]('''number''' ''endScale'')
 +
 
 +
* {{GitHubSearch|Search=SetScaleValues}} [[SetScaleValues]]('''number''' ''startScale'', '''number''' ''endScale'')
 +
 
 +
* {{GitHubSearch|Search=SetStartScale}} [[SetStartScale]]('''number''' ''startScale'')
 +
 
 +
 
 +
===AnimationObjectScroll===
 +
* {{GitHubSearch|Search=SetHorizontalEnd}} [[SetHorizontalEnd]]('''number''' ''endX'')
 +
 
 +
* {{GitHubSearch|Search=SetHorizontalRelative}} [[SetHorizontalRelative]]('''number''' ''offsetX'')
 +
 
 +
* {{GitHubSearch|Search=SetHorizontalStartAndEnd}} [[SetHorizontalStartAndEnd]]('''number''' ''startX'', '''number''' ''endX'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalEnd}} [[SetVerticalEnd]]('''number''' ''endY'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalRelative}} [[SetVerticalRelative]]('''number''' ''offsetY'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalStartAndEnd}} [[SetVerticalStartAndEnd]]('''number''' ''startY'', '''number''' ''endY'')
 +
 
 +
 
 +
===AnimationObjectSize===
 +
* {{GitHubSearch|Search=SetEndHeight}} [[SetEndHeight]]('''number''' ''endHeight'')
 +
 
 +
* {{GitHubSearch|Search=SetEndWidth}} [[SetEndWidth]]('''number''' ''endWidth'')
 +
 
 +
* {{GitHubSearch|Search=SetStartAndEndHeight}} [[SetStartAndEndHeight]]('''number''' ''startHeight'', '''number''' ''endHeight'')
 +
 
 +
* {{GitHubSearch|Search=SetStartAndEndWidth}} [[SetStartAndEndWidth]]('''number''' ''startWidth'', '''number''' ''endWidth'')
 +
 
 +
* {{GitHubSearch|Search=SetStartHeight}} [[SetStartHeight]]('''number''' ''startHeight'')
 +
 
 +
* {{GitHubSearch|Search=SetStartWidth}} [[SetStartWidth]]('''number''' ''startWidth'')
 +
 
 +
 
 +
===AnimationObjectTexture===
 +
* {{GitHubSearch|Search=GetCellsHigh}} [[GetCellsHigh]]()
 +
** '''Returns:''' '''number''' ''aNumCellsHigh''
 +
 
 +
* {{GitHubSearch|Search=GetCellsWide}} [[GetCellsWide]]()
 +
** '''Returns:''' '''number''' ''aNumCellsWide''
 +
 
 +
* {{GitHubSearch|Search=IsMirroringAlongX}} [[IsMirroringAlongX]]()
 +
** '''Returns:''' '''boolean''' ''mirroring''
 +
 
 +
* {{GitHubSearch|Search=IsMirroringAlongY}} [[IsMirroringAlongY]]()
 +
** '''Returns:''' '''boolean''' ''mirroring''
 +
 
 +
* {{GitHubSearch|Search=SetCellsHigh}} [[SetCellsHigh]]('''number''' ''aNumCellsHigh'')
 +
 
 +
* {{GitHubSearch|Search=SetCellsWide}} [[SetCellsWide]]('''number''' ''aNumCellsWide'')
 +
 
 +
* {{GitHubSearch|Search=SetFramerate}} [[SetFramerate]]('''number''' ''framesPerSecond'')
 +
 
 +
* {{GitHubSearch|Search=SetImageData}} [[SetImageData]]('''number''' ''aNumCellsWide'', '''number''' ''aNumCellsHigh'')
 +
 
 +
* {{GitHubSearch|Search=SetMirrorAlongX}} [[SetMirrorAlongX]]('''boolean''' ''mirroring'')
 +
 
 +
* {{GitHubSearch|Search=SetMirrorAlongY}} [[SetMirrorAlongY]]('''boolean''' ''mirroring'')
 +
 
 +
 
 +
===AnimationObjectTextureRotate===
 +
* {{GitHubSearch|Search=GetEndRotation}} [[GetEndRotation]]()
 +
** '''Returns:''' '''number''' ''endRadians''
 +
 
 +
* {{GitHubSearch|Search=GetStartRotation}} [[GetStartRotation]]()
 +
** '''Returns:''' '''number''' ''startRadians''
 +
 
 +
* {{GitHubSearch|Search=SetEndRotation}} [[SetEndRotation]]('''number''' ''endRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetRotationValues}} [[SetRotationValues]]('''number''' ''startRadians'', '''number''' ''endRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetStartRotation}} [[SetStartRotation]]('''number''' ''startRadians'')
 +
 
 +
 
 +
===AnimationObjectTextureSlide===
 +
* {{GitHubSearch|Search=SetSlideDistances}} [[SetSlideDistances]]('''number''' ''slideDistanceU'', '''number''' ''slideDistanceV'')
 +
 
 +
 
 +
===AnimationObjectTranslate===
 +
* {{GitHubSearch|Search=GetAnchorIndex}} [[GetAnchorIndex]]()
 +
** '''Returns:''' '''number''' ''anchorIndex''
 +
 
 +
* {{GitHubSearch|Search=GetDeltaOffsetX}} [[GetDeltaOffsetX]]()
 +
** '''Returns:''' '''number''' ''deltaX''
 +
 
 +
* {{GitHubSearch|Search=GetDeltaOffsetY}} [[GetDeltaOffsetY]]()
 +
** '''Returns:''' '''number''' ''deltaY''
 +
 
 +
* {{GitHubSearch|Search=GetEndOffsetX}} [[GetEndOffsetX]]()
 +
** '''Returns:''' '''number''' ''endX''
 +
 
 +
* {{GitHubSearch|Search=GetEndOffsetY}} [[GetEndOffsetY]]()
 +
** '''Returns:''' '''number''' ''endY''
 +
 
 +
* {{GitHubSearch|Search=GetStartOffsetX}} [[GetStartOffsetX]]()
 +
** '''Returns:''' '''number''' ''startX''
 +
 
 +
* {{GitHubSearch|Search=GetStartOffsetY}} [[GetStartOffsetY]]()
 +
** '''Returns:''' '''number''' ''startY''
 +
 
 +
* {{GitHubSearch|Search=GetTranslateDeltas}} [[GetTranslateDeltas]]()
 +
** '''Returns:''' '''number''' ''deltaX'', '''number''' ''deltaY''
 +
 
 +
* {{GitHubSearch|Search=SetAnchorIndex}} [[SetAnchorIndex]]('''number''' ''anchorIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetDeltaOffsetX}} [[SetDeltaOffsetX]]('''number''' ''deltaX'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* {{GitHubSearch|Search=SetDeltaOffsetY}} [[SetDeltaOffsetY]]('''number''' ''deltaY'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* {{GitHubSearch|Search=SetEndOffsetX}} [[SetEndOffsetX]]('''number''' ''endX'')
 +
 
 +
* {{GitHubSearch|Search=SetEndOffsetY}} [[SetEndOffsetY]]('''number''' ''endY'')
 +
 
 +
* {{GitHubSearch|Search=SetStartOffsetX}} [[SetStartOffsetX]]('''number''' ''startX'')
 +
 
 +
* {{GitHubSearch|Search=SetStartOffsetY}} [[SetStartOffsetY]]('''number''' ''startY'')
 +
 
 +
* {{GitHubSearch|Search=SetTranslateDeltas}} [[SetTranslateDeltas]]('''number''' ''deltaX'', '''number''' ''deltaY'', '''number''' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* {{GitHubSearch|Search=SetTranslateOffsets}} [[SetTranslateOffsets]]('''number''' ''startX'', '''number''' ''startY'', '''number''' ''endX'', '''number''' ''endY'')
 +
 
 +
 
 +
===AnimationTimeline===
 +
* {{GitHubSearch|Search=ApplyAllAnimationsToControl}} [[ApplyAllAnimationsToControl]]('''object''' ''animatedControl'')
 +
 
 +
* {{GitHubSearch|Search=ClearAllCallbacks}} [[ClearAllCallbacks]]()
 +
 
 +
* {{GitHubSearch|Search=GetAnimation}} [[GetAnimation]]('''number''' ''animationIndex'')
 +
** '''Returns:''' '''object''' ''animation''
 +
 
 +
* {{GitHubSearch|Search=GetAnimationOffset}} [[GetAnimationOffset]]('''object''' ''animation'')
 +
** '''Returns:''' '''number''' ''offset''
 +
 
 +
* {{GitHubSearch|Search=GetAnimationTimeline}} [[GetAnimationTimeline]]('''number''' ''timelineIndex'')
 +
** '''Returns:''' '''object''' ''timeline''
 +
 
 +
* {{GitHubSearch|Search=GetAnimationTimelineOffset}} [[GetAnimationTimelineOffset]]('''object''' ''animation'')
 +
** '''Returns:''' '''number''' ''offset''
 +
 
 +
* {{GitHubSearch|Search=GetDuration}} [[GetDuration]]()
 +
** '''Returns:''' '''number''' ''duration''
 +
 
 +
* {{GitHubSearch|Search=GetFirstAnimation}} [[GetFirstAnimation]]()
 +
** '''Returns:''' '''object''' ''animation''
 +
 
 +
* {{GitHubSearch|Search=GetFirstAnimationOfType}} [[GetFirstAnimationOfType]]('''number''' [[Globals#AnimationType|AnimationType]] ''animationType'')
 +
** '''Returns:''' '''object''' ''animation''
 +
 
 +
* {{GitHubSearch|Search=GetFirstAnimationTimeline}} [[GetFirstAnimationTimeline]]()
 +
** '''Returns:''' '''object''' ''timeline''
 +
 
 +
* {{GitHubSearch|Search=GetFullProgress}} [[GetFullProgress]]()
 +
** '''Returns:''' '''number''' ''progress''
 +
 
 +
* {{GitHubSearch|Search=GetHandler}} [[GetHandler]]('''string''' ''EventName'')
 +
** '''Returns:''' '''function''' ''FunctionRef''
 +
 
 +
* {{GitHubSearch|Search=GetLastAnimation}} [[GetLastAnimation]]()
 +
** '''Returns:''' '''object''' ''animation''
 +
 
 +
* {{GitHubSearch|Search=GetLastAnimationTimeline}} [[GetLastAnimationTimeline]]()
 +
** '''Returns:''' '''object''' ''timeline''
 +
 
 +
* {{GitHubSearch|Search=GetMinDuration}} [[GetMinDuration]]()
 +
** '''Returns:''' '''number''' ''minDuration''
 +
 
 +
* {{GitHubSearch|Search=GetNumAnimationTimelines}} [[GetNumAnimationTimelines]]()
 +
** '''Returns:''' '''number''' ''numTimelines''
 +
 
 +
* {{GitHubSearch|Search=GetNumAnimations}} [[GetNumAnimations]]()
 +
** '''Returns:''' '''number''' ''numAnimations''
 +
 
 +
* {{GitHubSearch|Search=GetParent}} [[GetParent]]()
 +
** '''Returns:''' '''object''' ''timeline''
 +
 
 +
* {{GitHubSearch|Search=GetPlaybackLoopsRemaining}} [[GetPlaybackLoopsRemaining]]()
 +
** '''Returns:''' '''number''' ''loopsRemaining''
 +
 
 +
* {{GitHubSearch|Search=GetProgress}} [[GetProgress]]()
 +
** '''Returns:''' '''number''' ''progress''
 +
 
 +
* {{GitHubSearch|Search=GetSkipAnimationsBehindPlayheadOnInitialPlay}} [[GetSkipAnimationsBehindPlayheadOnInitialPlay]]()
 +
** '''Returns:''' '''boolean''' ''skipAnimations''
 +
 
 +
* {{GitHubSearch|Search=InsertAnimation}} [[InsertAnimation]]('''number''' ''animationType'', '''object''' ''animatedControl'', '''number''' ''offset'')
 +
** '''Returns:''' '''object''' ''animation''
 +
 
 +
* {{GitHubSearch|Search=InsertAnimationFromVirtual}} [[InsertAnimationFromVirtual]]('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
 +
** '''Returns:''' '''object''' ''animation''
 +
 
 +
* {{GitHubSearch|Search=InsertAnimationTimeline}} [[InsertAnimationTimeline]]('''number''' ''offset'', '''object''' ''animatedControl'')
 +
** '''Returns:''' '''object''' ''animation''
 +
 
 +
* {{GitHubSearch|Search=InsertAnimationTimelineFromVirtual}} [[InsertAnimationTimelineFromVirtual]]('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
 +
** '''Returns:''' '''object''' ''animation''
 +
 
 +
* {{GitHubSearch|Search=InsertCallback}} [[InsertCallback]]('''function''' ''functionRef'', '''number''' ''offset'')
 +
** '''Returns:''' '''function''' ''functionRefRet''
 +
 
 +
* {{GitHubSearch|Search=IsEnabled}} [[IsEnabled]]()
 +
** '''Returns:''' '''boolean''' ''isEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsPaused}} [[IsPaused]]()
 +
** '''Returns:''' '''boolean''' ''isPaused''
 +
 
 +
* {{GitHubSearch|Search=IsPlaying}} [[IsPlaying]]()
 +
** '''Returns:''' '''boolean''' ''isPlaying''
 +
 
 +
* {{GitHubSearch|Search=IsPlayingBackward}} [[IsPlayingBackward]]()
 +
** '''Returns:''' '''boolean''' ''reversed''
 +
 
 +
* {{GitHubSearch|Search=Pause}} [[Pause]]()
 +
 
 +
* {{GitHubSearch|Search=PlayBackward}} [[PlayBackward]]()
 +
 
 +
* {{GitHubSearch|Search=PlayForward}} [[PlayForward]]()
 +
 
 +
* {{GitHubSearch|Search=PlayFromEnd}} [[PlayFromEnd]]('''number''' ''offsetMs'')
 +
 
 +
* {{GitHubSearch|Search=PlayFromStart}} [[PlayFromStart]]('''number''' ''offsetMs'')
 +
 
 +
* {{GitHubSearch|Search=PlayInstantlyToEnd}} [[PlayInstantlyToEnd]]()
 +
 
 +
* {{GitHubSearch|Search=PlayInstantlyToStart}} [[PlayInstantlyToStart]]()
 +
 
 +
* {{GitHubSearch|Search=Resume}} [[Resume]]()
 +
 
 +
* {{GitHubSearch|Search=SetAllAnimationOffsets}} [[SetAllAnimationOffsets]]('''number''' ''offset'')
 +
 
 +
* {{GitHubSearch|Search=SetAnimationOffset}} [[SetAnimationOffset]]('''object''' ''animation'', '''number''' ''offset'')
 +
 
 +
* {{GitHubSearch|Search=SetAnimationTimelineOffset}} [[SetAnimationTimelineOffset]]('''object''' ''animation'', '''number''' ''offset'')
 +
 
 +
* {{GitHubSearch|Search=SetCallbackOffset}} [[SetCallbackOffset]]('''function''' ''callback'', '''number''' ''offset'')
 +
 
 +
* {{GitHubSearch|Search=SetEnabled}} [[SetEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetHandler}} [[SetHandler]]('''string''' ''EventName'', '''function''' ''FunctionRef'')
 +
 
 +
* {{GitHubSearch|Search=SetMinDuration}} [[SetMinDuration]]('''number''' ''minDuration'')
 +
 
 +
* {{GitHubSearch|Search=SetPlaybackLoopCount}} [[SetPlaybackLoopCount]]('''number''' ''maxLoopCount'')
 +
 
 +
* {{GitHubSearch|Search=SetPlaybackLoopsRemaining}} [[SetPlaybackLoopsRemaining]]('''number''' ''loopsRemaining'')
 +
 
 +
* {{GitHubSearch|Search=SetPlaybackType}} [[SetPlaybackType]]('''number''' ''playbackType'', '''number''' ''maxLoopCount'')
 +
 
 +
* {{GitHubSearch|Search=SetProgress}} [[SetProgress]]('''number''' ''progress'')
 +
 
 +
* {{GitHubSearch|Search=SetSkipAnimationsBehindPlayheadOnInitialPlay}} [[SetSkipAnimationsBehindPlayheadOnInitialPlay]]('''boolean''' ''skipAnimations'')
 +
 
 +
* {{GitHubSearch|Search=Stop}} [[Stop]]()
 +
 
 +
 
 +
===BackdropControl===
 +
* {{GitHubSearch|Search=GetCenterColor}} [[GetCenterColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* {{GitHubSearch|Search=SetCenterColor}} [[SetCenterColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetCenterTexture}} [[SetCenterTexture]]('''string''' ''filename'', '''number''' ''tileSize'', '''number''' ''addressMode'')
 +
 
 +
* {{GitHubSearch|Search=SetEdgeColor}} [[SetEdgeColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetEdgeTexture}} [[SetEdgeTexture]]('''string''' ''filename'', '''number''' ''edgeFileWidth'', '''number''' ''edgeFileHeight'', '''number''' ''edgeSize'', '''number''' ''edgeFilePadding'')
 +
 
 +
* {{GitHubSearch|Search=SetInsets}} [[SetInsets]]('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetIntegralWrapping}} [[SetIntegralWrapping]]('''boolean''' ''integralWrappingEnabled'')
 +
 
 +
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
 
 +
===ButtonControl===
 +
* {{GitHubSearch|Search=EnableMouseButton}} [[EnableMouseButton]]('''number''' ''buttonNum'', '''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=GetLabelControl}} [[GetLabelControl]]()
 +
** '''Returns:''' '''object''' ''labelControl''
 +
 
 +
* {{GitHubSearch|Search=GetState}} [[GetState]]()
 +
** '''Returns:''' '''number''' ''state''
 +
 
 +
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* {{GitHubSearch|Search=SetClickSound}} [[SetClickSound]]('''string''' ''clickSound'')
 +
 
 +
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
 
 +
* {{GitHubSearch|Search=SetDisabledFontColor}} [[SetDisabledFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetDisabledPressedFontColor}} [[SetDisabledPressedFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetDisabledPressedTexture}} [[SetDisabledPressedTexture]]('''string''' ''textureFilename'')
 +
 
 +
* {{GitHubSearch|Search=SetDisabledTexture}} [[SetDisabledTexture]]('''string''' ''textureFilename'')
 +
 
 +
* {{GitHubSearch|Search=SetEnabled}} [[SetEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetEndCapWidth}} [[SetEndCapWidth]]('''number''' ''endCapWidth'')
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''text'')
 +
 
 +
* {{GitHubSearch|Search=SetHorizontalAlignment}} [[SetHorizontalAlignment]]('''number''' ''horizontalAlign'')
 +
 
 +
* {{GitHubSearch|Search=SetMouseOverBlendMode}} [[SetMouseOverBlendMode]]('''number''' ''blendMode'')
 +
 
 +
* {{GitHubSearch|Search=SetMouseOverFontColor}} [[SetMouseOverFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetMouseOverTexture}} [[SetMouseOverTexture]]('''string''' ''textureFilename'')
 +
 
 +
* {{GitHubSearch|Search=SetNormalFontColor}} [[SetNormalFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetNormalOffset}} [[SetNormalOffset]]('''number''' ''x'', '''number''' ''y'')
 +
 
 +
* {{GitHubSearch|Search=SetNormalTexture}} [[SetNormalTexture]]('''string''' ''textureFilename'')
 +
 
 +
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* {{GitHubSearch|Search=SetPressedFontColor}} [[SetPressedFontColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetPressedMouseOverTexture}} [[SetPressedMouseOverTexture]]('''string''' ''textureFilename'')
 +
 
 +
* {{GitHubSearch|Search=SetPressedOffset}} [[SetPressedOffset]]('''number''' ''x'', '''number''' ''y'')
 +
 
 +
* {{GitHubSearch|Search=SetPressedTexture}} [[SetPressedTexture]]('''string''' ''textureFilename'')
 +
 
 +
* {{GitHubSearch|Search=SetShowingHighlight}} [[SetShowingHighlight]]('''boolean''' ''showingHighlight'')
 +
 
 +
* {{GitHubSearch|Search=SetState}} [[SetState]]('''number''' ''newState'', '''boolean''' ''locked'')
 +
 
 +
* {{GitHubSearch|Search=SetText}} [[SetText]]('''string''' ''text'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalAlignment}} [[SetVerticalAlignment]]('''number''' ''verticalAlign'')
 +
 
 +
 
 +
===ColorSelectControl===
 +
* {{GitHubSearch|Search=GetColorAsHSV}} [[GetColorAsHSV]]()
 +
** '''Returns:''' '''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value''
 +
 
 +
* {{GitHubSearch|Search=GetColorAsRGB}} [[GetColorAsRGB]]()
 +
** '''Returns:''' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
 +
 
 +
* {{GitHubSearch|Search=GetColorWheelTextureControl}} [[GetColorWheelTextureControl]]()
 +
** '''Returns:''' '''object''' ''textureControl''
 +
 
 +
* {{GitHubSearch|Search=GetColorWheelThumbTextureControl}} [[GetColorWheelThumbTextureControl]]()
 +
** '''Returns:''' '''object''' ''textureControl''
 +
 
 +
* {{GitHubSearch|Search=GetFullValuedColorAsRGB}} [[GetFullValuedColorAsRGB]]()
 +
** '''Returns:''' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
 +
 
 +
* {{GitHubSearch|Search=GetThumbNormalizedPosition}} [[GetThumbNormalizedPosition]]()
 +
** '''Returns:''' '''number''' ''normalizedX'', '''number''' ''normalizedY''
 +
 
 +
* {{GitHubSearch|Search=GetValue}} [[GetValue]]()
 +
** '''Returns:''' '''number''' ''value''
 +
 
 +
* {{GitHubSearch|Search=SetColorAsHSV}} [[SetColorAsHSV]]('''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value'')
 +
 
 +
* {{GitHubSearch|Search=SetColorAsRGB}} [[SetColorAsRGB]]('''number''' ''red'', '''number''' ''green'', '''number''' ''blue'')
 +
 
 +
* {{GitHubSearch|Search=SetColorWheelThumbTextureControl}} [[SetColorWheelThumbTextureControl]]('''object''' ''textureControl'')
 +
 
 +
* {{GitHubSearch|Search=SetThumbNormalizedPosition}} [[SetThumbNormalizedPosition]]('''number''' ''normalizedX'', '''number''' ''normalizedY'')
 +
 
 +
* {{GitHubSearch|Search=SetValue}} [[SetValue]]('''number''' ''value'')
 +
 
 +
 
 +
===CompassDisplayControl===
 +
* {{GitHubSearch|Search=GetAlphaDropoffBehavior}} [[GetAlphaDropoffBehavior]]('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'')
 +
** '''Returns:''' '''number''' ''closeAlpha'', '''number''' ''farAlpha'', '''number''' ''closeAlphaDistanceM'', '''number''' ''farAlphaDistanceM''
 +
 
 +
* {{GitHubSearch|Search=GetCenterOveredPinDescription}} [[GetCenterOveredPinDescription]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''string''' ''description''
 +
 
 +
* {{GitHubSearch|Search=GetCenterOveredPinDistance}} [[GetCenterOveredPinDistance]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''number''' ''distanceFromPlayerCM''
 +
 
 +
* {{GitHubSearch|Search=GetCenterOveredPinInfo}} [[GetCenterOveredPinInfo]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''string''' ''description'', '''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''type'', '''number''' ''distanceFromPlayerCM'', '''number''' [[Globals#DrawLayer|DrawLayer]] ''drawLayer'', '''number''' ''drawLevel'', '''boolean''' ''suppressed''
 +
 
 +
* {{GitHubSearch|Search=GetCenterOveredPinLayerAndLevel}} [[GetCenterOveredPinLayerAndLevel]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''number''' [[Globals#DrawLayer|DrawLayer]] ''drawLayer'', '''number''' ''drawLevel''
 +
 
 +
* {{GitHubSearch|Search=GetCenterOveredPinType}} [[GetCenterOveredPinType]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''type''
 +
 
 +
* {{GitHubSearch|Search=GetNumCenterOveredPins}} [[GetNumCenterOveredPins]]()
 +
** '''Returns:''' '''number''' ''numCenterOveredPins''
 +
 
 +
* {{GitHubSearch|Search=GetScaleDropoffBehavior}} [[GetScaleDropoffBehavior]]('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'')
 +
** '''Returns:''' '''number''' ''closeScale'', '''number''' ''farScale'', '''number''' ''closeScaleDistanceM'', '''number''' ''farScaleDistanceM''
 +
 
 +
* {{GitHubSearch|Search=IsCenterOveredPinSuppressed}} [[IsCenterOveredPinSuppressed]]('''number''' ''centerOveredPinIndex'')
 +
** '''Returns:''' '''boolean''' ''suppressed''
 +
 
 +
* {{GitHubSearch|Search=SetAlphaDropoffBehavior}} [[SetAlphaDropoffBehavior]]('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''closeAlpha'', '''number''' ''farAlpha'', '''number''' ''closeAlphaDistanceM'', '''number''' ''farAlphaDistanceM'')
 +
 
 +
* {{GitHubSearch|Search=SetCardinalDirection}} [[SetCardinalDirection]]('''string''' ''directionName'', '''string''' ''font'', '''number''' ''cardinalDirection'')
 +
 
 +
* {{GitHubSearch|Search=SetScaleDropoffBehavior}} [[SetScaleDropoffBehavior]]('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''closeScale'', '''number''' ''farScale'', '''number''' ''closeScaleDistanceM'', '''number''' ''farScaleDistanceM'')
 +
 
 +
 
 +
===Control===
 +
Objects that inherit behavior from '''Control'''
 +
* [[Controls#BackdropControl|BackdropControl]]
 +
* [[Controls#ButtonControl|ButtonControl]]
 +
* [[Controls#ColorSelectControl|ColorSelectControl]]
 +
* [[Controls#CompassDisplayControl|CompassDisplayControl]]
 +
* [[Controls#CooldownControl|CooldownControl]]
 +
* [[Controls#DebugTextControl|DebugTextControl]]
 +
* [[Controls#EditControl|EditControl]]
 +
* [[Controls#LabelControl|LabelControl]]
 +
* [[Controls#LineControl|LineControl]]
 +
* [[Controls#MapDisplayControl|MapDisplayControl]]
 +
* [[Controls#RootWindow|RootWindow]]
 +
* [[Controls#ScrollControl|ScrollControl]]
 +
* [[Controls#SliderControl|SliderControl]]
 +
* [[Controls#StatusBarControl|StatusBarControl]]
 +
* [[Controls#TextBufferControl|TextBufferControl]]
 +
* [[Controls#TextureCompositeControl|TextureCompositeControl]]
 +
* [[Controls#TextureControl|TextureControl]]
 +
* [[Controls#TooltipControl|TooltipControl]]
 +
* [[Controls#TopLevelWindow|TopLevelWindow]]
 +
 
 +
 
 +
* {{GitHubSearch|Search=AddFilterForEvent}} [[AddFilterForEvent]]('''number''' ''event'')
 +
** '''Returns:''' '''boolean''' ''success''
 +
 
 +
* {{GitHubSearch|Search=ClearAnchors}} {{Protected_attributes}} [[ClearAnchors]]()
 +
 
 +
* {{GitHubSearch|Search=Convert3DLocalOrientationToWorldOrientation}} [[Convert3DLocalOrientationToWorldOrientation]]('''number''' ''localPitch'', '''number''' ''localYaw'', '''number''' ''localRoll'')
 +
** '''Returns:''' '''number''' ''worldPitch'', '''number''' ''worldYaw'', '''number''' ''worldRoll''
 +
 
 +
* {{GitHubSearch|Search=Convert3DLocalPositionToWorldPosition}} [[Convert3DLocalPositionToWorldPosition]]('''number''' ''localX'', '''number''' ''localY'', '''number''' ''localZ'')
 +
** '''Returns:''' '''number''' ''worldX'', '''number''' ''worldY'', '''number''' ''worldZ''
 +
 
 +
* {{GitHubSearch|Search=Convert3DWorldOrientationToLocalOrientation}} [[Convert3DWorldOrientationToLocalOrientation]]('''number''' ''worldPitch'', '''number''' ''worldYaw'', '''number''' ''worldRoll'')
 +
** '''Returns:''' '''number''' ''localPitch'', '''number''' ''localYaw'', '''number''' ''localRoll''
 +
 
 +
* {{GitHubSearch|Search=Convert3DWorldPositionToLocalPosition}} [[Convert3DWorldPositionToLocalPosition]]('''number''' ''worldX'', '''number''' ''worldY'', '''number''' ''worldZ'')
 +
** '''Returns:''' '''number''' ''localX'', '''number''' ''localY'', '''number''' ''localZ''
 +
 
 +
* {{GitHubSearch|Search=Create3DRenderSpace}} [[Create3DRenderSpace]]()
 +
 
 +
* {{GitHubSearch|Search=CreateControl}} [[CreateControl]]('''string''' ''arg1'', '''number''' ''type'')
 +
** '''Returns:''' '''object''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=Destroy3DRenderSpace}} [[Destroy3DRenderSpace]]()
 +
 
 +
* {{GitHubSearch|Search=Does3DRenderSpaceUseDepthBuffer}} [[Does3DRenderSpaceUseDepthBuffer]]()
 +
** '''Returns:''' '''boolean''' ''usesDepthBuffer''
 +
 
 +
* {{GitHubSearch|Search=Get3DRenderSpaceForward}} [[Get3DRenderSpaceForward]]()
 +
** '''Returns:''' '''number''' ''x'', '''number''' ''y'', '''number''' ''z''
 +
 
 +
* {{GitHubSearch|Search=Get3DRenderSpaceOrientation}} [[Get3DRenderSpaceOrientation]]()
 +
** '''Returns:''' '''number''' ''pitchRadians'', '''number''' ''yawRadians'', '''number''' ''rollRadians''
 +
 
 +
* {{GitHubSearch|Search=Get3DRenderSpaceOrigin}} [[Get3DRenderSpaceOrigin]]()
 +
** '''Returns:''' '''number''' ''x'', '''number''' ''y'', '''number''' ''z''
 +
 
 +
* {{GitHubSearch|Search=Get3DRenderSpaceRight}} [[Get3DRenderSpaceRight]]()
 +
** '''Returns:''' '''number''' ''x'', '''number''' ''y'', '''number''' ''z''
 +
 
 +
* {{GitHubSearch|Search=Get3DRenderSpaceSystem}} [[Get3DRenderSpaceSystem]]()
 +
** '''Returns:''' '''number''' [[Globals#GuiRender3DSpaceSystem|GuiRender3DSpaceSystem]] ''system''
 +
 
 +
* {{GitHubSearch|Search=Get3DRenderSpaceUp}} [[Get3DRenderSpaceUp]]()
 +
** '''Returns:''' '''number''' ''x'', '''number''' ''y'', '''number''' ''z''
 +
 
 +
* {{GitHubSearch|Search=GetAlpha}} [[GetAlpha]]()
 +
** '''Returns:''' '''number''' ''alpha''
 +
 
 +
* {{GitHubSearch|Search=GetAnchor}} [[GetAnchor]]('''number''' ''anchorIndex'')
 +
** '''Returns:''' '''boolean''' ''isValidAnchor'', '''number''' ''point'', '''object''' ''relativeTo'', '''number''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' [[Globals#AnchorConstrains|AnchorConstrains]] ''anchorConstrains''
 +
 
 +
* {{GitHubSearch|Search=GetBottom}} [[GetBottom]]()
 +
** '''Returns:''' '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetCenter}} [[GetCenter]]()
 +
** '''Returns:''' '''number''' ''centerX'', '''number''' ''centerY''
 +
 
 +
* {{GitHubSearch|Search=GetChild}} [[GetChild]]('''number''' ''childIndex'')
 +
** '''Returns:''' '''object''' ''childControl''
 +
 
 +
* {{GitHubSearch|Search=GetClampedToScreen}} [[GetClampedToScreen]]()
 +
** '''Returns:''' '''boolean''' ''clamped''
 +
 
 +
* {{GitHubSearch|Search=GetClampedToScreenInsets}} [[GetClampedToScreenInsets]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetControlAlpha}} [[GetControlAlpha]]()
 +
** '''Returns:''' '''number''' ''alpha''
 +
 
 +
* {{GitHubSearch|Search=GetControlScale}} [[GetControlScale]]()
 +
** '''Returns:''' '''number''' ''scale''
 +
 
 +
* {{GitHubSearch|Search=GetDesiredHeight}} [[GetDesiredHeight]]()
 +
** '''Returns:''' '''number''' ''height''
 +
 
 +
* {{GitHubSearch|Search=GetDesiredWidth}} [[GetDesiredWidth]]()
 +
** '''Returns:''' '''number''' ''width''
 +
 
 +
* {{GitHubSearch|Search=GetDimensionConstraints}} [[GetDimensionConstraints]]()
 +
** '''Returns:''' '''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight''
 +
 
 +
* {{GitHubSearch|Search=GetDimensions}} [[GetDimensions]]()
 +
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
 +
 
 +
* {{GitHubSearch|Search=GetDrawLayer}} [[GetDrawLayer]]()
 +
** '''Returns:''' '''number''' ''layer''
 +
 
 +
* {{GitHubSearch|Search=GetDrawLevel}} [[GetDrawLevel]]()
 +
** '''Returns:''' '''number''' ''level''
 +
 
 +
* {{GitHubSearch|Search=GetDrawTier}} [[GetDrawTier]]()
 +
** '''Returns:''' '''number''' ''tier''
 +
 
 +
* {{GitHubSearch|Search=GetExcludeFromResizeToFitExtents}} [[GetExcludeFromResizeToFitExtents]]()
 +
** '''Returns:''' '''boolean''' ''excludes''
 +
 
 +
* {{GitHubSearch|Search=GetHandler}} [[GetHandler]]('''string''' ''handlerName'')
 +
** '''Returns:''' '''function''' ''functionRef''
 +
 
 +
* {{GitHubSearch|Search=GetHeight}} [[GetHeight]]()
 +
** '''Returns:''' '''number''' ''height''
 +
 
 +
* {{GitHubSearch|Search=GetHitInsets}} [[GetHitInsets]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetId}} [[GetId]]()
 +
** '''Returns:''' '''number''' ''id''
 +
 
 +
* {{GitHubSearch|Search=GetInheritsAlpha}} [[GetInheritsAlpha]]()
 +
** '''Returns:''' '''boolean''' ''inheritAlpha''
 +
 
 +
* {{GitHubSearch|Search=GetInheritsScale}} [[GetInheritsScale]]()
 +
** '''Returns:''' '''boolean''' ''inheritScale''
 +
 
 +
* {{GitHubSearch|Search=GetLeft}} [[GetLeft]]()
 +
** '''Returns:''' '''number''' ''left''
 +
 
 +
* {{GitHubSearch|Search=GetName}} [[GetName]]()
 +
** '''Returns:''' '''string''' ''name''
 +
 
 +
* {{GitHubSearch|Search=GetNamedChild}} [[GetNamedChild]]('''string''' ''childName'')
 +
** '''Returns:''' '''object''' ''returnedControl''
 +
 
 +
* {{GitHubSearch|Search=GetNumChildren}} [[GetNumChildren]]()
 +
** '''Returns:''' '''number''' ''numChildren''
 +
 
 +
* {{GitHubSearch|Search=GetOwningWindow}} [[GetOwningWindow]]()
 +
** '''Returns:''' '''object''' ''OwningTopLevelWindow''
 +
 
 +
* {{GitHubSearch|Search=GetParent}} [[GetParent]]()
 +
** '''Returns:''' '''object''' ''ret1''
 +
 
 +
* {{GitHubSearch|Search=GetResizeToFitDescendents}} [[GetResizeToFitDescendents]]()
 +
** '''Returns:''' '''boolean''' ''resizes''
 +
 
 +
* {{GitHubSearch|Search=GetResizeToFitPadding}} [[GetResizeToFitPadding]]()
 +
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
 +
 
 +
* {{GitHubSearch|Search=GetRight}} [[GetRight]]()
 +
** '''Returns:''' '''number''' ''right''
 +
 
 +
* {{GitHubSearch|Search=GetScale}} [[GetScale]]()
 +
** '''Returns:''' '''number''' ''scale''
 +
 
 +
* {{GitHubSearch|Search=GetScreenRect}} [[GetScreenRect]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetTop}} [[GetTop]]()
 +
** '''Returns:''' '''number''' ''top''
 +
 
 +
* {{GitHubSearch|Search=GetType}} [[GetType]]()
 +
** '''Returns:''' '''number''' ''type''
 +
 
 +
* {{GitHubSearch|Search=GetWidth}} [[GetWidth]]()
 +
** '''Returns:''' '''number''' ''width''
 +
 
 +
* {{GitHubSearch|Search=Has3DRenderSpace}} [[Has3DRenderSpace]]()
 +
** '''Returns:''' '''boolean''' ''has3DRenderSpace''
 +
 
 +
* {{GitHubSearch|Search=IsChildOf}} [[IsChildOf]]('''object''' ''desiredParent'')
 +
** '''Returns:''' '''boolean''' ''isChild''
 +
 
 +
* {{GitHubSearch|Search=IsControlHidden}} [[IsControlHidden]]()
 +
** '''Returns:''' '''boolean''' ''hidden''
 +
 
 +
* {{GitHubSearch|Search=IsHandlerSet}} [[IsHandlerSet]]('''string''' ''handlerName'')
 +
** '''Returns:''' '''boolean''' ''isSet''
 +
 
 +
* {{GitHubSearch|Search=IsHidden}} [[IsHidden]]()
 +
** '''Returns:''' '''boolean''' ''hidden''
 +
 
 +
* {{GitHubSearch|Search=IsKeyboardEnabled}} [[IsKeyboardEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* {{GitHubSearch|Search=IsMouseEnabled}} [[IsMouseEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* {{GitHubSearch|Search=IsPointInside}} [[IsPointInside]]('''number''' ''x'', '''number''' ''y'', '''number''' ''leftOffset'', '''number''' ''topOffset'', '''number''' ''rightOffset'', '''number''' ''bottomOffset'')
 +
** '''Returns:''' '''boolean''' ''isInside''
 +
 
 +
* {{GitHubSearch|Search=RegisterForEvent}} [[RegisterForEvent]]('''number''' ''event'', '''function''' ''callback'')
 +
** '''Returns:''' '''boolean''' ''success''
 +
 
 +
* {{GitHubSearch|Search=Set3DRenderSpaceForward}} [[Set3DRenderSpaceForward]]('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
 +
 
 +
* {{GitHubSearch|Search=Set3DRenderSpaceOrientation}} [[Set3DRenderSpaceOrientation]]('''number''' ''pitchRadians'', '''number''' ''yawRadians'', '''number''' ''rollRadians'')
 +
 
 +
* {{GitHubSearch|Search=Set3DRenderSpaceOrigin}} [[Set3DRenderSpaceOrigin]]('''number''' ''xM'', '''number''' ''yM'', '''number''' ''zM'')
 +
 
 +
* {{GitHubSearch|Search=Set3DRenderSpaceRight}} [[Set3DRenderSpaceRight]]('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
 +
 
 +
* {{GitHubSearch|Search=Set3DRenderSpaceSystem}} [[Set3DRenderSpaceSystem]]('''number''' [[Globals#GuiRender3DSpaceSystem|GuiRender3DSpaceSystem]] ''system'')
 +
 
 +
* {{GitHubSearch|Search=Set3DRenderSpaceUp}} [[Set3DRenderSpaceUp]]('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
 +
 
 +
* {{GitHubSearch|Search=Set3DRenderSpaceUsesDepthBuffer}} [[Set3DRenderSpaceUsesDepthBuffer]]('''boolean''' ''usesDepthBuffer'')
 +
 
 +
* {{GitHubSearch|Search=SetAlpha}} {{Protected_attributes}} [[SetAlpha]]('''number''' ''alpha'')
 +
 
 +
* {{GitHubSearch|Search=SetAnchor}} {{Protected_attributes}} [[SetAnchor]]('''number''' ''whereOnMe'', '''object''' ''anchorTargetControl'', '''number''' ''whereOnTarget'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' [[Globals#AnchorConstrains|AnchorConstrains]] ''anchorConstrains'') - https://wiki.esoui.com/Control:SetAnchor
 +
 
 +
* {{GitHubSearch|Search=SetAnchorFill}} {{Protected_attributes}} [[SetAnchorFill]]('''object''' ''anchorTargetControl'')
 +
 
 +
* {{GitHubSearch|Search=SetClampedToScreen}} [[SetClampedToScreen]]('''boolean''' ''clamped'')
 +
 
 +
* {{GitHubSearch|Search=SetClampedToScreenInsets}} [[SetClampedToScreenInsets]]('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetDimensionConstraints}} [[SetDimensionConstraints]]('''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight'')
 +
 
 +
* {{GitHubSearch|Search=SetDimensions}} {{Protected_attributes}} [[SetDimensions]]('''number''' ''width'', '''number''' ''height'')
 +
 
 +
* {{GitHubSearch|Search=SetDrawLayer}} {{Protected_attributes}} [[SetDrawLayer]]('''number''' ''layer'')
 +
 
 +
* {{GitHubSearch|Search=SetDrawLevel}} {{Protected_attributes}} [[SetDrawLevel]]('''number''' ''level'')
 +
 
 +
* {{GitHubSearch|Search=SetDrawTier}} {{Protected_attributes}} [[SetDrawTier]]('''number''' ''tier'')
 +
 
 +
* {{GitHubSearch|Search=SetExcludeFromResizeToFitExtents}} {{Protected_attributes}} [[SetExcludeFromResizeToFitExtents]]('''boolean''' ''exclude'')
 +
 
 +
* {{GitHubSearch|Search=SetHandler}} [[SetHandler]]('''string''' ''handlerName'', '''function''' ''functionRef'')
 +
 
 +
* {{GitHubSearch|Search=SetHeight}} {{Protected_attributes}} [[SetHeight]]('''number''' ''height'')
 +
 
 +
* {{GitHubSearch|Search=SetHidden}} {{Protected_attributes}} [[SetHidden]]('''boolean''' ''aHidden'')
 +
 
 +
* {{GitHubSearch|Search=SetHitInsets}} [[SetHitInsets]]('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetId}} [[SetId]]('''number''' ''id'')
 +
 
 +
* {{GitHubSearch|Search=SetInheritAlpha}} [[SetInheritAlpha]]('''boolean''' ''inheritAlpha'')
 +
 
 +
* {{GitHubSearch|Search=SetInheritScale}} [[SetInheritScale]]('''boolean''' ''inheritScale'')
 +
 
 +
* {{GitHubSearch|Search=SetKeyboardEnabled}} {{Protected_attributes}} [[SetKeyboardEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetMouseEnabled}} {{Protected_attributes}} [[SetMouseEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetMovable}} [[SetMovable]]('''boolean''' ''isMovable'')
 +
 
 +
* {{GitHubSearch|Search=SetParent}} {{Protected_attributes}} [[SetParent]]('''object''' ''newParent'')
 +
 
 +
* {{GitHubSearch|Search=SetResizeHandleSize}} [[SetResizeHandleSize]]('''number''' ''handleSize'')
 +
 
 +
* {{GitHubSearch|Search=SetResizeToFitDescendents}} {{Protected_attributes}} [[SetResizeToFitDescendents]]('''boolean''' ''resize'')
 +
 
 +
* {{GitHubSearch|Search=SetResizeToFitPadding}} [[SetResizeToFitPadding]]('''number''' ''width'', '''number''' ''height'')
 +
 
 +
* {{GitHubSearch|Search=SetScale}} {{Protected_attributes}} [[SetScale]]('''number''' ''scale'')
 +
 
 +
* SetShapeType '''public''' ('''number''' ''shapeType'')
 +
 
 +
* {{GitHubSearch|Search=SetSimpleAnchor}} {{Protected_attributes}} [[SetSimpleAnchor]]('''object''' ''anchorTargetControl'', '''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 
 +
* {{GitHubSearch|Search=SetSimpleAnchorParent}} {{Protected_attributes}} [[SetSimpleAnchorParent]]('''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 
 +
* {{GitHubSearch|Search=SetWidth}} {{Protected_attributes}} [[SetWidth]]('''number''' ''width'')
 +
 
 +
* {{GitHubSearch|Search=StartMoving}} {{Protected_attributes}} [[StartMoving]]()
 +
** '''Returns:''' '''boolean''' ''isMoving''
 +
 
 +
* {{GitHubSearch|Search=StopMovingOrResizing}} {{Protected_attributes}} [[StopMovingOrResizing]]()
 +
 
 +
* {{GitHubSearch|Search=ToggleHidden}} {{Protected_attributes}} [[ToggleHidden]]()
 +
 
 +
* {{GitHubSearch|Search=UnregisterForEvent}} [[UnregisterForEvent]]('''number''' ''event'')
 +
** '''Returns:''' '''boolean''' ''success''
 +
 
 +
 
 +
===CooldownControl===
 +
* {{GitHubSearch|Search=GetDuration}} [[GetDuration]]()
 +
** '''Returns:''' '''number''' ''duration''
 +
 
 +
* {{GitHubSearch|Search=GetPercentCompleteFixed}} [[GetPercentCompleteFixed]]()
 +
** '''Returns:''' '''number''' ''percentComplete''
 +
 
 +
* {{GitHubSearch|Search=GetTimeLeft}} [[GetTimeLeft]]()
 +
** '''Returns:''' '''number''' ''time''
 +
 
 +
* {{GitHubSearch|Search=ResetCooldown}} [[ResetCooldown]]()
 +
 
 +
* {{GitHubSearch|Search=SetBlendMode}} [[SetBlendMode]]('''number''' ''blendMode'')
 +
 
 +
* {{GitHubSearch|Search=SetCooldownRemainTime}} [[SetCooldownRemainTime]]('''number''' ''remain'')
 +
 
 +
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
 
 +
* {{GitHubSearch|Search=SetFillColor}} [[SetFillColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetLeadingEdgeTexture}} [[SetLeadingEdgeTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetPercentCompleteFixed}} [[SetPercentCompleteFixed]]('''number''' ''percentComplete'')
 +
 
 +
* {{GitHubSearch|Search=SetRadialCooldownClockwise}} [[SetRadialCooldownClockwise]]('''boolean''' ''clockwise'')
 +
 
 +
* {{GitHubSearch|Search=SetRadialCooldownGradient}} [[SetRadialCooldownGradient]]('''number''' ''startAlpha'', '''number''' ''angularDistance'')
 +
 
 +
* {{GitHubSearch|Search=SetRadialCooldownOriginAngle}} [[SetRadialCooldownOriginAngle]]('''number''' ''originAngle'')
 +
 
 +
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalCooldownLeadingEdgeHeight}} [[SetVerticalCooldownLeadingEdgeHeight]]('''number''' ''leadingEdgeHeight'')
 +
 
 +
* {{GitHubSearch|Search=StartCooldown}} [[StartCooldown]]('''number''' ''remain'', '''number''' ''duration'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', '''boolean''' ''drawLeadingEdge'')
 +
 
 +
* {{GitHubSearch|Search=StartFixedCooldown}} [[StartFixedCooldown]]('''number''' ''percentComplete'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', '''boolean''' ''drawLeadingEdge'')
 +
 
 +
 
 +
===DebugTextControl===
 +
* {{GitHubSearch|Search=Clear}} [[Clear]]()
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontStr'')
 +
 
 +
 
 +
===EditControl===
 +
* {{GitHubSearch|Search=AddValidCharacter}} [[AddValidCharacter]]('''string''' ''validCharacter'')
 +
 
 +
* {{GitHubSearch|Search=Clear}} [[Clear]]()
 +
 
 +
* {{GitHubSearch|Search=ClearSelection}} [[ClearSelection]]()
 +
 
 +
* {{GitHubSearch|Search=CopyAllTextToClipboard}} {{Private function}} [[CopyAllTextToClipboard]]()
 +
 
 +
* {{GitHubSearch|Search=GetAllowMarkupType}} [[GetAllowMarkupType]]()
 +
** '''Returns:''' '''number''' [[Globals#AllowMarkupType|AllowMarkupType]] ''allowMarkupType''
 +
 
 +
* {{GitHubSearch|Search=GetCopyEnabled}} [[GetCopyEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* {{GitHubSearch|Search=GetCursorPosition}} [[GetCursorPosition]]()
 +
** '''Returns:''' '''number''' ''cursorPosition''
 +
 
 +
* {{GitHubSearch|Search=GetEditEnabled}} [[GetEditEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* {{GitHubSearch|Search=GetFontHeight}} [[GetFontHeight]]()
 +
** '''Returns:''' '''number''' ''fontHeightUIUnits''
 +
 
 +
* {{GitHubSearch|Search=GetIMECompositionExclusionArea}} [[GetIMECompositionExclusionArea]]()
 +
** '''Returns:''' '''number''' ''leftControlSpace'', '''number''' ''topControlSpace'', '''number''' ''rightControlSpace'', '''number''' ''bottomControlSpace''
 +
 
 +
* {{GitHubSearch|Search=GetNewLineEnabled}} [[GetNewLineEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* {{GitHubSearch|Search=GetPasteEnabled}} [[GetPasteEnabled]]()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* {{GitHubSearch|Search=GetScrollExtents}} [[GetScrollExtents]]()
 +
** '''Returns:''' '''number''' ''numLines''
 +
 
 +
* {{GitHubSearch|Search=GetText}} [[GetText]]()
 +
** '''Returns:''' '''string''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=GetTopLineIndex}} [[GetTopLineIndex]]()
 +
** '''Returns:''' '''number''' ''index''
 +
 
 +
* {{GitHubSearch|Search=HasFocus}} [[HasFocus]]()
 +
** '''Returns:''' '''boolean''' ''aRet''
 +
 
 +
* {{GitHubSearch|Search=HasSelection}} [[HasSelection]]()
 +
** '''Returns:''' '''boolean''' ''hasSelection''
 +
 
 +
* {{GitHubSearch|Search=InsertText}} [[InsertText]]('''string''' ''aText'')
 +
 
 +
* {{GitHubSearch|Search=IsComposingIMEText}} [[IsComposingIMEText]]()
 +
** '''Returns:''' '''boolean''' ''isComposing''
 +
 
 +
* {{GitHubSearch|Search=IsMultiLine}} [[IsMultiLine]]()
 +
** '''Returns:''' '''boolean''' ''isMultiLine''
 +
 
 +
* {{GitHubSearch|Search=LoseFocus}} [[LoseFocus]]()
 +
 
 +
* {{GitHubSearch|Search=RemoveAllValidCharacters}} [[RemoveAllValidCharacters]]()
 +
 
 +
* {{GitHubSearch|Search=SelectAll}} [[SelectAll]]()
 +
 
 +
* {{GitHubSearch|Search=SetAllowMarkupType}} [[SetAllowMarkupType]]('''number''' [[Globals#AllowMarkupType|AllowMarkupType]] ''allowMarkupType'')
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetCopyEnabled}} [[SetCopyEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetCursorPosition}} [[SetCursorPosition]]('''number''' ''cursorPosition'')
 +
 
 +
* {{GitHubSearch|Search=SetEditEnabled}} [[SetEditEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''font'')
 +
 
 +
* {{GitHubSearch|Search=SetMaxInputChars}} [[SetMaxInputChars]]('''number''' ''maxChars'')
 +
 
 +
* {{GitHubSearch|Search=SetMultiLine}} [[SetMultiLine]]('''boolean''' ''isMultiLine'')
 +
 
 +
* {{GitHubSearch|Search=SetNewLineEnabled}} [[SetNewLineEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetPasteEnabled}} [[SetPasteEnabled]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetSelection}} [[SetSelection]]('''number''' ''selectionStartIndex'', '''number''' ''selectionEndIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSelectionColor}} [[SetSelectionColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetText}} [[SetText]]('''string''' ''aText'')
 +
 
 +
* {{GitHubSearch|Search=SetTextType}} [[SetTextType]]('''number''' ''textType'')
 +
 
 +
* {{GitHubSearch|Search=SetTopLineIndex}} [[SetTopLineIndex]]('''number''' ''index'')
 +
 
 +
* {{GitHubSearch|Search=SetVirtualKeyboardType}} [[SetVirtualKeyboardType]]('''number''' [[Globals#VirtualKeyboardType|VirtualKeyboardType]] ''aKeyboardType'')
 +
 
 +
* {{GitHubSearch|Search=TakeFocus}} [[TakeFocus]]()
 +
 
 +
* {{GitHubSearch|Search=WasLastChangeVirtualKeyboard}} [[WasLastChangeVirtualKeyboard]]()
 +
** '''Returns:''' '''boolean''' ''aRet''
 +
 
 +
 
 +
===FontObject===
 +
* {{GitHubSearch|Search=GetFontInfo}} [[GetFontInfo]]()
 +
** '''Returns:''' '''string''' ''face'', '''number''' ''size'', '''string''' ''option''
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontDescriptor'')
 +
 
 +
 
 +
===LabelControl===
 +
* {{GitHubSearch|Search=AnchorToBaseline}} [[AnchorToBaseline]]('''object''' ''toLabel'', '''number''' ''offsetX'', '''number''' [[Globals#AnchorPosition|AnchorPosition]] ''anchorSide'')
 +
 
 +
* {{GitHubSearch|Search=Clean}} [[Clean]]()
 +
 
 +
* {{GitHubSearch|Search=ClearAnchorToBaseline}} [[ClearAnchorToBaseline]]('''object''' ''toLabel'')
 +
 
 +
* {{GitHubSearch|Search=DidLineWrap}} [[DidLineWrap]]()
 +
** '''Returns:''' '''boolean''' ''didLineWrap''
 +
 
 +
* {{GitHubSearch|Search=GetColor}} [[GetColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetFontHeight}} [[GetFontHeight]]()
 +
** '''Returns:''' '''number''' ''fontHeightUIUnits''
 +
 
 +
* {{GitHubSearch|Search=GetHorizontalAlignment}} [[GetHorizontalAlignment]]()
 +
** '''Returns:''' '''number''' ''align''
 +
 
 +
* {{GitHubSearch|Search=GetLinkEnabled}} [[GetLinkEnabled]]()
 +
** '''Returns:''' '''boolean''' ''linkEnabed''
 +
 
 +
* {{GitHubSearch|Search=GetModifyTextType}} [[GetModifyTextType]]()
 +
** '''Returns:''' '''number''' [[Globals#ModifyTextType|ModifyTextType]] ''modifyTextType''
 +
 
 +
* {{GitHubSearch|Search=GetNumLines}} [[GetNumLines]]()
 +
** '''Returns:''' '''number''' ''numLines''
 +
 
 +
* {{GitHubSearch|Search=GetStringWidth}} [[GetStringWidth]]('''string''' ''text'')
 +
** '''Returns:''' '''number''' ''scaledPixelWidth''
 +
 
 +
* {{GitHubSearch|Search=GetStyleColor}} [[GetStyleColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetText}} [[GetText]]()
 +
** '''Returns:''' '''string''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=GetTextDimensions}} [[GetTextDimensions]]()
 +
** '''Returns:''' '''number''' ''stringWidthUIUnits'', '''number''' ''stringHeightUIUnits''
 +
 
 +
* {{GitHubSearch|Search=GetTextHeight}} [[GetTextHeight]]()
 +
** '''Returns:''' '''number''' ''stringHeightUIUnits''
 +
 
 +
* {{GitHubSearch|Search=GetTextWidth}} [[GetTextWidth]]()
 +
** '''Returns:''' '''number''' ''stringWidthUIUnits''
 +
 
 +
* {{GitHubSearch|Search=GetVerticalAlignment}} [[GetVerticalAlignment]]()
 +
** '''Returns:''' '''number''' ''align''
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontString'')
 +
 
 +
* {{GitHubSearch|Search=SetHorizontalAlignment}} [[SetHorizontalAlignment]]('''number''' ''align'')
 +
 
 +
* {{GitHubSearch|Search=SetLineSpacing}} [[SetLineSpacing]]('''number''' ''lineSpacingPixels'')
 +
 
 +
* {{GitHubSearch|Search=SetLinkEnabled}} [[SetLinkEnabled]]('''boolean''' ''linkEnabed'')
 +
 
 +
* {{GitHubSearch|Search=SetMaxLineCount}} [[SetMaxLineCount]]('''number''' ''maxLineCount'')
 +
 
 +
* {{GitHubSearch|Search=SetMinLineCount}} [[SetMinLineCount]]('''number''' ''minLineCount'')
 +
 
 +
* {{GitHubSearch|Search=SetModifyTextType}} [[SetModifyTextType]]('''number''' [[Globals#ModifyTextType|ModifyTextType]] ''modifyTextType'')
 +
 
 +
* {{GitHubSearch|Search=SetNewLineX}} [[SetNewLineX]]('''number''' ''newLineXPixels'')
 +
 
 +
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* {{GitHubSearch|Search=SetStyleColor}} [[SetStyleColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetText}} [[SetText]]('''string''' ''aText'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalAlignment}} [[SetVerticalAlignment]]('''number''' ''verticalAlign'')
 +
 
 +
* {{GitHubSearch|Search=SetWrapMode}} [[SetWrapMode]]('''number''' ''wrapMode'')
 +
 
 +
* {{GitHubSearch|Search=WasTruncated}} [[WasTruncated]]()
 +
** '''Returns:''' '''boolean''' ''wasTruncated''
 +
 
 +
 
 +
===LineControl===
 +
* {{GitHubSearch|Search=GetBlendMode}} [[GetBlendMode]]()
 +
** '''Returns:''' '''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
 +
 
 +
* {{GitHubSearch|Search=GetColor}} [[GetColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetDesaturation}} [[GetDesaturation]]()
 +
** '''Returns:''' '''number''' ''desaturation''
 +
 
 +
* {{GitHubSearch|Search=GetTextureCoords}} [[GetTextureCoords]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileDimensions}} [[GetTextureFileDimensions]]()
 +
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileName}} [[GetTextureFileName]]()
 +
** '''Returns:''' '''string''' ''filename''
 +
 
 +
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsTextureLoaded}} [[IsTextureLoaded]]()
 +
** '''Returns:''' '''boolean''' ''loaded''
 +
 
 +
* {{GitHubSearch|Search=SetBlendMode}} [[SetBlendMode]]('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
 
 +
* {{GitHubSearch|Search=SetGradientColors}} [[SetGradientColors]]('''number''' [[Globals#ControlOrientation|ControlOrientation]] ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetThickness}} [[SetThickness]]('''number''' ''thickness'')
 +
 
 +
* {{GitHubSearch|Search=SetVertexColors}} [[SetVertexColors]]('''number''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
 +
 
 +
 
 +
===MapDisplayControl===
 +
* {{GitHubSearch|Search=GetZoom}} [[GetZoom]]()
 +
** '''Returns:''' '''number''' ''normalizedRadius''
 +
 
 +
* {{GitHubSearch|Search=SetPinFont}} [[SetPinFont]]('''string''' ''pinFont'')
 +
 
 +
* {{GitHubSearch|Search=SetZoom}} [[SetZoom]]('''number''' ''normalizedRadius'')
 +
 
 +
 
 +
===RootWindow===
 +
 
 +
===ScrollControl===
 +
* {{GitHubSearch|Search=GetFadeGradient}} [[GetFadeGradient]]('''number''' ''gradientIndex'')
 +
** '''Returns:''' '''number''' ''normalX'', '''number''' ''normalY'', '''number''' ''gradientLength''
 +
 
 +
* {{GitHubSearch|Search=GetScrollExtents}} [[GetScrollExtents]]()
 +
** '''Returns:''' '''number''' ''horizontal'', '''number''' ''vertical''
 +
 
 +
* {{GitHubSearch|Search=GetScrollOffsets}} [[GetScrollOffsets]]()
 +
** '''Returns:''' '''number''' ''horizontal'', '''number''' ''vertical''
 +
 
 +
* {{GitHubSearch|Search=RestoreToExtents}} [[RestoreToExtents]]('''number''' ''duration'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeGradient}} [[SetFadeGradient]]('''number''' ''gradientIndex'', '''number''' ''normalX'', '''number''' ''normalY'', '''number''' ''gradientLength'')
 +
 
 +
* {{GitHubSearch|Search=SetHorizontalScroll}} [[SetHorizontalScroll]]('''number''' ''offset'')
 +
 
 +
* {{GitHubSearch|Search=SetScrollBounding}} [[SetScrollBounding]]('''number''' [[Globals#ScrollBounding|ScrollBounding]] ''bounding'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalScroll}} [[SetVerticalScroll]]('''number''' ''offset'')
 +
 
 +
 
 +
===SliderControl===
 +
* {{GitHubSearch|Search=DoesAllowDraggingFromThumb}} [[DoesAllowDraggingFromThumb]]()
 +
** '''Returns:''' '''boolean''' ''allow''
 +
 
 +
* {{GitHubSearch|Search=GetEnabled}} [[GetEnabled]]()
 +
** '''Returns:''' '''boolean''' ''isEnabled''
 +
 
 +
* {{GitHubSearch|Search=GetMinMax}} [[GetMinMax]]()
 +
** '''Returns:''' '''number''' ''min'', '''number''' ''max''
 +
 
 +
* {{GitHubSearch|Search=GetOrientation}} [[GetOrientation]]()
 +
** '''Returns:''' '''number''' ''orientation''
 +
 
 +
* {{GitHubSearch|Search=GetThumbTextureControl}} [[GetThumbTextureControl]]()
 +
** '''Returns:''' '''object''' ''textureControl''
 +
 
 +
* {{GitHubSearch|Search=GetValue}} [[GetValue]]()
 +
** '''Returns:''' '''number''' ''value''
 +
 
 +
* {{GitHubSearch|Search=GetValueStep}} [[GetValueStep]]()
 +
** '''Returns:''' '''number''' ''step''
 +
 
 +
* {{GitHubSearch|Search=IsThumbFlushWithExtents}} [[IsThumbFlushWithExtents]]()
 +
** '''Returns:''' '''boolean''' ''flush''
 +
 
 +
* {{GitHubSearch|Search=SetAllowDraggingFromThumb}} [[SetAllowDraggingFromThumb]]('''boolean''' ''allow'')
 +
 
 +
* {{GitHubSearch|Search=SetBackgroundBottomTexture}} [[SetBackgroundBottomTexture]]('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
 +
 
 +
* {{GitHubSearch|Search=SetBackgroundMiddleTexture}} [[SetBackgroundMiddleTexture]]('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
 +
 
 +
* {{GitHubSearch|Search=SetBackgroundTopTexture}} [[SetBackgroundTopTexture]]('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetEnabled}} [[SetEnabled]]('''boolean''' ''enable'')
 +
 
 +
* {{GitHubSearch|Search=SetMinMax}} [[SetMinMax]]('''number''' ''min'', '''number''' ''max'')
 +
 
 +
* {{GitHubSearch|Search=SetOrientation}} [[SetOrientation]]('''number''' ''orientation'')
 +
 
 +
* {{GitHubSearch|Search=SetThumbFlushWithExtents}} [[SetThumbFlushWithExtents]]('''boolean''' ''flush'')
 +
 
 +
* {{GitHubSearch|Search=SetThumbTexture}} [[SetThumbTexture]]('''string''' ''filename'', '''string''' ''disabledFilename'', '''string''' ''highlightedFilename'', '''number''' ''thumbWidth'', '''number''' ''thumbHeight'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
 +
 
 +
* {{GitHubSearch|Search=SetThumbTextureHeight}} [[SetThumbTextureHeight]]('''number''' ''height'')
 +
 
 +
* {{GitHubSearch|Search=SetValue}} [[SetValue]]('''number''' ''value'')
 +
 
 +
* {{GitHubSearch|Search=SetValueStep}} [[SetValueStep]]('''number''' ''step'')
 +
 
 +
 
 +
===StatusBarControl===
 +
* {{GitHubSearch|Search=ClearFadeOutLossAdjustedTopValue}} [[ClearFadeOutLossAdjustedTopValue]]()
 +
 
 +
* {{GitHubSearch|Search=EnableFadeOut}} [[EnableFadeOut]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=EnableLeadingEdge}} [[EnableLeadingEdge]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=EnableScrollingOverlay}} [[EnableScrollingOverlay]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=GetMinMax}} [[GetMinMax]]()
 +
** '''Returns:''' '''number''' ''min'', '''number''' ''max''
 +
 
 +
* {{GitHubSearch|Search=GetValue}} [[GetValue]]()
 +
** '''Returns:''' '''number''' ''value''
 +
 
 +
* {{GitHubSearch|Search=SetBarAlignment}} [[SetBarAlignment]]('''number''' ''barAlignment'')
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutGainColor}} [[SetFadeOutGainColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutLossAdjustedTopValue}} [[SetFadeOutLossAdjustedTopValue]]('''number''' ''topValue'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutLossColor}} [[SetFadeOutLossColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutLossSetValueToAdjust}} [[SetFadeOutLossSetValueToAdjust]]('''number''' ''adjustValue'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutTexture}} [[SetFadeOutTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetFadeOutTime}} [[SetFadeOutTime]]('''number''' ''fadeOutSeconds'', '''number''' ''fadeOutDelaySeconds'')
 +
 
 +
* {{GitHubSearch|Search=SetGradientColors}} [[SetGradientColors]]('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* {{GitHubSearch|Search=SetLeadingEdge}} [[SetLeadingEdge]]('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'')
 +
 
 +
* {{GitHubSearch|Search=SetLeadingEdgeTextureCoords}} [[SetLeadingEdgeTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetMinMax}} [[SetMinMax]]('''number''' ''aMin'', '''number''' ''aMax'')
 +
 
 +
* {{GitHubSearch|Search=SetOrientation}} [[SetOrientation]]('''number''' ''orientation'')
 +
 
 +
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetValue}} [[SetValue]]('''number''' ''aValue'')
 +
 
 +
* {{GitHubSearch|Search=SetupScrollingOverlay}} [[SetupScrollingOverlay]]('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'', '''number''' ''duration'')
 +
 
 +
 
 +
===TextBufferControl===
 +
* {{GitHubSearch|Search=AddMessage}} [[AddMessage]]('''string''' ''aText'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''colorId'')
 +
 
 +
* {{GitHubSearch|Search=Clear}} [[Clear]]()
 +
 
 +
* {{GitHubSearch|Search=GetDrawLastEntryIfOutOfRoom}} [[GetDrawLastEntryIfOutOfRoom]]()
 +
** '''Returns:''' '''boolean''' ''drawLastIfOutOfRoom''
 +
 
 +
* {{GitHubSearch|Search=GetLineFade}} [[GetLineFade]]()
 +
** '''Returns:''' '''number''' ''timeBeforeLineBeginsToFade'', '''number''' ''timeItTakesLineToFade''
 +
 
 +
* {{GitHubSearch|Search=GetLinkEnabled}} [[GetLinkEnabled]]()
 +
** '''Returns:''' '''boolean''' ''linkEnabed''
 +
 
 +
* {{GitHubSearch|Search=GetMaxHistoryLines}} [[GetMaxHistoryLines]]()
 +
** '''Returns:''' '''number''' ''numLines''
 +
 
 +
* {{GitHubSearch|Search=GetNumHistoryLines}} [[GetNumHistoryLines]]()
 +
** '''Returns:''' '''number''' ''numLines''
 +
 
 +
* {{GitHubSearch|Search=GetNumVisibleLines}} [[GetNumVisibleLines]]()
 +
** '''Returns:''' '''number''' ''numLines''
 +
 
 +
* {{GitHubSearch|Search=GetScrollPosition}} [[GetScrollPosition]]()
 +
** '''Returns:''' '''number''' ''scrollPosition''
 +
 
 +
* {{GitHubSearch|Search=IsSplittingLongMessages}} [[IsSplittingLongMessages]]()
 +
** '''Returns:''' '''boolean''' ''isSplitting''
 +
 
 +
* {{GitHubSearch|Search=MoveScrollPosition}} [[MoveScrollPosition]]('''number''' ''numLines'')
 +
 
 +
* {{GitHubSearch|Search=SetClearBufferAfterFadeout}} [[SetClearBufferAfterFadeout]]('''boolean''' ''clearAfterFade'')
 +
 
 +
* {{GitHubSearch|Search=SetColorById}} [[SetColorById]]('''number''' ''colorId'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
 +
 
 +
* {{GitHubSearch|Search=SetDrawLastEntryIfOutOfRoom}} [[SetDrawLastEntryIfOutOfRoom]]('''boolean''' ''drawLastIfOutOfRoom'')
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontString'')
 +
 
 +
* {{GitHubSearch|Search=SetHorizontalAlignment}} [[SetHorizontalAlignment]]('''number''' ''align'')
 +
 
 +
* {{GitHubSearch|Search=SetLineFade}} [[SetLineFade]]('''number''' ''timeBeforeLineFadeBegins'', '''number''' ''timeForLineToFade'')
 +
 
 +
* {{GitHubSearch|Search=SetLinesInheritAlpha}} [[SetLinesInheritAlpha]]('''boolean''' ''linesInheritAlpha'')
 +
 
 +
* {{GitHubSearch|Search=SetLinkEnabled}} [[SetLinkEnabled]]('''boolean''' ''linkEnabed'')
 +
 
 +
* {{GitHubSearch|Search=SetMaxHistoryLines}} [[SetMaxHistoryLines]]('''number''' ''numLines'')
 +
 
 +
* {{GitHubSearch|Search=SetScrollPosition}} [[SetScrollPosition]]('''number''' ''line'')
 +
 
 +
* {{GitHubSearch|Search=SetSplitLongMessages}} [[SetSplitLongMessages]]('''boolean''' ''splitLongMessages'')
 +
 
 +
* {{GitHubSearch|Search=ShowFadedLines}} [[ShowFadedLines]]()
 +
 
 +
 
 +
===TextureCompositeControl===
 +
* {{GitHubSearch|Search=AddSurface}} [[AddSurface]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=ClearAllSurfaces}} [[ClearAllSurfaces]]()
 +
 
 +
* {{GitHubSearch|Search=GetBlendMode}} [[GetBlendMode]]()
 +
** '''Returns:''' '''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
 +
 
 +
* {{GitHubSearch|Search=GetColor}} [[GetColor]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetDesaturation}} [[GetDesaturation]]()
 +
** '''Returns:''' '''number''' ''desaturation''
 +
 
 +
* {{GitHubSearch|Search=GetInsets}} [[GetInsets]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetNumSurfaces}} [[GetNumSurfaces]]()
 +
** '''Returns:''' '''number''' ''surfaces''
 +
 
 +
* {{GitHubSearch|Search=GetSurfaceAlpha}} [[GetSurfaceAlpha]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetTextureCoords}} [[GetTextureCoords]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileDimensions}} [[GetTextureFileDimensions]]()
 +
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileName}} [[GetTextureFileName]]()
 +
** '''Returns:''' '''string''' ''filename''
 +
 
 +
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsSurfaceHidden}} [[IsSurfaceHidden]]('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''boolean''' ''hidden''
 +
 
 +
* {{GitHubSearch|Search=IsTextureLoaded}} [[IsTextureLoaded]]()
 +
** '''Returns:''' '''boolean''' ''loaded''
 +
 
 +
* {{GitHubSearch|Search=RemoveSurface}} [[RemoveSurface]]('''number''' ''surfaceIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetBlendMode}} [[SetBlendMode]]('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''surfaceIndex'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
 
 +
* {{GitHubSearch|Search=SetInsets}} [[SetInsets]]('''number''' ''surfaceIndex'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* {{GitHubSearch|Search=SetSurfaceAlpha}} [[SetSurfaceAlpha]]('''number''' ''surfaceIndex'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetSurfaceHidden}} [[SetSurfaceHidden]]('''number''' ''surfaceIndex'', '''boolean''' ''hidden'')
 +
 
 +
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''surfaceIndex'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
 
 +
===TextureControl===
 +
* {{GitHubSearch|Search=Get3DLocalDimensions}} [[Get3DLocalDimensions]]()
 +
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
 +
 
 +
* {{GitHubSearch|Search=GetAddressMode}} [[GetAddressMode]]()
 +
** '''Returns:''' '''number''' [[Globals#TextureAddressMode|TextureAddressMode]] ''addressMode''
 +
 
 +
* {{GitHubSearch|Search=GetBlendMode}} [[GetBlendMode]]()
 +
** '''Returns:''' '''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
 +
 
 +
* {{GitHubSearch|Search=GetColor}} [[GetColor]]()
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* {{GitHubSearch|Search=GetDesaturation}} [[GetDesaturation]]()
 +
** '''Returns:''' '''number''' ''desaturation''
 +
 
 +
* {{GitHubSearch|Search=GetResizeToFitFile}} [[GetResizeToFitFile]]()
 +
** '''Returns:''' '''boolean''' ''resizesToFitFile''
 +
 
 +
* {{GitHubSearch|Search=GetShaderEffectType}} [[GetShaderEffectType]]()
 +
** '''Returns:''' '''number''' [[Globals#ShaderEffectType|ShaderEffectType]] ''shaderEffectType''
 +
 
 +
* {{GitHubSearch|Search=GetTextureCoords}} [[GetTextureCoords]]()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileDimensions}} [[GetTextureFileDimensions]]()
 +
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
 +
 
 +
* {{GitHubSearch|Search=GetTextureFileName}} [[GetTextureFileName]]()
 +
** '''Returns:''' '''string''' ''filename''
 +
 
 +
* {{GitHubSearch|Search=GetVertexUV}} [[GetVertexUV]]('''number''' [[Globals#VERTEX_POINTS|VERTEX_POINTS]] ''vertex'')
 +
** '''Returns:''' '''number''' ''u'', '''number''' ''v''
 +
 
 +
* {{GitHubSearch|Search=Is3DQuadFacingCamera}} [[Is3DQuadFacingCamera]]()
 +
** '''Returns:''' '''boolean''' ''isFacing''
 +
 
 +
* {{GitHubSearch|Search=IsPixelRoundingEnabled}} [[IsPixelRoundingEnabled]]()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsTextureLoaded}} [[IsTextureLoaded]]()
 +
** '''Returns:''' '''boolean''' ''loaded''
 +
 
 +
* {{GitHubSearch|Search=Set3DLocalDimensions}} [[Set3DLocalDimensions]]('''number''' ''width'', '''number''' ''height'')
 +
 
 +
* {{GitHubSearch|Search=SetAddressMode}} [[SetAddressMode]]('''number''' [[Globals#TextureAddressMode|TextureAddressMode]] ''addressMode'')
 +
 
 +
* {{GitHubSearch|Search=SetAutoAdjustWrappedCoords}} [[SetAutoAdjustWrappedCoords]]('''boolean''' ''enabled'')
 +
 
 +
* {{GitHubSearch|Search=SetBlendMode}} [[SetBlendMode]]('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
 +
 
 +
* {{GitHubSearch|Search=SetColor}} [[SetColor]]('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* {{GitHubSearch|Search=SetDesaturation}} [[SetDesaturation]]('''number''' ''desaturation'')
 +
 
 +
* {{GitHubSearch|Search=SetGradientColors}} [[SetGradientColors]]('''number''' [[Globals#ControlOrientation|ControlOrientation]] ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* {{GitHubSearch|Search=SetPixelRoundingEnabled}} [[SetPixelRoundingEnabled]]('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* {{GitHubSearch|Search=SetResizeToFitFile}} [[SetResizeToFitFile]]('''boolean''' ''resizesToFitFile'')
 +
 
 +
* {{GitHubSearch|Search=SetShaderEffectType}} [[SetShaderEffectType]]('''number''' [[Globals#ShaderEffectType|ShaderEffectType]] ''shaderEffectType'')
 +
 
 +
* {{GitHubSearch|Search=SetTexture}} [[SetTexture]]('''string''' ''filename'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoords}} [[SetTextureCoords]]('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureCoordsRotation}} [[SetTextureCoordsRotation]]('''number''' ''angleInRadians'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureReleaseOption}} [[SetTextureReleaseOption]]('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureRotation}} [[SetTextureRotation]]('''number''' ''angleInRadians'', '''number''' ''normalizedRotationPointX'', '''number''' ''normalizedRotationPointY'')
 +
 
 +
* {{GitHubSearch|Search=SetTextureSampleProcessingWeight}} [[SetTextureSampleProcessingWeight]]('''number''' [[Globals#TextureSampleProcessing|TextureSampleProcessing]] ''sampleProcessingType'', '''number''' ''weight'')
 +
 
 +
* {{GitHubSearch|Search=SetVertexColors}} [[SetVertexColors]]('''number''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
 +
 
 +
* {{GitHubSearch|Search=SetVertexUV}} [[SetVertexUV]]('''number''' [[Globals#VERTEX_POINTS|VERTEX_POINTS]] ''vertex'', '''number''' ''u'', '''number''' ''v'')
 +
 
 +
 
 +
===TooltipControl===
 +
* {{GitHubSearch|Search=AddControl}} [[AddControl]]('''object''' ''control'', '''number''' ''cell'', '''boolean''' ''useLastRow'')
 +
 
 +
* {{GitHubSearch|Search=AddHeaderControl}} [[AddHeaderControl]]('''object''' ''control'', '''number''' ''headerRow'', '''number''' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'')
 +
 
 +
* {{GitHubSearch|Search=AddHeaderLine}} [[AddHeaderLine]]('''string''' ''text'', '''string''' ''font'', '''number''' ''headerRow'', '''number''' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
 +
 
 +
* {{GitHubSearch|Search=AddLine}} [[AddLine]]('''string''' ''text'', '''string''' ''font'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' [[Globals#AnchorPosition|AnchorPosition]] ''lineAnchor'', '''number''' [[Globals#ModifyTextType|ModifyTextType]] ''modifyTextType'', '''number''' [[Globals#TextAlignment|TextAlignment]] ''textAlignment'', '''boolean''' ''setToFullSize'', '''number''' ''minWidth'')
 +
 
 +
* {{GitHubSearch|Search=AddVerticalPadding}} [[AddVerticalPadding]]('''number''' ''paddingY'')
 +
 
 +
* {{GitHubSearch|Search=AppendAvAObjective}} [[AppendAvAObjective]]('''number''' ''queryType'', '''number''' ''keepId'', '''number''' ''objectiveId'', '''number''' [[Globals#ObjectivePinTier|ObjectivePinTier]] ''objectivePinTier'')
 +
 
 +
* {{GitHubSearch|Search=AppendMapPing}} [[AppendMapPing]]('''number''' ''pingType'', '''string''' ''unitTag'')
 +
 
 +
* {{GitHubSearch|Search=AppendQuestCondition}} [[AppendQuestCondition]]('''number''' ''questIndex'', '''number''' ''stepIndex'', '''number''' ''conditionIndex'')
 +
 
 +
* {{GitHubSearch|Search=AppendQuestEnding}} [[AppendQuestEnding]]('''number''' ''questIndex'')
 +
 
 +
* {{GitHubSearch|Search=AppendUnitName}} [[AppendUnitName]]('''string''' ''unitTag'')
 +
 
 +
* {{GitHubSearch|Search=ClearLines}} [[ClearLines]]()
 +
 
 +
* {{GitHubSearch|Search=GetOwner}} [[GetOwner]]()
 +
** '''Returns:''' '''object''' ''owner''
 +
 
 +
* {{GitHubSearch|Search=HideComparativeTooltips}} [[HideComparativeTooltips]]()
 +
 
 +
* {{GitHubSearch|Search=SetAbility}} [[SetAbility]]('''number''' ''aAbilityIndex'', '''boolean''' ''aShowBase'')
 +
 
 +
* {{GitHubSearch|Search=SetAbilityId}} [[SetAbilityId]]('''number''' ''abilityId'')
 +
 
 +
* {{GitHubSearch|Search=SetAchievement}} [[SetAchievement]]('''number''' ''aAchievementId'')
 +
 
 +
* {{GitHubSearch|Search=SetAchievementRewardItem}} [[SetAchievementRewardItem]]('''number''' ''aAchievementId'')
 +
 
 +
* {{GitHubSearch|Search=SetAction}} [[SetAction]]('''number''' ''aSlotId'')
 +
 
 +
* {{GitHubSearch|Search=SetActiveSkill}} [[SetActiveSkill]]('''number''' [[Globals#SkillType|SkillType]] ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillIndex'', '''number''' [[Globals#MorphSlot|MorphSlot]] ''morphSlot'', '''boolean''' ''isPurchased'', '''boolean''' ''isAdvised'', '''boolean''' ''isBadMorph'', '''number''' ''numAvailableSkillPoints'', '''boolean''' ''showSkillPointCost'', '''boolean''' ''showUpgradeText'', '''boolean''' ''showAdvised'', '''boolean''' ''showBadMorph'', '''number:nilable''' ''overrideRank'', '''number:nilable''' ''overrideAbilityId'')
 +
 
 +
* {{GitHubSearch|Search=SetAsComparativeTooltip1}} [[SetAsComparativeTooltip1]]()
 +
 
 +
* {{GitHubSearch|Search=SetAsComparativeTooltip2}} [[SetAsComparativeTooltip2]]()
 +
 
 +
* {{GitHubSearch|Search=SetAttachedMailItem}} [[SetAttachedMailItem]]('''id64''' ''aMailId'', '''number''' ''aAttachSlot'')
 +
 
 +
* {{GitHubSearch|Search=SetBagItem}} [[SetBagItem]]('''number''' [[Globals#Bag|Bag]] ''bagIndex'', '''number''' ''slotIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetBook}} [[SetBook]]('''number''' ''categoryIndex'', '''number''' ''collectionIndex'', '''number''' ''bookIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetBuff}} [[SetBuff]]('''number''' ''aBuffSlotId'', '''string''' ''unitTag'')
 +
 
 +
* {{GitHubSearch|Search=SetBuybackItem}} [[SetBuybackItem]]('''number''' ''entryIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetChampionSkillAbility}} [[SetChampionSkillAbility]]('''number''' ''disiplineIndex'', '''number''' ''skillIndex'', '''number''' ''numPendingPoints'')
 +
 
 +
* {{GitHubSearch|Search=SetCollectible}} [[SetCollectible]]('''number''' ''collectibleId'', '''boolean''' ''addNickname'', '''boolean''' ''showPurchasableHint'', '''boolean''' ''showBlockReason'')
 +
 
 +
* {{GitHubSearch|Search=SetCurrency}} [[SetCurrency]]('''number''' [[Globals#CurrencyType|CurrencyType]] ''currencyType'', '''number''' ''quantity'')
 +
 
 +
* {{GitHubSearch|Search=SetDailyLoginRewardEntry}} [[SetDailyLoginRewardEntry]]('''number''' ''rewardIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetEdgeKeepBonusAbility}} [[SetEdgeKeepBonusAbility]]('''number''' ''bonusIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetEmperorBonusAbility}} [[SetEmperorBonusAbility]]('''number''' ''campaignId'', '''number''' [[Globals#Alliance|Alliance]] ''alliance'')
 +
 
 +
* {{GitHubSearch|Search=SetFont}} [[SetFont]]('''string''' ''fontStr'')
 +
 
 +
* {{GitHubSearch|Search=SetGuildSpecificItem}} [[SetGuildSpecificItem]]('''number''' ''guildSpecificItemIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetHeaderRowSpacing}} [[SetHeaderRowSpacing]]('''number''' ''spacing'')
 +
 
 +
* {{GitHubSearch|Search=SetHeaderVerticalOffset}} [[SetHeaderVerticalOffset]]('''number''' ''verticalOffset'')
 +
 
 +
* {{GitHubSearch|Search=SetItemUsingEnchantment}} [[SetItemUsingEnchantment]]('''number''' [[Globals#Bag|Bag]] ''itemBagIndex'', '''number''' ''itemSlotIndex'', '''number''' [[Globals#Bag|Bag]] ''enchantmentBagIndex'', '''number''' ''enchantmentSlotIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetKeepBonusAbility}} [[SetKeepBonusAbility]]('''number''' ''bonusIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetKeepUpgrade}} [[SetKeepUpgrade]]('''number''' ''keepId'', '''number''' [[Globals#BattlegroundQueryContextType|BattlegroundQueryContextType]] ''battlegroundContext'', '''number''' ''upgradeLine'', '''number''' ''level'', '''number''' ''index'')
 +
 
 +
* {{GitHubSearch|Search=SetLastCraftingResultItem}} [[SetLastCraftingResultItem]]('''number''' ''resultIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetLink}} [[SetLink]]('''string''' ''aLink'')
 +
 
 +
* {{GitHubSearch|Search=SetLootItem}} [[SetLootItem]]('''number''' ''lootId'')
 +
 
 +
* {{GitHubSearch|Search=SetMarketProduct}} [[SetMarketProduct]]('''number''' ''marketProductId'', '''boolean''' ''showCollectiblePurchasableHint'')
 +
 
 +
* {{GitHubSearch|Search=SetMarketProductListing}} [[SetMarketProductListing]]('''number''' ''marketProductId'', '''number:nilable''' ''presentationIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetMinHeaderRowHeight}} [[SetMinHeaderRowHeight]]('''number''' ''minRowHeight'')
 +
 
 +
* {{GitHubSearch|Search=SetMinHeaderRows}} [[SetMinHeaderRows]]('''number''' ''minRows'')
 +
 
 +
* {{GitHubSearch|Search=SetOwner}} [[SetOwner]]('''object''' ''owner'', '''number''' ''position'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' ''relativePoint'')
 +
 
 +
* {{GitHubSearch|Search=SetPassiveSkill}} [[SetPassiveSkill]]('''number''' [[Globals#SkillType|SkillType]] ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillIndex'', '''number''' ''rank'', '''number''' ''purchasedToRank'', '''number''' ''numAvailableSkillPoints'', '''boolean''' ''showSkillPointCost'')
 +
 
 +
* {{GitHubSearch|Search=SetPendingAlchemyItem}} [[SetPendingAlchemyItem]]('''number''' [[Globals#Bag|Bag]] ''solventBagId'', '''number''' ''solventSlotIndex'', '''number''' [[Globals#Bag|Bag]] ''reagent1BagId'', '''number''' ''reagent1SlotIndex'', '''number''' [[Globals#Bag|Bag]] ''reagent2BagId'', '''number''' ''reagent2SlotIndex'', '''number:nilable''' [[Globals#Bag|Bag]] ''reagent3BagId'', '''number:nilable''' ''reagent3SlotIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetPendingEnchantingItem}} [[SetPendingEnchantingItem]]('''number''' [[Globals#Bag|Bag]] ''potencyRuneBagId'', '''number''' ''potencyRuneSlotIndex'', '''number''' [[Globals#Bag|Bag]] ''essenceRuneBagId'', '''number''' ''essenceRuneSlotIndex'', '''number''' [[Globals#Bag|Bag]] ''aspectRuneBagId'', '''number''' ''aspectRuneSlotIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetPendingRetraitItem}} [[SetPendingRetraitItem]]('''number''' [[Globals#Bag|Bag]] ''bagIndex'', '''number''' ''slotIndex'', '''number''' [[Globals#ItemTraitType|ItemTraitType]] ''pendingTrait'')
 +
 
 +
* {{GitHubSearch|Search=SetPendingSmithingItem}} [[SetPendingSmithingItem]]('''number''' ''patternIndex'', '''number''' ''materialIndex'', '''number''' ''materialQuantity'', '''number''' ''itemStyleId'', '''number''' ''traitIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetPlacedFurniture}} [[SetPlacedFurniture]]('''id64''' ''placedFurnitureId'')
 +
 
 +
* {{GitHubSearch|Search=SetProgressionAbility}} [[SetProgressionAbility]]('''number''' ''aProgressionIndex'', '''number''' ''aMorph'', '''number''' ''aRank'', '''boolean''' ''aShowAdvice'', '''boolean''' ''aAdvised'')
 +
 
 +
* {{GitHubSearch|Search=SetProvisionerIngredientItem}} [[SetProvisionerIngredientItem]]('''number''' ''recipeListIndex'', '''number''' ''recipeIndex'', '''number''' ''ingredientIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetProvisionerResultItem}} [[SetProvisionerResultItem]]('''number''' ''recipeListIndex'', '''number''' ''recipeIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetQuestItem}} [[SetQuestItem]]('''number''' ''questIndex'', '''number''' ''stepIndex'', '''number''' ''conditionIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetQuestReward}} [[SetQuestReward]]('''number''' ''aPerkIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetQuestTool}} [[SetQuestTool]]('''number''' ''questIndex'', '''number''' ''toolIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetReward}} [[SetReward]]('''number''' ''rewardId'', '''number''' ''quantity'')
 +
 
 +
* {{GitHubSearch|Search=SetScrollBonusAbility}} [[SetScrollBonusAbility]]('''number''' [[Globals#Alliance|Alliance]] ''alliance'', '''number''' [[Globals#ObjectiveType|ObjectiveType]] ''artifactType'', '''number''' ''bonusIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSkillAbility}} [[SetSkillAbility]]('''number''' ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillIndex'', '''boolean''' ''badMorph'')
 +
 
 +
* {{GitHubSearch|Search=SetSkillLine}} [[SetSkillLine]]('''number''' ''skillType'', '''number''' ''skillLineIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSkillLineAbilityId}} [[SetSkillLineAbilityId]]('''number''' ''abilityId'', '''number''' [[Globals#SkillType|SkillType]] ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillLineAbilityIndex'', '''number''' ''morphChoice'')
 +
 
 +
* {{GitHubSearch|Search=SetSkillUpgradeAbility}} [[SetSkillUpgradeAbility]]('''number''' ''skillType'', '''number''' ''skillLineIndex'', '''number''' ''skillIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingImprovementItem}} [[SetSmithingImprovementItem]]('''number''' ''craftingSkillType'', '''number''' ''improvementItemIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingImprovementResult}} [[SetSmithingImprovementResult]]('''number''' [[Globals#Bag|Bag]] ''itemToImproveBagId'', '''number''' ''itemToImproveSlotIndex'', '''number''' ''craftingSkillType'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingMaterialItem}} [[SetSmithingMaterialItem]]('''number''' ''patternIndex'', '''number''' ''materialIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingStyleItem}} [[SetSmithingStyleItem]]('''number''' ''itemStyleId'')
 +
 
 +
* {{GitHubSearch|Search=SetSmithingTraitItem}} [[SetSmithingTraitItem]]('''number''' ''traitItemIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetStoreItem}} [[SetStoreItem]]('''number''' ''entryIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetTradeItem}} [[SetTradeItem]]('''number''' ''aWho'', '''number''' ''aTradeIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetTradingHouseItem}} [[SetTradingHouseItem]]('''number''' ''tradingHouseIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetTradingHouseListing}} [[SetTradingHouseListing]]('''number''' ''tradingHouseIndex'')
 +
 
 +
* {{GitHubSearch|Search=SetVerticalPadding}} [[SetVerticalPadding]]('''number''' ''paddingY'')
 +
 
 +
* {{GitHubSearch|Search=SetWornItem}} [[SetWornItem]]('''number''' ''equipSlot'')
 +
 
 +
* {{GitHubSearch|Search=ShowComparativeTooltips}} [[ShowComparativeTooltips]]()
 +
 
 +
 
 +
===TopLevelWindow===
 +
* {{GitHubSearch|Search=AllowBringToTop}} [[AllowBringToTop]]()
 +
** '''Returns:''' '''boolean''' ''allow''
 +
 
 +
* {{GitHubSearch|Search=BringWindowToTop}} {{Protected_attributes}} [[BringWindowToTop]]()
 +
 
 +
* {{GitHubSearch|Search=SetAllowBringToTop}} {{Protected_attributes}} [[SetAllowBringToTop]]('''boolean''' ''allow'')
 +
 
 +
* {{GitHubSearch|Search=SetDrawWhenGuiHidden}} {{Private function}} [[SetDrawWhenGuiHidden]]('''boolean''' ''drawWhenHidden'')
 +
 
 +
* {{GitHubSearch|Search=SetTopmost}} [[SetTopmost]]('''boolean''' ''isTopmost'')
 +
 
 +
 
 +
===WindowManager===
 +
* {{GitHubSearch|Search=ApplyTemplateToControl}} [[ApplyTemplateToControl]]('''object''' ''control'', '''string''' ''virtualName'')
 +
 
 +
* {{GitHubSearch|Search=CompareControlVisualOrder}} [[CompareControlVisualOrder]]('''object''' ''controlA'', '''object''' ''controlB'')
 +
** '''Returns:''' '''number''' ''order''
 +
 
 +
* {{GitHubSearch|Search=CreateControl}} [[CreateControl]]('''string''' ''name'', '''object''' ''parent'', '''number''' [[Globals#ControlType|ControlType]] ''type'')
 +
** '''Returns:''' '''object''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=CreateControlFromVirtual}} [[CreateControlFromVirtual]]('''string''' ''controlName'', '''object''' ''parent'', '''string''' ''virtualName'', '''string''' ''optionalSuffix'')
 +
** '''Returns:''' '''object''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=CreateTopLevelWindow}} [[CreateTopLevelWindow]]('''string''' ''name'')
 +
** '''Returns:''' '''object''' ''apRet''
 +
 
 +
* {{GitHubSearch|Search=GetControlByName}} [[GetControlByName]]('''string''' ''name'', '''string''' ''suffix'')
 +
** '''Returns:''' '''object''' ''ret''
 +
 
 +
* {{GitHubSearch|Search=GetFocusControl}} [[GetFocusControl]]()
 +
** '''Returns:''' '''object''' ''focusControl''
 +
 
 +
* {{GitHubSearch|Search=GetHandler}} [[GetHandler]]('''string''' ''handlerName'')
 +
** '''Returns:''' '''function''' ''functionRef''
 +
 
 +
* {{GitHubSearch|Search=GetIMECandidate}} [[GetIMECandidate]]('''number''' ''index'')
 +
** '''Returns:''' '''string''' ''candidate''
 +
 
 +
* {{GitHubSearch|Search=GetIMECandidatePageInfo}} [[GetIMECandidatePageInfo]]()
 +
** '''Returns:''' '''number''' ''selectedIndex'', '''number''' ''pageStartIndex'', '''number''' ''pageSize''
 +
 
 +
* {{GitHubSearch|Search=GetMouseOverControl}} [[GetMouseOverControl]]()
 +
** '''Returns:''' '''object''' ''mouseOverControl''
 +
 
 +
* {{GitHubSearch|Search=GetNumIMECandidates}} [[GetNumIMECandidates]]()
 +
** '''Returns:''' '''number''' ''numCandidates''
 +
 
 +
* {{GitHubSearch|Search=IsChoosingIMECandidate}} [[IsChoosingIMECandidate]]()
 +
** '''Returns:''' '''boolean''' ''isChoosingCandidate''
 +
 
 +
* {{GitHubSearch|Search=IsHandlingHardwareEvent}} [[IsHandlingHardwareEvent]]()
 +
** '''Returns:''' '''boolean''' ''isHandlingHardwareEvent''
 +
 
 +
* {{GitHubSearch|Search=IsMouseOverWorld}} [[IsMouseOverWorld]]()
 +
** '''Returns:''' '''boolean''' ''isMouseOverWorld''
 +
 
 +
* {{GitHubSearch|Search=IsSecureRenderModeEnabled}} [[IsSecureRenderModeEnabled]]()
 +
** '''Returns:''' '''boolean''' ''secureRenderModeEnabled''
 +
 
 +
* {{GitHubSearch|Search=IsUsingCustomCandidateList}} [[IsUsingCustomCandidateList]]()
 +
** '''Returns:''' '''boolean''' ''isUsingCustomCandidateList''
 +
 
 +
* {{GitHubSearch|Search=SetFocusByName}} [[SetFocusByName]]('''string''' ''name'')
 +
 
 +
* {{GitHubSearch|Search=SetHandler}} [[SetHandler]]('''string''' ''handlerName'', '''function''' ''functionRef'')
 +
 
 +
* {{GitHubSearch|Search=SetMouseCursor}} [[SetMouseCursor]]('''number''' ''cursorType'')
 +
 
 +
* {{GitHubSearch|Search=SetMouseFocusByName}} [[SetMouseFocusByName]]('''string''' ''name'')

Revision as of 16:44, 11 July 2019

Page up-to-date to API Version 100028



Contents

Introduction

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

A working XML example

Check the link for an example.xml

Object creation

XML

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

LUA

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


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

For our LabelControl : 

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

Objects Types and their methods

All UI elements are inheriting the functions defined in Control.

AddOnManager


AnimationManager


AnimationObject

Objects that inherit behavior from AnimationObject



AnimationObject3DRotate


AnimationObject3DTranslate


AnimationObjectAlpha


AnimationObjectColor


AnimationObjectCustom


AnimationObjectScale


AnimationObjectScroll


AnimationObjectSize


AnimationObjectTexture


AnimationObjectTextureRotate


AnimationObjectTextureSlide


AnimationObjectTranslate


AnimationTimeline