BIS fnc fireSupportCluster: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 1/7)
(pf)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________
| arma3 |Game name=
|1.00|Game version=
____________________________________________________________________________________________


{{Function|= Comments
| Virtual fire support - cluster shell.|Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| [position,ammo,radius,rounds,delay,conditionEnd,safezone,altitude,velocity,sounds] spawn [[BIS_fnc_fireSupportCluster]] |Syntax=
 
 
|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 |Parameter 2=
 
|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 |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=


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


| <pre>/*
|p8= altitude: [[Number]] - (Optional, default 100) Altitude in metres where the submunition will be spawned |Parameter 8=
Author: WattyWatts, summer 2016


Description:
|p9= velocity: [[Number]] - (Optional, default 100) Descending velocity, in m/s |Parameter 9=
Virtual fire support - cluster shell


Select 0 - ARRAY or OBJECT or STRING: Target position ([x,y,z] or Object or "Marker").
|p10= sounds: [[Array]] - (Optional, default [""]) Strings of sounds to be played on the incoming submunition |Parameter 10=
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


EXAMPLE 1: _cluster = [BIS_Player,"G_40mm_HEDP",100,[4,10],10] spawn BIS_fnc_fireSupportCluster;
| [[Boolean]] |Return value=
EXAMPLE 2: _cluster = [[3600,3600,0],nil,100,[4,10],10] spawn BIS_fnc_fireSupportCluster;
EXAMPLE 3: _cluster = ["BIS_mrkTargetArea","",100,[4,10],10,{BIS_Player distance BIS_EscapeZone < 100}] spawn BIS_fnc_fireSupportCluster;
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
|exec= spawn |= Execution
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_fireSupportCluster]]; --> |= Syntax
|x1= <code> [BIS_Player,"G_40mm_HEDP",100,[4,10],10] [[spawn]] [[BIS_fnc_fireSupportCluster]];</code>|Example 1=
|p1= |= Parameter 1


| |= Return value
|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=
____________________________________________________________________________________________


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


| |= See also
| [[BIS_fnc_fireSupport]], [[BIS_fnc_fireSupportVirtual]] |See also=
 
}}
}}


Revision as of 10:28, 4 July 2018

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

Description

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

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_fireSupportBIS_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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_fireSupportCluster&oldid=108816"