BIS fnc rankParams: Difference between revisions

Latest revision as of 17:00, 13 July 2022

1.00

Hover & click on the images for description

Description

Description:: Return information about military rank. 1: STRING - requited data, can be one of following: "displayName" - full localized name (e.g. "Major") "displayNameShort" - short localized name (e.g. "Maj.") "classname" - system name (e.g. "MAJOR") "texture" - path to rank insignia
Execution:: call
Groups:: Object Manipulation

Syntax

Syntax:

[source, infoType] call BIS_fnc_rankParams

Parameters:

source: Number, String or Object - can be one of:

Number - rank ID
String - rank system name (e.g. "PRIVATE", "CORPORAL", …)
Object - person whose rank is checked

infoType: String - can be one of:

"displayName" - full localized name (e.g. "Major")
"displayNameShort" - short localized name (e.g. "Maj.")
"classname" - system name (e.g. "MAJOR")
"texture" - path to rank insignia

Return Value:

String

Examples

Example 1:: private _shortRank = [player, "displayNameShort"] call BIS_fnc_rankParams;

Additional Information

See also:: rank setUnitRank

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Object Manipulation
-|1.00|= Game version
+|descr= Return information about military rank.
-____________________________________________________________________________________________
-| <pre>/*
-	Description:
-	Return information about military rank.
-	Parameter(s):
-:
-		NUMBER - rank ID
-		STRING - rank system name (e.g. "PRIVATE", "CORPORAL", ...)
-		OBJECT - person whos rank is checked
 : STRING - requited data, can be one of following:
 		"displayName" - full localized name (e.g. "Major")
@@ Line 24: / Line 14: @@
 		"texture" - path to rank insignia
-	Returns:
+|s1= [source, infoType] call [[BIS_fnc_rankParams]]
-	STRING
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_rankParams]]; --> |= Syntax
-|p1= |= Parameter 1
+|p1= source: [[Number]], [[String]] or [[Object]] - can be one of:
+* [[Number]] - rank ID
+* [[String]] -  rank system name (e.g. "PRIVATE", "CORPORAL", …)
+* [[Object]] - person whose rank is checked
-| |= Return value
+|p2= infoType: [[String]] - can be one of:
-____________________________________________________________________________________________
+* "displayName" - full localized name (e.g. "Major")
+* "displayNameShort" - short localized name (e.g. "Maj.")
+* "classname" - system name (e.g. "MAJOR")
+* "texture" - path to rank insignia
-|x1= <code></code> |=
+|r1= [[String]]
-____________________________________________________________________________________________
-| |= See also
+|x1= <sqf>private _shortRank = [player, "displayNameShort"] call BIS_fnc_rankParams;</sqf>
+|seealso= [[rank]] [[setUnitRank]]
 }}
-<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: Misc|{{uc:rankParams}}]]
-[[Category:Functions|{{uc:rankParams}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:rankParams}}]]