GUIVariable - Revision history

Celtic Minstrel: /* Simple types */ Fix improper articles

2025-04-28T12:47:06Z

‎Simple types: Fix improper articles

Bssarkar: /* Simple types */ Add real and f_real

2025-04-27T14:28:31Z

‎Simple types: Add real and f_real

Soliton: /* Simple types */ Explain how formula types work

2025-02-04T12:04:07Z

‎Simple types: Explain how formula types work

Soliton: /* Simple types */

2025-02-04T10:19:35Z

‎Simple types

White haired uncle: /* Simple types */

2024-11-05T03:14:06Z

‎Simple types

White haired uncle: /* Simple types */ - add f_color, fix color description

2024-11-05T03:06:55Z

‎Simple types: - add f_color, fix color description

Celtic Minstrel: /* Simple types */ Align left column cells to the top, for better "link to a row" support

2024-08-04T18:06:52Z

‎Simple types: Align left column cells to the top, for better "link to a row" support

Celtic Minstrel: Remove redundant extra pipes

2024-05-07T03:05:01Z

Remove redundant extra pipes

Bssarkar: /* Simple types */ convert to wikitable formatting

2024-05-06T05:56:29Z

‎Simple types: convert to wikitable formatting

Pentarctagon at 02:09, 29 April 2024

2024-04-29T02:09:18Z

@@ Line 27: / Line 27: @@
 |-
 |style="vertical-align:top"| <span id="f_int">f_int</span>
-| Signed number or formula returning an signed number.
+| Signed number or formula returning a signed number.
 |-
 |style="vertical-align:top"| <span id="real">real</span>
@@ Line 33: / Line 33: @@
 |-
 |style="vertical-align:top"| <span id="f_real">f_real</span>
-| Signed real number or formula returning an signed real number.
+| Signed real number or formula returning a signed real number.
 |-
 |style="vertical-align:top"| <span id="bool">bool</span>
@@ Line 72: / Line 72: @@
 * bottom aligned at the bottom
 * center centered
-When nothing is set or an another value as in the list the item is centered.
+When nothing is set or another value as in the list the item is centered.
 |-
 |style="vertical-align:top"| <span id="h_align">h_align</span>

@@ Line 28: / Line 28: @@
 |style="vertical-align:top"| <span id="f_int">f_int</span>
 | Signed number or formula returning an signed number.
 |-
 |style="vertical-align:top"| <span id="bool">bool</span>

@@ Line 4: / Line 4: @@
 == Simple types ==
