secondaryWeapon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added see also, modified note)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(50 intermediate revisions by 11 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
____________________________________________________________________________________________


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


}}
|gr1= Unit Inventory
 
|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]].


<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 directly detect the active weapon.
|r1= [[String]] - class name of the secondary weapon or <sqf inline>""</sqf> if none available
</dd>


<!-- Note Section END -->
|x1= <sqf>private _secondaryWeapon = secondaryWeapon player;</sqf>
</dl>


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


[[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 14:59, 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
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
Retrieved from "https://community.bistudio.com/wiki?title=secondaryWeapon&oldid=348320"