BIS_fnc_guiMessage

1.00

Hover & click on the images for description

Description

Description:

Shows customized native message box to user

Execution:

call

Groups:

Uncategorised

Syntax

Syntax:

[message, (header, position, isCancel, parent, pause)] call BIS_fnc_guiMessage;

Parameters:

Take On Helicopters

message:
String or Structured Text - message
Array - listbox, every item is defined as String (enabled) or String in Array (disabled)

When variable BIS_fnc_guiMessage_cursel is defined and is Number, item with index equal to the variable will be selected by default.

header (Optional): String or Structured Text - header text

position (Optional): Array - position in format [x,y,w,h]

isCancel (Optional): Boolean or Array - true to display cancel button or array with button texts [okText,cancelText]

parent (Optional): Display - parent display

pause (Optional): Boolean - true to pause simulation when message window is open

Return Value:

Array - [endState, (lbId)]

• endState: Boolean - true when clicked OK button, false when escaped or clicked on Cancel button
• lbId: Number - selected listbox item (when listbox was used)

Returned only after message box is closed.

Alternative Syntax

Syntax:

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

Parameters:

Arma 3

message (Optional): String or Structured Text - message

header (Optional): String - header text

okButton (Optional):
Boolean - enable "OK" button (default: true)
String - custom text for "OK" button

cancelButton (Optional):
Boolean - enable "Cancel" button (default: false)
String - custom text for "Cancel" button

parent (Optional): Display - parent display

useParentBox (Optional): Boolean - try to use control inherited from "RscMessageBox" in parent instead of creating a new one (default: false)

pause (Optional): Boolean - pause simulation when message box is open (default: true, 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:

["Message","Header",nil,true] spawn BIS_fnc_guiMessage; Result:

Example 3:

[["Enabled Item",["Disabled Item"]],"Header"] spawn BIS_fnc_guiMessage; // TKOH

Example 4:

_result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage; // Arma 3

Additional Information

See also:

hintCBIS_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

Bottom Section

Posted on June 24, 2014 - 00:43 (UTC)

AgentRevolution

Message boxes can be force-closed with: uiNamespace setVariable ["BIS_fnc_guiMessage_status", false];