Difference between revisions of "ammo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (that syntax didn't return 30, it assigned 30 to a variable. Try to keep examples and corresponding explanation correct.)
m (template:command argument fix)
(23 intermediate revisions by 12 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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| unit '''ammo''' "weaponName" |= Syntax
+
| unit '''ammo''' muzzle |SYNTAX=
  
|p1= unit: [[Object]] |= Parameter 1
+
|p1= unit: [[Object]] |PARAMETER1=
  
|p2= weaponName: [[String]] - muzzle 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=
  
| [[Integer]] |= Return value
+
| [[Number]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <pre>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=
 +
 
 +
|x3= <code>_count = [[player]] [[ammo]] [[primaryWeapon]] [[player]];</code> |EXAMPLE3=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[someAmmo]] |= See also
+
| [[setAmmo]], [[someAmmo]], [[magazines]] |SEEALSO=
  
 
}}
 
}}
Line 33: Line 35:
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 +
 +
<dd class="notedate">Posted on February 17, 2012
 +
<dt class="note">'''[[User:kju|kju]]'''
 +
<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".
  
 
<!-- Note Section END -->
 
<!-- Note Section END -->
Line 40: 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]]
 
[[Category:Scripting Commands ArmA|AMMO]]
 
[[Category:Scripting Commands ArmA|AMMO]]
 
[[Category:Command_Group:_Weapons|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Weapons|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{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 14:28, 7 April 2019

Introduced with Operation Flashpoint version 1.00
  Arguments of this scripting command don't have to be local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

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

Multiplayer:
-
See also:
setAmmosomeAmmomagazines

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

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.