Difference between revisions of "BIS fnc configExtremes"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name " to "|Game name= ")
m (Some wiki formatting)
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{RV|type=function
  
{{Function|Comments=
+
|game1= arma3
____________________________________________________________________________________________
+
|version1= 1.36
  
| arma3 |Game name=
+
|gr1= Configs
  
|1.36|= Game version
+
|descr= Scan config paths and return min and max values for each property.<br>
 +
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).
  
|arg= |MPARGUMENTS=
+
|s1= [paths, properties, propertyTypes, propertyDefaults] call [[BIS_fnc_configExtremes]]
|eff= |= Effects in MP
 
____________________________________________________________________________________________
 
  
|Scan config paths and return min and max values for each property.
+
|p1= paths: [[Array]] of [[Config]]s - paths to be scanned.
<br>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). |DESCRIPTION=
 
____________________________________________________________________________________________
 
  
| <nowiki>[paths, properties, (propertyTypes, propertyDefaults)]</nowiki> call [[BIS_fnc_configExtremes]] |SYNTAX=
+
|p2= properties: [[Array]] of [[String]]s - class names of properties to be evaluated.
  
|p1= paths: [[Array]] of [[Config]]s - paths to be scanned. |PARAMETER1=
+
|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
  
|p2= properties: [[Array]] of [[String]]s - class names of properties to be evaluated. |PARAMETER2=
+
|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
  
|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]] |PARAMETER3=
+
|r1= [[Array]] - [minValues, maxValues] where minValues and maxValues are arrays respective to the properties array.
  
|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 |PARAMETER4=
+
|x1= <sqf>
 
+
private _paths = [configFile >> "CfgWeapons"] call BIS_fnc_returnChildren;
| [[Array]] - [minValues, maxValues] where minValues and maxValues are arrays respective to the properties array. |RETURNVALUE=
+
[_paths, ["maxRange", "reloadTime"]] call BIS_fnc_configExtremes;
____________________________________________________________________________________________
+
</sqf>
 
 
|x1= <code>[<nowiki>[</nowiki>[[configFile]] >> "cfgWeapons"] call [[BIS_fnc_returnChildren]], ["maxRange","reloadTime"]] call [[BIS_fnc_configExtremes]];</code> |EXAMPLE1=
 
____________________________________________________________________________________________
 
 
 
| |SEEALSO=
 
  
 +
|seealso=
 
}}
 
}}
 
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
 
<!-- Note Section END -->
 
</dl>
 
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Function Group: Configs|{{uc:configExtremes}}]]
 
[[Category:Functions|{{uc:configExtremes}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:configExtremes}}]]
 

Latest revision as of 12:09, 13 July 2022

Hover & click on the images for description

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

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.

Examples

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

Additional Information

See also:
See also needed

Notes

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