Difference between revisions of "VN ms fnc dgbt squadStart"

From Savage Game Design Wiki
Jump to navigation Jump to search
m (Text replacement - "[[vn_" to "[[VN_")
(Page filling)
 
Line 1: Line 1:
−
[[Category:TODO]][[Category:TODO]]
 
 
{{Function
 
{{Function
  
Line 6: Line 5:
 
|author= Wyqer, veteran29
 
|author= Wyqer, veteran29
  
−
|a=
+
|a= global
  
−
|e=
+
|e= global
  
 
|g1= dgbt
 
|g1= dgbt
  
−
|d= <pre>/*
+
|d= Starts the squad transport DGBT pickup phase - the random area being a square of 800m &times; 800m.
−
    Author: Wyqer, veteran29
 
−
    Date: 2019-07-13
 
  
−
    Description:
+
|s= [taskedGroup, pos, parentTask, unitClasses] call [[VN_ms_fnc_dgbt_squadStart]]
−
        Starts the squad transport DGBT pickup phase with given parameters.
 
  
−
    Parameter(s):
+
|p1n= taskedGroup
−
        _grp        - Group to create the task for.                                        [GROUP, defaults to grpNull]
+
|p1t= group
−
        _pos        - Position to spawn the squad to transport.                            [ARRAY, defaults to [0, 0, 0]]
+
|p1d= the group to receive the task
−
        _parentTask - Parent task for creation of the DGBT as child task. (optional)        [STRING, defaults to ""]
+
|p1v=
−
        _squad      - Classnames of the squad units which should be transported. (optional) [ARRAY, defaults to []]
 
  
−
    Returns:
+
|p2n= pos
−
        Group, all squad units and task ID as array on success or empty array [ARRAY]
+
|p2t= array
−
*/
+
|p2d= group to board ''helicopter''
−
 
+
|p2v=
−
</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
 
−
 
 
−
|s= [] call [[VN_ms_fnc_dgbt_squadStart]]
 
  
−
|p1n=
+
|p3n= parentTask
−
|p1t=
+
|p3t= string
−
|p1d=
+
|p3d= if provided, the task will be created as child to that parent task
−
|p1v=
+
|p3v= ""
  
−
|p2n=
+
|p4n= unitClasses
−
|p2t=
+
|p4t= array
−
|p2d=
+
|p4d= transported units' classnames
−
|p2v=
+
|p4v= <small>["vn_b_men_army_02", "vn_b_men_army_08", "vn_b_men_army_03", "vn_b_men_army_10", "vn_b_men_army_06", "vn_b_men_army_05"]</small>
  
−
|r1t=
+
|r1t= array
−
|r1d=
+
|r1d= format [squad group, units, currentTask, markerName]
  
−
|x1= <code>-</code>
+
|x1= <code>[helicopterGroup, getMarkerPos "LZ", nil, ["vn_b_men_army_01", "vn_b_men_army_02", "vn_b_men_army_03"]] call [[VN_ms_fnc_dgbt_squadStart]];</code>
 
}}
 
}}

Latest revision as of 21:19, 25 February 2021

← back to Functions Introduced in S.O.G. Prairie Fire v1.00
by Wyqer, veteran29
Argument(s): global
Effect(s): global

Description

Starts the squad transport DGBT pickup phase - the random area being a square of 800m × 800m.

Syntax

Syntax
[taskedGroup, pos, parentTask, unitClasses] call VN_ms_fnc_dgbt_squadStart
Parameters
taskedGroup: Group - the group to receive the task
pos: Array - group to board helicopter
parentTask: String - (Optional, default "") if provided, the task will be created as child to that parent task
unitClasses: Array - (Optional, default ["vn_b_men_army_02", "vn_b_men_army_08", "vn_b_men_army_03", "vn_b_men_army_10", "vn_b_men_army_06", "vn_b_men_army_05"]) transported units' classnames
Return value
Array - format [squad group, units, currentTask, markerName]

Examples

Example 1
[helicopterGroup, getMarkerPos "LZ", nil, ["vn_b_men_army_01", "vn_b_men_army_02", "vn_b_men_army_03"]] call VN_ms_fnc_dgbt_squadStart;
Retrieved from "https://wiki.sogpf.com/index.php?title=VN_ms_fnc_dgbt_squadStart&oldid=4146"