primaryWeapon: Difference between revisions

Latest revision as of 16:35, 8 November 2023

Hover & click on the images for description

Description:: Returns name of unit's primary weapon. This command will also return a weapon class name if the weapon is not used by the player, for example, it is on the unit's back. Use currentWeapon to get the weapon the unit is using.
Groups:: Unit Inventory

See also:: primaryWeaponMagazine primaryWeaponItems addPrimaryWeaponItem removePrimaryWeaponItem removeAllPrimaryWeaponItems secondaryWeapon handgunWeapon currentWeapon weapons

: 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: @@
-back to [[Scripting_Reference#P|COMREF]]
+{{RV|type=command
-<h2 style="color:#000066">'''primaryWeapon ''vehicle'''''</h2>
+|game1= ofp
+|version1= 1.75
+|game2= ofpe
+|version2= 1.00
-'''Operand types:'''
+|game3= arma1
+|version3= 1.00
-'''vehicle:''' [[Object]]
+|game4= arma2
+|version4= 1.00
-'''Type of returned value:'''
+|game5= arma2oa
+|version5= 1.50
-[[String]]
+|game6= tkoh
+|version6= 1.00
-'''Description:'''
+|game7= arma3
+|version7= 0.50
-Returns name of vehicle's primary weapon (empty string if none).
+|arg= global
+|gr1= Unit Inventory
-'''Example:'''
+|descr= Returns name of unit's primary weapon. This command will also return a weapon class name if the weapon is not used by the player, for example, it is on the unit's back. Use [[currentWeapon]] to get the weapon the unit is using.
-pWeap = '''primaryWeapon''' [[player]]
+|s1= [[primaryWeapon]] unit
+|p1= unit: [[Object]]
+|r1= [[String]] - weapon class name or "" if no primary weapon
+|x1= <sqf>_pWeap = primaryWeapon player;</sqf>
+|x2= <sqf>hint primaryWeapon player; // "arifle_MX_ACO_pointer_F"</sqf>
+|seealso= [[primaryWeaponMagazine]] [[primaryWeaponItems]] [[addPrimaryWeaponItem]] [[removePrimaryWeaponItem]] [[removeAllPrimaryWeaponItems]] [[secondaryWeapon]] [[handgunWeapon]] [[currentWeapon]] [[weapons]]
+}}