Changes between Version 2 and Version 3 of Internals

Timestamp:

03/06/09 07:34:05 (17 years ago)

Author:

Henrik Heimbuerger

Comment:

added MDL and dialogs variable sections

Internals

@@ -1 +1 @@
 = Internals =
+
+This page will try to explain how CortUI is implemented. As such, it should be only relevant to those working on CortUI. If you just want to use it for Allegiance, you shouldn't have to read it.
 
 == MDL files ==
 
+CortUI and the HUDs are a modification of various MDL text files of Allegiance. Therefore, understanding the language used is very essential. [http://cortui.rtsquad.org/download/Ksero's_MDL_Language_Documentation.zip Ksero's MDL documentation] is compulsory reading. The language documentation explains the syntax and the reference is very useful during development, because it lists the parameters to all the functions and what they do.
+
+The rest of this page assumes you have read and understood the introduction and have the reference ready for lookup.
+
+It is very important that you understand that MDL is more of a functional/descriptive language. It is quite unlike the imperative programming langauges you might know. It is not possible in MDL to say "do this, then do that". You merely construct a ruleset on how the Allegiance client is supposed to build up the UI. There is no way to actually store data over time and there is no way to tell it how to behave that hasn't been prepared by the developers.
+
 == The dialogs variable ==
+
+The core of the modification can be found in the `dialog.mdl` file. It defines one variable, called `dialogs`, which defines the whole in-game UI.
+
+It defines a list of pairs. Each pair represents one pane that will appear on the UI at certain times. Each pair consists of the following elements:
+
+|| '''Name'''      || '''Type'''                   || '''Description''' ||
+|| image           || a variable defined above     || the image to display ||
+|| side            || one of the `Side*` constants || defines to which point the coordinates are given relative to ||
+|| off point       || an XY-coordinate pair        || the coordinates of the pane when it is not shown (used for animation) ||
+|| on point        || an XY-coordinate pair        || the coordinates of the pane when it is shown ||
+|| transition time || float                        || the transition time from off point to on point or the back when the pane is shown/hidden ||
+|| console mode    || integer / bitfield           || the context in which to show the pane ||
+|| undetectable    || boolean                      || whether clicks on the pane are detected and handled ||
+
+Some more documentation can be found in the modified `dialog.mdl`. In particular, it contains a list of all the `Side*` constants and the meaning of the bits used in the `console mode` bitfield.
+
+CortUI consists of a modification of this `dialogs` list and various changes of the pane definitions, which in turn depend on the values set in `cortui_settings.mdl`.
 
 == The installer ==