BIS fnc rankParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Object Manipulation


|gr1 = Object Manipulation |GROUP1=
|descr= Return information about military rank.
 
| Return information about military rank. |Description=


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


| [source, infoType] call [[BIS_fnc_rankParams]] |Syntax=
|s1= [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 25:
* "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=
|r1= [[String]]


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


| [[rank]], [[setUnitRank]] |See also=
|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:Functions|{{uc:rankParams}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:rankParams}}]]

Latest revision as of 17:00, 13 July 2022

Arma 3 logo black.png1.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_rankParams&oldid=328370"