localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
m (Text replacement - "<tt>([a-zA-Z0-9\. _"']+)<\/tt>" to "{{hl|$1}}")
Line 32: Line 32:
|p1= stringName: [[String]] - String which leads to localisation. Casing does not matter. Since Arma 3 v2.04 a string starting with "$" is supported as well
|p1= stringName: [[String]] - String which leads to localisation. Casing does not matter. Since Arma 3 v2.04 a string starting with "$" is supported as well


|r1= [[String]] -  Text found in corresponding entry in stringtable file. If the key could not be found an empty string <tt>""</tt> is returned and an entry is added to .rpt file, for example <tt>String STR_DN_SNAKE not found</tt>
|r1= [[String]] -  Text found in corresponding entry in stringtable file. If the key could not be found an empty string {{hl|""}} is returned and an entry is added to .rpt file, for example {{hl|String STR_DN_SNAKE not found}}


|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{cc|Returns "BLUFOR"}}</code>
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{cc|Returns "BLUFOR"}}</code>

Revision as of 00:44, 16 November 2021

Hover & click on the images for description

Description

Description:
Used to internationalize text messages. A string is returned from Stringtable.csv (or Stringtable.xml) which corresponds to the stringName.
Groups:
StringsLocalization

Syntax

Syntax:
localize stringName
Parameters:
stringName: String - String which leads to localisation. Casing does not matter. Since Arma 3 v2.04 a string starting with "$" is supported as well
Return Value:
String - Text found in corresponding entry in stringtable file. If the key could not be found an empty string "" is returned and an entry is added to .rpt file, for example String STR_DN_SNAKE not found

Examples

Example 1:
hint localize "STR_WEST"; // Returns "BLUFOR"
Example 2:
hint format ["Go %1", localize "STR_Q_NORTH"]; // Returns "Go North"
Example 3:
hint format [ localize "STR_ACTION_DROP_WEAPON", // "STR_ACTION_DROP_WEAPON" contains "Drop %1" localize "STR_SN_RIFLE" // "STR_SN_RIFLE" contains "Rifle" ]; // Returns "Drop Rifle"
Example 4:
localize "$STR_USRACT_ADJUST"; // Since Arma 3 v2.04, Returns "Adjust"

Additional Information

See also:
isLocalizeddiag_localizedgetTextRawBIS_fnc_localizeWFSideTextparseTextStringtable.csvStringtable.xml

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