primaryWeapon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added weapons to see also)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *W([a-z ])" to "$1 - w$2")
 
(63 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofpr |= Game name
|game1= ofp
|version1= 1.75


|1.75|= Game version
|game2= ofpe
____________________________________________________________________________________________
|version2= 1.00


| Returns name of unit's primary weapon (empty string if none). |= Description
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| [[String]] <nowiki>=</nowiki> '''primaryWeapon''' [[Object#Unit|Unit]]|= Syntax
|game4= arma2
|version4= 1.00


|p1= Unit: [[Object]] |= Parameter 1
|game5= arma2oa
|version5= 1.50


| [[String]] |= Return value
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00
 
|x1= <code>_pWeap <nowiki>=</nowiki> primaryWeapon [[player]]</code> |= Example 1
____________________________________________________________________________________________


| [[secondaryWeapon]], [[weapons]] |= See also
|game7= arma3
|version7= 0.50


}}
|arg= global
 
|gr1= Unit Inventory
 
|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.
 
|s1= [[primaryWeapon]] unit


<h3 style="display:none">Notes</h3>
|p1= unit: [[Object]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on August 4, 2006 - 10:57</dd>
|r1= [[String]] - weapon class name or "" if no primary weapon
<dt class="note">'''[[User:Hardrock|hardrock]]'''</dt><dd class="note">''Notes from before the conversion:''


'''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. There is no command that will enable you to directly detect the active weapon.
|x1= <sqf>_pWeap = primaryWeapon player;</sqf>
</dd>
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>hint primaryWeapon player; // "arifle_MX_ACO_pointer_F"</sqf>


[[Category:Scripting Commands|PRIMARYWEAPON]]
|seealso= [[primaryWeaponMagazine]] [[primaryWeaponItems]] [[addPrimaryWeaponItem]] [[removePrimaryWeaponItem]] [[removeAllPrimaryWeaponItems]] [[secondaryWeapon]] [[handgunWeapon]] [[currentWeapon]] [[weapons]]
[[Category:Scripting Commands OFP 1.96|PRIMARYWEAPON]]
}}
[[Category:Scripting Commands ArmA|PRIMARYWEAPON]]
[[Category:Command_Group:_Weapons|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17:35, 8 November 2023

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh 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:
primaryWeaponMagazine primaryWeaponItems addPrimaryWeaponItem removePrimaryWeaponItem removeAllPrimaryWeaponItems secondaryWeapon handgunWeapon currentWeapon weapons

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=349379"