localize

From Bohemia Interactive Community
Revision as of 23:23, 24 March 2021 by Lou Montana (talk | contribs) (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#))?\]\] " to "")
Jump to navigation Jump to search
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.
If the key couldn't be found, for example "STR_DN_SNAKE", empty string "" is returned and an entry is added to .rpt file, for example String STR_DN_SNAKE not found.
Arma 3
Since Arma 3 v2.03.147223, localize accepts "$" symbol in localized name. For example:

localize "str_west"; //"BLUFOR"

localize "$str_west"; //"BLUFOR"
🚧
TODO: Remove above with 2.04 release, update examples
Groups:
StringsLocalization

Syntax

Syntax:
localize stringName
Parameters:
stringName: String
Return Value:
String text found in corresponding entry in stringtable file or empty string (see description)

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:
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