addWeaponItem: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Fix parameter)
 
(5 intermediate revisions by the same user not shown)
Line 11: Line 11:


|descr= 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.
|descr= 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


|s1= unit [[addWeaponItem]] [weaponName, itemName, instant]
|s1= unit [[addWeaponItem]] [weaponName, itemName, instant]


|p1= unit: [[Object]]
|p1= unit: [[Object]]
|p2= [weaponName, itemName, instant]: [[Array]]
 
|p3= weaponName: [[String]] - name of the weapon to add magazine to
|p2= weaponName: [[String]] - name of the weapon to add magazine to
|p4= itemName: [[String]] - class name of the item to add (if magazine, muzzle will be autodetected)
 
|p5= instant (Optional): [[Boolean]] - [[true]] to skip animation. Default: [[false]]
|p3= itemName: [[String]] - class name of the item to add (if magazine, muzzle will be autodetected)
 
|p4= instant: [[Boolean]] - (Optional, default [[false]]) [[true]] to skip animation
|p4since= arma3 1.96


|r1= [[Nothing]]
|r1= [[Nothing]]


|s2= unit [[addWeaponItem]] [weaponName, [itemName, ammoCount, muzzleName], instant]
|s2= unit [[addWeaponItem]] [weaponName, [itemName, ammoCount, muzzleName], instant]


|p21= unit: [[Object]]
|p21= unit: [[Object]]
|p22= [weaponName, [itemName, ammoCount, muzzleName], instant]: [[Array]]
 
|p23= weaponName: [[String]] - name of the weapon to add magazine to
|p22= weaponName: [[String]] - name of the weapon to add magazine to
|p24= [itemName, ammoCount, muzzleName]: [[Array]]
 
|p25= itemName: [[String]] - class name of the item to add (if magazine, muzzle will be autodetected unless specified)
|p23= itemName: [[String]] - class name of the item to add (if magazine, muzzle will be autodetected unless specified)
|p26= ammoCount (Optional): [[Number]] - optional amount of ammo in magazine
 
|p27= muzzleName (Optional): [[String]] - optional target muzzle to add magazine to
|p24= ammoCount: [[Number]] - (Optional) optional amount of ammo in magazine
|p28= instant (Optional): [[Boolean]] - [[true]] to skip animation. Default: [[false]]
 
|p25= muzzleName: [[String]] - (Optional) optional target muzzle to add magazine to
 
|p26= instant: [[Boolean]] - (Optional, default [[false]]) [[true]] to skip animation
|p26since= arma3 1.96


|r2= [[Nothing]]
|r2= [[Nothing]]


|x1= <code>[[player]] [[addWeaponItem]] ["arifle_MX_GL_ACO_F", "1Rnd_HE_Grenade_shell"];</code>
|x1= <sqf>player addWeaponItem ["arifle_MX_GL_ACO_F", "1Rnd_HE_Grenade_shell"];</sqf>
|x2= <code>[[player]] [[addWeaponItem]] ["arifle_MX_GL_ACO_F", ["1Rnd_HE_Grenade_shell", 1, "GL_3GL_F"]];</code>
 
|x3= <code>[[player]] [[addWeaponItem]] ["Laserdesignator", "Laserbatteries"];</code>
|x2= <sqf>player addWeaponItem ["arifle_MX_GL_ACO_F", ["1Rnd_HE_Grenade_shell", 1, "GL_3GL_F"]];</sqf>
 
|x3= <sqf>player addWeaponItem ["LaserDesignator", "LaserBatteries"];</sqf>


|seealso= [[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]]
}}
}}

Latest revision as of 15:44, 16 June 2023

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.
Groups:
Unit Inventory

Syntax

Syntax:
unit addWeaponItem [weaponName, itemName, instant]
Parameters:
unit: Object
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)
since Arma 3 logo black.png1.96
instant: Boolean - (Optional, default false) true to skip animation
Return Value:
Nothing

Alternative Syntax

Syntax:
unit addWeaponItem [weaponName, [itemName, ammoCount, muzzleName], instant]
Parameters:
unit: Object
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 unless specified)
ammoCount: Number - (Optional) optional amount of ammo in magazine
muzzleName: String - (Optional) optional target muzzle to add magazine to
since Arma 3 logo black.png1.96
instant: Boolean - (Optional, default false) true to skip animation
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:
addPrimaryWeaponItem addSecondaryWeaponItem addHandgunItem addBinocularItem weaponsItems handgunItems primaryWeaponItems secondaryWeaponItems binocularItems removePrimaryWeaponItem removeSecondaryWeaponItem removeHandgunItem removeBinocularItem

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