getText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(([^=\| ]+)('''|\[\[)([^=\| ]+)) * \|p1=" to " |s1= $1 |p1=")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00
 
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|gr1= Config
|gr1= Config


| 1.00
|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]].


| 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


|s1=  [[getText]] config
|p1= config: [[Config]]
 
|p1= config: [[Config]]


|r1= [[String]] - text value
|r1= [[String]] - text value


|x1= <code>_text = [[getText]] ([[configFile]] [[gtgt|>>]] "CfgVehicles" [[gtgt|>>]] "Thing" [[gtgt|>>]] "icon"); // "Get in %1 as Driver"</code>
|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]]
|seealso= [[configFile]], [[config / name]], [[configName]], [[count]], [[getArray]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]], [[getTextRaw]]
Line 47: Line 59:
</code>
</code>
</dl>
</dl>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

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;