primaryWeapon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#|[A-Z]+))?\]\] " to "")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofpr
|game1= ofp


|1.75
|version1= 1.75


|arg= global
|game2= ofpe
 
|version2= 1.00
 
|game3= arma1
 
|version3= 1.00
 
|game4= arma2


|gr1= Unit Inventory
|version4= 1.00


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


| '''primaryWeapon''' unit
|version5= 1.51


|p1= unit: [[Object]]
|game6= tkoh


| [[String]]
|version6= 1.00
 
|x1= <code>_pWeap = [[primaryWeapon]] [[player]];</code>


|x2= <code>[[hint]] [[primaryWeapon]] [[player]]; //"arifle_MX_ACO_pointer_F"</code>
|game7= arma3


|seealso= [[primaryWeaponMagazine]], [[primaryWeaponItems]], [[addPrimaryWeaponItem]], [[removePrimaryWeaponItem]], [[removeAllPrimaryWeaponItems]], [[secondaryWeapon]], [[handgunWeapon]], [[currentWeapon]], [[weapons]]
|version7= 0.50
}}


<dl class="command_description">
|arg= global
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on August 4, 2006 - 10:57</dd>
|gr1= Unit Inventory
<dt class="note">[[User:Hardrock|hardrock]]<dd class="note">'''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.


<!-- Note Section END -->
|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.
</dl>


|s1= '''primaryWeapon''' unit


|p1= unit: [[Object]]


{{GameCategory|arma1|Scripting Commands}}
|r1= [[String]] - Weapon class name or {{ic|""}} if no primary weapon
 
|x1= <code>_pWeap = [[primaryWeapon]] [[player]];</code>


{{GameCategory|arma2|Scripting Commands}}
|x2= <code>[[hint]] [[primaryWeapon]] [[player]]; {{cc|"arifle_MX_ACO_pointer_F"}}</code>
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<!-- CONTINUE Notes -->
|seealso= [[primaryWeaponMagazine]], [[primaryWeaponItems]], [[addPrimaryWeaponItem]], [[removePrimaryWeaponItem]], [[removeAllPrimaryWeaponItems]], [[secondaryWeapon]], [[handgunWeapon]], [[currentWeapon]], [[weapons]]
<dl class="command_description">
}}
<dd class="notedate">Posted on October 11, 2015 - 21:53 (UTC)</dd>
<dt class="note">[[User:Austin medic|Austin medic]]</dt>
<dd class="note">
To directly detect the active weapon use [[currentWeapon]] command.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 14:52, 27 March 2021

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

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

Syntax

Syntax:
primaryWeapon unit
Parameters:
unit: Object
Return Value:
String - Weapon class name or "" if no primary weapon

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
Retrieved from "https://community.bistudio.com/wiki?title=primaryWeapon&oldid=251872"