localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Changed Informative to Feature|arma3)
No edit summary
Line 8: Line 8:


| Used to internationalize text messages. A string is returned from [[Stringtable.csv]] (or [[Stringtable.xml]]) which corresponds to the ''stringName''.<br>
| Used to internationalize text messages. A string is returned from [[Stringtable.csv]] (or [[Stringtable.xml]]) which corresponds to the ''stringName''.<br>
If the key couldn't be found, for example <tt>"STR_DN_SNAKE"</tt>, string {{Inline code|"Missing string 'STR_DN_SNAKE'"}} is returned and an entry is added to .rpt file, for example <tt>String STR_DN_SNAKE not found</tt>.
If the key couldn't be found, for example <tt>"STR_DN_SNAKE"</tt>, empty string <tt>""</tt> is returned and an entry is added to .rpt file, for example <tt>String STR_DN_SNAKE not found</tt>.


{{Feature|arma3|Since Arma 3 v2.03.147217, [[localize]] accepts <tt>"$IDS<number>"</tt> and <tt>"$STR<name>"</tt> localization template formats. For example:  
{{Feature|arma3|Since Arma 3 v2.03.147217, [[localize]] accepts <tt>"$IDS<number>"</tt> and <tt>"$STR<name>"</tt> localization template formats. For example:  
Line 19: Line 19:
|p1= stringName: [[String]]
|p1= stringName: [[String]]


| [[String]]
| [[String]] text found in corresponding entry in stringtable file or empty string (see description)
* {{Since|arma3|2.03.147217}}: text found in corresponding entry in stringtable file or missing string message (see description)
* ''before {{arma3}} v2.03.147217'': empty string is returned if key could not be found
 
   
   
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</code>
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</code>

Revision as of 13:11, 5 February 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
Strings

Syntax

Syntax:
Syntax needed
Parameters:
stringName: String
Return Value:
Return value needed

Examples

Example 1:
hint localize "STR_WEST"; // -> "BLUFOR" (in Arma2)
Example 2:
hint format ["Go %1", localize "STR_Q_NORTH"]; // -> "Go North"
Example 3:
// STR_ACTION_DROP_WEAPON contains "Drop %1" // STR_SN_RIFLE contains "Rifle" hint format [localize "STR_ACTION_DROP_WEAPON", localize "STR_SN_RIFLE"]; // -> "Drop Rifle"

Additional Information

See also:
See also needed

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 September 12, 2014 - 11:55 (UTC)
Killzone Kid
The command localize will strip all HTML tags from your stringtable.xml entries, however there is a way to trick it by substituting tags with HTML code instead:
<?xml version="1.0" encoding="utf-8"?>
<Key ID="STR_TEST_KK">
	<Original><![CDATA[<t color='#ff0000'>This doesn't work</t>]]></Original>
</Key>
<Key ID="STR_TEST_KK2">
	<Original>&lt;t color='#ff0000'&gt;This works&lt;/t&gt;</Original>
</Key>

hint parseText localize "str_test_kk"; // no change of colour hint parseText localize "str_test_kk2"; // hint content is in red