BIS fnc ambientPlanes: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Some wiki formatting)
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| tkoh |Game name=
|game1= tkoh
|version1= 1.00


|1.00|Game version=
|game2= arma3
|version2= 0.50


|gr1 = Ambient |GROUP1=
|gr1= Ambient


|eff= global |MP Effect=
|eff= global


| Creates ambient airplanes fly-by near airports around the [[player]]. It will automatically get classes from {{Inline code|[[configFile]] >> "CfgVehicles"}} on all planes that have "ambientType" attribute > 0. |DESCRIPTION=
|descr= Creates ambient airplanes fly-by near airports around the [[player]]. It will automatically get classes from <sqf inline>configFile >> "CfgVehicles"</sqf> on all planes that have "ambientType" attribute &gt; 0.


|mp= Since this function uses [[player]] and its effect is [[Multiplayer Scripting#Locality|global]], this can only be used in singleplayer or executed locally on a player, usually the group leader. |Multiplayer=
|mp= Since this function uses [[player]] and its effect is [[Multiplayer Scripting#Locality|global]], this can only be used in singleplayer or executed locally on a player, usually the group leader.


| [quantity, areaRadius, dirStep] call [[BIS_fnc_ambientPlanes]] |SYNTAX=
|s1= [quantity, areaRadius, dirStep] call [[BIS_fnc_ambientPlanes]]


|p1= quantity: [[Number]] - (Optional, default 5) |PARAMETER1=
|p1= quantity: [[Number]] - (Optional, default 5)


|p2= areaRadius: [[Number]] - (Optional, default 10000) - area radius around airports where planes can spawn/fly |PARAMETER2=
|p2= areaRadius: [[Number]] - (Optional, default 10000) - area radius around airports where planes can spawn/fly


|p3= dirStep: [[Number]] - (Optional, default 30) |PARAMETER3=
|p3= dirStep: [[Number]] - (Optional, default 30)


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]


|x1= <code>[] [[call]] [[BIS_fnc_ambientPlanes]];</code> |EXAMPLE1=
|x1= <sqf>[] call BIS_fnc_ambientPlanes;</sqf>


|x2= <code>[30, 3000] [[call]] [[BIS_fnc_ambientPlanes]];</code> |EXAMPLE2=
|x2= <sqf>[30, 3000] call BIS_fnc_ambientPlanes;</sqf>


| [[createUnit]] [[createVehicle]] [[BIS_fnc_spawnGroup]] |SEEALSO=
|seealso= [[createUnit]] [[createVehicle]] [[BIS_fnc_spawnGroup]]
}}
}}
<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:{{Name|arma3}}: Functions|{{uc:ambientPlanes}}]]

Latest revision as of 13:33, 27 July 2022

tkoh logo small.png1.00Arma 3 logo black.png0.50
GEGlobal
Hover & click on the images for description

Description

Description:
Creates ambient airplanes fly-by near airports around the player. It will automatically get classes from configFile >> "CfgVehicles" on all planes that have "ambientType" attribute > 0.
Execution:
call
Multiplayer:
Since this function uses player and its effect is global, this can only be used in singleplayer or executed locally on a player, usually the group leader.
Groups:
Ambient

Syntax

Syntax:
[quantity, areaRadius, dirStep] call BIS_fnc_ambientPlanes
Parameters:
quantity: Number - (Optional, default 5)
areaRadius: Number - (Optional, default 10000) - area radius around airports where planes can spawn/fly
dirStep: Number - (Optional, default 30)
Return Value:
Nothing

Examples

Example 1:
[] call BIS_fnc_ambientPlanes;
Example 2:
[30, 3000] call BIS_fnc_ambientPlanes;

Additional Information

See also:
createUnit createVehicle BIS_fnc_spawnGroup

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_ambientPlanes&oldid=329369"