getNumber

From Bohemia Interactive Community
Revision as of 10:31, 3 April 2014 by Ffur2007slx2 5 (talk | contribs) (Add BIS_fnc_returnConfigEntry as an enhanced fnc to bis_fnc_getcfgdata)
Jump to navigation Jump to search
-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Extract number from config entry.
Groups:
Uncategorised

Syntax

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

Examples

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

Additional Information

See also:
configFileconfig/nameconfigNamecountgetArraygetTextinheritsFromisArrayisClassisNumberisTextselect

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

Posted on 04:45, 3 March 2007 (CET)
Donnervogel
use getNumber to get boolean values from a config file. 1 equals true, 0 equals false and if no value is found (when a valid variable is undefined) 0.67 is returned.
Posted on 13 September 2011
Loki
With an not existing entry, getNumber returns 0.
Posted on Mar 28, 2014 - 07:53
ffur2007slx2_5
In ArmA3 ver 1.14, it is 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. E.g.
Traditional workaround: _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. e.g. [(configfile >> "CannonFire" >> "LightExp"),"lifeTime",0] call BIS_fnc_returnConfigEntry;//0.5 To compose collected Number into Array, use BIS_fnc_getCfgDataArray instead. E.g. (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. e.g. (configfile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") call BIS_fnc_getCfgDataBool;

Bottom Section