BIS fnc halt: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *L([a-z ])" to "$1 - l$2")
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| TKOH
|game1= tkoh
|version1= 1.00


|1.00
|game2= arma3
|version2= 0.50


|gr1 = Program Flow
|gr1= Program Flow


| Halts current function and all it is parents and logs an error message.
|descr= Halts current function and all its parents and logs an error message.


| [param1,param2,...,param10] call bis_fnc_halt;
|s1= [param1, param2, ..., param10] call [[BIS_fnc_halt]]


|p1= param1: [[String]] - Logged message ([[format|formatted]]).
|p1= param1: [[String]] - logged message ([[format|formatted]])


|p2= param2 - param10: [[Anything]]
|p2= param2 - param10: [[Anything]]


| [[Boolean]]
|r1= [[Boolean]]
 
|x1= <code>["You are now supposed to be %1",[[rank]] [[player]]] [[call]] [[BIS_fnc_halt]];</code>


|
|x1= <sqf>["You are now supposed to be %1", rank player] call BIS_fnc_halt;</sqf>


|seealso=
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:halt}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:halt}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:halt}}]]

Latest revision as of 15:38, 8 November 2023

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