BIS fnc localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{ *codecomment *\| *\/\/ *([^ ]+) *\}\} " to "{{cc|$1}}")
m (revert + fix)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3


|1.00
|version1= 1.00


|gr1 = Strings
|gr1 = Strings


| Checks if passed string is localization key and if so, return the localized text. Else, returns the passed string itself.
|descr= Checks if passed string is localization key and if so, return the localized text. Else, returns the passed string itself.


| localizationString call [[BIS_fnc_localize]]
|s1= localizationString call [[BIS_fnc_localize]]


|p1= localizationString: [[String]]
|p1= localizationString: [[String]]


| [[String]] - the localized text behind the key or the key itself (if not localized).
|r1= [[String]] - the localized text behind the key or the key itself (if not localized).


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


| [[isLocalized]], [[localize]], [[Stringtable.xml]]
{{cc|assuming the [[Stringtable.xml|stringtable]] does not contain a key "STR_anotherString"}}
"STR_anotherString" [[call]] [[BIS_fnc_localize]]; {{cc|returns "STR_anotherString"}}</code>
 
|seealso= [[isLocalized]], [[localize]], [[Stringtable.xml]]
}}
}}
[[Category:Functions|{{uc:localize}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:localize}}]]


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

Revision as of 18:53, 29 January 2021

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

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