BIS_fnc_guiMessage

Description

Displays an interactive message dialog in the center of the screen.

Important

This function internally utilizes suspension (waitUntil to be specific) and therefore has to be executed in a scheduled environment.

Syntax

[message, header, okButton, cancelButton, parent, useParentBox, pause] call BIS_fnc_guiMessage

Parameters:

• message: String or Structured Text - (Optional, default: "") message
• header: String - (Optional, default: "") header text
• okButton Boolean or String - (Optional, default true):
  • Boolean - enable the "OK" button
  • String - custom text for the "OK" button
• cancelButton: Boolean or String - (Optional, default false):
  • Boolean - enable the "Cancel" button
  • String - custom text for the "Cancel" button
• parent: Display - (Optional, default: [] call BIS_fnc_displayMission) parent display
• useParentBox: Boolean - (Optional, default: false) try to use control inherited from "RscMessageBox" in parent instead of creating a new one
• pause: Boolean - (Optional, default: true) pause simulation while message dialog is open (no effect in multiplayer)

Returns: Boolean - true if the "OK" button was pressed, otherwise false. Returned only after the 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 "The player is sure.";
} else {
    systemChat "The player is not sure.";
};

See also

BIS_fnc_GUIhint · BIS_fnc_3DENShowMessage · hintC

uiNamespace setVariable ["BIS_fnc_guiMessage_status", false];

[] spawn
{
    private _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage;
    // Use _result here
};