BIS fnc localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (extra space breaking format removed)
(BIS_fnc_localize's input parameters changed within the past versions of ArmA 3 (29.12.2017))
Line 13: Line 13:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


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


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 00:58, 29 December 2017


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.
Arma 3
This function does exactly the same as the command localize
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:
See also needed

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