Difference between revisions of "getText"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
 
(29 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| ofp |= Game name
+
| arma |Game name=
  
−
|1.00|= Game version
+
| 1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
|  |= Description
+
| Extract text from config entry. |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| '''getText config''' |= Syntax
+
| [[String]] <nowiki>=</nowiki> '''getText''' config|SYNTAX=
−
 
+
|p1 =  config: [[Config]]
−
| |= Return value
+
| [[String]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 +
|x1 = <code>_text = [[getText]] ([[configFile]] [[gtgt|>>]] "CfgVehicles" [[gtgt|>>]] "Thing" [[gtgt|>>]] "icon");</code>
  
−
| |= See also
+
| [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |SEEALSO=
  
 
}}
 
}}
Line 22: Line 23:
 
<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>
Line 29: Line 55:
 
[[Category:Scripting Commands|GETTEXT]]
 
[[Category:Scripting Commands|GETTEXT]]
 
[[Category:Scripting Commands ArmA|GETTEXT]]
 
[[Category:Scripting Commands ArmA|GETTEXT]]
 +
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command Group: Config|{{uc:{{PAGENAME}}}}]]

Latest revision as of 10:44, 6 April 2020

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

Description

Description:
Extract text from config entry.

Syntax

Syntax:
String = getText config
Parameters:
config: Config
Return Value:
String

Examples

Example 1:
_text = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon");

Additional Information

See also:
configFileconfig/nameconfigNamecountgetArraygetNumberinheritsFromisArrayisClassisNumberisTextselect

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Add New Note | How To

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

Retrieved from "https://community.bistudio.com/wiki?title=getText&oldid=150672"