closeDisplay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "")
m (Fix example)
 
(4 intermediate revisions by the same user not shown)
Line 23: Line 23:
#define IDC_CANCEL 2 // emulate "Cancel" button
#define IDC_CANCEL 2 // emulate "Cancel" button
</syntaxhighlight>
</syntaxhighlight>
{{Feature | 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.}}
{{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.}}


|s1= display [[closeDisplay]] exitCode
|s1= display [[closeDisplay]] exitCode


|p1= display: [[Display]]
|p1= display: [[Display]]
Line 31: Line 32:
|p2= exitCode: [[Number]]
|p2= exitCode: [[Number]]


|r1=[[Nothing]]
|r1= [[Nothing]]


|x1= <code>_display [[closeDisplay]] 1;</code>
|x1= <sqf>_display closeDisplay 1;</sqf>


|x2= <code>#define IDC_OK 1
|x2= <sqf>
_display [[closeDisplay]] IDC_OK;</code>
#define IDC_OK 1
_display closeDisplay IDC_OK;
</sqf>


|seealso= [[createDisplay]], [[closeDialog]]
|seealso= [[createDisplay]] [[closeDialog]]
}}
}}

Latest revision as of 11:11, 1 July 2022

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