Difference between revisions of "ammo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (example)
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
(78 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
{{Command|= Comments
+
{{RV|type=command
−
____________________________________________________________________________________________
 
  
−
| ofp |= Game name
+
|game1= ofp
 +
|version1= 1.00
  
−
|1.00|= Game version
+
|game2= ofpe
 +
|version2= 1.00
  
−
|arg= global |= Arguments in MP
+
|game3= arma1
−
____________________________________________________________________________________________
+
|version3= 1.00
  
−
| Check how many rounds are left in the currently loaded magazine of the given weapon. |= Description
+
|game4= arma2
−
____________________________________________________________________________________________
+
|version4= 1.00
  
−
| unit '''ammo''' "weaponName" |= Syntax
+
|game5= arma2oa
 +
|version5= 1.50
  
−
|p1= unit: [[Object]] |= Parameter 1
+
|game6= tkoh
 +
|version6= 1.00
  
−
|p2= weaponName: [[String]] - muzzle name. See the topic [[:Category:Weapons]] for reference about possible values. |= Parameter 2
+
|game7= arma3
 +
|version7= 0.50
  
−
| [[Integer]] |= Return value
+
|arg= global
−
____________________________________________________________________________________________
 
−
 
 
−
|x1= <pre>_count=player ammo "M16"</pre>
 
  
−
returns 30 in case of a full magazine |= Example 1
+
|gr1= Unit Inventory
−
____________________________________________________________________________________________
 
  
−
| [[someAmmo]] |= See also
+
|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
 +
 +
|p1= unit: [[Object]]
 +
 +
|p2= muzzle: [[String]] - muzzle of a weapon. See the topic [[:Category:Weapons]] for reference about possible values.
 +
 +
|r1= [[Number]]
 +
 +
|x1= <sqf>_count = player ammo "M16"; //returns 30 in case of a full magazine</sqf>
 +
 +
|x2= <sqf>_count = player ammo "M203Muzzle";</sqf>
 +
 +
|x3= <sqf>_count = player ammo primaryWeapon player;</sqf>
 +
 +
|seealso= [[setAmmo]] [[someAmmo]] [[magazines]]
 
}}
 
}}
  
−
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
−
<!-- Note Section BEGIN -->
 
  
−
<!-- Note Section END -->
+
<dt><dt>
−
</dl>
+
<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".
 +
 
  
−
<h3 style="display:none">Bottom Section</h3>
+
<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>
  
−
[[Category:Scripting Commands|AMMO]]
+
</dl>
−
[[Category:Scripting Commands OFP 1.96|AMMO]]
 
−
[[Category:Scripting Commands OFP 1.46|AMMO]]
 
−
[[Category:Scripting Commands ArmA|AMMO]]
 
−
[[Category:Command_Group:_Weapons|{{uc:{{PAGENAME}}}}]]
 

Revision as of 11:21, 13 May 2022

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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:
setAmmo someAmmo magazines

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.
Retrieved from "https://community.bistudio.com/wiki?title=ammo&oldid=318674"