weaponsInfo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(Correct return format)
Line 17: Line 17:
|p3= onlyLoaded (Optional): [[Boolean]] - [[true]] to return loaded weapons only. Default [[false]].
|p3= onlyLoaded (Optional): [[Boolean]] - [[true]] to return loaded weapons only. Default [[false]].


|r1= [[Array]] - weapons information in format [weaponIndex, isSelected, weaponName, muzzleName, firemode, magazineName, ammoCount] where:
|r1= [[Array]] of [[Array]]s - weapons information in format <nowiki>[</nowiki>[weaponIndex, isSelected, weaponName, muzzleName, firemode, magazineName, ammoCount], ...] where:
* weaponIndex: [[Number]] - internal weapon index (changes frequently) used with "SwitchWeapon" and "UseWeapon" [[action]]s
* weaponIndex: [[Number]] - internal weapon index (changes frequently) used with "SwitchWeapon" and "UseWeapon" [[action]]s
* isSelected: [[Boolean]] - [[true]] if this weapon is currently selected
* isSelected: [[Boolean]] - [[true]] if this weapon is currently selected

Revision as of 10:24, 30 March 2022

Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.10.

Description

Description:
Returns entitiy's weapons information including weapon index and firemode.
Groups:
Weapons

Syntax

Syntax:
unit weaponsInfo [weapon, onlyLoaded]
Parameters:
unit: Object - person
weapon: String - name of the weapon (not muzzle) or "" to return all weapons
onlyLoaded (Optional): Boolean - true to return loaded weapons only. Default false.
Return Value:
Array of Arrays - weapons information in format [[weaponIndex, isSelected, weaponName, muzzleName, firemode, magazineName, ammoCount], ...] where:
  • weaponIndex: Number - internal weapon index (changes frequently) used with "SwitchWeapon" and "UseWeapon" actions
  • isSelected: Boolean - true if this weapon is currently selected
  • weaponName: String - weapon name
  • muzzleName: String - muzzle name
  • firemode: String - firemode that is set for this 'weaponIndex'
  • magazineName: String - name of the loaded magazine or ""
  • ammoCount: Number - magazine ammo count or -1

Examples

Example 1:
Find weapon with FullAuto firemode and switch to it: private _weapons = player weaponsInfo [currentWeapon player, true]; private _found = _weapons findIf { _x select 4 == "FullAuto" }; if (_found > -1) then { action ["SwitchWeapon", player, player, _weapons select _found select 0] };

Additional Information

See also:
weaponState weaponReloadingTime

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