localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |game1= ofp |version1= 1.00 |game2= arma1 |version2= 1.00 |game3= arma2 |version3= 1.00 |game4= arma2oa |version4= 1.51 |game5= tkoh |version5= 1.00 |game6= arma3 |version6= 0.50 " to " |game1= ofp |version1= 1.00 |game...)
m (update v2.04)
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''.<br>
|descr= Used to internationalize text messages. A string is returned from [[Stringtable.csv]] (or [[Stringtable.xml]]) which corresponds to the ''string''.
If the key couldn't be found, for example <tt>"STR_DN_SNAKE"</tt>, empty string <tt>""</tt> is returned and an entry is added to .rpt file, for example <tt>String STR_DN_SNAKE not found</tt>.
{{Feature|arma3|Since Arma 3 v2.03.147223, [[localize]] accepts <tt>"$"</tt> symbol in localized name. For example:
<code>[[localize]] "str_west"; //"BLUFOR"</code>
<code>[[localize]] "$str_west"; //"BLUFOR"</code>
}}
{{Wiki | TODO | Remove above with 2.04 release, update examples }}


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


|p1= stringName: [[String]]
|p1= string: [[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 or empty string (see description)
|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>
   
   
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</code>
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{cc|Returns "BLUFOR"}}</code>


|x2= <code>[[hint]] [[format]] ["Go %1", [[localize]] "STR_Q_NORTH"]; {{codecomment|// -> "Go North"}}</code>
|x2= <code>[[hint]] [[format]] ["Go %1", [[localize]] "STR_Q_NORTH"]; {{cc|Returns "Go North"}}</code>


|x3= <code>{{codecomment|// STR_ACTION_DROP_WEAPON contains "Drop %1"
|x3= <code>[[hint]] [[format]]  
// STR_SN_RIFLE contains "Rifle"}}
[
[[hint]] [[format]] [<nowiki/>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; {{codecomment|// -> "Drop Rifle"}}</code>
  [[localize]] "STR_ACTION_DROP_WEAPON", {{cc|"STR_ACTION_DROP_WEAPON" contains "Drop %1"}}
  [[localize]] "STR_SN_RIFLE" {{cc|"STR_SN_RIFLE" contains "Rifle"}}
]; {{cc|Returns "Drop Rifle"}}</code>
 
|x4= <code>[[localize]] "$STR_USRACT_ADJUST"; {{cc|Since Arma 3 v2.04, Returns "Adjust"}}</code>


|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]]
}}
}}


<dl class="command_description">
<dl class="command_description">

Revision as of 14:54, 27 April 2021

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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 string.
Groups:
StringsLocalization

Syntax

Syntax:
localize stringName
Parameters:
string: 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

Retrieved from "https://community.bistudio.com/wiki?title=localize&oldid=256010"