UI XML

From ESOUI Wiki

(Difference between revisions)
Jump to: navigation, search
m (Attributes)
m
 
(21 intermediate revisions not shown)
Line 1: Line 1:
 +
''Page up-to-date to API Version [[APIVersion#100028|100028]]''
 +
 +
----
 +
 +
 +
==Introduction==
 +
 +
This is the exhaustive list of '''UI Elements''' used to drawn the UI of Elder Scrolls Online.
 +
 +
* Each '''Element''' is a '''''XML Element'''''
 +
* Each ''Element'' have some ''attributes'' and may have ''Child Elements''<br>''Attributes to change the z-index of controls'' (bring more to the front/move more to the back) are:<br>tier="[https://wiki.esoui.com/Globals#DrawTier DrawTier]"<br>layer="[https://wiki.esoui.com/Globals#DrawLayer DrawLayer]"<br>level="DrawLevel (integer value 0..n)<br>
 +
* Each ''Element'' with a ''name'' attribute can be accessed throught '''Lua'''
 +
* ''Elements'' without ''name'' attribute can be manipulated with the '''[[Controls|Methods]]''' of the ''Owning Element'' (the one which have a ''name'' attribute).
 +
* You can add comments like in any XML file
 +
 +
==Structure==
 +
 +
* '''All''' XML definition must be embedded between ''GuiXml'' Element
 +
* All ''Controls'' must be defined inside the ''Controls'' Element. This one is also inside GuiXml Element.
 +
 +
<source lang="lua">
 +
<GuiXml>
 +
 +
<!-- New Font definition -->
 +
<Font name="ZoFontBookTabletSmall" font="$(STONE_TABLET_FONT)|$(KB_24)|soft-shadow-thick" />
 +
<Font name="ZoFontGameMini" font="$(BOLD_FONT)|$(KB_13)|soft-shadow-thin" />
 +
 +
<!-- Your Controls should be INSIDE this Element -->
 +
<Controls>
 +
 +
<Label name="SuperStarXMLSkillsNavigationEntry" virtual="true" font="ZoFontHeader" inherits="ZO_SelectableLabel">
 +
<OnMouseUp>
 +
ZO_TreeEntry_OnMouseUp(self, upInside)
 +
</OnMouseUp>
 +
</Label>
 +
 +
</Controls>
 +
</GuiXml>
 +
</source>
 +
 +
 +
==Magic Values==
 +
 +
* The Magic Value ''$(parent)'' replace this string by the name of the parent attribute.
 +
* The Magic Value ''$(grandparent)'' replace this string by the name of the grandparent attribute respectively.
 +
 +
 +
In the example under,
 +
 +
<source lang="lua">
 +
<Backdrop name="$(parent)BG" inherits="ZO_DefaultBackdrop" />
 +
</source>
 +
 +
is equal to :
 +
 +
<source lang="lua">
 +
<Backdrop name="AIResearchGridBG" inherits="ZO_DefaultBackdrop" />
 +
</source>
 +
 +
==Inheritance==
 +
 +
* If your control should inherit of attributes, Elements, and code associated of another control, the attribute ''inherits'' must be used. Value is the name of the Control which give inheritance.
 +
* If an Element inherits of another, the referrer must be defined BEFORE the inheriter.
 +
 +
 +
In the example under,
 +
 +
<source lang="lua">
 +
<Backdrop name="$(parent)BG" inherits="ZO_DefaultBackdrop" />
 +
</source>
 +
 +
Inherits the ''ZO_DefaultBackdrop'' sub elements, attributes, code, etc.
 +
ZO_DefaultBackdrop MUST be loaded before the file which define this block.
 +
 +
 +
==Virtualization==
 +
 +
* If your control is intended to be integrated ''in a Loop'' or in different places like ''being used as a template'', it should be Virtual. Simply add ''virtual'' attribute and set the value to ''true''.
 +
* Please note that a Virtual Element itself cannot be accessed directly throught Lua. Only the one which use the Element can be.
 +
 +
In the example under,
 +
 +
<source lang="lua">
 +
<Control name="SuperStarXMLSkillsAbilityTypeHeader" virtual="true">
 +
<Dimensions y="32"/>
 +
<Controls>
 +
<Label name="$(parent)Label" font="ZoFontHeader2" color="INTERFACE_COLOR_TYPE_TEXT_COLORS:INTERFACE_TEXT_COLOR_SELECTED" modifyTextType="UPPERCASE">
 +
<Anchor point="LEFT" />
 +
</Label>
 +
</Controls>
 +
</Control>
 +
 +
</source>
 +
 +
Is virtual.
 +
 +
 +
 +
== Loading Order==
 +
 +
* The XML files should ALWAYS be defined AFTER Lua files in metafile. If a XML File is defined to make a call to a Lua File (generally at ''OnInitialized'') and the function definition is set after in the metafile, it will generate an error.
 +
 +
 +
 +
 +
== Examples of UI Definition ==
 +
 +
 +
<source lang="lua">
 +
<GuiXml>
 +
<Controls>
 +
 +
<Control name="SuperStarXMLSkillsAbilityTypeHeader" virtual="true">
 +
<Dimensions y="32"/>
 +
<Controls>
 +
<Label name="$(parent)Label" font="ZoFontHeader2" color="INTERFACE_COLOR_TYPE_TEXT_COLORS:INTERFACE_TEXT_COLOR_SELECTED" modifyTextType="UPPERCASE">
 +
<Anchor point="LEFT" />
 +
</Label>
 +
</Controls>
 +
</Control>
 +
 +
<!-- This TopLevelControl can be accessed in Lua throught variable "AIResearchGrid" -->
 +
<TopLevelControl name="AIResearchGrid" mouseEnabled="true" movable="true" clampedToScreen="true" hidden="true">
 +
<Dimensions x="750" y="800" />
 +
<Anchor point="CENTER" />
 +
<Controls>
 +
 +
<Backdrop name="$(parent)BG" inherits="ZO_DefaultBackdrop" />
 +
 +
<Label name="$(parent)WindowTitle" font="ZoFontAnnounceMedium" text="|c8080ffAI|r RESEARCH GRID">
 +
<Anchor point="TOPLEFT" relativeTo="$(parent)" relativePoint="TOPLEFT" />
 +
</Label>
 +
 +
<Texture name="$(parent)TopDivider" textureFile="/esoui/art/miscellaneous/horizontaldivider.dds" tier="HIGH">
 +
<Dimensions x="800" y="4"/>
 +
<Anchor point="TOP" relativeTo="$(parent)" offsetY="38" />
 +
</Texture>
 +
 +
<Button name="$(parent)ButtonCloseAddon" inherits="ZO_ButtonBehaviorClickSound">
 +
<Dimensions x="40" y="40" />
 +
<Anchor point="TOPRIGHT" relativeTo="$(parent)" relativePoint="TOPRIGHT" offsetX="15" />
 +
<Textures normal="EsoUI/Art/Buttons/closebutton_up.dds"
 +
pressed="EsoUI/Art/Buttons/closebutton_down.dds"
 +
mouseOver="EsoUI/Art/Buttons/closebutton_mouseover.dds"
 +
disabled="EsoUI/Art/Buttons/closebutton_disabled.dds"/>
 +
<OnClicked>
 +
AIRG_ToggleMainWindow()
 +
</OnClicked>
 +
</Button>
 +
 +
</Controls>
 +
</TopLevelControl>
 +
</Controls>
 +
</GuiXml>
 +
</source>
 +
== UI Elements ==
== UI Elements ==
-
=== AlphaAnimation ===
+
 
 +
===Attributes===
 +
* '''number''' '''[[Globals#TextureAddressMode|TextureAddressMode]]''' ''addressMode''
 +
* '''boolean''' ''allowBringToTop''
 +
* '''number''' '''[[Globals#AllowMarkupType|AllowMarkupType]]''' ''allowMarkupType''
 +
* '''number''' ''alpha''
 +
* '''number''' ''anchorIndex''
 +
* '''boolean''' ''applyAlpha''
 +
* '''string''' ''applyToChildControlName''
 +
* '''boolean''' ''autoAdjustTextureCoords''
 +
* '''number''' '''[[Globals#BarAlignment|BarAlignment]]''' ''barAlignment''
 +
* '''number''' '''[[Globals#TextureBlendMode|TextureBlendMode]]''' ''blendMode''
 +
* '''number''' ''cellsHigh''
 +
* '''number''' ''cellsWide''
 +
* '''string''' ''centerColor''
 +
* '''boolean''' ''clampedToScreen''
 +
* '''string''' ''clickSound''
 +
* '''string''' ''color''
 +
* '''number''' ''delay''
 +
* '''number''' ''deltaX''
 +
* '''number''' ''deltaXFromEnd''
 +
* '''number''' ''deltaY''
 +
* '''number''' ''deltaYFromEnd''
 +
* '''number''' ''deltaZ''
 +
* '''number''' ''deltaZFromEnd''
 +
* '''number''' ''desaturation''
 +
* '''string''' ''disabled''
 +
* '''string''' ''disabledColor''
 +
* '''string''' ''disabledPressed''
 +
* '''string''' ''disabledPressedColor''
 +
* '''boolean''' ''dragFromThumb''
 +
* '''boolean''' ''drawLastEntryIfOutOfRoom''
 +
* '''number''' ''duration''
 +
* '''string''' ''edgeColor''
 +
* '''boolean''' ''editEnabled''
 +
* '''boolean''' ''enableFadeOut''
 +
* '''boolean''' ''enabled''
 +
* '''number''' ''endAlpha''
 +
* '''number''' ''endCapWidth''
 +
* '''string''' ''endColor''
 +
* '''number''' ''endHeight''
 +
* '''number''' ''endPitch''
 +
* '''number''' ''endRoll''
 +
* '''number''' ''endRotation''
 +
* '''number''' ''endScale''
 +
* '''number''' ''endWidth''
 +
* '''number''' ''endX''
 +
* '''number''' ''endY''
 +
* '''number''' ''endYaw''
 +
* '''number''' ''endZ''
 +
* '''boolean''' ''excludeFromResizeToFitExtents''
 +
* '''string''' ''fadeOutGainColor''
 +
* '''string''' ''fadeOutLossColor''
 +
* '''string''' ''fadeOutTextureFile''
 +
* '''string''' ''fillColor''
 +
* '''string''' ''font''
 +
* '''number''' ''framerate''
 +
* '''number''' ''headerRowSpacing''
 +
* '''number''' ''headerVerticalOffset''
 +
* '''boolean''' ''hidden''
 +
* '''number''' '''[[Globals#TextAlignment|TextAlignment]]''' ''horizontalAlignment''
 +
* '''number''' ''id''
 +
* '''boolean''' ''inheritAlpha''
 +
* '''boolean''' ''inheritScale''
 +
* '''string''' ''inherits''
 +
* '''boolean''' ''integralWrapping''
 +
* '''boolean''' ''keyboardEnabled''
 +
* '''string''' ''layer''
 +
* '''string''' ''leadingEdgeTexture''
 +
* '''number''' ''level''
 +
* '''number''' ''lineSpacing''
 +
* '''boolean''' ''linkEnabled''
 +
* '''string''' ''loopCount''
 +
* '''number''' ''maxHistoryLines''
 +
* '''number''' ''maxInputCharacters''
 +
* '''number''' ''maxLineCount''
 +
* '''number''' ''minDuration''
 +
* '''number''' ''minLineCount''
 +
* '''boolean''' ''mirrorAlongX''
 +
* '''boolean''' ''mirrorAlongY''
 +
* '''number''' '''[[Globals#ModifyTextType|ModifyTextType]]''' ''modifyTextType''
 +
* '''boolean''' ''mouseEnabled''
 +
* '''string''' ''mouseOver''
 +
* '''number''' '''[[Globals#TextureBlendMode|TextureBlendMode]]''' ''mouseOverBlendMode''
 +
* '''string''' ''mouseOverColor''
 +
* '''boolean''' ''movable''
 +
* '''boolean''' ''multiLine''
 +
* '''boolean''' ''newLineEnabled''
 +
* '''number''' ''newLineIndent''
 +
* '''string''' ''normal''
 +
* '''string''' ''normalColor''
 +
* '''number''' '''[[Globals#ControlOrientation|ControlOrientation]]''' ''orientation''
 +
* '''string''' ''pinFont''
 +
* '''boolean''' ''pixelRoundingEnabled''
 +
* '''number''' '''[[Globals#AnimationPlayback|AnimationPlayback]]''' ''playbackType''
 +
* '''string''' ''pressed''
 +
* '''string''' ''pressedColor''
 +
* '''string''' ''pressedMouseOver''
 +
* '''boolean''' ''radialCooldownClockwise''
 +
* '''number''' ''radialCooldownOriginAngle''
 +
* '''number''' ''resizeHandleSize''
 +
* '''boolean''' ''resizeToFitDescendents''
 +
* '''boolean''' ''resizeToFitFile''
 +
* '''number''' ''scale''
 +
* '''string''' ''selectionColor''
 +
* '''number''' '''[[Globals#ShaderEffectType|ShaderEffectType]]''' ''shaderEffectType''
 +
* '''number''' '''[[Globals#ShapeType|ShapeType]]''' ''shape''
 +
* '''boolean''' ''splitLongMessages''
 +
* '''number''' ''startAlpha''
 +
* '''string''' ''startColor''
 +
* '''number''' ''startHeight''
 +
* '''number''' ''startPitch''
 +
* '''number''' ''startRoll''
 +
* '''number''' ''startRotation''
 +
* '''number''' ''startScale''
 +
* '''number''' ''startWidth''
 +
* '''number''' ''startX''
 +
* '''number''' ''startY''
 +
* '''number''' ''startYaw''
 +
* '''number''' ''startZ''
 +
* '''number''' ''step''
 +
* '''string''' ''styleColor''
 +
* '''string''' ''text''
 +
* '''string''' ''textType''
 +
* '''number''' ''textureCoordsRotation''
 +
* '''string''' ''textureFile''
 +
* '''number''' '''[[Globals#ReleaseReferenceOptions|ReleaseReferenceOptions]]''' ''textureFileReleaseOption''
 +
* '''number''' ''thickness''
 +
* '''string''' ''tier''
 +
* '''boolean''' ''topmost''
 +
* '''number''' '''[[Globals#TextAlignment|TextAlignment]]''' ''verticalAlignment''
 +
* '''number''' '''[[Globals#TextWrapMode|TextWrapMode]]''' ''wrapMode''
 +
 
 +
 
 +
===AlphaAnimation===
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#Attributes|Child: endAlpha]]
* [[#Attributes|Child: endAlpha]]
* [[#Attributes|Child: startAlpha]]
* [[#Attributes|Child: startAlpha]]
-
=== Anchor ===
+
 
-
* ''attribute:'' '''[[#AnchorPosition|AnchorPosition]]''' ''point''
+
===Anchor===
-
* ''attribute:'' '''[[#AnchorPosition|AnchorPosition]]''' ''relativePoint''
+
* ''attribute:'' '''[[Globals#AnchorPosition|AnchorPosition]]''' ''point''
 +
* ''attribute:'' '''[[Globals#AnchorPosition|AnchorPosition]]''' ''relativePoint''
* ''attribute:'' '''string''' ''relativeTo''
* ''attribute:'' '''string''' ''relativeTo''
* ''attribute:'' '''number''' ''offsetX''
* ''attribute:'' '''number''' ''offsetX''
* ''attribute:'' '''number''' ''offsetY''
* ''attribute:'' '''number''' ''offsetY''
 +
* ''attribute:'' '''[[Globals#AnchorConstrains|AnchorConstrains]]''' ''constrains''
-
=== AnchorFill ===
 
-
=== AnchorToBaseline ===
+
===AnchorFill===
 +
 
 +
 
 +
 
 +
===AnchorToBaseline===
* ''attribute:'' '''string''' ''relativeToLabel''
* ''attribute:'' '''string''' ''relativeToLabel''
* ''attribute:'' '''number''' ''offsetX''
* ''attribute:'' '''number''' ''offsetX''
-
* ''attribute:'' '''[[#AnchorPosition|AnchorPosition]]''' ''side''
+
* ''attribute:'' '''[[Globals#AnchorPosition|AnchorPosition]]''' ''side''
 +
 
-
=== AnimationBase ===
+
===AnimationBase===
* ''attribute:'' '''string''' ''name''
* ''attribute:'' '''string''' ''name''
* [[#EasingFunction|Child: EasingFunction]]
* [[#EasingFunction|Child: EasingFunction]]
* [[#OnPlay_Animation|Child: OnPlay_Animation]]
* [[#OnPlay_Animation|Child: OnPlay_Animation]]
* [[#OnStop_Animation|Child: OnStop_Animation]]
* [[#OnStop_Animation|Child: OnStop_Animation]]
 +
* [[#Attributes|Child: applyToChildControlName]]
* [[#Attributes|Child: delay]]
* [[#Attributes|Child: delay]]
* [[#Attributes|Child: duration]]
* [[#Attributes|Child: duration]]
 +
* [[#Attributes|Child: enabled]]
* [[#Attributes|Child: inherits]]
* [[#Attributes|Child: inherits]]
-
=== AnimationTimeline ===
+
 
 +
===AnimationTimeline===
* ''attribute:'' '''string''' ''name''
* ''attribute:'' '''string''' ''name''
* [[#Animations|Child: Animations]]
* [[#Animations|Child: Animations]]
Line 37: Line 336:
* [[#OnStop|Child: OnStop]]
* [[#OnStop|Child: OnStop]]
* [[#Attributes|Child: delay]]
* [[#Attributes|Child: delay]]
 +
* [[#Attributes|Child: enabled]]
* [[#Attributes|Child: inherits]]
* [[#Attributes|Child: inherits]]
* [[#Attributes|Child: loopCount]]
* [[#Attributes|Child: loopCount]]
 +
* [[#Attributes|Child: minDuration]]
* [[#Attributes|Child: playbackType]]
* [[#Attributes|Child: playbackType]]
-
=== Animations ===
+
 
 +
===Animations===
* [[#AlphaAnimation|Child: AlphaAnimation]]
* [[#AlphaAnimation|Child: AlphaAnimation]]
* [[#AnimationTimeline|Child: AnimationTimeline]]
* [[#AnimationTimeline|Child: AnimationTimeline]]
* [[#ColorAnimation|Child: ColorAnimation]]
* [[#ColorAnimation|Child: ColorAnimation]]
* [[#CustomAnimation|Child: CustomAnimation]]
* [[#CustomAnimation|Child: CustomAnimation]]
 +
* [[#Rotate3DAnimation|Child: Rotate3DAnimation]]
* [[#ScaleAnimation|Child: ScaleAnimation]]
* [[#ScaleAnimation|Child: ScaleAnimation]]
* [[#SizeAnimation|Child: SizeAnimation]]
* [[#SizeAnimation|Child: SizeAnimation]]
* [[#TextureAnimation|Child: TextureAnimation]]
* [[#TextureAnimation|Child: TextureAnimation]]
* [[#TextureRotateAnimation|Child: TextureRotateAnimation]]
* [[#TextureRotateAnimation|Child: TextureRotateAnimation]]
 +
* [[#Translate3DAnimation|Child: Translate3DAnimation]]
* [[#TranslateAnimation|Child: TranslateAnimation]]
* [[#TranslateAnimation|Child: TranslateAnimation]]
-
=== Backdrop ===
+
 
 +
===Backdrop===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#Center|Child: Center]]
* [[#Center|Child: Center]]
Line 62: Line 367:
* [[#Attributes|Child: integralWrapping]]
* [[#Attributes|Child: integralWrapping]]
* [[#Attributes|Child: pixelRoundingEnabled]]
* [[#Attributes|Child: pixelRoundingEnabled]]
 +
* [[#Attributes|Child: textureFileReleaseOption]]
-
=== BackgroundBottom ===
+
 
 +
===BackgroundBottom===
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''left''
Line 70: Line 377:
* ''attribute:'' '''number''' ''right''
* ''attribute:'' '''number''' ''right''
-
=== BackgroundMiddle ===
+
 
 +
===BackgroundMiddle===
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''left''
Line 77: Line 385:
* ''attribute:'' '''number''' ''right''
* ''attribute:'' '''number''' ''right''
-
=== BackgroundTop ===
+
 
 +
===BackgroundTop===
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''left''
Line 84: Line 393:
* ''attribute:'' '''number''' ''right''
* ''attribute:'' '''number''' ''right''
-
=== Browser ===
+
 
 +
===Browser===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#OnLoadFinished|Child: OnLoadFinished]]
* [[#OnLoadFinished|Child: OnLoadFinished]]
Line 90: Line 400:
* [[#OnRequestClose|Child: OnRequestClose]]
* [[#OnRequestClose|Child: OnRequestClose]]
-
=== Button ===
+
 
 +
===Button===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#ButtonState|Child: ButtonState]]
* [[#ButtonState|Child: ButtonState]]
Line 106: Line 417:
* [[#Attributes|Child: modifyTextType]]
* [[#Attributes|Child: modifyTextType]]
* [[#Attributes|Child: mouseOverBlendMode]]
* [[#Attributes|Child: mouseOverBlendMode]]
 +
* [[#Attributes|Child: pixelRoundingEnabled]]
* [[#Attributes|Child: text]]
* [[#Attributes|Child: text]]
 +
* [[#Attributes|Child: textureFileReleaseOption]]
* [[#Attributes|Child: verticalAlignment]]
* [[#Attributes|Child: verticalAlignment]]
-
=== ButtonState ===
 
-
* ''attribute:'' '''[[#ButtonState|ButtonState]]''' ''state''
 
-
* ''attribute:'' '''bool''' ''locked''
 
-
=== Callback ===
+
===ButtonState===
 +
* ''attribute:'' '''[[Globals#ButtonState|ButtonState]]''' ''state''
 +
* ''attribute:'' '''boolean''' ''locked''
 +
 
 +
 
 +
===Callback===
* [[#OnInsertAnimationTimelineCallback|Inherits: OnInsertAnimationTimelineCallback]]
* [[#OnInsertAnimationTimelineCallback|Inherits: OnInsertAnimationTimelineCallback]]
-
* ScriptArguments: local self, time = ...
+
* '''ScriptArguments:''' ''local self, time = ...''
-
=== Callbacks ===
+
 
 +
===Callbacks===
* [[#Callback|Child: Callback]]
* [[#Callback|Child: Callback]]
-
=== Center ===
+
 
 +
===Center===
* ''attribute:'' '''string''' ''file''
* ''attribute:'' '''string''' ''file''
-
* ''attribute:'' '''bool''' ''tiled''
+
* ''attribute:'' '''boolean''' ''tiled''
-
* ''attribute:'' '''integer''' ''tileSize''
+
* ''attribute:'' '''number''' ''tileSize''
-
=== ClampedToScreenInsets ===
+
 
 +
===ClampedToScreenInsets===
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''top''
* ''attribute:'' '''number''' ''top''
Line 131: Line 449:
* ''attribute:'' '''number''' ''bottom''
* ''attribute:'' '''number''' ''bottom''
-
=== ColorAnimation ===
+
 
 +
===ClearAnchors===
 +
 
 +
 
 +
 
 +
===ColorAnimation===
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#AnimationBase|Inherits: AnimationBase]]
 +
* [[#Attributes|Child: applyAlpha]]
* [[#Attributes|Child: endColor]]
* [[#Attributes|Child: endColor]]
* [[#Attributes|Child: startColor]]
* [[#Attributes|Child: startColor]]
-
=== ColorSelect ===
+
 
 +
===ColorSelect===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#OnColorSelected|Child: OnColorSelected]]
* [[#OnColorSelected|Child: OnColorSelected]]
-
=== Compass ===
+
 
 +
===Compass===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#CompassPinType|Child: CompassPinType]]
* [[#CompassPinType|Child: CompassPinType]]
-
=== CompassPinType ===
+
 
-
* ''attribute:'' '''[[#MapDisplayPinType|MapDisplayPinType]]''' ''name''
+
===CompassPinType===
 +
* ''attribute:'' '''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''name''
* ''attribute:'' '''number''' ''pinSize''
* ''attribute:'' '''number''' ''pinSize''
* ''attribute:'' '''string''' ''pinTexture''
* ''attribute:'' '''string''' ''pinTexture''
Line 152: Line 479:
* ''attribute:'' '''string''' ''belowTexture''
* ''attribute:'' '''string''' ''belowTexture''
* ''attribute:'' '''string''' ''linkTexture''
* ''attribute:'' '''string''' ''linkTexture''
-
* ''attribute:'' '''bool''' ''clamped''
+
* ''attribute:'' '''boolean''' ''clamped''
-
* ''attribute:'' '''bool''' ''allowUpdatesWhenAnimating''
+
* ''attribute:'' '''boolean''' ''allowUpdatesWhenAnimating''
-
* ''attribute:'' '''number''' ''minScale''
+
* ''attribute:'' '''number''' ''maxDistanceM''
-
* ''attribute:'' '''number''' ''maxScale''
+
* ''attribute:'' '''number''' ''closeScale''
-
* ''attribute:'' '''number''' ''minVisibleScale''
+
* ''attribute:'' '''number''' ''farScale''
-
* ''attribute:'' '''number''' ''minAlpha''
+
* ''attribute:'' '''number''' ''closeScaleDistanceM''
-
* ''attribute:'' '''number''' ''maxAlpha''
+
* ''attribute:'' '''number''' ''farScaleDistanceM''
-
* ''attribute:'' '''number''' ''minVisibleAlpha''
+
* ''attribute:'' '''number''' ''closeAlpha''
-
* ''attribute:'' '''number''' ''maxVisibleNormalizedDistance''
+
* ''attribute:'' '''number''' ''farAlpha''
-
* ''attribute:'' '''number''' ''leadingScaleCoefficient''
+
* ''attribute:'' '''number''' ''closeAlphaDistanceM''
-
* ''attribute:'' '''number''' ''scaleCoefficient''
+
* ''attribute:'' '''number''' ''farAlphaDistanceM''
-
* ''attribute:'' '''number''' ''scaleConstant''
+
-
* ''attribute:'' '''number''' ''leadingAlphaCoefficient''
+
-
* ''attribute:'' '''number''' ''alphaCoefficient''
+
-
* ''attribute:'' '''number''' ''alphaConstant''
+
* ''attribute:'' '''string''' ''animation''
* ''attribute:'' '''string''' ''animation''
* ''attribute:'' '''string''' ''addedAnimation''
* ''attribute:'' '''string''' ''addedAnimation''
* ''attribute:'' '''string''' ''removedAnimation''
* ''attribute:'' '''string''' ''removedAnimation''
-
* ''attribute:'' '''[[#DrawLayer|DrawLayer]]''' ''layer''
+
* ''attribute:'' '''[[Globals#DrawLayer|DrawLayer]]''' ''layer''
 +
* ''attribute:'' '''number''' ''drawLevelOffsetBase''
 +
 
-
=== Control ===
+
===Control===
* ''attribute:'' '''string''' ''name''
* ''attribute:'' '''string''' ''name''
-
* ''attribute:'' '''bool''' ''virtual''
+
* ''attribute:'' '''boolean''' ''virtual''
 +
* ''attribute:'' '''boolean''' ''override''
 +
* ''attribute:'' '''[[Globals#ControlAccessControl|ControlAccessControl]]''' ''accessControl''
* [[#Anchor|Child: Anchor]]
* [[#Anchor|Child: Anchor]]
* [[#AnchorFill|Child: AnchorFill]]
* [[#AnchorFill|Child: AnchorFill]]
* [[#ClampedToScreenInsets|Child: ClampedToScreenInsets]]
* [[#ClampedToScreenInsets|Child: ClampedToScreenInsets]]
 +
* [[#ClearAnchors|Child: ClearAnchors]]
* [[#Controls|Child: Controls]]
* [[#Controls|Child: Controls]]
* [[#DimensionConstraints|Child: DimensionConstraints]]
* [[#DimensionConstraints|Child: DimensionConstraints]]
Line 199: Line 527:
* [[#OnMoveStop|Child: OnMoveStop]]
* [[#OnMoveStop|Child: OnMoveStop]]
* [[#OnReceiveDrag|Child: OnReceiveDrag]]
* [[#OnReceiveDrag|Child: OnReceiveDrag]]
 +
* [[#OnRectChanged|Child: OnRectChanged]]
 +
* [[#OnRectHeightChanged|Child: OnRectHeightChanged]]
 +
* [[#OnRectWidthChanged|Child: OnRectWidthChanged]]
* [[#OnResizeStart|Child: OnResizeStart]]
* [[#OnResizeStart|Child: OnResizeStart]]
* [[#OnResizeStop|Child: OnResizeStop]]
* [[#OnResizeStop|Child: OnResizeStop]]
Line 223: Line 554:
* [[#Attributes|Child: tier]]
* [[#Attributes|Child: tier]]
-
=== Controls ===
+
 
 +
===Controls===
* [[#Backdrop|Child: Backdrop]]
* [[#Backdrop|Child: Backdrop]]
* [[#Browser|Child: Browser]]
* [[#Browser|Child: Browser]]
Line 241: Line 573:
* [[#TextBuffer|Child: TextBuffer]]
* [[#TextBuffer|Child: TextBuffer]]
* [[#Texture|Child: Texture]]
* [[#Texture|Child: Texture]]
 +
* [[#TextureComposite|Child: TextureComposite]]
* [[#Tooltip|Child: Tooltip]]
* [[#Tooltip|Child: Tooltip]]
* [[#TopLevelControl|Child: TopLevelControl]]
* [[#TopLevelControl|Child: TopLevelControl]]
-
=== Cooldown ===
+
 
 +
===Cooldown===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
 +
* [[#RadialCooldownGradient|Child: RadialCooldownGradient]]
* [[#Attributes|Child: blendMode]]
* [[#Attributes|Child: blendMode]]
* [[#Attributes|Child: fillColor]]
* [[#Attributes|Child: fillColor]]
* [[#Attributes|Child: leadingEdgeTexture]]
* [[#Attributes|Child: leadingEdgeTexture]]
 +
* [[#Attributes|Child: radialCooldownClockwise]]
 +
* [[#Attributes|Child: radialCooldownOriginAngle]]
* [[#Attributes|Child: textureFile]]
* [[#Attributes|Child: textureFile]]
 +
* [[#Attributes|Child: textureFileReleaseOption]]
-
=== CustomAnimation ===
+
 
 +
===CustomAnimation===
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#UpdateFunction|Child: UpdateFunction]]
* [[#UpdateFunction|Child: UpdateFunction]]
-
=== DebugText ===
+
 
 +
===DebugText===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#Attributes|Child: font]]
* [[#Attributes|Child: font]]
-
=== DimensionConstraints ===
+
 
 +
===DimensionConstraints===
* ''attribute:'' '''number''' ''minX''
* ''attribute:'' '''number''' ''minX''
* ''attribute:'' '''number''' ''minY''
* ''attribute:'' '''number''' ''minY''
Line 265: Line 606:
* ''attribute:'' '''number''' ''maxY''
* ''attribute:'' '''number''' ''maxY''
-
=== Dimensions ===
+
 
 +
===Dimensions===
* ''attribute:'' '''number''' ''x''
* ''attribute:'' '''number''' ''x''
* ''attribute:'' '''number''' ''y''
* ''attribute:'' '''number''' ''y''
-
=== EasingFunction ===
+
 
 +
===EasingFunction===
* [[#OnSetAnimationEaseFunction|Inherits: OnSetAnimationEaseFunction]]
* [[#OnSetAnimationEaseFunction|Inherits: OnSetAnimationEaseFunction]]
* ScriptArguments: local progress = ...
* ScriptArguments: local progress = ...
-
=== Edge ===
+
 
 +
===Edge===
* ''attribute:'' '''string''' ''file''
* ''attribute:'' '''string''' ''file''
-
* ''attribute:'' '''integer''' ''edgeFileWidth''
+
* ''attribute:'' '''number''' ''edgeFileWidth''
-
* ''attribute:'' '''integer''' ''edgeFileHeight''
+
* ''attribute:'' '''number''' ''edgeFileHeight''
-
* ''attribute:'' '''integer''' ''edgeSize''
+
* ''attribute:'' '''number''' ''edgeSize''
-
* ''attribute:'' '''integer''' ''edgeFilePadding''
+
* ''attribute:'' '''number''' ''edgeFilePadding''
 +
 
-
=== EditBox ===
+
===EditBox===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#OnBackspace|Child: OnBackspace]]
* [[#OnBackspace|Child: OnBackspace]]
Line 288: Line 633:
* [[#OnFocusGained|Child: OnFocusGained]]
* [[#OnFocusGained|Child: OnFocusGained]]
* [[#OnFocusLost|Child: OnFocusLost]]
* [[#OnFocusLost|Child: OnFocusLost]]
 +
* [[#OnIMEBeginComposition|Child: OnIMEBeginComposition]]
 +
* [[#OnIMEEndComposition|Child: OnIMEEndComposition]]
* [[#OnPageDown|Child: OnPageDown]]
* [[#OnPageDown|Child: OnPageDown]]
* [[#OnPageUp|Child: OnPageUp]]
* [[#OnPageUp|Child: OnPageUp]]
Line 294: Line 641:
* [[#OnTextChanged|Child: OnTextChanged]]
* [[#OnTextChanged|Child: OnTextChanged]]
* [[#OnUpArrow|Child: OnUpArrow]]
* [[#OnUpArrow|Child: OnUpArrow]]
 +
* [[#Attributes|Child: allowMarkupType]]
* [[#Attributes|Child: color]]
* [[#Attributes|Child: color]]
* [[#Attributes|Child: editEnabled]]
* [[#Attributes|Child: editEnabled]]
Line 303: Line 651:
* [[#Attributes|Child: textType]]
* [[#Attributes|Child: textType]]
-
=== FadeGradient ===
+
 
 +
===FadeGradient===
* ''attribute:'' '''number''' ''x1''
* ''attribute:'' '''number''' ''x1''
* ''attribute:'' '''number''' ''y1''
* ''attribute:'' '''number''' ''y1''
Line 311: Line 660:
* ''attribute:'' '''number''' ''size2''
* ''attribute:'' '''number''' ''size2''
-
=== Font ===
+
 
 +
===Font===
* ''attribute:'' '''string''' ''name''
* ''attribute:'' '''string''' ''name''
-
* ''attribute:'' '''bool''' ''virtual''
+
* ''attribute:'' '''boolean''' ''virtual''
* [[#sentinel_element|Child: sentinel_element]]
* [[#sentinel_element|Child: sentinel_element]]
* [[#Attributes|Child: font]]
* [[#Attributes|Child: font]]
* [[#Attributes|Child: inherits]]
* [[#Attributes|Child: inherits]]
-
=== FontColors ===
+
 
 +
===FontColors===
* [[#Attributes|Child: disabledColor]]
* [[#Attributes|Child: disabledColor]]
* [[#Attributes|Child: disabledPressedColor]]
* [[#Attributes|Child: disabledPressedColor]]
Line 325: Line 676:
* [[#Attributes|Child: pressedColor]]
* [[#Attributes|Child: pressedColor]]
-
=== GuiXml ===
+
 
 +
===GuiXml===
* [[#Animations|Child: Animations]]
* [[#Animations|Child: Animations]]
* [[#Controls|Child: Controls]]
* [[#Controls|Child: Controls]]
Line 331: Line 683:
* [[#String|Child: String]]
* [[#String|Child: String]]
-
=== HitInsets ===
+
 
 +
===HitInsets===
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''top''
* ''attribute:'' '''number''' ''top''
Line 337: Line 690:
* ''attribute:'' '''number''' ''bottom''
* ''attribute:'' '''number''' ''bottom''
-
=== Insets ===
+
 
 +
===Insets===
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''top''
* ''attribute:'' '''number''' ''top''
Line 343: Line 697:
* ''attribute:'' '''number''' ''bottom''
* ''attribute:'' '''number''' ''bottom''
-
=== Label ===
+
 
 +
===Label===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#AnchorToBaseline|Child: AnchorToBaseline]]
* [[#AnchorToBaseline|Child: AnchorToBaseline]]
* [[#OnLinkClicked|Child: OnLinkClicked]]
* [[#OnLinkClicked|Child: OnLinkClicked]]
 +
* [[#OnLinkMouseUp|Child: OnLinkMouseUp]]
* [[#OnTextChanged|Child: OnTextChanged]]
* [[#OnTextChanged|Child: OnTextChanged]]
* [[#OnUserAreaCreated|Child: OnUserAreaCreated]]
* [[#OnUserAreaCreated|Child: OnUserAreaCreated]]
Line 354: Line 710:
* [[#Attributes|Child: lineSpacing]]
* [[#Attributes|Child: lineSpacing]]
* [[#Attributes|Child: linkEnabled]]
* [[#Attributes|Child: linkEnabled]]
 +
* [[#Attributes|Child: maxLineCount]]
 +
* [[#Attributes|Child: minLineCount]]
* [[#Attributes|Child: modifyTextType]]
* [[#Attributes|Child: modifyTextType]]
 +
* [[#Attributes|Child: newLineIndent]]
 +
* [[#Attributes|Child: pixelRoundingEnabled]]
* [[#Attributes|Child: styleColor]]
* [[#Attributes|Child: styleColor]]
* [[#Attributes|Child: text]]
* [[#Attributes|Child: text]]
Line 360: Line 720:
* [[#Attributes|Child: wrapMode]]
* [[#Attributes|Child: wrapMode]]
-
=== LeadingEdge ===
+
 
 +
===LeadingEdge===
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''number''' ''width''
* ''attribute:'' '''number''' ''width''
* ''attribute:'' '''number''' ''height''
* ''attribute:'' '''number''' ''height''
-
=== LeadingEdgeTextureCoords ===
+
 
 +
===LeadingEdgeTextureCoords===
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''right''
* ''attribute:'' '''number''' ''right''
Line 371: Line 733:
* ''attribute:'' '''number''' ''bottom''
* ''attribute:'' '''number''' ''bottom''
-
=== Limits ===
+
 
 +
===Limits===
* ''attribute:'' '''number''' ''min''
* ''attribute:'' '''number''' ''min''
* ''attribute:'' '''number''' ''max''
* ''attribute:'' '''number''' ''max''
-
=== Line ===
+
 
 +
===Line===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#TextureCoords|Child: TextureCoords]]
* [[#TextureCoords|Child: TextureCoords]]
* [[#Attributes|Child: blendMode]]
* [[#Attributes|Child: blendMode]]
* [[#Attributes|Child: color]]
* [[#Attributes|Child: color]]
 +
* [[#Attributes|Child: pixelRoundingEnabled]]
* [[#Attributes|Child: textureFile]]
* [[#Attributes|Child: textureFile]]
* [[#Attributes|Child: thickness]]
* [[#Attributes|Child: thickness]]
-
=== LineFade ===
+
 
 +
===LineFade===
* ''attribute:'' '''number''' ''fadeBegin''
* ''attribute:'' '''number''' ''fadeBegin''
* ''attribute:'' '''number''' ''fadeDuration''
* ''attribute:'' '''number''' ''fadeDuration''
-
=== MapDisplay ===
+
 
 +
===LocalDimensions3D===
 +
* ''attribute:'' '''number''' ''x''
 +
* ''attribute:'' '''number''' ''y''
 +
 
 +
 
 +
===MapDisplay===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#MapGutter|Child: MapGutter]]
* [[#MapGutter|Child: MapGutter]]
Line 395: Line 767:
* [[#Attributes|Child: shape]]
* [[#Attributes|Child: shape]]
-
=== MapGutter ===
+
 
 +
===MapGutter===
* ''attribute:'' '''number''' ''offset''
* ''attribute:'' '''number''' ''offset''
* ''attribute:'' '''number''' ''size''
* ''attribute:'' '''number''' ''size''
-
=== MapPinType ===
+
 
-
* ''attribute:'' '''[[#MapDisplayPinType|MapDisplayPinType]]''' ''name''
+
===MapPinType===
-
* ''attribute:'' '''[[#MapArrowType|MapArrowType]]''' ''arrowType''
+
* ''attribute:'' '''[[Globals#MapDisplayPinType|MapDisplayPinType]]''' ''name''
 +
* ''attribute:'' '''[[Globals#MapArrowType|MapArrowType]]''' ''arrowType''
* ''attribute:'' '''number''' ''pinSize''
* ''attribute:'' '''number''' ''pinSize''
* ''attribute:'' '''number''' ''pinXInset''
* ''attribute:'' '''number''' ''pinXInset''
Line 415: Line 789:
* ''attribute:'' '''string''' ''addedAnimation''
* ''attribute:'' '''string''' ''addedAnimation''
* ''attribute:'' '''string''' ''removedAnimation''
* ''attribute:'' '''string''' ''removedAnimation''
-
* ''attribute:'' '''[[#MapPinAnimationTarget|MapPinAnimationTarget]]''' ''animationTarget''
+
* ''attribute:'' '''[[Globals#MapPinAnimationTarget|MapPinAnimationTarget]]''' ''animationTarget''
-
=== MouseButton ===
 
-
* ''attribute:'' '''integer''' ''button''
 
-
* ''attribute:'' '''bool''' ''enabled''
 
-
=== NormalOffset ===
+
===MouseButton===
 +
* ''attribute:'' '''number''' ''button''
 +
* ''attribute:'' '''boolean''' ''enabled''
 +
 
 +
 
 +
===NormalOffset===
* ''attribute:'' '''number''' ''x''
* ''attribute:'' '''number''' ''x''
* ''attribute:'' '''number''' ''y''
* ''attribute:'' '''number''' ''y''
-
=== OnAddGameData ===
+
 
 +
===OnAddGameData===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnBackspace ===
+
 
 +
===OnBackspace===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnChar ===
+
 
 +
===OnChar===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, key = ...
+
* '''ScriptArguments:''' ''local self, key = ...''
 +
 
-
=== OnCleared ===
+
===OnCleared===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnClicked ===
+
 
 +
===OnClicked===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, button = ...
+
* '''ScriptArguments:''' ''local self, button, ctrl, alt, shift, command = ...''
-
=== OnColorSelected ===
+
 
 +
===OnColorSelected===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, r, g, b = ...
+
* '''ScriptArguments:''' ''local self, r, g, b = ...''
-
=== OnDownArrow ===
+
 
 +
===OnDownArrow===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnDragStart ===
+
 
 +
===OnDragStart===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, button = ...
+
* '''ScriptArguments:''' ''local self, button = ...''
 +
 
-
=== OnDurationChanged ===
+
===OnDurationChanged===
* [[#OnSetAnimationTimelineEventHandler|Inherits: OnSetAnimationTimelineEventHandler]]
* [[#OnSetAnimationTimelineEventHandler|Inherits: OnSetAnimationTimelineEventHandler]]
-
* ScriptArguments: local self, duration = ...
+
* '''ScriptArguments:''' ''local self, duration = ...''
-
=== OnEffectivelyHidden ===
+
 
 +
===OnEffectivelyHidden===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, hidden = ...
+
* '''ScriptArguments:''' ''local self, hidden = ...''
-
=== OnEffectivelyShown ===
+
 
 +
===OnEffectivelyShown===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, hidden = ...
+
* '''ScriptArguments:''' ''local self, hidden = ...''
-
=== OnEnabledStateChanged ===
+
 
 +
===OnEnabledStateChanged===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, enabled = ...
+
* '''ScriptArguments:''' ''local self, enabled = ...''
-
=== OnEnter ===
+
 
 +
===OnEnter===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
 +
 
-
=== OnEscape ===
+
===OnEscape===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnFocusGained ===
+
 
 +
===OnFocusGained===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnFocusLost ===
+
 
 +
===OnFocusLost===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnHide ===
+
 
 +
===OnHide===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, hidden = ...
+
* '''ScriptArguments:''' ''local self, hidden = ...''
 +
 
-
=== OnInitialized ===
+
===OnIMEBeginComposition===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnInsertAnimationTimelineCallback ===
 
-
* ''attribute:'' '''integer''' ''delay''
 
-
=== OnKeyDown ===
+
===OnIMEEndComposition===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, key, ctrl, alt, shift, command = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnKeyUp ===
+
 
 +
===OnInitialized===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, key, ctrl, alt, shift, command = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnLinkClicked ===
+
 
 +
===OnInsertAnimationTimelineCallback===
 +
* ''attribute:'' '''number''' ''delay''
 +
 
 +
 
 +
===OnKeyDown===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, linkData, linkText, button, ctrl, alt, shift, command = ...
+
* '''ScriptArguments:''' ''local self, key, ctrl, alt, shift, command = ...''
-
=== OnLoadFinished ===
+
 
 +
===OnKeyUp===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, key, ctrl, alt, shift, command = ...''
 +
 
-
=== OnLoadStart ===
+
===OnLinkClicked===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, linkData, linkText, button, ctrl, alt, shift, command = ...''
-
=== OnMinMaxValueChanged ===
+
 
 +
===OnLinkMouseUp===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, min, max = ...
+
* '''ScriptArguments:''' ''local self, linkData, linkText, button, ctrl, alt, shift, command = ...''
-
=== OnMouseDoubleClick ===
+
 
 +
===OnLoadFinished===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, button, ctrl, alt, shift, command = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnMouseDown ===
+
 
 +
===OnLoadStart===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, button, ctrl, alt, shift, command = ...
+
* '''ScriptArguments:''' ''local self = ...''
 +
 
-
=== OnMouseEnter ===
+
===OnMinMaxValueChanged===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, min, max = ...''
-
=== OnMouseExit ===
+
 
 +
===OnMouseDoubleClick===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, button, ctrl, alt, shift, command = ...''
-
=== OnMouseUp ===
+
 
 +
===OnMouseDown===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, button, upInside, ctrl, alt, shift, command = ...
+
* '''ScriptArguments:''' ''local self, button, ctrl, alt, shift, command = ...''
-
=== OnMouseWheel ===
+
 
 +
===OnMouseEnter===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, delta, ctrl, alt, shift, command = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnMoveStart ===
+
 
 +
===OnMouseExit===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
 +
 
-
=== OnMoveStop ===
+
===OnMouseUp===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, button, upInside, ctrl, alt, shift, command = ...''
-
=== OnPageDown ===
+
 
 +
===OnMouseWheel===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, delta, ctrl, alt, shift, command = ...''
-
=== OnPageUp ===
+
 
 +
===OnMoveStart===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnPlay ===
+
 
 +
===OnMoveStop===
 +
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
 +
* '''ScriptArguments:''' ''local self = ...''
 +
 
 +
 
 +
===OnPageDown===
 +
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
 +
* '''ScriptArguments:''' ''local self = ...''
 +
 
 +
 
 +
===OnPageUp===
 +
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
 +
* '''ScriptArguments:''' ''local self = ...''
 +
 
 +
 
 +
===OnPlay===
* [[#OnSetAnimationTimelineEventHandler|Inherits: OnSetAnimationTimelineEventHandler]]
* [[#OnSetAnimationTimelineEventHandler|Inherits: OnSetAnimationTimelineEventHandler]]
-
* ScriptArguments: local self, completedPlaying = ...
+
* '''ScriptArguments:''' ''local self, completedPlaying = ...''
 +
 
-
=== OnPlay_Animation ===
+
===OnPlay_Animation===
* [[#OnSetAnimationEventHandler|Inherits: OnSetAnimationEventHandler]]
* [[#OnSetAnimationEventHandler|Inherits: OnSetAnimationEventHandler]]
-
* ScriptArguments: local self, animatingControl, completedPlaying = ...
+
* '''ScriptArguments:''' ''local self, animatingControl, completedPlaying = ...''
-
=== OnReceiveDrag ===
+
 
 +
===OnReceiveDrag===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, button = ...
+
* '''ScriptArguments:''' ''local self, button = ...''
-
=== OnRequestClose ===
+
 
 +
===OnRectChanged===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, newLeft, newTop, newRight, newBottom, oldLeft, oldTop, oldRight, oldBottom = ...''
-
=== OnResizeStart ===
+
 
 +
===OnRectHeightChanged===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, newHeight, oldHeight = ...''
-
=== OnResizeStop ===
+
 
 +
===OnRectWidthChanged===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, newWidth, oldWidth = ...''
 +
 
-
=== OnResizedToFit ===
+
===OnRequestClose===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, desiredWidth, desiredHeight = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnScrollExtentsChanged ===
+
 
 +
===OnResizeStart===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, horizontal, vertical = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnScrollOffsetChanged ===
+
 
 +
===OnResizeStop===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, horizontal, vertical = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnSetAnimationEaseFunction ===
 
-
=== OnSetAnimationEventHandler ===
+
===OnResizedToFit===
 +
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
 +
* '''ScriptArguments:''' ''local self, desiredWidth, desiredHeight = ...''
-
=== OnSetAnimationTimelineEventHandler ===
 
-
=== OnSetControlEventHandler ===
+
===OnScrollExtentsChanged===
 +
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
 +
* '''ScriptArguments:''' ''local self, horizontal, vertical = ...''
-
=== OnSetUpdateFunction ===
 
-
=== OnShow ===
+
===OnScrollOffsetChanged===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, hidden = ...
+
* '''ScriptArguments:''' ''local self, horizontal, vertical = ...''
-
=== OnSliderReleased ===
+
 
 +
===OnSetAnimationEaseFunction===
 +
 
 +
 
 +
 
 +
===OnSetAnimationEventHandler===
 +
 
 +
 
 +
 
 +
===OnSetAnimationTimelineEventHandler===
 +
 
 +
 
 +
 
 +
===OnSetControlEventHandler===
 +
 
 +
 
 +
 
 +
===OnSetUpdateFunction===
 +
 
 +
 
 +
 
 +
===OnShow===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, value = ...
+
* '''ScriptArguments:''' ''local self, hidden = ...''
-
=== OnSpace ===
+
 
 +
===OnSliderReleased===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self, value = ...''
-
=== OnStop ===
+
 
 +
===OnSpace===
 +
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
 +
* '''ScriptArguments:''' ''local self = ...''
 +
 
 +
 
 +
===OnStop===
* [[#OnSetAnimationTimelineEventHandler|Inherits: OnSetAnimationTimelineEventHandler]]
* [[#OnSetAnimationTimelineEventHandler|Inherits: OnSetAnimationTimelineEventHandler]]
-
* ScriptArguments: local self, completedPlaying = ...
+
* '''ScriptArguments:''' ''local self, completedPlaying = ...''
 +
 
-
=== OnStop_Animation ===
+
===OnStop_Animation===
* [[#OnSetAnimationEventHandler|Inherits: OnSetAnimationEventHandler]]
* [[#OnSetAnimationEventHandler|Inherits: OnSetAnimationEventHandler]]
-
* ScriptArguments: local self, animatingControl, completedPlaying = ...
+
* '''ScriptArguments:''' ''local self, animatingControl, completedPlaying = ...''
-
=== OnTab ===
+
 
 +
===OnTab===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnTextChanged ===
+
 
 +
===OnTextChanged===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnUpArrow ===
+
 
 +
===OnTextureLoaded===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self = ...
+
* '''ScriptArguments:''' ''local self = ...''
-
=== OnUpdate ===
+
 
 +
===OnUpArrow===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, time = ...
+
* '''ScriptArguments:''' ''local self = ...''
 +
 
-
=== OnUserAreaCreated ===
+
===OnUpdate===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, areaData, areaText, left, right, top, bottom = ...
+
* '''ScriptArguments:''' ''local self, time = ...''
-
=== OnValueChanged ===
+
 
 +
===OnUserAreaCreated===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, value, eventReason = ...
+
* '''ScriptArguments:''' ''local self, areaData, areaText, left, right, top, bottom, continuation = ...''
-
=== OnVisibleRadiusChanged ===
+
 
 +
===OnValueChanged===
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
-
* ScriptArguments: local self, radius = ...
+
* '''ScriptArguments:''' ''local self, value, eventReason = ...''
-
=== PressedOffset ===
+
 
 +
===OnVisibleRadiusChanged===
 +
* [[#OnSetControlEventHandler|Inherits: OnSetControlEventHandler]]
 +
* '''ScriptArguments:''' ''local self, radius = ...''
 +
 
 +
 
 +
===PressedOffset===
* ''attribute:'' '''number''' ''x''
* ''attribute:'' '''number''' ''x''
* ''attribute:'' '''number''' ''y''
* ''attribute:'' '''number''' ''y''
-
=== ResizeToFitPadding ===
+
 
 +
===RadialCooldownGradient===
 +
* ''attribute:'' '''number''' ''startAlpha''
 +
* ''attribute:'' '''number''' ''angularDistance''
 +
 
 +
 
 +
===ResizeToFitPadding===
* ''attribute:'' '''number''' ''width''
* ''attribute:'' '''number''' ''width''
* ''attribute:'' '''number''' ''height''
* ''attribute:'' '''number''' ''height''
-
=== ScaleAnimation ===
+
 
 +
===Rotate3DAnimation===
 +
* [[#AnimationBase|Inherits: AnimationBase]]
 +
* [[#Attributes|Child: endPitch]]
 +
* [[#Attributes|Child: endRoll]]
 +
* [[#Attributes|Child: endYaw]]
 +
* [[#Attributes|Child: startPitch]]
 +
* [[#Attributes|Child: startRoll]]
 +
* [[#Attributes|Child: startYaw]]
 +
 
 +
 
 +
===ScaleAnimation===
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#Attributes|Child: endScale]]
* [[#Attributes|Child: endScale]]
* [[#Attributes|Child: startScale]]
* [[#Attributes|Child: startScale]]
-
=== Scroll ===
+
 
 +
===Scroll===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#FadeGradient|Child: FadeGradient]]
* [[#FadeGradient|Child: FadeGradient]]
Line 677: Line 1,173:
* [[#OnScrollOffsetChanged|Child: OnScrollOffsetChanged]]
* [[#OnScrollOffsetChanged|Child: OnScrollOffsetChanged]]
-
=== ScrollingOverlay ===
+
 
 +
===ScrollingOverlay===
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''number''' ''width''
* ''attribute:'' '''number''' ''width''
* ''attribute:'' '''number''' ''height''
* ''attribute:'' '''number''' ''height''
-
* ''attribute:'' '''integer''' ''duration''
+
* ''attribute:'' '''number''' ''duration''
 +
 
-
=== SizeAnimation ===
+
===SizeAnimation===
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#Attributes|Child: endHeight]]
* [[#Attributes|Child: endHeight]]
Line 690: Line 1,188:
* [[#Attributes|Child: startWidth]]
* [[#Attributes|Child: startWidth]]
-
=== Slider ===
+
 
 +
===Slider===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#BackgroundBottom|Child: BackgroundBottom]]
* [[#BackgroundBottom|Child: BackgroundBottom]]
Line 704: Line 1,203:
* [[#Attributes|Child: step]]
* [[#Attributes|Child: step]]
-
=== StatusBar ===
+
 
 +
===StatusBar===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#LeadingEdge|Child: LeadingEdge]]
* [[#LeadingEdge|Child: LeadingEdge]]
Line 722: Line 1,222:
* [[#Attributes|Child: textureFile]]
* [[#Attributes|Child: textureFile]]
-
=== String ===
+
 
 +
===String===
* ''attribute:'' '''string''' ''name''
* ''attribute:'' '''string''' ''name''
* ''attribute:'' '''string''' ''value''
* ''attribute:'' '''string''' ''value''
-
=== TextBuffer ===
+
 
 +
===Surface===
 +
* ''attribute:'' '''number''' ''texCoordLeft''
 +
* ''attribute:'' '''number''' ''texCoordRight''
 +
* ''attribute:'' '''number''' ''texCoordTop''
 +
* ''attribute:'' '''number''' ''texCoordBottom''
 +
* ''attribute:'' '''number''' ''insetLeft''
 +
* ''attribute:'' '''number''' ''insetRight''
 +
* ''attribute:'' '''number''' ''insetTop''
 +
* ''attribute:'' '''number''' ''insetBottom''
 +
* ''attribute:'' '''string''' ''color''
 +
 
 +
 
 +
===TextBuffer===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#LineFade|Child: LineFade]]
* [[#LineFade|Child: LineFade]]
* [[#OnLinkClicked|Child: OnLinkClicked]]
* [[#OnLinkClicked|Child: OnLinkClicked]]
 +
* [[#OnLinkMouseUp|Child: OnLinkMouseUp]]
* [[#Attributes|Child: color]]
* [[#Attributes|Child: color]]
* [[#Attributes|Child: drawLastEntryIfOutOfRoom]]
* [[#Attributes|Child: drawLastEntryIfOutOfRoom]]
Line 738: Line 1,253:
* [[#Attributes|Child: splitLongMessages]]
* [[#Attributes|Child: splitLongMessages]]
-
=== Texture ===
+
 
 +
===Texture===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
 +
* [[#LocalDimensions3D|Child: LocalDimensions3D]]
 +
* [[#OnTextureLoaded|Child: OnTextureLoaded]]
* [[#TextureCoords|Child: TextureCoords]]
* [[#TextureCoords|Child: TextureCoords]]
 +
* [[#TextureSampleProcessingWeight|Child: TextureSampleProcessingWeight]]
* [[#Attributes|Child: addressMode]]
* [[#Attributes|Child: addressMode]]
 +
* [[#Attributes|Child: autoAdjustTextureCoords]]
* [[#Attributes|Child: blendMode]]
* [[#Attributes|Child: blendMode]]
* [[#Attributes|Child: color]]
* [[#Attributes|Child: color]]
 +
* [[#Attributes|Child: desaturation]]
* [[#Attributes|Child: pixelRoundingEnabled]]
* [[#Attributes|Child: pixelRoundingEnabled]]
* [[#Attributes|Child: resizeToFitFile]]
* [[#Attributes|Child: resizeToFitFile]]
 +
* [[#Attributes|Child: shaderEffectType]]
 +
* [[#Attributes|Child: textureCoordsRotation]]
* [[#Attributes|Child: textureFile]]
* [[#Attributes|Child: textureFile]]
 +
* [[#Attributes|Child: textureFileReleaseOption]]
-
=== TextureAnimation ===
+
 
 +
===TextureAnimation===
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#Attributes|Child: cellsHigh]]
* [[#Attributes|Child: cellsHigh]]
Line 756: Line 1,281:
* [[#Attributes|Child: mirrorAlongY]]
* [[#Attributes|Child: mirrorAlongY]]
-
=== TextureCoords ===
+
 
 +
===TextureComposite===
 +
* [[#Control|Inherits: Control]]
 +
* [[#Surface|Child: Surface]]
 +
* [[#Attributes|Child: blendMode]]
 +
* [[#Attributes|Child: pixelRoundingEnabled]]
 +
* [[#Attributes|Child: textureFile]]
 +
* [[#Attributes|Child: textureFileReleaseOption]]
 +
 
 +
 
 +
===TextureCoords===
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''left''
* ''attribute:'' '''number''' ''right''
* ''attribute:'' '''number''' ''right''
Line 762: Line 1,297:
* ''attribute:'' '''number''' ''bottom''
* ''attribute:'' '''number''' ''bottom''
-
=== TextureRotateAnimation ===
+
 
 +
===TextureRotateAnimation===
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#Attributes|Child: endRotation]]
* [[#Attributes|Child: endRotation]]
* [[#Attributes|Child: startRotation]]
* [[#Attributes|Child: startRotation]]
-
=== Textures ===
+
 
 +
===TextureSampleProcessingWeight===
 +
* ''attribute:'' '''[[Globals#TextureSampleProcessing|TextureSampleProcessing]]''' ''type''
 +
* ''attribute:'' '''number''' ''weight''
 +
 
 +
 
 +
===Textures===
* [[#Attributes|Child: disabled]]
* [[#Attributes|Child: disabled]]
* [[#Attributes|Child: disabledPressed]]
* [[#Attributes|Child: disabledPressed]]
Line 775: Line 1,317:
* [[#Attributes|Child: pressedMouseOver]]
* [[#Attributes|Child: pressedMouseOver]]
-
=== ThumbTexture ===
+
 
 +
===ThumbTexture===
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''string''' ''textureFile''
* ''attribute:'' '''string''' ''disabledTextureFile''
* ''attribute:'' '''string''' ''disabledTextureFile''
Line 785: Line 1,328:
* ''attribute:'' '''number''' ''bottom''
* ''attribute:'' '''number''' ''bottom''
* ''attribute:'' '''number''' ''right''
* ''attribute:'' '''number''' ''right''
-
* ''attribute:'' '''bool''' ''flushWithSliderExtents''
+
* ''attribute:'' '''boolean''' ''flushWithSliderExtents''
-
=== Tooltip ===
+
 
 +
===Tooltip===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#OnAddGameData|Child: OnAddGameData]]
* [[#OnAddGameData|Child: OnAddGameData]]
Line 795: Line 1,339:
* [[#Attributes|Child: headerVerticalOffset]]
* [[#Attributes|Child: headerVerticalOffset]]
-
=== TopLevelControl ===
+
 
 +
===TopLevelControl===
* [[#Control|Inherits: Control]]
* [[#Control|Inherits: Control]]
* [[#Attributes|Child: allowBringToTop]]
* [[#Attributes|Child: allowBringToTop]]
* [[#Attributes|Child: topmost]]
* [[#Attributes|Child: topmost]]
-
=== TranslateAnimation ===
+
 
 +
===Translate3DAnimation===
 +
* [[#AnimationBase|Inherits: AnimationBase]]
 +
* [[#Attributes|Child: deltaX]]
 +
* [[#Attributes|Child: deltaXFromEnd]]
 +
* [[#Attributes|Child: deltaY]]
 +
* [[#Attributes|Child: deltaYFromEnd]]
 +
* [[#Attributes|Child: deltaZ]]
 +
* [[#Attributes|Child: deltaZFromEnd]]
 +
* [[#Attributes|Child: endX]]
 +
* [[#Attributes|Child: endY]]
 +
* [[#Attributes|Child: endZ]]
 +
* [[#Attributes|Child: startX]]
 +
* [[#Attributes|Child: startY]]
 +
* [[#Attributes|Child: startZ]]
 +
 
 +
 
 +
===TranslateAnimation===
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#AnimationBase|Inherits: AnimationBase]]
* [[#Attributes|Child: anchorIndex]]
* [[#Attributes|Child: anchorIndex]]
* [[#Attributes|Child: deltaX]]
* [[#Attributes|Child: deltaX]]
 +
* [[#Attributes|Child: deltaXFromEnd]]
* [[#Attributes|Child: deltaY]]
* [[#Attributes|Child: deltaY]]
 +
* [[#Attributes|Child: deltaYFromEnd]]
* [[#Attributes|Child: endX]]
* [[#Attributes|Child: endX]]
* [[#Attributes|Child: endY]]
* [[#Attributes|Child: endY]]
Line 810: Line 1,374:
* [[#Attributes|Child: startY]]
* [[#Attributes|Child: startY]]
-
=== UpdateFunction ===
 
-
* [[#OnSetUpdateFunction|Inherits: OnSetUpdateFunction]]
 
-
* ScriptArguments: local self, progress = ...
 
 +
===UpdateFunction===
 +
* [[#OnSetUpdateFunction|Inherits: OnSetUpdateFunction]]
 +
* '''ScriptArguments:''' ''local self, progress = ...''
-
== Attributes ==
 
-
These attributes are potentially shared by various UI elements.
 
-
* addressMode '''[[Globals#TextureAddressMode|TextureAddressMode]]'''
+
===sentinel_element===
-
* allowBringToTop '''bool'''
+
-
* alpha '''number'''
+
-
* anchorIndex '''integer'''
+
-
* barAlignment '''[[Globals#BarAlignment|BarAlignment]]'''
+
-
* blendMode '''[[Globals#TextureBlendMode|TextureBlendMode]]'''
+
-
* cellsHigh '''integer'''
+
-
* cellsWide '''integer'''
+
-
* centerColor '''string'''
+
-
* clampedToScreen '''bool'''
+
-
* clickSound '''string'''
+
-
* color '''string'''
+
-
* delay '''integer'''
+
-
* deltaX '''number'''
+
-
* deltaY '''number'''
+
-
* disabled '''string'''
+
-
* disabledColor '''string'''
+
-
* disabledPressed '''string'''
+
-
* disabledPressedColor '''string'''
+
-
* dragFromThumb '''bool'''
+
-
* drawLastEntryIfOutOfRoom '''bool'''
+
-
* duration '''integer'''
+
-
* edgeColor '''string'''
+
-
* editEnabled '''bool'''
+
-
* enableFadeOut '''bool'''
+
-
* endAlpha '''number'''
+
-
* endCapWidth '''integer'''
+
-
* endColor '''string'''
+
-
* endHeight '''number'''
+
-
* endRotation '''number'''
+
-
* endScale '''number'''
+
-
* endWidth '''number'''
+
-
* endX '''number'''
+
-
* endY '''number'''
+
-
* excludeFromResizeToFitExtents '''bool'''
+
-
* fadeOutGainColor '''string'''
+
-
* fadeOutLossColor '''string'''
+
-
* fadeOutTextureFile '''string'''
+
-
* fillColor '''string'''
+
-
* font '''string'''
+
-
* framerate '''number'''
+
-
* headerRowSpacing '''number'''
+
-
* headerVerticalOffset '''number'''
+
-
* hidden '''bool'''
+
-
* horizontalAlignment '''[[Globals#TextAlignment|TextAlignment]]'''
+
-
* id '''integer'''
+
-
* inheritAlpha '''bool'''
+
-
* inheritScale '''bool'''
+
-
* inherits '''string'''
+
-
* integralWrapping '''bool'''
+
-
* keyboardEnabled '''bool'''
+
-
* layer '''string'''
+
-
* leadingEdgeTexture '''string'''
+
-
* level '''integer'''
+
-
* lineSpacing '''integer'''
+
-
* linkEnabled '''bool'''
+
-
* loopCount '''string'''
+
-
* maxHistoryLines '''integer'''
+
-
* maxInputCharacters '''integer'''
+
-
* mirrorAlongX '''bool'''
+
-
* mirrorAlongY '''bool'''
+
-
* modifyTextType '''[[Globals#ModifyTextType|ModifyTextType]]'''
+
-
* mouseEnabled '''bool'''
+
-
* mouseOver '''string'''
+
-
* mouseOverBlendMode '''[[Globals#TextureBlendMode|TextureBlendMode]]'''
+
-
* mouseOverColor '''string'''
+
-
* movable '''bool'''
+
-
* multiLine '''bool'''
+
-
* newLineEnabled '''bool'''
+
-
* newLineIndent '''number'''
+
-
* normal '''string'''
+
-
* normalColor '''string'''
+
-
* orientation '''[[Globals#ControlOrientation|ControlOrientation]]'''
+
-
* pinFont '''string'''
+
-
* pixelRoundingEnabled '''bool'''
+
-
* playbackType '''[[Globals#AnimationPlayback|AnimationPlayback]]'''
+
-
* pressed '''string'''
+
-
* pressedColor '''string'''
+
-
* pressedMouseOver '''string'''
+
-
* resizeHandleSize '''number'''
+
-
* resizeToFitDescendents '''bool'''
+
-
* resizeToFitFile '''bool'''
+
-
* scale '''number'''
+
-
* selectionColor '''string'''
+
-
* shape '''[[Globals#ShapeType|ShapeType]]'''
+
-
* splitLongMessages '''bool'''
+
-
* startAlpha '''number'''
+
-
* startColor '''string'''
+
-
* startHeight '''number'''
+
-
* startRotation '''number'''
+
-
* startScale '''number'''
+
-
* startWidth '''number'''
+
-
* startX '''number'''
+
-
* startY '''number'''
+
-
* step '''number'''
+
-
* styleColor '''string'''
+
-
* text '''string'''
+
-
* textType '''string'''
+
-
* textureFile '''string'''
+
-
* thickness '''number'''
+
-
* tier '''string'''
+
-
* topmost '''bool'''
+
-
* verticalAlignment '''[[Globals#TextAlignment|TextAlignment]]'''
+
-
* wrapMode '''[[Globals#TextWrapMode|TextWrapMode]]'''
+

Latest revision as of 16:41, 11 July 2019

Page up-to-date to API Version 100028



Contents

Introduction

This is the exhaustive list of UI Elements used to drawn the UI of Elder Scrolls Online.

Structure

<GuiXml>
 
	<!-- New Font definition -->
	<Font name="ZoFontBookTabletSmall" font="$(STONE_TABLET_FONT)|$(KB_24)|soft-shadow-thick" />
	<Font name="ZoFontGameMini" font="$(BOLD_FONT)|$(KB_13)|soft-shadow-thin" />
 
	<!-- Your Controls should be INSIDE this Element -->
	<Controls>
 
		<Label name="SuperStarXMLSkillsNavigationEntry" virtual="true" font="ZoFontHeader" inherits="ZO_SelectableLabel">
			<OnMouseUp>
				ZO_TreeEntry_OnMouseUp(self, upInside)
			</OnMouseUp>
		</Label>
 
	</Controls>
</GuiXml>


Magic Values


In the example under,

<Backdrop name="$(parent)BG" inherits="ZO_DefaultBackdrop" />

is equal to :

<Backdrop name="AIResearchGridBG" inherits="ZO_DefaultBackdrop" />

Inheritance


In the example under,

<Backdrop name="$(parent)BG" inherits="ZO_DefaultBackdrop" />

Inherits the ZO_DefaultBackdrop sub elements, attributes, code, etc. ZO_DefaultBackdrop MUST be loaded before the file which define this block.


Virtualization

In the example under,

		<Control name="SuperStarXMLSkillsAbilityTypeHeader" virtual="true">
			<Dimensions y="32"/>
			<Controls>
				<Label name="$(parent)Label" font="ZoFontHeader2" color="INTERFACE_COLOR_TYPE_TEXT_COLORS:INTERFACE_TEXT_COLOR_SELECTED" modifyTextType="UPPERCASE">
				<Anchor point="LEFT" />
			</Label>
			</Controls>
		</Control>

Is virtual.


Loading Order



Examples of UI Definition

<GuiXml>
	<Controls>
 
		<Control name="SuperStarXMLSkillsAbilityTypeHeader" virtual="true">
			<Dimensions y="32"/>
			<Controls>
				<Label name="$(parent)Label" font="ZoFontHeader2" color="INTERFACE_COLOR_TYPE_TEXT_COLORS:INTERFACE_TEXT_COLOR_SELECTED" modifyTextType="UPPERCASE">
					<Anchor point="LEFT" />
				</Label>
			</Controls>
		</Control>
 
		<!-- This TopLevelControl can be accessed in Lua throught variable "AIResearchGrid" -->
		<TopLevelControl name="AIResearchGrid" mouseEnabled="true" movable="true" clampedToScreen="true" hidden="true">
			<Dimensions x="750" y="800" />
			<Anchor point="CENTER" />
			<Controls>
 
				<Backdrop name="$(parent)BG" inherits="ZO_DefaultBackdrop" />
 
				<Label name="$(parent)WindowTitle" font="ZoFontAnnounceMedium" text="|c8080ffAI|r RESEARCH GRID">
					<Anchor point="TOPLEFT" relativeTo="$(parent)" relativePoint="TOPLEFT" />
				</Label>
 
				<Texture name="$(parent)TopDivider" textureFile="/esoui/art/miscellaneous/horizontaldivider.dds" tier="HIGH">
					<Dimensions x="800" y="4"/>
					<Anchor point="TOP" relativeTo="$(parent)" offsetY="38" />
				</Texture>
 
				<Button name="$(parent)ButtonCloseAddon" inherits="ZO_ButtonBehaviorClickSound">
					<Dimensions x="40" y="40" />
					<Anchor point="TOPRIGHT" relativeTo="$(parent)" relativePoint="TOPRIGHT" offsetX="15" />
					<Textures normal="EsoUI/Art/Buttons/closebutton_up.dds"
						pressed="EsoUI/Art/Buttons/closebutton_down.dds"
						mouseOver="EsoUI/Art/Buttons/closebutton_mouseover.dds"
						disabled="EsoUI/Art/Buttons/closebutton_disabled.dds"/>
					<OnClicked>
						AIRG_ToggleMainWindow()
					</OnClicked>
				</Button>
 
			</Controls>
		</TopLevelControl>
	</Controls>
</GuiXml>

UI Elements

Attributes


AlphaAnimation


Anchor


AnchorFill

AnchorToBaseline


AnimationBase


AnimationTimeline


Animations


Backdrop


BackgroundBottom


BackgroundMiddle


BackgroundTop


Browser


Button


ButtonState


Callback


Callbacks


Center


ClampedToScreenInsets


ClearAnchors

ColorAnimation


ColorSelect


Compass


CompassPinType


Control


Controls


Cooldown


CustomAnimation


DebugText


DimensionConstraints


Dimensions


EasingFunction


Edge


EditBox


FadeGradient


Font


FontColors


GuiXml


HitInsets


Insets


Label


LeadingEdge


LeadingEdgeTextureCoords


Limits


Line


LineFade


LocalDimensions3D


MapDisplay


MapGutter


MapPinType


MouseButton


NormalOffset


OnAddGameData


OnBackspace


OnChar


OnCleared


OnClicked


OnColorSelected


OnDownArrow


OnDragStart


OnDurationChanged


OnEffectivelyHidden


OnEffectivelyShown


OnEnabledStateChanged


OnEnter


OnEscape


OnFocusGained


OnFocusLost


OnHide


OnIMEBeginComposition


OnIMEEndComposition


OnInitialized


OnInsertAnimationTimelineCallback


OnKeyDown


OnKeyUp


OnLinkClicked


OnLinkMouseUp


OnLoadFinished


OnLoadStart


OnMinMaxValueChanged


OnMouseDoubleClick


OnMouseDown


OnMouseEnter


OnMouseExit


OnMouseUp


OnMouseWheel


OnMoveStart


OnMoveStop


OnPageDown


OnPageUp


OnPlay


OnPlay_Animation


OnReceiveDrag


OnRectChanged


OnRectHeightChanged


OnRectWidthChanged


OnRequestClose


OnResizeStart


OnResizeStop


OnResizedToFit


OnScrollExtentsChanged


OnScrollOffsetChanged


OnSetAnimationEaseFunction

OnSetAnimationEventHandler

OnSetAnimationTimelineEventHandler

OnSetControlEventHandler

OnSetUpdateFunction

OnShow


OnSliderReleased


OnSpace


OnStop


OnStop_Animation


OnTab


OnTextChanged


OnTextureLoaded


OnUpArrow


OnUpdate


OnUserAreaCreated


OnValueChanged


OnVisibleRadiusChanged


PressedOffset


RadialCooldownGradient


ResizeToFitPadding


Rotate3DAnimation


ScaleAnimation


Scroll


ScrollingOverlay


SizeAnimation


Slider


StatusBar


String


Surface


TextBuffer


Texture


TextureAnimation


TextureComposite


TextureCoords


TextureRotateAnimation


TextureSampleProcessingWeight


Textures


ThumbTexture


Tooltip


TopLevelControl


Translate3DAnimation


TranslateAnimation


UpdateFunction


sentinel_element

Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox