BIS fnc ambientFlyby: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{Feature | Informative | " to "{{Feature|informative|")
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Ambient


|1.00|= Game version
|descr= 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.
____________________________________________________________________________________________
{{Feature|informative|Created vehicle is [[setCaptive|set captive]], making its side [[civilian]].}}


| 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
|s1= [startPos, endPos, altitude, speedMode, classname, side] call [[BIS_fnc_ambientFlyby]]
____________________________________________________________________________________________


| <nowiki>[[0,0,0],[100,100,100],100,"NORMAL","B_Heli_Light_01_F",WEST]</nowiki> call '''BIS_fnc_ambientFlyby'''; |= Syntax
|p1= startPos: [[Position]] - start position of the air unit. The Z value does not matter and is replaced by ''altitude''


|p1= [[Array]] - Array containing start position where air unit spawns. Format [x,y,z]. |=
|p2= endPos: [[Array]] format [[Position#PositionAGL|PositionAGL]] - end position where the air unit moves to and despawns (through [[addWaypoint]])
|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. |=


| [[Boolean]] - True if function executed successfully. |= Return value
|p3= altitude: [[Number]] - (Optional, default 100) height at which air unit will spawn and fly above ground level
____________________________________________________________________________________________


|x1= <code><nowiki>ambientFly = [[200,200,200],[250,250,250]]</nowiki> call BIS_fnc_ambientFlyBy; //Spawns a Littlebird that flies from position 200,200,200 to 250,250,250 at height 100 and Normal speed.</code> |=
|p4= speedMode: [[String]] - (Optional, default "NORMAL") [[speedMode|speed mode]] at which air unit travels. Possible values are "LIMITED", "NORMAL" and "FULL"
|x2 = <code><nowiki>ambientFly = [getposATL player, getposATL opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", WEST]</nowiki> call BIS_fnc_ambientFlyBy;</code> |=
____________________________________________________________________________________________


| |= See also
|p5= classname: [[String]] - (Optional, default "B_Heli_Light_01_F") vehicle classname defined in [[CfgVehicles]]


}}
|p6= side: [[Side]] - (Optional, default [[west]]) side to which the vehicle belongs
 
|r1= [[Boolean]] - [[true]] if function executed successfully.


<h3 style="display:none">Notes</h3>
|x1= <sqf>
<dl class="command_description">
// spawns a Littlebird that flies from position 200,200,50 to 250,250,75 at altitude 100 and normal speed
<!-- Note Section BEGIN -->
[[200,200,50], [250,250,75]] call BIS_fnc_ambientFlyby;
</sqf>


<!-- Note Section END -->
|x2= <sqf>[getPosATL player, getPosATL opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", west] call BIS_fnc_ambientFlyby;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[createVehicle]] [[BIS_fnc_spawnVehicle]]
[[Category:Function Group: Ambient|{{uc:ambientFlyby}}]]
}}
[[Category:Functions|{{uc:ambientFlyby}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ambientFlyby}}]]

Latest revision as of 21:42, 16 May 2024

Arma 3 logo black.png1.00
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: Position - start position of the air unit. The Z value does not matter and is replaced by altitude
endPos: Array format PositionAGL - end position where the air unit moves to and despawns (through addWaypoint)
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:
createVehicle BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ambientFlyby&oldid=364496"