Difference between revisions of "getText"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Some wiki formatting)
 
(47 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma |= Game name
+
|game1= arma1
 +
|version1= 1.00
  
| 1.00|= Game version
+
|game2= arma2
____________________________________________________________________________________________
+
|version2= 1.00
  
| Extract text from config entry.  |= Description
+
|game3= arma2oa
____________________________________________________________________________________________
+
|version3= 1.50
  
| [[String]] <nowiki>=</nowiki> '''getText''' config|= Syntax
+
|game4= tkoh
|p1 =  config: [[Config]]
+
|version4= 1.00
| [[String]] |= Return value
 
____________________________________________________________________________________________
 
|x1 = <code> _text <nowiki>=</nowiki> '''getText''' (configFile >> "CfgVehicles" >> "Thing" >> "icon")  </code>
 
  
| [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |= See also
+
|game5= arma3
 +
|version5= 0.50
  
 +
|gr1= Config
 +
 +
|descr= 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]].
 +
 +
|s1= [[getText]] config
 +
 +
|p1= config: [[Config]]
 +
 +
|r1= [[String]] - text value
 +
 +
|x1= <code>_text = [[getText]] ([[configFile]] [[gtgt|>>]] "CfgVehicles" [[gtgt|>>]] "Thing" [[gtgt|>>]] "icon"); {{cc|"Get in %1 as Driver"}}</code>
 +
 +
|seealso= [[configFile]], [[config / name]], [[configName]], [[count]], [[getArray]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]], [[getTextRaw]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
 
  
<!-- Note Section END -->
+
<dt></dt>
 +
<dd class="notedate">Posted on Mar 28, 2014 - 07:52</dd>
 +
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
 +
<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>
 
</dl>
 
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|GETTEXT]]
 
[[Category:Scripting Commands ArmA|GETTEXT]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands VBS2|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 22:51, 13 June 2021

Hover & click on the images for description

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.
Groups:
Config

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

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
Posted on Mar 28, 2014 - 07:52
ffur2007slx2_5
(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: _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;