BIS fnc 3DENShowMessage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])= ([^ ]+) (\[\[call\]\]) ([^ ]+) " to "|s$1= $2 call $4 ")
(more info and another example how to skip optional parameters)
Line 6: Line 6:
|gr1= Eden Editor
|gr1= Eden Editor


|descr= Shows a pop-up message.
|descr= Shows a pop-up message. In case one wants to add custom code to the buttons but preserve the localized text, use the following stringtable entries:
* <tt>"STR_DISP_OK"</tt>
* <tt>"STR_DISP_CLOSE"</tt>
* <tt>"STR_DISP_CANCEL"</tt>
In order to skip any optional parameter in between other parameters, send [[nil]] as parameter.


|s1= [text, title, buttonOK, buttonCancel, icon] call [[BIS_fnc_3DENShowMessage]]
|s1= [text, title, buttonOK, buttonCancel, icon] call [[BIS_fnc_3DENShowMessage]]
Line 39: Line 43:
{BIS_Message_Confirmed = [[false]]}
{BIS_Message_Confirmed = [[false]]}
],
],
"\A3\ui_f\data\map\markers\handdrawn\warning_CA.paa",
[[findDisplay]] 313
] [[call]] [[BIS_fnc_3DENShowMessage]]; {{cc|A confirm window}}</code>
|x2= <code>{{cc|Only change the OK button's code}}
[
"Are you sure you want to delete / modify the selected variables?",
"Delete / Modify",
[
[[nil]],
{BIS_Message_Confirmed = [[true]]}
],
[[nil]],
"\A3\ui_f\data\map\markers\handdrawn\warning_CA.paa",
"\A3\ui_f\data\map\markers\handdrawn\warning_CA.paa",
[[findDisplay]] 313
[[findDisplay]] 313

Revision as of 11:05, 28 June 2021

Hover & click on the images for description

Description

Description:
Shows a pop-up message. In case one wants to add custom code to the buttons but preserve the localized text, use the following stringtable entries:
  • "STR_DISP_OK"
  • "STR_DISP_CLOSE"
  • "STR_DISP_CANCEL"
In order to skip any optional parameter in between other parameters, send nil as parameter.
Execution:
call
Groups:
Eden Editor

Syntax

Syntax:
[text, title, buttonOK, buttonCancel, icon] call BIS_fnc_3DENShowMessage
Parameters:
text: String - Text to display
title: String - (Optional, default "") Title header
buttonOK: String - (Optional, default "") If String then it is the text of the button. Can also be Array in format:
0: String - Text
1: Code - Code executed when button is pressed
buttonCancel: String - (Optional, default "") Same as buttonOK
icon: String - (Optional, default "") Path to an icon which will be shown on the left side of the message
parentDisplay: Display - (Optional, default findDisplay 313 (Display Eden)) Display from which the window is opened from
Return Value:
Display

Examples

Example 1:
["Message","Title of the Message"] call BIS_fnc_3DENShowMessage;
Example 2:
// Only change the OK button's code [ "Are you sure you want to delete / modify the selected variables?", "Delete / Modify", [ nil, {BIS_Message_Confirmed = true} ], nil, "\A3\ui_f\data\map\markers\handdrawn\warning_CA.paa", findDisplay 313 ] call BIS_fnc_3DENShowMessage; // A confirm window

Additional Information

See also:
BIS_fnc_guiMessage

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