Difference between revisions of "BIS fnc guiMessage"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Created page with "{{Function|= Comments ____________________________________________________________________________________________ | TKOH |= Game name |1.00|= Game version ____________________...")
 
(Remove TKOH content)
(34 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Function|= Comments
+
{{Function|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| TKOH |= Game name
+
| arma3 |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Send function for remote execution (and executes locally if conditions are met) . |= Description
+
| [[File:BIS fnc guiMessage.jpg|thumb|right|GUI message in {{arma3}}]] Shows customized native message box to user.
 +
{{Informative | This syntax is for {{arma3}}. For the {{tkoh}} version, see [[BIS_fnc_guiMessage TKOH]].}} |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [message, (header, position, isCancel, parent, pause)] spawn BIS_fnc_guiMessage; |= Syntax
+
| [message, header, okButton, cancelButton, parent, useParentBox, pause)] spawn [[BIS_fnc_guiMessage]]
  
|p1= '''message''': [[String]] or [[Structured Text]] or [[Array]] - message or array of items (listbox will be displayed instead) |=
+
|p1= message: [[String]] or [[Structured Text]] - (Optional, default "") message
|p2= '''header''' (Optional): [[String]] or [[Structured Text]] - header |=
 
|p3= '''position''' (Optional): [[Array]] - position in format [x,y,w,h] |=
 
|p4= '''isCancel''' (Optional): [[Boolean]] or [[Array]] - true to display cancel button or array with button texts [okText,cancelText] |=
 
|p5= '''parent''' (Optional): [[Display]] - parent display |=
 
|p6= '''pause''' (Optional): [[Boolean]] - true to pause simulation when message window is open |=
 
  
| [[Array]] - [endState, (lbId)]
+
|p2= header: [[String]] - (Optional) header text
* endState: [[Boolean]] - true when clicked OK button, false when escaped or clocked on Cancel button
+
 
* lbId: [[Number]] - selected listbox item (when listbox was used)
+
|p3= okButton: [[Boolean]] or [[String]] (Optional, default [[true]])
Returned only after message windows was closed.|= Return value
+
* [[Boolean]] - enable "OK" button
____________________________________________________________________________________________
+
* [[String]] - custom text for "OK" button
 
+
 
|x1= <code>["Hello World"] spawn BIS_fnc_guiMessage;</code>|=
+
|p4= cancelButton: [[Boolean]] or [[String]] - (Optional, default [[false]])
 +
* [[Boolean]] - enable "Cancel" button
 +
* [[String]] - custom text for "Cancel" button
 +
 
 +
|p5= parent: [[Display]] - (Optional, default [[displayNull]]) parent display
 +
 
 +
|p6= useParentBox: [[Boolean]] - (Optional, default [[false]]) try to use control inherited from "RscMessageBox" in parent instead of creating a new one
  
|x2= <code>["Message","Header",nil,true] spawn BIS_fnc_guiMessage;</code>
+
|p7= pause: [[Boolean]] - (Optional, default [[true]]) pause simulation when message box is open (no effect in multiplayer)
Result:<br />
 
[[File:TakeOn BIS fnc guiMessage.jpg|200px]]|=
 
  
 +
| [[Boolean]] - [[true]] if "OK" button was pressed, otherwise false. Returned only after message box is closed. |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|exec= spawn |=
+
|x1= <code>["Hello World"] [[spawn]] [[BIS_fnc_guiMessage]];</code> |EXAMPLE1=
  
| |= See also
+
|x2= <code>_result = ["Are you sure?", "Confirm", [[true]], [[true]]] [[call]] [[BIS_fnc_guiMessage]];</code> |EXAMPLE2=
 +
____________________________________________________________________________________________
  
 +
| [[hintC]], [[BIS_fnc_GUIhint]]
 
}}
 
}}
  
Line 42: Line 45:
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 +
 +
<dd class="notedate">Posted on June 24, 2014 - 00:43 (UTC)</dd>
 +
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
 +
<dd class="note">
 +
Message boxes can be force-closed with:
 +
<code>[[uiNamespace]] [[setVariable]] ["BIS_fnc_guiMessage_status", [[false]]];</code>
 +
</dd>
 +
 +
<dd class="notedate">Posted on January 13, 2016 - 15:16 (UTC)</dd>
 +
<dt class="note">[[User:Eden|Eden]]</dt>
 +
<dd class="note">
 +
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:
 +
 +
<code>[] [[spawn]]
 +
{
 +
  [[private]] _result = ["Are you sure?", "Confirm", [[true]], [[true]]] [[call]] [[BIS_fnc_guiMessage]];
 +
  {{cc|Use _result here}}
 +
};</code>
 +
</dd>
 +
 +
<dd class="notedate">Posted on November 1, 2017 - 18:35 (UTC)</dd>
 +
<dt class="note">[[User:demellion|demellion]]</dt>
 +
<dd class="note">
 +
'''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]].
 +
</dd>
  
 
<!-- Note Section END -->
 
<!-- Note Section END -->
Line 48: Line 76:
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
  
[[Category:Take_On_Helicopters:_Functions|guiMessage]]
+
[[Category:Function Group: GUI|guiMessage]]

Revision as of 18:03, 23 April 2020

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
    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

    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