getNumber: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma1 |Game name= | | arma1 |Game name= | ||
Line 9: | Line 8: | ||
|1.00|Game version= | |1.00|Game version= | ||
| Extract number from config entry. |DESCRIPTION= | | Extract number from config entry. |DESCRIPTION= | ||
|'''getNumber''' config |SYNTAX= | |'''getNumber''' config |SYNTAX= | ||
Line 19: | Line 16: | ||
| [[Number]] |RETURNVALUE= | | [[Number]] |RETURNVALUE= | ||
|x1= <code>_value = [[getNumber]] ([[configFile]] [[gtgt|>>]] "CfgVehicles" [[gtgt|>>]] "Thing" [[gtgt|>>]] "maxSpeed");</code> |EXAMPLE1= | |x1= <code>_value = [[getNumber]] ([[configFile]] [[gtgt|>>]] "CfgVehicles" [[gtgt|>>]] "Thing" [[gtgt|>>]] "maxSpeed");</code> |EXAMPLE1= | ||
| [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getText]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |SEEALSO= | | [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getText]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |SEEALSO= |
Revision as of 02:42, 17 January 2021
Description
- Description:
- Extract number from config entry.
- Groups:
- Config
Syntax
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 entry. 1 equals true, 0 equals false.
- Posted on 13 September 2011
- Loki
- With an not existing entry, getNumber returns 0.
- Posted on Mar 28, 2014 - 07:53
- ffur2007slx2_5
-
(ArmA3 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:_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;