BIS_fnc_guiMessage

From Bohemia Interactive Community
Revision as of 12:04, 19 May 2021 by Ansin11 (talk | contribs) (Upgraded page to level 2 (and fixed some errors and clarified some things here and there!))
Jump to: navigation, search
tkoh logo small.png Take On Helicopters
Arma 3 logo black.png Arma 3
Hover & click on the images for description

Description

Description:
BIS_fnc_guiMessage message dialog in Arma 3
Displays an interactive message dialog in the center of the screen.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[message, header, okButton, cancelButton, parent, useParentBox, pause] call BIS_fnc_guiMessage
Parameters:
message (Optional, default: ""): String or Structured Text - Message
header (Optional): String - Header text
okButton (Optional, default: true):
  • Boolean - Enable the "OK" button
  • String - Custom text for the "OK" button
cancelButton (Optional, default: false):
  • Boolean - Enable the "Cancel" button
  • String - Custom text for the "Cancel" button
parent (Optional, default: displayNull): Display - Parent display
useParentBox (Optional, default: false): Boolean - Try to use control inherited from "RscMessageBox" in parent instead of creating a new one
pause (Optional, default: true): Boolean - Pause simulation while message dialog is open (no effect in multiplayer)
Return Value:
Boolean - True if the "OK" button was pressed, otherwise false. Returned only after message box is closed.

Examples

Example 1:
Because this example uses spawn, the return value of BIS_fnc_guiMessage is lost and can not be used. ["Hello World"] spawn BIS_fnc_guiMessage;
Example 2:
private _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage; if (_result) then { systemChat "Player is sure."; } else { systemChat "Player is not sure."; };

Additional Information

See also:
BIS_fnc_GUIhint BIS_fnc_3DENShowMessage hintC

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
Posted on June 24, 2014 - 00:43 (UTC)
AgentRev
Message boxes can be force-closed with: uiNamespace setVariable ["BIS_fnc_guiMessage_status", false];
Posted on January 13, 2016 - 15:16 (UTC)
Eden
Calling this function can cause an game crash. When doing this you have to spawn the function or add an spawn around it so you can use the result: [] spawn { private _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage; // Use _result here };
Posted on November 1, 2017 - 18:35 (UTC)
demellion
NOTE: This function only exists along with mission display (findDisplay 46). If this function is called before with -skipIntro parameter enabled (see Arma 3: Startup Parameters) it will result as Void.