This documentation is aimed at anyone who is interested in editing the GUI of the Pyrogenesis Engine, whether in-house scripters or maybe, down the road, modders. The documentation will explain things like how to make XML files, how to manipulate the GUI from Javascript and what all those object properties actually do.

== Documentation ==
The documentation is broken down into sub-pages:

 * [wiki:GUI_-_XML_Files XML Files][[BR]]The GUI is created in XML files ... here is a quick guide.
 * [wiki:GUI_-_Properties Properties][[BR]]Read about the object ''properties'' and what they do. It is also recommended to visit the page for the type of object you're using; there might be examples and notes about property usage.
  * [wiki:GUI_-_Data_Types Data Types][[BR]]All properties have specific data types, such as ''string'', ''integer'' or ''float''.
 * [wiki:GUI_-_Custom_Objects Custom Objects][[BR]]Custom objects are building blocks of the real GUI objects, such as scrollbars, icons and tooltips.
 * [wiki:GUI_-_Actions Actions][[BR]]A perfect example of an action is when a button is pressed, and Javascript is executed.
 * [wiki:GUI_-_Styles Styles] - Updated[[BR]]Styles are templates with properties. Instead of manually giving ten objects the same values, you can just create a style and use it on those objects.
 * [wiki:GUI_-_Sprites Sprites] - Updated[[BR]]In the GUI, what is regarded a ''sprite'' is not just an image, it is a collage of sometimes a multitude of images, with different placements relative to the host object. As with many parts of the GUI, master this and you will find the GUI quite powerful.
 * [wiki:GUI_-_Text_Renderer Text Renderer][[BR]]There are a number of ways you can change the format of the text you're typing, including nesting images and icons, by inserting tags similar to those of HTML. This text rendering system is generic in the GUI so it's worth taking a peek at.
 * [wiki:Exposed_GUI_Functions GUI Javascript Functions][[BR]]Learn how to manipulate the GUI with Javascript.

== Objects ==
The object types of the GUI. '''Active''' types are available for use (though they may not necessarily be fully featured yet). '''Unavailable''' types have not started development or are not yet in a state where they can be considered usable.

=== Active ===

 * [wiki:GUI_-_Button Button]
 * [wiki:GUI_-_Check-box Check-box]
 * [wiki:GUI_-_Drop-down Drop-down]
 * [wiki:GUI_-_Empty Empty]
 * [wiki:GUI_-_Image Image]
 * [wiki:GUI_-_Input Input]
 * [wiki:GUI_-_List List]
 * [wiki:GUI_-_Minimap Minimap]
 * [wiki:GUI_-_Progress-bar Progress-bar]
 * [wiki:GUI_-_Radio-button Radio-button]
 * [wiki:GUI_-_Repeat Repeat]
 * [wiki:GUI_-_Text Text]

=== Unavailable ===
 * [wiki:GUI_-_Color-picker Color-picker]
 * [wiki:GUI_-_Menu Menu]
 * [wiki:GUI_-_Slider Slider]