Difference between revisions of "ammo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "|= Game version" to "|Game version=")
(35 intermediate revisions by 16 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|AMMO]]
+
{{Command|Comments=
[[Category:Scripting Commands OFP 1.97|AMMO]]
+
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|AMMO]]
+
 
[[Category:Scripting Commands ArmA|AMMO]]
+
| ofp |Game name=
 +
 
 +
|1.00|Game version=
 +
 
 +
|arg= global |Multiplayer Arguments=
 +
____________________________________________________________________________________________
 +
 
 +
| 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''' muzzle |SYNTAX=
  
 +
|p1= unit: [[Object]] |PARAMETER1=
  
<h2 style="color:#000066">'''''unit'' ammo ''magazine'''''</h2>
+
|p2= muzzle: [[String]] - muzzle of a weapon. See the topic [[:Category:Weapons]] for reference about possible values. |PARAMETER2=
  
 +
| [[Number]] |RETURNVALUE=
 +
____________________________________________________________________________________________
 +
 
 +
|x1= <code>_count = [[player]] [[ammo]] "M16"; //returns 30 in case of a full magazine</code> |EXAMPLE1=
  
'''Operand types:'''
+
|x2= <code>_count = [[player]] [[ammo]] "M203Muzzle";</code> |EXAMPLE2=
  
'''unit:''' [[Object]]
+
|x3= <code>_count = [[player]] [[ammo]] [[primaryWeapon]] [[player]];</code> |EXAMPLE3=
 +
____________________________________________________________________________________________
  
'''magazine:''' [[String]]
+
| [[setAmmo]], [[someAmmo]], [[magazines]] |SEEALSO=
  
'''Type of returned value:'''
+
}}
  
[[Number]]
+
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
  
'''Description:'''
+
<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".
  
Count how many shots are left for given magazine type.
+
<!-- Note Section END -->
 +
</dl>
  
 +
<h3 style="display:none">Bottom Section</h3>
  
'''Example:'''
+
[[Category:Scripting Commands|AMMO]]
 +
[[Category:Scripting Commands OFP 1.99|AMMO]]
 +
[[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}}}}]]
 +
[[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}}}}]]
  
player '''ammo''' "M16"
+
<!-- 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 00:18, 31 August 2019

Introduced with Operation Flashpoint version 1.001.00
Arguments 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. Use the Talk page or the Forums for discussions.

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.