ammo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
m (Text replacement - "|= Game version" to "|Game version=")
(39 intermediate revisions by 15 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#A|COMREF]]
{{Command|Comments=
____________________________________________________________________________________________


<h2 style="color:#000066">'''''unit'' ammo ''magazine'''''</h2>
| ofp |Game name=


|1.00|Game version=


'''Operand types:'''
|arg= global |Multiplayer Arguments=
____________________________________________________________________________________________


'''unit:''' [[Object]]
| 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=
____________________________________________________________________________________________


'''magazine:''' [[String]]
| unit '''ammo''' muzzle |SYNTAX=


'''Type of returned value:'''
|p1= unit: [[Object]] |PARAMETER1=


[[Number]]
|p2= muzzle: [[String]] - muzzle of a weapon. See the topic [[:Category:Weapons]] for reference about possible values. |PARAMETER2=


'''Description:'''
| [[Number]] |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>_count = [[player]] [[ammo]] "M16"; //returns 30 in case of a full magazine</code> |EXAMPLE1=


Count how many shots are left for given magazine type.
|x2= <code>_count = [[player]] [[ammo]] "M203Muzzle";</code> |EXAMPLE2=


|x3= <code>_count = [[player]] [[ammo]] [[primaryWeapon]] [[player]];</code> |EXAMPLE3=
____________________________________________________________________________________________


'''Example:'''
| [[setAmmo]], [[someAmmo]], [[magazines]] |SEEALSO=


player '''ammo''' "M16"
}}
 
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- 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 -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[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}}}}]]
 
<!-- 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 01:18, 31 August 2019

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.55.133505 the command also returns ammo for units in vehicles.
Groups:
Uncategorised

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

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

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.