BIS fnc localize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Some wiki formatting)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Strings


|gr1 = Strings |GROUP1=
|descr= 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.
|s1= localizationString call [[BIS_fnc_localize]]
|DESCRIPTION=


| localizationString call [[BIS_fnc_localize]] |SYNTAX=
|p1= localizationString: [[String]]


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


| [[String]] - the localized text behind the key or the key itself (if not localized). |RETURNVALUE=
|x1= <sqf>
// assuming the stringtable contains a key "STR_someString" with the value "Hello world"
"STR_someString" call BIS_fnc_localize; // returns "Hello world"


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


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


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Vincent H.
<!-- Note Section BEGIN -->
|timestamp= 20171229000300
 
|text= Unfortunately [[localize]] does not exactly do the same as [[BIS_fnc_localize]].<br>
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Functions|{{uc:localize}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:localize}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 29, 2017 - 00:03 (UTC)</dd>
<dt class="note">[[User:Vincent H.|Vincent H.]]</dt>
<dd class="note">
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>
}}
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 20:33, 18 April 2022

Arma 3 logo black.png1.00
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:
isLocalized localize Stringtable.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
Vincent H. - c
Posted on Dec 29, 2017 - 00:03 (UTC)
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.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_localize&oldid=308934"