BIS fnc halo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


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


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


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


| Makes a High Altitude Low Opening (HALO) parachute jump.
|game4= arma3
{{Feature arma3|HALO feature is already implemented in Arma 3. Using this function will result in incorrect behaviour and animation.}} |DESCRIPTION=
|version4= 0.50
____________________________________________________________________________________________


| [unit, altitude] call [[BIS_fnc_halo]] |SYNTAX=
|gr1= Systems


|p1= unit: [[Object]] - the HALO performing unit |= Parameter 1
|descr= Makes a High Altitude Low Opening (HALO) parachute jump.
{{Feature|arma3|HALO feature is already implemented in {{arma3}}. Using this function will result in incorrect behaviour and animation.}}


|p2= altitude: [[Number]] - (Optional, default 0) altitude added to the unit before HALO |= Parameter 2
|s1= [unit, altitude] call [[BIS_fnc_halo]]


| [[Nothing]] |RETURNVALUE=
|p1= unit: [[Object]] - the HALO-performing unit
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[player]]] [[call]] [[BIS_fnc_halo]]; {{codecomment|// Instantly parachutes the player object}}</code> |= Example 1
|p2= altitude: [[Number]] - (Optional, default 0) altitude added to the unit before HALO


|x2= <code><nowiki>[</nowiki>player, 100] call BIS_fnc_halo; {{codecomment|// Increases the altitude of player by 100 before HALO}}</code> |= Example 2
|r1= [[Nothing]]
____________________________________________________________________________________________


| |SEEALSO=
|x1= <sqf>[player] call BIS_fnc_halo; // instantly parachutes the player object</sqf>
}}


<h3 style="display:none">Notes</h3>
|x2= <sqf>[player, 100] call BIS_fnc_halo; // increases the altitude of player by 100 before HALO</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[setUnitFreefallHeight]] [[getUnitFreefallInfo]]
</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 14:04, 13 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_halo&oldid=327955"