BIS fnc configExtremes: Difference between revisions

Latest revision as of 12:09, 13 July 2022

Hover & click on the images for description

Description:: Scan config paths and return min and max values for each property.
Can be used only for properties of type Number and Array (value is considered to be the geometric mean of all numbers in the array).
Execution:: call
Groups:: Configs

Syntax:: [paths, properties, propertyTypes, propertyDefaults] call BIS_fnc_configExtremes
Parameters:: paths: Array of Configs - paths to be scanned.
: properties: Array of Strings - class names of properties to be evaluated.
: propertyTypes: Array of Booleans - (Optional, default false) whether the property at the respective index should be evaluated and returned as a logarithmic number
: propertyDefaults: Array of Numbers - (Optional, default 0) value to be used in cases where the property at the respective index is not defined
Return Value:: Array - [minValues, maxValues] where minValues and maxValues are arrays respective to the properties array.

Example 1:: private _paths = [configFile >> "CfgWeapons"] call BIS_fnc_returnChildren; [_paths, ["maxRange", "reloadTime"]] call BIS_fnc_configExtremes;

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 15: / Line 15: @@
 |p2= properties: [[Array]] of [[String]]s - class names of properties to be evaluated.
-|p3= propertyTypes (Optional): [[Array]] of [[Boolean]]s - whether the property at the respective index should be evaluated and returned as a [[log]]arithmic number. Default: [[false]]
+|p3= propertyTypes: [[Array]] of [[Boolean]]s - (Optional, default [[false]]) whether the property at the respective index should be evaluated and returned as a [[log]]arithmic number
-|p4= propertyDefaults (Optional): [[Array]] of [[Number]]s - value to be used in cases where the property at the respective index is not defined. Default: 0
+|p4= propertyDefaults: [[Array]] of [[Number]]s - (Optional, default 0) value to be used in cases where the property at the respective index is not defined
 |r1= [[Array]] - [minValues, maxValues] where minValues and maxValues are arrays respective to the properties array.
-|x1= <code>[[private]] _paths = [<nowiki/>[[configFile]] >> "cfgWeapons"] [[call]] [[BIS_fnc_returnChildren]];
+|x1= <sqf>
-[_paths, ["maxRange", "reloadTime"]] call [[BIS_fnc_configExtremes]];</code>
+private _paths = [configFile >> "CfgWeapons"] call BIS_fnc_returnChildren;
+[_paths, ["maxRange", "reloadTime"]] call BIS_fnc_configExtremes;
+</sqf>
 |seealso=
 }}