BIS fnc halo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(32 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma2oa |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/*
|version4= 0.50
File: fn_HALO.sqf


Description:
|gr1= Systems
High Altitude Low Opening


Parameter(s):
|descr= Makes a High Altitude Low Opening (HALO) parachute jump.
_this: ARRAY - starts HALO jump directly
{{Feature|arma3|HALO feature is already implemented in {{arma3}}. Using this function will result in incorrect behaviour and animation.}}
OBJECT - waits until unit in array is out of vehicle


Returns:
|s1= [unit, altitude] call [[BIS_fnc_halo]]
Nothing
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= unit: [[Object]] - the HALO-performing unit
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_halo]]; --> |= Syntax
|p2= altitude: [[Number]] - (Optional, default 0) altitude added to the unit before HALO


|p1= |= Parameter 1
|r1= [[Nothing]]


| |= Return value
|x1= <sqf>[player] call BIS_fnc_halo; // instantly parachutes the player object</sqf>
____________________________________________________________________________________________


|x1= <code></code> |=
|x2= <sqf>[player, 100] call BIS_fnc_halo; // increases the altitude of player by 100 before HALO</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso= [[setUnitFreefallHeight]] [[getUnitFreefallInfo]]
}}
}}
<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: Misc|{{uc:halo}}]]
[[Category:Functions|{{uc:halo}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:halo}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:halo}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:halo}}]]

Latest revision as of 15:04, 13 July 2022

Hover & click on the images for description

Description

Description:
Makes a High Altitude Low Opening (HALO) parachute jump.
Arma 3
HALO feature is already implemented in Arma 3. Using this function will result in incorrect behaviour and animation.
Execution:
call
Groups:
Systems

Syntax

Syntax:
[unit, altitude] call BIS_fnc_halo
Parameters:
unit: Object - the HALO-performing unit
altitude: Number - (Optional, default 0) altitude added to the unit before HALO
Return Value:
Nothing

Examples

Example 1:
[player] call BIS_fnc_halo; // instantly parachutes the player object
Example 2:
[player, 100] call BIS_fnc_halo; // increases the altitude of player by 100 before HALO

Additional Information

See also:
setUnitFreefallHeight getUnitFreefallInfo

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