XML elements
Main Menu |
---|
|
- For an overview of WoW's XML, see XML user interface and XML basics.
The Widget XML schema is one method to construct user interface widgets when initializing the game and each AddOn. This should be read in conjunction with the following pages:
- Widget API - Functions to program each widget while the game is running
- Widget Handlers - Handlers for responding to user interaction and game-state changes
- Category:Widgets - Articles about each widget type, describing alternate methods to construct them
- Category:XML elements - Alphabetical list of all articles about XML elements
FrameXML defines this schema in FrameXML/UI.xsd
which is archived at Townlong-Yak.
Application Control | Base Implementations | <Frame> Subclasses | <Animation> Subclasses |
---|---|---|---|
Contents
- 1 UI
- 2 Include
- 3 Script
- 4 LayoutFrame
- 5 Frame
- 6 Texture
- 7 FontString
- 8 Font
- 9 FontFamily
- 10 AnimationGroup
- 11 Animation
UI
See also: <UI>
The document root that all other tags must reside in
Include
See also: <Include file="">
Loads another XML file. Customarily near the top of an XML file so the dependence is clear.
Script
See also: <Script file="">
Loads a Lua (.lua) file. Customarily near the top of an XML file so the dependence is clear.
LayoutFrame
<LayoutFrame> is an abstract element with common attributes underpinning the entire schema. LayoutFrame is not a real widget, but elements inheriting from this will construct a kind of Region widget. Elements inheriting from <LayoutFrame> have the following parent/child schema:
<UI> <LayoutFrame> <Size /> <Anchors> <Anchor> <Offset /> </Anchor> </Anchors> <Animations> <AnimationGroup /> </Animations> </LayoutFrame> </UI>
Elements inheriting from <LayoutFrame> have the following attributes:
XML attribute | Type | Default | Lua equivalent | Description |
---|---|---|---|---|
name | xs:string | CreateFrame(__, name, __, __) | $parent becomes the name of the nearest parent in the DOM that has a non-empty name | |
parentKey | xs:string | parent[parentKey] = self |
Adds a reference into the parent's runtime Lua table | |
parentArray | xs:string | tinsert(parent[parentArray], self) | Adds a reference into an array within the parent's runtime Lua table | |
inherits | xs:string | CreateFrame(__, __, __, inheritsFrom) | Clones characteristics from an XML virtual template | |
mixin | xs:string | Mixin(mixin:strmatch(",")) |
Copies key/value pairs from one or more comma-separated global Lua tables | |
secureMixin | xs:string | No equivalent | Copies key/value pairs from one or more comma-separated global Lua tables, wrapping each secure function value in a closure that forces the execution path to a secure state until it returns | |
virtual | xs:boolean | No equivalent | If true, creates a XML virtual template for later cloning via inherits | |
setAllPoints | xs:boolean | Region:SetAllPoints() | Anchors the LayoutFrame to its parent's top-left and bottom-right corners | |
hidden | xs:boolean | Region:SetShown(hidden) | Controls the frame's initial visibility upon creation. |
Each <Anchor> within a <LayoutFrame> has the following attributes:
XML attribute | Type | Description |
---|---|---|
point | ui:FRAMEPOINT | See Region:SetPoint() |
relativeTo | xs:string | |
relativePoint | ui:FRAMEPOINT | |
x | xs:float | Alternative to <Offset /> |
y | xs:float |
Frame
<Frame> constructs a Frame widget, the highest-level concrete type for interactable objects and containers. A frame also contains <Layers> and <Scripts> to customize appearance and user interaction.
<Frame> resides in either the document root, UI, or the <Frames></Frames>
element of another frame.
<UI> <Frame> <TitleRegion /> <ResizeBounds> <minResize /> <maxResize /> </ResizeBounds> <Backdrop> <!-- Classic only from 9.0.1 --> <BackgroundInsets /> <TileSize /> <EdgeSize /> <Color /> <BorderColor /> </Backdrop> <BackgroundInsets /> <HitRectInsets /> <Layers> <Layer> <Texture /> <MaskTexture /> <FontString /> <Line /> </Layer> </Layers> <Frames> <Frame /> </Frames> <Scripts /> <!-- Also see <LayoutFrame> --> </Frame> </UI>
<Frame> has all the attributes of <LayoutFrame> plus the following:
XML attribute | Type | Default | Lua equivalent |
---|---|---|---|
alpha | xs:float | Region:SetAlpha(alpha) | |
parent | xs:string | CreateFrame(__, __, parent, __) | |
toplevel | xs:boolean | Frame:SetTopLevel(toplevel) | |
flattenRenderLayers | xs:boolean | Frame:SetFlattensRenderLayers(flattenRenderLayers) | |
useParentLevel | xs:boolean | frame:SetFrameLevel(frame:GetParent():GetFrameLevel())
| |
movable | xs:boolean | Frame:SetMovable(movable) | |
resizable | xs:boolean | Frame:SetResizable(resizable) | |
frameStrata | ui:FRAMESTRATA | Frame:SetFrameStrata("frameStrata") | |
frameLevel | xs:int | Frame:SetFrameLevel(frameLevel) | |
id | xs:int | Frame:SetID(id) | |
enableMouse | xs:boolean | ||
enableMouseClicks | xs:boolean | Frame:SetMouseClickEnabled(enableMouseClicks) | |
enableMouseMotion | xs:boolean | Frame:SetMouseMotionEnabled(enableMouseMotion) | |
enableKeyboard | xs:boolean | Frame:SetKeyboardEnabled(enableKeyboard) | |
clampedToScreen | xs:boolean | Frame:SetClampedToScreen(clampedToScreen) | |
protected | xs:boolean | ||
depth | xs:float | Frame:SetDepth(depth) | |
dontSavePosition | xs:boolean | Frame:SetDontSavePosition() | |
propagateKeyboardInput | xs:boolean | Frame:SetPropagateKeyboardInput(propagateKeyboardInput) | |
ignoreParentAlpha | xs:boolean | Region:SetIgnoreParentAlpha(ignoreParentAlpha) | |
ignoreParentScale | xs:boolean | Region:SetIgnoreParentAlpha(ignoreParentScale) | |
intrinsic | xs:boolean | ||
clipChildren | xs:boolean | Frame:SetClipsChildren(clipChildren) | |
propagateHyperlinksToParent | xs:boolean | ||
hyperlinksEnabled | xs:boolean | Frame:SetHyperlinksEnabled(hyperlinksEnabled) |
Button
<Button> constructs a Button widget that responds to clicks, displays a label, and displays textures whether it is pushed, depressed (normal) or hovered (highlight).
<Button> resides in the same places as a <Frame> and can use all of its structure, plus the following:
<UI> <Button> <NormalTexture /> <PushedTexture /> <DisabledTexture /> <HighlightTexture /> <ButtonText /> <NormalFont /> <HighlightFont /> <DisabledFont /> <NormalColor /> <HighlightColor /> <DisabledColor /> <PushedTextOffset /> <Scripts> <OnClick /> <OnDoubleClick /> <PostClick /> <PreClick /> </Scripts> </Button> <Frame> <Frames> <Button /> </Frames> </Frame> </UI>
<Button> has all the attributes of <Frame> plus the following:
XML attribute | Type | Default | Lua equivalent |
---|---|---|---|
text | xs:string | Button:SetText(text) | |
registerForClicks | xs:string | Button:RegisterForClicks(registerForClicks) | |
motionScriptsWhileDisabled | xs:boolean | Button:SetMotionScriptsWhileDisabled(motionScriptsWhileDisabled) |
CheckButton
Clicking adds or remove check mark. Commonly used for option panels.
CheckButton has all the attributes of <Button> plus the following:
- checked
Source: DefaultUI - FrameXML\TutorialFrame.xml
Element name: TutorialFrameCheckButton
CheckButton has all the tags of <Button> plus the following:
- checkedtexture
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: ActionButtonTemplate - disabledcheckedtexture
Source: DefaultUI - FrameXML\FriendsFrame.xml
Element name: GuildControlPopupFrameCheckboxTemplate
ColorSelect
Allows the user to choose a color. Commonly used for customizing the appearance of a UI element.
ColorSelect has all the attributes of <Frame>.
Known Tags:
- size
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - anchors
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - backdrop
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - layers
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - frames
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - scripts
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - colorwheeltexture
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - colorwheelthumbtexture
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - colorvaluetexture
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame - colorvaluethumbtexture
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: ColorPickerFrame
Cooldown
Used for spell and action buttons to show its cooldown state.
Cooldown has all the attributes of <Frame> plus the following:
- reverse
Source: DefaultUI - FrameXML\TargetFrame.xml
Element name: $parentCooldown
Known Tags:
- size
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: $parentCooldown - anchors
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: $parentCooldown
EditBox
Used to type in any kind of text.
EditBox has all the attributes of <Frame> plus the following:
- letters
Source: DefaultUI - FrameXML\ArenaRegistrarFrame.xml
Element name: ArenaRegistrarFrameEditBox - historylines
Source: DefaultUI - FrameXML\ArenaRegistrarFrame.xml
Element name: ArenaRegistrarFrameEditBox - ignorearrows
Source: DefaultUI - FrameXML\ChatFrame.xml
Element name: ChatFrameEditBoxTemplate - autofocus
Source: DefaultUI - FrameXML\FriendsFrame.xml
Element name: WhoFrameEditBox - multiline
Source: DefaultUI - FrameXML\FriendsFrame.xml
Element name: GuildInfoEditBox - numeric
Source: DefaultUI - FrameXML\MoneyInputFrame.xml
Element name: $parentGold
Known Tags:
- size
Source: DefaultUI - FrameXML\ArenaRegistrarFrame.xml
Element name: ArenaRegistrarFrameEditBox - anchors
Source: DefaultUI - FrameXML\ArenaRegistrarFrame.xml
Element name: ArenaRegistrarFrameEditBox - layers
Source: DefaultUI - FrameXML\ArenaRegistrarFrame.xml
Element name: ArenaRegistrarFrameEditBox - scripts
Source: DefaultUI - FrameXML\ArenaRegistrarFrame.xml
Element name: ArenaRegistrarFrameEditBox - fontstring
Source: DefaultUI - FrameXML\ArenaRegistrarFrame.xml
Element name: ArenaRegistrarFrameEditBox - frames
Source: DefaultUI - FrameXML\ChatFrame.xml
Element name: ChatFrameEditBoxTemplate
GameTooltip
Displays a frame at the position of the cursor, whose contents typically depend on what is being moused over.
GameTooltip has all the attributes of <Frame>.
Known Tags:
- scripts
Source: DefaultUI - FrameXML\GameTooltip.xml
Element name: GameTooltip - backdrop
Source: DefaultUI - FrameXML\GameTooltipTemplate.xml
Element name: GameTooltipTemplate - layers
Source: DefaultUI - FrameXML\GameTooltipTemplate.xml
Element name: GameTooltipTemplate - frames
Source: DefaultUI - FrameXML\GameTooltipTemplate.xml
Element name: GameTooltipTemplate - size
Source: DefaultUI - FrameXML\ItemRef.xml
Element name: ItemRefTooltip - anchors
Source: DefaultUI - FrameXML\ItemRef.xml
Element name: ItemRefTooltip
MessageFrame
A window like a frame, but for storing messages.
MessageFrame has all the attributes of <Frame> plus the following:
- insertmode
Source: DefaultUI - FrameXML\RaidWarning.xml
Element name: RaidWarningFrame - displayduration
Source: DefaultUI - FrameXML\UIErrorsFrame.xml
Element name: UIErrorsFrame
Known Tags:
- size
Source: DefaultUI - FrameXML\RaidWarning.xml
Element name: RaidWarningFrame - anchors
Source: DefaultUI - FrameXML\RaidWarning.xml
Element name: RaidWarningFrame - scripts
Source: DefaultUI - FrameXML\RaidWarning.xml
Element name: RaidWarningFrame - fontstring
Source: DefaultUI - FrameXML\RaidWarning.xml
Element name: RaidWarningFrame
Minimap
This is specific element for a radar showing you detailed map with units/resources on it
Minimap has all the attributes of <Frame> plus the following:
- minimapplayermodel
Source: DefaultUI - FrameXML\Minimap.xml
Element name: Minimap - minimaparrowmodel
Source: DefaultUI - FrameXML\Minimap.xml
Element name: Minimap
Known Tags:
- size
Source: DefaultUI - FrameXML\Minimap.xml
Element name: Minimap - anchors
Source: DefaultUI - FrameXML\Minimap.xml
Element name: Minimap - frames
Source: DefaultUI - FrameXML\Minimap.xml
Element name: Minimap - scripts
Source: DefaultUI - FrameXML\Minimap.xml
Element name: Minimap
Model
Displays a 3D model.
Model has all the attributes of <Frame> plus the following:
- file
Source: DefaultUI - FrameXML\MainMenuBarBagButtons.xml
Element name: ItemAnimTemplate
Known Tags:
- scripts
Source: DefaultUI - FrameXML\MainMenuBarBagButtons.xml
Element name: ItemAnimTemplate - anchors
Source: DefaultUI - FrameXML\MainMenuBarBagButtons.xml
Element name: $parentItemAnim - size
Source: DefaultUI - FrameXML\Minimap.xml
Element name: MiniMapPing
DressUpModel
Needs more testing. Used for checking how some linked item will look on character.
DressUpModel has all the attributes of <Model>.
Known Tags:
- size
Source: DefaultUI - FrameXML\DressUpFrame.xml
Element name: DressUpModel - anchors
Source: DefaultUI - FrameXML\DressUpFrame.xml
Element name: DressUpModel - scripts
Source: DefaultUI - FrameXML\DressUpFrame.xml
Element name: DressUpModel - frames
Source: DefaultUI - FrameXML\DressUpFrame.xml
Element name: DressUpModel
PlayerModel
Displays a 3D model of a player character. The model can preview items.
PlayerModel has all the attributes of <Model>.
Known Tags:
- size
Source: DefaultUI - FrameXML\PaperDollFrame.xml
Element name: CharacterModelFrame - anchors
Source: DefaultUI - FrameXML\PaperDollFrame.xml
Element name: CharacterModelFrame - scripts
Source: DefaultUI - FrameXML\PaperDollFrame.xml
Element name: CharacterModelFrame - frames
Source: DefaultUI - FrameXML\PaperDollFrame.xml
Element name: CharacterModelFrame
TabardModel
Displays tabard.
TabardModel has all the attributes of <Model>.
Known Tags:
- size
Source: DefaultUI - FrameXML\TabardFrame.xml
Element name: TabardModel - anchors
Source: DefaultUI - FrameXML\TabardFrame.xml
Element name: TabardModel - frames
Source: DefaultUI - FrameXML\TabardFrame.xml
Element name: TabardModel - scripts
Source: DefaultUI - FrameXML\TabardFrame.xml
Element name: TabardModel
ScrollFrame
Window that allows to scroll in up/down to show more info.
ScrollFrame has all the attributes of <Frame>.
Known Tags:
- size
Source: DefaultUI - FrameXML\BattlefieldFrame.xml
Element name: BattlefieldListScrollFrame - anchors
Source: DefaultUI - FrameXML\BattlefieldFrame.xml
Element name: BattlefieldListScrollFrame - layers
Source: DefaultUI - FrameXML\BattlefieldFrame.xml
Element name: BattlefieldListScrollFrame - scripts
Source: DefaultUI - FrameXML\BattlefieldFrame.xml
Element name: BattlefieldListScrollFrame - scrollchild
Source: DefaultUI - FrameXML\FriendsFrame.xml
Element name: GuildInfoFrameScrollFrame - frames
Source: DefaultUI - FrameXML\UIPanelTemplates.xml
Element name: UIPanelScrollFrameTemplate
ScrollingMessageFrame
Same as ScrollFrame but for messages only.
ScrollingMessageFrame has all the attributes of <ScrollFrame> plus the following:
- displayduration
Source: DefaultUI - FrameXML\ChatFrame.xml
Element name: ChatFrameTemplate - maxlines
Source: DefaultUI - FrameXML\ChatFrame.xml
Element name: ChatFrameTemplate
Known Tags:
- scripts
Source: DefaultUI - FrameXML\ChatFrame.xml
Element name: ChatFrameTemplate - fontstring
Source: DefaultUI - FrameXML\ChatFrame.xml
Element name: ChatFrameTemplate - size
Source: DefaultUI - FrameXML\FloatingChatFrame.xml
Element name: FloatingChatFrameTemplate - anchors
Source: DefaultUI - FrameXML\FloatingChatFrame.xml
Element name: FloatingChatFrameTemplate - titleregion
Source: DefaultUI - FrameXML\FloatingChatFrame.xml
Element name: FloatingChatFrameTemplate - resizebounds
Source: DefaultUI - FrameXML\FloatingChatFrame.xml
Element name: FloatingChatFrameTemplate - layers
Source: DefaultUI - FrameXML\FloatingChatFrame.xml
Element name: FloatingChatFrameTemplate - frames
Source: DefaultUI - FrameXML\FloatingChatFrame.xml
Element name: FloatingChatFrameTemplate
SimpleHTML
Shows up a window with content organized as in html file. Still only some common tags of html are supported, so it's impossible to load html pages inside it.
SimpleHTML has all the attributes of <Frame>.
Known Tags:
- size
Source: DefaultUI - FrameXML\ItemTextFrame.xml
Element name: ItemTextPageText - anchors
Source: DefaultUI - FrameXML\ItemTextFrame.xml
Element name: ItemTextPageText - fontstring
Source: DefaultUI - FrameXML\ItemTextFrame.xml
Element name: ItemTextPageText
Slider
A scroll bar for scrolling elements.
Slider has all the attributes of <Frame> plus the following:
- orientation
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - minvalue
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - maxvalue
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - valuestep
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - defaultvalue
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame
Known Tags:
- size
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - anchors
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - backdrop
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - layers
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - scripts
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - thumbtexture
Source: DefaultUI - FrameXML\ColorPickerFrame.xml
Element name: OpacitySliderFrame - hitrectinsets
Source: DefaultUI - FrameXML\OptionsFrameTemplates.xml
Element name: OptionsSliderTemplate - frames
Source: DefaultUI - FrameXML\UIPanelTemplates.xml
Element name: UIPanelScrollBarTemplate
StatusBar
Needs more testing. Used in casing bar.
StatusBar has all the attributes of <Frame> plus the following:
- drawlayer
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name: CastingBarFrameTemplate - inherits
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name: CastingBarFrame - minvalue
Source: DefaultUI - FrameXML\HonorFrame.xml
Element name: HonorFrameProgressBar - maxvalue
Source: DefaultUI - FrameXML\HonorFrame.xml
Element name: HonorFrameProgressBar - defaultvalue
Source: DefaultUI - FrameXML\HonorFrame.xml
Element name: HonorFrameProgressBar
Known Tags:
- layers
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name: CastingBarFrameTemplate - scripts
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name: CastingBarFrameTemplate - bartexture
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name: CastingBarFrameTemplate - barcolor
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name: CastingBarFrameTemplate - size
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name: CastingBarFrame - anchors
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name: CastingBarFrame - frames
Source: DefaultUI - FrameXML\HonorFrame.xml
Element name: HonorFrameProgressBar - hitrectinsets
Source: DefaultUI - FrameXML\ReputationFrame.xml
Element name: ReputationBarTemplate
TaxiRouteFrame
Shows a frame with the current continent's flight routes.
TaxiRouteFrame has all the attributes of <Frame>.
Known Tags:
- size
Source: DefaultUI - FrameXML\TaxiFrame.xml
Element name: TaxiRouteMap - anchors
Source: DefaultUI - FrameXML\TaxiFrame.xml
Element name: TaxiRouteMap
WorldFrame
Defined in default interface and contains all graphics information. Any addon placed inside this one will be always visible.
WorldFrame has all the attributes of <Frame>.
Known Tags:
- layers
Source: DefaultUI - FrameXML\WorldFrame.xml
Element name: WorldFrame - frames
Source: DefaultUI - FrameXML\WorldFrame.xml
Element name: WorldFrame - scripts
Source: DefaultUI - FrameXML\WorldFrame.xml
Element name: WorldFrame
Texture
Stores path for graphic file used for drawing elements.
Texture has all the attributes of <LayoutFrame> plus the following:
- file
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: $parentFlash - alphamode
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: $parentBorder
Known Tags:
- size
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: $parentBorder - anchors
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: $parentBorder - texcoords
Source: DefaultUI - FrameXML\ArenaRegistrarFrame.xml
Element name: $parentMiddle - color
Source: DefaultUI - FrameXML\CastingBarFrame.xml
Element name:
FontString
This one show a text you cannot edit.
FontString has all the attributes of <Font> and <LayoutFrame> plus the following:
- text
Source: DefaultUI - FrameXML\ArenaFrame.xml
Element name: $parentFrameLabel - nonspacewrap
Source: DefaultUI - FrameXML\BasicControls.xml
Element name: ScriptErrors_Message - bytes
Source: DefaultUI - FrameXML\ChatFrame.xml
Element name: - maxlines
Source: DefaultUI - FrameXML\SpellBookFrame.xml
Element name: $parentSpellName
Known Tags:
- size
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: $parentHotKey - anchors
Source: DefaultUI - FrameXML\ActionButtonTemplate.xml
Element name: $parentHotKey - color
Source: DefaultUI - FrameXML\CharacterFrame.xml
Element name: CharacterNameText - fontheight
Source: DefaultUI - FrameXML\ZoneText.xml
Element name: AutoFollowStatusText
Font
<Font> constructs a Font object to define how one or more FontInstances should appear.
<Font> resides in either the document root, or within a <FontFamily> to provide compatibility for different character sets.
<UI> <Font> <FontHeight /> <Color /> <Shadow /> <TitleRegion /> </Font> <FontFamily> <Member> <Font /> </Member> </FontFamily> </UI>
<Font> has the following attributes:
XML attribute | Type | Default | Lua equivalent | Description |
---|---|---|---|---|
name | xs:string | CreateFont(name) | ||
inherits | xs:string | No equivalent | Clones characteristics from the named XML virtual template | |
virtual | xs:boolean | No equivalent | Creates a XML virtual template instead of an actual Font object | |
font | xs:string | FontInstance:SetFont(font, ...) | ||
spacing | xs:float | FontInstance:SetSpacing(spacing) | ||
outline | ui:OUTLINETYPE | FontInstance:SetFont(__, __, "OUTLINE") | NONE, NORMAL or THICK | |
monochrome | xs:boolean | FontInstance:SetFont(__, __, "MONOCHROME") | ||
justifyV | ui:JUSTIFYVTYPE | FontInstance:SetJustifyV(justifyV) | TOP, BOTTOM or MIDDLE | |
justifyH | ui:JUSTIFYHTYPE | FontInstance:SetJustifyH(justifyH) | LEFT, RIGHT or CENTER | |
height | xs:float | |||
fixedSize | xs:boolean | |||
filter | xs:boolean |
FontFamily
<FontFamily> constructs a localized Font object for each kind of character set.
<FontFamily> has the following attributes:
XML attribute | Type | Default | Lua equivalent | Description |
---|---|---|---|---|
name | xs:string | No equivalent | Required | |
virtual | xs:boolean | No equivalent | Creates a XML virtual template instead of an actual Font object |
Each <Member> within the <FontFamily> must have the following attribute:
XML attribute | Type | Description |
---|---|---|
alphabet | ui:FONTALPHABET | "roman", "korean", "simplifiedchinese", "traditionalchinese" or "russian" |
AnimationGroup
See also: <AnimationGroup>
AnimationGroup has all the attributes of <LayoutFrame>.
Animation
See also: <Animation>
Animation has all the attributes of <LayoutFrame>.