BIS fnc localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add seeAlso, format example)
m (template:command argument fix)
Line 8: Line 8:


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


| localizationString call [[BIS_fnc_localize]] |= Syntax
| localizationString call [[BIS_fnc_localize]] |SYNTAX=


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


| [[String]] - the localized text behind the key or the key itself (if not localized). |= Return value
| [[String]] - the localized text behind the key or the key itself (if not localized). |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 22: Line 22:


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


____________________________________________________________________________________________
____________________________________________________________________________________________


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



Revision as of 12:29, 7 April 2019

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.