getText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(5 intermediate revisions by 2 users not shown)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Extract text from config entry.  |= Description
| Extract text from config entry.  |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[String]] <nowiki>=</nowiki> '''getText''' config|= Syntax
| [[String]] <nowiki>=</nowiki> '''getText''' config|SYNTAX=
|p1 =  config: [[Config]]
|p1 =  config: [[Config]]
| [[String]] |= Return value
| [[String]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1 = <code> _text <nowiki>=</nowiki> '''getText''' (configFile >> "CfgVehicles" >> "Thing" >> "icon") </code>
|x1 = <code>_text = [[getText]] ([[configFile]] [[gtgt|>>]] "CfgVehicles" [[gtgt|>>]] "Thing" [[gtgt|>>]] "icon");</code>


| [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |= See also
| [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |SEEALSO=


}}
}}
Line 23: Line 23:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
 
<dd class="notedate">Posted on Mar 28, 2014 - 07:52
<dt class="note">'''[[User:ffur2007slx2_5|ffur2007slx2_5]]'''<dd class="note">
(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.<br>
Traditional workaround:
<code>
_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 };
};
</code>
'''Recommended workaround:'''
<code>
([[configFile]] >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") [[call]] [[BIS_fnc_GetCfgData]];
</code>
To return default value once entry was not found, we can use [[BIS_fnc_returnConfigEntry]] instead of [[BIS_fnc_GetCfgData]]. e.g.
<code>
[([[configFile]] >> "CannonFire" >> "LightExp"),"lifeTime",0] [[call]] [[BIS_fnc_returnConfigEntry]];//0.5
</code>
To compose collected [[String]] into [[Array]], use [[BIS_fnc_getCfgDataArray]] instead. E.g.
<code>
([[configFile]] >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") [[call]] [[BIS_fnc_getCfgDataArray]];
</code>
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>

Revision as of 15:40, 7 April 2019

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Extract text from config entry.
Groups:
Uncategorised

Syntax

Syntax:
String = getText config
Parameters:
config: Config
Return Value:
String

Examples

Example 1:
_text = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon");

Additional Information

See also:
configFileconfig/nameconfigNamecountgetArraygetNumberinheritsFromisArrayisClassisNumberisTextselect

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 Mar 28, 2014 - 07:52
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. e.g. [(configFile >> "CannonFire" >> "LightExp"),"lifeTime",0] call BIS_fnc_returnConfigEntry;//0.5 To compose collected String into Array, use BIS_fnc_getCfgDataArray instead. E.g. (configFile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") call BIS_fnc_getCfgDataArray;

Bottom Section