This shows you the differences between two versions of the page.
Next revision | Previous revisionLast revisionBoth sides next revision | ||
dragengine:modules:dragonscript:xmlguitheme:parameters [2018/02/27 13:46] – < dragonlord | dragengine:modules:dragonscript:xmlguitheme:parameters [2020/04/03 10:21] – url move dragonlord | ||
---|---|---|---|
Line 6: | Line 6: | ||
Parameters define a value of a specific type to assign to a parameter by name. The last set values for a particular parameter name is used in the end. The supported types are described here. In general all attributes are optional unless marked otherwise. Not defined attributes use the default value. | Parameters define a value of a specific type to assign to a parameter by name. The last set values for a particular parameter name is used in the end. The supported types are described here. In general all attributes are optional unless marked otherwise. Not defined attributes use the default value. | ||
+ | The loader script tries to set the parameter using the provided type. If the parameter does not understand the provided value an exception is thrown. The loader script prints out such problems to the game console and tries to continue if possible. In some cases it is though not possible to continue without a properly set value. While working with parameters always watch the game console to see if some parameters are not properly understood or invalid. | ||
===== Integer ===== | ===== Integer ===== | ||
Sets an integer value. | Sets an integer value. | ||
Line 103: | Line 104: | ||
</ | </ | ||
+ | ===== Font ===== | ||
+ | Sets a font parameter. Fonts are engine resources. When you define a font parameter you select the font file to use and the line height in pixels. If the line height does not match the font scaling is required which might look ok or not. | ||
+ | |||
+ | <code xml> | ||
+ | <font parameter=' | ||
+ | </ | ||
+ | |||
+ | ===== Image ===== | ||
+ | Sets an image parameter. Images are engine resources. | ||
+ | |||
+ | <code xml> | ||
+ | <image parameter=' | ||
+ | </ | ||
+ | |||
+ | ===== Video ===== | ||
+ | Sets a video parameter. Videos are engine resources. Video parameters are typically played back automatically in a loop by the parameter owner | ||
+ | |||
+ | <code xml> | ||
+ | <video parameter=' | ||
+ | </ | ||
+ | |||
+ | ===== Border Size ===== | ||
+ | Sets a BorderSize parameter. [[https:// | ||
+ | |||
+ | <code xml> | ||
+ | <!-- Set border size with all sides set to the same value. --> | ||
+ | < | ||
+ | |||
+ | <!-- Set border size with individual values for each side. Not defined sides are set to 0. --> | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | ===== Point ===== | ||
+ | Sets a Point parameter. [[https:// | ||
+ | |||
+ | <code xml> | ||
+ | <!-- Set border size with individual values for each side. Not defined sides are set to 0. --> | ||
+ | <point parameter=' | ||
+ | </ | ||
+ | |||
+ | ===== Canvas Creator ===== | ||
+ | Sets a CanvasCreator parameter. See [[dragengine: | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ===== Border ===== | ||
+ | Sets a Border parameter. See [[dragengine: | ||
+ | |||
+ | <code xml> | ||
+ | <border parameter=' | ||
+ | < | ||
+ | </ | ||
+ | <border parameter=' | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ===== Decoration ===== | ||
+ | Sets a Decoration parameter. See [[dragengine: | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ===== Mouse Pointer ===== | ||
+ | Sets a MousePointer parameter. See [[dragengine: | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ===== Widget Designer ===== | ||
+ | Sets a WidgetDesigner parameter. See [[dragengine: | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ===== Null ===== | ||
+ | Sets a null parameter. Null can be used in place of any other parameter type. It is typically used to clear a previously set parameter for example from a named widget designer or some element loaded from XML file. Depending on the parameter null values may not be allowed. | ||
+ | |||
+ | <code xml> | ||
+ | <!-- Set parameter to null or empty. In this example the parameter is of type BorderSize and cleared this way. --> | ||
+ | <null parameter=' | ||
+ | </ | ||