getNumber

From Bohemia Interactive Community
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Extract number from config entry.
Groups:
Config

Syntax

Syntax:
getNumber config
Parameters:
config: Config
Return Value:
Number

Examples

Example 1:
_value = getNumber (configFile >> "CfgVehicles" >> "Thing" >> "maxSpeed");

Additional Information

See also:
configFile a / b configName count getArray getText inheritsFrom isArray isClass isNumber isText select

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
Donnervogel - c
Posted on Mar 03, 2007 - 04:45 (UTC)
Use getNumber to get boolean values from a config entry. 1 equals true, 0 equals false.
Loki - c
Posted on Sep 13, 2011 - 00:44 (UTC)
With an not existing entry, getNumber returns 0.
ffur2007slx2_5 - c
Posted on Mar 28, 2014 - 07:53 (UTC)
(Arma 3 1.14), It's recommended to use BIS_fnc_getCfgData or BIS_fnc_returnConfigEntry to get variable cfg data rather than conditioning via isNumber, isText, isArray, getNumber, getText and getArray combination.
Traditional workaround:
private _cfg = configFile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type"; switch (true) do { case (isNumber _cfg): { getNumber _cfg }; case (isText _cfg): { getText _cfg }; case (isArray _cfg): { getArray _cfg }; default { nil }; };
Recommended workaround:
(configFile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") call BIS_fnc_getCfgData;
To return default value once entry was not found, we can use BIS_fnc_returnConfigEntry instead of BIS_fnc_getCfgData.
[(configFile >> "CannonFire" >> "LightExp"),"lifeTime",0] call BIS_fnc_returnConfigEntry; // 0.5
To compose collected Number into Array, use BIS_fnc_getCfgDataArray instead.
(configFile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") call BIS_fnc_getCfgDataArray;
To retype collected Number into Boolean, use BIS_fnc_getCfgDataBool. Anything bigger than 0 is true, otherwise false.
(configFile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") call BIS_fnc_getCfgDataBool;