BIS fnc rankParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Return information about military rank. |Description=
 
Description:
Return information about military rank.


Parameter(s):
0:
NUMBER - rank ID
STRING - rank system name (e.g. "PRIVATE", "CORPORAL", ...)
OBJECT - person whos rank is checked
1: STRING - requited data, can be one of following:
1: STRING - requited data, can be one of following:
"displayName" - full localized name (e.g. "Major")
"displayName" - full localized name (e.g. "Major")
Line 23: Line 14:
"classname" - system name (e.g. "MAJOR")
"classname" - system name (e.g. "MAJOR")
"texture" - path to rank insignia
"texture" - path to rank insignia
____________________________________________________________________________________________


Returns:
| [source, infoType] call [[BIS_fnc_rankParams]] |Syntax=
STRING
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_rankParams]]; --> |= Syntax
|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 |Parameter 1=


|p1= |= Parameter 1
|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 |Parameter 2=


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


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


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


Line 52: Line 46:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:rankParams}}]]
[[Category:Function Group: Misc|{{uc:rankParams}}]]
[[Category:Function Group: Misc|{{uc:rankParams}}]]
[[Category:Functions|{{uc:rankParams}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:rankParams}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:rankParams}}]]

Revision as of 15:59, 6 June 2018

Hover & click on the images for description

Description

Description:
Return information about military rank.
Execution:
call
Groups:
Uncategorised

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