Difference between revisions of "getText"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
 
(42 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
{{Command|= Comments
+
{{Command
−
____________________________________________________________________________________________
 
  
−
| arma |= Game name
+
| arma1
  
−
| 1.00|= Game version
+
|gr1= Config
−
____________________________________________________________________________________________
 
  
−
| Extract text from config entry.  |= Description
 
−
____________________________________________________________________________________________
 
  
−
| '''getText''' config |= Syntax
 
−
|p1 = config: [[Config]]
 
−
| [[String]] |= Return value
 
−
____________________________________________________________________________________________
 
−
|x1 = <code> _array <nowiki>=</nowiki> '''getText''' (configFile >> "CfgVehicles" >> "Thing" >> "icon")  </code>
 
−
|  |= See also
 
  
 +
| 1.00
 +
 +
| 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]].
 +
 +
| [[getText]] config
 +
 +
|p1 =  config: [[Config]]
 +
 +
| [[String]] - text value
 +
 +
|x1 = <code>_text = [[getText]] ([[configFile]] [[gtgt|>>]] "CfgVehicles" [[gtgt|>>]] "Thing" [[gtgt|>>]] "icon"); // "Get in %1 as Driver"</code>
 +
 +
| [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]], [[getTextRaw]]
 
}}
 
}}
  
Line 22: Line 25:
 
<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>
  
−
<h3 style="display:none">Bottom Section</h3>
+
{{GameCategory|arma2|Scripting Commands}}
−
[[Category:Scripting Commands|GETTEXT]]
+
{{GameCategory|arma3|Scripting Commands}}
−
[[Category:Scripting Commands ArmA|GETTEXT]]
+
{{GameCategory|tkoh|Scripting Commands}}
−
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
 
−
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 01:44, 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.

+ Add Note (Help)

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;
Retrieved from "https://community.bistudio.com/wiki?title=getText&oldid=207845"