localize: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 26: | Line 26: | ||
|gr2= Localization | |gr2= Localization | ||
|descr= Used to internationalize text messages. | |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]] - | |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]] - | |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"; // | |x1= <sqf>hint localize "STR_WEST"; // returns "BLUFOR"</sqf> | ||
|x2= <sqf>hint format ["Go %1", localize "STR_Q_NORTH"]; // | |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" | ||
</sqf> | </sqf> | ||
|x4= <sqf>localize "$STR_USRACT_ADJUST"; // | |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"; | <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
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 2.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:
- Example 2:
- Example 3:
- 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
- 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><t color='#ff0000'>This works</t></Original> </Key>
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Strings
- Command Group: Localization