BIS fnc fireSupportVirtual: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(page filling)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(37 intermediate revisions by 3 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
____________________________________________________________________________________________


| Creates an strategic map. |= Description
|descr= Fires virtual mortar/artillery fire support.
____________________________________________________________________________________________


| [target,mag,radius,rounds,delay,conditionEnd,safezone,alt,speed,sounds] call [[BIS_fnc_fireSupportVirtual]] |= Syntax
|s1= [target, ammo, radius, rounds, delay, conditionEnd, safezone, alt, speed, sounds] spawn [[BIS_fnc_fireSupportVirtual]]


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


|p1= target: [[Position]] or [[Object]] or [[String]] - Target position, can be an object position or marker|= Parameter 1
|p2= ammo: [[String]] - (Optional, default "Sh_82mm_AMOS") ammunition to be used (if left empty, {{hl|Sh_82mm_AMOS}} ammunition will be used)


|p2= mag: [[String]] - Magazine (if left empy, first magazine available will be used)|= Parameter 2
|p3= radius: [[Number]] - (Optional, default 100) radius of target area in meters


|p3= radius: [[Number]] - Radius of target area in meters|= Parameter 3
|p4= rounds: [[Number]] - (Optional, default 10) number of rounds to be fired


|p4= rouds: [[Number]] - Number of rounds to be fired|= Parameter 4
|p5= delay: [[Array]] or [[Number]] - (Optional, default 10) delay between rounds
* [[Array]] [min, max]:
** min: [[Number]] - min delay
** max: [[Number]] - max delay
* [[Number]] - Precise delay


|p5= delay: [[Array]] or [[Number]] - Delay between rounds.
|p6= conditionEnd: [[Code]] - (Optional, default <sqf inline>{ false }</sqf>) condition to end bombardment before all rounds are fired
*[[Array]]
**1: min delay
**2: max delay
*[[Number]] - Precise delay|= Parameter 5


|p6= conditionEnd: [[Code]] - (Optional, default ?) Condition to end bombardment before all rounds are fired|= Parameter 6
|p7= safezone: [[Number]] - (Optional, default 0) safezone radius - minimal distance from the target position where shells may be directed at


|p7= safezone: [[Number]] - (Optional, default ?) Safezone radius - minimal distance from the target position where shells may be directed at|= Parameter 7
|p8= alt: [[Number]] - (Optional, default 250) altitude where the shell will be created


|p8= alt: [[Number]] - (Optional, default 250) Altitude where the shell will be created|= Parameter 8
|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


|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|= Parameter 9
|p10= sounds: [[Array]] of [[String]]s - (Optional, default [""]) sounds to be played on the incoming shell


|p10= sounds: [[Array]] of [[String|strings]] - (Optional, default []) Ssounds to be played on the incoming shell|= Parameter 10
|r1= [[Boolean]] - [[true]] if successful


| [[Boolean]] - [[True]] if successful |= Return value
|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>


|x1= <code>[ BIS_Player,"Sh_82mm_AMOS",100,24,10 ] [[spawn]] [[BIS_fnc_fireSupportVirtual]];;</code> |=
|x3= <sqf>[BIS_Player, nil, 100, 24, 10, {dayTime > 20}, 50] spawn BIS_fnc_fireSupportVirtual;</sqf>
|x2= <code>[ [3600,3600,0],[[nil]],100,24,10 ] [[spawn]] [[BIS_fnc_fireSupportVirtual]];</code> |=
|x3= <code>[ BIS_Player,[[nil]],100,24,10,{[[daytime]] > 20},50 ] [[spawn]] [[BIS_fnc_fireSupportVirtual]];</code> |=


____________________________________________________________________________________________
|exec= spawn


| [[BIS_fnc_fireSupportCluster]], [[BIS_fnc_fire]], [[BIS_fnc_fireSupport]]   |= See also
|seealso= [[BIS_fnc_fireSupport]] [[BIS_fnc_fireSupportCluster]] [[BIS_fnc_fire]] [[BIS_fnc_fireSupport]]
}}
}}
<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:fireSupportVirtual}}]]
[[Category:Functions|{{uc:fireSupportVirtual}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:fireSupportVirtual}}]]

Latest revision as of 15:50, 8 November 2023

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