BIS fnc guiMessage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |x3=" to "|Example2= |x3=")
m (Text replacement - "BIS fnc " to "BIS_fnc_")
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{TabView
____________________________________________________________________________________________


| TKOH |Game name=
|selected= 2


|1.00|Game version=
|title1= {{TabView/GameTitle|tkoh}}
____________________________________________________________________________________________
|content1=
{{RV|type=function


| Shows customized native message box to user |DESCRIPTION=
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| [message, (''header'', ''position'', ''isCancel'', ''parent'', ''pause'')] call BIS_fnc_guiMessage; |SYNTAX=
|gr1= GUI
|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. |Parameter2=


|p3= '''header''' (Optional): [[String]] or [[Structured Text]] - header text |=
|descr= Shows customized native message box to user.
|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)]
|s1= [message, header, position, isCancel, parent, pause] spawn [[BIS_fnc_guiMessage]]
 
|p1= message: [[String]], [[Structured Text]] or [[Array]]:
* [[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 as a [[Number]], item with this index will be selected.
 
|p2= header: [[String]] or [[Structured Text]] - (Optional, default "") header text
 
|p3= position: [[Array]] - (Optional) position in format [x,y,w,h]
 
|p4= isCancel: [[Boolean]] or [[Array]] - (Optional, default [[true]]) [[true]] to display cancel button or array with button texts [okText, cancelText]
 
|p5= parent: [[Display]] - (Optional) parent display
 
|p6= pause: [[Boolean]] - (Optional) [[true]] to pause simulation when message window is open
 
|r1= [[Array]] - [endState, lbId]
* 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]] - (Optional, returned if listbox was used) selected listbox item
Returned only after message box is closed.|RETURNVALUE=
Returned only after message box is closed.
____________________________________________________________________________________________
 
|x1= <sqf>["Hello World"] spawn BIS_fnc_guiMessage;</sqf>
 
|x2= [[File:TakeOn BIS_fnc_guiMessage.jpg|right|200px]]
<sqf>["Message", "Header", nil, true] spawn BIS_fnc_guiMessage;</sqf>
 
|x3= <sqf>[["Enabled Item", ["Disabled Item"]], "Header"] spawn BIS_fnc_guiMessage;</sqf>


|s2= [(''message'', ''header'', ''okButton'', ''cancelButton'', ''parent'', ''useParentBox'', ''pause'')] call BIS_fnc_guiMessage; |= Alternative Syntax
|seealso= [[hintC]] [[BIS_fnc_GUIhint]]
|p21= [[File:arma3_release_version.gif|link=]] <span style="vertical-align: top; font-weight: bold">Arma 3</span>
|p22= '''message''' (Optional): [[String]] or [[Structured Text]] - message |=
|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
|exec= spawn
<br />Returned only after message box is closed.|RETURNVALUE=
}}
____________________________________________________________________________________________
 
|x1= <code>["Hello World"] spawn BIS_fnc_guiMessage;</code>|=


|x2= <code>["Message","Header",nil,true] spawn BIS_fnc_guiMessage;</code>
|title2= {{TabView/GameTitle|arma3}}
Result:<br />
|content2=
[[File:TakeOn BIS fnc guiMessage.jpg|200px]]|Example2=
{{RV|type=function


|x3= <code>[["Enabled Item",["Disabled Item"]],"Header"] spawn BIS_fnc_guiMessage; // TKOH</code>|=
|game1= arma3
|version1= 0.50


|x4= <code>_result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage; // Arma 3</code>|=
|eff= local


____________________________________________________________________________________________
|gr1= GUI


| [[hintC]], [[BIS_fnc_GUIhint]] |SEEALSO=
|descr= [[File:BIS_fnc_guiMessage.jpg|thumb|[[BIS_fnc_guiMessage]] dialog in {{arma3}}]]
Displays an interactive message dialog in the center of the screen.
{{Feature|important|This function internally utilizes suspension ([[waitUntil]] to be specific) and therefore has to be executed in a [[Scheduler#Scheduled_Environment|scheduled environment]].}}


}}
|exec= call
 
|s1= [message, header, okButton, cancelButton, parent, useParentBox, pause] call [[BIS_fnc_guiMessage]]
 
|p1= message: [[String]] or [[Structured Text]] - (Optional, default: "") message
 
|p2= header: [[String]] - (Optional, default: "") header text
 
|p3= okButton [[Boolean]] or [[String]] - (Optional, default [[true]]):
* [[Boolean]] - enable the "OK" button
* [[String]] - custom text for the "OK" button
 
|p4= cancelButton: [[Boolean]] or [[String]] - (Optional, default [[false]]):
* [[Boolean]] - enable the "Cancel" button
* [[String]] - custom text for the "Cancel" button
 
|p5= parent: [[Display]] - (Optional, default: <sqf inline>[] call BIS_fnc_displayMission</sqf>) parent display
 
|p6= useParentBox: [[Boolean]] - (Optional, default: [[false]]) try to use control inherited from "RscMessageBox" in parent instead of creating a new one


<h3 style="display:none">Notes</h3>
|p7= pause: [[Boolean]] - (Optional, default: [[true]]) pause simulation while message dialog is open (no effect in multiplayer)
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|r1= [[Boolean]] - [[true]] if the "OK" button was pressed, otherwise [[false]]. Returned only after the message box is closed.
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= Because this example uses [[spawn]], the return value of [[BIS_fnc_guiMessage]] is lost and can not be used.
<sqf>["Hello World"] spawn BIS_fnc_guiMessage;</sqf>


[[Category:Functions|guiMessage]]
|x2= <sqf>
[[Category:Take_On_Helicopters:_Functions|guiMessage]]
private _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage;
[[Category:Arma_3:_Functions|guiMessage]]
[[Category:Function Group: GUI|guiMessage]]


<!-- CONTINUE Notes -->
if (_result) then {
<dl class="command_description">
systemChat "The player is sure.";
<dd class="notedate">Posted on June 24, 2014 - 00:43 (UTC)</dd>
} else {
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
systemChat "The player is not sure.";
<dd class="note">
};
Message boxes can be force-closed with:
</sqf>
<code>uiNamespace setVariable ["BIS_fnc_guiMessage_status", false];</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
|seealso= [[BIS_fnc_GUIhint]] [[BIS_fnc_3DENShowMessage]] [[hintC]]
<dl class="command_description">
}}
<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
}}
 
