BIS_fnc_guiMessage

From Bohemia Interactive Community
Revision as of 19:03, 23 April 2020 by Lou Montana (talk | contribs) (Remove TKOH content)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Introduced with Arma 3 version 1.001.00
Hover & click on the images for descriptions

Description

Description:
GUI message in Arma 3
Shows customized native message box to user.
This syntax is for Arma 3. For the Take On Helicopters version, see BIS_fnc_guiMessage TKOH.

Syntax

Syntax:
[message, header, okButton, cancelButton, parent, useParentBox, pause)] spawn BIS_fnc_guiMessage
Parameters:
message: String or Structured Text - (Optional, default "") message
header: String - (Optional) header text
okButton: Boolean or String (Optional, default true)
  • Boolean - enable "OK" button
  • String - custom text for "OK" button
cancelButton: Boolean or String - (Optional, default false)
  • Boolean - enable "Cancel" button
  • String - custom text for "Cancel" button
  • parent: Display - (Optional, default displayNull) 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 when message box is open (no effect in multiplayer)
    Return Value:
    Boolean - true if "OK" button was pressed, otherwise false. Returned only after message box is closed.

    Examples

    Example 1:
    ["Hello World"] spawn BIS_fnc_guiMessage;
    Example 2:
    _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage;

    Additional Information

    Execution:
    call
    See also:
    hintCBIS_fnc_GUIhint

    Notes

    i
    Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

    Notes

    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.

    Bottom Section