BIS fnc rankParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Object Manipulation |GROUP1=")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


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


|gr1 = Object Manipulation |GROUP1=
|gr1 = Object Manipulation |GROUP1=
____________________________________________________________________________________________


| Return information about military rank. |Description=
| Return information about military rank. |Description=
Line 16: Line 14:
"classname" - system name (e.g. "MAJOR")
"classname" - system name (e.g. "MAJOR")
"texture" - path to rank insignia
"texture" - path to rank insignia
____________________________________________________________________________________________


| [source, infoType] call [[BIS_fnc_rankParams]] |Syntax=
| [source, infoType] call [[BIS_fnc_rankParams]] |Syntax=
Line 32: Line 29:


| [[String]] |Return value=
| [[String]] |Return value=
____________________________________________________________________________________________


|x1= <code>_shortRank = [<nowiki/>[[player]], "displayNameShort"] [[call]] [[BIS_fnc_rankParams]];</code> |Example 1=
|x1= <code>_shortRank = [<nowiki/>[[player]], "displayNameShort"] [[call]] [[BIS_fnc_rankParams]];</code> |Example 1=
____________________________________________________________________________________________


| [[rank]], [[setUnitRank]] |See also=
| [[rank]], [[setUnitRank]] |See also=

Revision as of 00:45, 17 January 2021

Hover & click on the images for description

Description

Description:
Return information about military rank.
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:
_shortRank = [player, "displayNameShort"] call BIS_fnc_rankParams;

Additional Information

See also:
ranksetUnitRank

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