BIS fnc guiMessage: Difference between revisions
Jump to navigation
Jump to search
m (minor edit (self note)) |
m (template:command argument fix) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Shows customized native message box to user |= | | Shows customized native message box to user |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [message, (''header'', ''position'', ''isCancel'', ''parent'', ''pause'')] call BIS_fnc_guiMessage; |= | | [message, (''header'', ''position'', ''isCancel'', ''parent'', ''pause'')] call BIS_fnc_guiMessage; |SYNTAX= | ||
|p1= [[File:TKOH_version.gif|bottom|link=]] <span style="vertical-align: top; font-weight: bold">Take On Helicopters</span> | |p1= [[File:TKOH_version.gif|bottom|link=]] <span style="vertical-align: top; font-weight: bold">Take On Helicopters</span> | ||
|p2= '''message''': | |p2= '''message''': | ||
| Line 26: | Line 26: | ||
* endState: [[Boolean]] - [[true]] when clicked OK button, [[false]] when escaped or clicked on Cancel button | * endState: [[Boolean]] - [[true]] when clicked OK button, [[false]] when escaped or clicked on Cancel button | ||
* lbId: [[Number]] - selected listbox item (when listbox was used) | * lbId: [[Number]] - selected listbox item (when listbox was used) | ||
Returned only after message box is closed.|= | Returned only after message box is closed.|RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 44: | Line 44: | ||
|r2= [[Boolean]] - true if "OK" button was pressed, otherwise false | |r2= [[Boolean]] - true if "OK" button was pressed, otherwise false | ||
<br />Returned only after message box is closed.|= | <br />Returned only after message box is closed.|RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 59: | Line 59: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[hintC]], [[BIS_fnc_GUIhint]] |= | | [[hintC]], [[BIS_fnc_GUIhint]] |SEEALSO= | ||
}} | }} | ||
Revision as of 11:28, 7 April 2019
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)] 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
Notes
Bottom Section
- 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 { _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage; //use _result here }
- Posted on January 13, 2016 - 19:38 (UTC)
- Revo
- That's how it looks in Arma 3 Screenshot --Revo (talk) 20:38, 13 January 2016 (CET)
- 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.