Difference between revisions of "VN fnc module masterArm"

Latest revision as of 20:19, 26 February 2021

Introduced in S.O.G. Prairie Fire v1.00
by Ethan Johnson

Argument(s):	global
Effect(s):	global

Master arm setup module function, uses VN_fnc_masterArm_actions.

Syntax: [logic, units, isActivated] call VN_fnc_module_masterarm
Parameters: logic: Object - the module logic; units: Array of Object - (Optional, default []) synchronised units, unused; isActivated: Boolean - (Optional, default true) is the module activated
Return value: Nothing

Example 1: [module, units group player, true] call VN_fnc_module_masterArm;

@@ Line 1: / Line 1: @@
-[[Category:TODO]]
 {{Function
@@ Line 6: / Line 5: @@
 |author= Ethan Johnson
-|a=
+|a= global
-|e=
+|e= global
 |g1= master_functions
-|d= <pre>/*
+|d= Master arm setup module function, uses [[VN_fnc_masterArm_actions]].
-        FILE: fn_module_masterarm.sqf
-        DATE: 24-11-2019
-        AUTHOR: Ethan Johnson
-        DESCRIPTION:
+|s= [logic, units, isActivated] call [[VN_fnc_module_masterarm]]
-                Master arm setup function
-        PARAMETERS:
-                (0): OBJECT - Logic unit.
-                (1): ARRAY - List of units.
-                (2): BOOLEAN - Activated variable.
-        RETURNS:
-                NONE
-*/
-</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
-|s= [] call [[VN_fnc_module_masterarm]]
+|p1n= logic
+|p1t= object
+|p1d= the module logic
+|p1v=
-|p1n=
+|p2n= units
-|p1t=
+|p2t= {{DataType|array}} of {{DataType|object}}
-|p1d=
+|p2d= synchronised units, unused
-|p1v=
+|p2v= []
-|p2n=
+|p3n= isActivated
-|p2t=
+|p3t= boolean
-|p2d=
+|p3d= is the module activated
-|p2v=
+|p3v= {{Biki|true}}
 |r1t=
 |r1d=
-|x1= <code>-</code>
+|x1= <code>[module, units group player, true] call [[VN_fnc_module_masterArm]];</code>
 }}