setUnitRank: Difference between revisions

Latest revision as of 19:03, 29 April 2023

1.00

Hover & click on the images for description

Description

Description:

Sets rank of given unit. Possible rank values, and the associated rating that is set (not added, the value replaces previous rating) with it:

Ranks		CORPORAL	SERGEANT	LIEUTENANT	CAPTAIN	MAJOR	COLONEL
Ratings	ArmA Arma 2 Arma 2:OA TKOH	500	1500	2500	3500	5000	7500
	Arma 3 (ca 2015)	50	150	250	350	500	750
	Arma 3	0	0	0	0	0	0

Before Arma 3 v1.68 and in previous titles, this command was GAGlobal LELocal.

Groups:

Unit Identity

Syntax

Syntax:: unitName setUnitRank rank
Parameters:: unitName: Object
: rank: String - see above. If a wrong string is provided, the command errors and reverts to using "PRIVATE"
Return Value:: Nothing

Examples

Example 1:: player setUnitRank "COLONEL";

Additional Information

See also:: Rating Values rating addRating rank setRank

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: @@
-[[Category:Scripting Commands|R]]
+{{RV|type=command
-[[Category:Scripting Commands ArmA|R]]
-<new command not populated>
+|game1= ofpe
+|version1= 1.00
+|game2= arma1
+|version2= 1.00
-<h2 style="color:#000066">''''' setUnitRank '''''</h2>
+|game3= arma2
+|version3= 1.00
+|game4= arma2oa
+|version4= 1.50
-'''Operand types:'''
+|game5= tkoh
+|version5= 1.00
-'''Type of returned value:'''
+|game6= arma3
+|version6= 0.50
-'''Compatibility:'''
+|arg= global
-'''Description:'''
+|eff= global
+|gr1= Unit Identity
-'''Example:'''
+|descr= Sets rank of given unit.
+Possible rank values, and the associated [[rating]] that is '''set''' (not added, the value replaces previous rating) with it:
+{{{!}} class="wikitable" style="text-align: center"
+! colspan="2" {{!}} Ranks
+! PRIVATE
+! CORPORAL
+! SERGEANT
+! LIEUTENANT
+! CAPTAIN
+! MAJOR
+! COLONEL
+{{!}}-
+! rowspan="3" {{!}} Ratings
+!
+{{Name|arma1|short}}<br>
+{{Name|arma2|short}}<br>
+{{Name|arma2oa|short}}<br>
+{{Name|tkoh|short}}
+{{!}} 0
+{{!}} 500
+{{!}} 1500
+{{!}} 2500
+{{!}} 3500
+{{!}} 5000
+{{!}} 7500
+{{!}}-
+! {{Name|arma3|short}} (ca 2015)
+{{!}} 0
+{{!}} 50
+{{!}} 150
+{{!}} 250
+{{!}} 350
+{{!}} 500
+{{!}} 750
+{{!}}-
+! {{Name|arma3|short}}
+{{!}} 0
+{{!}} 0
+{{!}} 0
+{{!}} 0
+{{!}} 0
+{{!}} 0
+{{!}} 0
+{{!}}}
+{{Feature|arma3|Before {{arma3}} v1.68 and in previous titles, this command was {{Icon|globalArgument|32}} {{Icon|localEffect|32}}.}}
+|s1= unitName [[setUnitRank]] rank
+|p1= unitName: [[Object]]
+|p2= rank: [[String]] - see above. If a wrong string is provided, the command errors and reverts to using "PRIVATE"
+|r1= [[Nothing]]
+|x1= <sqf>player setUnitRank "COLONEL";</sqf>
+|seealso= [[ArmA: Armed Assault: Rating Values|Rating Values]] [[rating]] [[addRating]] [[rank]] [[setRank]]
+}}