localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
(not found strings are logged in .rpt)
(37 intermediate revisions by 15 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#L|COMREF]]
{{Command|Comments=
____________________________________________________________________________________________


<h2 style="color:#000066"> '''localize ''stringName'''''</h2>
| ofp |Game name=


|1.00|Game version=
____________________________________________________________________________________________


'''Operand types:'''
| 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=
____________________________________________________________________________________________


'''stringName:''' [[String]]
| [[localize]] stringName |Syntax=


'''Type of returned value:'''
|p1= stringName: [[String]] |Parameter 1=


[[String]]
| [[String]] - text found in corresponding entry in stringtable file |Return value=


'''Description:'''
____________________________________________________________________________________________
 
|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</code> |Example 1=
|x2= <code>[[hint]] [[format]] ["Go %1", [[localize]] "STR_Q_NORTH"]; {{codecomment|// -> "Go North"}}</code> |Example 2=
|x3= <code>{{codecomment|// STR_ACTION_DROP_WEAPON contains "Drop %1"
// STR_SN_RIFLE contains "Rifle"}}
[[hint]] [[format]] <nowiki>[</nowiki>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; {{codecomment|// -> "Drop Rifle"}}</code> |Example 3=


Replace string with given '''stringName''' with corresponding localized text from [[stringtable.csv]].
____________________________________________________________________________________________


| [[isLocalized]], [[BIS_fnc_localize]], [[WFSideText]], [[parseText]], [[Stringtable.csv]], [[Stringtable.xml]] |See also=
}}


'''Example:'''
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


'''localize''' "STR_DN_FROG"
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 12, 2014 - 11:55 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
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:
<syntaxhighlight lang="xml"><?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></syntaxhighlight>
<code>[[hint]] [[parseText]] [[localize]] "str_test_kk";  {{codecomment|// no change of colour}}</code>
<code>[[hint]] [[parseText]] [[localize]] "str_test_kk2"; {{codecomment|// hint content is in red}}</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 15:31, 2 September 2018

Logo A0.png1.00
Hover & click on the images for description

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:
Uncategorised

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

See also:
isLocalizedBIS_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

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>&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=109128"