secondaryWeapon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(57 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|SECONDARYWEAPON]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.96|SECONDARYWEAPON]]
[[Category:Scripting Commands ArmA|SECONDARYWEAPON]]


|game1= ofp
|version1= 1.75


<h2 style="color:#000066">'''secondaryWeapon ''vehicle'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''vehicle:''' [[Object]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[String]]
|game7= arma3
|version7= 0.50


'''Compatibility:'''
|gr1= Unit Inventory


Added in version '''1.75'''
|descr= Returns the name of a unit's secondary weapon (launcher). To detect the weapon which is '''currently''' being used by the unit use [[currentWeapon]].


'''Description:'''
|s1= [[secondaryWeapon]] unit


Returns name of '''vehicle's''' secondary weapon (empty string if none).
|p1= unit: [[Object]]


|r1= [[String]] - class name of the secondary weapon or <sqf inline>""</sqf> if none available


'''Example:'''
|x1= <sqf>private _secondaryWeapon = secondaryWeapon player;</sqf>


sWeap = '''secondaryWeapon''' [[player]]
|x2= <sqf>hint secondaryWeapon player; // "launch_NLAW_F"</sqf>


 
|seealso= [[secondaryWeaponMagazine]] [[secondaryWeaponItems]] [[addSecondaryWeaponItem]] [[primaryWeapon]] [[handgunWeapon]] [[currentWeapon]] [[weapons]]
'''Comments:'''
}}
 
'''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.

Latest revision as of 13:59, 8 November 2023

Hover & click on the images for description

Description

Description:
Returns the name of a unit's secondary weapon (launcher). 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:
secondaryWeaponMagazine secondaryWeaponItems addSecondaryWeaponItem primaryWeapon 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