Controls

From ESOUI Wiki

(Difference between revisions)
Jump to: navigation, search
(CompassDisplayControl)
(100016)
Line 1: Line 1:
-
=== Control ===
+
==Introduction==
-
(E.g. <code>WINDOW_MANAGER</code> controls)
+
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'''
-
* ClearAnchors '''protected-attributes''' ()
 
-
* CreateControl('''string''' ''arg1'', '''integer''' ''type'')
 
-
** ''Returns:'' '''object''' ''apRet''
 
-
* GetAlpha()
 
-
** ''Returns:'' '''number''' ''alpha''
 
-
* GetAnchor('''integer''' ''anchorIndex'')
 
-
** ''Returns:'' '''bool''' ''isValidAnchor'', '''[[Globals#AnchorPosition|AnchorPosition]]''' ''point'', '''object''' ''relativeTo'', '''[[Globals#AnchorPosition|AnchorPosition]]''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY''
 
-
* GetBottom()
+
Objects creation throught XML :
-
** ''Returns:'' '''number''' ''bottom''
+
-
* GetCenter()
+
<source lang="lua">
-
** ''Returns:'' '''number''' ''centerX'', '''number''' ''centerY''
+
<!-- Basic -->
 +
<Label name="objectName" />
-
* GetChild('''luaindex''' ''childIndex'')
+
<!-- With few elements -->
-
** ''Returns:'' '''object''' ''childControl''
+
<Label name="Name" font="ZoFontGame" verticalAlignment="CENTER">
 +
<Dimensions x="350" y="48" />
 +
<Anchor point="TOPLEFT" relativeTo="$(parent)" />
 +
</Label>
 +
</source>
-
* GetClampedToScreen()
 
-
** ''Returns:'' '''bool''' ''clamped''
 
-
* GetClampedToScreenInsets()
+
Objects creation throught Lua:
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
+
-
* GetDesiredHeight()
+
<source lang="lua">
-
** ''Returns:'' '''number''' ''height''
+
-- Will create a new control without any parent.
 +
CreateControl("ControlName", CT_LABEL ) -- See http://wiki.esoui.com/Globals#ControlType
 +
</source>
-
* GetDesiredWidth()
 
-
** ''Returns:'' '''number''' ''width''
 
-
* GetDimensionConstraints()
 
-
** ''Returns:'' '''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight''
 
-
* GetDimensions()
+
Then, you can call any of the methods listed under :
-
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
+
-
* GetDrawLayer()
+
For our '''LabelControl''' :
-
** ''Returns:'' '''integer''' ''layer''
+
-
* GetDrawLevel()
+
<source lang="lua">
-
** ''Returns:'' '''integer''' ''level''
+
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>
-
* GetDrawTier()
 
-
** ''Returns:'' '''integer''' ''tier''
 
-
* GetExcludeFromResizeToFitExtents()
 
-
** ''Returns:'' '''bool''' ''excludes''
 
-
* GetHandler('''string''' ''handlerName'')
+
==Objects Types and their methods==
-
** ''Returns:'' '''function''' ''functionRef''
+
-
 
+
-
* GetHeight()
+
-
** ''Returns:'' '''number''' ''height''
+
-
 
+
-
* GetHitInsets()
+
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
+
-
 
+
-
* GetId()
+
-
** ''Returns:'' '''integer''' ''id''
+
-
 
+
-
* GetInheritsAlpha()
+
-
** ''Returns:'' '''bool''' ''inheritAlpha''
+
-
 
+
-
* GetInheritsScale()
+
-
** ''Returns:'' '''bool''' ''inheritScale''
+
-
 
+
-
* GetLeft()
+
-
** ''Returns:'' '''number''' ''left''
+
-
 
+
-
* GetName()
+
-
** ''Returns:'' '''string''' ''name''
+
-
 
+
-
* GetNamedChild('''string''' ''childName'')
+
-
** ''Returns:'' '''object''' ''returnedControl''
+
-
 
+
-
* GetNumChildren()
+
-
** ''Returns:'' '''integer''' ''numChildren''
+
-
 
+
-
* GetOwningWindow()
+
-
** ''Returns:'' '''object''' ''OwningTopLevelWindow''
+
-
 
+
-
* GetParent()
+
-
** ''Returns:'' '''object''' ''ret1''
+
-
 
+
-
* GetResizeToFitDescendents()
+
-
** ''Returns:'' '''bool''' ''resizes''
+
-
 
+
-
* GetResizeToFitPadding()
+
-
** ''Returns:'' '''number''' ''width'', '''number''' ''height''
+
-
 
+
-
* GetRight()
+
-
** ''Returns:'' '''number''' ''right''
+
-
 
+
-
* GetScale()
+
-
** ''Returns:'' '''number''' ''scale''
+
-
 
+
-
* GetScreenRect()
+
-
** ''Returns:'' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
+
-
 
+
-
* GetTop()
+
-
** ''Returns:'' '''number''' ''top''
+
-
 
+
-
* GetType()
+
-
** ''Returns:'' '''integer''' ''type''
+
-
 
+
-
* GetWidth()
+
-
** ''Returns:'' '''number''' ''width''
+
-
 
+
-
* IsChildOf('''object''' ''desiredParent'')
+
-
** ''Returns:'' '''bool''' ''isChild''
+
-
 
+
-
* IsControlHidden()
+
-
** ''Returns:'' '''bool''' ''hidden''
+
-
 
+
-
* IsHandlerSet('''string''' ''handlerName'')
+
-
** ''Returns:'' '''bool''' ''isSet''
+
-
 
+
-
* IsHidden()
+
-
** ''Returns:'' '''bool''' ''hidden''
+
-
 
+
-
* IsKeyboardEnabled()
+
-
** ''Returns:'' '''bool''' ''enabled''
+
-
 
+
-
* IsMouseEnabled()
+
-
** ''Returns:'' '''bool''' ''enabled''
+
-
 
+
-
* SetAlpha '''protected-attributes''' ('''number''' ''alpha'')
+
-
 
+
-
* [[Control:SetAnchor|SetAnchor]] '''protected-attributes''' ('''[[Globals#AnchorPosition|AnchorPosition]]''' ''point'', '''object''' ''relativeTo'', '''[[Globals#AnchorPosition|AnchorPosition]]''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY'')
+
-
 
+
-
* SetAnchorFill '''protected-attributes''' ('''object''' ''anchorTargetControl'')
+
-
 
+
-
* [[Control:SetClampedToScreen|SetClampedToScreen]]('''bool''' ''clamped'')
+
-
 
+
-
* SetClampedToScreenInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
+
-
 
+
-
* SetDimensionConstraints('''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight'')
+
-
 
+
-
* SetDimensions '''protected-attributes''' ('''number''' ''width'', '''number''' ''height'')
+
-
 
+
-
* SetDrawLayer '''protected-attributes''' ('''integer''' ''layer'')
+
-
 
+
-
* SetDrawLevel '''protected-attributes''' ('''integer''' ''level'')
+
-
 
+
-
* SetDrawTier '''protected-attributes''' ('''integer''' ''tier'')
+
-
 
+
-
* SetExcludeFromResizeToFitExtents '''protected-attributes''' ('''bool''' ''exclude'')
+
-
 
+
-
* SetHandler('''string''' ''handlerName'', '''function''' ''functionRef'')
+
-
 
+
-
* SetHeight '''protected-attributes''' ('''number''' ''height'')
+
-
 
+
-
* SetHidden '''protected-attributes''' ('''bool''' ''aHidden'')
+
-
 
+
-
* SetHitInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
+
-
 
+
-
* SetId('''integer''' ''id'')
+
-
 
+
-
* SetInheritAlpha('''bool''' ''inheritAlpha'')
+
-
 
+
-
* SetInheritScale('''bool''' ''inheritScale'')
+
-
 
+
-
* SetKeyboardEnabled '''protected-attributes''' ('''bool''' ''enabled'')
+
-
 
+
-
* SetMouseEnabled '''protected-attributes''' ('''bool''' ''enabled'')
+
-
 
+
-
* SetMovable('''bool''' ''isMovable'')
+
-
 
+
-
* SetParent '''protected-attributes''' ('''object''' ''newParent'')
+
-
 
+
-
* SetResizeHandleSize('''number''' ''handleSize'')
+
-
* SetResizeToFitDescendents '''protected-attributes''' ('''bool''' ''resize'')
 
-
* SetResizeToFitPadding('''number''' ''width'', '''number''' ''height'')
+
===AddOnManager===
-
 
+
-
* SetScale '''protected-attributes''' ('''number''' ''scale'')
+
-
 
+
-
* SetShapeType '''public''' ('''integer''' ''shapeType'')
+
-
 
+
-
* SetSimpleAnchor '''protected-attributes''' ('''object''' ''anchorTargetControl'', '''number''' ''offsetX'', '''number''' ''offsetY'')
+
-
 
+
-
* SetSimpleAnchorParent '''protected-attributes''' ('''number''' ''offsetX'', '''number''' ''offsetY'')
+
-
 
+
-
* SetWidth '''protected-attributes''' ('''number''' ''width'')
+
-
 
+
-
* StartMoving '''protected-attributes''' ()
+
-
** ''Returns:'' '''bool''' ''isMoving''
+
-
 
+
-
* StopMovingOrResizing '''protected-attributes''' ()
+
-
 
+
-
* ToggleHidden '''protected-attributes''' ()
+
-
 
+
-
==== Objects that inherit behavior from '''Control''' ====
+
-
* [[#BackdropControl|BackdropControl]]
+
-
* [[#BrowserControl|BrowserControl]]
+
-
* [[#ButtonControl|ButtonControl]]
+
-
* [[#ColorSelectControl|ColorSelectControl]]
+
-
* [[#CompassDisplayControl|CompassDisplayControl]]
+
-
* [[#CooldownControl|CooldownControl]]
+
-
* [[#DebugTextControl|DebugTextControl]]
+
-
* [[#EditControl|EditControl]]
+
-
* [[#LabelControl|LabelControl]]
+
-
* [[#LineControl|LineControl]]
+
-
* [[#MapDisplayControl|MapDisplayControl]]
+
-
* [[#RootWindow|RootWindow]]
+
-
* [[#ScrollControl|ScrollControl]]
+
-
* [[#SliderControl|SliderControl]]
+
-
* [[#StatusBarControl|StatusBarControl]]
+
-
* [[#TextBufferControl|TextBufferControl]]
+
-
* [[#TextureControl|TextureControl]]
+
-
* [[#TooltipControl|TooltipControl]]
+
-
* [[#TopLevelWindow|TopLevelWindow]]
+
-
 
+
-
=== AddOnManager ===
+
* AddRelevantFilter('''string''' ''relevantFilter'')
* AddRelevantFilter('''string''' ''relevantFilter'')
-
* GetAddOnDependencyInfo('''luaindex''' ''addOnIndex'', '''luaindex''' ''addOnDependencyIndex'')
+
* GetAddOnDependencyInfo('''number''' ''addOnIndex'', '''number''' ''addOnDependencyIndex'')
-
** ''Returns:'' '''string''' ''name'', '''bool''' ''active''
+
** '''Returns:''' '''string''' ''name'', '''boolean''' ''active''
* GetAddOnFilter()
* GetAddOnFilter()
-
** ''Returns:'' '''string''' ''settingFilter''
+
** '''Returns:''' '''string''' ''settingFilter''
-
* GetAddOnInfo('''luaindex''' ''addOnIndex'')
+
* GetAddOnInfo('''number''' ''addOnIndex'')
-
** ''Returns:'' '''string''' ''name'', '''string''' ''title'', '''string''' ''author'', '''string''' ''description'', '''bool''' ''enabled'', '''[[Globals#AddOnLoadState|AddOnLoadState]]''' ''state'', '''bool''' ''isOutOfDate''
+
** '''Returns:''' '''string''' ''name'', '''string''' ''title'', '''string''' ''author'', '''string''' ''description'', '''boolean''' ''enabled'', ''number'' [[Globals#AddOnLoadState|AddOnLoadState]] ''state'', '''boolean''' ''isOutOfDate''
-
* GetAddOnNumDependencies('''luaindex''' ''addOnIndex'')
+
* GetAddOnNumDependencies('''number''' ''addOnIndex'')
-
** ''Returns:'' '''integer''' ''numDependencies''
+
** '''Returns:''' '''number''' ''numDependencies''
* GetLoadOutOfDateAddOns()
* GetLoadOutOfDateAddOns()
-
** ''Returns:'' '''bool''' ''loadOutOfDateAddons''
+
** '''Returns:''' '''boolean''' ''loadOutOfDateAddons''
* GetNumAddOns()
* GetNumAddOns()
-
** ''Returns:'' '''integer''' ''numAddOns''
+
** '''Returns:''' '''number''' ''numAddOns''
* RemoveAddOnFilter()
* RemoveAddOnFilter()
Line 244: Line 71:
* ResetRelevantFilters()
* ResetRelevantFilters()
-
* SetAddOnEnabled('''luaindex''' ''addOnIndex'', '''bool''' ''enabled'')
+
* SetAddOnEnabled('''number''' ''addOnIndex'', '''boolean''' ''enabled'')
* SetAddOnFilter('''string''' ''settingFilter'')
* SetAddOnFilter('''string''' ''settingFilter'')
-
* SetLoadOutOfDateAddOns('''bool''' ''loadOutOfDateAddons'')
+
* SetLoadOutOfDateAddOns('''boolean''' ''loadOutOfDateAddons'')
-
=== AnimationManager ===
+
===AnimationManager===
* CreateTimeline()
* CreateTimeline()
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''object''' ''timeline''
* CreateTimelineFromVirtual('''string''' ''timelineName'', '''object''' ''animatedControl'')
* CreateTimelineFromVirtual('''string''' ''timelineName'', '''object''' ''animatedControl'')
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''object''' ''timeline''
-
=== AnimationObject ===
+
===AnimationObject===
 +
 
 +
Objects that inherit behavior from '''AnimationObject'''
 +
 
 +
 
 +
* [[#AnimationObjectAlpha]],
 +
* [[#AnimationObjectColor]],
 +
* [[#AnimationObjectCustom]],
 +
* [[#AnimationObjectScale]],
 +
* [[#AnimationObjectScroll]],
 +
* [[#AnimationObjectSize]],
 +
* [[#AnimationObjectTexture]],
 +
* [[#AnimationObjectTexture3DRotate]],
 +
* [[#AnimationObjectTexture3DTranslate]],
 +
* [[#AnimationObjectTextureRotate]],
 +
* [[#AnimationObjectTextureSlide]],
 +
* [[#AnimationObjectTranslate]]
 +
 
* GetAnimatedControl()
* GetAnimatedControl()
-
** ''Returns:'' '''object''' ''animatedControl''
+
** '''Returns:''' '''object''' ''animatedControl''
* GetDuration()
* GetDuration()
-
** ''Returns:'' '''integer''' ''durationMs''
+
** '''Returns:''' '''number''' ''durationMs''
* GetEasingFunction()
* GetEasingFunction()
-
** ''Returns:'' '''function''' ''functionRef''
+
** '''Returns:''' '''function''' ''functionRef''
* GetHandler('''string''' ''EventName'')
* GetHandler('''string''' ''EventName'')
-
** ''Returns:'' '''function''' ''FunctionRef''
+
** '''Returns:''' '''function''' ''FunctionRef''
* GetTimeline()
* GetTimeline()
-
** ''Returns:'' '''object''' ''owningTimeline''
+
** '''Returns:''' '''object''' ''owningTimeline''
* IsPlaying()
* IsPlaying()
-
** ''Returns:'' '''bool''' ''isPlaying''
+
** '''Returns:''' '''boolean''' ''isPlaying''
* SetAnimatedControl('''object''' ''animatedControl'')
* SetAnimatedControl('''object''' ''animatedControl'')
-
* SetDuration('''integer''' ''durationMs'')
+
* SetDuration('''number''' ''durationMs'')
* SetEasingFunction('''function''' ''functionRef'')
* SetEasingFunction('''function''' ''functionRef'')
* SetHandler('''string''' ''EventName'', '''function''' ''FunctionRef'')
* SetHandler('''string''' ''EventName'', '''function''' ''FunctionRef'')
-
 
-
==== Objects that inherit behavior from '''AnimationObject''' ====
 
-
 
-
* [[#AnimationObjectAlpha|AnimationObjectAlpha]]
 
-
* [[#AnimationObjectColor|AnimationObjectColor]]
 
-
* [[#AnimationObjectCustom|AnimationObjectCustom]]
 
-
* [[#AnimationObjectScale|AnimationObjectScale]]
 
-
* [[#AnimationObjectScroll|AnimationObjectScroll]]
 
-
* [[#AnimationObjectSize|AnimationObjectSize]]
 
-
* [[#AnimationObjectTexture|AnimationObjectTexture]]
 
-
* [[#AnimationObjectTextureRotate|AnimationObjectTextureRotate]]
 
-
* [[#AnimationObjectTextureSlide|AnimationObjectTextureSlide]]
 
-
* [[#AnimationObjectTranslate|AnimationObjectTranslate]]
 
-
=== AnimationObjectAlpha ===
+
===AnimationObjectAlpha===
* GetEndAlpha()
* GetEndAlpha()
-
** ''Returns:'' '''number''' ''endAlpha''
+
** '''Returns:''' '''number''' ''endAlpha''
* GetStartAlpha()
* GetStartAlpha()
-
** ''Returns:'' '''number''' ''startAlpha''
+
** '''Returns:''' '''number''' ''startAlpha''
* SetAlphaValues('''number''' ''startAlpha'', '''number''' ''endAlpha'')
* SetAlphaValues('''number''' ''startAlpha'', '''number''' ''endAlpha'')
Line 315: Line 146:
-
=== AnimationObjectColor ===
+
===AnimationObjectColor===
* GetEndColor()
* GetEndColor()
-
** ''Returns:'' '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA''
+
** '''Returns:''' '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA''
* GetStartColor()
* GetStartColor()
-
** ''Returns:'' '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA''
+
** '''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'')
* SetColorValues('''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
Line 329: Line 160:
-
=== AnimationObjectCustom ===
+
===AnimationObjectCustom===
* SetUpdateFunction('''function''' ''functionRef'')
* SetUpdateFunction('''function''' ''functionRef'')
-
=== AnimationObjectScale ===
+
===AnimationObjectScale===
* GetEndScale()
* GetEndScale()
-
** ''Returns:'' '''number''' ''endScale''
+
** '''Returns:''' '''number''' ''endScale''
* GetStartScale()
* GetStartScale()
-
** ''Returns:'' '''number''' ''startScale''
+
** '''Returns:''' '''number''' ''startScale''
* SetEndScale('''number''' ''endScale'')
* SetEndScale('''number''' ''endScale'')
Line 347: Line 178:
-
=== AnimationObjectScroll ===
+
===AnimationObjectScroll===
* SetHorizontalEnd('''number''' ''endX'')
* SetHorizontalEnd('''number''' ''endX'')
Line 361: Line 192:
-
=== AnimationObjectSize ===
+
===AnimationObjectSize===
* SetEndHeight('''number''' ''endHeight'')
* SetEndHeight('''number''' ''endHeight'')
Line 375: Line 206:
-
=== AnimationObjectTexture ===
+
===AnimationObjectTexture===
* GetCellsHigh()
* GetCellsHigh()
-
** ''Returns:'' '''integer''' ''aNumCellsHigh''
+
** '''Returns:''' '''number''' ''aNumCellsHigh''
* GetCellsWide()
* GetCellsWide()
-
** ''Returns:'' '''integer''' ''aNumCellsWide''
+
** '''Returns:''' '''number''' ''aNumCellsWide''
* IsMirroringAlongX()
* IsMirroringAlongX()
-
** ''Returns:'' '''bool''' ''mirroring''
+
** '''Returns:''' '''boolean''' ''mirroring''
* IsMirroringAlongY()
* IsMirroringAlongY()
-
** ''Returns:'' '''bool''' ''mirroring''
+
** '''Returns:''' '''boolean''' ''mirroring''
-
* SetCellsHigh('''integer''' ''aNumCellsHigh'')
+
* SetCellsHigh('''number''' ''aNumCellsHigh'')
-
* SetCellsWide('''integer''' ''aNumCellsWide'')
+
* SetCellsWide('''number''' ''aNumCellsWide'')
* SetFramerate('''number''' ''framesPerSecond'')
* SetFramerate('''number''' ''framesPerSecond'')
-
* SetImageData('''integer''' ''aNumCellsWide'', '''integer''' ''aNumCellsHigh'')
+
* SetImageData('''number''' ''aNumCellsWide'', '''number''' ''aNumCellsHigh'')
-
* SetMirrorAlongX('''bool''' ''mirroring'')
+
* SetMirrorAlongX('''boolean''' ''mirroring'')
-
* SetMirrorAlongY('''bool''' ''mirroring'')
+
* SetMirrorAlongY('''boolean''' ''mirroring'')
-
=== AnimationObjectTextureRotate ===
+
===AnimationObjectTexture3DRotate===
 +
* GetEndPitch()
 +
** '''Returns:''' '''number''' ''endPitchRadians''
 +
 
 +
* GetEndRoll()
 +
** '''Returns:''' '''number''' ''endRollRadians''
 +
 
 +
* GetEndYaw()
 +
** '''Returns:''' '''number''' ''endYawRadians''
 +
 
 +
* GetStartPitch()
 +
** '''Returns:''' '''number''' ''startPitchRadians''
 +
 
 +
* GetStartRoll()
 +
** '''Returns:''' '''number''' ''startRollRadians''
 +
 
 +
* GetStartYaw()
 +
** '''Returns:''' '''number''' ''startYawRadians''
 +
 
 +
* SetEndPitch('''number''' ''endPitchRadians'')
 +
 
 +
* SetEndRoll('''number''' ''endRollRadians'')
 +
 
 +
* SetEndYaw('''number''' ''endYawRadians'')
 +
 
 +
* SetRotationValues('''number''' ''startPitchRadians'', '''number''' ''startYawRadians'', '''number''' ''startRollRadians'', '''number''' ''endPitchRadians'', '''number''' ''endYawRadians'', '''number''' ''endRollRadians'')
 +
 
 +
* SetStartPitch('''number''' ''startPitchRadians'')
 +
 
 +
* SetStartRoll('''number''' ''startRollRadians'')
 +
 
 +
* SetStartYaw('''number''' ''startYawRadians'')
 +
 
 +
 
 +
===AnimationObjectTexture3DTranslate===
 +
* ClearBezierControlPoints()
 +
 
 +
* GetDeltaOffsetX()
 +
** '''Returns:''' '''number''' ''deltaX''
 +
 
 +
* GetDeltaOffsetY()
 +
** '''Returns:''' '''number''' ''deltaY''
 +
 
 +
* GetDeltaOffsetZ()
 +
** '''Returns:''' '''number''' ''deltaZ''
 +
 
 +
* GetEndOffsetX()
 +
** '''Returns:''' '''number''' ''endX''
 +
 
 +
* GetEndOffsetY()
 +
** '''Returns:''' '''number''' ''endY''
 +
 
 +
* GetEndOffsetZ()
 +
** '''Returns:''' '''number''' ''endZ''
 +
 
 +
* GetStartOffsetX()
 +
** '''Returns:''' '''number''' ''startX''
 +
 
 +
* GetStartOffsetY()
 +
** '''Returns:''' '''number''' ''startY''
 +
 
 +
* GetStartOffsetZ()
 +
** '''Returns:''' '''number''' ''startZ''
 +
 
 +
* GetTranslateDeltas()
 +
** '''Returns:''' '''number''' ''deltaX'', '''number''' ''deltaY'', '''number''' ''deltaZ''
 +
 
 +
* SetBezierControlPoint('''number''' ''index'', '''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
 +
 
 +
* SetDeltaOffsetX('''number''' ''deltaX'', ''number'' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* SetDeltaOffsetY('''number''' ''deltaY'', ''number'' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* SetDeltaOffsetZ('''number''' ''deltaZ'', ''number'' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* SetEndOffsetX('''number''' ''endX'')
 +
 
 +
* SetEndOffsetY('''number''' ''endY'')
 +
 
 +
* SetEndOffsetZ('''number''' ''endZ'')
 +
 
 +
* SetStartOffsetX('''number''' ''startX'')
 +
 
 +
* SetStartOffsetY('''number''' ''startY'')
 +
 
 +
* SetStartOffsetZ('''number''' ''startZ'')
 +
 
 +
* SetTranslateDeltas('''number''' ''deltaX'', '''number''' ''deltaY'', '''number''' ''deltaZ'', ''number'' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
 +
 
 +
* SetTranslateOffsets('''number''' ''startX'', '''number''' ''startY'', '''number''' ''startZ'', '''number''' ''endX'', '''number''' ''endY'', '''number''' ''endZ'')
 +
 
 +
 
 +
===AnimationObjectTextureRotate===
* GetEndRotation()
* GetEndRotation()
-
** ''Returns:'' '''number''' ''endRadians''
+
** '''Returns:''' '''number''' ''endRadians''
* GetStartRotation()
* GetStartRotation()
-
** ''Returns:'' '''number''' ''startRadians''
+
** '''Returns:''' '''number''' ''startRadians''
* SetEndRotation('''number''' ''endRadians'')
* SetEndRotation('''number''' ''endRadians'')
Line 415: Line 338:
-
=== AnimationObjectTextureSlide ===
+
===AnimationObjectTextureSlide===
* SetSlideDistances('''number''' ''slideDistanceU'', '''number''' ''slideDistanceV'')
* SetSlideDistances('''number''' ''slideDistanceU'', '''number''' ''slideDistanceV'')
-
=== AnimationObjectTranslate ===
+
===AnimationObjectTranslate===
 +
* GetAnchorIndex()
 +
** '''Returns:''' '''number''' ''anchorIndex''
 +
 
* GetDeltaOffsetX()
* GetDeltaOffsetX()
-
** ''Returns:'' '''number''' ''deltaX''
+
** '''Returns:''' '''number''' ''deltaX''
* GetDeltaOffsetY()
* GetDeltaOffsetY()
-
** ''Returns:'' '''number''' ''deltaY''
+
** '''Returns:''' '''number''' ''deltaY''
* GetEndOffsetX()
* GetEndOffsetX()
-
** ''Returns:'' '''number''' ''endX''
+
** '''Returns:''' '''number''' ''endX''
* GetEndOffsetY()
* GetEndOffsetY()
-
** ''Returns:'' '''number''' ''endY''
+
** '''Returns:''' '''number''' ''endY''
* GetStartOffsetX()
* GetStartOffsetX()
-
** ''Returns:'' '''number''' ''startX''
+
** '''Returns:''' '''number''' ''startX''
* GetStartOffsetY()
* GetStartOffsetY()
-
** ''Returns:'' '''number''' ''startY''
+
** '''Returns:''' '''number''' ''startY''
* GetTranslateDeltas()
* GetTranslateDeltas()
-
** ''Returns:'' '''number''' ''deltaX'', '''number''' ''deltaY''
+
** '''Returns:''' '''number''' ''deltaX'', '''number''' ''deltaY''
-
* SetAnchorIndex('''integer''' ''anchorIndex'')
+
* SetAnchorIndex('''number''' ''anchorIndex'')
-
* SetDeltaOffsetX('''number''' ''deltaX'')
+
* SetDeltaOffsetX('''number''' ''deltaX'', ''number'' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
-
* SetDeltaOffsetY('''number''' ''deltaY'')
+
* SetDeltaOffsetY('''number''' ''deltaY'', ''number'' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
* SetEndOffsetX('''number''' ''endX'')
* SetEndOffsetX('''number''' ''endX'')
Line 455: Line 381:
* SetStartOffsetY('''number''' ''startY'')
* SetStartOffsetY('''number''' ''startY'')
-
* SetTranslateDeltas('''number''' ''deltaX'', '''number''' ''deltaY'')
+
* SetTranslateDeltas('''number''' ''deltaX'', '''number''' ''deltaY'', ''number'' [[Globals#TranslateAnimationDeltaType|TranslateAnimationDeltaType]] ''translateAnimationDeltaType'')
* SetTranslateOffsets('''number''' ''startX'', '''number''' ''startY'', '''number''' ''endX'', '''number''' ''endY'')
* SetTranslateOffsets('''number''' ''startX'', '''number''' ''startY'', '''number''' ''endX'', '''number''' ''endY'')
-
=== AnimationTimeline ===
+
===AnimationTimeline===
* ApplyAllAnimationsToControl('''object''' ''animatedControl'')
* ApplyAllAnimationsToControl('''object''' ''animatedControl'')
* ClearAllCallbacks()
* ClearAllCallbacks()
-
* GetAnimation('''luaindex''' ''animationIndex'')
+
* GetAnimation('''number''' ''animationIndex'')
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''object''' ''animation''
* GetAnimationOffset('''object''' ''animation'')
* GetAnimationOffset('''object''' ''animation'')
-
** ''Returns:'' '''integer''' ''offset''
+
** '''Returns:''' '''number''' ''offset''
-
* GetAnimationTimeline('''luaindex''' ''timelineIndex'')
+
* GetAnimationTimeline('''number''' ''timelineIndex'')
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''object''' ''timeline''
* GetAnimationTimelineOffset('''object''' ''animation'')
* GetAnimationTimelineOffset('''object''' ''animation'')
-
** ''Returns:'' '''integer''' ''offset''
+
** '''Returns:''' '''number''' ''offset''
* GetDuration()
* GetDuration()
-
** ''Returns:'' '''integer''' ''duration''
+
** '''Returns:''' '''number''' ''duration''
* GetFirstAnimation()
* GetFirstAnimation()
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''object''' ''animation''
* GetFirstAnimationTimeline()
* GetFirstAnimationTimeline()
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''object''' ''timeline''
* GetFullProgress()
* GetFullProgress()
-
** ''Returns:'' '''number''' ''progress''
+
** '''Returns:''' '''number''' ''progress''
* GetHandler('''string''' ''EventName'')
* GetHandler('''string''' ''EventName'')
-
** ''Returns:'' '''function''' ''FunctionRef''
+
** '''Returns:''' '''function''' ''FunctionRef''
* GetLastAnimation()
* GetLastAnimation()
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''object''' ''animation''
* GetLastAnimationTimeline()
* GetLastAnimationTimeline()
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''object''' ''timeline''
* GetNumAnimationTimelines()
* GetNumAnimationTimelines()
-
** ''Returns:'' '''integer''' ''numTimelines''
+
** '''Returns:''' '''number''' ''numTimelines''
* GetNumAnimations()
* GetNumAnimations()
-
** ''Returns:'' '''integer''' ''numAnimations''
+
** '''Returns:''' '''number''' ''numAnimations''
* GetParent()
* GetParent()
-
** ''Returns:'' '''object''' ''timeline''
+
** '''Returns:''' '''object''' ''timeline''
 +
 
 +
* GetPlaybackLoopsRemaining()
 +
** '''Returns:''' '''number''' ''loopsRemaining''
* GetProgress()
* GetProgress()
-
** ''Returns:'' '''number''' ''progress''
+
** '''Returns:''' '''number''' ''progress''
 +
 
 +
* GetSkipAnimationsBehindPlayheadOnInitialPlay()
 +
** '''Returns:''' '''boolean''' ''skipAnimations''
-
* InsertAnimation('''integer''' ''animationType'', '''object''' ''animatedControl'', '''integer''' ''offset'')
+
* InsertAnimation('''number''' ''animationType'', '''object''' ''animatedControl'', '''number''' ''offset'')
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''object''' ''animation''
* InsertAnimationFromVirtual('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
* InsertAnimationFromVirtual('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''object''' ''animation''
-
* InsertAnimationTimeline('''integer''' ''offset'', '''object''' ''animatedControl'')
+
* InsertAnimationTimeline('''number''' ''offset'', '''object''' ''animatedControl'')
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''object''' ''animation''
* InsertAnimationTimelineFromVirtual('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
* InsertAnimationTimelineFromVirtual('''string''' ''animationVirtualName'', '''object''' ''animatedControl'')
-
** ''Returns:'' '''object''' ''animation''
+
** '''Returns:''' '''object''' ''animation''
-
* InsertCallback('''function''' ''functionRef'', '''integer''' ''offset'')
+
* InsertCallback('''function''' ''functionRef'', '''number''' ''offset'')
-
** ''Returns:'' '''function''' ''functionRefRet''
+
** '''Returns:''' '''function''' ''functionRefRet''
* IsPlaying()
* IsPlaying()
-
** ''Returns:'' '''bool''' ''isPlaying''
+
** '''Returns:''' '''boolean''' ''isPlaying''
* IsPlayingBackward()
* IsPlayingBackward()
-
** ''Returns:'' '''bool''' ''reversed''
+
** '''Returns:''' '''boolean''' ''reversed''
* PlayBackward()
* PlayBackward()
Line 535: Line 467:
* PlayForward()
* PlayForward()
-
* PlayFromEnd('''integer''' ''offsetMs'')
+
* PlayFromEnd('''number''' ''offsetMs'')
-
* PlayFromStart('''integer''' ''offsetMs'')
+
* PlayFromStart('''number''' ''offsetMs'')
* PlayInstantlyToEnd()
* PlayInstantlyToEnd()
Line 543: Line 475:
* PlayInstantlyToStart()
* PlayInstantlyToStart()
-
* SetAnimationOffset('''object''' ''animation'', '''integer''' ''offset'')
+
* SetAnimationOffset('''object''' ''animation'', '''number''' ''offset'')
-
* SetAnimationTimelineOffset('''object''' ''animation'', '''integer''' ''offset'')
+
* SetAnimationTimelineOffset('''object''' ''animation'', '''number''' ''offset'')
-
* SetCallbackOffset('''function''' ''callback'', '''integer''' ''offset'')
+
* SetCallbackOffset('''function''' ''callback'', '''number''' ''offset'')
* SetHandler('''string''' ''EventName'', '''function''' ''FunctionRef'')
* SetHandler('''string''' ''EventName'', '''function''' ''FunctionRef'')
-
* SetPlaybackType('''integer''' ''playbackType'', '''integer''' ''maxLoopCount'')
+
* SetPlaybackLoopCount('''number''' ''maxLoopCount'')
 +
 
 +
* SetPlaybackLoopsRemaining('''number''' ''loopsRemaining'')
 +
 
 +
* SetPlaybackType('''number''' ''playbackType'', '''number''' ''maxLoopCount'')
* SetProgress('''number''' ''progress'')
* SetProgress('''number''' ''progress'')
 +
 +
* SetSkipAnimationsBehindPlayheadOnInitialPlay('''boolean''' ''skipAnimations'')
* Stop()
* Stop()
-
=== BackdropControl ===
+
===BackdropControl===
* GetCenterColor()
* GetCenterColor()
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* IsPixelRoundingEnabled()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
* SetCenterColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetCenterColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetCenterTexture('''string''' ''filename'', '''integer''' ''tileSize'', '''integer''' ''addressMode'')
+
* SetCenterTexture('''string''' ''filename'', '''number''' ''tileSize'', '''number''' ''addressMode'')
* SetEdgeColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetEdgeColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetEdgeTexture('''string''' ''filename'', '''integer''' ''edgeFileWidth'', '''integer''' ''edgeFileHeight'', '''integer''' ''edgeSize'', '''integer''' ''edgeFilePadding'')
+
* SetEdgeTexture('''string''' ''filename'', '''number''' ''edgeFileWidth'', '''number''' ''edgeFileHeight'', '''number''' ''edgeSize'', '''number''' ''edgeFilePadding'')
* SetInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
* SetInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
-
* SetIntegralWrapping('''bool''' ''integralWrappingEnabled'')
+
* SetIntegralWrapping('''boolean''' ''integralWrappingEnabled'')
-
* SetPixelRoundingEnabled('''bool''' ''enabled'')
+
* SetPixelRoundingEnabled('''boolean''' ''enabled'')
 +
* SetTextureReleaseOption(''number'' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
-
=== BrowserControl ===
 
-
* Open('''integer''' ''param1'', '''integer''' ''param2'', '''integer''' ''param3'', '''string''' ''text'')
 
-
 
+
===ButtonControl===
-
=== ButtonControl ===
+
* EnableMouseButton('''number''' ''buttonNum'', '''boolean''' ''enabled'')
-
* EnableMouseButton('''integer''' ''buttonNum'', '''bool''' ''enabled'')
+
* GetLabelControl()
* GetLabelControl()
-
** ''Returns:'' '''object''' ''labelControl''
+
** '''Returns:''' '''object''' ''labelControl''
* GetState()
* GetState()
-
** ''Returns:'' '''integer''' ''state''
+
** '''Returns:''' '''number''' ''state''
 +
 
 +
* IsPixelRoundingEnabled()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
* SetClickSound('''string''' ''clickSound'')
* SetClickSound('''string''' ''clickSound'')
Line 602: Line 544:
* SetDisabledTexture('''string''' ''textureFilename'')
* SetDisabledTexture('''string''' ''textureFilename'')
-
* SetEnabled('''bool''' ''enabled'')
+
* SetEnabled('''boolean''' ''enabled'')
-
* SetEndCapWidth('''integer''' ''endCapWidth'')
+
* SetEndCapWidth('''number''' ''endCapWidth'')
* SetFont('''string''' ''text'')
* SetFont('''string''' ''text'')
-
* SetHorizontalAlignment('''integer''' ''horizontalAlign'')
+
* SetHorizontalAlignment('''number''' ''horizontalAlign'')
-
* SetMouseOverBlendMode('''integer''' ''blendMode'')
+
* SetMouseOverBlendMode('''number''' ''blendMode'')
* SetMouseOverFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetMouseOverFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 621: Line 563:
* SetNormalTexture('''string''' ''textureFilename'')
* SetNormalTexture('''string''' ''textureFilename'')
 +
 +
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
* SetPressedFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetPressedFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 630: Line 574:
* SetPressedTexture('''string''' ''textureFilename'')
* SetPressedTexture('''string''' ''textureFilename'')
-
* SetState('''integer''' ''newState'', '''bool''' ''locked'')
+
* SetShowingHighlight('''boolean''' ''showingHighlight'')
 +
 
 +
* SetState('''number''' ''newState'', '''boolean''' ''locked'')
* SetText('''string''' ''text'')
* SetText('''string''' ''text'')
Line 636: Line 582:
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
* SetTextureCoords('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
-
* SetVerticalAlignment('''integer''' ''verticalAlign'')
+
* SetTextureReleaseOption(''number'' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
* SetVerticalAlignment('''number''' ''verticalAlign'')
-
=== ColorSelectControl ===
+
===ColorSelectControl===
* GetColorAsHSV()
* GetColorAsHSV()
-
** ''Returns:'' '''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value''
+
** '''Returns:''' '''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value''
* GetColorAsRGB()
* GetColorAsRGB()
-
** ''Returns:'' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
+
** '''Returns:''' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
* GetColorWheelTextureControl()
* GetColorWheelTextureControl()
-
** ''Returns:'' '''object''' ''textureControl''
+
** '''Returns:''' '''object''' ''textureControl''
* GetColorWheelThumbTextureControl()
* GetColorWheelThumbTextureControl()
-
** ''Returns:'' '''object''' ''textureControl''
+
** '''Returns:''' '''object''' ''textureControl''
* GetFullValuedColorAsRGB()
* GetFullValuedColorAsRGB()
-
** ''Returns:'' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
+
** '''Returns:''' '''number''' ''red'', '''number''' ''green'', '''number''' ''blue''
* GetValue()
* GetValue()
-
** ''Returns:'' '''number''' ''value''
+
** '''Returns:''' '''number''' ''value''
* SetColorAsHSV('''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value'')
* SetColorAsHSV('''number''' ''hue'', '''number''' ''saturation'', '''number''' ''value'')
Line 667: Line 615:
-
=== CompassDisplayControl ===
+
===CompassDisplayControl===
-
* GetAlphaCoefficients('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'')
+
* GetAlphaCoefficients(''number'' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'')
-
** ''Returns:'' '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant''
+
** '''Returns:''' '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant''
-
* GetCenterOveredPinInfo('''luaindex''' ''centerOveredPinIndex'')
+
* GetCenterOveredPinInfo('''number''' ''centerOveredPinIndex'')
-
** ''Returns:'' '''string''' ''description'', '''integer''' ''type'', '''number''' ''distance'', '''[[Globals#DrawLayer|DrawLayer]]''' ''drawLayer'', '''integer''' ''drawLevel'', '''bool''' ''suppressed''
+
** '''Returns:''' '''string''' ''description'', '''number''' ''type'', '''number''' ''distance'', ''number'' [[Globals#DrawLayer|DrawLayer]] ''drawLayer'', '''number''' ''drawLevel'', '''boolean''' ''suppressed''
-
* GetMinVisibleAlpha('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'')
+
* GetMinVisibleAlpha(''number'' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'')
-
** ''Returns:'' '''number''' ''minVisibleAlpha''
+
** '''Returns:''' '''number''' ''minVisibleAlpha''
-
* GetMinVisibleScale('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'')
+
* GetMinVisibleScale(''number'' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'')
-
** ''Returns:'' '''number''' ''minVisibleScale''
+
** '''Returns:''' '''number''' ''minVisibleScale''
* GetNumCenterOveredPins()
* GetNumCenterOveredPins()
-
** ''Returns:'' '''integer''' ''numCenterOveredPins''
+
** '''Returns:''' '''number''' ''numCenterOveredPins''
-
* GetScaleCoefficients('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'')
+
* GetScaleCoefficients(''number'' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'')
-
** ''Returns:'' '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant''
+
** '''Returns:''' '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant''
-
* SetAlphaCoefficients('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
+
* SetAlphaCoefficients(''number'' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
-
* SetCardinalDirection('''string''' ''directionName'', '''string''' ''font'', '''integer''' ''cardinalDirection'')
+
* SetCardinalDirection('''string''' ''directionName'', '''string''' ''font'', '''number''' ''cardinalDirection'')
-
* SetMinVisibleAlpha('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'', '''number''' ''minVisibleAlpha'')
+
* SetMinVisibleAlpha(''number'' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''minVisibleAlpha'')
-
* SetMinVisibleScale('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'', '''number''' ''minVisibleScale'')
+
* SetMinVisibleScale(''number'' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''minVisibleScale'')
-
* SetScaleCoefficients('''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
+
* SetScaleCoefficients(''number'' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
-
=== EventManager ===
 
-
(E.g. <code>EVENT_MANAGER</code>)
+
===Control===
-
* RegisterForEvent('''integer''' ''event'', '''function''' ''callback'')
+
Objects that inherit behavior from '''Control'''
-
** ''Returns:'' '''bool''' ''success''
+
-
* UnregisterForEvent('''integer''' ''event'')
 
-
** ''Returns:'' '''bool''' ''success''
 
 +
* [[#BackdropControl]],
 +
* [[#ButtonControl]],
 +
* [[#ColorSelectControl]],
 +
* [[#CompassDisplayControl]],
 +
* [[#CooldownControl]],
 +
* [[#DebugTextControl]],
 +
* [[#EditControl]],
 +
* [[#LabelControl]],
 +
* [[#LineControl]],
 +
* [[#MapDisplayControl]],
 +
* [[#RootWindow]],
 +
* [[#ScrollControl]],
 +
* [[#SliderControl]],
 +
* [[#StatusBarControl]],
 +
* [[#TextBufferControl]],
 +
* [[#TextureCompositeControl]],
 +
* [[#TextureControl]],
 +
* [[#TooltipControl]],
 +
* [[#TopLevelWindow]]
-
=== CooldownControl ===
+
 
 +
 
 +
* AddFilterForEvent('''number''' ''event'')
 +
** '''Returns:''' '''boolean''' ''success''
 +
 
 +
* {{Protected_attributes}} ClearAnchors ()
 +
 
 +
* CreateControl('''string''' ''arg1'', '''number''' ''type'')
 +
** '''Returns:''' '''object''' ''apRet''
 +
 
 +
* GetAlpha()
 +
** '''Returns:''' '''number''' ''alpha''
 +
 
 +
* GetAnchor('''number''' ''anchorIndex'')
 +
** '''Returns:''' '''boolean''' ''isValidAnchor'', '''number''' ''point'', '''object''' ''relativeTo'', '''number''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY'', ''number'' [[Globals#AnchorConstrains|AnchorConstrains]] ''anchorConstrains''
 +
 
 +
* GetBottom()
 +
** '''Returns:''' '''number''' ''bottom''
 +
 
 +
* GetCenter()
 +
** '''Returns:''' '''number''' ''centerX'', '''number''' ''centerY''
 +
 
 +
* GetChild('''number''' ''childIndex'')
 +
** '''Returns:''' '''object''' ''childControl''
 +
 
 +
* GetClampedToScreen()
 +
** '''Returns:''' '''boolean''' ''clamped''
 +
 
 +
* GetClampedToScreenInsets()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 
 +
* GetControlAlpha()
 +
** '''Returns:''' '''number''' ''alpha''
 +
 
 +
* GetControlScale()
 +
** '''Returns:''' '''number''' ''scale''
 +
 
 +
* GetDesiredHeight()
 +
** '''Returns:''' '''number''' ''height''
 +
 
 +
* GetDesiredWidth()
 +
** '''Returns:''' '''number''' ''width''
 +
 
 +
* GetDimensionConstraints()
 +
** '''Returns:''' '''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight''
 +
 
 +
* GetDimensions()
 +
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
 +
 
 +
* GetDrawLayer()
 +
** '''Returns:''' '''number''' ''layer''
 +
 
 +
* GetDrawLevel()
 +
** '''Returns:''' '''number''' ''level''
 +
 
 +
* GetDrawTier()
 +
** '''Returns:''' '''number''' ''tier''
 +
 
 +
* GetExcludeFromResizeToFitExtents()
 +
** '''Returns:''' '''boolean''' ''excludes''
 +
 
 +
* GetHandler('''string''' ''handlerName'')
 +
** '''Returns:''' '''function''' ''functionRef''
 +
 
 +
* GetHeight()
 +
** '''Returns:''' '''number''' ''height''
 +
 
 +
* GetHitInsets()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 
 +
* GetId()
 +
** '''Returns:''' '''number''' ''id''
 +
 
 +
* GetInheritsAlpha()
 +
** '''Returns:''' '''boolean''' ''inheritAlpha''
 +
 
 +
* GetInheritsScale()
 +
** '''Returns:''' '''boolean''' ''inheritScale''
 +
 
 +
* GetLeft()
 +
** '''Returns:''' '''number''' ''left''
 +
 
 +
* GetName()
 +
** '''Returns:''' '''string''' ''name''
 +
 
 +
* GetNamedChild('''string''' ''childName'')
 +
** '''Returns:''' '''object''' ''returnedControl''
 +
 
 +
* GetNumChildren()
 +
** '''Returns:''' '''number''' ''numChildren''
 +
 
 +
* GetOwningWindow()
 +
** '''Returns:''' '''object''' ''OwningTopLevelWindow''
 +
 
 +
* GetParent()
 +
** '''Returns:''' '''object''' ''ret1''
 +
 
 +
* GetResizeToFitDescendents()
 +
** '''Returns:''' '''boolean''' ''resizes''
 +
 
 +
* GetResizeToFitPadding()
 +
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
 +
 
 +
* GetRight()
 +
** '''Returns:''' '''number''' ''right''
 +
 
 +
* GetScale()
 +
** '''Returns:''' '''number''' ''scale''
 +
 
 +
* GetScreenRect()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom''
 +
 
 +
* GetTop()
 +
** '''Returns:''' '''number''' ''top''
 +
 
 +
* GetType()
 +
** '''Returns:''' '''number''' ''type''
 +
 
 +
* GetWidth()
 +
** '''Returns:''' '''number''' ''width''
 +
 
 +
* IsChildOf('''object''' ''desiredParent'')
 +
** '''Returns:''' '''boolean''' ''isChild''
 +
 
 +
* IsControlHidden()
 +
** '''Returns:''' '''boolean''' ''hidden''
 +
 
 +
* IsHandlerSet('''string''' ''handlerName'')
 +
** '''Returns:''' '''boolean''' ''isSet''
 +
 
 +
* IsHidden()
 +
** '''Returns:''' '''boolean''' ''hidden''
 +
 
 +
* IsKeyboardEnabled()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* IsMouseEnabled()
 +
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* IsPointInside('''number''' ''x'', '''number''' ''y'', '''number''' ''leftOffset'', '''number''' ''topOffset'', '''number''' ''rightOffset'', '''number''' ''bottomOffset'')
 +
** '''Returns:''' '''boolean''' ''isInside''
 +
 
 +
* RegisterForEvent('''number''' ''event'', '''function''' ''callback'')
 +
** '''Returns:''' '''boolean''' ''success''
 +
 
 +
* {{Protected_attributes}} SetAlpha ('''number''' ''alpha'')
 +
 
 +
* {{Protected_attributes}} SetAnchor ('''number''' ''whereOnMe'', '''object''' ''anchorTargetControl'', '''number''' ''whereOnTarget'', '''number''' ''offsetX'', '''number''' ''offsetY'', ''number'' [[Globals#AnchorConstrains|AnchorConstrains]] ''anchorConstrains'')
 +
 
 +
* {{Protected_attributes}} SetAnchorFill ('''object''' ''anchorTargetControl'')
 +
 
 +
* SetClampedToScreen('''boolean''' ''clamped'')
 +
 
 +
* SetClampedToScreenInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 
 +
* SetDimensionConstraints('''number''' ''minWidth'', '''number''' ''minHeight'', '''number''' ''maxWidth'', '''number''' ''maxHeight'')
 +
 
 +
* {{Protected_attributes}} SetDimensions ('''number''' ''width'', '''number''' ''height'')
 +
 
 +
* {{Protected_attributes}} SetDrawLayer ('''number''' ''layer'')
 +
 
 +
* {{Protected_attributes}} SetDrawLevel ('''number''' ''level'')
 +
 
 +
* {{Protected_attributes}} SetDrawTier ('''number''' ''tier'')
 +
 
 +
* {{Protected_attributes}} SetExcludeFromResizeToFitExtents ('''boolean''' ''exclude'')
 +
 
 +
* SetHandler('''string''' ''handlerName'', '''function''' ''functionRef'')
 +
 
 +
* {{Protected_attributes}} SetHeight ('''number''' ''height'')
 +
 
 +
* {{Protected_attributes}} SetHidden ('''boolean''' ''aHidden'')
 +
 
 +
* SetHitInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
 +
 
 +
* SetId('''number''' ''id'')
 +
 
 +
* SetInheritAlpha('''boolean''' ''inheritAlpha'')
 +
 
 +
* SetInheritScale('''boolean''' ''inheritScale'')
 +
 
 +
* {{Protected_attributes}} SetKeyboardEnabled ('''boolean''' ''enabled'')
 +
 
 +
* {{Protected_attributes}} SetMouseEnabled ('''boolean''' ''enabled'')
 +
 
 +
* SetMovable('''boolean''' ''isMovable'')
 +
 
 +
* {{Protected_attributes}} SetParent ('''object''' ''newParent'')
 +
 
 +
* SetResizeHandleSize('''number''' ''handleSize'')
 +
 
 +
* {{Protected_attributes}} SetResizeToFitDescendents ('''boolean''' ''resize'')
 +
 
 +
* SetResizeToFitPadding('''number''' ''width'', '''number''' ''height'')
 +
 
 +
* {{Protected_attributes}} SetScale ('''number''' ''scale'')
 +
 
 +
* SetShapeType *public* ('''number''' ''shapeType'')
 +
 
 +
* {{Protected_attributes}} SetSimpleAnchor ('''object''' ''anchorTargetControl'', '''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 
 +
* {{Protected_attributes}} SetSimpleAnchorParent ('''number''' ''offsetX'', '''number''' ''offsetY'')
 +
 
 +
* {{Protected_attributes}} SetWidth ('''number''' ''width'')
 +
 
 +
* {{Protected_attributes}} StartMoving ()
 +
** '''Returns:''' '''boolean''' ''isMoving''
 +
 
 +
* {{Protected_attributes}} StopMovingOrResizing ()
 +
 
 +
* {{Protected_attributes}} ToggleHidden ()
 +
 
 +
* UnregisterForEvent('''number''' ''event'')
 +
** '''Returns:''' '''boolean''' ''success''
 +
 
 +
 
 +
===CooldownControl===
* GetDuration()
* GetDuration()
-
** ''Returns:'' '''integer''' ''duration''
+
** '''Returns:''' '''number''' ''duration''
 +
 
 +
* GetPercentCompleteFixed()
 +
** '''Returns:''' '''number''' ''percentComplete''
* GetTimeLeft()
* GetTimeLeft()
-
** ''Returns:'' '''integer''' ''time''
+
** '''Returns:''' '''number''' ''time''
* ResetCooldown()
* ResetCooldown()
-
* SetBlendMode('''integer''' ''blendMode'')
+
* SetBlendMode('''number''' ''blendMode'')
-
* SetCooldownRemainTime('''integer''' ''remain'')
+
* SetCooldownRemainTime('''number''' ''remain'')
 +
 
 +
* SetDesaturation('''number''' ''desaturation'')
* SetFillColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetFillColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetLeadingEdgeTexture('''string''' ''filename'')
* SetLeadingEdgeTexture('''string''' ''filename'')
 +
 +
* SetPercentCompleteFixed('''number''' ''percentComplete'')
 +
 +
* SetRadialCooldownClockwise('''boolean''' ''clockwise'')
 +
 +
* SetRadialCooldownGradient('''number''' ''startAlpha'', '''number''' ''angularDistance'')
 +
 +
* SetRadialCooldownOriginAngle('''number''' ''originAngle'')
* SetTexture('''string''' ''filename'')
* SetTexture('''string''' ''filename'')
-
* SetVerticalCooldownLeadingEdgeHeight('''integer''' ''leadingEdgeHeight'')
+
* SetTextureReleaseOption(''number'' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
* SetVerticalCooldownLeadingEdgeHeight('''number''' ''leadingEdgeHeight'')
 +
 
 +
* StartCooldown('''number''' ''remain'', '''number''' ''duration'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', '''boolean''' ''drawLeadingEdge'')
-
* StartCooldown('''integer''' ''remain'', '''integer''' ''duration'', '''integer''' ''cooldownType'', '''integer''' ''cooldownTimeType'', '''bool''' ''drawLeadingEdge'')
+
* StartFixedCooldown('''number''' ''percentComplete'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', '''boolean''' ''drawLeadingEdge'')
-
=== DebugTextControl ===
+
===DebugTextControl===
* Clear()
* Clear()
Line 737: Line 933:
-
=== EditControl ===
+
===EditControl===
-
 
+
-
(E.g. <code>ZO_ChatWindowTextEntryEditBox</code>)
+
-
 
+
* AddValidCharacter('''string''' ''validCharacter'')
* AddValidCharacter('''string''' ''validCharacter'')
Line 747: Line 940:
* ClearSelection()
* ClearSelection()
-
* CopyAllTextToClipboard()
+
* {{Private function}} CopyAllTextToClipboard ()
* GetCopyEnabled()
* GetCopyEnabled()
-
** ''Returns:'' '''bool''' ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* GetCursorPosition()
* GetCursorPosition()
-
** ''Returns:'' '''integer''' ''cursorPosition''
+
** '''Returns:''' '''number''' ''cursorPosition''
* GetEditEnabled()
* GetEditEnabled()
-
** ''Returns:'' '''bool''' ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* GetFontHeight()
* GetFontHeight()
-
** ''Returns:'' '''number''' ''fontHeight''
+
** '''Returns:''' '''number''' ''fontHeight''
* GetNewLineEnabled()
* GetNewLineEnabled()
-
** ''Returns:'' '''bool''' ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* GetPasteEnabled()
* GetPasteEnabled()
-
** ''Returns:'' '''bool''' ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
 +
 
 +
* GetScrollExtents()
 +
** '''Returns:''' '''number''' ''numLines''
* GetText()
* GetText()
-
** ''Returns:'' '''string''' ''apRet''
+
** '''Returns:''' '''string''' ''apRet''
 +
 
 +
* GetTopLineIndex()
 +
** '''Returns:''' '''number''' ''index''
* HasFocus()
* HasFocus()
-
** ''Returns:'' '''bool''' ''aRet''
+
** '''Returns:''' '''boolean''' ''aRet''
* HasSelection()
* HasSelection()
-
** ''Returns:'' '''bool''' ''hasSelection''
+
** '''Returns:''' '''boolean''' ''hasSelection''
* InsertText('''string''' ''aText'')
* InsertText('''string''' ''aText'')
 +
 +
* IsComposingIMEText()
 +
** '''Returns:''' '''boolean''' ''isComposing''
* IsMultiLine()
* IsMultiLine()
-
** ''Returns:'' '''bool''' ''isMultiLine''
+
** '''Returns:''' '''boolean''' ''isMultiLine''
* LoseFocus()
* LoseFocus()
 +
 +
* RemoveAllValidCharacters()
* SelectAll()
* SelectAll()
Line 787: Line 991:
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetCopyEnabled('''bool''' ''enabled'')
+
* SetCopyEnabled('''boolean''' ''enabled'')
-
* SetCursorPosition('''integer''' ''cursorPosition'')
+
* SetCursorPosition('''number''' ''cursorPosition'')
-
* SetEditEnabled('''bool''' ''enabled'')
+
* SetEditEnabled('''boolean''' ''enabled'')
* SetFont('''string''' ''font'')
* SetFont('''string''' ''font'')
-
* SetMaxInputChars('''integer''' ''maxChars'')
+
* SetMaxInputChars('''number''' ''maxChars'')
-
* SetMultiLine('''bool''' ''isMultiLine'')
+
* SetMultiLine('''boolean''' ''isMultiLine'')
-
* SetNewLineEnabled('''bool''' ''enabled'')
+
* SetNewLineEnabled('''boolean''' ''enabled'')
-
* SetPasteEnabled('''bool''' ''enabled'')
+
* SetPasteEnabled('''boolean''' ''enabled'')
-
* SetSelection('''integer''' ''selectionStartIndex'', '''integer''' ''selectionEndIndex'')
+
* SetSelection('''number''' ''selectionStartIndex'', '''number''' ''selectionEndIndex'')
* SetSelectionColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetSelectionColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 809: Line 1,013:
* SetText('''string''' ''aText'')
* SetText('''string''' ''aText'')
-
* SetTextType('''integer''' ''textType'')
+
* SetTextType('''number''' ''textType'')
 +
 
 +
* SetTopLineIndex('''number''' ''index'')
 +
 
 +
* SetVirtualKeyboardType(''number'' [[Globals#VirtualKeyboardType|VirtualKeyboardType]] ''aKeyboardType'')
* TakeFocus()
* TakeFocus()
 +
 +
* WasLastChangeVirtualKeyboard()
 +
** '''Returns:''' '''boolean''' ''aRet''
-
=== FontObject ===
+
===FontObject===
* GetFontInfo()
* GetFontInfo()
-
** ''Returns:'' '''string''' ''face'', '''integer''' ''size'', '''string''' ''option''
+
** '''Returns:''' '''string''' ''face'', '''number''' ''size'', '''string''' ''option''
* SetFont('''string''' ''fontDescriptor'')
* SetFont('''string''' ''fontDescriptor'')
-
=== LabelControl ===
+
===LabelControl===
-
* AnchorToBaseline('''object''' ''toLabel'', '''number''' ''offsetX'', '''[[Globals#AnchorPosition|AnchorPosition]]''' ''anchorSide'')
+
* AnchorToBaseline('''object''' ''toLabel'', '''number''' ''offsetX'', ''number'' [[Globals#AnchorPosition|AnchorPosition]] ''anchorSide'')
* ClearAnchorToBaseline('''object''' ''toLabel'')
* ClearAnchorToBaseline('''object''' ''toLabel'')
* DidLineWrap()
* DidLineWrap()
-
** ''Returns:'' '''bool''' ''didLineWrap''
+
** '''Returns:''' '''boolean''' ''didLineWrap''
* GetColor()
* GetColor()
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
* GetFontHeight()
* GetFontHeight()
-
** ''Returns:'' '''number''' ''fontHeight''
+
** '''Returns:''' '''number''' ''fontHeight''
* GetHorizontalAlignment()
* GetHorizontalAlignment()
-
** ''Returns:'' '''integer''' ''align''
+
** '''Returns:''' '''number''' ''align''
* GetModifyTextType()
* GetModifyTextType()
-
** ''Returns:'' '''[[Globals#ModifyTextType|ModifyTextType]]''' ''modifyTextType''
+
** '''Returns:''' ''number'' [[Globals#ModifyTextType|ModifyTextType]] ''modifyTextType''
 +
 
 +
* GetNumLines()
 +
** '''Returns:''' '''number''' ''numLines''
* GetStringWidth('''string''' ''text'')
* GetStringWidth('''string''' ''text'')
-
** ''Returns:'' '''number''' ''width''
+
** '''Returns:''' '''number''' ''width''
* GetStyleColor()
* GetStyleColor()
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
* GetText()
* GetText()
-
** ''Returns:'' '''string''' ''apRet''
+
** '''Returns:''' '''string''' ''apRet''
* GetTextDimensions()
* GetTextDimensions()
-
** ''Returns:'' '''number''' ''stringWidth'', '''number''' ''stringHeight''
+
** '''Returns:''' '''number''' ''stringWidth'', '''number''' ''stringHeight''
* GetTextHeight()
* GetTextHeight()
-
** ''Returns:'' '''number''' ''stringHeight''
+
** '''Returns:''' '''number''' ''stringHeight''
* GetTextWidth()
* GetTextWidth()
-
** ''Returns:'' '''number''' ''stringWidth''
+
** '''Returns:''' '''number''' ''stringWidth''
* GetVerticalAlignment()
* GetVerticalAlignment()
-
** ''Returns:'' '''integer''' ''align''
+
** '''Returns:''' '''number''' ''align''
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 +
* SetDesaturation('''number''' ''desaturation'')
* SetFont('''string''' ''fontString'')
* SetFont('''string''' ''fontString'')
-
* SetHorizontalAlignment('''integer''' ''align'')
+
* SetHorizontalAlignment('''number''' ''align'')
 +
 
 +
* SetLineSpacing('''number''' ''lineSpacing'')
-
* SetLineSpacing('''integer''' ''newLineX'')
+
* SetMaxLineCount('''number''' ''maxLineCount'')
-
* SetModifyTextType('''[[Globals#ModifyTextType|ModifyTextType]]''' ''modifyTextType'')
+
* SetModifyTextType(''number'' [[Globals#ModifyTextType|ModifyTextType]] ''modifyTextType'')
* SetNewLineX('''number''' ''newLineX'')
* SetNewLineX('''number''' ''newLineX'')
 +
 +
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
* SetStyleColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetStyleColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 878: Line 1,098:
* SetText('''string''' ''aText'')
* SetText('''string''' ''aText'')
-
* SetVerticalAlignment('''integer''' ''verticalAlign'')
+
* SetVerticalAlignment('''number''' ''verticalAlign'')
-
* SetWrapMode('''integer''' ''wrapMode'')
+
* SetWrapMode('''number''' ''wrapMode'')
* WasTruncated()
* WasTruncated()
-
** ''Returns:'' '''bool''' ''wasTruncated''
+
** '''Returns:''' '''boolean''' ''wasTruncated''
 +
 
 +
===LineControl===
 +
* GetBlendMode()
 +
** '''Returns:''' ''number'' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
-
=== LineControl ===
 
* GetColor()
* GetColor()
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
-
* GetTextureInfo()
+
* GetDesaturation()
-
** ''Returns:'' '''string''' ''filename'', '''integer''' ''addressMode'', '''integer''' ''blendMode'', '''number''' ''desaturation'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'', '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
+
** '''Returns:''' '''number''' ''desaturation''
-
* SetBlendMode('''integer''' ''blendMode'')
+
* GetTextureCoords()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* GetTextureFileDimensions()
 +
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
 +
 
 +
* GetTextureFileName()
 +
** '''Returns:''' '''string''' ''filename''
 +
 
 +
* IsPixelRoundingEnabled()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* IsTextureLoaded()
 +
** '''Returns:''' '''boolean''' ''loaded''
 +
 
 +
* SetBlendMode(''number'' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 899: Line 1,137:
* SetDesaturation('''number''' ''desaturation'')
* SetDesaturation('''number''' ''desaturation'')
-
* SetGradientColors('''integer''' ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
+
* SetGradientColors(''number'' [[Globals#ControlOrientation|ControlOrientation]] ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
 +
 
 +
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
* SetTexture('''string''' ''filename'')
* SetTexture('''string''' ''filename'')
Line 907: Line 1,147:
* SetThickness('''number''' ''thickness'')
* SetThickness('''number''' ''thickness'')
-
* SetVertexColors('''integer''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
+
* SetVertexColors('''number''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
-
=== MapDisplayControl ===
+
===MapDisplayControl===
* GetZoom()
* GetZoom()
-
** ''Returns:'' '''number''' ''normalizedRadius''
+
** '''Returns:''' '''number''' ''normalizedRadius''
* SetPinFont('''string''' ''pinFont'')
* SetPinFont('''string''' ''pinFont'')
Line 919: Line 1,159:
-
=== RootWindow ===
+
===RootWindow===
-
=== ScrollControl ===
+
===ScrollControl===
* GetScrollExtents()
* GetScrollExtents()
-
** ''Returns:'' '''number''' ''horizontal'', '''number''' ''vertical''
+
** '''Returns:''' '''number''' ''horizontal'', '''number''' ''vertical''
* GetScrollOffsets()
* GetScrollOffsets()
-
** ''Returns:'' '''number''' ''horizontal'', '''number''' ''vertical''
+
** '''Returns:''' '''number''' ''horizontal'', '''number''' ''vertical''
-
* RestoreToExtents('''integer''' ''duration'')
+
* RestoreToExtents('''number''' ''duration'')
-
* SetFadeGradient('''luaindex''' ''gradientIndex'', '''number''' ''normalX'', '''number''' ''normalY'', '''number''' ''gradientLength'')
+
* SetFadeGradient('''number''' ''gradientIndex'', '''number''' ''normalX'', '''number''' ''normalY'', '''number''' ''gradientLength'')
* SetHorizontalScroll('''number''' ''offset'')
* SetHorizontalScroll('''number''' ''offset'')
-
* SetScrollBounding('''integer''' ''bounding'')
+
* SetScrollBounding('''number''' ''bounding'')
* SetVerticalScroll('''number''' ''offset'')
* SetVerticalScroll('''number''' ''offset'')
-
=== SliderControl ===
+
===SliderControl===
* DoesAllowDraggingFromThumb()
* DoesAllowDraggingFromThumb()
-
** ''Returns:'' '''bool''' ''allow''
+
** '''Returns:''' '''boolean''' ''allow''
* GetEnabled()
* GetEnabled()
-
** ''Returns:'' '''bool''' ''isEnabled''
+
** '''Returns:''' '''boolean''' ''isEnabled''
* GetMinMax()
* GetMinMax()
-
** ''Returns:'' '''number''' ''min'', '''number''' ''max''
+
** '''Returns:''' '''number''' ''min'', '''number''' ''max''
* GetOrientation()
* GetOrientation()
-
** ''Returns:'' '''integer''' ''orientation''
+
** '''Returns:''' '''number''' ''orientation''
* GetThumbTextureControl()
* GetThumbTextureControl()
-
** ''Returns:'' '''object''' ''textureControl''
+
** '''Returns:''' '''object''' ''textureControl''
* GetValue()
* GetValue()
-
** ''Returns:'' '''number''' ''value''
+
** '''Returns:''' '''number''' ''value''
* GetValueStep()
* GetValueStep()
-
** ''Returns:'' '''number''' ''step''
+
** '''Returns:''' '''number''' ''step''
* IsThumbFlushWithExtents()
* IsThumbFlushWithExtents()
-
** ''Returns:'' '''bool''' ''flush''
+
** '''Returns:''' '''boolean''' ''flush''
-
* SetAllowDraggingFromThumb('''bool''' ''allow'')
+
* SetAllowDraggingFromThumb('''boolean''' ''allow'')
* SetBackgroundBottomTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
* SetBackgroundBottomTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
Line 972: Line 1,212:
* SetBackgroundTopTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
* SetBackgroundTopTexture('''string''' ''fileName'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
-
* SetEnabled('''bool''' ''enable'')
+
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetEnabled('''boolean''' ''enable'')
* SetMinMax('''number''' ''min'', '''number''' ''max'')
* SetMinMax('''number''' ''min'', '''number''' ''max'')
-
* SetOrientation('''integer''' ''orientation'')
+
* SetOrientation('''number''' ''orientation'')
-
* SetThumbFlushWithExtents('''bool''' ''flush'')
+
* SetThumbFlushWithExtents('''boolean''' ''flush'')
* SetThumbTexture('''string''' ''filename'', '''string''' ''disabledFilename'', '''string''' ''highlightedFilename'', '''number''' ''thumbWidth'', '''number''' ''thumbHeight'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
* SetThumbTexture('''string''' ''filename'', '''string''' ''disabledFilename'', '''string''' ''highlightedFilename'', '''number''' ''thumbWidth'', '''number''' ''thumbHeight'', '''number''' ''texTop'', '''number''' ''texLeft'', '''number''' ''texBottom'', '''number''' ''texRight'')
Line 989: Line 1,231:
-
=== StatusBarControl ===
+
===StatusBarControl===
* ClearFadeOutLossAdjustedTopValue()
* ClearFadeOutLossAdjustedTopValue()
-
* EnableFadeOut('''bool''' ''enabled'')
+
* EnableFadeOut('''boolean''' ''enabled'')
-
* EnableLeadingEdge('''bool''' ''enabled'')
+
* EnableLeadingEdge('''boolean''' ''enabled'')
-
* EnableScrollingOverlay('''bool''' ''enabled'')
+
* EnableScrollingOverlay('''boolean''' ''enabled'')
* GetMinMax()
* GetMinMax()
-
** ''Returns:'' '''number''' ''min'', '''number''' ''max''
+
** '''Returns:''' '''number''' ''min'', '''number''' ''max''
* GetValue()
* GetValue()
-
** ''Returns:'' '''number''' ''value''
+
** '''Returns:''' '''number''' ''value''
-
* SetBarAlignment('''integer''' ''barAlignment'')
+
* SetBarAlignment('''number''' ''barAlignment'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 1,028: Line 1,270:
* SetMinMax('''number''' ''aMin'', '''number''' ''aMax'')
* SetMinMax('''number''' ''aMin'', '''number''' ''aMax'')
-
* SetOrientation('''integer''' ''orientation'')
+
* SetOrientation('''number''' ''orientation'')
* SetTexture('''string''' ''filename'')
* SetTexture('''string''' ''filename'')
Line 1,036: Line 1,278:
* SetValue('''number''' ''aValue'')
* SetValue('''number''' ''aValue'')
-
* SetupScrollingOverlay('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'', '''integer''' ''duration'')
+
* SetupScrollingOverlay('''string''' ''textureFile'', '''number''' ''width'', '''number''' ''height'', '''number''' ''duration'')
-
=== TextBufferControl ===
+
===TextBufferControl===
-
 
+
* AddMessage('''string''' ''aText'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''colorId'')
-
(E.g. <code>CHAT_SYSTEM</code> windows.)
+
-
 
+
-
* AddMessage('''string''' ''aText'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''integer''' ''colorId'')
+
* Clear()
* Clear()
* GetDrawLastEntryIfOutOfRoom()
* GetDrawLastEntryIfOutOfRoom()
-
** ''Returns:'' '''bool''' ''drawLastIfOutOfRoom''
+
** '''Returns:''' '''boolean''' ''drawLastIfOutOfRoom''
* GetLineFade()
* GetLineFade()
-
** ''Returns:'' '''number''' ''timeBeforeLineBeginsToFade'', '''number''' ''timeItTakesLineToFade''
+
** '''Returns:''' '''number''' ''timeBeforeLineBeginsToFade'', '''number''' ''timeItTakesLineToFade''
* GetLinkEnabled()
* GetLinkEnabled()
-
** ''Returns:'' '''bool''' ''linkEnabed''
+
** '''Returns:''' '''boolean''' ''linkEnabed''
* GetMaxHistoryLines()
* GetMaxHistoryLines()
-
** ''Returns:'' '''integer''' ''numLines''
+
** '''Returns:''' '''number''' ''numLines''
* GetNumHistoryLines()
* GetNumHistoryLines()
-
** ''Returns:'' '''integer''' ''numLines''
+
** '''Returns:''' '''number''' ''numLines''
* GetNumVisibleLines()
* GetNumVisibleLines()
-
** ''Returns:'' '''integer''' ''numLines''
+
** '''Returns:''' '''number''' ''numLines''
* GetScrollPosition()
* GetScrollPosition()
-
** ''Returns:'' '''integer''' ''scrollPosition''
+
** '''Returns:''' '''number''' ''scrollPosition''
* IsSplittingLongMessages()
* IsSplittingLongMessages()
-
** ''Returns:'' '''bool''' ''isSplitting''
+
** '''Returns:''' '''boolean''' ''isSplitting''
-
* MoveScrollPosition('''integer''' ''numLines'')
+
* MoveScrollPosition('''number''' ''numLines'')
-
* SetClearBufferAfterFadeout('''bool''' ''clearAfterFade'')
+
* SetClearBufferAfterFadeout('''boolean''' ''clearAfterFade'')
-
* SetColorById('''integer''' ''colorId'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
+
* SetColorById('''number''' ''colorId'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
-
* SetDrawLastEntryIfOutOfRoom('''bool''' ''drawLastIfOutOfRoom'')
+
* SetDrawLastEntryIfOutOfRoom('''boolean''' ''drawLastIfOutOfRoom'')
* SetFont('''string''' ''fontString'')
* SetFont('''string''' ''fontString'')
-
* SetHorizontalAlignment('''integer''' ''align'')
+
* SetHorizontalAlignment('''number''' ''align'')
* SetLineFade('''number''' ''timeBeforeLineFadeBegins'', '''number''' ''timeForLineToFade'')
* SetLineFade('''number''' ''timeBeforeLineFadeBegins'', '''number''' ''timeForLineToFade'')
-
* SetLinkEnabled('''bool''' ''linkEnabed'')
+
* SetLinesInheritAlpha('''boolean''' ''linesInheritAlpha'')
-
* SetMaxHistoryLines('''integer''' ''numLines'')
+
* SetLinkEnabled('''boolean''' ''linkEnabed'')
-
* SetScrollPosition('''integer''' ''line'')
+
* SetMaxHistoryLines('''number''' ''numLines'')
-
* SetSplitLongMessages('''bool''' ''splitLongMessages'')
+
* SetScrollPosition('''number''' ''line'')
 +
 
 +
* SetSplitLongMessages('''boolean''' ''splitLongMessages'')
* ShowFadedLines()
* ShowFadedLines()
-
=== TextureControl ===
+
===TextureCompositeControl===
 +
* AddSurface('''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* ClearAllSurfaces()
 +
 
 +
* GetBlendMode()
 +
** '''Returns:''' ''number'' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
 +
 
 +
* GetColor('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* GetDesaturation()
 +
** '''Returns:''' '''number''' ''desaturation''
 +
 
 +
* GetInsets('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* GetNumSurfaces()
 +
** '''Returns:''' '''number''' ''surfaces''
 +
 
 +
* GetSurfaceAlpha('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''a''
 +
 
 +
* GetTextureCoords('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
 +
 
 +
* GetTextureFileDimensions()
 +
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
 +
 
 +
* GetTextureFileName()
 +
** '''Returns:''' '''string''' ''filename''
 +
 
 +
* IsPixelRoundingEnabled()
 +
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
 +
 
 +
* IsSurfaceHidden('''number''' ''surfaceIndex'')
 +
** '''Returns:''' '''boolean''' ''hidden''
 +
 
 +
* IsTextureLoaded()
 +
** '''Returns:''' '''boolean''' ''loaded''
 +
 
 +
* RemoveSurface('''number''' ''surfaceIndex'')
 +
 
 +
* SetBlendMode(''number'' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
 +
 
 +
* SetColor('''number''' ''surfaceIndex'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
 +
 
 +
* SetDesaturation('''number''' ''desaturation'')
 +
 
 +
* SetInsets('''number''' ''surfaceIndex'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* SetSurfaceAlpha('''number''' ''surfaceIndex'', '''number''' ''a'')
 +
 
 +
* SetSurfaceHidden('''number''' ''surfaceIndex'', '''boolean''' ''hidden'')
 +
 
 +
* SetTexture('''string''' ''filename'')
 +
 
 +
* SetTextureCoords('''number''' ''surfaceIndex'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
 +
 
 +
* SetTextureReleaseOption(''number'' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
 +
 
 +
 
 +
===TextureControl===
 +
* Get3DLocalDimensions()
 +
** '''Returns:''' '''number''' ''width'', '''number''' ''height''
 +
 
 +
* Get3DLocalOffset()
 +
** '''Returns:''' '''number''' ''right'', '''number''' ''up'', '''number''' ''forward''
 +
 
 +
* Get3DLocalOrientation()
 +
** '''Returns:''' '''number''' ''pitchRadians'', '''number''' ''yawRadians'', '''number''' ''rollRadians''
 +
 
 +
* GetAddressMode()
 +
** '''Returns:''' ''number'' [[Globals#TextureAddressMode|TextureAddressMode]] ''addressMode''
 +
 
 +
* GetBlendMode()
 +
** '''Returns:''' ''number'' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode''
 +
 
* GetColor()
* GetColor()
-
** ''Returns:'' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
+
** '''Returns:''' '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a''
 +
 
 +
* GetDesaturation()
 +
** '''Returns:''' '''number''' ''desaturation''
* GetResizeToFitFile()
* GetResizeToFitFile()
-
** ''Returns:'' '''bool''' ''resizesToFitFile''
+
** '''Returns:''' '''boolean''' ''resizesToFitFile''
 +
 
 +
* GetTextureCoords()
 +
** '''Returns:''' '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom''
* GetTextureFileDimensions()
* GetTextureFileDimensions()
-
** ''Returns:'' '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
+
** '''Returns:''' '''number''' ''pixelWidth'', '''number''' ''pixelHeight''
 +
 
 +
* GetTextureFileName()
 +
** '''Returns:''' '''string''' ''filename''
 +
 
 +
* GetVertexUV(''number'' [[Globals#VERTEX_POINTS|VERTEX_POINTS]] ''vertex'')
 +
** '''Returns:''' '''number''' ''u'', '''number''' ''v''
-
* GetTextureInfo()
+
* IsPixelRoundingEnabled()
-
** ''Returns:'' '''string''' ''filename'', '''integer''' ''addressMode'', '''integer''' ''blendMode'', '''number''' ''desaturation'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'', '''integer''' ''pixelWidth'', '''integer''' ''pixelHeight''
+
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
* IsTextureLoaded()
* IsTextureLoaded()
-
** ''Returns:'' '''bool''' ''loaded''
+
** '''Returns:''' '''boolean''' ''loaded''
-
* SetAddressMode('''integer''' ''addressMode'')
+
* Set3DLocalDimensions('''number''' ''width'', '''number''' ''height'')
-
* SetAutoAdjustWrappedCoords('''bool''' ''enabled'')
+
* Set3DLocalOffset('''number''' ''right'', '''number''' ''up'', '''number''' ''forward'')
-
* SetBlendMode('''integer''' ''blendMode'')
+
* Set3DLocalOrientation('''number''' ''pitchRadians'', '''number''' ''yawRadians'', '''number''' ''rollRadians'')
 +
 
 +
* Set3DRenderSpace('''number''' ''spaceId'')
 +
 
 +
* SetAddressMode(''number'' [[Globals#TextureAddressMode|TextureAddressMode]] ''addressMode'')
 +
 
 +
* SetAutoAdjustWrappedCoords('''boolean''' ''enabled'')
 +
 
 +
* SetBlendMode(''number'' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 1,122: Line 1,462:
* SetDesaturation('''number''' ''desaturation'')
* SetDesaturation('''number''' ''desaturation'')
-
* SetGradientColors('''integer''' ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
+
* SetGradientColors(''number'' [[Globals#ControlOrientation|ControlOrientation]] ''orientation'', '''number''' ''startR'', '''number''' ''startG'', '''number''' ''startB'', '''number''' ''startA'', '''number''' ''endR'', '''number''' ''endG'', '''number''' ''endB'', '''number''' ''endA'')
-
* SetPixelRounding('''bool''' ''pixelRoundingEnabled'')
+
* SetNumDimensions(''number'' [[Globals#Dimensions|Dimensions]] ''dimensions'')
-
* SetResizeToFitFile('''bool''' ''resizesToFitFile'')
+
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
 +
 
 +
* SetResizeToFitFile('''boolean''' ''resizesToFitFile'')
* SetTexture('''string''' ''filename'')
* SetTexture('''string''' ''filename'')
Line 1,133: Line 1,475:
* SetTextureCoordsRotation('''number''' ''angleInRadians'')
* SetTextureCoordsRotation('''number''' ''angleInRadians'')
 +
 +
* SetTextureReleaseOption(''number'' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
* SetTextureRotation('''number''' ''angleInRadians'', '''number''' ''normalizedRotationPointX'', '''number''' ''normalizedRotationPointY'')
* SetTextureRotation('''number''' ''angleInRadians'', '''number''' ''normalizedRotationPointX'', '''number''' ''normalizedRotationPointY'')
-
* SetVertexColors('''integer''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
+
* SetVertexColors('''number''' ''vertexPoints'', '''number''' ''red'', '''number''' ''green'', '''number''' ''blue'', '''number''' ''alpha'')
 +
* SetVertexUV(''number'' [[Globals#VERTEX_POINTS|VERTEX_POINTS]] ''vertex'', '''number''' ''u'', '''number''' ''v'')
-
=== TooltipControl ===
 
-
* AddControl('''object''' ''control'', '''integer''' ''cell'', '''bool''' ''useLastRow'')
 
-
* AddHeaderControl('''object''' ''control'', '''integer''' ''headerRow'', '''[[Globals#TooltipHeaderSide|TooltipHeaderSide]]''' ''headerSide'')
+
===TooltipControl===
 +
* AddControl('''object''' ''control'', '''number''' ''cell'', '''boolean''' ''useLastRow'')
-
* AddHeaderLine('''string''' ''text'', '''string''' ''font'', '''integer''' ''headerRow'', '''[[Globals#TooltipHeaderSide|TooltipHeaderSide]]''' ''headerSide'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
+
* AddHeaderControl('''object''' ''control'', '''number''' ''headerRow'', ''number'' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'')
-
* 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'')
+
* AddHeaderLine('''string''' ''text'', '''string''' ''font'', '''number''' ''headerRow'', ''number'' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
 +
 
 +
* 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'')
* AddVerticalPadding('''number''' ''paddingY'')
* AddVerticalPadding('''number''' ''paddingY'')
-
* AppendAvAObjective('''integer''' ''queryType'', '''integer''' ''keepId'', '''integer''' ''objectiveId'', '''bool''' ''isSpawnPosition'')
+
* AppendAvAObjective('''number''' ''queryType'', '''number''' ''keepId'', '''number''' ''objectiveId'', '''boolean''' ''isSpawnPosition'')
-
* AppendMapPing('''integer''' ''pingType'', '''string''' ''unitTag'')
+
* AppendMapPing('''number''' ''pingType'', '''string''' ''unitTag'')
-
* AppendQuestCondition('''luaindex''' ''questIndex'', '''luaindex''' ''stepIndex'', '''luaindex''' ''conditionIndex'')
+
* AppendQuestCondition('''number''' ''questIndex'', '''number''' ''stepIndex'', '''number''' ''conditionIndex'')
-
* AppendQuestEnding('''luaindex''' ''questIndex'')
+
* AppendQuestEnding('''number''' ''questIndex'')
* AppendUnitName('''string''' ''unitTag'')
* AppendUnitName('''string''' ''unitTag'')
-
 
-
* AppendYourCorpse()
 
* ClearLines()
* ClearLines()
* GetOwner()
* GetOwner()
-
** ''Returns:'' '''object''' ''owner''
+
** '''Returns:''' '''object''' ''owner''
* HideComparativeTooltips()
* HideComparativeTooltips()
-
* SetAbility('''luaindex''' ''aAbilityIndex'', '''bool''' ''aShowBase'')
+
* SetAbility('''number''' ''aAbilityIndex'', '''boolean''' ''aShowBase'')
-
* SetAchievement('''integer''' ''aAchievementId'')
+
* SetAbilityId('''number''' ''abilityId'')
-
* SetAchievementRewardItem('''integer''' ''aAchievementId'', '''luaindex''' ''aRewardItem'')
+
* SetAchievement('''number''' ''aAchievementId'')
-
* SetAction('''luaindex''' ''aSlotId'')
+
* SetAchievementRewardItem('''number''' ''aAchievementId'')
 +
 
 +
* SetAction('''number''' ''aSlotId'')
* SetAsComparativeTooltip1()
* SetAsComparativeTooltip1()
Line 1,181: Line 1,527:
* SetAsComparativeTooltip2()
* SetAsComparativeTooltip2()
-
* SetAttachedMailItem('''id64''' ''aMailId'', '''luaindex''' ''aAttachSlot'')
+
* SetAttachedMailItem('''id64''' ''aMailId'', '''number''' ''aAttachSlot'')
-
* SetAttributePassive('''integer''' ''attribute'', '''luaindex''' ''passiveIndex'')
+
* SetBagItem('''number''' ''bagIndex'', '''number''' ''slotIndex'')
-
* SetBagItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'')
+
* SetBook('''number''' ''categoryIndex'', '''number''' ''collectionIndex'', '''number''' ''bookIndex'')
-
* SetBook('''luaindex''' ''categoryIndex'', '''luaindex''' ''collectionIndex'', '''luaindex''' ''bookIndex'')
+
* SetBuff('''number''' ''aBuffSlotId'', '''string''' ''unitTag'')
-
* SetBuff('''integer''' ''aBuffSlotId'', '''string''' ''unitTag'')
+
* SetBuybackItem('''number''' ''entryIndex'')
-
* SetBuybackItem('''luaindex''' ''entryIndex'')
+
* SetChampionSkillAbility('''number''' ''disiplineIndex'', '''number''' ''skillIndex'', '''number''' ''numPendingPoints'')
-
* SetEmperorBonusAbility('''integer''' ''campaignId'', '''integer''' ''alliance'')
+
* SetCollectible('''number''' ''collectibleId'', '''boolean''' ''addNickname'', '''boolean''' ''showHint'', '''boolean''' ''showBlockReason'')
 +
 
 +
* SetEmperorBonusAbility('''number''' ''campaignId'', '''number''' ''alliance'')
* SetFont('''string''' ''fontStr'')
* SetFont('''string''' ''fontStr'')
 +
 +
* SetForceTooltipNotStolen('''boolean''' ''forceNotStolen'')
 +
 +
* SetGuildSpecificItem('''number''' ''guildSpecificItemIndex'')
* SetHeaderRowSpacing('''number''' ''spacing'')
* SetHeaderRowSpacing('''number''' ''spacing'')
Line 1,201: Line 1,553:
* SetHeaderVerticalOffset('''number''' ''verticalOffset'')
* SetHeaderVerticalOffset('''number''' ''verticalOffset'')
-
* SetHookPointStoreEntry('''luaindex''' ''hookPointIndex'', '''luaindex''' ''storeIndex'')
+
* SetItemUsingEnchantment('''number''' ''itemBagIndex'', '''number''' ''itemSlotIndex'', '''number''' ''enchantmentBagIndex'', '''number''' ''enchantmentSlotIndex'')
-
* SetItemUsingEnchantment('''integer''' ''itemBagIndex'', '''integer''' ''itemSlotIndex'', '''integer''' ''enchantmentBagIndex'', '''integer''' ''enchantmentSlotIndex'')
+
* SetKeepBonusAbility('''number''' ''bonusIndex'')
-
* SetKeepBonusAbility('''luaindex''' ''bonusIndex'')
+
* SetKeepUpgrade('''number''' ''keepId'', ''number'' [[Globals#BattlegroundQueryContextType|BattlegroundQueryContextType]] ''battlegroundContext'', '''number''' ''upgradeLine'', '''number''' ''level'', '''number''' ''index'')
-
* SetKeepUpgrade('''integer''' ''keepId'', '''integer''' ''battlegroundContext'', '''integer''' ''upgradeLine'', '''integer''' ''level'', '''luaindex''' ''index'')
+
* SetLastCraftingResultItem('''number''' ''resultIndex'')
-
 
+
-
* SetLastCraftingResultItem('''luaindex''' ''resultIndex'')
+
* SetLink('''string''' ''aLink'')
* SetLink('''string''' ''aLink'')
-
* SetLootItem('''integer''' ''lootId'')
+
* SetLootItem('''number''' ''lootId'')
 +
 
 +
* SetMarketProduct('''number''' ''marketProductId'')
* SetMinHeaderRowHeight('''number''' ''minRowHeight'')
* SetMinHeaderRowHeight('''number''' ''minRowHeight'')
-
* SetMinHeaderRows('''integer''' ''minRows'')
+
* SetMinHeaderRows('''number''' ''minRows'')
-
* SetMount('''luaindex''' ''aStableIndex'')
+
* SetOwner('''object''' ''owner'', '''number''' ''position'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' ''relativePoint'')
-
* SetOwner('''object''' ''owner'', '''integer''' ''position'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''integer''' ''relativePoint'')
+
* SetPendingAlchemyItem('''number''' ''solventBagId'', '''number''' ''solventSlotIndex'', '''number''' ''reagent1BagId'', '''number''' ''reagent1SlotIndex'', '''number''' ''reagent2BagId'', '''number''' ''reagent2SlotIndex'', '''number:nilable''' ''reagent3BagId'', '''number:nilable''' ''reagent3SlotIndex'')
-
* SetPendingAlchemyItem('''integer''' ''solventBagId'', '''integer''' ''solventSlotIndex'', '''integer''' ''reagent1BagId'', '''integer''' ''reagent1SlotIndex'', '''integer''' ''reagent2BagId'', '''integer''' ''reagent2SlotIndex'', '''integer:nilable''' ''reagent3BagId'', '''integer:nilable''' ''reagent3SlotIndex'')
+
* SetPendingEnchantingItem('''number''' ''potencyRuneBagId'', '''number''' ''potencyRuneSlotIndex'', '''number''' ''essenceRuneBagId'', '''number''' ''essenceRuneSlotIndex'', '''number''' ''aspectRuneBagId'', '''number''' ''aspectRuneSlotIndex'')
-
* SetPendingEnchantingItem('''integer''' ''potencyRuneBagId'', '''integer''' ''potencyRuneSlotIndex'', '''integer''' ''essenceRuneBagId'', '''integer''' ''essenceRuneSlotIndex'', '''integer''' ''aspectRuneBagId'', '''integer''' ''aspectRuneSlotIndex'')
+
* SetPendingSmithingItem('''number''' ''patternIndex'', '''number''' ''materialIndex'', '''number''' ''materialQuantity'', '''number''' ''styleIndex'', '''number''' ''traitIndex'')
-
* SetPendingSmithingItem('''luaindex''' ''patternIndex'', '''luaindex''' ''materialIndex'', '''integer''' ''materialQuantity'', '''luaindex''' ''styleIndex'', '''luaindex''' ''traitIndex'')
+
* SetProgressionAbility('''number''' ''aProgressionIndex'', '''number''' ''aMorph'', '''number''' ''aRank'')
-
* SetPlugItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'', '''luaindex''' ''socketIndex'')
+
* SetProvisionerIngredientItem('''number''' ''recipeListIndex'', '''number''' ''recipeIndex'', '''number''' ''ingredientIndex'')
-
* SetProgressionAbility('''luaindex''' ''aProgressionIndex'', '''integer''' ''aMorph'', '''integer''' ''aRank'')
+
* SetProvisionerResultItem('''number''' ''recipeListIndex'', '''number''' ''recipeIndex'')
-
* SetProvisionerIngredientItem('''luaindex''' ''recipeListIndex'', '''luaindex''' ''recipeIndex'', '''luaindex''' ''ingredientIndex'')
+
* SetQuestItem('''number''' ''questIndex'', '''number''' ''stepIndex'', '''number''' ''conditionIndex'')
-
* SetProvisionerResultItem('''luaindex''' ''recipeListIndex'', '''luaindex''' ''recipeIndex'')
+
* SetQuestReward('''number''' ''aPerkIndex'')
-
* SetQuestItem('''luaindex''' ''questIndex'', '''luaindex''' ''stepIndex'', '''luaindex''' ''conditionIndex'')
+
* SetQuestTool('''number''' ''questIndex'', '''number''' ''toolIndex'')
-
* SetQuestReward('''luaindex''' ''aPerkIndex'')
+
* SetScrollBonusAbility('''number''' ''alliance'', '''number''' ''artifactType'', '''number''' ''bonusIndex'')
-
* SetQuestTool('''luaindex''' ''questIndex'', '''luaindex''' ''toolIndex'')
+
* SetSkillAbility('''number''' ''skillType'', '''number''' ''skillIndex'', '''number''' ''abilityIndex'')
-
* SetScrollBonusAbility('''integer''' ''alliance'', '''integer''' ''artifactType'', '''luaindex''' ''bonusIndex'')
+
* SetSkillLine('''number''' ''skillType'', '''number''' ''skillIndex'')
-
* SetSiegeFire()
+
* SetSkillUpgradeAbility('''number''' ''skillType'', '''number''' ''skillIndex'', '''number''' ''abilityIndex'')
-
* SetSkillAbility('''integer''' ''skillType'', '''luaindex''' ''skillIndex'', '''luaindex''' ''abilityIndex'')
+
* SetSmithingImprovementItem('''number''' ''craftingSkillType'', '''number''' ''improvementItemIndex'')
-
* SetSkillLine('''integer''' ''skillType'', '''luaindex''' ''skillIndex'')
+
* SetSmithingImprovementResult('''number''' ''itemToImproveBagId'', '''number''' ''itemToImproveSlotIndex'', '''number''' ''craftingSkillType'')
-
* SetSkillUpgradeAbility('''integer''' ''skillType'', '''luaindex''' ''skillIndex'', '''luaindex''' ''abilityIndex'')
+
* SetSmithingMaterialItem('''number''' ''patternIndex'', '''number''' ''materialIndex'')
-
* SetSmithingImprovementItem('''integer''' ''craftingSkillType'', '''luaindex''' ''improvementItemIndex'')
+
* SetSmithingStyleItem('''number''' ''styleItemIndex'')
-
* SetSmithingImprovementResult('''integer''' ''itemToImproveBagId'', '''integer''' ''itemToImproveSlotIndex'', '''integer''' ''craftingSkillType'')
+
* SetSmithingTraitItem('''number''' ''traitItemIndex'')
-
* SetSmithingMaterialItem('''luaindex''' ''patternIndex'', '''luaindex''' ''materialIndex'')
+
* SetStoreItem('''number''' ''entryIndex'')
-
* SetSmithingStyleItem('''luaindex''' ''styleItemIndex'')
+
* SetTradeItem('''number''' ''aWho'', '''number''' ''aTradeIndex'')
-
* SetSmithingTraitItem('''luaindex''' ''traitItemIndex'')
+
* SetTradingHouseItem('''number''' ''tradingHouseIndex'')
-
* SetSocketingItem('''integer''' ''bagIndex'', '''integer''' ''slotIndex'')
+
* SetTradingHouseListing('''number''' ''tradingHouseIndex'')
-
* SetStoreAlternateCurrencyItem('''luaindex''' ''entryIndex'', '''integer''' ''offset'')
+
* SetWornItem('''number''' ''equipSlot'')
-
 
+
-
* SetStoreItem('''luaindex''' ''entryIndex'')
+
-
 
+
-
* SetSynergyBuff('''integer''' ''aBuffSlotId'')
+
-
 
+
-
* SetTradeItem('''integer''' ''aWho'', '''luaindex''' ''aTradeIndex'')
+
-
 
+
-
* SetTradingHouseItem('''luaindex''' ''tradingHouseIndex'')
+
-
 
+
-
* SetTradingHouseListing('''luaindex''' ''tradingHouseIndex'')
+
-
 
+
-
* SetUnit('''string''' ''aUnitTag'')
+
-
 
+
-
* SetWeaponSetAbility('''luaindex''' ''aWeaponSet'', '''integer''' ''aRank'')
+
-
 
+
-
* SetWornItem('''integer''' ''equipSlot'')
+
* ShowComparativeTooltips()
* ShowComparativeTooltips()
-
=== TopLevelWindow ===
+
===TopLevelWindow===
* AllowBringToTop()
* AllowBringToTop()
-
** ''Returns:'' '''bool''' ''allow''
+
** '''Returns:''' '''boolean''' ''allow''
-
* BringWindowToTop '''protected-attributes''' ()
+
* {{Protected_attributes}} BringWindowToTop ()
-
* SetAllowBringToTop '''protected-attributes''' ('''bool''' ''allow'')
+
* {{Protected_attributes}} SetAllowBringToTop ('''boolean''' ''allow'')
-
* SetDrawWhenGuiHidden '''private''' ('''bool''' ''drawWhenHidden'')
+
* {{Private function}} SetDrawWhenGuiHidden ('''boolean''' ''drawWhenHidden'')
-
* SetTopmost '''protected-attributes''' ('''bool''' ''isTopmost'')
+
* SetTopmost('''boolean''' ''isTopmost'')
-
=== WindowManager (WINDOW_MANAGER) ===
+
===WindowManager===
-
* CreateControl('''string''' ''arg1'', '''object''' ''parent'', '''integer''' ''type'')
+
* ApplyTemplateToControl('''object''' ''control'', '''string''' ''virtualName'')
-
** ''Returns:'' '''object''' ''apRet''
+
 
 +
* CompareControlVisualOrder('''object''' ''controlA'', '''object''' ''controlB'')
 +
** '''Returns:''' '''number''' ''order''
 +
 
 +
* CreateControl('''string''' ''arg1'', '''object''' ''parent'', '''number''' ''type'')
 +
** '''Returns:''' '''object''' ''apRet''
* CreateControlFromVirtual('''string''' ''controlName'', '''object''' ''parent'', '''string''' ''virtualName'')
* CreateControlFromVirtual('''string''' ''controlName'', '''object''' ''parent'', '''string''' ''virtualName'')
-
** ''Returns:'' '''object''' ''apRet''
+
** '''Returns:''' '''object''' ''apRet''
* CreateTopLevelWindow('''string''' ''arg1'')
* CreateTopLevelWindow('''string''' ''arg1'')
-
** ''Returns:'' '''object''' ''apRet''
+
** '''Returns:''' '''object''' ''apRet''
* GetControlByName('''string''' ''name'', '''string''' ''suffix'')
* GetControlByName('''string''' ''name'', '''string''' ''suffix'')
-
** ''Returns:'' '''object''' ''ret''
+
** '''Returns:''' '''object''' ''ret''
* GetFocusControl()
* GetFocusControl()
-
** ''Returns:'' '''object''' ''focusControl''
+
** '''Returns:''' '''object''' ''focusControl''
* GetMouseOverControl()
* GetMouseOverControl()
-
** ''Returns:'' '''object''' ''mouseOverControl''
+
** '''Returns:''' '''object''' ''mouseOverControl''
* IsHandlingHardwareEvent()
* IsHandlingHardwareEvent()
-
** ''Returns:'' '''bool''' ''isHandlingHardwareEvent''
+
** '''Returns:''' '''boolean''' ''isHandlingHardwareEvent''
* IsMouseOverWorld()
* IsMouseOverWorld()
-
** ''Returns:'' '''bool''' ''isMouseOverWorld''
+
** '''Returns:''' '''boolean''' ''isMouseOverWorld''
 +
 
 +
* IsSecureRenderModeEnabled()
 +
** '''Returns:''' '''boolean''' ''secureRenderModeEnabled''
* SetFocusByName('''string''' ''name'')
* SetFocusByName('''string''' ''name'')
-
* SetMouseCursor('''integer''' ''cursorType'')
+
* SetMouseCursor('''number''' ''cursorType'')
 +
 
 +
* SetMouseFocusByName('''string''' ''name'')

Revision as of 23:13, 13 July 2016

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



Objects creation throught 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>


Objects creation throught 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

AddOnManager


AnimationManager


AnimationObject

Objects that inherit behavior from AnimationObject




AnimationObjectAlpha


AnimationObjectColor


AnimationObjectCustom


AnimationObjectScale


AnimationObjectScroll


AnimationObjectSize


AnimationObjectTexture


AnimationObjectTexture3DRotate


AnimationObjectTexture3DTranslate


AnimationObjectTextureRotate


AnimationObjectTextureSlide


AnimationObjectTranslate


AnimationTimeline


BackdropControl


ButtonControl


ColorSelectControl


CompassDisplayControl


Control

Objects that inherit behavior from Control




CooldownControl


DebugTextControl


EditControl


FontObject


LabelControl


LineControl


MapDisplayControl


RootWindow

ScrollControl


SliderControl


StatusBarControl


TextBufferControl


TextureCompositeControl


TextureControl


TooltipControl


TopLevelWindow


WindowManager

Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox