Difference between revisions of "getText"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - " {3,}\|" to " |")
 
(48 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|GETTEXT]]
+
{{Command
[[Category:Scripting Commands ArmA|GETTEXT]]
 
  
 +
| arma1
  
<h2 style="color:#000066"> ''' getText  '' config'''''</h2>
+
|gr1= Config
  
 +
| 1.00
  
'''Operand types:'''
+
| Extracts [[localize]]d text from config entry, if entry is subject to [[localize | localization]], otherwise returns text value. To obtain the translation key itself, see [[getTextRaw]].
  
'''config''': [[Config]]
+
| [[getText]] config
   
 
'''Type of returned value:'''
 
  
[[String]]
+
|p1 =  config: [[Config]]
  
'''Compatibility:'''
+
| [[String]] - text value
  
Version 2.35 required.
+
|x1 = <code>_text = [[getText]] ([[configFile]] [[gtgt|>>]] "CfgVehicles" [[gtgt|>>]] "Thing" [[gtgt|>>]] "icon"); // "Get in %1 as Driver"</code>
  
'''Description:'''
+
| [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]], [[getTextRaw]]
 +
}}
  
Extract text from config entry.
+
<dl class="command_description">
 +
<!-- 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 -->
 +
</dl>
  
'''Example:'''
+
{{GameCategory|arma2|Scripting Commands}}
 
+
{{GameCategory|arma3|Scripting Commands}}
_array = '''getText''' (configFile >> "CfgVehicles" >> "Thing" >> "icon")
+
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 17:38, 18 January 2021

Introduced with Armed Assault version 1.001.00
Hover & click on the images for descriptions

Description

Description:
Extracts localized text from config entry, if entry is subject to localization, otherwise returns text value. To obtain the translation key itself, see getTextRaw.

Syntax

Syntax:
getText config
Parameters:
config: Config
Return Value:
String - text value

Examples

Example 1:
_text = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon"); // "Get in %1 as Driver"

Additional Information

See also:
configFileconfig/nameconfigNamecountgetArraygetNumberinheritsFromisArrayisClassisNumberisTextselectgetTextRaw
Groups:
Config

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.
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;