Difference between revisions of "VN ms module fnc tracker aoDynamicSimToggle"

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]]
 
 
{{Function
 
{{Function
  
Line 6: Line 5:
 
|author= Wyqer, veteran29
 
|author= Wyqer, veteran29
  
−
|a=
+
|a= global
  
 
|e=
 
|e=
Line 12: Line 11:
 
|g1= tracker
 
|g1= tracker
  
−
|d= <pre>/*
+
|d= Toggle {{Biki|enableDynamicSimulation|dynamic simulation}} for '''existing''' groups - the setting will not apply to groups spawned after execution. Uses [[VN_ms_module_fnc_tracker_aoGroups]].
−
    File: fn_tracker_aoDynamicSim.sqf
 
−
    Author: Wyqer, veteran29
 
−
    Date: 2020-10-14
 
−
    Last Update: 2020-10-14
 
−
    Public: Yes
 
  
−
    Description:
+
|s= [logic, enabled] call [[VN_ms_module_fnc_tracker_aoDynamicSimToggle]]
−
        Toggle dynamic simulation for EXISTING groups. Will not apply for groups spawned in future.
 
  
−
    Parameter(s):
+
|p1n= logic
−
        _logic - AO Module with groups to toggle from [OBJECT, defaults to objNull]
+
|p1t= object
−
        _enabled - Dynamic simulation state [BOOL, defaults to true]
+
|p1d= the module logic
−
 
 
−
    Returns:
 
−
        Groups that were processed [ARRAY]
 
−
 
 
−
    Example(s):
 
−
        [vn_ms_overlord, true] call vn_ms_module_fnc_tracker_aoDynamicSimToggle
 
−
*/
 
−
 
 
−
params [
 
−
    ["_logic", objNull, [objNull]],
 
−
    ["_enabled", true, [false]]
 
−
];
 
−
 
 
−
#ifdef VN_DEBUG
 
−
    systemChat format ["[VN_OVERLORD] Toggling dynamic sim: %1, %2", _logic, _enabled];
 
−
#endif
 
−
 
 
−
private _aoGroups = _logic call vn_ms_module_fnc_tracker_aoGroups;
 
−
</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
 
−
 
 
−
|s= [] call [[VN_ms_module_fnc_tracker_aoDynamicSimToggle]]
 
−
 
 
−
|p1n=
 
−
|p1t=
 
−
|p1d=
 
 
|p1v=
 
|p1v=
  
−
|p2n=
+
|p2n= enabled
−
|p2t=
+
|p2t= boolean
 
|p2d=
 
|p2d=
−
|p2v=
+
|p2v= true
  
−
|r1t=
+
|r1t= array
−
|r1d=
+
|r1d= processed groups
  
−
|x1= <code>-</code>
+
|x1= <code>[vn_ms_overlord, true] call [[VN_ms_module_fnc_tracker_aoDynamicSimToggle]];</code>
 
}}
 
}}

Latest revision as of 18:00, 26 February 2021

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

Description

Toggle dynamic simulation for existing groups - the setting will not apply to groups spawned after execution. Uses VN_ms_module_fnc_tracker_aoGroups.

Syntax

Syntax
[logic, enabled] call VN_ms_module_fnc_tracker_aoDynamicSimToggle
Parameters
logic: Object - the module logic
enabled: Boolean - (Optional, default true)
Return value
Array - processed groups

Examples

Example 1
[vn_ms_overlord, true] call VN_ms_module_fnc_tracker_aoDynamicSimToggle;
Retrieved from "https://wiki.sogpf.com/index.php?title=VN_ms_module_fnc_tracker_aoDynamicSimToggle&oldid=4197"