{{Note
|user= AgentRev
|timestamp= 20140624004300
|text= Message boxes can be force-closed with:
<sqf>uiNamespace setVariable ["BIS_fnc_guiMessage_status", false];</sqf>
}}
 
{{Note
|user= Eden
|timestamp= 20160113151600
|text= 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:
<sqf>
[] spawn
{
{
  _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage;
private _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage;
 
// Use _result here
  //use _result here
};
}</code>
</sqf>
</dd>
}}
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Demellion
<dd class="notedate">Posted on January 13, 2016 - 19:38 (UTC)</dd>
|timestamp= 20171101183500
<dt class="note">[[User:Revo|Revo]]</dt>
|text= 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 class="note">
}}
That's how it looks in Arma 3
[http://i.imgur.com/WUZLaK1.jpg Screenshot]
--[[User:Revo|Revo]] ([[User talk:Revo|talk]]) 20:38, 13 January 2016 (CET)
</dd>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<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>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 11:15, 27 July 2022

tkoh logo small.png Take On Helicopters
Arma 3 logo black.png Arma 3
tkoh logo small.png1.00
Hover & click on the images for description

Description

Description:
Shows customized native message box to user.
Execution:
spawn
Groups:
GUI

Syntax

Syntax:
[message, header, position, isCancel, parent, pause] spawn BIS_fnc_guiMessage
Parameters:
message: String, Structured Text or Array: When variable BIS_fnc_guiMessage_cursel is defined as a Number, item with this index will be selected.
header: String or Structured Text - (Optional, default "") header text
position: Array - (Optional) position in format [x,y,w,h]
isCancel: Boolean or Array - (Optional, default true) true to display cancel button or array with button texts [okText, cancelText]
parent: Display - (Optional) parent display
pause: Boolean - (Optional) 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 - (Optional, returned if listbox was used) selected listbox item
Returned only after message box is closed.

Examples

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

Additional Information

See also:
hintC BIS_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
Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
BIS_fnc_guiMessage dialog in Arma 3

Displays an interactive message dialog in the center of the screen.

⚠
This function internally utilizes suspension (waitUntil to be specific) and therefore has to be executed in a scheduled environment.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[message, header, okButton, cancelButton, parent, useParentBox, pause] call BIS_fnc_guiMessage
Parameters:
message: String or Structured Text - (Optional, default: "") message
header: String - (Optional, default: "") header text
okButton Boolean or String - (Optional, default true):
  • Boolean - enable the "OK" button
  • String - custom text for the "OK" button
cancelButton: Boolean or String - (Optional, default false):
  • Boolean - enable the "Cancel" button
  • String - custom text for the "Cancel" button
parent: Display - (Optional, default: [] call BIS_fnc_displayMission) 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 while message dialog is open (no effect in multiplayer)
Return Value:
Boolean - true if the "OK" button was pressed, otherwise false. Returned only after the message box is closed.

Examples

Example 1:
Because this example uses spawn, the return value of BIS_fnc_guiMessage is lost and can not be used.
["Hello World"] spawn BIS_fnc_guiMessage;
Example 2:
private _result = ["Are you sure?", "Confirm", true, true] call BIS_fnc_guiMessage; if (_result) then { systemChat "The player is sure."; } else { systemChat "The player is not sure."; };

Additional Information

See also:
BIS_fnc_GUIhint BIS_fnc_3DENShowMessage hintC

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
AgentRev - c
Posted on Jun 24, 2014 - 00:43 (UTC)
Message boxes can be force-closed with:
uiNamespace setVariable ["BIS_fnc_guiMessage_status", false];
Eden - c
Posted on Jan 13, 2016 - 15:16 (UTC)
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 };
Demellion - c
Posted on Nov 01, 2017 - 18:35 (UTC)
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.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_guiMessage&oldid=329335"