BIS_fnc_guiMessage

From Bohemia Interactive Community
Revision as of 09:10, 21 October 2011 by Str (talk | contribs)
Jump to navigation Jump to search
Introduced with Take On Helicopters version 1.001.00
Hover & click on the images for descriptions

Description

Description:
Send function for remote execution (and executes locally if conditions are met) .

Syntax

Syntax:
[message, (header, position, isCancel, parent, pause)] spawn BIS_fnc_guiMessage;
Parameters:
message:
String - message
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
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 windows was closed.

Examples

Example 1:
["Hello World"] spawn BIS_fnc_guiMessage;
Example 2:
["Message","Header",nil,true] spawn BIS_fnc_guiMessage; Result:
TakeOn BIS fnc guiMessage.jpg
Example 3:
[["Enabled Item",["Disabled Item"]],"Header"] spawn BIS_fnc_guiMessage;

Additional Information

Execution:
spawn
See also:
See also needed
Groups:
Uncategorised

Notes

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

Notes

Bottom Section