BIS fnc addWeapon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *W([a-z ])" to "$1 - w$2")
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Inventory


|gr1 = Inventory |GROUP1=
|gr2= Weapons


|gr2 = Weapons |GROUP2=
|descr= Adds a weapon to the specified unit, with magazine classnames taken from the weapon's config (in [[:Category:Weapons|CfgWeapons]]).
This function does not remove magazines nor weapons prior to adding the new weapon, so that still has to be done manually.


|s1= [unit, weaponClassName, quantity, type] call [[BIS_fnc_addWeapon]]


| Adds a weapon to the specified unit, with magazine classnames taken from the weapon's config (in [[:Category:Weapons|CfgWeapons]]).
|p1= unit: [[Object]] - unit to add weapon to.
This function does not remove magazines nor weapons prior to adding the new weapon, so that still has to be done manually. |DESCRIPTION=


| [unit, weaponClassName, quantity, type] call [[BIS_fnc_addWeapon]] |SYNTAX=
|p2= weaponClassName: [[String]] - weapon Classname (found in [[:Category:Weapons|CfgWeapons]]).


|p1= unit: [[Object]] - Unit to add weapon to. |Parameter1=
|p3= quantity: [[Number]] - amount of magazines.
 
|p2= weaponClassName: [[String]] - Weapon Classname (found in [[:Category:Weapons|CfgWeapons]]). |Parameter2=
 
|p3= quantity: [[Number]] - Amount of magazines. |PARAMETER3=


|p4= type: [[Number]] or [[String]] - (Optional, default 0)
|p4= type: [[Number]] or [[String]] - (Optional, default 0)
* [[Number]] - Index of magazine name that should be used - found in {{Inline code|magazines {{=}} {}<nowiki/>}} array.
* [[Number]] - Index of magazine name that should be used - found in <syntaxhighlight lang="cpp" inline>magazines = {}</syntaxhighlight> array.
* [[String]] - Magazine name to be used.
* [[String]] - Magazine name to be used.
|Parameter4=


| [[String]] - Primary'''(!)''' muzzle name of weapon. |RETURNVALUE=
|r1= [[String]] - primary'''(!)''' muzzle name of weapon.


|x1= Add 6 dual-purpose magazines and the underwater gun to the player:
|x1= Add 6 dual-purpose magazines and the underwater gun to the player:
<code>newGun = [<nowiki/>[[player]], "arifle_SDAR_F", 6] [[call]] [[BIS_fnc_addWeapon]];</code> |Example1=
<sqf>[player, "arifle_SDAR_F", 6] call BIS_fnc_addWeapon;</sqf>


|x2= Adds 2 &times; 30 Rnd Stanag Tracer (Red) magazines to bluforUnit, with an Mk20_F:
|x2= Adds 2 &times; 30 Rnd Stanag Tracer (Red) magazines to bluforUnit, with an Mk20_F:
<code>newGun = [bluforUnit, "arifle_Mk20_F", 2, 1] [[call]] [[BIS_fnc_addWeapon]];</code> |Example2=
<sqf>[bluforUnit, "arifle_Mk20_F", 2, 1] call BIS_fnc_addWeapon;</sqf>


|x3= Alternative syntax of second example, with magazine name written out:
|x3= Alternative syntax of second example, with magazine name written out:
<code>newGun = [bluforUnit, "arifle_Mk20_F", 2, "30Rnd_556x45_Stanag_Tracer_red"] [[call]] [[BIS_fnc_addWeapon]];</code> |Example3=
<sqf>[bluforUnit, "arifle_Mk20_F", 2, "30Rnd_556x45_Stanag_Tracer_red"] call BIS_fnc_addWeapon;</sqf>


| [[addWeapon]], [[selectWeapon]] |SEEALSO=
|seealso= [[addWeapon]] [[selectWeapon]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Tryteyker-
<!-- Note Section BEGIN -->
|timestamp= 20140929181300
 
|text= This function only returns the primary muzzle name of a gun. For more info on how to select guns' secondary muzzle names (like an underhand grenade launcher), view the notes on [[selectWeapon]].
<!-- Note Section END -->
}}
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Functions|{{uc:addWeapon}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:addWeapon}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 29, 2014 - 18:13 (UTC)</dd>
<dt class="note">[[User:Tryteyker-|Tryteyker-]]</dt>
<dd class="note">
This function only returns the primary muzzle name of a gun. For more info on how to select guns' secondary muzzle names (like an underhand grenade launcher), view the notes on [[selectWeapon]].
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 16:35, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Adds a weapon to the specified unit, with magazine classnames taken from the weapon's config (in CfgWeapons). This function does not remove magazines nor weapons prior to adding the new weapon, so that still has to be done manually.
Execution:
call
Groups:
InventoryWeapons

Syntax

Syntax:
[unit, weaponClassName, quantity, type] call BIS_fnc_addWeapon
Parameters:
unit: Object - unit to add weapon to.
weaponClassName: String - weapon Classname (found in CfgWeapons).
quantity: Number - amount of magazines.
type: Number or String - (Optional, default 0)
  • Number - Index of magazine name that should be used - found in magazines = {} array.
  • String - Magazine name to be used.
Return Value:
String - primary(!) muzzle name of weapon.

Examples

Example 1:
Add 6 dual-purpose magazines and the underwater gun to the player:
[player, "arifle_SDAR_F", 6] call BIS_fnc_addWeapon;
Example 2:
Adds 2 × 30 Rnd Stanag Tracer (Red) magazines to bluforUnit, with an Mk20_F:
[bluforUnit, "arifle_Mk20_F", 2, 1] call BIS_fnc_addWeapon;
Example 3:
Alternative syntax of second example, with magazine name written out:
[bluforUnit, "arifle_Mk20_F", 2, "30Rnd_556x45_Stanag_Tracer_red"] call BIS_fnc_addWeapon;

Additional Information

See also:
addWeapon selectWeapon

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
Tryteyker- - c
Posted on Sep 29, 2014 - 18:13 (UTC)
This function only returns the primary muzzle name of a gun. For more info on how to select guns' secondary muzzle names (like an underhand grenade launcher), view the notes on selectWeapon.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_addWeapon&oldid=349361"