BIS fnc getCfgDataBool: Difference between revisions

Latest revision as of 21:51, 16 February 2024

1.00

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= Configs
-____________________________________________________________________________________________
-| Gets a number defined in [[Config]] and retype it into a [[Boolean]]. Everything bigger then 0 is [[true]], otherwise it's [[false]].|Description=
+|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]].
-| config call [[BIS_fnc_getCfgDataBool]] |Syntax=
+|s1= config call [[BIS_fnc_getCfgDataBool]]
+|p1= config: [[Config]] - [[Config]] path
-|p1= config: [[Config]] - [[Config]] path |Parameter 1=
+|r1= [[Boolean]]
+|s2= array call [[BIS_fnc_getCfgDataBool]]
-| [[Boolean]] |Return value=
+|p21= [[Array]] of [[String]]s - [[missionConfigFile]] classes and an attribute
-|exec= call |= Execution
+|r2= [[Boolean]]
-____________________________________________________________________________________________
-|s2= array call [[BIS_fnc_getCfgDataBool]] |Alternative Syntax=
+|x1= <sqf>private _value = (missionConfigFile >> "Characters" >> "Default" >> "equipAdjust") call BIS_fnc_getCfgDataBool;</sqf>
-|p21= [[Array]] of [[Strings]] - [[missionConfigFile]] classes and an attribute |Alternative Parameter 1=
+|x2= <sqf>private _value = ["Characters", "Default", "equipAdjust"] call BIS_fnc_getCfgDataBool;</sqf>
-|r2= [[Boolean]] |Alternative Return Value=
+|seealso= [[BIS_fnc_getCfgData]] [[BIS_fnc_getCfgDataArray]] [[BIS_fnc_getCfgDataObject]] [[BIS_fnc_getCfgDataPool]]
-|x1= <code> _value = ([[missionConfigFile]] >> "Characters" >> "Default" >> "equipAdjust") [[call]] [[BIS_fnc_getCfgDataBool]];</code>|Example 1=
-|x2= <code> _value = ["Characters","Default","equipAdjust"] [[call]] [[BIS_fnc_getCfgDataBool]];</code>|Example 1=
-____________________________________________________________________________________________
-| [[BIS_fnc_getCfgData]], [[BIS_fnc_getCfgDataArray]], [[BIS_fnc_getCfgDataObject]], [[BIS_fnc_getCfgDataPool]]|See also=
 }}
-<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}}]]