BIS fnc halt: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *L([a-z ])" to "$1 - l$2")
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| tkoh |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|gr1= Program Flow
____________________________________________________________________________________________


| <pre>/*
|descr= Halts current function and all its parents and logs an error message.


Description:
|s1= [param1, param2, ..., param10] call [[BIS_fnc_halt]]
Halts current function and all it's parents and shows an error message.


Parameter(s):
|p1= param1: [[String]] - logged message ([[format|formatted]])
_this select 0: STRING - Formatted message
_this select n (Optional): ANY - additional parameters


Returns:
|p2= param2 - param10: [[Anything]]
NOTHING
*/


//--- Display log message
|r1= [[Boolean]]
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_halt]]; --> |= Syntax
|x1= <sqf>["You are now supposed to be %1", rank player] call BIS_fnc_halt;</sqf>
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Debug|{{uc:halt}}]]
[[Category:Functions|{{uc:halt}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:halt}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:halt}}]]

Latest revision as of 16:38, 8 November 2023

tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Halts current function and all its parents and logs an error message.
Execution:
call
Groups:
Program Flow

Syntax

Syntax:
[param1, param2, ..., param10] call BIS_fnc_halt
Parameters:
param1: String - logged message (formatted)
param2 - param10: Anything
Return Value:
Boolean

Examples

Example 1:
["You are now supposed to be %1", rank player] call BIS_fnc_halt;

Additional Information

See also:
See also needed

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_halt&oldid=348819"