BIS fnc localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (removed incorrect note)
m (Add seeAlso, format example)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 19: Line 18:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code><i>//assuming the [[Stringtable.xml|stringtable]] contains a key "STR_someString" with the value "Hello world"</i>
|x1= <code>{{codecomment|// assuming the [[Stringtable.xml|stringtable]] contains a key "STR_someString" with the value "Hello world"}}
"STR_someString" [[call]] [[BIS_fnc_localize]]; //returns "Hello world"
"STR_someString" [[call]] [[BIS_fnc_localize]]; {{codecomment|// returns "Hello world"}}


<i>//assuming the [[Stringtable.xml|stringtable]] does not contain a key "STR_anotherString"</i>
{{codecomment|// assuming the [[Stringtable.xml|stringtable]] does not contain a key "STR_anotherString"}}
"STR_anotherString" [[call]] [[BIS_fnc_localize]]; //returns "STR_anotherString" </code> |= Example
"STR_anotherString" [[call]] [[BIS_fnc_localize]]; {{codecomment|// returns "STR_anotherString"}}</code> |= Example1


____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[isLocalized]], [[localize]], [[Stringtable.xml]] |= See also
 
}}
}}


Line 48: Line 46:
<dt class="note">[[User:Vincent H.|Vincent H.]]</dt>
<dt class="note">[[User:Vincent H.|Vincent H.]]</dt>
<dd class="note">
<dd class="note">
Unfortunately [[localize]] does not exactly the same as [[BIS_fnc_localize]].<br>
Unfortunately [[localize]] does not exactly do the same as [[BIS_fnc_localize]].<br />
[[BIS_fnc_localize]] also checks if it the input string [[isLocalized]] while [[localize]] will return an empty string if the input parameter is not localized.
[[BIS_fnc_localize]] also checks if it the input string [[isLocalized]] while [[localize]] will return an empty string if the input parameter is not localized.
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 03:16, 7 May 2018

Hover & click on the images for description

Description

Description:
Checks if passed string is localization key and if so, return the localized text. Else, returns the passed string itself.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
localizationString call BIS_fnc_localize
Parameters:
localizationString: String
Return Value:
String - the localized text behind the key or the key itself (if not localized).

Examples

Example 1:
// assuming the stringtable contains a key "STR_someString" with the value "Hello world" "STR_someString" call BIS_fnc_localize; // returns "Hello world" // assuming the stringtable does not contain a key "STR_anotherString" "STR_anotherString" call BIS_fnc_localize; // returns "STR_anotherString"

Additional Information

See also:
isLocalizedlocalizeStringtable.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 December 29, 2017 - 00:03 (UTC)
Vincent H.
Unfortunately localize does not exactly do the same as BIS_fnc_localize.
BIS_fnc_localize also checks if it the input string isLocalized while localize will return an empty string if the input parameter is not localized.