weaponState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
(format)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the current weapon state as an array of strings in the following format [WeaponName, MuzzleName, ModeName, MagazineName, AmmoCount] (AmmoCount is [[Number]]). |= Description
| Returns the current unit's or vehicle's weapon state |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''weaponState''' unitName |= Syntax
| '''weaponState''' unit |= Syntax


|p1= unitName: [[Object]] |= Parameter 1
|p1= unit: [[Object]] |= Parameter 1


| [[Array]] - ["m16a4","m16a4","Single","30Rnd_556x45_Stanag",29] |= Return value
| [[Array]] - in format [weapon, muzzle, firemode, magazine, ammoCount], where:
* weapon: [[String]]
* muzzle: [[String]]
* firemode: [[String]]
* magazine: [[String]]
* ammoCount: [[Number]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|s2= '''weaponState''' [vehicle, turretPath] |= Syntax
|s2= '''weaponState''' [vehicle, turretPath] |= Syntax


|p21= vehicle: [[Object]] |= Parameter 1
|p21 =  [vehicle, turretPath]: [[Array]] |=
|p22= vehicle: [[Object]] |= Parameter 1


|p22= turretPath: [[Array]] |= Parameter 2
|p23= turretPath: [[Array]] |= Parameter 2


|r2= [[Array]] - ["M256","M256","M256","20Rnd_120mmSABOT_M1A2",20] |= Return value 2
|r2= [[Array]] - in format [weapon, muzzle, firemode, magazine, ammoCount], where:
* weapon: [[String]]
* muzzle: [[String]]
* firemode: [[String]]
* magazine: [[String]]
* ammoCount: [[Number]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>_weaponStatePlayer <nowiki>=</nowiki> [[weaponState]] [[player]];</code>|= EXAMPLE1  
|x1= <code>_wsPlayer <nowiki>=</nowiki> [[weaponState]] [[player]];// ["m16a4","m16a4","Single","30Rnd_556x45_Stanag",29]</code>|= EXAMPLE1  
|x2= <code>_weaponStateVehiclePlayer <nowiki>=</nowiki> [[weaponState]] [ [[vehicle]] [[player]],[0]];</code>|= EXAMPLE2  
|x2= <code>_wsVehiclePlayer <nowiki>=</nowiki> [[weaponState]] <nowiki>[</nowiki>[[vehicle]] [[player]],[0]]; //["M256","M256","M256","20Rnd_120mmSABOT_M1A2",20] </code>|= EXAMPLE2  
|x3= <code>_SecondPositionOfThefirstTurret <nowiki>=</nowiki> [[weaponState]] [ [[vehicle]] [[player]],[0,0,1]];</code>|= EXAMPLE2  
|x3= <code>_SecondPositionOfThefirstTurret <nowiki>=</nowiki> [[weaponState]] <nowiki>[</nowiki>[[vehicle]] [[player]],[0,0,1]]; </code>|= EXAMPLE2  


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 14:55, 13 February 2017

A2 OA Logo.png1.60
Hover & click on the images for description

Description

Description:
Returns the current unit's or vehicle's weapon state
Groups:
Uncategorised

Syntax

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

Alternative Syntax

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

Examples

Example 1:
_wsPlayer = weaponState player;// ["m16a4","m16a4","Single","30Rnd_556x45_Stanag",29]
Example 2:
_wsVehiclePlayer = weaponState [vehicle player,[0]]; //["M256","M256","M256","20Rnd_120mmSABOT_M1A2",20]
Example 3:
_SecondPositionOfThefirstTurret = weaponState [vehicle player,[0,0,1]];

Additional Information

See also:
weaponsloadMagazinemagazinesTurretweaponsTurret

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

Posted on February 17, 2012
kju
The command does not work for a vehicle driver - even if he has weapons.
The command only works for vehicle positions, if there was an unit on the position before. When a position has been occupied once, the command even works when there is no unit currently at the given vehicle position.

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=weaponState&oldid=98818"