weaponState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma2oa |Game name=
| arma2oa |Game name=
Line 7: Line 6:


|gr1= Weapons |GROUP1=
|gr1= Weapons |GROUP1=
____________________________________________________________________________________________


| Returns the currently selected weapon state for unit or vehicle.<br><br>
| Returns the currently selected weapon state for unit or vehicle.<br><br>
Line 15: Line 13:
* Driver turret can now be accessed as well with turret path [-1].
* Driver turret can now be accessed as well with turret path [-1].
* Muzzle name is supported as well as weapon name. The command searches for weapon first, then if not found, muzzle is searched for. }}|DESCRIPTION=
* Muzzle name is supported as well as weapon name. The command searches for weapon first, then if not found, muzzle is searched for. }}|DESCRIPTION=
____________________________________________________________________________________________


| [[weaponState]] unit |SYNTAX=
| [[weaponState]] unit |SYNTAX=
Line 27: Line 24:
* magazine: [[String]]
* magazine: [[String]]
* ammoCount: [[Number]] |RETURNVALUE=
* ammoCount: [[Number]] |RETURNVALUE=
____________________________________________________________________________________________


|s2= [[weaponState]] [vehicle, turretPath, weapon] |SYNTAX2=
|s2= [[weaponState]] [vehicle, turretPath, weapon] |SYNTAX2=
Line 45: Line 41:
* magazine: [[String]]
* magazine: [[String]]
* ammoCount: [[Number]] |RETURNVALUE2=
* ammoCount: [[Number]] |RETURNVALUE2=
____________________________________________________________________________________________


|x1= <code>_wsPlayer = [[weaponState]] [[player]]; {{cc|["arifle_MXC_ACO_F","arifle_MXC_ACO_F","Single","30Rnd_65x39_caseless_mag",30]}}</code> |EXAMPLE1=
|x1= <code>_wsPlayer = [[weaponState]] [[player]]; {{cc|["arifle_MXC_ACO_F","arifle_MXC_ACO_F","Single","30Rnd_65x39_caseless_mag",30]}}</code> |EXAMPLE1=
|x2= <code>_wsVehicle = [[weaponState]] [_apc, [0]]; {{cc|["autocannon_40mm_CTWS","HE","player","60Rnd_40mm_GPR_Tracer_Red_shells",60]}}</code> |EXAMPLE2=
|x2= <code>_wsVehicle = [[weaponState]] [_apc, [0]]; {{cc|["autocannon_40mm_CTWS","HE","player","60Rnd_40mm_GPR_Tracer_Red_shells",60]}}</code> |EXAMPLE2=
|x3= <code>_wsVehicle = [[weaponState]] [_apc, [0], "AP"]; {{cc|["autocannon_40mm_CTWS","AP","player","40Rnd_40mm_APFSDS_Tracer_Red_shells",40]}}</code> |EXAMPLE3=
|x3= <code>_wsVehicle = [[weaponState]] [_apc, [0], "AP"]; {{cc|["autocannon_40mm_CTWS","AP","player","40Rnd_40mm_APFSDS_Tracer_Red_shells",40]}}</code> |EXAMPLE3=
____________________________________________________________________________________________


| [[weapons]], [[selectWeaponTurret]], [[loadMagazine]], [[magazinesTurret]], [[weaponsTurret]] |SEEALSO=
| [[weapons]], [[selectWeaponTurret]], [[loadMagazine]], [[magazinesTurret]], [[weaponsTurret]] |SEEALSO=

Revision as of 04:22, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns the currently selected weapon state for unit or vehicle.

Arma 3
Since Arma 3 v1.69.140397 this command has been improved and extended:
  • A vehicle's weapon query doesn't need a weapon operator provided the weapon or muzzle is specified in optional param.
    (keep in mind that by default a vehicle has no weapons selected)
  • Driver turret can now be accessed as well with turret path [-1].
  • Muzzle name is supported as well as weapon name. The command searches for weapon first, then if not found, muzzle is searched for.
Groups:
Weapons

Syntax

Syntax:
weaponState unit
Parameters:
unit: Object
Return Value:
Array - in format [weapon, muzzle, firemode, magazine, ammoCount], where:

Alternative Syntax

Syntax:
weaponState [vehicle, turretPath, weapon]
Parameters:
[vehicle, turretPath, weapon]: Array
vehicle: Object
turretPath: Array
weapon (Optional): String (since Arma 3 v1.69.140397) - weapon or muzzle name
Return Value:
Array - in format [weapon, muzzle, firemode, magazine, ammoCount], where:

Examples

Example 1:
_wsPlayer = weaponState player; // ["arifle_MXC_ACO_F","arifle_MXC_ACO_F","Single","30Rnd_65x39_caseless_mag",30]
Example 2:
_wsVehicle = weaponState [_apc, [0]]; // ["autocannon_40mm_CTWS","HE","player","60Rnd_40mm_GPR_Tracer_Red_shells",60]
Example 3:
_wsVehicle = weaponState [_apc, [0], "AP"]; // ["autocannon_40mm_CTWS","AP","player","40Rnd_40mm_APFSDS_Tracer_Red_shells",40]

Additional Information

See also:
weaponsselectWeaponTurretloadMagazinemagazinesTurretweaponsTurret

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

Notes

Bottom Section