XML schema

Main Menu

In World of Warcraft addons, XML files are used to define User Interface elements. XML is however not required since most functionality is also supported in Lua via the Widget API. Similar to Lua files, XML files are referenced from the TOC file.

It's advisable to use an editor like VS Code with the Red Hat XML extension.

VS Code with XML extension

Terminology[]

A tag begins with < and ends with >; for example <Frame>.
A tag can have attributes; for example <Frame name="ShinyRedApple".
An element consists of a start tag, end tag and anything in between; for example <Frame>content</Frame>.

XML schema[]

Each XML file consists of a Ui element. The xmlns and xsi attributes are optional but essential for XML parsers and validation.

<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/
https://raw.githubusercontent.com/Gethe/wow-ui-source/live/Interface/FrameXML/UI_shared.xsd">
</Ui>

<!-- can also be formatted like this for readability purposes -->
<Ui xmlns="http://www.blizzard.com/wow/ui/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.blizzard.com/wow/ui/
                        https://raw.githubusercontent.com/Gethe/wow-ui-source/live/Interface/FrameXML/UI_shared.xsd">
</Ui>

xmlns declares the default namespace. This means that all of the nested elements will use http://www.blizzard.com/wow/ui/ as namespace; organizing and associating them with World of Warcraft.
xmlns:xsi declares the http://www.w3.org/2001/XMLSchema-instance namespace and binds it to the xsi prefix. This also allows using the xsi:schemaLocation attribute.
xsi:schemaLocation declares whitespace-separated pairs of namespace and XSD files. This means that https://raw.githubusercontent.com/Gethe/wow-ui-source/live/Interface/FrameXML/UI_shared.xsd will be used with the http://www.blizzard.com/wow/ui/ namespace for validation and hinting.

Example[]

See also: XML user interface

Shows a texture on the center of the screen.

<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/
https://raw.githubusercontent.com/Gethe/wow-ui-source/live/Interface/FrameXML/UI_shared.xsd">
    <Frame parent="UIParent">
        <Size x="64" y="64"/>
        <Anchors>
            <Anchor point="CENTER"/>
        </Anchors>
        <Layers>
            <Layer level="ARTWORK">
                <Texture file="interface/icons/inv_mushroom_11" setAllPoints="true"/>
            </Layer>
        </Layers>
    </Frame>
</Ui>

Widget hierarchy[]

Core tags

<Frame> subtypes

<Animation> subtypes

<UI>

<LayoutFrame>

<Frame>

<Texture>
- <MaskTexture>
- <Line>

<FontString>
<Font>
<FontFamily>

<Animation>
<AnimationGroup>

<Alpha>
<Scale>
<LineScale>
<Translation>
<LineTranslation>
<Path>
<Rotation>
<TextureCoordTranslation>

UI[]

[Edit Ui]

<Ui> encloses all other tags.

<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/.. \FrameXML\UI.xsd">
	<Include />
	<Script />
	<!-- and all widgets -->
</Ui>

<Include> loads a file.

file (xs:string) - Relative path to a *.lua or *.xml file.

<Script> executes Lua code.

file (xs:string?) - Relative path to a *.lua file, in lieu of coding Lua inside the XML file.

LayoutFrame[]

[Edit LayoutFrame]

<LayoutFrame> abstracts tags and attributes common to most widgets.

<LayoutFrame>
	<Size />
	<Anchors />
	<KeyValues />
	<Animations />
</LayoutFrame>

name (xs:string?) - Adds a reference to _G, substituting $parent with a parent's name.

parentKey (xs:string?) - Adds a reference to the widget's parent.

