BIS fnc fireSupportCluster: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(36 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= Supports


|1.00|= Game version
|descr= Virtual fire support - cluster shell.
____________________________________________________________________________________________


| <pre>/*
|s1= [position,ammo,radius,rounds,delay,conditionEnd,safezone,altitude,velocity,sounds] spawn [[BIS_fnc_fireSupportCluster]]
Author: WattyWatts, summer 2016


Description:
|p1= position: [[Position]], [[Object]] or [[String]] - can be position, an object, or a marker
Virtual fire support - cluster shell


Select 0 - ARRAY or OBJECT or STRING: Target position ([x,y,z] or Object or "Marker").
|p2= ammo: [[String]] - (Optional, default "G_40mm_HEDP") ammunition class, [[nil]] or empty string to use 40mm HEDP shells
Select 1 - STRING: Ammo (you can use nil or empty string for default 40mm HEDP grenade shell).
Select 2 - NUMBER: Radius. Default 100m.
Select 3 - ARRAY: Number of cluster shells to be fired and submunition quantity. Default [1,20].
Select 4 - NUMBER or ARRAY: Delay between rounds - use either #x for precise timing or [#x,#y] for setting min and max delay. Default 10 sec.
Select 5 - (OPTIONAL) CODE: Condition to end fire support before all cluster shells are fired.
Select 6 - (OPTIONAL) NUMBER: Safezone radius - minimal distance from the target position where cluster may be spawned at. Default is 0m.
Select 7 - (OPTIONAL) NUMBER: Altitude where the submunition will be spawned. Default 100m.
Select 8 - (OPTIONAL) NUMBER: Descending velocity, in m/s. Default is 100.
Select 9 - (OPTIONAL) ARRAY: Strings of sounds to be played on the incoming submunition, default is silence.


Returns: boolean
|p3= radius: [[Number]] - (Optional, default 100) radius of the area in metres


EXAMPLE 1: _cluster = [BIS_Player,"G_40mm_HEDP",100,[4,10],10] spawn BIS_fnc_fireSupportCluster;
|p4= rounds: [[Array]] - (Optional, default [1,20]) number of rounds to be fired, can be:
EXAMPLE 2: _cluster = [[3600,3600,0],nil,100,[4,10],10] spawn BIS_fnc_fireSupportCluster;
* 0: Number of shells
EXAMPLE 3: _cluster = ["BIS_mrkTargetArea","",100,[4,10],10,{BIS_Player distance BIS_EscapeZone < 100}] spawn BIS_fnc_fireSupportCluster;
* 1: Number of submunition
EXAMPLE 4: _cluster = [BIS_Player,nil,100,[4,20],10,{dayTime > 20},50] spawn BIS_fnc_fireSupportCluster;
EXAMPLE 5: _cluster = [BIS_Victim,"G_40mm_HEDP",100,[5,25],10,{dayTime > 20},75,500,150,["shell1","shell2"]] spawn BIS_fnc_fireSupportCluster;
EXAMPLE 6: _cluster =
[
BIS_Victim,
"G_40mm_HEDP",
100,
[5,25],
[5,10],
{dayTime > 20},
75,
200,
125,
["shell1","shell2"]
] spawn BIS_fnc_fireSupportCluster;
*/


// Params
|p5= delay: [[Array]] or [[Number]] - (Optional, default 10) delay between rounds in seconds, can be [[Number]] for precise delay or [[Array]] to set min and max delay
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_fireSupportCluster]]; --> |= Syntax
|p6= conditionEnd: [[Code]] - (Optional, default {}) condition to end fire support
|p1= |= Parameter 1


| |= Return value
|p7= safeZone: [[Number]] - (Optional, default 0) safezone radius in metres
____________________________________________________________________________________________


|x1= <code></code> |=
|p8= altitude: [[Number]] - (Optional, default 100) altitude in metres where the submunition will be spawned
____________________________________________________________________________________________


| |= See also
|p9= velocity: [[Number]] - (Optional, default 100) descending velocity, in m/s


}}
|p10= sounds: [[Array]] - (Optional, default [""]) strings of sounds to be played on the incoming submunition
 
|r1= [[Boolean]]
 
|exec= spawn
 
|x1= <sqf>[BIS_Player, "G_40mm_HEDP", 100, [4,10], 10] spawn BIS_fnc_fireSupportCluster;</sqf>


<h3 style="display:none">Notes</h3>
|x2= <sqf>[BIS_Victim,"G_40mm_HEDP", 100, [5,25], 10, { dayTime > 20 }, 75, 500, 150, ["shell1", "shell2"]] spawn BIS_fnc_fireSupportCluster;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x3= <sqf>["BIS_mrkTargetArea", "", 100, [4,10], 10, { BIS_Player distance BIS_EscapeZone < 100 }] spawn BIS_fnc_fireSupportCluster;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[BIS_fnc_fireSupport]] [[BIS_fnc_fireSupportVirtual]]
[[Category:Function Group: Combat|{{uc:fireSupportCluster}}]]
}}
[[Category:Functions|{{uc:fireSupportCluster}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:fireSupportCluster}}]]

Latest revision as of 14:00, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Virtual fire support - cluster shell.
Execution:
spawn
Groups:
Supports

Syntax

Syntax:
[position,ammo,radius,rounds,delay,conditionEnd,safezone,altitude,velocity,sounds] spawn BIS_fnc_fireSupportCluster
Parameters:
position: Position, Object or String - can be position, an object, or a marker
ammo: String - (Optional, default "G_40mm_HEDP") ammunition class, nil or empty string to use 40mm HEDP shells
radius: Number - (Optional, default 100) radius of the area in metres
rounds: Array - (Optional, default [1,20]) number of rounds to be fired, can be:
  • 0: Number of shells
  • 1: Number of submunition
delay: Array or Number - (Optional, default 10) delay between rounds in seconds, can be Number for precise delay or Array to set min and max delay
conditionEnd: Code - (Optional, default {}) condition to end fire support
safeZone: Number - (Optional, default 0) safezone radius in metres
altitude: Number - (Optional, default 100) altitude in metres where the submunition will be spawned
velocity: Number - (Optional, default 100) descending velocity, in m/s
sounds: Array - (Optional, default [""]) strings of sounds to be played on the incoming submunition
Return Value:
Boolean

Examples

Example 1:
[BIS_Player, "G_40mm_HEDP", 100, [4,10], 10] spawn BIS_fnc_fireSupportCluster;
Example 2:
[BIS_Victim,"G_40mm_HEDP", 100, [5,25], 10, { dayTime > 20 }, 75, 500, 150, ["shell1", "shell2"]] spawn BIS_fnc_fireSupportCluster;
Example 3:
["BIS_mrkTargetArea", "", 100, [4,10], 10, { BIS_Player distance BIS_EscapeZone < 100 }] spawn BIS_fnc_fireSupportCluster;

Additional Information

See also:
BIS_fnc_fireSupport BIS_fnc_fireSupportVirtual

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_fireSupportCluster&oldid=348400"