localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Some wiki formatting)
Line 26: Line 26:
|gr2= Localization
|gr2= Localization


|descr= Used to internationalize text messages. A string is returned from [[Stringtable.csv]] (or [[Stringtable.xml]]) which corresponds to the ''stringName''.
|descr= Used to internationalize text messages. The provided translation key is looked up in [[Stringtable.xml]] (or [[Stringtable.csv]]).


|s1= [[localize]] stringName
|s1= [[localize]] stringName


|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 {{GVI|arma3|2.04|size=0.75}} a string starting with "$" is supported


|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}}
|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= <sqf>hint localize "STR_WEST"; // Returns "BLUFOR"</sqf>
|x1= <sqf>hint localize "STR_WEST"; // returns "BLUFOR"</sqf>


|x2= <sqf>hint format ["Go %1", localize "STR_Q_NORTH"]; // Returns "Go North"</sqf>
|x2= <sqf>hint format ["Go %1", localize "STR_Q_NORTH"]; // returns "Go North"</sqf>


|x3= <sqf>
|x3= <sqf>
hint format  
hint format  
[
[
localize "STR_ACTION_DROP_WEAPON", // "STR_ACTION_DROP_WEAPON" contains "Drop %1"
localize "STR_ACTION_DROP_WEAPON", // "STR_ACTION_DROP_WEAPON" contains "Drop %1"
localize "STR_SN_RIFLE" // "STR_SN_RIFLE" contains "Rifle"
localize "STR_SN_RIFLE" // "STR_SN_RIFLE" contains "Rifle"
]; // Returns "Drop Rifle"
]; // returns "Drop Rifle"
</sqf>
</sqf>


|x4= <sqf>localize "$STR_USRACT_ADJUST"; // Since Arma 3 v2.04, Returns "Adjust"</sqf>
|x4= <sqf>localize "$STR_USRACT_ADJUST"; // returns "Adjust" since Arma 3 v2.04</sqf>


|seealso= [[isLocalized]] [[diag_localized]] [[getTextRaw]] [[BIS_fnc_localize]] [[WFSideText]] [[parseText]] [[Stringtable.csv]] [[Stringtable.xml]]
|seealso= [[isLocalized]] [[diag_localized]] [[getTextRaw]] [[BIS_fnc_localize]] [[WFSideText]] [[parseText]] [[Stringtable.csv]] [[Stringtable.xml]]
Line 64: Line 64:
</Key>
</Key>
</syntaxhighlight>
</syntaxhighlight>
<sqf>hint parseText localize "str_test_kk"; // no change of colour</sqf>
<sqf>
<sqf>hint parseText localize "str_test_kk2"; // hint content is in red</sqf>
hint parseText localize "str_test_kk"; // no change of colour
hint parseText localize "str_test_kk2"; // hint content is in red
</sqf>
}}
}}

Revision as of 12:21, 29 September 2022

Hover & click on the images for description

Description

Description:
Used to internationalize text messages. The provided translation key is looked up in Stringtable.xml (or Stringtable.csv).
Groups:
StringsLocalization

Syntax

Syntax:
localize stringName
Parameters:
stringName: String - string which leads to localisation. Casing does not matter. Since Arma 3 logo black.png2.04 a string starting with "$" is supported
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"; // returns "Adjust" since Arma 3 v2.04

Additional Information

See also:
isLocalized diag_localized getTextRaw BIS_fnc_localize WFSideText parseText Stringtable.csv Stringtable.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
Killzone_Kid - c
Posted on Sep 12, 2014 - 11:55 (UTC)
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