localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(formatting and new command group)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp


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


|gr1= Strings
|gr1= Strings


| Used to internationalize text messages. A string is returned from [[Stringtable.csv]] (or [[Stringtable.xml]]) which corresponds to the ''stringName''.<br>
|gr2= Localization
 
|descr= Used to internationalize 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, 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>.
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:  
{{Feature|arma3|Since Arma 3 v2.03.147223, [[localize]] accepts <tt>"$"</tt> symbol in localized name. For example:  
Line 15: Line 37:
{{Wiki | TODO | Remove above with 2.04 release, update examples }}
{{Wiki | TODO | Remove above with 2.04 release, update examples }}


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


|p1= stringName: [[String]]
|p1= stringName: [[String]]


| [[String]] text found in corresponding entry in stringtable file or empty string (see description)
|r1= [[String]] text found in corresponding entry in stringtable file or empty string (see description)
   
   
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</code>
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</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"]; {{codecomment|// -> "Go North"}}</code>
|x3= <code>{{codecomment|// STR_ACTION_DROP_WEAPON contains "Drop %1"
|x3= <code>{{codecomment|// STR_ACTION_DROP_WEAPON contains "Drop %1"
// STR_SN_RIFLE contains "Rifle"}}
// STR_SN_RIFLE contains "Rifle"}}
[[hint]] [[format]] [<nowiki/>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; {{codecomment|// -> "Drop Rifle"}}</code>
[[hint]] [[format]] [<nowiki/>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; {{codecomment|// -> "Drop Rifle"}}</code>


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


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->

Revision as of 10:57, 13 March 2021

Logo A0.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh 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 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

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