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)
(page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Creates an strategic map. |= Description
Author: Vaclav "Watty Watts" Oliva
____________________________________________________________________________________________
 
| [target,mag,radius,rounds,delay,conditionEnd,safezone,alt,speed,sounds] call [[BIS_fnc_fireSupportVirtual]] |= Syntax


Description:
Virtual fire support of artillery/mortar unit.


Parameters:
|p1= target: [[Position]] or [[Object]] or [[String]] - Target position, can be an object position or marker|= Parameter 1
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:
|p2= mag: [[String]] - Magazine (if left empy, first magazine available will be used)|= Parameter 2
Boolean


Examples:
|p3= radius: [[Number]] - Radius of target area in meters|= Parameter 3
_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
|p4= rouds: [[Number]] - Number of rounds to be fired|= Parameter 4
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
 
____________________________________________________________________________________________
|p5= delay: [[Array]] or [[Number]] - Delay between rounds.
*[[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 ?) 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
 
|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
 
| [[Boolean]] - [[True]] if successful |= Return value


| <!-- [] call [[BIS_fnc_fireSupportVirtual]]; --> |= Syntax
|p1= |= Parameter 1


| |= Return value
|x1= <code>[ BIS_Player,"Sh_82mm_AMOS",100,24,10 ] [[spawn]] [[BIS_fnc_fireSupportVirtual]];;</code> |=
____________________________________________________________________________________________
|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> |=


|x1= <code></code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_fireSupportCluster]], [[BIS_fnc_fire]], [[BIS_fnc_fireSupport]]  |= See also
 
}}
}}



Revision as of 00:51, 28 May 2018

Hover & click on the images for description

Description

Description:
Creates an strategic map.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[target,mag,radius,rounds,delay,conditionEnd,safezone,alt,speed,sounds] call BIS_fnc_fireSupportVirtual
Parameters:
target: Position or Object or String - Target position, can be an object position or marker
mag: String - Magazine (if left empy, first magazine available will be used)
radius: Number - Radius of target area in meters
rouds: Number - Number of rounds to be fired
delay: Array or Number - Delay between rounds.
conditionEnd: Code - (Optional, default ?) Condition to end bombardment before all rounds are fired
safezone: Number - (Optional, default ?) 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_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