BIS fnc fireSupportCluster: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Execution " to "|Execution= ")
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Supports
____________________________________________________________________________________________


| Virtual fire support - cluster shell.|Description=
|descr= Virtual fire support - cluster shell.
____________________________________________________________________________________________


| [position,ammo,radius,rounds,delay,conditionEnd,safezone,altitude,velocity,sounds] spawn [[BIS_fnc_fireSupportCluster]] |Syntax=
|s1= [position,ammo,radius,rounds,delay,conditionEnd,safezone,altitude,velocity,sounds] spawn [[BIS_fnc_fireSupportCluster]]


|p1= position: [[Position]], [[Object]] or [[String]] - can be position, an object, or a marker


|p1= position: [[Position]], [[Object]] or [[String]] - Can be position, an object, or a marker |Parameter 1=
|p2= ammo: [[String]] - (Optional, default "G_40mm_HEDP") ammunition class, [[nil]] or empty string to use 40mm HEDP shells


|p2= ammo: [[String]] - (Optional, default "G_40mm_HEDP") Ammunition class, [[nil]] or empty string to use 40mm HEDP shells |Parameter 2=
|p3= radius: [[Number]] - (Optional, default 100) radius of the area in metres


|p3= radius: [[Number]] - (Optional, default 100) Radius of the area in metres |Parameter 3=
|p4= rounds: [[Array]] - (Optional, default [1,20]) number of rounds to be fired, can be:
* 0: Number of shells
* 1: Number of submunition


|p4= rounds: [[Array]] - (Optional, default [1,20]) Number of rounds to be fired, can be:
|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
*0: Number of shells
*1: Number of submunition |Parameter 4=


|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 |Parameter 5=
|p6= conditionEnd: [[Code]] - (Optional, default {}) condition to end fire support


|p6= conditionEnd: [[Code]] - (Optional, default {}) Condition to end fire support |Parameter 6=
|p7= safeZone: [[Number]] - (Optional, default 0) safezone radius in metres


|p7= safeZone: [[Number]] - (Optional, default 0) Safezone radius in metres |Parameter 7=
|p8= altitude: [[Number]] - (Optional, default 100) altitude in metres where the submunition will be spawned


|p8= altitude: [[Number]] - (Optional, default 100) Altitude in metres where the submunition will be spawned |Parameter 8=
|p9= velocity: [[Number]] - (Optional, default 100) descending velocity, in m/s


|p9= velocity: [[Number]] - (Optional, default 100) Descending velocity, in m/s |Parameter 9=
|p10= sounds: [[Array]] - (Optional, default [""]) strings of sounds to be played on the incoming submunition


|p10= sounds: [[Array]] - (Optional, default [""]) Strings of sounds to be played on the incoming submunition |Parameter 10=
|r1= [[Boolean]]


|exec= spawn


| [[Boolean]] |Return value=
|x1= <sqf>[BIS_Player, "G_40mm_HEDP", 100, [4,10], 10] spawn BIS_fnc_fireSupportCluster;</sqf>


|exec= spawn |Execution=
|x2= <sqf>[BIS_Victim,"G_40mm_HEDP", 100, [5,25], 10, { dayTime > 20 }, 75, 500, 150, ["shell1", "shell2"]] spawn BIS_fnc_fireSupportCluster;</sqf>
____________________________________________________________________________________________


|x1= <code> [BIS_Player,"G_40mm_HEDP",100,[4,10],10] [[spawn]] [[BIS_fnc_fireSupportCluster]];</code>|Example 1=
|x3= <sqf>["BIS_mrkTargetArea", "", 100, [4,10], 10, { BIS_Player distance BIS_EscapeZone < 100 }] spawn BIS_fnc_fireSupportCluster;</sqf>


|x2= <code> [ BIS_Victim,"G_40mm_HEDP",100,[5,25],10,{[[daytime]] > 20},75,500,150,["shell1","shell2"] ] [[spawn]] [[BIS_fnc_fireSupportCluster]];</code>|Example 2=
|seealso= [[BIS_fnc_fireSupport]] [[BIS_fnc_fireSupportVirtual]]
 
|x3= <code> ["BIS_mrkTargetArea","",100,[4,10],10,{BIS_Player [[distance]] BIS_EscapeZone < 100}] [[spawn]] [[BIS_fnc_fireSupportCluster]];</code>|Example 3=
____________________________________________________________________________________________
 
| [[BIS_fnc_fireSupport]], [[BIS_fnc_fireSupportVirtual]] |See also=
}}
}}
<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:Function Group: Combat|{{uc:fireSupportCluster}}]]
[[Category:Functions|{{uc:fireSupportCluster}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:fireSupportCluster}}]]

Latest revision as of 14:00, 8 November 2023

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