GUIToolkitWML - Revision history

Bssarkar: /* GUI */ item -> ui control/widgets, much easily understood

2025-01-25T05:50:04Z

‎GUI: item -> ui control/widgets, much easily understood

Bssarkar: /* Row values */ demote heading level

2025-01-25T05:48:32Z

‎Row values: demote heading level

Bssarkar: Organize sections so that it can be understood which subtags are available where.

2025-01-25T05:48:07Z

Organize sections so that it can be understood which subtags are available where.

Bssarkar: Duplicate sections, already exist in GUIWidgetInstanceWML page

2025-01-25T05:44:48Z

Duplicate sections, already exist in GUIWidgetInstanceWML page

Bssarkar: /* Subtag [settings] */ Rename section heading to be more consistent with rest of page

2025-01-25T05:42:05Z

‎Subtag [settings]: Rename section heading to be more consistent with rest of page

Bssarkar: /* State */ remove duplicate

2025-01-25T05:39:55Z

‎State: remove duplicate

Bssarkar: /* Resolution */ demote heading level because this describes the [resolution] subtag under [window_definition]

2025-01-25T05:38:37Z

‎Resolution: demote heading level because this describes the [resolution] subtag under [window_definition]

Bssarkar: /* Available Windows */ add )

2025-01-25T05:37:30Z

‎Available Windows: add )

Bssarkar: /* GUI */ add links to widget and window lists, organize into subsections

2024-08-27T04:48:35Z

‎GUI: add links to widget and window lists, organize into subsections

Bssarkar: /* GUI */ mention tag

2024-08-27T04:44:46Z

‎GUI: mention tag

@@ Line 1: / Line 1: @@
 == GUI ==
-The gui class contains the definitions of all widgets and windows used in the game. This can be seen as a skin and it allows the user to define the visual aspect of the various items. The visual aspect can be determined depending on the size of the game window.
+The gui class contains the definitions of all widgets and windows used in the game. This can be seen as a skin and it allows the user to define the visual aspect of the various ui controls/widgets. The visual aspect can be determined depending on the size of the game window.
 Widgets have a definition and an instance, the definition contains the general info/looks of a widget and the instance the actual looks. E.g. where the button text is placed is the same for every button, but the

@@ Line 538: / Line 538: @@
 can be found here [[GUILayout]].
-== Row values ==
+=== Row values ===
 For every row the following variables are available:

@@ Line 1: / Line 1: @@
 == GUI ==
-The gui class contains the definitions of all widgets and windows used in
+The gui class contains the definitions of all widgets and windows used in the game. This can be seen as a skin and it allows the user to define the visual aspect of the various items. The visual aspect can be determined depending on the size of the game window.
-Widgets have a definition and an instance, the definition contains the
+Widgets have a definition and an instance, the definition contains the general info/looks of a widget and the instance the actual looks. E.g. where the button text is placed is the same for every button, but the
 text of every button might differ.
-The default gui has the id ''default'' and must exist, in the default gui
+The default gui has the id ''default'' and must exist, in the default gui there must a definition of every widget with the id ''default'' and every window needs to be defined. If the definition of a widget with a certain id doesn't exist it will fall back to default in the current gui, if it's not defined there either it will fall back to the default widget in the default theme. That way it's possible to slowly create your own gui and test it.
 In WML, the gui class is represented by the toplevel '''[gui]''' tag, which supports the following keys,
@@ Line 247: / Line 236: @@
 |}
-== Resolution ==
+== Widget definition ==
 Depending on the resolution a widget can look different. Resolutions are
 evaluated in order of appearance. The ''window_width'' and ''window_height''
@@ Line 342: / Line 332: @@
-== State ==
+=== State ===
 A state contains the info what to do in a state. At the moment this is rather focused on the drawing part, might change later.
@@ Line 525: / Line 515: @@
 Note more fields will probably be added later on.
-== Cell ==
+== Grid ==
 {| border="1"
 !key
@@ Line 562: / Line 553: @@
 |}
-== Cell values ==
+=== Cell values ===
 For every column the following variables are available:
 {| border="1"

@@ Line 605: / Line 605: @@
 | Does the widget grow in horizontal direction when the grid cell grows in the horizontal direction. This is used if the grid cell is higher as the best width for the widget.
 |}
 [[Category: WML Reference]]
 [[Category: GUI WML Reference]]

@@ Line 51: / Line 51: @@
 |}
-=== Subtag [settings] ===
+=== Settings ===
 A setting section (subtag '''[settings]''') supports the following keys:
 {| border="1"

@@ Line 187: / Line 187: @@
 === Available Windows ===
-<span id="window_list"></span>List of available windows: (main list at [[GUIWindowDefinitionWML]]
+<span id="window_list"></span>List of available windows: (main list at [[GUIWindowDefinitionWML]])
 {| border="1"
 !Section

@@ Line 50: / Line 50: @@
 | The settings for the gui.
 |}
 <span id="widget_list"></span>List of available widgets:
@@ Line 184: / Line 243: @@
 | Editor custom tod ([[GUIWindowDefinitionWML#Editor_custom_tod|definition]])
 | Creates new ToD schedules for the editor.
 |}