Home › Engine executable › UI XML vocabulary

UI XML vocabulary (ForgeUI)

The XML files that define the game's user interface are read by the exe's UI toolkit, ForgeUI. Each control type has code that reads its attributes and child names; this page lists them straight from that code, so it shows every attribute a control type understands, including ones the game's own files never use. The shipped column counts how often the attribute appears on that element in the 346 UI XML files that come with the game.

Of the 338 names found in the exe, 172 are used in shipped files (the rest are supported but not used by the game, or are child element and style names). Verified: the name is a literal in the control's XML-reading code and the shipped counts. Inferred: the element name of each control type (checked against the tags in the shipped files) and the short explanations.

Most control types inherit the attributes of ControlBase (the Container element: Anchor, Size, Offset, Hidden, mouse handling, ...); each type section below lists the names its own code reads in addition and marks those that are also in the base list.

Control types

AlphaAnim

XML element: <AlphaAnim> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Cycle (382), Speed (380), ID (287), Size (273), Function (190), Stopped (110), Pause (89), FunctionPower (16).

AnimControl

XML element: <SlideAnim> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Start (197), ID (155), End (154), Size (145), EndOffset (118), Begin (70), Style (20).

ButtonControl

XML element: <Button> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (501), Size (372), Style (174).

ButtonControlBase

XML element: none, this is a base class of other controls (base class (no element of its own)).

CheckBoxControl

XML element: <CheckBox> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (123), Style (107), String (60), Size (20), WrapWidth (13), Align (12).

ColorBoxButtonControl

XML element: <ColorBox> (curated alias).

ContextBase

XML element: <Context> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): {http://www.w3.org/2001/XMLSchema-instance}noNamespaceSchemaLocation (102), Style (57), FontStyle (50), ColorSet (46), Name (39).

ControlBase

XML element: <Container> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Size (2406), ID (1558), Style (69).

DragControl

XML element: <Drag> (curated alias).

EditBoxControl

XML element: <EditBox> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (57), Size (56), Style (53), FontStyle (21), ColorSet (15), String (11), CallOnChar (10).

FlipAnim

XML element: <FlipAnim> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Size (50), ID (28), EndPause (21), Stopped (18).

GraphControl

XML element: <Graph> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (10), Size (10).

GridButtonControl

XML element: <GridButton> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Size (959), ID (948), Style (870), Texture (189), StateOffsetIncrement (110), TruncateWidth (29), ColorSet (25), NoStateChange (22), WrapWidth (15), SmallCaps (14), SmallCapsType (14), States (13), Void1 (10).

GridControl

XML element: <Grid> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Size (1943), ID (1019), Style (970).

ImageControl

XML element: <Image> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Size (3012), ID (1978), Icon (211), StateOffsetIncrement (15), Speed (15), Style (12).

LineControl

XML element: <Line> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): End (89), ID (24).

ListBoxControlBase

XML element: <ListBox> (curated alias).

MeterControl

XML element: <Meter> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (128), Size (128).

MovieControl

XML element: <Movie> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (11), Size (11).

PullDownControl

XML element: <PullDown> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (132), Size (127), Style (93).

RadioButtonControl

XML element: <RadioButton> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (36), Style (36), String (35), TextOffset (33), ButtonTexture (33), ButtonSize (33), CheckTexture (33), CheckSize (33), CheckTextureOffset (33), BoxOnLeft (33).

ScrollPanelControl

XML element: <ScrollPanel> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Size (348), ID (311), Style (87).

ScrollTextControl

XML element: <ScrollTextField> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Size (33), Style (33), ID (32), String (14).

SliderControl

XML element: <Slider> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Style (23), Size (23), ID (23).

StackControl

XML element: <Stack> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (1129), Size (230).

TabControl

XML element: <Tab> (curated alias).

TextButtonControl

XML element: <TextButton> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (22), Style (22), Size (14).

TextControl

XML element: <Label> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): Style (3537), ID (2696), Size (224), Text (12).

TutorialControl

XML element: <Tutorial> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (114), Style (114).

TweenControl

XML element: none, this is a base class of other controls (base class (no element of its own)).

WorldAnchorControl

XML element: <WorldAnchor> (curated alias).

Used 10 or more times on this element in shipped files but not found as a literal in this type's own code (so they are read by shared code, for example ID and Size, or by a parent type): ID (14).