BIS_fnc_guiMessage
Jump to navigation
Jump to search
Take On Helicopters
Arma 3
Description
Syntax
- Syntax:
- [message, header, position, isCancel, parent, pause] spawn BIS_fnc_guiMessage
- Parameters:
- message: String, Structured Text or Array:
- String or Structured Text - message
- Array - listbox, every item is defined as String (enabled) or String in Array (disabled)
- header: String or Structured Text - (Optional, default "") header text
- position: Array - (Optional) position in format [x,y,w,h]
- isCancel: Boolean or Array - (Optional, default true) true to display cancel button or array with button texts [okText, cancelText]
- parent: Display - (Optional) parent display
- pause: Boolean - (Optional) true to pause simulation when message window is open
- Return Value:
- Array - [endState, lbId] Returned only after message box is closed.
Examples
- Example 1:
["Hello World"] spawn BIS_fnc_guiMessage;
- Example 2:
-
["Message", "Header", nil, true] spawn BIS_fnc_guiMessage;
- Example 3:
[["Enabled Item", ["Disabled Item"]], "Header"] spawn BIS_fnc_guiMessage;
Additional Information
- See also:
- hintC BIS_fnc_GUIhint
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
Description
- Description:
-
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: String or Structured Text - (Optional, default: "") message
- header: String - (Optional, default: "") header text
- okButton Boolean or String - (Optional, default true):
- cancelButton: Boolean or String - (Optional, default false):
- 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)
- Return Value:
- 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."; };
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.