Difference between revisions of "BIS fnc configExtremes"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 12: Line 12:
  
 
|Scan config paths and return min and max values for each property.
 
|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). |= Description
+
<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
+
| <nowiki>[paths, properties, (propertyTypes, propertyDefaults)]</nowiki> call [[BIS_fnc_configExtremes]] |SYNTAX=
  
 
|p1= paths: [[Array]] of [[Config]]s - paths to be scanned. |= Parameter 1
 
|p1= paths: [[Array]] of [[Config]]s - paths to be scanned. |= Parameter 1
Line 25: Line 25:
 
|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 |= Parameter 4
 
|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 |= Parameter 4
  
| [[Array]] - [minValues, maxValues] where minValues and maxValues are arrays respective to the properties array. |= Return Value
+
| [[Array]] - [minValues, maxValues] where minValues and maxValues are arrays respective to the properties array. |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
Line 31: Line 31:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
| |SEEALSO=
  
 
}}
 
}}

Revision as of 11:26, 7 April 2019


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:
Uncategorised

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 (Optional): Array of Booleans - whether the property at the respective index should be evaluated and returned as a logarithmic number. Default: false
propertyDefaults (Optional): Array of Numbers - value to be used in cases where the property at the respective index is not defined. Default: 0
Return Value:
Array - [minValues, maxValues] where minValues and maxValues are arrays respective to the properties array.

Examples

Example 1:
[[configFile >> "cfgWeapons"] call BIS_fnc_returnChildren, ["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

Notes

Bottom Section