primaryWeapon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| ofpr |Game name=
| ofpr |Game name=
Line 9: Line 8:


|gr1= Unit Inventory |GROUP1=
|gr1= Unit Inventory |GROUP1=
____________________________________________________________________________________________


| Returns name of unit's primary weapon (empty string if none). |DESCRIPTION=
| Returns name of unit's primary weapon (empty string if none). |DESCRIPTION=
____________________________________________________________________________________________


| '''primaryWeapon''' unit |SYNTAX=
| '''primaryWeapon''' unit |SYNTAX=
Line 19: Line 16:


| [[String]] |RETURNVALUE=
| [[String]] |RETURNVALUE=
____________________________________________________________________________________________
   
   
|x1= <code>_pWeap = [[primaryWeapon]] [[player]];</code> |EXAMPLE1=
|x1= <code>_pWeap = [[primaryWeapon]] [[player]];</code> |EXAMPLE1=


|x2= <code>[[hint]] [[primaryWeapon]] [[player]]; //"arifle_MX_ACO_pointer_F"</code> |EXAMPLE2=
|x2= <code>[[hint]] [[primaryWeapon]] [[player]]; //"arifle_MX_ACO_pointer_F"</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[primaryWeaponMagazine]], [[primaryWeaponItems]], [[addPrimaryWeaponItem]], [[removePrimaryWeaponItem]], [[removeAllPrimaryWeaponItems]], [[secondaryWeapon]], [[handgunWeapon]], [[currentWeapon]], [[weapons]] |SEEALSO=
| [[primaryWeaponMagazine]], [[primaryWeaponItems]], [[addPrimaryWeaponItem]], [[removePrimaryWeaponItem]], [[removeAllPrimaryWeaponItems]], [[secondaryWeapon]], [[handgunWeapon]], [[currentWeapon]], [[weapons]] |SEEALSO=

Revision as of 02:20, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns name of unit's primary weapon (empty string if none).
Groups:
Unit Inventory

Syntax

Syntax:
primaryWeapon unit
Parameters:
unit: Object
Return Value:
String

Examples

Example 1:
_pWeap = primaryWeapon player;
Example 2:
hint primaryWeapon player; //"arifle_MX_ACO_pointer_F"

Additional Information

See also:
primaryWeaponMagazineprimaryWeaponItemsaddPrimaryWeaponItemremovePrimaryWeaponItemremoveAllPrimaryWeaponItemssecondaryWeaponhandgunWeaponcurrentWeaponweapons

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

Posted on August 4, 2006 - 10:57
hardrock
primaryWeapon tells you what weapon the unit has irrespective of the status of the weapon. For example a unit that has an M16 on his back will still report an M16 as its primary weapon.

Bottom Section

Posted on October 11, 2015 - 21:53 (UTC)
Austin medic
To directly detect the active weapon use currentWeapon command.