ctrlCreate: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - " {{GameCategory|arma3|New Scripting Commands}} {{GameCategory|arma3|Scripting Commands}} {{uc:{{PAGENAME}}}} " to "") |
Lou Montana (talk | contribs) m (Text replacement - "// since Arma 3" to "// since {{arma3}}") |
||
(85 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma3 | |game1= arma3 | ||
|version1= 1.26 | |||
|1.26 | |||
|gr1= GUI Control | |gr1= GUI Control | ||
| Creates a new control in the given display.<br | |descr= Creates a new control in the given display.<br> | ||
The control class could be an existing class from the [[configFile | main config]] or a custom class defined in the [[missionConfigFile | mission config]]. The main config is searched first, if the class does not exist there, the mission config is searched. Some of the common controls defined in the main config that can be used with this command: | The control class could be an existing class from the [[configFile | main config]] or a custom class defined in the [[missionConfigFile | mission config]]. | ||
The main config is searched first, if the class does not exist there, the mission config is searched. | |||
Some of the common controls defined in the main config that can be used with this command: | |||
<spoiler text="Show list"> | <spoiler text="Show list"> | ||
{{{!}} class | {{Feature|informative|This list contains controls which are guaranteed to work with this command. However, controls not listed here should work as well - as long as they are properly defined.}} | ||
{{{!}} class="wikitable" width="100%" | |||
! Class !! Description !! Available since | ! Class !! Description !! Available since | ||
{{!}}- | {{!}}- | ||
Line 28: | Line 30: | ||
{{!}} RscEditMulti {{!}}{{!}} multiline input box {{!}}{{!}} | {{!}} RscEditMulti {{!}}{{!}} multiline input box {{!}}{{!}} | ||
{{!}}- | {{!}}- | ||
{{!}} RscEditReadOnly {{!}}{{!}} input box with [[DialogControls-EditBox | | {{!}} RscEditReadOnly {{!}}{{!}} input box with [[DialogControls-EditBox | {{hl|c= canModify {{=}} false;}}]] {{!}}{{!}} {{GVI|arma3|1.98}} | ||
{{!}}- | {{!}}- | ||
{{!}} RscEditMultiReadOnly {{!}}{{!}} multiline input box with [[DialogControls-EditBox | | {{!}} RscEditMultiReadOnly {{!}}{{!}} multiline input box with [[DialogControls-EditBox | {{hl|c= canModify {{=}} false;}}]]{{!}}{{!}} {{GVI|arma3|1.98}} | ||
{{!}}- | {{!}}- | ||
{{!}} RscTree {{!}}{{!}} tree view control {{!}}{{!}} | {{!}} RscTree {{!}}{{!}} tree view control {{!}}{{!}} | ||
{{!}}- | {{!}}- | ||
{{!}} RscTreeMulti {{!}}{{!}} multi-select tree view {{!}}{{!}} | {{!}} RscTreeMulti {{!}}{{!}} multi-select tree view {{!}}{{!}} {{GVI|arma3|2.02}} | ||
{{!}}- | {{!}}- | ||
{{!}} RscTreeSearch {{!}}{{!}} searchable tree view control (see Example 4) {{!}}{{!}} | {{!}} RscTreeSearch {{!}}{{!}} searchable tree view control (see Example 4) {{!}}{{!}} | ||
Line 42: | Line 44: | ||
{{!}} RscVideoKeepAspect {{!}}{{!}} picture control for video to keep original video aspect ratio {{!}}{{!}} | {{!}} RscVideoKeepAspect {{!}}{{!}} picture control for video to keep original video aspect ratio {{!}}{{!}} | ||
{{!}}- | {{!}}- | ||
{{!}} RscButtonMenuBIKI {{!}}{{!}} shortcut button with url pointing to "https://community.bistudio.com/wiki/" {{!}}{{!}} | {{!}} RscButtonMenuBIKI {{!}}{{!}} shortcut button with url pointing to "https://community.bistudio.com/wiki/" {{!}}{{!}} {{GVI|arma3|1.98}} | ||
{{!}}- | {{!}}- | ||
{{!}} RscControlsGroup {{!}}{{!}} default controls group {{!}}{{!}} | {{!}} RscControlsGroup {{!}}{{!}} default controls group {{!}}{{!}} | ||
Line 51: | Line 53: | ||
{{!}}- | {{!}}- | ||
{{!}} RscControlsGroupNoVScrollbars {{!}}{{!}} controls group without vertical scrollbar {{!}}{{!}} | {{!}} RscControlsGroupNoVScrollbars {{!}}{{!}} controls group without vertical scrollbar {{!}}{{!}} | ||
{{!}}} | {{!}}} | ||
</spoiler> | </spoiler> | ||
{{Feature| | {{Feature|important|If you are creating [[CT_MAP]] control dynamically, use [[ctrlMapSetPosition]] to update control position instead of [[ctrlSetPosition]].}} | ||
| display | |s1= display [[ctrlCreate]] [class, idc, controlsGroup] | ||
|p1= display: [[Display]] - | |p1= display: [[Display]] - display in which control will be created | ||
|p2= [ | |p2= class: [[String]] or {{GVI|arma3|2.14|size= 0.75}} [[Config]] - existing classname (see [[ctrlCreate/classnames]]) of the new control; {{GVI|arma3|1.70|size= 0.75}} it is possible to use classes defined in mission config | ||
|p3= | |p3= idc: [[Number]] - IDC of the new control. Use -1 if not needed | ||
{{Feature|warning|Be careful when setting the IDC to {{hl|-1}} if the GUI also contains a [[CT_LISTNBOX]] since {{hl|idcLeft}} and {{hl|idcRight}} by default have <syntaxhighlight lang="cpp" inline>idc = -1;</syntaxhighlight>.}} | |||
|p4= | |p4= controlsGroup: [[Control]] - (Optional, default [[controlNull]]) creates controls in existing controls group | ||
| | |r1= [[Control]] | ||
| [ | |x1= <sqf>_display ctrlCreate ["RscText", 1234];</sqf> | ||
| | |x2= <sqf> | ||
_map = findDisplay 46 ctrlCreate ["RscMapControl", -1]; | |||
_multiLineText = | _multiLineText = findDisplay 46 ctrlCreate ["RscTextMulti", -1]; | ||
_multiLineEdit = | _multiLineEdit = findDisplay 46 ctrlCreate ["RscEditMulti", -1]; | ||
|x3= < | </sqf> | ||
|x4= Create Tree View control with search. Available | |||
|x3= <sqf>myControl = findDisplay 0 ctrlCreate ["RscText", 1234, findDisplay 0 displayCtrl 2300];</sqf> | |||
|x4= Create Tree View control with search. Available {{hl|RscTreeSearch}} class is hardcoded to be used with {{hl|RscEdit}} with idc {{hl|645}}. | |||
Example below demonstrates how to. After tree is generated, try typing something in the top box. | |||
<sqf> | |||
0 spawn | |||
{ | { | ||
[[ | disableSerialization; | ||
_display = (if (is3DEN) then {findDisplay 313} else {[] call BIS_fnc_displayMission}) createDisplay "RscDisplayEmpty"; | |||
_edit = _display ctrlCreate ["RscEdit", 645]; | |||
_edit ctrlSetPosition [0,0,1,0.04]; | |||
_edit ctrlSetBackgroundColor [0,0,0,1]; | |||
_edit ctrlCommit 0; | |||
_tv = _display ctrlCreate ["RscTreeSearch", -1]; | |||
_tv ctrlSetFont "EtelkaMonospacePro"; | |||
_tv ctrlSetFontHeight 0.03; | |||
_tv ctrlSetPosition [0,0.06,1,0.94]; | |||
_tv ctrlSetBackgroundColor [0,0,0,1]; | |||
_tv ctrlCommit 0; | |||
_classes = "true" configClasses (configFile >> "CfgVehicles"); | |||
for "_i" from 0 to 5 do | |||
{ | { | ||
_tv | _tv tvAdd [[], configName selectRandom _classes]; | ||
for "_j" from 0 to 5 do | |||
{ | { | ||
_tv | _tv tvAdd [[_i], configName selectRandom _classes]; | ||
for "_k" from 0 to 5 do | |||
{ | { | ||
_tv | _tv tvAdd [[_i, _j], configName selectRandom _classes]; | ||
for "_n" from 0 to 5 do | |||
{ | { | ||
_tv | _tv tvAdd [[_i, _j, _k], configName selectRandom _classes]; | ||
}; | }; | ||
}; | }; | ||
}; | }; | ||
}; | }; | ||
};</ | }; | ||
</sqf> | |||
|x5=Create a simple submit edit box and show content in hint: < | |x5= Create a simple submit edit box and show content in hint: | ||
<sqf> | |||
disableSerialization; | |||
private _display = findDisplay 46 createDisplay "RscDisplayEmpty"; | |||
private _ctrlGroup = _display ctrlCreate ["RscControlsGroupNoScrollbars", -1]; | |||
private _ctrlBackground = _display ctrlCreate ["RscTextMulti", -1, _ctrlGroup]; | |||
IDD_EDIT_BOX = 123; | IDD_EDIT_BOX = 123; | ||
private _ctrlEdit = _display ctrlCreate ["RscEditMulti", IDD_EDIT_BOX, _ctrlGroup]; | |||
private _ctrlButton = _display ctrlCreate ["RscShortcutButton", -1, _ctrlGroup]; | |||
_ctrlGroup | _ctrlGroup ctrlSetPosition [0.5, 0.5, 0, 0]; | ||
_ctrlGroup | _ctrlGroup ctrlCommit 0; | ||
_ctrlBackground | _ctrlBackground ctrlSetPosition [0, 0, 0.5, 0.5]; | ||
_ctrlBackground | _ctrlBackground ctrlSetBackgroundColor [0.5, 0.5, 0.5, 0.9]; | ||
_ctrlBackground | _ctrlBackground ctrlSetText "ENTER TEXT:"; | ||
_ctrlBackground | _ctrlBackground ctrlEnable false; | ||
_ctrlBackground | _ctrlBackground ctrlCommit 0; | ||
_ctrlEdit | _ctrlEdit ctrlSetPosition [0.01, 0.05, 0.48, 0.34]; | ||
_ctrlEdit | _ctrlEdit ctrlSetBackgroundColor [0, 0, 0, 0.5]; | ||
_ctrlEdit | _ctrlEdit ctrlCommit 0; | ||
_ctrlButton | _ctrlButton ctrlSetPosition [0.185, 0.42, 0.13, 0.05]; | ||
_ctrlButton | _ctrlButton ctrlCommit 0; | ||
_ctrlButton | _ctrlButton ctrlSetText "SUBMIT"; | ||
_ctrlButton | _ctrlButton ctrlAddEventHandler ["ButtonClick", | ||
{ | { | ||
params ["_ctrl"]; | |||
_display = | _display = ctrlParent _ctrl; | ||
_text = | _text = ctrlText (_display displayCtrl IDD_EDIT_BOX); | ||
if (_text == "") then { _text = "EMPTY" }; | |||
hint _text; | |||
_display | _display closeDisplay 1; | ||
}]; | }]; | ||
ctrlSetFocus _ctrlEdit; | |||
_ctrlGroup | _ctrlGroup ctrlSetPosition [0.25, 0.25, 0.5, 0.5]; | ||
_ctrlGroup | _ctrlGroup ctrlCommit 0.1; | ||
playSound "Hint3"; | |||
</sqf> | |||
| [[allControls]] | |x6= <sqf> | ||
// since {{arma3}} v2.14 | |||
findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate [configFile >> "RscDisplayBootcampMsgBox" >> "controls" >> "BootcampMessageBox", -1]; | |||
</sqf> | |||
|seealso= [[ctrlMapSetPosition]] [[allControls]] [[allDisplays]] [[controlsGroupCtrl]] [[ctrlDelete]] [[ctrlModel]] [[ctrlSetModel]] [[ctrlPosition]] [[ctrlSetPosition]] [[ctrlClassName]] [[ctrlModelScale]] [[ctrlSetModelScale]] [[ctrlModelDirAndUp]] [[ctrlSetModelDirAndUp]] [[displayParent]] | |||
}} | }} | ||
Latest revision as of 19:02, 18 November 2023
Description
- Description:
- Creates a new control in the given display.
The control class could be an existing class from the main config or a custom class defined in the mission config. The main config is searched first, if the class does not exist there, the mission config is searched. Some of the common controls defined in the main config that can be used with this command:Class Description Available since RscText simple text box RscStructuredText text box which supports structured text RscTextMulti simple multiline text box RscPicture simple picture box RscPictureKeepAspect picture box that doesn't stretch picture RscEdit input box RscEditMulti multiline input box RscEditReadOnly input box with canModify = false; 1.98
RscEditMultiReadOnly multiline input box with canModify = false; 1.98
RscTree tree view control RscTreeMulti multi-select tree view 2.02
RscTreeSearch searchable tree view control (see Example 4) RscVideo picture control with autostart for video texture (see BIS_fnc_playVideo) RscVideoKeepAspect picture control for video to keep original video aspect ratio RscButtonMenuBIKI shortcut button with url pointing to "https://community.bistudio.com/wiki/" 1.98
RscControlsGroup default controls group RscControlsGroupNoScrollbars controls group without scrollbars RscControlsGroupNoHScrollbars controls group without horizontal scrollbar RscControlsGroupNoVScrollbars controls group without vertical scrollbar - Groups:
- GUI Control
Syntax
- Syntax:
- display ctrlCreate [class, idc, controlsGroup]
- Parameters:
- display: Display - display in which control will be created
- class: String or
2.14 Config - existing classname (see ctrlCreate/classnames) of the new control;
1.70 it is possible to use classes defined in mission config
- idc: Number - IDC of the new control. Use -1 if not needed
- controlsGroup: Control - (Optional, default controlNull) creates controls in existing controls group
- Return Value:
- Control
Examples
- Example 1:
- _display ctrlCreate ["RscText", 1234];
- Example 2:
- _map = findDisplay 46 ctrlCreate ["RscMapControl", -1]; _multiLineText = findDisplay 46 ctrlCreate ["RscTextMulti", -1]; _multiLineEdit = findDisplay 46 ctrlCreate ["RscEditMulti", -1];
- Example 3:
- Example 4:
- Create Tree View control with search. Available RscTreeSearch class is hardcoded to be used with RscEdit with idc 645.
Example below demonstrates how to. After tree is generated, try typing something in the top box.
0 spawn { disableSerialization; _display = (if (is3DEN) then {findDisplay 313} else {[] call BIS_fnc_displayMission}) createDisplay "RscDisplayEmpty"; _edit = _display ctrlCreate ["RscEdit", 645]; _edit ctrlSetPosition [0,0,1,0.04]; _edit ctrlSetBackgroundColor [0,0,0,1]; _edit ctrlCommit 0; _tv = _display ctrlCreate ["RscTreeSearch", -1]; _tv ctrlSetFont "EtelkaMonospacePro"; _tv ctrlSetFontHeight 0.03; _tv ctrlSetPosition [0,0.06,1,0.94]; _tv ctrlSetBackgroundColor [0,0,0,1]; _tv ctrlCommit 0; _classes = "true" configClasses (configFile >> "CfgVehicles"); for "_i" from 0 to 5 do { _tv tvAdd [[], configName selectRandom _classes]; for "_j" from 0 to 5 do { _tv tvAdd [[_i], configName selectRandom _classes]; for "_k" from 0 to 5 do { _tv tvAdd [[_i, _j], configName selectRandom _classes]; for "_n" from 0 to 5 do { _tv tvAdd [[_i, _j, _k], configName selectRandom _classes]; }; }; }; }; };
- Example 5:
- Create a simple submit edit box and show content in hint:
disableSerialization; private _display = findDisplay 46 createDisplay "RscDisplayEmpty"; private _ctrlGroup = _display ctrlCreate ["RscControlsGroupNoScrollbars", -1]; private _ctrlBackground = _display ctrlCreate ["RscTextMulti", -1, _ctrlGroup]; IDD_EDIT_BOX = 123; private _ctrlEdit = _display ctrlCreate ["RscEditMulti", IDD_EDIT_BOX, _ctrlGroup]; private _ctrlButton = _display ctrlCreate ["RscShortcutButton", -1, _ctrlGroup]; _ctrlGroup ctrlSetPosition [0.5, 0.5, 0, 0]; _ctrlGroup ctrlCommit 0; _ctrlBackground ctrlSetPosition [0, 0, 0.5, 0.5]; _ctrlBackground ctrlSetBackgroundColor [0.5, 0.5, 0.5, 0.9]; _ctrlBackground ctrlSetText "ENTER TEXT:"; _ctrlBackground ctrlEnable false; _ctrlBackground ctrlCommit 0; _ctrlEdit ctrlSetPosition [0.01, 0.05, 0.48, 0.34]; _ctrlEdit ctrlSetBackgroundColor [0, 0, 0, 0.5]; _ctrlEdit ctrlCommit 0; _ctrlButton ctrlSetPosition [0.185, 0.42, 0.13, 0.05]; _ctrlButton ctrlCommit 0; _ctrlButton ctrlSetText "SUBMIT"; _ctrlButton ctrlAddEventHandler ["ButtonClick", { params ["_ctrl"]; _display = ctrlParent _ctrl; _text = ctrlText (_display displayCtrl IDD_EDIT_BOX); if (_text == "") then { _text = "EMPTY" }; hint _text; _display closeDisplay 1; }]; ctrlSetFocus _ctrlEdit; _ctrlGroup ctrlSetPosition [0.25, 0.25, 0.5, 0.5]; _ctrlGroup ctrlCommit 0.1; playSound "Hint3";
- Example 6:
- // since Arma 3 v2.14 findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate [configFile >> "RscDisplayBootcampMsgBox" >> "controls" >> "BootcampMessageBox", -1];
Additional Information
- See also:
- ctrlMapSetPosition allControls allDisplays controlsGroupCtrl ctrlDelete ctrlModel ctrlSetModel ctrlPosition ctrlSetPosition ctrlClassName ctrlModelScale ctrlSetModelScale ctrlModelDirAndUp ctrlSetModelDirAndUp displayParent
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note