BIS fnc ambientFlyby: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) 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 | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1 = Ambient | |gr1 = Ambient | ||
| 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]].}} | | 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]].}} | ||
| [startPos, endPos, altitude, speedMode, classname, side] call [[BIS_fnc_ambientFlyby]]; | | [startPos, endPos, altitude, speedMode, classname, side] call [[BIS_fnc_ambientFlyby]]; | ||
|p1= startPos: [[PositionATL]] - start position of the air unit | |p1= startPos: [[PositionATL]] - start position of the air unit | ||
|p2= endPos: [[PositionAGL]] - end position where the air unit moves to and despawns | |p2= endPos: [[PositionAGL]] - end position where the air unit moves to and despawns | ||
|p3= altitude: [[Number]] - (Optional, default 100) height at which air unit will spawn and fly above ground level | |p3= altitude: [[Number]] - (Optional, default 100) height at which air unit will spawn and fly above ground level | ||
|p4= speedMode: [[String]] - (Optional, default "NORMAL") [[speedMode|speed mode]] at which air unit travels. Possible values are "LIMITED", "NORMAL" and "FULL" | |p4= speedMode: [[String]] - (Optional, default "NORMAL") [[speedMode|speed mode]] at which air unit travels. Possible values are "LIMITED", "NORMAL" and "FULL" | ||
|p5= classname: [[String]] - (Optional, default "B_Heli_Light_01_F") vehicle classname defined in [[CfgVehicles]] | |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 | |p6= side: [[Side]] - (Optional, default [[west]]) side to which the vehicle belongs | ||
| [[Boolean]] - [[true]] if function executed successfully. | | [[Boolean]] - [[true]] if function executed successfully. | ||
|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}} | ||
[<nowiki/>[200,200,50], [250,250,75]] [[call]] [[BIS_fnc_ambientFlyby]];</code> | [<nowiki/>[200,200,50], [250,250,75]] [[call]] [[BIS_fnc_ambientFlyby]];</code> | ||
|x2 = <code>[<nowiki/>[[getPosATL]] [[player]], [[getPosATL]] opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", [[west]]] [[call]] [[BIS_fnc_ambientFlyby]];</code> | |x2 = <code>[<nowiki/>[[getPosATL]] [[player]], [[getPosATL]] opforUnit, 400, "FULL", "B_Heli_Light_01_Armed_F", [[west]]] [[call]] [[BIS_fnc_ambientFlyby]];</code> | ||
| [[createVehicle]], [[BIS_fnc_spawnVehicle]] | | [[createVehicle]], [[BIS_fnc_spawnVehicle]] | ||
}} | }} | ||
Revision as of 22:37, 17 January 2021
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.
- 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