-The simple types are types which have one value or a short list of options.
+The simple types are types which have one value or a short list of options. For types starting with <code>f_</code> where [[WFL|formula]] support is mentioned this means that if the value starts with an opening parenthesis <code>(</code> it is interpreted as a formula and otherwise as the alternative type.
 {| class="wikitable"

@@ Line 40: / Line 40: @@
 |-
 |style="vertical-align:top"| <span id="color">color</span>
-| A string which contains the color, this a group of 4 numbers between 0 and 255 separated by commas. The numbers are red component, green component, blue component and alpha.  An alpha of 0 is fully transparent, while an alpha of 255 is fully opaque.
+| A string which contains the color, this is a group of 4 numbers between 0 and 255 separated by commas. The numbers represent the red, green and blue component as well as the alpha.  An alpha value of 0 is fully transparent, while an alpha of 255 is fully opaque. If left out alpha defaults to fully opaque.
 |-
 |style="vertical-align:top"| <span id="f_color">f_color</span>

@@ Line 40: / Line 40: @@
 |-
 |style="vertical-align:top"| <span id="color">color</span>
-| A string which contains the color, this a group of 4 numbers between 0 and 255 separated by commas. The numbers are red component, green component, blue component and alpha.  An alpha of 0 is fully transparent, while an alpha of 255 is fully opaque. Omitted values are set to 0.
+| A string which contains the color, this a group of 4 numbers between 0 and 255 separated by commas. The numbers are red component, green component, blue component and alpha.  An alpha of 0 is fully transparent, while an alpha of 255 is fully opaque.
 |-
 |style="vertical-align:top"| <span id="f_color">f_color</span>

@@ Line 9: / Line 9: @@
 !Variable !!Description
 |-
-| <span id="unsigned">unsigned</span>
+|style="vertical-align:top"| <span id="unsigned">unsigned</span>
 | Unsigned number (positive whole numbers and zero).
 |-
-| <span id="f_unsigned">f_unsigned</span>
+|style="vertical-align:top"| <span id="f_unsigned">f_unsigned</span>
 | Unsigned number or formula returning an unsigned number.
 |-
-| <span id="int">int</span>
+|style="vertical-align:top"| <span id="int">int</span>
 | Signed number (whole numbers).
 |-
-| <span id="f_int">f_int</span>
+|style="vertical-align:top"| <span id="f_int">f_int</span>
 | Signed number or formula returning an signed number.
 |-
-| <span id="bool">bool</span>
+|style="vertical-align:top"| <span id="bool">bool</span>
 | A boolean value accepts the normal values as the rest of the game.
 |-
-| <span id="f_bool">f_bool</span>
+|style="vertical-align:top"| <span id="f_bool">f_bool</span>
 | Boolean value or a formula returning a boolean value.
 |-
-| <span id="string">string</span>
+|style="vertical-align:top"| <span id="string">string</span>
 | A text.
 |-
-| <span id="tstring">tstring</span>
+|style="vertical-align:top"| <span id="tstring">tstring</span>
 | A translatable string.
 |-
-| <span id="f_tstring">f_tstring</span>
+|style="vertical-align:top"| <span id="f_tstring">f_tstring</span>
 | Formula returning a translatable string.
 |-
-| <span id="function">function</span>
+|style="vertical-align:top"| <span id="function">function</span>
 | A string containing a set of function definition for the formula language.
 |-
-| <span id="color">color</span>
+|style="vertical-align:top"| <span id="color">color</span>
 | A string which contains the color, this a group of 4 numbers between 0 and 255 separated by a comma. The numbers are red component, green component, blue component and alpha. A color of 0 is not available. An alpha of 255 is fully transparent. Omitted values are set to 0.
 |-
-| <span id="font_style">font_style</span>
+|style="vertical-align:top"| <span id="font_style">font_style</span>
 | A string which contains the style of the font:
 * normal    normal font
@@ Line 50: / Line 50: @@
 Since SDL has problems combining these styles only one can be picked. Once SDL will allow multiple options, this type will be transformed to a comma separated list. If empty we default to the normal style. Since the render engine is replaced by Pango markup this field will change later on. Note widgets that allow marked up text can use markup to change the font style.
 |-
-| <span id="v_align">v_align</span>
+|style="vertical-align:top"| <span id="v_align">v_align</span>
 | Vertical alignment; how an item is aligned vertically in the available space. Possible values:
 * top    aligned at the top
@@ Line 57: / Line 57: @@
 When nothing is set or an another value as in the list the item is centered.
 |-
-| <span id="h_align">h_align</span>
+|style="vertical-align:top"| <span id="h_align">h_align</span>
 | Horizontal alignment; how an item is aligned horizontally in the available space. Possible values:
 * left   aligned at the left side
@@ Line 63: / Line 63: @@
 * center centered
 |-
-| <span id="f_h_align">f_h_align</span>
+|style="vertical-align:top"| <span id="f_h_align">f_h_align</span>
 | A horizontal alignment or a formula returning a horizontal alignment.
 |-
-| <span id="border">border</span>
+|style="vertical-align:top"| <span id="border">border</span>
 | Comma separated list of borders to use. Possible values:
 * left   border at the left side
@@ Line 74: / Line 74: @@
 * all    alias for "left, right, top, bottom"
 |-
-| <span id="scrollbar_mode">scrollbar_mode</span>
+|style="vertical-align:top"| <span id="scrollbar_mode">scrollbar_mode</span>
 | How to show the scrollbar of a widget. Possible values:
 * always       The scrollbar is always shown, regardless whether it's required or not.
@@ Line 82: / Line 82: @@
 Use auto when the list can be changed dynamically eg the game list in the lobby. For optimization you can also use auto when you really expect a scrollbar, but don't want it to be shown when not needed eg the language list will need a scrollbar on most screens.
 |-
-| <span id="resize_mode">resize_mode</span>
+|style="vertical-align:top"| <span id="resize_mode">resize_mode</span>
 | Determines how an image is resized. Possible values:
 * scale        The image is scaled.
@@ Line 88: / Line 88: @@
 * tile         The image is placed several times until the entire surface is filled. The last images are truncated.
 |-
-| <span id="grow_direction">grow_direction</span>
+|style="vertical-align:top"| <span id="grow_direction">grow_direction</span>
 | Determines how an image is resized. Possible values:
 * scale        The image is scaled.

@@ Line 1: / Line 1: @@
 == Variables ==
 In various parts of the GUI there are several variables types in use. This
 page describes them.
 == Simple types ==
 The simple types are types which have one value or a short list of options.
@@ Line 97: / Line 95: @@
 * tile         The image is placed several times until the entire surface is filled. The last images are truncated.
 |}
 == Section types ==
 For more complex parts, there are sections. Sections contain of several
 lines of WML and can have sub sections. For example a grid has sub sections
@@ Line 139: / Line 111: @@
 | A grid contains several widgets. (TODO add link to generic grid page.)
 |}
 [[Category: WML Reference]]
 [[Category: GUI WML Reference]]