weaponsItems: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "↵↵+<\/sqf>" to " </sqf>")
 
(5 intermediate revisions by 4 users not shown)
Line 8: Line 8:
|gr2= Vehicle Inventory
|gr2= Vehicle Inventory


|descr= [[Image:Weaponsitems.jpg|150px|right|border]]Returns an array with subarrays contains class names and also names of connected items of all the vehicle's weapons.
|descr= [[File:Weaponsitems.jpg|150px|right|border]]Returns an array with subarrays contains class names and also names of connected items of all the vehicle's weapons.
{{Feature | Informative | This command will return weapon magazines as well in , or empty array [] if weapon has no magazine}}
{{Feature|informative|This command can return weapon magazine(s) if any are present. Or an empty array if weapon is stored without a magazine in it.}}
* {{GVI|arma3|1.22|size= 0.75}} it is possible to query weapon holders and ammo crates with this command.<br><!--
* {{GVI|arma3|1.22|size= 0.75}} it is possible to query weapon holders and ammo crates with this command.<br><!--
-->If the argument is a vehicle, the command will return vehicle's weapons.<br><!--
-->If the argument is a vehicle, the command will return vehicle's weapons.<br><!--
Line 20: Line 20:
|p1= vehicle: [[Object]] - unit or vehicle
|p1= vehicle: [[Object]] - unit or vehicle


|r1= [[Array]] of [[Array]]s of weapon items, format [weapon, muzzle, flashlight, optics, muzzleMagazine, muzzleMagazine, bipod]:
|r1= [[Array]] of [[Array]]s of weapon items, format [weapon, muzzle, flashlight, optics, [magazine, ammo], [magazine, ammo], bipod]:
* weapon: [[String]]
* weapon: [[String]]
* muzzle: [[String]]
* muzzle: [[String]]
* flashlight: [[String]]
* flashlight: [[String]]
* optics: [[String]]
* optics: [[String]]
* muzzleMagazine: Often primary muzzle magazine, unless primary muzzle is empty then it will be secondary muzzle magazine - [[Array]] format [magazineName, ammoCount] or empty array if no magazine:
* [primaryMagazine, primaryAmmo]: [[Array]] - could be empty
** magazineName: [[String]]
* [secondaryMagazine, secondaryAmmo]: [[Array]] - could be empty
** ammoCount: [[Number]]
* muzzleMagazine: Normally secondary muzzle magazine unless primary muzzle is empty - [[Array]] format [magazineName, ammoCount] or empty array if no magazine:
** magazineName: [[String]]
** ammoCount: [[Number]]
* bipod: [[String]]
* bipod: [[String]]
{{Feature|important|The weapons are listed in the order they were taken by the unit, with the most recent at the bottom of the array, e.g do '''not''' assume the first item is always the primary weapon.}}
{{Feature|important|The weapons are listed in the order they were taken by the unit, with the most recent at the bottom of the array, e.g do '''not''' assume the first item is always the primary weapon.}}
Line 56: Line 52:
]
]
*/
*/
</sqf>
</sqf>


Latest revision as of 11:35, 3 September 2024

Arma 3 logo black.png0.76
Hover & click on the images for description

Description

Description:
Weaponsitems.jpg
Returns an array with subarrays contains class names and also names of connected items of all the vehicle's weapons.
ⓘ
This command can return weapon magazine(s) if any are present. Or an empty array if weapon is stored without a magazine in it.
  • Arma 3 logo black.png1.22 it is possible to query weapon holders and ammo crates with this command.
    If the argument is a vehicle, the command will return vehicle's weapons.
    If the argument is a container, the command will act identical to weaponsItemsCargo.
  • Arma 3 logo black.png1.96 the returned array always contains secondary muzzle magazine info and consistent with getUnitLoadout format for weapon items.
  • Arma 3 logo black.png2.02 the returned array can contains binocular weapon items.
Groups:
Unit InventoryVehicle Inventory

Syntax

Syntax:
weaponsItems vehicle
Parameters:
vehicle: Object - unit or vehicle
Return Value:
Array of Arrays of weapon items, format [weapon, muzzle, flashlight, optics, [magazine, ammo], [magazine, ammo], bipod]:
⚠
The weapons are listed in the order they were taken by the unit, with the most recent at the bottom of the array, e.g do not assume the first item is always the primary weapon.

Alternative Syntax

Syntax:
weaponsItems [vehicle, extended]
Parameters:
vehicle: Object - unit or vehicle
extended: Boolean - true to include muzzle information
Return Value:
Array of Arrays (see above) in format [weapon, muzzle, flashlight, optics, [magazine, ammo, muzzle, maxammo], [magazine, ammo, muzzle, maxammo], bipod]

Examples

Example 1:
hint str weaponsItems player; // returns e.g /* [ ["arifle_MX_ACO_pointer_F", "muzzle_snds_H", "acc_pointer_IR", "optic_Aco", ["30Rnd_65x39_caseless_mag", 30], [], "bipod_01_F_blk"], ["launch_NLAW_F", "", "", "", ["NLAW_F", 1], [], ""], ["hgun_P07_F", "muzzle_snds_L", "", "", ["16Rnd_9x21_Mag", 11], [], ""] ] // a loaded underbarrel grenade launcher can look like this: [ ["arifle_MX_GL_F", "muzzle_snds_H", "acc_pointer_IR", "optic_Aco", ["30Rnd_65x39_caseless_mag", 30], ["1Rnd_HE_Grenade_shell", 1], ""] ] */
Example 2:
hint str weaponsItems vehicle player; // returns e.g /* [ ["gatling_30mm", "", "", "", ["250Rnd_30mm_HE_shells", 250], [], ""], ["missiles_SCALPEL", "", "", "", ["8Rnd_LG_scalpel", 8], [], ""], ["rockets_Skyfire", "", "", "", ["38Rnd_80mm_rockets", 38], [], ""] ] */

Additional Information

See also:
weaponsItemsCargo primaryWeaponItems secondaryWeaponItems handgunItems addPrimaryWeaponItem addSecondaryWeaponItem addHandgunItem primaryWeapon secondaryWeapon handgunWeapon binocular weaponAccessories addWeaponWithAttachmentsCargoGlobal BIS_fnc_weaponComponents weaponState

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=weaponsItems&oldid=369242"