getText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|gr1= Config |GROUP1=
|gr1= Config






| 1.00|Game version=
| 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]]. |DESCRIPTION=
| 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 |SYNTAX=
| [[getText]] config


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


| [[String]] - text value |RETURNVALUE=
| [[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"); // "Get in %1 as Driver"</code>


| [[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]]
}}
}}



Revision as of 00:42, 18 January 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

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