Difference between revisions of "secondaryWeapon"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - " " to " ")
 
(38 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 a unit's secondary weapon (empty string if none). |= Description
+
|game3= arma1
____________________________________________________________________________________________
+
|version3= 1.00
  
| '''secondaryWeapon''' 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>sWeap <nowiki>=</nowiki> secondaryWeapon [[player]]</code> |= Example 1
 
____________________________________________________________________________________________
 
  
| |= See also
+
|game7= arma3
 +
|version7= 0.50
  
}}
+
|gr1= Unit Inventory
 +
 
 +
|descr= Returns the name of a unit's secondary weapon. To detect the weapon which is '''currently''' being used by the unit use [[currentWeapon]].
  
<h3 style="display:none">Notes</h3>
+
|s1= [[secondaryWeapon]] unit
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
  
<dd class="notedate">Posted on August 4, 2006 - 10:58</dd>
+
|p1= unit: [[Object]]
<dt class="note">'''[[User:Hardrock|hardrock]]'''</dt><dd class="note">''Notes from before the conversion:''
 
  
'''secondaryWeapon''' tells you what weapon the unit has irrespective of the status of the weapon. For example a unit that has a LAWLauncher on his back will still report a LAWLauncher as its secondary weapon. There is no command that will enable you to detect the active weapon.
+
|r1= [[String]] -  Class name of the secondary weapon or {{ic|""}} if none available
</dd>
 
  
<!-- Note Section END -->
+
|x1= <code>[[private]] _secondaryWeapon = [[secondaryWeapon]] [[player]];</code>
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
|x2= <code>[[hint]] [[secondaryWeapon]] [[player]]; {{cc|"launch_NLAW_F"}}</code>
  
[[Category:Scripting Commands|SECONDARYWEAPON]]
+
|seealso= [[secondaryWeaponMagazine]], [[secondaryWeaponItems]], [[addSecondaryWeaponItem]], [[primaryWeapon]], [[handgunWeapon]], [[currentWeapon]], [[weapons]]
[[Category:Scripting Commands OFP 1.96|SECONDARYWEAPON]]
+
}}
[[Category:Scripting Commands ArmA|SECONDARYWEAPON]]
 
[[Category:Command_Group:_Weapons|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 21:12, 10 June 2021

Hover & click on the images for description

Description

Description:
Returns the name of a unit's secondary weapon. To detect the weapon which is currently being used by the unit use currentWeapon.
Groups:
Unit Inventory

Syntax

Syntax:
secondaryWeapon unit
Parameters:
unit: Object
Return Value:
String - Class name of the secondary weapon or "" if none available

Examples

Example 1:
private _secondaryWeapon = secondaryWeapon player;
Example 2:
hint secondaryWeapon player; // "launch_NLAW_F"

Additional Information

See also:
secondaryWeaponMagazinesecondaryWeaponItemsaddSecondaryWeaponItemprimaryWeaponhandgunWeaponcurrentWeaponweapons

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