addWeaponItem: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 11: Line 10:


|gr1= Unit Inventory |GROUP1=
|gr1= Unit Inventory |GROUP1=
____________________________________________________________________________________________


| Adds a weapon item to the specified weapon. The item can be weapon magazine, in which case the amount of ammo and target muzzle could also be specified.
| Adds a weapon item to the specified weapon. The item can be weapon magazine, in which case the amount of ammo and target muzzle could also be specified.
* Since Arma 3 v1.95 it is possible to add item instantly skipping the animation by providing optional boolean|DESCRIPTION=
* Since Arma 3 v1.95 it is possible to add item instantly skipping the animation by providing optional boolean|DESCRIPTION=
____________________________________________________________________________________________


| unit '''addWeaponItem''' [weaponName, itemName, instant]|SYNTAX1=
| unit '''addWeaponItem''' [weaponName, itemName, instant]|SYNTAX1=
Line 39: Line 36:


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________


|x1= <code>[[player]] [[addWeaponItem]] ["arifle_MX_GL_ACO_F", "1Rnd_HE_Grenade_shell"];</code> |EXAMPLE1=
|x1= <code>[[player]] [[addWeaponItem]] ["arifle_MX_GL_ACO_F", "1Rnd_HE_Grenade_shell"];</code> |EXAMPLE1=
|x2= <code>[[player]] [[addWeaponItem]] ["arifle_MX_GL_ACO_F", ["1Rnd_HE_Grenade_shell", 1, "GL_3GL_F"]];</code> |EXAMPLE2=
|x2= <code>[[player]] [[addWeaponItem]] ["arifle_MX_GL_ACO_F", ["1Rnd_HE_Grenade_shell", 1, "GL_3GL_F"]];</code> |EXAMPLE2=
|x3= <code>[[player]] [[addWeaponItem]] ["Laserdesignator", "Laserbatteries"];</code> |EXAMPLE3=
|x3= <code>[[player]] [[addWeaponItem]] ["Laserdesignator", "Laserbatteries"];</code> |EXAMPLE3=
____________________________________________________________________________________________


| [[addPrimaryWeaponItem]], [[addSecondaryWeaponItem]], [[addHandgunItem]], [[addBinocularItem]], [[weaponsItems]], [[handgunItems]], [[primaryWeaponItems]], [[secondaryWeaponItems]], [[binocularItems]], [[removePrimaryWeaponItem]], [[removeSecondaryWeaponItem]], [[removeHandgunItem]], [[removeBinocularItem]] |SEEALSO=
| [[addPrimaryWeaponItem]], [[addSecondaryWeaponItem]], [[addHandgunItem]], [[addBinocularItem]], [[weaponsItems]], [[handgunItems]], [[primaryWeaponItems]], [[secondaryWeaponItems]], [[binocularItems]], [[removePrimaryWeaponItem]], [[removeSecondaryWeaponItem]], [[removeHandgunItem]], [[removeBinocularItem]] |SEEALSO=

Revision as of 00:06, 17 January 2021

Hover & click on the images for description

Description

Description:
Adds a weapon item to the specified weapon. The item can be weapon magazine, in which case the amount of ammo and target muzzle could also be specified.
  • Since Arma 3 v1.95 it is possible to add item instantly skipping the animation by providing optional boolean
Groups:
Unit Inventory

Syntax

Syntax:
unit addWeaponItem [weaponName, itemName, instant]
Parameters:
unit: Object
[weaponName, itemName, instant]: Array
weaponName: String - name of the weapon to add magazine to
itemName: String - class name of the item to add (if magazine, muzzle will be autodetected)
instant (Optional): Boolean - true to skip animation. Default: false
Return Value:
Nothing

Alternative Syntax

Syntax:
unit addWeaponItem [weaponName, [itemName, ammoCount, muzzleName], instant]
Parameters:
unit: Object
[weaponName, [magazineName, ammoCount, muzzleName], instant]: Array
weaponName: String - name of the weapon to add magazine to
[itemName, ammoCount, muzzleName]: Array
itemName: String - class name of the item to add (if magazine, muzzle will be autodetected unless specified)
ammoCount (Optional): Number - optional amount of ammo in magazine
muzzleName (Optional): String - optional target muzzle to add magazine to
instant (Optional): Boolean - true to skip animation. Default: false
Return Value:
Nothing

Examples

Example 1:
player addWeaponItem ["arifle_MX_GL_ACO_F", "1Rnd_HE_Grenade_shell"];
Example 2:
player addWeaponItem ["arifle_MX_GL_ACO_F", ["1Rnd_HE_Grenade_shell", 1, "GL_3GL_F"]];
Example 3:
player addWeaponItem ["Laserdesignator", "Laserbatteries"];

Additional Information

See also:
addPrimaryWeaponItemaddSecondaryWeaponItemaddHandgunItemaddBinocularItemweaponsItemshandgunItemsprimaryWeaponItemssecondaryWeaponItemsbinocularItemsremovePrimaryWeaponItemremoveSecondaryWeaponItemremoveHandgunItemremoveBinocularItem

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

Notes

Bottom Section