BIS fnc fireSupport: 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]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(48 intermediate revisions by 4 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
|gr2= Combat
____________________________________________________________________________________________


| <pre>/*
|descr= Mortar/artillery fire support.
Author: Vaclav "Watty Watts" Oliva


Description:
|s1= [arty,target,mag,radius,rounds,delay,conditionEnd,safezone] spawn [[BIS_fnc_fireSupport]]
Mortar/artillery fire support


Parameters:
|p1= arty: [[Object]] - artillery unit.
Select 0 - OBJECT: Artillery unit
Select 1 - ARRAY or OBJECT or MARKER: Target position ([x,y,z] or Object or "Marker")
Select 2 - STRING: Magazine (if left empy, first magazine available will be used)
Select 3 - NUMBER: Radius
Select 4 - NUMBER: Number of rounds to be fired
Select 5 - NUMBER or ARRAY: Delay between rounds - use either #x for precise timing or [#x,#y] for setting min and max delay. 5 seconds is minimum.
Select 6 - (OPTIONAL) CODE: Condition to end bombardment before all rounds are fired
Select 7 - (OPTIONAL) NUMBER: Safezone radius - minimal distance from the target position where shells may be directed at


Returns:
|p2= target: [[Position]] or [[Object]] or [[String]] - target position, can be object/position 3D or marker name
Boolean


Examples:
|p3= mag: [[String]] - magazine (if left empy, first magazine available will be used)
_barrage = [BIS_Mortar,[3600,3600,0],"",100,24,10] spawn BIS_fnc_fireSupport;
_barrage = [BIS_Mortar,BIS_Player,"8Rnd_82mm_Mo_shells",100,24,10] spawn BIS_fnc_fireSupport;
_barrage = [BIS_Mortar,"BIS_mrkTargetArea","8Rnd_82mm_Mo_shells",100,24,10,{BIS_Player distance BIS_EscapeZone < 100}] spawn BIS_fnc_fireSupport;
_barrage = [BIS_Mortar,BIS_Player,"8Rnd_82mm_Mo_shells",100,24,10,{dayTime > 20},50] spawn BIS_fnc_fireSupport;
_barrage = [BIS_Mortar,BIS_Victim,"8Rnd_82mm_Mo_shells",100,24,[5,10],{dayTime > 20},50] spawn BIS_fnc_fireSupport;
*/


// Params
|p4= radius: [[Number]] - radius of target area in meters
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_fireSupport]]; --> |= Syntax
|p5= rounds: [[Number]] - number of rounds to be fired
|p1= |= Parameter 1


| |= Return value
|p6= delay: [[Array]] or [[Number]] - delay between rounds:
____________________________________________________________________________________________
* [[Array]]
** 1: Min delay
** 2: Max delay
* [[Number]] - Precise delay


|x1= <code></code> |=
|p7= conditionEnd: [[Code]] - condition to end bombardment before all rounds are fired
____________________________________________________________________________________________


| |= See also
|p8= safezone: [[Number]] - safezone radius - minimal distance from the target position where shells may be directed at


}}
|r1= [[Boolean]] - [[true]] if successful
 
|x1= <sqf>[BIS_Mortar, [3600,3600,0], "", 100, 24, 10] spawn BIS_fnc_fireSupport;</sqf>


<h3 style="display:none">Notes</h3>
|x2= <sqf>[BIS_Mortar, BIS_Player, "8Rnd_82mm_Mo_shells", 100, 24, 10] spawn BIS_fnc_fireSupport;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x3= <sqf>[BIS_Mortar, "BIS_mrkTargetArea", "8Rnd_82mm_Mo_shells", 100, 24, 10, { BIS_Player distance BIS_EscapeZone < 100 }] spawn BIS_fnc_fireSupport;</sqf>
</dl>


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

Latest revision as of 15:50, 8 November 2023

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

Description

Description:
Mortar/artillery fire support.
Execution:
call
Groups:
SupportsCombat

Syntax

Syntax:
[arty,target,mag,radius,rounds,delay,conditionEnd,safezone] spawn BIS_fnc_fireSupport
Parameters:
arty: Object - artillery unit.
target: Position or Object or String - target position, can be object/position 3D or marker name
mag: String - magazine (if left empy, first magazine available will be used)
radius: Number - radius of target area in meters
rounds: Number - number of rounds to be fired
delay: Array or Number - delay between rounds:
conditionEnd: Code - condition to end bombardment before all rounds are fired
safezone: Number - safezone radius - minimal distance from the target position where shells may be directed at
Return Value:
Boolean - true if successful

Examples

Example 1:
[BIS_Mortar, [3600,3600,0], "", 100, 24, 10] spawn BIS_fnc_fireSupport;
Example 2:
[BIS_Mortar, BIS_Player, "8Rnd_82mm_Mo_shells", 100, 24, 10] spawn BIS_fnc_fireSupport;
Example 3:
[BIS_Mortar, "BIS_mrkTargetArea", "8Rnd_82mm_Mo_shells", 100, 24, 10, { BIS_Player distance BIS_EscapeZone < 100 }] spawn BIS_fnc_fireSupport;

Additional Information

See also:
BIS_fnc_fireSupportCluster BIS_fnc_fire 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_fireSupport&oldid=349210"