localize: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| ofp |Game name= | | ofp |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Strings |GROUP1= | |gr1= Strings |GROUP1= | ||
| Used to internationalise text messages. A string is returned from [[Stringtable.csv]] (or [[Stringtable.xml]]) which corresponds to the ''stringName''.<br> | | Used to internationalise 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, an empty string ({{Inline code|""}}) is returned and an entry is added to .rpt file, for example <tt>String STR_DN_SNAKE not found</tt>. |Description= | If the key couldn't be found, an empty string ({{Inline code|""}}) is returned and an entry is added to .rpt file, for example <tt>String STR_DN_SNAKE not found</tt>. |Description= | ||
| [[localize]] stringName |Syntax= | | [[localize]] stringName |Syntax= | ||
| Line 19: | Line 16: | ||
| [[String]] - text found in corresponding entry in stringtable file |Return value= | | [[String]] - text found in corresponding entry in stringtable file |Return value= | ||
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</code> |Example 1= | |x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</code> |Example 1= | ||
| Line 27: | Line 23: | ||
[[hint]] [[format]] [<nowiki/>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; {{codecomment|// -> "Drop Rifle"}}</code> |Example 3= | [[hint]] [[format]] [<nowiki/>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; {{codecomment|// -> "Drop Rifle"}}</code> |Example 3= | ||
| [[isLocalized]], [[BIS_fnc_localize]], [[WFSideText]], [[parseText]], [[Stringtable.csv]], [[Stringtable.xml]] |See also= | | [[isLocalized]], [[BIS_fnc_localize]], [[WFSideText]], [[parseText]], [[Stringtable.csv]], [[Stringtable.xml]] |See also= | ||
Revision as of 01:52, 17 January 2021
Description
- Description:
- Used to internationalise text messages. A string is returned from Stringtable.csv (or Stringtable.xml) which corresponds to the stringName.
If the key couldn't be found, an empty string ("") is returned and an entry is added to .rpt file, for example String STR_DN_SNAKE not found. - Groups:
- Strings
Syntax
- Syntax:
- localize stringName
- Parameters:
- stringName: String
- Return Value:
- String - text found in corresponding entry in stringtable file
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
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
Notes
Bottom Section
- 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><t color='#ff0000'>This works</t></Original> </Key>
hint parseText localize "str_test_kk"; // no change of colourhint parseText localize "str_test_kk2"; // hint content is in red
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Strings
- Scripting Commands OFP 1.46
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.99
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands