BIS fnc rankParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


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


| Return information about military rank. |Description=
| Return information about military rank.


1: STRING - requited data, can be one of following:
1: STRING - requited data, can be one of following:
Line 15: Line 15:
"texture" - path to rank insignia
"texture" - path to rank insignia


| [source, infoType] call [[BIS_fnc_rankParams]] |Syntax=
| [source, infoType] call [[BIS_fnc_rankParams]]


|p1= source: [[Number]], [[String]] or [[Object]] - can be one of:
|p1= source: [[Number]], [[String]] or [[Object]] - can be one of:
* [[Number]] - rank ID
* [[Number]] - rank ID
* [[String]] -  rank system name (e.g. "PRIVATE", "CORPORAL", …)
* [[String]] -  rank system name (e.g. "PRIVATE", "CORPORAL", …)
* [[Object]] - person whose rank is checked |Parameter 1=
* [[Object]] - person whose rank is checked


|p2= infoType: [[String]] - can be one of:
|p2= infoType: [[String]] - can be one of:
Line 26: Line 26:
* "displayNameShort" - short localized name (e.g. "Maj.")
* "displayNameShort" - short localized name (e.g. "Maj.")
* "classname" - system name (e.g. "MAJOR")
* "classname" - system name (e.g. "MAJOR")
* "texture" - path to rank insignia |Parameter 2=
* "texture" - path to rank insignia


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


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


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



Revision as of 23:39, 17 January 2021

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:
_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

Bottom Section