BIS fnc fireSupportVirtual: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 1/7)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(38 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= Fires virtual mortar/artillery fire support.
____________________________________________________________________________________________


| <pre>/*
|s1= [target, ammo, radius, rounds, delay, conditionEnd, safezone, alt, speed, sounds] spawn [[BIS_fnc_fireSupportVirtual]]
Author: Vaclav "Watty Watts" Oliva


Description:
|p1= target: [[Position]], [[Object]] or [[String]] - target position, can be object, position or marker name
Virtual fire support of artillery/mortar unit.


Parameters:
|p2= ammo: [[String]] - (Optional, default "Sh_82mm_AMOS") ammunition to be used (if left empty, {{hl|Sh_82mm_AMOS}} ammunition will be used)
Select 0 - ARRAY or OBJECT or STRING: Target position ([x,y,z] or Object or "Marker")
Select 1 - STRING: Ammo (you can use nil or empty string for default 82mm mortar)
Select 2 - NUMBER: Radius
Select 3 - NUMBER: Number of rounds to be fired
Select 4 - NUMBER or ARRAY: Delay between rounds - use either #x for precise timing or [#x,#y] for setting min and max delay
Select 5 - (OPTIONAL) CODE: Condition to end bombardment before all rounds are fired
Select 6 - (OPTIONAL) NUMBER: Safezone radius - minimal distance from the target position where shells may be fired at
Select 7 - (OPTIONAL) NUMBER: Altitude where the shell will be created, default 250
Select 8 - (OPTIONAL) NUMBER: Descending velocity, in m/s. Default is 150, if you use flare as ammo, set it to lower value (1-5) to let it fall down slowly
Select 9 - (OPTIONAL) ARRAY: String of sounds to be played on the incoming shell, default is silence


Returns:
|p3= radius: [[Number]] - (Optional, default 100) radius of target area in meters
Boolean


Examples:
|p4= rounds: [[Number]] - (Optional, default 10) number of rounds to be fired
_barrage = [BIS_Player,"Sh_82mm_AMOS",100,24,10] spawn BIS_fnc_fireSupportVirtual;
_barrage = [[3600,3600,0],nil,100,24,10] spawn BIS_fnc_fireSupportVirtual;
_barrage = ["BIS_mrkTargetArea","",100,24,10,{BIS_Player distance BIS_EscapeZone < 100}] spawn BIS_fnc_fireSupportVirtual;
_barrage = [BIS_Player,nil,100,24,10,{dayTime > 20},50] spawn BIS_fnc_fireSupportVirtual;
_barrage = [BIS_Victim,"Sh_82mm_AMOS",100,24,10,{dayTime > 20},75,500,200,["mortar1","mortar2"]] spawn BIS_fnc_fireSupportVirtual;
_barrage = [
BIS_Victim,
"Sh_82mm_AMOS",
100,
24,
[10,20],
{dayTime > 20},
75,
500,
200,
["mortar1","mortar2"]
] spawn BIS_fnc_fireSupportVirtual;
*/


// Params
|p5= delay: [[Array]] or [[Number]] - (Optional, default 10) delay between rounds
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
* [[Array]] [min, max]:
____________________________________________________________________________________________
** min: [[Number]] - min delay
** max: [[Number]] - max delay
* [[Number]] - Precise delay


| <!-- [] call [[BIS_fnc_fireSupportVirtual]]; --> |= Syntax
|p6= conditionEnd: [[Code]] - (Optional, default <sqf inline>{ false }</sqf>) condition to end bombardment before all rounds are fired
|p1= |= Parameter 1


| |= Return value
|p7= safezone: [[Number]] - (Optional, default 0) safezone radius - minimal distance from the target position where shells may be directed at
____________________________________________________________________________________________


|x1= <code></code> |=
|p8= alt: [[Number]] - (Optional, default 250) altitude where the shell will be created
____________________________________________________________________________________________


| |= See also
|p9= speed: [[Number]] - (Optional, default 150) descending velocity, in m/s. Default is 150, if you use flare as ammo, set it to lower value (1-5) to let it fall down slowly


}}
|p10= sounds: [[Array]] of [[String]]s - (Optional, default [""]) sounds to be played on the incoming shell
 
|r1= [[Boolean]] - [[true]] if successful
 
|x1= <sqf>[BIS_Player, "Sh_82mm_AMOS", 100, 24, 10] spawn BIS_fnc_fireSupportVirtual;</sqf>
 
|x2= <sqf>[[3600, 3600, 0], nil, 100, 24, 10] spawn BIS_fnc_fireSupportVirtual;</sqf>


<h3 style="display:none">Notes</h3>
|x3= <sqf>[BIS_Player, nil, 100, 24, 10, {dayTime > 20}, 50] spawn BIS_fnc_fireSupportVirtual;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|exec= spawn
</dl>


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

Latest revision as of 15:50, 8 November 2023

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

Description

Description:
Fires virtual mortar/artillery fire support.
Execution:
spawn
Groups:
Supports

Syntax

Syntax:
[target, ammo, radius, rounds, delay, conditionEnd, safezone, alt, speed, sounds] spawn BIS_fnc_fireSupportVirtual
Parameters:
target: Position, Object or String - target position, can be object, position or marker name
ammo: String - (Optional, default "Sh_82mm_AMOS") ammunition to be used (if left empty, Sh_82mm_AMOS ammunition will be used)
radius: Number - (Optional, default 100) radius of target area in meters
rounds: Number - (Optional, default 10) number of rounds to be fired
delay: Array or Number - (Optional, default 10) delay between rounds
conditionEnd: Code - (Optional, default { false }) condition to end bombardment before all rounds are fired
safezone: Number - (Optional, default 0) safezone radius - minimal distance from the target position where shells may be directed at
alt: Number - (Optional, default 250) altitude where the shell will be created
speed: Number - (Optional, default 150) descending velocity, in m/s. Default is 150, if you use flare as ammo, set it to lower value (1-5) to let it fall down slowly
sounds: Array of Strings - (Optional, default [""]) sounds to be played on the incoming shell
Return Value:
Boolean - true if successful

Examples

Example 1:
[BIS_Player, "Sh_82mm_AMOS", 100, 24, 10] spawn BIS_fnc_fireSupportVirtual;
Example 2:
[[3600, 3600, 0], nil, 100, 24, 10] spawn BIS_fnc_fireSupportVirtual;
Example 3:
[BIS_Player, nil, 100, 24, 10, {dayTime > 20}, 50] spawn BIS_fnc_fireSupportVirtual;

Additional Information

See also:
BIS_fnc_fireSupport BIS_fnc_fireSupportCluster BIS_fnc_fire BIS_fnc_fireSupport

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_fireSupportVirtual&oldid=349184"