Difference between revisions of "ammo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(9 intermediate revisions by 5 users not shown)
Line 9: Line 9:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| Check how many rounds are left in the currently loaded magazine of the given weapon. |= Description
+
| Check how many rounds are left in the currently loaded magazine in the given muzzle. Since Arma v1.55.133505 the command also returns ammo for units in vehicles.|DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| [[Number]] <nowiki>=</nowiki> unitName '''ammo''' weaponName |= Syntax
+
| unit '''ammo''' muzzle |SYNTAX=
  
−
|p1= unitName: [[Object]] |= Parameter 1
+
|p1= unit: [[Object]] |PARAMETER1=
  
−
|p2= weaponName: [[String]] - weapon name. See the topic [[:Category:Weapons]] for reference about possible values. |= Parameter 2
+
|p2= muzzle: [[String]] - muzzle of a weapon. See the topic [[:Category:Weapons]] for reference about possible values. |PARAMETER2=
  
−
| [[Number]] |= Return value
+
| [[Number]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
−
|x1= <pre>_count = player ammo "M16"</pre>
+
|x1= <code>_count = [[player]] [[ammo]] "M16"; //returns 30 in case of a full magazine</code> |EXAMPLE1=
  
−
returns 30 in case of a full magazine |= Example 1
+
|x2= <code>_count = [[player]] [[ammo]] "M203Muzzle";</code> |EXAMPLE2=
  
−
|x2= <pre>_count = player ammo "M203Muzzle"</pre> |= Example 2
+
|x3= <code>_count = [[player]] [[ammo]] [[primaryWeapon]] [[player]];</code> |EXAMPLE3=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| [[someAmmo]], [[magazines]] |= See also
+
| [[setAmmo]], [[someAmmo]], [[magazines]] |SEEALSO=
  
 
}}
 
}}
Line 46: Line 46:
  
 
[[Category:Scripting Commands|AMMO]]
 
[[Category:Scripting Commands|AMMO]]
 +
[[Category:Scripting Commands OFP 1.99|AMMO]]
 
[[Category:Scripting Commands OFP 1.96|AMMO]]
 
[[Category:Scripting Commands OFP 1.96|AMMO]]
 
[[Category:Scripting Commands OFP 1.46|AMMO]]
 
[[Category:Scripting Commands OFP 1.46|AMMO]]
Line 54: Line 55:
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 +
 +
<!-- CONTINUE Notes -->
 +
<dl class="command_description">
 +
<dd class="notedate">Posted on August 30, 2018 - 15:42 (UTC)</dd>
 +
<dt class="note">[[User:.kju|.kju]]</dt>
 +
<dd class="note">
 +
Actually the command wants the [[currentMuzzle]] ([[gunner]] _vehicle) as parameter - not the weapon class.
 +
Most of the time both are the same. However when you have custom [[CfgWeapons_Config_Reference#modes.5B.5D.3D_.7B.22this.22.7D|modes[]]] for the weapons, this is likely not true.
 +
</dd>
 +
</dl>
 +
<!-- DISCONTINUE Notes -->

Revision as of 15:28, 7 April 2019

Introduced with Operation Flashpoint version 1.001.00Arguments of this scripting command don't have to be local to the client the command is executed on
Hover & click on the images for descriptions

Description

Description:
Check how many rounds are left in the currently loaded magazine in the given muzzle. Since Arma v1.55.133505 the command also returns ammo for units in vehicles.

Syntax

Syntax:
unit ammo muzzle
Parameters:
unit: Object
muzzle: String - muzzle of a weapon. See the topic Category:Weapons for reference about possible values.
Return Value:
Number

Examples

Example 1:
_count = player ammo "M16"; //returns 30 in case of a full magazine
Example 2:
_count = player ammo "M203Muzzle";
Example 3:
_count = player ammo primaryWeapon player;

Additional Information

See also:
setAmmosomeAmmomagazines

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

+ Add Note (Help)

Notes

Posted on February 17, 2012
kju
OA 1.60: The command works (now?) also for units in vehicles. However only for the vehicle's gunners' weapons - aka those returned by "weapons vehicle".

Bottom Section

Posted on August 30, 2018 - 15:42 (UTC)
.kju
Actually the command wants the currentMuzzle (gunner _vehicle) as parameter - not the weapon class. Most of the time both are the same. However when you have custom modes[] for the weapons, this is likely not true.
Retrieved from "https://community.bistudio.com/wiki?title=ammo&oldid=120158"