BIS fnc addWeapon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Lou Montana (talk | contribs) m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *W([a-z ])" to "$1 - w$2") |
||
| (49 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{RV|type=function | |||
|game1= arma3 | |||
|version1= 1.00 | |||
| | |gr1= Inventory | ||
| | |gr2= Weapons | ||
| Adds a weapon to the specified unit, with magazine classnames taken from the weapon's config (in CfgWeapons). | |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. | This function does not remove magazines nor weapons prior to adding the new weapon, so that still has to be done manually. | ||
| [unit, | |s1= [unit, weaponClassName, quantity, type] call [[BIS_fnc_addWeapon]] | ||
|p1= [[Object]] - | |p1= unit: [[Object]] - unit to add weapon to. | ||
| [[String]] - | |p2= weaponClassName: [[String]] - weapon Classname (found in [[:Category:Weapons|CfgWeapons]]). | ||
| | |p3= quantity: [[Number]] - amount of magazines. | ||
| [[ | |p4= type: [[Number]] or [[String]] - (Optional, default 0) | ||
* [[Number]] - Index of magazine name that should be used - found in <syntaxhighlight lang="cpp" inline>magazines = {}</syntaxhighlight> array. | |||
* [[String]] - Magazine name to be used. | |||
|r1= [[String]] - primary'''(!)''' muzzle name of weapon. | |||
|x1= Add 6 dual-purpose magazines and the underwater gun to the player: | |||
<sqf>[player, "arifle_SDAR_F", 6] call BIS_fnc_addWeapon;</sqf> | |||
|x2= Adds 2 × 30 Rnd Stanag Tracer (Red) magazines to bluforUnit, with an Mk20_F: | |||
<sqf>[bluforUnit, "arifle_Mk20_F", 2, 1] call BIS_fnc_addWeapon;</sqf> | |||
< | |||
< | |x3= Alternative syntax of second example, with magazine name written out: | ||
</ | <sqf>[bluforUnit, "arifle_Mk20_F", 2, "30Rnd_556x45_Stanag_Tracer_red"] call BIS_fnc_addWeapon;</sqf> | ||
|seealso= [[addWeapon]] [[selectWeapon]] | |||
[[ | }} | ||
[[ | |||
{{Note | |||
|user= Tryteyker- | |||
|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]]. | |||
}} | |||
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]]. | |||
Latest revision as of 16:35, 8 November 2023
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)
- Return Value:
- String - primary(!) muzzle name of weapon.
Examples
- Example 1:
- Add 6 dual-purpose magazines and the underwater gun to the player:
- Example 2:
- Adds 2 × 30 Rnd Stanag Tracer (Red) magazines to bluforUnit, with an Mk20_F:
- Example 3:
- Alternative syntax of second example, with magazine name written out:
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
- 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.