parentArray ((xs:string?) - Inserts a reference to an array in the widget's parent.

inherits (xs:string?) - Inherits a comma-separated list of XML virtual templates.

virtual (xs:boolean?) - Creates an XML virtual template instead of a widget (requires name).

mixin (xs:string?) - Inherits a comma-separated list of Lua mixins.

secureMixin (xs:string?) - Inherits a comma-separated list of Lua mixins, wrapping inherited functions to force secure execution.

setAllPoints (xs:boolean?) - Sets the top-left and bottom-right anchors to match the parent widget.

hidden (xs:boolean?) - Controls the frame's initial visibility.

<Anchors> defines a widget's anchors by enclosing <Anchor> tags.

<Anchor> defines a single point to align a <LayoutFrame>.

point (ui:FRAMEPOINT) - Point to align.

relativeTo (xs:string?) - Another widget to align against (in _G).

relativeKey (string?) - Another widget to align against (sibling).

relativePoint (ui:FRAMEPOINT?) - Point on the other widget to align against (defaults to the same as point)

x (xs:float?) - Horizontal offset.

y (xs:float?) - Vertical offset.

<Size> (inherits from <Dimension>) sets the width and height.

<KeyValues> defines additional properties by enclosing <KeyValue> tags.

<KeyValue> assigns a single key/value pair to the widget's runtime table.

key (xs:string) - Key in the widget's table.

value (xs:string) - Value to be assigned.

keyType (ui:KEYVALUETYPE) - nil, boolean, number, string (default) or global

type (ui:KEYVALUETYPE) - nil, boolean, number, string (default) or global

<Animations> encloses one or more <AnimationGroup> tags.

Frame[]

[Edit Frame]

<Frame> (inherits from <LayoutFrame>, creates a Frame widget) handles events and user interaction, and may contain other widgets.

<Frame>
	<ResizeBounds />
	<HitRectInsets />
	<Layers />
	<Frames />
	<Scripts />
</Frame>

alpha (xs:float?) - Sets the alpha.

scale (xs:float?) - Sets the scale.

parent (xs:string?) - Parents another frame to this one.

toplevel (xs:boolean?) - Renders in front.

flattenRenderLayers (xs:boolean?) - Flattens child regions.

useParentLevel (xs:boolean?) - Prevents incrementing the frame level above its parent.

movable (xs:boolean?) - Enables dragging.

resizable (xs:boolean?) - Enables resizing.

frameStrata (ui:FRAMESTRATA) - Sequences overlapping frames.

frameLevel (xs:int?) - Further sequences overlapping frames in the same frameStrata.

id (xs:int?) - Assigns an id.

enableMouse (xs:boolean?) - Enables all mouse input.

enableMouseClicks (xs:boolean?) - Enables mouse clicks only.

enableMouseMotion (xs:boolean?) - Enables mouse motion only.

enableKeyboard (xs:boolean?) - Enables keyboard input.

clampedToScreen (xs:boolean?) - Prevents dragging off screen.

protected (xs:boolean?) - Declares the frame protected for secure code execution.

depth (xs:float?) - Frame:SetDepth(depth)

dontSavePosition (xs:boolean?) - Prevents saving the position of a movable frame.

propagateKeyboardInput (xs:boolean?) - Propagates keyboard input to the parent frame.

ignoreParentAlpha (xs:boolean?) - Controls alpha directly or as a fraction of its parent's alpha.

ignoreParentScale (xs:boolean?) - Controls alpha directly or as a fraction of its parent's scale.

intrinsic (xs:boolean?) - Creates an intrinsic frame.

clipChildren (xs:boolean?) - Clips overflowing children.

propagateHyperlinksToParent (xs:boolean?) - Propagates hyperlink interaction to the parent frame.

hyperlinksEnabled (xs:boolean?) - Enables interactive hyperlinks.

<ResizeBounds> limits resizing with <minResize> and <maxResize> child tags that inherit from <Dimension>.

<HitRectInsets> (inherits from <Inset>) shrinks (+) or expands (-) mouse focus from the frame's edges.

<Layers> encloses <Layer> tags to sequence overlapping graphical regions parented by the same frame.

<Layer> encloses regions (<Texture>, <FontString>, etc.) in a single draw layer.

level (ui:DRAWLAYER) - Sequences graphical regions as "BACKGROUND", "BORDER", "ARTWORK", etc..

textureSubLevel (xs:int?) - Further sequences overlapping <Texture> widgets inside the same level.

<Frames> encloses other <Frame> tags with a parent/child relationship.

<Scripts> contains widget script handlers such as <OnLoad> or <OnUpdate>.

Each widget script may enclose Lua code between the tags.

function (xs:string?) - Name of a function instead of Lua code between the XML tags.

method (xs:string?) - Name of a widget method instead of Lua code between the XML tags.

inherit (xs:string?) - Hooks (prepend, append) other scripts inherited through an XML virtual template.

intrinsicOrder (xs:string?) - Hooks (precall, postcall) other scripts when copied as an intrinsic frame.

autoEnableInput (xs:boolean?)

Button[]

[Edit Button]

<Button> (inherits from <Frame>, creates a Button) responds to clicks.

<Button text="" registerForClicks="" motionScriptsWhileDisabled="">
	<NormalTexture />
	<PushedTexture />
	<DisabledTexture />
	<HighlightTexture />
	<NormalColor />
	<HighlightColor />
	<DisabledColor />
	<ButtonText />
	<PushedTextOffset />
	<NormalFont style="" />
	<HighlightFont style="" />
	<DisabledFont style="" />
</Button>

text (xs:string?) - Displays a label.

registerForClicks (xs:string?) - Controls which mouse buttons will trigger OnClick.

motionScriptsWhileDisabled (xs:boolean?) - Enables OnEnter and OnLeave while disabled.

<NormalTexture>, <PushedTexture>, <DisabledTexture>, and <HighlightTexture> appear by state; inherit <Texture>.

<NormalColor>, <HighlightColor> and <DisabledColor>, colors the label by state; inherit <Color>.

<ButtonText> controls the label; inherits <FontString>.

<PushedTextOffset> moves the label when pushed; inherits <Dimension>.

<NormalFont>, <HighlightFont>, and <DisabledFont> styles the label by state.

style (xs:string)

CheckButton[]

[Edit CheckButton]

<CheckButton> (inherits from <Button>, creates a CheckButton) adds a 'checked' state.

<CheckButton>
	<CheckedTexture />
	<DisabledCheckedTexture />
</CheckButton>

checked (boolean?) - True shows the texture; false hides it.

<CheckedTexture> appears when checked; inherits <Texture>.

<DisabledCheckedTexture> appears when checked and disabled; inherits <Texture>.

ItemButton[]

<ItemButton> is an intrinsic frame extending <Button>.

ColorSelect[]

[Edit ColorSelect]

<ColorSelect> (inherits from <Frame>, creates a ColorSelect widget) selects a color by hue and shade.

<ColorSelect>
	<ColorWheelTexture />
	<ColorWheelThumbTexture />
	<ColorValueTexture />
	<ColorValueThumbTexture />
</ColorSelect>

<ColorWheelTexture> produces a color wheel of hues; inherits <Texture>

<ColorValueTexture> produces a gradiant of shades; inherits <Texture>.

<ColorWheelThumbTexture> and <ColorValueThumbTexture> mark the current selection; inherit <Texture>.

Cooldown[]

[Edit Cooldown]

<Cooldown> (inherits from <Frame>, creates a Cooldown widget) overlays another frame with a rotating edge, swipe, and bling.

<Cooldown reverse="" hideCountdownNumbers="" drawEdge="" drawBling="" drawSwipe="" rotation="">
	<EdgeTexture />
	<SwipeTexture />
	<BlingTexture />
</Cooldown>

reverse (xs:boolean?) - Reverses the direction.

hideCountdownNumbers (xs:boolean?) - Hides the seconds remaining.

drawEdge (xs:boolean?) - Draws the edge.

drawSwipe (xs:boolean?) - Draws the swipe.

drawBling (xs:boolean?) - Draws the bling.

rotation (xs:float?) - Rotates the origin.

<EdgeTexture> rotates from the origin; inherits <Texture>.

<SwipeTexture> fills between the origin and edge; inherits <Texture>.

<BlingTexture> animates briefly when the cooldown finishes; inherits <Texture>.

EditBox[]

[Edit EditBox]

<EditBox> (inherits from <Frame>, creates an EditBox widget) recieves text input.

<EditBox font="" letters="" blinkSpeed="" numeric="" alphabeticOnly="" password="" multiLine="" historyLines="" autoFocus="" ignoreArrows="" countInvisibleLetters="" invisibleBytes="">
	<FontString />
	<HighlightColor />
	<TextInsets />
</EditBox>

font (xs:string) - See <Font>.

letters (xs:int?) - Maximum number of letters; or zero for no limit.

blinkSpeed (xs:float? - speed of cursor blinking, interval in seconds between "blinks".

numeric (boolean?) - if true, then only digits 0-9 can be entered in this EditBox

password (boolean?) - if true, then asterisks will be displayed instead of whatever text you enter.

multiLine (boolean?) - multi-line EditBox

historyLines (int?) - Number of lines to keep as a "history" for this editbox. You can cycle through editbox' history with arrows Up and Down (or Alt+Up, Alt+Down if attribute ignoreArrows set to true)

autoFocus (boolean?) - if true, then this EditBox will automatically receive keyboard focus when it is displayed.

ignoreArrows (boolean?) - if false, then pressing arrows on keyboard will move cursor around the EditBox. If set to true, then EditBox will ignore arrows and they will instead turn around your character in game world. In this case you can still move text cursor around your editbox with Alt-arrows.

countInvisibleLetters (boolean?)

invisibleBytes (int?)

<HighlightColor> inherits <Color>

<TextInsets> defines padding (+) or overflow (-) of the FontString relative to the EditBox; inherits <Inset>.

GameTooltip[]

[Edit GameTooltip]

<GameTooltip> (inherits from <Frame>, creates a GameTooltip widget) formats a tooltip.

<GameTooltip />

MessageFrame[]

[Edit Message Frame]

<MessageFrame> (inherits from <Frame>, creates a MessageFrame widget) prints messages.

<MessageFrameType>
	<FontString />
	<TextInsets />
</MessageFrameType>

font (xs:string)

fade (xs:boolean?) - True causes messages to fade slowly; false causes them to disappear instantly.

fadeDuration (xs:float?) - Default 3.0

fadePower (xs:float?) - Default 1.0

displayDuration (xs:float?) - Default 10.0

insertMode (ui:INSERTMODE) - "TOP", or "BOTTOM" (default)

<TextInsets> defines padding (+) or overflow (-) of the FontString relative to the MessageFrame; inherits <Inset>.

Model[]

[Edit Model]

<Model> (inherits from <Frame>, creates a Model widget) renders a 3D model.

file (xs:string) - Relative path to a resource starting from Interface/.

modelScale (xs:float)

fogNear (xs:float)

fogFar (xs:float)

glow (xs:float)

drawLayer (ui:DRAWLAYER) - See <Layer>.

<FogColor> inherits from <Color>.

PlayerModel[]

<PlayerModel> (inherits from <Model>, creates a PlayerModel widget) displays a pose of the player character.

DressUpModel[]

<DressUpModel> (inherits from <PlayerModel>, creates a DressUpModel widget) trials equipment appearances on the player character.

TabardModel[]

<TabardModel> (inherits from <PlayerModel>, creates a TabardModel widget) trials tabard appearances on the player character.

CinematicModel[]

<CinematicModel> (inherits from <Model>, creates a CinematicModel widget) displays a creature in a pose.

facing (boolean) - Whether or not the model is facing left.

UiCamera[]

<UiCamera> (inherits from <Model>, creates a UiCamera widget) -- needs summary.

ScrollFrame[]

[<ScrollFrame>]

<ScrollFrame> (inherits from <Frame>, creates a ScrollFrame widget) provides a scroll bar for the user to scroll a <ScrollChild> frame.

<ScrollFrame>
	<ScrollChild />
</ScrollFrame>

<ScrollChild> inherits from <Frame>.

ScrollingMessageFrame[]

<ScrollingMessageFrame> is an intrinsic frame, extending <Frame>

SimpleHTML[]

[Edit SimpleHTML]

<SimpleHTML> (inherits from <Frame>, creates a SimpleHTML widget) renders HTML content.

<SimpleHTML font="" file="" hyperlinkFormat="" resizeToFitContents="">
	<FontString />
	<FontStringHeader1 />
	<FontStringHeader2 />
	<FontStringHeader3 />
</SimpleHTML>

font (xs:string) - See <Font>.

file (xs:string?)

hyperlinkFormat (xs:string?) - Defaults to |H%s|h%s|h, similar to the hyperlink escape sequence.

resizeToFitContents (xs:boolean?)

<FontString>.

<FontStringHeader1> (inherits from <FontString>) defines the <H1> font.

<FontStringHeader2> and <FontStringHeader3> similarly apply to the <H2> and <H3> fonts.

Slider[]

[Edit Slider]

<Slider> (inherits from <Frame>, creates a Slider widget) selects a value within a range.

<Slider drawLayer="" minValue="" maxValue="" defaultValue="" valueStep="" orientation="" obeyStepOnDrag="">
	<ThumbTexture />
</Slider>

drawLayer (ui:DRAWLAYER) - See <Texture>.

minValue (xs:float) - Sets the left or bottom limit of the range of selectable values.

maxValue (xs:float) - Sets the right or top limit of the range of selectable values.

defaultValue (xs:float) - Normally in the range of minValue and maxValue

valueStep (xs:float) - Sets the increment by which values jump as the slider is dragged.

orientation (ui:ORIENTATION) - HORIZONTAL, VERTICAL (default).

obeyStepOnDrag (xs:boolean)

<ThumbTexture> inherits from <FontString>.

StatusBar[]

[Edit StatusBar]

<StatusBar> creates a bar that fills from minValue to maxValue.

<StatusBar drawLayer="" minValue="" maxValue="" defaultValue="" orientation="" rotatesTexture="" reverseFill="">
	<BarTexture />
	<BarColor />
</StatusBar>

drawLayer (ui:DRAWLAYER) - See <Texture>.

minValue (xs:float) - Value when the bar is empty (e.g. 0 for a health bar).

maxValue (xs:float) - Value when the bar is full (e.g. UnitHealthMax).

defaultValue (xs:float) - In the range of [minValue, maxValue].

orientation (ui:ORIENTATION) - "HORIZONTAL" (default), "VERTICAL"

rotatesTexture (boolean?)

reverseFill (boolean?)

<BarTexture> inherits from <Texture>.

<BarColor> inherits from <Color>.

ArchaeologyDigSiteFrame[]

[Edit ArchaeologyDigSiteFrame]

<ArchaeologyDigSiteFrame> (inherits from <Frame>, creates a ArchaeologyDigSiteFrame widget) marks an archaeology dig site.

<ArchaeologyDigSiteFrame filltexture="" bordertexture="" />

filltexture (xs:string)

bordertexture (xs:string)

ScenarioPOIFrame[]

[Edit ScenarioPOIFrame]

<ScenarioPOIFrame> (inherits from <Frame>, creates a ScenarioPOIFrame widget) marks a scenario point of interest.

<ScenarioPOIFrame filltexture="" bordertexture="" />

filltexture (xs:string)

bordertexture (xs:string)

QuestPOIFrame[]

[Edit QuestPOIFrame]

<QuestPOIFrame> (inherits from <Frame>, creates a QuestPOIFrame widget) marks a quest location.

<QuestPOIFrame filltexture="" bordertexture="" />

filltexture (xs:string)

bordertexture (xs:string)

Texture[]

[Edit Texture]

<Texture> (inherits from <LayoutFrame>, creates a Texture widget) draws an image, solid color, or gradient.

<Texture>
	<TexCoords />
	<Color />
	<Gradient />
</Texture>

file (xs:string?) - Loads a BLP, JPEG or TGA.

mask (xs:string?) - Applies a <MaskTexture>.

alphaMode (ui:ALPHAMODE?) - Blends overlapping textures.

alpha (xs:float?) - Sets opacity from 0 to 1.

scale (xs:float?) - Scales the widget's coordinate system.

snapToPixelGrid (xs:boolean?)

texelSnappingBias (xs:float?)

hWrapMode (ui:WRAPMODE)

vWrapMode (ui:WRAPMODE)

ignoreParentAlpha (xs:boolean?) - Controls alpha directly or as a fraction of its parent's alpha.

ignoreParentScale (xs:boolean?) - Controls alpha directly or as a fraction of its parent's scale.

nonBlocking (xs:boolean?)

horizTile (xs:boolean?)

vertTile (xs:boolean?)

atlas (xs:string?) - Loads a predefined file and coords.

useAtlasSize (xs:boolean?)

desaturated (xs:boolean?) - Removes color.

<TexCoords> samples part of an image file, using either four edges or a <Rect> child element.

left (xs:float?) -Left edge, normalized from left (0) to right (1).

right (xs:float?) - Right edge, normalized from left (0) to right (1).

top (xs:float?) - Top edge, normalized from top (0) to bottom (1).

bottom (xs:float?) - Bottom edge, normalized from top (0) to bottom (1).

<Rect> has eight attributes to define an affine transformation from arbitrary (non-right-angled) corners.

ULx (xs:float) - Upper-left, x coord, normalized from left (0) to right (1).

ULy (xs:float) - Upper-left, y coord, normalized from top (0) to bottom (1).

LLx (xs:float) - Lower-left, x coord, normalized from left (0) to right (1).

LLy (xs:float) - Lower-left, y coord, normalized from top (0) to bottom (1).

URx (xs:float) - Upper-right, x coord, normalized from left (0) to right (1).

URy (xs:float) - Upper-right, y coord, normalized from top (0) to bottom (1).

LRx (xs:float) - Lower-right, x coord, normalized from left (0) to right (1).

LRy (xs:float) - Lower-right, y coord, normalized from top (0) to bottom (1).

<Color> sets color using RGB values or a ColorMixin, and alpha.

r (xs:float?) - Red component from 0.0 (default) to 1.0.

g (xs:float?) - Green component from 0.0 (default) to 1.0.

b (xs:float?) - Blue component from 0.0 (default) to 1.0.

a (xs:float?) - Alpha (opacity) from 0.0 to 1.0 (default).

name (xs:string?) - Name of a ColorMixin made with CreateColor().

<Gradient> defines a gradient between two solid colors, <MinColor> and <MaxColor>.

orientation (ui:ORIENTATION) - "HORIZONTAL" (default) or "VERTICAL"

<MinColor> and <MaxColor> inherit from <Color>

MaskTexture[]

[Edit MaskTexture]

<MaskTexture> (inherits from <Texture>, creates a MaskTexture widget) applies a mask to other textures.

<MaskTexture>
	<MaskedTextures>
		<MaskedTexture />
	</MaskedTextures>
</MaskTexture>

<MaskedTextures> encloses one or more <MaskedTexture> tags.

<MaskedTexture> identifies a texture upon which to apply this mask.

childKey (xs:string) - The parentKey of another <Texture> in the same Frame.

target (xs:string?)

Line[]

[Edit Line]

<Line> (child of <Layer>, creates a Line widget) draws a line.

<Line thickness="">
	<StartAnchor />
	<EndAnchor />
</Line>

thickness (xs:float?) - Defaults to 4.0

<StartAnchor> and <EndAnchor> inherit from <Anchor>

FontString[]

[Edit FontString]

<FontString> (inherits from <LayoutFrame>, creates a FontString) draws text.

<FontString>
	<FontHeight />
	<Color />
	<Shadow />
</FontString>

font (xs:string?)

bytes (xs:int?) - Defaults to 255.

text (xs:string?)

spacing (xs:float?)

outline (ui:OUTLINETYPE) - "NORMAL", "THICK".

monochrome (xs:boolean?)

nonspacewrap (xs:boolean?)

wordwrap (xs:boolean?)

justifyV (ui:JUSTIFYVTYPE) - "TOP", "MIDDLE", "BOTTOM".

justifyH (ui:JUSTIFYHTYPE) - "LEFT", "RIGHT", "CENTER".

maxLines (xs:unsignedInt?)

indented (xs:boolean?)

alpha (xs:float?) - Sets the alpha.

ignoreParentAlpha (xs:boolean?) - Controls alpha directly or as a fraction of its parent's alpha.

ignoreParentScale (xs:boolean?) - Prevents resizing due to the parent frame's scale.

<FontHeight> sets the font height.

val (xs:float) - Sets the font height, scaling dependent.

<Color> sets color using RGB values or a ColorMixin, and alpha.

r (xs:float?) - Red component from 0.0 (default) to 1.0.

g (xs:float?) - Green component from 0.0 (default) to 1.0.

b (xs:float?) - Blue component from 0.0 (default) to 1.0.

a (xs:float?) - Alpha (opacity) from 0.0 to 1.0 (default).

name (xs:string?) - Name of a ColorMixin made with CreateColor().

<Shadow> places a shadow behind text with a <Color> child tag.

x (xs:float) - Left (+) or right (-), scaling dependent.

y (xs:float) - Up (+) or down (-), scaling dependent.

Font[]

[Edit Font]

<Font> (creates a Font object) defines a font for text-containing elements like <FontString> and <EditBox>.

<Font>
	<FontHeight />
	<Color />
	<Shadow />
</Font>

name (xs:string?) - Similar to <LayoutFrame>; normally required but may be omitted inside a <FontFamily>

inherits (xs:string?) - Similar to <LayoutFrame>.

virtual (xs:boolean?) - Similar to <LayoutFrame>.

font (xs:string?)

spacing (xs:float?)

outline (ui:OUTLINETYPE ?) - "NONE" (default), "NORMAL", "THICK"

monochrome (xs:boolean?)

justifyV (ui:JUSTIFYVTYPE ?) - "TOP", "BOTTOM", "MIDDLE" (default)

justifyH (ui:JUSTIFYVTYPE ?) - "LEFT", "RIGHT", "CENTER" (default)

height (xs:float?)

fixedSize (xs:boolean?)

filter (xs:boolean?)

<FontHeight> sets the font height.

val (xs:float) - Sets the font height, scaling dependent.

<Color> sets color using RGB values or a ColorMixin, and alpha.

r (xs:float?) - Red component from 0.0 (default) to 1.0.

g (xs:float?) - Green component from 0.0 (default) to 1.0.

b (xs:float?) - Blue component from 0.0 (default) to 1.0.

a (xs:float?) - Alpha (opacity) from 0.0 to 1.0 (default).

name (xs:string?) - Name of a ColorMixin made with CreateColor().

<Shadow> places a shadow behind text with a <Color> child tag.

x (xs:float) - Left (+) or right (-), scaling dependent.

y (xs:float) - Up (+) or down (-), scaling dependent.

FontFamily[]

[Edit FontFamily]

<FontFamily> (creates a Font object) has a <Member> for each alphabet (character set), each enclosing a <Font> tag.

<FontFamily name="" virtual="">
	<Member alphabet="">
		<Font />
	</Member>
</FontFamily>

name (xs:string) - Similar to <LayoutFrame>.

virtual (xs:string?) - Similar to <LayoutFrame>.

<Member> encloses a single <Font> tag; and one member is chosen when the game loads.

alphabet (xs:string) - "roman", "korean", "simplifiedchinese", "traditionalchinese", "russian"

AnimationGroup[]

[Edit AnimationGroup]

<AnimationGroup> (creates an AnimationGroup widget) encloses <Animation> tags.

<AnimationGroup>
	<Animation />
	<Scripts />
</AnimationGroup>

name (xs:string?) - Adds a reference to _G, substituting $parent with a parent's name.

inherits (xs:string?) - Inherits a comma-separated list of XML virtual templates.

virtual (xs:boolean?) - Creates an XML virtual template instead of a widget (requires name).

parentKey (xs:string?) - Adds a reference to the widget's parent.

parentArray ((xs:string?) - Inserts a reference to an array in the widget's parent.

looping (ui:ANIMLOOPTYPE) - Defaults to false.

setToFinalAlpha (xs:boolean)

<Scripts> contains widget script handlers such as <OnLoad> or <OnUpdate>.

Each widget script may enclose Lua code between the tags.

function (xs:string?) - Name of a function instead of Lua code between the XML tags.

method (xs:string?) - Name of a widget method instead of Lua code between the XML tags.

inherit (xs:string?) - Hooks (prepend, append) other scripts inherited through an XML virtual template.

intrinsicOrder (xs:string?) - Hooks (precall, postcall) other scripts when copied as an intrinsic frame.

autoEnableInput (xs:boolean?)

Animation[]

[Edit Animation]

<Animation> abstracts tags and attributes common to Animations that animate a <LayoutFrame>.

<Animation>
	<Scripts />
</Animation>

name (xs:string) - See <LayoutFrame>.

inherits (xs:string) - See <LayoutFrame>.

virtual (xs:boolean) - See <LayoutFrame>.

target (xs:string?)

targetKey (xs:string?)

parentKey (xs:string?)

childKey (xs:string?)

startDelay (xs:float?) - Delay in seconds until the animation begins.

endDelay (xs:float?) - Delay in seconds after the animation finishes.

duration (xs:float) - Duration of the animation in seconds.

order (ui:AnimOrderType) - Whole number between 1 (default) and 100

smoothing (ui:ANIMSMOOTHTYPE) - NONE (default), IN, OUT, IN_OUT or OUT_IN

<Scripts> contains widget script handlers such as <OnLoad> or <OnUpdate>.

Each widget script may enclose Lua code between the tags.

function (xs:string?) - Name of a function instead of Lua code between the XML tags.

method (xs:string?) - Name of a widget method instead of Lua code between the XML tags.

inherit (xs:string?) - Hooks (prepend, append) other scripts inherited through an XML virtual template.

intrinsicOrder (xs:string?) - Hooks (precall, postcall) other scripts when copied as an intrinsic frame.

autoEnableInput (xs:boolean?)

Alpha[]

[Edit Alpha]

<Alpha> (inherits from <Animation>, creates an Alpha animation) changes a Region's alpha.

<Alpha fromAlpha="" toAlpha="" />

fromAlpha (xs:float) - Starting alpha as the animation begins.

toAlpha (xs:float) - Finishing alpha as the animation ends.

Scale[]

[Edit Scale]

<Scale> (inherits from <Animation>, creates a Scale animation) resizes a Region.

<Scale scaleX="" scaleY="" fromScaleX="" fromScaleY="" toScaleX="" toScaleY="" />

scaleX (xs:float) - Defaults to 1.0.

scaleY (xs:float) - Defaults to 1.0.

fromScaleX (xs:float) - Defaults to 1.0.

fromScaleY (xs:float) - Defaults to 1.0.

toScaleX (xs:float) - Defaults to 1.0.

toScaleY (xs:float) - Defaults to 1.0.

LineScale[]

<LineScale> inherits from <Scale>; creates a LineScale animation.

Translation[]

[Edit Translation]

<Translation> (inherits from <Animation>, creates a Translation animation) moves a Region.

<Translation  offsetX="" offsetY="" />

offsetX (xs:float) - Defaults to 0.0.

offsetY (xs:float) - Defaults to 0.0.

LineTranslation[]

<LineTranslation> inherits from <Translation>; creates a LineTranslation animation.

Path[]

[Edit Path]

<Path> (inherits from <Animation>, creates a Path animation) moves a region through control points.

<Path curve="">
	<ControlPoints>
		<ControlPoint name="" offsetX="" offsetY="" />
	</ControlPoints>
</Path>

curve (ui:ANIMCURVETYPE) - NONE (default), SMOOTH.

<ControlPoints> encloses <ControlPoint> tags.

<ControlPoint> describes offset coordinates from the region's position.

name (xs:string)

offsetX (xs:float)

offsetY (xs:float)

Rotation[]

[Edit Rotation]

<Rotation> (inherits from <Animation>, creates a Rotation animation) rotates a Region around an origin.

<Rotation degrees="" radians="">
	<Origin point="">
		<Offset />
	</Origin>
</Rotation>

degrees (xs:float)

radians (xs:float)

<Origin> defines the point about which the region rotates.

point (ui:FRAMEPOINT) - See <LayoutFrame>; defaults to "CENTER".

<Offset> inherits from <Dimension>

TextureCoordTranslation[]

XML/TextureCoordTranslation

Wowpedia

XML schema

Terminology[]

XML schema[]

Example[]

Widget hierarchy[]

UI[]

LayoutFrame[]

Frame[]

Button[]

CheckButton[]

ItemButton[]

ColorSelect[]

Cooldown[]

EditBox[]

GameTooltip[]

MessageFrame[]

Model[]

PlayerModel[]

DressUpModel[]

TabardModel[]

CinematicModel[]

UiCamera[]

ScrollFrame[]

ScrollingMessageFrame[]

SimpleHTML[]

Slider[]

StatusBar[]

ArchaeologyDigSiteFrame[]

ScenarioPOIFrame[]

QuestPOIFrame[]

Texture[]

MaskTexture[]

Line[]

FontString[]

Font[]

FontFamily[]

AnimationGroup[]

Animation[]

Alpha[]

Scale[]

LineScale[]

Translation[]

LineTranslation[]

Path[]

Rotation[]

TextureCoordTranslation[]

See also[]

Fan Feed