closeDialog: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Dialog is not instantly closed (copied from closeDisplay))
 
(59 intermediate revisions by 13 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97]]
[[Category:Scripting Commands ArmA]]


back to [[Scripting_Reference#C|COMREF]]
|game1= ofp
|version1= 1.75


<h2 style="color:#000066"> '''closeDialog ''idc'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''idc:''' [[Number]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Compatibility:'''
|arg= local


Added in version '''1.50'''
|eff= local


'''Description:'''
|gr1= GUI Control


Close topmost user [[dialog]] as if button with id '''idc''' was pressed.
|descr= Closes the currently active dialog with exit code. It does not instantly close the dialog but does it on next simulation cycle. Most common exit codes are:
<syntaxhighlight lang="cpp">
#define IDC_OK 1 // emulate "OK" button
#define IDC_CANCEL 2 // emulate "Cancel" button
</syntaxhighlight>


|s1= [[closeDialog]]  exitcode


'''Example:'''
|p1= exitcode: [[Number]]


'''closeDialog''' 1
|r1= [[Nothing]]
 
|x1= <sqf>closeDialog 2;</sqf>
 
|x2= <sqf>
#define IDC_CANCEL 2
closeDialog IDC_CANCEL;
</sqf>
 
|seealso= [[createDialog]] [[dialog]] [[closeDisplay]]
}}

Latest revision as of 00:42, 12 November 2023

Hover & click on the images for description

Description

Description:
Closes the currently active dialog with exit code. It does not instantly close the dialog 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
Groups:
GUI Control

Syntax

Syntax:
closeDialog exitcode
Parameters:
exitcode: Number
Return Value:
Nothing

Examples

Example 1:
closeDialog 2;
Example 2:
#define IDC_CANCEL 2 closeDialog IDC_CANCEL;

Additional Information

See also:
createDialog dialog closeDisplay

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