Difference between revisions of "VN fnc module cinematic"

Latest revision as of 20:22, 26 February 2021

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

Argument(s):	n/a
Effect(s):	unknown

Cinematic module base. Uses VN_fnc_cinematic_play.

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

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

@@ Line 1: / Line 1: @@
-[[Category:TODO]]
 {{Function
@@ Line 12: / Line 11: @@
 |g1= master_functions
-|d= <pre>/*
+|d= Cinematic module base. Uses [[VN_fnc_cinematic_play]].
-        FILE: fn_module_cinematic.sqf
-        DATE: 25-11-2019
-        AUTHOR: Ethan Johnson
-        DESCRIPTION:
+|s= [logic, units, isActivated] call [[VN_fnc_module_cinematic]]
-                Cinematic module base
-        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_cinematic]];
+|p1n= logic
+|p1t= object
-|p1n=
+|p1d= the module logic
-|p1t=
-|p1d=
 |p1v=
-|p2n=
+|p2n= units
-|p2t=
+|p2t= {{DataType|array}} of {{DataType|object}}
-|p2d=
+|p2d= synchronised units
 |p2v=
+|p3n= isActivated
+|p3t= boolean
+|p3d= is the module activated
+|p3v= {{Biki|true}}
 |r1t=
 |r1d=
-|x1= <code>-</code>
+|x1= <code>[module, units group player, true] call [[VN_fnc_module_cinematic]];</code>
 }}