BIS fnc getCfgDataBool: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "Strings" to "Strings")
 
(39 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Configs


|1.00|= Game version
|descr= Gets a number defined in config and retype it into a boolean. Everything greater than 0 is [[true]], otherwise it is [[false]].
____________________________________________________________________________________________
* Default syntax works for any config
* Alternative syntax is for comfortable working with mission's [[Description.ext]].


| <pre>/*
|s1= config call [[BIS_fnc_getCfgDataBool]]


Description:
|p1= config: [[Config]] - [[Config]] path
Get a number defined in cfg and retype it into a bool. Everything bigger then 0 is true, otherwise it's false.


Remark(s):
|r1= [[Boolean]]
* Can by called 2 ways:
* 1st way (general) works for any config.
* 2nd way is for comfortable working with mission description.ext.


Parameter(s):
|s2= array call [[BIS_fnc_getCfgDataBool]]
_this: CFG
_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.


Example:
|p21= [[Array]] of [[String]]s - [[missionConfigFile]] classes and an attribute


* 1st way of calling:
|r2= [[Boolean]]


_value = (missionconfigfile >> "Characters" >> "Default" >> "equipAdjust") call BIS_fnc_getCfgDataBool;
|x1= <sqf>private _value = (missionConfigFile >> "Characters" >> "Default" >> "equipAdjust") call BIS_fnc_getCfgDataBool;</sqf>


* 2nd way of calling:
|x2= <sqf>private _value = ["Characters", "Default", "equipAdjust"] call BIS_fnc_getCfgDataBool;</sqf>
 
_value = ["Characters","Default","equipAdjust"] call BIS_fnc_getCfgDataBool;
 
Returns:
BOOL
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_getCfgDataBool]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_getCfgData]] [[BIS_fnc_getCfgDataArray]] [[BIS_fnc_getCfgDataObject]] [[BIS_fnc_getCfgDataPool]]
}}
}}
<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:getCfgDataBool}}]]
[[Category:Functions|{{uc:getCfgDataBool}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getCfgDataBool}}]]

Latest revision as of 21:51, 16 February 2024

Hover & click on the images for description

Description

Description:
Gets a number defined in config and retype it into a boolean. Everything greater than 0 is true, otherwise it is false.
  • Default syntax works for any config
  • Alternative syntax is for comfortable working with mission's Description.ext.
Execution:
call
Groups:
Configs

Syntax

Syntax:
config call BIS_fnc_getCfgDataBool
Parameters:
config: Config - Config path
Return Value:
Boolean

Alternative Syntax

Syntax:
array call BIS_fnc_getCfgDataBool
Parameters:
Array of Strings - missionConfigFile classes and an attribute
Return Value:
Boolean

Examples

Example 1:
private _value = (missionConfigFile >> "Characters" >> "Default" >> "equipAdjust") call BIS_fnc_getCfgDataBool;
Example 2:
private _value = ["Characters", "Default", "equipAdjust"] call BIS_fnc_getCfgDataBool;

Additional Information

See also:
BIS_fnc_getCfgData BIS_fnc_getCfgDataArray BIS_fnc_getCfgDataObject BIS_fnc_getCfgDataPool

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