closeDisplay: Difference between revisions

Latest revision as of 11:11, 1 July 2022

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:

Closes given display with exit code. It does not instantly close the display but does it on next simulation cycle. Most common exit codes are:

#define IDC_OK		1 // emulate "OK" button
#define IDC_CANCEL	2 // emulate "Cancel" button

⚠

Sometimes when one display is opened on top of another display the previous display may not close properly; some display EHs such as "onUnload" may never fire. Use this command to manually handle such displays.

Groups:

GUI Control

Syntax

Syntax:: display closeDisplay exitCode
Parameters:: display: Display
: exitCode: Number
Return Value:: Nothing

Examples

Example 1:: _display closeDisplay 1;
Example 2:: #define IDC_OK 1 _display closeDisplay IDC_OK;

Additional Information

See also:: createDisplay closeDialog

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

@@ Line 1: / Line 1: @@
-{{Command|Comments=
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |Game name=
+|game1= arma1
+|version1= 1.00
-|1.00|Game version=
+|game2= arma2
-____________________________________________________________________________________________
+|version2= 1.00
-| Closes given display with exit code. It does not instantly close the display but does it on next simulation cycle. Most common exit codes are:
+|game3= arma2oa
-<code>#define IDC_OK            1 //emulate "Ok" button</code>
+|version3= 1.50
-<code>#define IDC_CANCEL        2 //emulate "Cancel" button</code>
-{{Important | Sometimes when one display is opened on top of another display, previous display may not close properly, i.e. some display EHs such as "onUnload" may never fire. Use this command to manually handle such displays.}} |DESCRIPTION=
-____________________________________________________________________________________________
-| display '''closeDisplay''' exitcode |SYNTAX=
+|game4= tkoh
+|version4= 1.00
-|p1= display: [[Display]] |PARAMETER1=
+|game5= arma3
+|version5= 0.50
-|p2= exitcode: [[Number]] |PARAMETER2=
+|gr1= GUI Control
-| [[Nothing]] |RETURNVALUE=
+|descr= Closes given display with exit code. It does not instantly close the display but does it on next simulation cycle. Most common exit codes are:
-____________________________________________________________________________________________
+<syntaxhighlight lang="cpp">
+#define IDC_OK		1 // emulate "OK" button
-|x1= <code>_display [[closeDisplay]] 1;</code> |EXAMPLE1=
+#define IDC_CANCEL	2 // emulate "Cancel" button
+</syntaxhighlight>
+{{Feature|important|Sometimes when one display is opened on top of another display the previous display may not close properly; some display EHs such as "onUnload" may never fire.
+Use this command to manually handle such displays.}}
-|x2= <code>#define IDC_OK 1
+|s1= display [[closeDisplay]] exitCode
-_display [[closeDisplay]] IDC_OK;</code> |EXAMPLE1=
-____________________________________________________________________________________________
-|[[createDisplay]], [[closeDialog]]|SEEALSO=
+|p1= display: [[Display]]
-}}
+|p2= exitCode: [[Number]]
-<h3 style="display:none">Notes</h3>
+|r1= [[Nothing]]
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>_display closeDisplay 1;</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x2= <sqf>
+#define IDC_OK 1
+_display closeDisplay IDC_OK;
+</sqf>
-[[Category:Scripting Commands|CLOSEDISPLAY]]
+|seealso= [[createDisplay]] [[closeDialog]]
-[[Category:Scripting Commands ArmA|CLOSEDISPLAY]]
+}}
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
-<!-- CONTINUE Notes -->
-<!-- DISCONTINUE Notes -->