BIS fnc ambientFlyby: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Added parameters, syntax and examples.)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Spawns an air unit that moves from point A to point B, never engaging nor being engaged. It is set as captive and will despawn once it reaches it's destination. |= Description
 
Description:
Spawns an ambient air unit, makes it move and deletes it when it reaches destination
Vehicle will never engage and will be flagged as captive
Good for simple creation of ambient fly by's
 
Parameter(s):
_this select 0: ARRAY - The position where vehicle will spawn
_this select 1: ARRAY - The end position of the vehicle, it will be deleted here
_this select 2: NUMBER - The spawn and flight height of the vehicle
_this select 3: STRING - The speed the vehicle will move ("LIMITED", "NORMAL", "FULL")
_this select 4: STRING - The classname of the vehicle to spawn
_this select 5: SIDE - The side the vehicle belongs
Returns:
BOOL - true on success
*/
 
//Params
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_ambientFlyby]]; --> |= Syntax
| <nowiki>[[0,0,0],[100,100,100],100,"NORMAL","B_Heli_Light_01_F",WEST]</nowiki> call '''BIS_fnc_ambientFlyby'''; |= Syntax


|p1= |= Parameter 1
|p1= [[Array]] - Array containing start position where air unit spawns. Format [x,y,z]. |=
|p2= [[Array]] - Array containing end position where air unit moves to and despawns. Format [x,y,z]. |=
|p3= [[Number]] - Height at which air unit will spawn and fly. |=
|p4= [[String]] - String detailing speed at which air unit travels. Possible values "LIMITED", "NORMAL" and "FULL". |=
|p5= [[String]] - Vehicle classname of air unit to spawn. Viewable in CfgVehicles. |=
|p6= [[Side]] - Side which vehicle belongs to. |=


| |= Return value
| [[Boolean]] - True if function executed successfully. |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code><nowiki>ambientFly = [[200,200,200],[250,250,250]]</nowiki> call BIS_fnc_ambientFlyBy; // This spawns a Littlebird that flies from position 200,200,200 to 250,250,250 at height 100 and Normal speed.</code> |=
|x2 = <code><nowiki>ambientFly = [getposATL player, getposATL opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", WEST]</nowiki> call BIS_fnc_ambientFlyBy;</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 20:16, 29 September 2014


Hover & click on the images for description

Description

Description:
Spawns an air unit that moves from point A to point B, never engaging nor being engaged. It is set as captive and will despawn once it reaches it's destination.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[[0,0,0],[100,100,100],100,"NORMAL","B_Heli_Light_01_F",WEST] call BIS_fnc_ambientFlyby;
Parameters:
Array - Array containing start position where air unit spawns. Format [x,y,z].
Array - Array containing end position where air unit moves to and despawns. Format [x,y,z].
Number - Height at which air unit will spawn and fly.
String - String detailing speed at which air unit travels. Possible values "LIMITED", "NORMAL" and "FULL".
String - Vehicle classname of air unit to spawn. Viewable in CfgVehicles.
Side - Side which vehicle belongs to.
Return Value:
Boolean - True if function executed successfully.

Examples

Example 1:
ambientFly = [[200,200,200],[250,250,250]] call BIS_fnc_ambientFlyBy; // This spawns a Littlebird that flies from position 200,200,200 to 250,250,250 at height 100 and Normal speed.
Example 2:
ambientFly = [getposATL player, getposATL opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", WEST] call BIS_fnc_ambientFlyBy;

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

Notes

Bottom Section