BIS fnc ordinalNumber: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Fix SQF)
 
(39 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Strings


|1.00|= Game version
|descr= Return number as ordinal number (e.g. 1 become "1st")
____________________________________________________________________________________________


| <pre>/*
|s1= [number, language, isFeminine] call [[BIS_fnc_ordinalNumber]]


Description:
|p1= number: [[Number]]
Return number as ordinal number (e.g. 1 become "1st")


Parameter(s):
|p2= language: [[String]] - (Optional, current game [[language]])
0: NUMBER
1 (Optional): STRING - language (default: current game language)
2 (Optional): BOOL - true for feminine gender, false for masculine (default: false)


Returns:
|p3= isFeminine: [[Boolean]] - (Optional, default [[false]])
STRING
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_ordinalNumber]]; --> |= Syntax
|r1= [[String]]


|p1= |= Parameter 1
|x1= <sqf>private _second = [42] call BIS_fnc_ordinalNumber; // will return "42nd" for English-speaking players</sqf>


| |= Return value
|x2= <sqf>
____________________________________________________________________________________________
private _num1enm = [1, "English", false] call BIS_fnc_ordinalNumber; // returns "1st"
_num1frm = [1, "French",  false] call BIS_fnc_ordinalNumber; // returns "1er"
_num1frw = [1, "French",  true] call BIS_fnc_ordinalNumber; // returns "1re"
_num1esm = [1, "Spanish", false] call BIS_fnc_ordinalNumber; // returns "1"
_num1esw = [1, "Spanish",  true] call BIS_fnc_ordinalNumber; // returns "1*" for Portuguese, Italian and Spanish
</sqf>


|x1= <code></code> |=
|x3= <sqf>
____________________________________________________________________________________________
private _num1en = [1, "English"] call BIS_fnc_ordinalNumber; // returns "1st"
_num2en = [2, "English"] call BIS_fnc_ordinalNumber; // returns "2nd"
_num3en = [3, "English"] call BIS_fnc_ordinalNumber; // returns "3rd"
_num4en = [4, "English"] call BIS_fnc_ordinalNumber; // returns "4th"
_num9en = [9, "English"] call BIS_fnc_ordinalNumber; // returns "9th"
</sqf>


| |= See also
|x4= <sqf>private _second = [1, "unknownLanguage"] call BIS_fnc_ordinalNumber; // will return "1." if language is not recognised/supported</sqf>


|seealso= [[language]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Strings|{{uc:ordinalNumber}}]]
[[Category:Functions|{{uc:ordinalNumber}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ordinalNumber}}]]

Latest revision as of 16:47, 1 November 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Return number as ordinal number (e.g. 1 become "1st")
Execution:
call
Groups:
Strings

Syntax

Syntax:
[number, language, isFeminine] call BIS_fnc_ordinalNumber
Parameters:
number: Number
language: String - (Optional, current game language)
isFeminine: Boolean - (Optional, default false)
Return Value:
String

Examples

Example 1:
private _second = [42] call BIS_fnc_ordinalNumber; // will return "42nd" for English-speaking players
Example 2:
private _num1enm = [1, "English", false] call BIS_fnc_ordinalNumber; // returns "1st" _num1frm = [1, "French", false] call BIS_fnc_ordinalNumber; // returns "1er" _num1frw = [1, "French", true] call BIS_fnc_ordinalNumber; // returns "1re" _num1esm = [1, "Spanish", false] call BIS_fnc_ordinalNumber; // returns "1" _num1esw = [1, "Spanish", true] call BIS_fnc_ordinalNumber; // returns "1*" for Portuguese, Italian and Spanish
Example 3:
private _num1en = [1, "English"] call BIS_fnc_ordinalNumber; // returns "1st" _num2en = [2, "English"] call BIS_fnc_ordinalNumber; // returns "2nd" _num3en = [3, "English"] call BIS_fnc_ordinalNumber; // returns "3rd" _num4en = [4, "English"] call BIS_fnc_ordinalNumber; // returns "4th" _num9en = [9, "English"] call BIS_fnc_ordinalNumber; // returns "9th"
Example 4:
private _second = [1, "unknownLanguage"] call BIS_fnc_ordinalNumber; // will return "1." if language is not recognised/supported

Additional Information

See also:
language

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ordinalNumber&oldid=330766"