BIS fnc fireSupportVirtual: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Fix description)
(Add default values)
Line 10: Line 10:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


|p2= mag: [[String]] - Magazine (if left empy, first magazine available will be used) |Parameter 2=
|p2= mag: [[String]] - (Optional, default "Sh_82mm_AMOS") magazine (if left empty, first available magazine will be used) |Parameter 2=


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


|p4= rounds: [[Number]] - Number of rounds to be fired|Parameter 4=
|p4= rounds: [[Number]] - (Optional, default 10) number of rounds to be fired |Parameter 4=


|p5= delay: [[Array]] or [[Number]] - Delay between rounds.
|p5= delay: [[Array]] or [[Number]] - (Optional, default 10) delay between rounds
* [[Array]]
* [[Array]] [min, max]:
** 1: min delay
** min: [[Number]] - min delay
** 2: max delay
** max: [[Number]] - max delay
* [[Number]] - Precise delay |Parameter 5=
* [[Number]] - Precise delay |Parameter 5=


|p6= conditionEnd: [[Code]] - (Optional, default ?) Condition to end bombardment before all rounds are fired|Parameter 6=
|p6= conditionEnd: [[Code]] - (Optional, default {{Inline code|{ [[false]] }<nowiki/>}}) Condition to end bombardment before all rounds are fired |Parameter 6=


|p7= safezone: [[Number]] - (Optional, default ?) Safezone radius - minimal distance from the target position where shells may be directed at|Parameter 7=
|p7= safezone: [[Number]] - (Optional, default 0) 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|Parameter 8=
|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|Parameter 9=
|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|strings]] - (Optional, default []) Ssounds to be played on the incoming shell|Parameter 10=
|p10= sounds: [[Array]] of [[String|strings]] - (Optional, default [""]) Ssounds to be played on the incoming shell |Parameter 10=


| [[Boolean]] - [[true]] if successful |Return value=
| [[Boolean]] - [[true]] if successful |Return value=


|x1= <code>[BIS_Player, "Sh_82mm_AMOS", 100, 24, 10] [[spawn]] [[BIS_fnc_fireSupportVirtual]];</code> |Example 1=


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


|exec= spawn |Execution=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 56: Line 58:


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

Revision as of 14:46, 19 July 2020

Hover & click on the images for description

Description

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

Syntax

Syntax:
[target, mag, 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
mag: String - (Optional, default "Sh_82mm_AMOS") magazine (if left empty, first available magazine 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 [""]) Ssounds 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_fireSupportBIS_fnc_fireSupportClusterBIS_fnc_fireBIS_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

Notes

Bottom Section