Wikia

WoWWiki

XML types

Talk0
102,217pages on
this wiki
Revision as of 06:59, September 19, 2013 by Celess22 (Talk | contribs)

XML UI

Reference for the WoW UI XML types which are true seperate types and used in a variety of places. A type defined here is not a type that defines a major XML element like a widget, which can be found instead here in XML elements.

Reference

Below are the 'XML types', wow 'attribute types', 'element types', and 'enumerations'. The 'XML types', wow 'attribute types', and 'enumerations' can be used on attributes. The 'element types' are typically CapitolCase, where 'enumerations' are typically ALLUPPERCASE.

XML simple types

  • nil - null or Lua nil, an empty value or type
  • bool - boolean, a binary value constrained to on and off, like 'true' or 'false'
  • int - integer or Lua number, a signed number constrained to whole values, like -1,0,1,2...1000...
  • float - floating point or Lua number, a signed number able to contain fractional values, like -1.2,-1,0.123,2000.1...
  • string - a special charecter based array containing text, like "bob"

Size and Offset

Dimension

  • AbsDimension - unit based coordinates
  • RelDimension - scalar coordinates
  • x (int) - a unit value thats horizontally opposed
  • y (int) - a unit value thats vertically opposed

AbsDimension

  • x (int) - a unit value thats horizontally opposed
  • y (int) - a unit value thats vertically opposed

RelDimension

  • x (float) - a scalar value thats horizontally opposed
  • y (float) - a scalar value thats vertically opposed

Value

AbsValue

  • val (int) - a unit value

RelValue

  • val (float) - a scalar value

Inset

AbsInset

  • left (int)
  • right (int)
  • top (int)
  • bottom (int)

RelInset

  • left (float)
  • right (float)
  • top (float)
  • bottom (float)

Layout

LayoutFrame

  • name (string) - defines the name of the element
  • parentKey (string) - name for a key in the parent element, which will reference this element at runtime.
  • parentArray (string) - name for an array in the parent, to reference this element at runtime.
  • inherits (string) - uses a virtual element as a template
  • virtual (bool) - marks the as a template, to be inherited from using inherits
  • setAllPoints (bool) - anchors the TOPLEFT, TOPRIGHT, BOTTOMLEFT and BOTTOMRIGHT points to the parent
  • hidden (bool) - makes the element hidden by default
  • Size (Dimension)
  • Anchors
  • Animations

Anchor

  • point (FRAMEPOINT)
  • relativeTo (string)
  • relativeKey (string) - uses a Lua name of reference to make relative to. alternate to 'relativeTo'.
  • relativePoint (FRAMEPOINT)
  • x (int)
  • y (int)
  • Offset (Dimension)

FRAMEPOINT

  • TOPLEFT
  • TOPRIGHT
  • BOTTOMLEFT
  • BOTTOMRIGHT
  • TOP
  • BOTTOM
  • LEFT
  • RIGHT
  • CENTER

Appearance

Color

Defines a color.

  • r (float) - red
  • g (float) - green
  • b (float) - blue
  • a (float) - Default is '1.0'.

Gradient

Defines a color gradient.

ButtonStyle

  • style (string) - Name of a font or fontstring for text render.

ORIENTATION

  • HORIZONTAL
  • VERTICAL

JUSTIFYV

  • TOP
  • MIDDLE
  • BOTTOM

JUSTIFYH

  • LEFT
  • CENTER
  • RIGHT

OUTLINE

  • NONE
  • NORMAL
  • THICK

ALPHAMODE

Defines a way transparency applied.

  • DISABLE - no blend.
  • BLEND - (default) while background fades element gets stronger
  • ALPHAKEY - transparency depends on alpha channel of textures
  • ADD - background and element colors added resulting in bright colors
  • MOD - modulate

Display

Layer

  • level (DRAWLAYER) - Default is 'ARTWORK'.
  • textureSubLevel (int) - Additional sub-leveling of 'level'. Range of -8 .. 7. Default is '0'.
  • Texture ...
  • FontString ...

Backdrop

  • bgFile (string) - texture file for frame background
  • edgeFile (string) - texture file to use as frame edge
  • tile (bool) - true tile background, otherise is stretched. Default is 'false'.
  • alphaMode (ALPHAMODE) - blend mode for the colors or texture. Default is 'BLEND'.
  • BackgroundInsets (Inset) - offset out from frame to draw backdrop, higher values go outward.
  • EdgeSize (Value) - how large each copy of the edgeFile becomes on-screen
  • TileSize (Value) - how large each copy of the bgFile becomes on-screen
  • Color (Color) - defines a background color
  • BorderColor (Color) - defines a border color

DRAWLAYER

  • BACKGROUND
  • BORDER
  • ARTWORK - usual default.
  • OVERLAY
  • HIGHLIGHT

FRAMESTRATA

  • PARENT
  • BACKGROUND
  • LOW
  • MEDIUM
  • HIGH
  • DIALOG
  • FULLSCREEN
  • FULLSCREEN_DIALOG
  • TOOLTIP

Animation

AnimOrigin

  • point (FRAMEPOINT) - relative anchor for the offset.
  • Offset (Dimension) - static initial ofset for the animation origin.

ControlPoint

  • name (string)
  • offsetX (float)
  • offsetY (float)

ANIMLOOP

  • NONE
  • REPEAT
  • BOUNCE

ANIMSMOOTH

  • NONE
  • IN
  • OUT
  • IN_OUT
  • OUT_IN

ANIMCURVE

  • NONE
  • SMOOTH

Other Types

ATTRIBUTETYPE

  • nil
  • boolean
  • number
  • string

Ui

Attributes

Attribute

  • name (string) - Lua name for the member
  • type (ATTRIBUTETYPE) - the Lua type for the member. Default is 'string'.
  • value - value to set for the member

Parked

The below is temporarity parked here while things are restructured, was from the XML Basics, where it didnt really belong

For complete description and properties of each element follow link below. Since there is no official blizzard documentation, and standards change with patches, it's hard to keep this list up to date and accurate.

  • NonWidgets
    • include - You specify another scheme to load here (ones not listed in ToC file)
    • script - Refers to a script file (skipped in ToC file) or contains lua script inside
    • font - Defines a font template (can be used only inside ui tag)
    • texture - Defines a texture template (can be used only inside ui tag)

Around Wikia's network

Random Wiki