weaponsInfo: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (Created page with "{{RV|type=command |game1= arma3 |version1= 2.10 |branch= dev |gr1= Weapons |descr= Returns entitiy's weapons information including weapon index and firemode. |s1= unit w...") |
Killzone Kid (talk | contribs) No edit summary |
||
(10 intermediate revisions by 4 users not shown) | |||
Line 3: | Line 3: | ||
|game1= arma3 | |game1= arma3 | ||
|version1= 2.10 | |version1= 2.10 | ||
|gr1= Weapons | |gr1= Weapons | ||
|descr= Returns | |descr= Returns entity's weapons information including weapon index and firemode. | ||
|s1= unit [[weaponsInfo]] [ | |s1= unit [[weaponsInfo]] [weaponOrMuzzle, onlyLoaded] | ||
|p1= unit: [[Object]] - person | |p1= unit: [[Object]] - person | ||
|p2= | |p2= weaponOrMuzzle: [[String]] - name of the weapon or muzzle (returns whichever matches first) or "" to return all weapons | ||
|p3= onlyLoaded | |p3= onlyLoaded: [[Boolean]] - (Optional, default [[false]]) [[true]] to return loaded weapons only | ||
|r1= [[Array]] - weapons information in format [weaponIndex, isSelected, weaponName, muzzleName, firemode, magazineName, ammoCount] where: | |r1= [[Array]] of [[Array]]s (or an empty []) - weapons information in format <nowiki>[</nowiki>[weaponIndex, isSelected, weaponName, muzzleName, firemode, magazineName, ammoCount, isPrimary], ...] 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 | ||
Line 25: | Line 24: | ||
* magazineName: [[String]] - name of the loaded magazine or "" | * magazineName: [[String]] - name of the loaded magazine or "" | ||
* ammoCount: [[Number]] - magazine ammo count or -1 | * ammoCount: [[Number]] - magazine ammo count or -1 | ||
* isPrimary: [[Boolean]] - [[true]] if this muzzle is considered primary by the engine (Since Arma 3 2.14) | |||
|x1= < | |x1= Find weapon with FullAuto firemode and switch to it: <sqf> | ||
private _weapons = player weaponsInfo [currentMuzzle player, true]; | |||
private _found = _weapons findIf { _x select 4 == "FullAuto" }; | |||
if (_found > -1) then { action ["SwitchWeapon", player, player, _weapons select _found select 0] }; | |||
</sqf> | |||
|seealso= [[weaponState]] [[weaponReloadingTime]] | |seealso= [[weaponState]] [[weaponReloadingTime]] [[action]] | ||
}} | }} |
Latest revision as of 09:07, 23 July 2023
Description
- Description:
- Returns entity's weapons information including weapon index and firemode.
- Groups:
- Weapons
Syntax
- Syntax:
- unit weaponsInfo [weaponOrMuzzle, onlyLoaded]
- Parameters:
- unit: Object - person
- weaponOrMuzzle: String - name of the weapon or muzzle (returns whichever matches first) or "" to return all weapons
- onlyLoaded: Boolean - (Optional, default false) true to return loaded weapons only
- Return Value:
- Array of Arrays (or an empty []) - weapons information in format [[weaponIndex, isSelected, weaponName, muzzleName, firemode, magazineName, ammoCount, isPrimary], ...] 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
- isPrimary: Boolean - true if this muzzle is considered primary by the engine (Since Arma 3 2.14)
Examples
- Example 1:
- Find weapon with FullAuto firemode and switch to it:
Additional Information
- See also:
- weaponState weaponReloadingTime action
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