Difference between revisions of "ammo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "</dl> <dl class="command_description"> " to "")
(80 intermediate revisions by 16 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|AMMO]]
+
{{RV|type=command
[[Category:Scripting Commands OFP 1.97|AMMO]]
 
[[Category:Scripting Commands OFP 1.46|AMMO]]
 
[[Category:Scripting Commands ArmA|AMMO]]
 
  
 +
|game1= ofp
 +
|version1= 1.00
  
<h2 style="color:#000066">'''''unit'' ammo ''magazine'''''</h2>
+
|game2= ofpe
 +
|version2= 1.00
  
 +
|game3= arma1
 +
|version3= 1.00
  
'''Operand types:'''
+
|game4= arma2
 +
|version4= 1.00
  
'''unit:''' [[Object]]
+
|game5= arma2oa
 +
|version5= 1.50
  
'''magazine:''' [[String]]
+
|game6= tkoh
 +
|version6= 1.00
  
'''Type of returned value:'''
+
|game7= arma3
 +
|version7= 0.50
  
[[Number]]
+
|arg= global
  
'''Description:'''
+
|gr1= Unit Inventory
  
Count how many shots are left for given magazine type.
+
|descr= Check how many rounds are left in the currently loaded magazine in the given muzzle. Since Arma v1.56 the command also returns ammo for units in vehicles.
  
 +
|s1= unit [[ammo]] muzzle
  
'''Example:'''
+
|p1= unit: [[Object]]
  
player '''ammo''' "M16"
+
|p2= muzzle: [[String]] - muzzle of a weapon. See the topic [[:Category:Weapons]] for reference about possible values.
 +
 
 +
|r1= [[Number]]
 +
 
 +
|x1= <code>_count = [[player]] [[ammo]] "M16"; //returns 30 in case of a full magazine</code>
 +
 
 +
|x2= <code>_count = [[player]] [[ammo]] "M203Muzzle";</code>
 +
 
 +
|x3= <code>_count = [[player]] [[ammo]] [[primaryWeapon]] [[player]];</code>
 +
 
 +
|seealso= [[setAmmo]], [[someAmmo]], [[magazines]]
 +
}}
 +
 
 +
<dl class="command_description">
 +
 
 +
<dt><dt>
 +
<dd class="notedate">Posted on February 17, 2012</dd>
 +
<dt class="note">[[User:kju|kju]]</dt>
 +
<dd class="note">'''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".
 +
 
 +
 
 +
<dt></dt>
 +
<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>

Revision as of 13:30, 9 August 2021

Hover & click on the images for description

Description

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

Syntax

Syntax:
unit ammo muzzle
Parameters:
unit: Object
muzzle: String - muzzle of a weapon. See the topic 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

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
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".
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.