Client XML Documentation

From Starsonata Wiki
Revision as of 08:06, 8 February 2012 by Blue dwarf (talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Button

Window

WindowTrans

ModalScreen

MessageBox

ScrollBar

Image

<element type="image">

Example:

<element type="image">

 <attributes>
<rect name="Rect" value="12, 37, 483, 305" />
<texture name="Texture" value="background.station.ships" />
<bool name="UseAlphaChannel" value="true" />
<color name="Color" value="9fffffff" />
<rect name="ImageRect" value="25, 63, 498, 333" />
</attributes>

</element>

Notes:

Rect is the coordinates that the image will appear

The texture name is the name of an image specified in images.xml

ImageRect specifies a subset of the image to display

Color is in the aarrggbb format

Rectangle

<element type="rectangle">

  <attributes>
    <string name="IdName" value="" />
    <string name="TextID" value="" />
    <int name="Id" value="-1" />
    <string name="Caption" value="" />
    <rect name="Rect" value="0, 0, 1, 1" />
    <position name="MinSize" value="1, 1" />
    <position name="MaxSize" value="0, 0" />
    <bool name="NoClip" value="false" />
    <enum name="LeftAlign" value="upperLeft" />
    <enum name="RightAlign" value="upperLeft" />
    <enum name="TopAlign" value="upperLeft" />
    <enum name="BottomAlign" value="upperLeft" />
    <bool name="Visible" value="true" />
    <bool name="Enabled" value="true" />
    <bool name="TabStop" value="false" />
    <bool name="TabGroup" value="false" />
    <int name="TabOrder" value="-1" />
    <color name="col_left_up" value="ffffffff" />
    <color name="col_right_up" value="ffffffff" />
    <color name="col_left_down" value="ffffffff" />
    <color name="col_right_down" value="ffffffff" />
  </attributes>

</element>

Checkbox

<code><element type="checkBox">
  <attributes>
    <string name="IdName" value="" />
    <string name="TextID" value="" />
    <int name="Id" value="-1" />
    <string name="Caption" value="" />
    <rect name="Rect" value="0, 0, 1, 1" />
    <position name="MinSize" value="1, 1" />
    <position name="MaxSize" value="0, 0" />
    <bool name="NoClip" value="false" />
    <enum name="LeftAlign" value="upperLeft" />
    <enum name="RightAlign" value="upperLeft" />
    <enum name="TopAlign" value="upperLeft" />
    <enum name="BottomAlign" value="upperLeft" />
    <bool name="Visible" value="true" />
    <bool name="Enabled" value="true" />
    <bool name="TabStop" value="true" />
    <bool name="TabGroup" value="false" />
    <int name="TabOrder" value="3" />
    <bool name="Checked" value="false" />
    <int name="IconChecked" value="-1" />
    <int name="IconUnchecked" value="-1" />
    <string name="IconBankName" value="" />
  </attributes>
</element>
</code>

Table

MeshViewer

StaticText

EditBox

SpinBox

TabControl

Tab

ContextMenu

Menu

Toolbar

ComboBox

Chat

RadioButtonGroup

RadioCheckboxGroup

Slider

Tutorial

Callback

Variables

A list of variables that is under construction is available at: https://docs.google.com/spreadsheet/ccc?key=0AteE8uOXJmHDdFJFYlJhVUlUb3d0LTRzMHJ5MVJlaXc&hl=en_GB

Post on the talk page or contact Blue Dwarf/Jeff Bobbo for editing access