CT – Template
Jump to navigation
Jump to search
m (new UI EH command category as default entry on related commands list) |
(Usage instructions, overview over parameters) |
||
Line 70: | Line 70: | ||
== Usage == | == Usage == | ||
<pre> | <pre>{{CT|mode|arg1=value|arg2=value2|...}}</pre> | ||
</pre> | {| class="wikitable" | ||
! Mode !! Arguments !! Description !! Example | |||
|- | |||
|rowspan="6"| '''intro''' || macro || Control type macro from [[BIS_fnc_exportGUIBaseClasses]]. || <pre>CT_STATIC</pre> | |||
|- | |||
| value || Value of the macro. || <pre>0</pre> | |||
|- | |||
| description || Some text to give info about the CT. || <pre>This is CT_MAP. It is a map.</pre> | |||
|- | |||
| gallery || List of images to display in a gallery below the description. || <pre>File:Image.jpg{{!}}This is an image of the control.</pre> | |||
|- | |||
| commands || List of commands associated with the control. ||<pre>* [[:Category:Command_Group:_GUI_Control_-_Controls_Table|Commands: Controls Table]]</pre> | |||
|- | |||
| events || List of UIEH that work on the control. || <pre>* [[User_Interface_Event_Handlers|Events: All]]</pre> | |||
|- | |||
| colspan=4 | | |||
|- | |||
| '''abc start''' || no arguments || Marks the beggining of the config reference part with the use of the '''attribute''' mode. || | |||
|- | |||
| colspan=4 | | |||
|- | |||
|rowspan="5"| '''attribute''' || name || Name of the attribute. || <pre>text</pre> | |||
|- | |||
| value1-4 || Possible values of the config entry. Has to match the type given by type1-4. || <pre>"This is a string"</pre> | |||
|- | |||
| type1-4 || Type of the respective value. Possible values: Number, String, Array, Class. Each type/value pair gets an example.|| <pre>String</pre> | |||
|- | |||
| description || What does the attribute do? || <pre>This string displays text.</pre> | |||
|- | |||
| mandatory || If defined a yellow warning box will be displayed at the attributes position. Mandatory attributes throw an error in RPT when omitted. || <pre>1</pre> | |||
|- | |||
| colspan=4 | | |||
|- | |||
| '''abc end''' || no arguments || Marks the end of the config reference. || | |||
|- | |||
| colspan=4 | | |||
|- | |||
| '''examples''' || no arguments || Inserts the header and a disclaimer at this position. || | |||
|} | |||
You can inspect the generator code for this page by clicking EDIT on the top right. The code starts below this line:<br> | |||
<nowiki>=============================================================================================================</nowiki> | |||
{{CT|intro | {{CT|intro |
Revision as of 00:51, 11 November 2020
Usage
{{CT|mode|arg1=value|arg2=value2|...}}
Mode | Arguments | Description | Example |
---|---|---|---|
intro | macro | Control type macro from BIS_fnc_exportGUIBaseClasses. | CT_STATIC |
value | Value of the macro. | 0 | |
description | Some text to give info about the CT. | This is CT_MAP. It is a map. | |
gallery | List of images to display in a gallery below the description. | File:Image.jpg{{!}}This is an image of the control. | |
commands | List of commands associated with the control. | * [[:Category:Command_Group:_GUI_Control_-_Controls_Table|Commands: Controls Table]] | |
events | List of UIEH that work on the control. | * [[User_Interface_Event_Handlers|Events: All]] | |
abc start | no arguments | Marks the beggining of the config reference part with the use of the attribute mode. | |
attribute | name | Name of the attribute. | text |
value1-4 | Possible values of the config entry. Has to match the type given by type1-4. | "This is a string" | |
type1-4 | Type of the respective value. Possible values: Number, String, Array, Class. Each type/value pair gets an example. | String | |
description | What does the attribute do? | This string displays text. | |
mandatory | If defined a yellow warning box will be displayed at the attributes position. Mandatory attributes throw an error in RPT when omitted. | 1 | |
abc end | no arguments | Marks the end of the config reference. | |
examples | no arguments | Inserts the header and a disclaimer at this position. |
You can inspect the generator code for this page by clicking EDIT on the top right. The code starts below this line:
=============================================================================================================
Template:Navbox control types
Template:Cfg ref
Introduction
Informative text about this control type.
Related commands
- Commands: General
- Commands: UI Eventhandlers
- command group CT
Related User Interface Eventhandlers
- Events: General
- event1
- event2
Alphabetical Order
#define CT_TREE 1234
T
testArray
- Type
- Array
- Description
- This is a test array to test arrays.
testArray[] = {1,0,0,1};
testAttribute
- Type
- String
- Description
- n/a
testAttribute = "test";
testClass
Class example:
class ComboScrollBar
{
color[] = {1,1,1,1};
colorActive[] = {1,1,1,1};
colorDisabled[] = {1,1,1,0.3};
thumb = "\A3\ui_f\data\gui\cfg\scrollbar\thumb_ca.paa";
arrowEmpty = "\A3\ui_f\data\gui\cfg\scrollbar\arrowEmpty_ca.paa";
arrowFull = "\A3\ui_f\data\gui\cfg\scrollbar\arrowFull_ca.paa";
border = "\A3\ui_f\data\gui\cfg\scrollbar\border_ca.paa";
shadow = 0;
scrollSpeed = 0.06;
width = 0;
height = 0;
autoScrollEnabled = 0;
autoScrollSpeed = -1;
autoScrollDelay = 5;
autoScrollRewind = 0;
};
Number example:
testClass = 9876;
Default Classes
RscExample
class RscExample
{
deletable = 0;
fade = 0;
access = 0;
type = CT_TYPEMACRO;
style = SL_HORZ;
color[] = {1,1,1,0.8};
colorActive[] = {1,1,1,1};
shadow = 0;
x = 0;
y = 0;
w = 0.3;
h = 0.025;
};