Difference between revisions of "BIS fnc guiMessage"

From Bohemia Interactive Community
Jump to navigation Jump to search
(shorten revolution to rev)
(Remove TKOH content)
(18 intermediate revisions by 5 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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Shows customized native message box to user |= 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'')] call BIS_fnc_guiMessage; |= Syntax
+
| [message, header, okButton, cancelButton, parent, useParentBox, pause)] spawn [[BIS_fnc_guiMessage]]
|p1= [[File:TKOH_version.gif|bottom|link=]] <span style="vertical-align: top; font-weight: bold">Take On Helicopters</span>
 
|p2= '''message''':
 
<br />[[String]] or [[Structured Text]] - message
 
<br />[[Array]] - listbox, every item is defined as [[String]] (enabled) or [[String]] in [[Array]] (disabled)
 
<br />
 
<br />When variable '''BIS_fnc_guiMessage_cursel''' is defined and is [[Number]], item with index equal to the variable will be selected by default. |=
 
|p3= '''header''' (Optional): [[String]] or [[Structured Text]] - header text |=
 
|p4= '''position''' (Optional): [[Array]] - position in format [x,y,w,h] |=
 
|p5= '''isCancel''' (Optional): [[Boolean]] or [[Array]] - true to display cancel button or array with button texts [okText,cancelText] |=
 
|p6= '''parent''' (Optional): [[Display]] - parent display |=
 
|p7= '''pause''' (Optional): [[Boolean]] - true to pause simulation when message window is open |=
 
  
| [[Array]] - [endState, (lbId)]
+
|p1= message: [[String]] or [[Structured Text]] - (Optional, default "") message
* endState: [[Boolean]] - [[true]] when clicked OK button, [[false]] when escaped or clicked on Cancel button
+
 
* lbId: [[Number]] - selected listbox item (when listbox was used)
+
|p2= header: [[String]] - (Optional) header text
Returned only after message box is closed.|= Return value
 
____________________________________________________________________________________________
 
  
|s2= [(''message'', ''header'', ''okButton'', ''cancelButton'', ''parent'', ''useParentBox'', ''pause'')] call BIS_fnc_guiMessage; |= Alternative Syntax
+
|p3= okButton: [[Boolean]] or [[String]] (Optional, default [[true]])
|p21= [[File:arma3_release_version.gif|link=]] <span style="vertical-align: top; font-weight: bold">Arma 3</span>
+
* [[Boolean]] - enable "OK" button
|p22= '''message''' (Optional): [[String]] or [[Structured Text]] - message |=
+
* [[String]] - custom text for "OK" button
|p23= '''header''' (Optional): [[String]] - header text |=
 
|p24= '''okButton''' (Optional):
 
<br />[[Boolean]] - enable "OK" button (default: true)
 
<br />[[String]] - custom text for "OK" button |=
 
|p25= '''cancelButton''' (Optional):
 
<br />[[Boolean]] - enable "Cancel" button (default: false)
 
<br />[[String]] - custom text for "Cancel" button |=
 
|p26= '''parent''' (Optional): [[Display]] - parent display |=
 
|p27= '''useParentBox''' (Optional): [[Boolean]] - try to use control inherited from "RscMessageBox" in parent instead of creating a new one (default: false) |=
 
|p28= '''pause''' (Optional): [[Boolean]] - pause simulation when message box is open (default: true, no effect in multiplayer)|=
 
  
|r2= [[Boolean]] - true if "OK" button was pressed, otherwise false
+
|p4= cancelButton: [[Boolean]] or [[String]] - (Optional, default [[false]])
<br />Returned only after message box is closed.|= Return value
+
* [[Boolean]] - enable "Cancel" button
____________________________________________________________________________________________
+
* [[String]] - custom text for "Cancel" button
 
 
|x1= <code>["Hello World"] spawn BIS_fnc_guiMessage;</code>|=
 
  
|x2= <code>["Message","Header",nil,true] spawn BIS_fnc_guiMessage;</code>
+
|p5= parent: [[Display]] - (Optional, default [[displayNull]]) parent display
Result:<br />
 
[[File:TakeOn BIS fnc guiMessage.jpg|200px]]|=
 
  
|x3= <code>[["Enabled Item",["Disabled Item"]],"Header"] spawn BIS_fnc_guiMessage; // TKOH</code>|=
+
|p6= useParentBox: [[Boolean]] - (Optional, default [[false]]) try to use control inherited from "RscMessageBox" in parent instead of creating a new one
  
|x4= <code>_result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage; // Arma 3</code>|=
+
|p7= pause: [[Boolean]] - (Optional, default [[true]]) pause simulation when message box is open (no effect in multiplayer)
  
 +
| [[Boolean]] - [[true]] if "OK" button was pressed, otherwise false. Returned only after message box is closed. |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[hintC]], [[BIS_fnc_GUIhint]] |= See also
+
|x1= <code>["Hello World"] [[spawn]] [[BIS_fnc_guiMessage]];</code> |EXAMPLE1=
 +
 
 +
|x2= <code>_result = ["Are you sure?", "Confirm", [[true]], [[true]]] [[call]] [[BIS_fnc_guiMessage]];</code> |EXAMPLE2=
 +
____________________________________________________________________________________________
  
 +
| [[hintC]], [[BIS_fnc_GUIhint]]
 
}}
 
}}
  
Line 67: Line 46:
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
  
<!-- Note Section END -->
 
</dl>
 
 
<h3 style="display:none">Bottom Section</h3>
 
 
[[Category:Functions|guiMessage]]
 
[[Category:Take_On_Helicopters:_Functions|guiMessage]]
 
[[Category:Arma_3:_Functions|guiMessage]]
 
[[Category:Function Group: GUI|guiMessage]]
 
 
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on June 24, 2014 - 00:43 (UTC)</dd>
 
<dd class="notedate">Posted on June 24, 2014 - 00:43 (UTC)</dd>
 
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
 
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
 
<dd class="note">
 
<dd class="note">
 
Message boxes can be force-closed with:
 
Message boxes can be force-closed with:
<code>uiNamespace setVariable ["BIS_fnc_guiMessage_status", false];</code>
+
<code>[[uiNamespace]] [[setVariable]] ["BIS_fnc_guiMessage_status", [[false]]];</code>
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on January 13, 2016 - 15:16 (UTC)</dd>
 
<dd class="notedate">Posted on January 13, 2016 - 15:16 (UTC)</dd>
 
<dt class="note">[[User:Eden|Eden]]</dt>
 
<dt class="note">[[User:Eden|Eden]]</dt>
Line 95: Line 58:
 
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:
 
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
+
<code>[] [[spawn]]
 
{
 
{
   _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage;
+
   [[private]] _result = ["Are you sure?", "Confirm", [[true]], [[true]]] [[call]] [[BIS_fnc_guiMessage]];
    
+
   {{cc|Use _result here}}
  //use _result here
+
};</code>
}</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>
 
</dd>
 +
 +
<!-- Note Section END -->
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
+
 
 +
<h3 style="display:none">Bottom Section</h3>
 +
 
 +
[[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