createDialog: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(83 intermediate revisions by 14 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"> '''createDialog ''name'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


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


'''name:''' [[String]]
|game5= arma2oa
|version5= 1.50


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


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


'''Compatibility:'''
|eff= local


Added in version '''1.50'''
|gr1= GUI Control


'''Description:'''
|descr= Creates a dialog which is defined either in the mission's [[Description.ext|description.ext]], in the campaign's description.ext or in the global [[Resource.cpp/bin|resource.cpp]]. The given name has to be the class name used in one of these files. If another dialog is already opened, the desired dialog is created as a child dialog of the one already opened.


Create user [[dialog]] from resource template '''name'''.<br>
{{Feature|informative|By default, displays created with [[createDisplay]] are rendered on top of dialogs created with [[createDialog]]. If ''forceOnTop'' is set to [[true]], the dialog will be rendered on top of displays.}}
If user [[dialog]] already exists, creates child [[dialog]] of topmost user [[dialog]].<br>
Class '''name''' is searched for in [[description.ext]] of mission, [[description.ext]] of campaign and global [[resource.cpp]].<br>
Returns success.


|s1= [[createDialog]]  dialogName


'''Example:'''
|p1= dialogName: [[String]] - class name used in the description.ext, resource.cpp or config.cpp
_ok = '''createDialog''' "RscDisplayGame"
 
|r1= [[Boolean]] -  [[true]] when the dialog was created successfully
 
|s2= [[createDialog]] [dialogName, forceOnTop]
 
|s2since= arma3 2.08
 
|p21= dialogName: [[String]] - class name used in the description.ext, resource.cpp or config.cpp
 
|p22= forceOnTop: [[Boolean]] - (Optional, default [[false]]) if [[true]], dialog will be rendered on top of displays
 
|r2= [[Display]] - created dialog
 
|x1= <sqf>
private _ok = createDialog "RscDisplayGame";
if (!_ok) then { hint "Dialog could not be opened!" };
</sqf>
 
|seealso= [[displayCtrl]] [[createDisplay]] [[closeDialog]] [[dialog]] [[displayNull]] [[controlNull]] [[ctrlCreate]] [[displayParent]]
}}
 
{{Note
|user= Killzone_Kid
|timestamp= 20170729090400
|text= A user dialog created with [[createDisplay]] over mission display ([[findDisplay]] 46) will stop [[displayAddEventHandler|display event handlers]] added to mission display from firing. However if it is created with [[createDialog]] then the event handlers continue to work.
}}

Latest revision as of 01:02, 19 March 2023

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Creates a dialog which is defined either in the mission's description.ext, in the campaign's description.ext or in the global resource.cpp. The given name has to be the class name used in one of these files. If another dialog is already opened, the desired dialog is created as a child dialog of the one already opened.
ⓘ
By default, displays created with createDisplay are rendered on top of dialogs created with createDialog. If forceOnTop is set to true, the dialog will be rendered on top of displays.
Groups:
GUI Control

Syntax

Syntax:
createDialog dialogName
Parameters:
dialogName: String - class name used in the description.ext, resource.cpp or config.cpp
Return Value:
Boolean - true when the dialog was created successfully

Alternative Syntax

Syntax:
createDialog [dialogName, forceOnTop]
Parameters:
dialogName: String - class name used in the description.ext, resource.cpp or config.cpp
forceOnTop: Boolean - (Optional, default false) if true, dialog will be rendered on top of displays
Return Value:
Display - created dialog

Examples

Example 1:
private _ok = createDialog "RscDisplayGame"; if (!_ok) then { hint "Dialog could not be opened!" };

Additional Information

See also:
displayCtrl createDisplay closeDialog dialog displayNull controlNull ctrlCreate 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
Killzone_Kid - c
Posted on Jul 29, 2017 - 09:04 (UTC)
A user dialog created with createDisplay over mission display (findDisplay 46) will stop display event handlers added to mission display from firing. However if it is created with createDialog then the event handlers continue to work.
Retrieved from "https://community.bistudio.com/wiki?title=createDialog&oldid=338553"