Controls

From ESOUI Wiki

(Difference between revisions)
Jump to: navigation, search
(100020)
(bool)
Line 56: Line 56:
* GetAddOnDependencyInfo('''number''' ''addOnIndex'', '''number''' ''addOnDependencyIndex'')
* GetAddOnDependencyInfo('''number''' ''addOnIndex'', '''number''' ''addOnDependencyIndex'')
-
** '''Returns:''' '''string''' ''name'', *bool* ''active''
+
** '''Returns:''' '''string''' ''name'', '''boolean''' ''active''
* GetAddOnFilter()
* GetAddOnFilter()
Line 62: Line 62:
* GetAddOnInfo('''number''' ''addOnIndex'')
* GetAddOnInfo('''number''' ''addOnIndex'')
-
** '''Returns:''' '''string''' ''name'', '''string''' ''title'', '''string''' ''author'', '''string''' ''description'', *bool* ''enabled'', '''number''' [[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('''number''' ''addOnIndex'')
* GetAddOnNumDependencies('''number''' ''addOnIndex'')
Line 68: Line 68:
* GetLoadOutOfDateAddOns()
* GetLoadOutOfDateAddOns()
-
** '''Returns:''' *bool* ''loadOutOfDateAddons''
+
** '''Returns:''' '''boolean''' ''loadOutOfDateAddons''
* GetNumAddOns()
* GetNumAddOns()
Line 77: Line 77:
* ResetRelevantFilters()
* ResetRelevantFilters()
-
* SetAddOnEnabled('''number''' ''addOnIndex'', *bool* ''enabled'')
+
* SetAddOnEnabled('''number''' ''addOnIndex'', '''boolean''' ''enabled'')
* SetAddOnFilter('''string''' ''settingFilter'')
* SetAddOnFilter('''string''' ''settingFilter'')
-
* SetLoadOutOfDateAddOns(*bool* ''loadOutOfDateAddons'')
+
* SetLoadOutOfDateAddOns('''boolean''' ''loadOutOfDateAddons'')
Line 124: Line 124:
* IsPlaying()
* IsPlaying()
-
** '''Returns:''' *bool* ''isPlaying''
+
** '''Returns:''' '''boolean''' ''isPlaying''
* SetAnimatedControl('''object''' ''animatedControl'')
* SetAnimatedControl('''object''' ''animatedControl'')
Line 309: Line 309:
* IsMirroringAlongX()
* IsMirroringAlongX()
-
** '''Returns:''' *bool* ''mirroring''
+
** '''Returns:''' '''boolean''' ''mirroring''
* IsMirroringAlongY()
* IsMirroringAlongY()
-
** '''Returns:''' *bool* ''mirroring''
+
** '''Returns:''' '''boolean''' ''mirroring''
* SetCellsHigh('''number''' ''aNumCellsHigh'')
* SetCellsHigh('''number''' ''aNumCellsHigh'')
Line 322: Line 322:
* SetImageData('''number''' ''aNumCellsWide'', '''number''' ''aNumCellsHigh'')
* SetImageData('''number''' ''aNumCellsWide'', '''number''' ''aNumCellsHigh'')
-
* SetMirrorAlongX(*bool* ''mirroring'')
+
* SetMirrorAlongX('''boolean''' ''mirroring'')
-
* SetMirrorAlongY(*bool* ''mirroring'')
+
* SetMirrorAlongY('''boolean''' ''mirroring'')
Line 443: Line 443:
* GetSkipAnimationsBehindPlayheadOnInitialPlay()
* GetSkipAnimationsBehindPlayheadOnInitialPlay()
-
** '''Returns:''' *bool* ''skipAnimations''
+
** '''Returns:''' '''boolean''' ''skipAnimations''
* InsertAnimation('''number''' ''animationType'', '''object''' ''animatedControl'', '''number''' ''offset'')
* InsertAnimation('''number''' ''animationType'', '''object''' ''animatedControl'', '''number''' ''offset'')
Line 461: Line 461:
* IsPlaying()
* IsPlaying()
-
** '''Returns:''' *bool* ''isPlaying''
+
** '''Returns:''' '''boolean''' ''isPlaying''
* IsPlayingBackward()
* IsPlayingBackward()
-
** '''Returns:''' *bool* ''reversed''
+
** '''Returns:''' '''boolean''' ''reversed''
* PlayBackward()
* PlayBackward()
Line 494: Line 494:
* SetProgress('''number''' ''progress'')
* SetProgress('''number''' ''progress'')
-
* SetSkipAnimationsBehindPlayheadOnInitialPlay(*bool* ''skipAnimations'')
+
* SetSkipAnimationsBehindPlayheadOnInitialPlay('''boolean''' ''skipAnimations'')
* Stop()
* Stop()
Line 504: Line 504:
* IsPixelRoundingEnabled()
* IsPixelRoundingEnabled()
-
** '''Returns:''' *bool* ''pixelRoundingEnabled''
+
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
* SetCenterColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetCenterColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 516: Line 516:
* 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'')
* SetTextureReleaseOption('''number''' [[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]] ''releaseOption'')
Line 524: Line 524:
===ButtonControl===
===ButtonControl===
-
* EnableMouseButton('''number''' ''buttonNum'', *bool* ''enabled'')
+
* EnableMouseButton('''number''' ''buttonNum'', '''boolean''' ''enabled'')
* GetLabelControl()
* GetLabelControl()
Line 533: Line 533:
* IsPixelRoundingEnabled()
* IsPixelRoundingEnabled()
-
** '''Returns:''' *bool* ''pixelRoundingEnabled''
+
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
* SetClickSound('''string''' ''clickSound'')
* SetClickSound('''string''' ''clickSound'')
Line 547: Line 547:
* SetDisabledTexture('''string''' ''textureFilename'')
* SetDisabledTexture('''string''' ''textureFilename'')
-
* SetEnabled(*bool* ''enabled'')
+
* SetEnabled('''boolean''' ''enabled'')
* SetEndCapWidth('''number''' ''endCapWidth'')
* SetEndCapWidth('''number''' ''endCapWidth'')
Line 567: Line 567:
* SetNormalTexture('''string''' ''textureFilename'')
* SetNormalTexture('''string''' ''textureFilename'')
-
* SetPixelRoundingEnabled(*bool* ''pixelRoundingEnabled'')
+
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
* SetPressedFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetPressedFontColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 577: Line 577:
* SetPressedTexture('''string''' ''textureFilename'')
* SetPressedTexture('''string''' ''textureFilename'')
-
* SetShowingHighlight(*bool* ''showingHighlight'')
+
* SetShowingHighlight('''boolean''' ''showingHighlight'')
-
* SetState('''number''' ''newState'', *bool* ''locked'')
+
* SetState('''number''' ''newState'', '''boolean''' ''locked'')
* SetText('''string''' ''text'')
* SetText('''string''' ''text'')
Line 634: Line 634:
* GetCenterOveredPinInfo('''number''' ''centerOveredPinIndex'')
* GetCenterOveredPinInfo('''number''' ''centerOveredPinIndex'')
-
** '''Returns:''' '''string''' ''description'', '''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''type'', '''number''' ''distance'', '''number''' [[Globals#DrawLayer|DrawLayer]] ''drawLayer'', '''number''' ''drawLevel'', *bool* ''suppressed''
+
** '''Returns:''' '''string''' ''description'', '''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''type'', '''number''' ''distance'', '''number''' [[Globals#DrawLayer|DrawLayer]] ''drawLayer'', '''number''' ''drawLevel'', '''boolean''' ''suppressed''
* GetCenterOveredPinLayerAndLevel('''number''' ''centerOveredPinIndex'')
* GetCenterOveredPinLayerAndLevel('''number''' ''centerOveredPinIndex'')
Line 655: Line 655:
* IsCenterOveredPinSuppressed('''number''' ''centerOveredPinIndex'')
* IsCenterOveredPinSuppressed('''number''' ''centerOveredPinIndex'')
-
** '''Returns:''' *bool* ''suppressed''
+
** '''Returns:''' '''boolean''' ''suppressed''
* SetAlphaCoefficients('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
* SetAlphaCoefficients('''number''' [[Globals#MapDisplayPinType|MapDisplayPinType]] ''pinType'', '''number''' ''leadingCoefficient'', '''number''' ''coefficient'', '''number''' ''constant'')
Line 692: Line 692:
* AddFilterForEvent('''number''' ''event'')
* AddFilterForEvent('''number''' ''event'')
-
** '''Returns:''' *bool* ''success''
+
** '''Returns:''' '''boolean''' ''success''
* {{Protected_attributes}} ClearAnchors()
* {{Protected_attributes}} ClearAnchors()
Line 716: Line 716:
* Does3DRenderSpaceUseDepthBuffer()
* Does3DRenderSpaceUseDepthBuffer()
-
** '''Returns:''' *bool* ''usesDepthBuffer''
+
** '''Returns:''' '''boolean''' ''usesDepthBuffer''
* Get3DRenderSpaceForward()
* Get3DRenderSpaceForward()
Line 740: Line 740:
* GetAnchor('''number''' ''anchorIndex'')
* GetAnchor('''number''' ''anchorIndex'')
-
** '''Returns:''' *bool* ''isValidAnchor'', '''number''' ''point'', '''object''' ''relativeTo'', '''number''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' [[Globals#AnchorConstrains|AnchorConstrains]] ''anchorConstrains''
+
** '''Returns:''' '''boolean''' ''isValidAnchor'', '''number''' ''point'', '''object''' ''relativeTo'', '''number''' ''relativePoint'', '''number''' ''offsetX'', '''number''' ''offsetY'', '''number''' [[Globals#AnchorConstrains|AnchorConstrains]] ''anchorConstrains''
* GetBottom()
* GetBottom()
Line 752: Line 752:
* GetClampedToScreen()
* GetClampedToScreen()
-
** '''Returns:''' *bool* ''clamped''
+
** '''Returns:''' '''boolean''' ''clamped''
* GetClampedToScreenInsets()
* GetClampedToScreenInsets()
Line 785: Line 785:
* GetExcludeFromResizeToFitExtents()
* GetExcludeFromResizeToFitExtents()
-
** '''Returns:''' *bool* ''excludes''
+
** '''Returns:''' '''boolean''' ''excludes''
* GetHandler('''string''' ''handlerName'')
* GetHandler('''string''' ''handlerName'')
Line 800: Line 800:
* GetInheritsAlpha()
* GetInheritsAlpha()
-
** '''Returns:''' *bool* ''inheritAlpha''
+
** '''Returns:''' '''boolean''' ''inheritAlpha''
* GetInheritsScale()
* GetInheritsScale()
-
** '''Returns:''' *bool* ''inheritScale''
+
** '''Returns:''' '''boolean''' ''inheritScale''
* GetLeft()
* GetLeft()
Line 824: Line 824:
* GetResizeToFitDescendents()
* GetResizeToFitDescendents()
-
** '''Returns:''' *bool* ''resizes''
+
** '''Returns:''' '''boolean''' ''resizes''
* GetResizeToFitPadding()
* GetResizeToFitPadding()
Line 848: Line 848:
* Has3DRenderSpace()
* Has3DRenderSpace()
-
** '''Returns:''' *bool* ''has3DRenderSpace''
+
** '''Returns:''' '''boolean''' ''has3DRenderSpace''
* IsChildOf('''object''' ''desiredParent'')
* IsChildOf('''object''' ''desiredParent'')
-
** '''Returns:''' *bool* ''isChild''
+
** '''Returns:''' '''boolean''' ''isChild''
* IsControlHidden()
* IsControlHidden()
-
** '''Returns:''' *bool* ''hidden''
+
** '''Returns:''' '''boolean''' ''hidden''
* IsHandlerSet('''string''' ''handlerName'')
* IsHandlerSet('''string''' ''handlerName'')
-
** '''Returns:''' *bool* ''isSet''
+
** '''Returns:''' '''boolean''' ''isSet''
* IsHidden()
* IsHidden()
-
** '''Returns:''' *bool* ''hidden''
+
** '''Returns:''' '''boolean''' ''hidden''
* IsKeyboardEnabled()
* IsKeyboardEnabled()
-
** '''Returns:''' *bool* ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* IsMouseEnabled()
* IsMouseEnabled()
-
** '''Returns:''' *bool* ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* IsPointInside('''number''' ''x'', '''number''' ''y'', '''number''' ''leftOffset'', '''number''' ''topOffset'', '''number''' ''rightOffset'', '''number''' ''bottomOffset'')
* IsPointInside('''number''' ''x'', '''number''' ''y'', '''number''' ''leftOffset'', '''number''' ''topOffset'', '''number''' ''rightOffset'', '''number''' ''bottomOffset'')
-
** '''Returns:''' *bool* ''isInside''
+
** '''Returns:''' '''boolean''' ''isInside''
* RegisterForEvent('''number''' ''event'', '''function''' ''callback'')
* RegisterForEvent('''number''' ''event'', '''function''' ''callback'')
-
** '''Returns:''' *bool* ''success''
+
** '''Returns:''' '''boolean''' ''success''
* Set3DRenderSpaceForward('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
* Set3DRenderSpaceForward('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
Line 886: Line 886:
* Set3DRenderSpaceUp('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
* Set3DRenderSpaceUp('''number''' ''x'', '''number''' ''y'', '''number''' ''z'')
-
* Set3DRenderSpaceUsesDepthBuffer(*bool* ''usesDepthBuffer'')
+
* Set3DRenderSpaceUsesDepthBuffer('''boolean''' ''usesDepthBuffer'')
* {{Protected_attributes}} SetAlpha('''number''' ''alpha'')
* {{Protected_attributes}} SetAlpha('''number''' ''alpha'')
Line 894: Line 894:
* {{Protected_attributes}} SetAnchorFill('''object''' ''anchorTargetControl'')
* {{Protected_attributes}} SetAnchorFill('''object''' ''anchorTargetControl'')
-
* SetClampedToScreen(*bool* ''clamped'')
+
* SetClampedToScreen('''boolean''' ''clamped'')
* SetClampedToScreenInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
* SetClampedToScreenInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
Line 908: Line 908:
* {{Protected_attributes}} SetDrawTier('''number''' ''tier'')
* {{Protected_attributes}} SetDrawTier('''number''' ''tier'')
-
* {{Protected_attributes}} SetExcludeFromResizeToFitExtents(*bool* ''exclude'')
+
* {{Protected_attributes}} SetExcludeFromResizeToFitExtents('''boolean''' ''exclude'')
* SetHandler('''string''' ''handlerName'', '''function''' ''functionRef'')
* SetHandler('''string''' ''handlerName'', '''function''' ''functionRef'')
Line 914: Line 914:
* {{Protected_attributes}} SetHeight('''number''' ''height'')
* {{Protected_attributes}} SetHeight('''number''' ''height'')
-
* {{Protected_attributes}} SetHidden(*bool* ''aHidden'')
+
* {{Protected_attributes}} SetHidden('''boolean''' ''aHidden'')
* SetHitInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
* SetHitInsets('''number''' ''left'', '''number''' ''top'', '''number''' ''right'', '''number''' ''bottom'')
Line 920: Line 920:
* SetId('''number''' ''id'')
* SetId('''number''' ''id'')
-
* SetInheritAlpha(*bool* ''inheritAlpha'')
+
* SetInheritAlpha('''boolean''' ''inheritAlpha'')
-
* SetInheritScale(*bool* ''inheritScale'')
+
* SetInheritScale('''boolean''' ''inheritScale'')
-
* {{Protected_attributes}} SetKeyboardEnabled(*bool* ''enabled'')
+
* {{Protected_attributes}} SetKeyboardEnabled('''boolean''' ''enabled'')
-
* {{Protected_attributes}} SetMouseEnabled(*bool* ''enabled'')
+
* {{Protected_attributes}} SetMouseEnabled('''boolean''' ''enabled'')
-
* SetMovable(*bool* ''isMovable'')
+
* SetMovable('''boolean''' ''isMovable'')
* {{Protected_attributes}} SetParent('''object''' ''newParent'')
* {{Protected_attributes}} SetParent('''object''' ''newParent'')
Line 934: Line 934:
* SetResizeHandleSize('''number''' ''handleSize'')
* SetResizeHandleSize('''number''' ''handleSize'')
-
* {{Protected_attributes}} SetResizeToFitDescendents(*bool* ''resize'')
+
* {{Protected_attributes}} SetResizeToFitDescendents('''boolean''' ''resize'')
* SetResizeToFitPadding('''number''' ''width'', '''number''' ''height'')
* SetResizeToFitPadding('''number''' ''width'', '''number''' ''height'')
Line 949: Line 949:
* {{Protected_attributes}} StartMoving()
* {{Protected_attributes}} StartMoving()
-
** '''Returns:''' *bool* ''isMoving''
+
** '''Returns:''' '''boolean''' ''isMoving''
* {{Protected_attributes}} StopMovingOrResizing()
* {{Protected_attributes}} StopMovingOrResizing()
Line 956: Line 956:
* UnregisterForEvent('''number''' ''event'')
* UnregisterForEvent('''number''' ''event'')
-
** '''Returns:''' *bool* ''success''
+
** '''Returns:''' '''boolean''' ''success''
===CooldownControl===
===CooldownControl===
Line 982: Line 982:
* SetPercentCompleteFixed('''number''' ''percentComplete'')
* SetPercentCompleteFixed('''number''' ''percentComplete'')
-
* SetRadialCooldownClockwise(*bool* ''clockwise'')
+
* SetRadialCooldownClockwise('''boolean''' ''clockwise'')
* SetRadialCooldownGradient('''number''' ''startAlpha'', '''number''' ''angularDistance'')
* SetRadialCooldownGradient('''number''' ''startAlpha'', '''number''' ''angularDistance'')
Line 994: Line 994:
* SetVerticalCooldownLeadingEdgeHeight('''number''' ''leadingEdgeHeight'')
* SetVerticalCooldownLeadingEdgeHeight('''number''' ''leadingEdgeHeight'')
-
* StartCooldown('''number''' ''remain'', '''number''' ''duration'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', *bool* ''drawLeadingEdge'')
+
* StartCooldown('''number''' ''remain'', '''number''' ''duration'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', '''boolean''' ''drawLeadingEdge'')
-
* StartFixedCooldown('''number''' ''percentComplete'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', *bool* ''drawLeadingEdge'')
+
* StartFixedCooldown('''number''' ''percentComplete'', '''number''' ''cooldownType'', '''number''' ''cooldownTimeType'', '''boolean''' ''drawLeadingEdge'')
Line 1,015: Line 1,015:
* GetCopyEnabled()
* GetCopyEnabled()
-
** '''Returns:''' *bool* ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* GetCursorPosition()
* GetCursorPosition()
Line 1,021: Line 1,021:
* GetEditEnabled()
* GetEditEnabled()
-
** '''Returns:''' *bool* ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* GetFontHeight()
* GetFontHeight()
Line 1,027: Line 1,027:
* GetNewLineEnabled()
* GetNewLineEnabled()
-
** '''Returns:''' *bool* ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* GetPasteEnabled()
* GetPasteEnabled()
-
** '''Returns:''' *bool* ''enabled''
+
** '''Returns:''' '''boolean''' ''enabled''
* GetScrollExtents()
* GetScrollExtents()
Line 1,042: Line 1,042:
* HasFocus()
* HasFocus()
-
** '''Returns:''' *bool* ''aRet''
+
** '''Returns:''' '''boolean''' ''aRet''
* HasSelection()
* HasSelection()
-
** '''Returns:''' *bool* ''hasSelection''
+
** '''Returns:''' '''boolean''' ''hasSelection''
* InsertText('''string''' ''aText'')
* InsertText('''string''' ''aText'')
* IsComposingIMEText()
* IsComposingIMEText()
-
** '''Returns:''' *bool* ''isComposing''
+
** '''Returns:''' '''boolean''' ''isComposing''
* IsMultiLine()
* IsMultiLine()
-
** '''Returns:''' *bool* ''isMultiLine''
+
** '''Returns:''' '''boolean''' ''isMultiLine''
* LoseFocus()
* LoseFocus()
Line 1,063: Line 1,063:
* 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('''number''' ''cursorPosition'')
* SetCursorPosition('''number''' ''cursorPosition'')
-
* SetEditEnabled(*bool* ''enabled'')
+
* SetEditEnabled('''boolean''' ''enabled'')
* SetFont('''string''' ''font'')
* SetFont('''string''' ''font'')
Line 1,073: Line 1,073:
* SetMaxInputChars('''number''' ''maxChars'')
* SetMaxInputChars('''number''' ''maxChars'')
-
* SetMultiLine(*bool* ''isMultiLine'')
+
* SetMultiLine('''boolean''' ''isMultiLine'')
-
* SetNewLineEnabled(*bool* ''enabled'')
+
* SetNewLineEnabled('''boolean''' ''enabled'')
-
* SetPasteEnabled(*bool* ''enabled'')
+
* SetPasteEnabled('''boolean''' ''enabled'')
* SetSelection('''number''' ''selectionStartIndex'', '''number''' ''selectionEndIndex'')
* SetSelection('''number''' ''selectionStartIndex'', '''number''' ''selectionEndIndex'')
Line 1,094: Line 1,094:
* WasLastChangeVirtualKeyboard()
* WasLastChangeVirtualKeyboard()
-
** '''Returns:''' *bool* ''aRet''
+
** '''Returns:''' '''boolean''' ''aRet''
Line 1,112: Line 1,112:
* DidLineWrap()
* DidLineWrap()
-
** '''Returns:''' *bool* ''didLineWrap''
+
** '''Returns:''' '''boolean''' ''didLineWrap''
* GetColor()
* GetColor()
Line 1,166: Line 1,166:
* SetNewLineX('''number''' ''newLineX'')
* SetNewLineX('''number''' ''newLineX'')
-
* SetPixelRoundingEnabled(*bool* ''pixelRoundingEnabled'')
+
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
* SetStyleColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetStyleColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
Line 1,177: Line 1,177:
* WasTruncated()
* WasTruncated()
-
** '''Returns:''' *bool* ''wasTruncated''
+
** '''Returns:''' '''boolean''' ''wasTruncated''
Line 1,200: Line 1,200:
* IsPixelRoundingEnabled()
* IsPixelRoundingEnabled()
-
** '''Returns:''' *bool* ''pixelRoundingEnabled''
+
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
* IsTextureLoaded()
* IsTextureLoaded()
-
** '''Returns:''' *bool* ''loaded''
+
** '''Returns:''' '''boolean''' ''loaded''
* SetBlendMode('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
* SetBlendMode('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
Line 1,213: Line 1,213:
* SetGradientColors('''number''' [[Globals#ControlOrientation|ControlOrientation]] ''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(*bool* ''pixelRoundingEnabled'')
+
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
* SetTexture('''string''' ''filename'')
* SetTexture('''string''' ''filename'')
Line 1,255: Line 1,255:
===SliderControl===
===SliderControl===
* DoesAllowDraggingFromThumb()
* DoesAllowDraggingFromThumb()
-
** '''Returns:''' *bool* ''allow''
+
** '''Returns:''' '''boolean''' ''allow''
* GetEnabled()
* GetEnabled()
-
** '''Returns:''' *bool* ''isEnabled''
+
** '''Returns:''' '''boolean''' ''isEnabled''
* GetMinMax()
* GetMinMax()
Line 1,276: Line 1,276:
* 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 1,288: Line 1,288:
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
* SetColor('''number''' ''r'', '''number''' ''g'', '''number''' ''b'', '''number''' ''a'')
-
* SetEnabled(*bool* ''enable'')
+
* SetEnabled('''boolean''' ''enable'')
* SetMinMax('''number''' ''min'', '''number''' ''max'')
* SetMinMax('''number''' ''min'', '''number''' ''max'')
Line 1,294: Line 1,294:
* SetOrientation('''number''' ''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 1,308: Line 1,308:
* ClearFadeOutLossAdjustedTopValue()
* ClearFadeOutLossAdjustedTopValue()
-
* EnableFadeOut(*bool* ''enabled'')
+
* EnableFadeOut('''boolean''' ''enabled'')
-
* EnableLeadingEdge(*bool* ''enabled'')
+
* EnableLeadingEdge('''boolean''' ''enabled'')
-
* EnableScrollingOverlay(*bool* ''enabled'')
+
* EnableScrollingOverlay('''boolean''' ''enabled'')
* GetMinMax()
* GetMinMax()
Line 1,361: Line 1,361:
* GetDrawLastEntryIfOutOfRoom()
* GetDrawLastEntryIfOutOfRoom()
-
** '''Returns:''' *bool* ''drawLastIfOutOfRoom''
+
** '''Returns:''' '''boolean''' ''drawLastIfOutOfRoom''
* GetLineFade()
* GetLineFade()
Line 1,367: Line 1,367:
* GetLinkEnabled()
* GetLinkEnabled()
-
** '''Returns:''' *bool* ''linkEnabed''
+
** '''Returns:''' '''boolean''' ''linkEnabed''
* GetMaxHistoryLines()
* GetMaxHistoryLines()
Line 1,382: Line 1,382:
* IsSplittingLongMessages()
* IsSplittingLongMessages()
-
** '''Returns:''' *bool* ''isSplitting''
+
** '''Returns:''' '''boolean''' ''isSplitting''
* MoveScrollPosition('''number''' ''numLines'')
* MoveScrollPosition('''number''' ''numLines'')
-
* SetClearBufferAfterFadeout(*bool* ''clearAfterFade'')
+
* SetClearBufferAfterFadeout('''boolean''' ''clearAfterFade'')
* SetColorById('''number''' ''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'')
Line 1,398: Line 1,398:
* SetLineFade('''number''' ''timeBeforeLineFadeBegins'', '''number''' ''timeForLineToFade'')
* SetLineFade('''number''' ''timeBeforeLineFadeBegins'', '''number''' ''timeForLineToFade'')
-
* SetLinesInheritAlpha(*bool* ''linesInheritAlpha'')
+
* SetLinesInheritAlpha('''boolean''' ''linesInheritAlpha'')
-
* SetLinkEnabled(*bool* ''linkEnabed'')
+
* SetLinkEnabled('''boolean''' ''linkEnabed'')
* SetMaxHistoryLines('''number''' ''numLines'')
* SetMaxHistoryLines('''number''' ''numLines'')
Line 1,406: Line 1,406:
* SetScrollPosition('''number''' ''line'')
* SetScrollPosition('''number''' ''line'')
-
* SetSplitLongMessages(*bool* ''splitLongMessages'')
+
* SetSplitLongMessages('''boolean''' ''splitLongMessages'')
* ShowFadedLines()
* ShowFadedLines()
Line 1,444: Line 1,444:
* IsPixelRoundingEnabled()
* IsPixelRoundingEnabled()
-
** '''Returns:''' *bool* ''pixelRoundingEnabled''
+
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
* IsSurfaceHidden('''number''' ''surfaceIndex'')
* IsSurfaceHidden('''number''' ''surfaceIndex'')
-
** '''Returns:''' *bool* ''hidden''
+
** '''Returns:''' '''boolean''' ''hidden''
* IsTextureLoaded()
* IsTextureLoaded()
-
** '''Returns:''' *bool* ''loaded''
+
** '''Returns:''' '''boolean''' ''loaded''
* RemoveSurface('''number''' ''surfaceIndex'')
* RemoveSurface('''number''' ''surfaceIndex'')
Line 1,462: Line 1,462:
* SetInsets('''number''' ''surfaceIndex'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
* SetInsets('''number''' ''surfaceIndex'', '''number''' ''left'', '''number''' ''right'', '''number''' ''top'', '''number''' ''bottom'')
-
* SetPixelRoundingEnabled(*bool* ''pixelRoundingEnabled'')
+
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
* SetSurfaceAlpha('''number''' ''surfaceIndex'', '''number''' ''a'')
* SetSurfaceAlpha('''number''' ''surfaceIndex'', '''number''' ''a'')
-
* SetSurfaceHidden('''number''' ''surfaceIndex'', *bool* ''hidden'')
+
* SetSurfaceHidden('''number''' ''surfaceIndex'', '''boolean''' ''hidden'')
* SetTexture('''string''' ''filename'')
* SetTexture('''string''' ''filename'')
Line 1,492: Line 1,492:
* GetResizeToFitFile()
* GetResizeToFitFile()
-
** '''Returns:''' *bool* ''resizesToFitFile''
+
** '''Returns:''' '''boolean''' ''resizesToFitFile''
* GetTextureCoords()
* GetTextureCoords()
Line 1,507: Line 1,507:
* Is3DQuadFacingCamera()
* Is3DQuadFacingCamera()
-
** '''Returns:''' *bool* ''isFacing''
+
** '''Returns:''' '''boolean''' ''isFacing''
* IsPixelRoundingEnabled()
* IsPixelRoundingEnabled()
-
** '''Returns:''' *bool* ''pixelRoundingEnabled''
+
** '''Returns:''' '''boolean''' ''pixelRoundingEnabled''
* IsTextureLoaded()
* IsTextureLoaded()
-
** '''Returns:''' *bool* ''loaded''
+
** '''Returns:''' '''boolean''' ''loaded''
* Set3DLocalDimensions('''number''' ''width'', '''number''' ''height'')
* Set3DLocalDimensions('''number''' ''width'', '''number''' ''height'')
Line 1,519: Line 1,519:
* SetAddressMode('''number''' [[Globals#TextureAddressMode|TextureAddressMode]] ''addressMode'')
* SetAddressMode('''number''' [[Globals#TextureAddressMode|TextureAddressMode]] ''addressMode'')
-
* SetAutoAdjustWrappedCoords(*bool* ''enabled'')
+
* SetAutoAdjustWrappedCoords('''boolean''' ''enabled'')
* SetBlendMode('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
* SetBlendMode('''number''' [[Globals#TextureBlendMode|TextureBlendMode]] ''blendMode'')
Line 1,529: Line 1,529:
* SetGradientColors('''number''' [[Globals#ControlOrientation|ControlOrientation]] ''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(*bool* ''pixelRoundingEnabled'')
+
* SetPixelRoundingEnabled('''boolean''' ''pixelRoundingEnabled'')
-
* SetResizeToFitFile(*bool* ''resizesToFitFile'')
+
* SetResizeToFitFile('''boolean''' ''resizesToFitFile'')
* SetTexture('''string''' ''filename'')
* SetTexture('''string''' ''filename'')
Line 1,549: Line 1,549:
===TooltipControl===
===TooltipControl===
-
* AddControl('''object''' ''control'', '''number''' ''cell'', *bool* ''useLastRow'')
+
* AddControl('''object''' ''control'', '''number''' ''cell'', '''boolean''' ''useLastRow'')
* AddHeaderControl('''object''' ''control'', '''number''' ''headerRow'', '''number''' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'')
* AddHeaderControl('''object''' ''control'', '''number''' ''headerRow'', '''number''' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'')
Line 1,555: Line 1,555:
* AddHeaderLine('''string''' ''text'', '''string''' ''font'', '''number''' ''headerRow'', '''number''' [[Globals#TooltipHeaderSide|TooltipHeaderSide]] ''headerSide'', '''number''' ''r'', '''number''' ''g'', '''number''' ''b'')
* 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'', *bool* ''setToFullSize'')
+
* 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'')
Line 1,576: Line 1,576:
* HideComparativeTooltips()
* HideComparativeTooltips()
-
* SetAbility('''number''' ''aAbilityIndex'', *bool* ''aShowBase'')
+
* SetAbility('''number''' ''aAbilityIndex'', '''boolean''' ''aShowBase'')
* SetAbilityId('''number''' ''abilityId'')
* SetAbilityId('''number''' ''abilityId'')
Line 1,602: Line 1,602:
* SetChampionSkillAbility('''number''' ''disiplineIndex'', '''number''' ''skillIndex'', '''number''' ''numPendingPoints'')
* SetChampionSkillAbility('''number''' ''disiplineIndex'', '''number''' ''skillIndex'', '''number''' ''numPendingPoints'')
-
* SetCollectible('''number''' ''collectibleId'', *bool* ''addNickname'', *bool* ''showHint'', *bool* ''showBlockReason'')
+
* SetCollectible('''number''' ''collectibleId'', '''boolean''' ''addNickname'', '''boolean''' ''showHint'', '''boolean''' ''showBlockReason'')
* SetEmperorBonusAbility('''number''' ''campaignId'', '''number''' [[Globals#Alliance|Alliance]] ''alliance'')
* SetEmperorBonusAbility('''number''' ''campaignId'', '''number''' [[Globals#Alliance|Alliance]] ''alliance'')
Line 1,689: Line 1,689:
===TopLevelWindow===
===TopLevelWindow===
* AllowBringToTop()
* AllowBringToTop()
-
** '''Returns:''' *bool* ''allow''
+
** '''Returns:''' '''boolean''' ''allow''
* {{Protected_attributes}} BringWindowToTop()
* {{Protected_attributes}} BringWindowToTop()
-
* {{Protected_attributes}} SetAllowBringToTop(*bool* ''allow'')
+
* {{Protected_attributes}} SetAllowBringToTop('''boolean''' ''allow'')
-
* {{Private function}} SetDrawWhenGuiHidden(*bool* ''drawWhenHidden'')
+
* {{Private function}} SetDrawWhenGuiHidden('''boolean''' ''drawWhenHidden'')
-
* SetTopmost(*bool* ''isTopmost'')
+
* SetTopmost('''boolean''' ''isTopmost'')
Line 1,725: Line 1,725:
* IsHandlingHardwareEvent()
* IsHandlingHardwareEvent()
-
** '''Returns:''' *bool* ''isHandlingHardwareEvent''
+
** '''Returns:''' '''boolean''' ''isHandlingHardwareEvent''
* IsMouseOverWorld()
* IsMouseOverWorld()
-
** '''Returns:''' *bool* ''isMouseOverWorld''
+
** '''Returns:''' '''boolean''' ''isMouseOverWorld''
* IsSecureRenderModeEnabled()
* IsSecureRenderModeEnabled()
-
** '''Returns:''' *bool* ''secureRenderModeEnabled''
+
** '''Returns:''' '''boolean''' ''secureRenderModeEnabled''
* SetFocusByName('''string''' ''name'')
* SetFocusByName('''string''' ''name'')

Revision as of 22:16, 30 September 2017

Page up-to-date to API Version 100020




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

Object creation

XML

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

LUA

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


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

For our LabelControl :

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

Objects Types and their methods

All UI elements are inheriting the functions defined in Control.

AddOnManager


AnimationManager


AnimationObject

Objects that inherit behavior from AnimationObject


AnimationObject3DRotate


AnimationObject3DTranslate


AnimationObjectAlpha


AnimationObjectColor


AnimationObjectCustom


AnimationObjectScale


AnimationObjectScroll


AnimationObjectSize


AnimationObjectTexture


AnimationObjectTextureRotate


AnimationObjectTextureSlide


AnimationObjectTranslate


AnimationTimeline


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