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")
 
(30 intermediate revisions by 2 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


|gr1= Weapons |GROUP1=
|game3= arma1
|version3= 1.00


|gr2= Unit Inventory |GROUP2=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Returns name of a unit's secondary weapon (empty string if none). |DESCRIPTION=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| [[secondaryWeapon]] unit |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= unit: [[Object]] |PARAMETER1=
|game7= arma3
|version7= 0.50


| [[String]] |RETURNVALUE=
|gr1= Unit Inventory
____________________________________________________________________________________________
 
|x1= <code>[[private]] _secondaryWeapon = [[secondaryWeapon]] [[player]];</code> |EXAMPLE1=


|x2= <code>[[hint]] [[secondaryWeapon]] [[player]]; {{cc|"launch_NLAW_F"}}</code> |EXAMPLE2=
|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]].
____________________________________________________________________________________________


| [[secondaryWeaponMagazine]], [[secondaryWeaponItems]], [[addSecondaryWeaponItem]]
|s1= [[secondaryWeapon]] unit
[[primaryWeapon]], [[handgunWeapon]], [[currentWeapon]], [[weapons]] |SEEALSO=
}}


<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:58
|r1= [[String]] - class name of the secondary weapon or <sqf inline>""</sqf> if none available
<dt class="note">[[User:Hardrock|hardrock]]
<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. Use [[currentWeapon]] to detect the active weapon.
|x1= <sqf>private _secondaryWeapon = secondaryWeapon player;</sqf>
<!-- Note Section END -->
</dl>


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


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|seealso= [[secondaryWeaponMagazine]] [[secondaryWeaponItems]] [[addSecondaryWeaponItem]] [[primaryWeapon]] [[handgunWeapon]] [[currentWeapon]] [[weapons]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Weapons|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13: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"