BIS fnc ambientFlyby: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Ambient(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\] " to "")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1 = Ambient |GROUP1=
|gr1 = Ambient |GROUP1=
____________________________________________________________________________________________


| 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 its destination.{{Informative | Created vehicle is [[setCaptive|set captive]], making its side [[civilian]].}} |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 its destination.{{Informative | Created vehicle is [[setCaptive|set captive]], making its side [[civilian]].}} |DESCRIPTION=
____________________________________________________________________________________________


| [startPos, endPos, altitude, speedMode, classname, side] call [[BIS_fnc_ambientFlyby]]; |SYNTAX=
| [startPos, endPos, altitude, speedMode, classname, side] call [[BIS_fnc_ambientFlyby]]; |SYNTAX=
Line 27: Line 24:


| [[Boolean]] - [[true]] if function executed successfully. |RETURNVALUE=
| [[Boolean]] - [[true]] if function executed successfully. |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code>{{cc|spawns a Littlebird that flies from position 200,200,50 to 250,250,75 at altitude 100 and normal speed}}
|x1= <code>{{cc|spawns a Littlebird that flies from position 200,200,50 to 250,250,75 at altitude 100 and normal speed}}
Line 33: Line 29:


|x2 = <code>[<nowiki/>[[getPosATL]] [[player]], [[getPosATL]] opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", [[west]]] [[call]] [[BIS_fnc_ambientFlyby]];</code> |Example2=
|x2 = <code>[<nowiki/>[[getPosATL]] [[player]], [[getPosATL]] opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", [[west]]] [[call]] [[BIS_fnc_ambientFlyby]];</code> |Example2=
____________________________________________________________________________________________


| [[createVehicle]], [[BIS_fnc_spawnVehicle]] |SEEALSO=
| [[createVehicle]], [[BIS_fnc_spawnVehicle]] |SEEALSO=

Revision as of 22:40, 16 January 2021

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 its destination.
Created vehicle is set captive, making its side civilian.
Execution:
call
Groups:
Ambient

Syntax

Syntax:
[startPos, endPos, altitude, speedMode, classname, side] call BIS_fnc_ambientFlyby;
Parameters:
startPos: PositionATL - start position of the air unit
endPos: PositionAGL - end position where the air unit moves to and despawns
altitude: Number - (Optional, default 100) height at which air unit will spawn and fly above ground level
speedMode: String - (Optional, default "NORMAL") speed mode at which air unit travels. Possible values are "LIMITED", "NORMAL" and "FULL"
classname: String - (Optional, default "B_Heli_Light_01_F") vehicle classname defined in CfgVehicles
side: Side - (Optional, default west) side to which the vehicle belongs
Return Value:
Boolean - true if function executed successfully.

Examples

Example 1:
// spawns a Littlebird that flies from position 200,200,50 to 250,250,75 at altitude 100 and normal speed [[200,200,50], [250,250,75]] call BIS_fnc_ambientFlyby;
Example 2:
[getPosATL player, getPosATL opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", west] call BIS_fnc_ambientFlyby;

Additional Information

See also:
createVehicleBIS_fnc_spawnVehicle

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