BIS fnc localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1 = Strings |GROUP1=
|gr1 = Strings |GROUP1=
____________________________________________________________________________________________


| 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=
Line 18: Line 15:


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


|x1= <code>{{codecomment|// assuming the [[Stringtable.xml|stringtable]] contains a key "STR_someString" with the value "Hello world"}}
|x1= <code>{{codecomment|// assuming the [[Stringtable.xml|stringtable]] contains a key "STR_someString" with the value "Hello world"}}
Line 26: Line 22:
"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]] |SEEALSO=
| [[isLocalized]], [[localize]], [[Stringtable.xml]] |SEEALSO=

Revision as of 00:31, 17 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

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.