BIS fnc ambientPlanes: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| tkoh |Game name=
| tkoh


|1.00|Game version=
|1.00


|gr1 = Ambient |GROUP1=
|gr1 = Ambient


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


| 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 &gt; 0. |DESCRIPTION=
| 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 &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. |Multiplayer=


| [quantity, areaRadius, dirStep] call [[BIS_fnc_ambientPlanes]] |SYNTAX=
| [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=
| [[Nothing]]


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


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


| [[createUnit]] [[createVehicle]] [[BIS_fnc_spawnGroup]] |SEEALSO=
| [[createUnit]] [[createVehicle]] [[BIS_fnc_spawnGroup]]
}}
}}



Revision as of 22:36, 17 January 2021

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


Bottom Section