Difference between revisions of "VN ms fnc dgbt crateStart"

From Savage Game Design Wiki
Jump to navigation Jump to search
m (Text replacement - " {{Function" to "Category:TODO {{Function")
(Page filling)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
[[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 crate transport DGBT pickup phase with given parameters. Uses [[VN_ms_fnc_dgbt_generateTaskId]].
−
    Author: Wyqer, veteran29
 
−
    Date: 2019-07-13
 
  
−
    Description:
+
|s= [group, pos, parentTask, boxClass] call [[VN_ms_fnc_dgbt_crateStart]]
−
        Starts the crate transport DGBT pickup phase with given parameters.
 
  
−
    Parameter(s):
+
|p1n= group
−
        _grp        - Group to create the task for.                                    [GROUP, defaults to grpNull]
+
|p1t= group
−
        _pos        - Position to spawn the crate to transport.                        [ARRAY, defaults to [0, 0, 0]]
+
|p1d= task bearer
−
        _parentTask - Parent task for creation of the DGBT as child task. (optional)    [STRING, defaults to ""]
+
|p1v=
−
        _box        - Classname of the box which should be transported. (optional)      [STRING, defaults to "vn_b_ammobox_supply_05"]
 
  
−
    Returns:
+
|p2n= pos
−
        Crate object and task as array on success or empty array [ARRAY]
+
|p2t= array
−
*/
+
|p2d= box spawn position
−
 
+
|p2v=
−
</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
 
−
 
 
−
|s= [] call [[vn_ms_fnc_dgbt_crateStart]];
 
  
−
|p1n=
+
|p3n= parentTask
−
|p1t=
+
|p3t= string
−
|p1d=
+
|p3d= if provided, the task will be parent task
−
|p1v=
+
|p3v= ""
  
−
|p2n=
+
|p4n= boxClass
−
|p2t=
+
|p4t= string
−
|p2d=
+
|p4d= box classname to be created
−
|p2v=
+
|p4v= "vn_b_ammobox_supply_05"
  
−
|r1t=
+
|r1t= array
−
|r1d=
+
|r1d= [crate, task] or empty array on failure
  
−
|x1= <code>-</code>
+
|x1= <code>[group player, getMarkerPos "crate_pos", "", "vn_b_ammobox_supply_04"] call [[VN_ms_fnc_dgbt_crateStart]];</code>
 
}}
 
}}

Latest revision as of 18:15, 23 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 crate transport DGBT pickup phase with given parameters. Uses VN_ms_fnc_dgbt_generateTaskId.

Syntax

Syntax
[group, pos, parentTask, boxClass] call VN_ms_fnc_dgbt_crateStart
Parameters
group: Group - task bearer
pos: Array - box spawn position
parentTask: String - (Optional, default "") if provided, the task will be parent task
boxClass: String - (Optional, default "vn_b_ammobox_supply_05") box classname to be created
Return value
Array - [crate, task] or empty array on failure

Examples

Example 1
[group player, getMarkerPos "crate_pos", "", "vn_b_ammobox_supply_04"] call VN_ms_fnc_dgbt_crateStart;
Retrieved from "https://wiki.sogpf.com/index.php?title=VN_ms_fnc_dgbt_crateStart&oldid=4138"