magazinesAmmo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Add since template usage)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns array of arrays of all vehicle's magazines and their ammo count (also works on supply boxes). When applied to a unit (soldier), the command behaves differently and will omit magazines already loaded into unit's weapons. Use [[magazinesAmmoFull]] to return all magazines.
| Returns all vehicle's magazines and their ammo count (also works on supply boxes). When applied to a unit (soldier), the command behaves differently and will omit magazines already loaded into unit's weapons. Use [[magazinesAmmoFull]] to return all magazines. |DESCRIPTION=
 
<br><br>'''Output format''':
 
<br>[[magazine1],[magazine2],[magazine3]...[magazineN]]
 
<br><br>'''Magazine format''':
 
<br>0: Magazine class name
 
<br>1: Magazine current ammo count |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[magazinesAmmo]] vehicle |SYNTAX=
| [[magazinesAmmo]] vehicle |SYNTAX=


|p1= vehicle: [[Object]] - unit or vehicle or container. When transport is supplied, the command returns vehicle's magazines not the cargo. When container is supplied, the command behaves identically to [[magazinesAmmoCargo]] |PARAMETER1=  
|p1= vehicle: [[Object]] - unit or vehicle or container. When transport is supplied, the command returns vehicle's magazines not the cargo. When container is supplied, the command behaves identically to [[magazinesAmmoCargo]] |PARAMETER1=
 
| [[Array]] of [[Array]]s in format:
* [[String]]: magazine class name
* [[Number]]: magazine ammo count |RETURNVALUE=


| [[Array]] |RETURNVALUE=  
|s2= [[magazinesAmmo]] [vehicle, includeEmpty] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(Since Arma 3 v1.99.146475)|SYNTAX2=


| s2= [[magazinesAmmo]] [vehicle, includeEmpty] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(Since Arma 3 v1.99.146475)|SYNTAX2=
|p21= vehicle: [[Object]] - unit or vehicle. |PARAMETER21=


|p21= [vehicle, includeEmpty]: [[Array]]  |PARAMETER21=
|p22= includeEmpty (Optional): [[Boolean]] - [[true]] to include empty magazines. Default: [[false]]  |PARAMETER22=
|p22= vehicle: [[Object]] - unit or vehicle.  |PARAMETER22=
|p23= includeEmpty (Optional): [[Boolean]] - [[true]] to include empty magazines. Default: [[false]]  |PARAMETER23=  


| r2=[[Array]] |RETURNVALUE2=  
|r2= [[Array]] of [[Array]]s in format:
* [[String]]: magazine class name
* [[Number]]: magazine ammo count |RETURNVALUE2=
   
   
|x1=<code>_magazinesAmmo = [[magazinesAmmo]] [[player]];
|x1= <code>_magazinesAmmo = [[magazinesAmmo]] [[player]];
/*
{{codecomment|/*
[
[
["30Rnd_65x39_caseless_mag",30],
["30Rnd_65x39_caseless_mag",30],
Line 48: Line 42:
["HandGrenade",1]
["HandGrenade",1]
]
]
<nowiki>*/</nowiki></code>|EXAMPLE1=
<nowiki/>*/}}</code>|EXAMPLE1=


|x2=<code>_magazinesAmmo = [[magazinesAmmo]] Mi_48;
|x2=<code>_magazinesAmmo = [[magazinesAmmo]] Mi_48;
/*
{{codecomment|/*
[
[
["250Rnd_30mm_APDS_shells",250],
["250Rnd_30mm_APDS_shells",250],
Line 58: Line 52:
["38Rnd_80mm_rockets",38]
["38Rnd_80mm_rockets",38]
]
]
<nowiki>*/</nowiki></code>|EXAMPLE2=
<nowiki/>*/}}</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[magazinesAmmoFull]], [[magazinesAmmoCargo]], [[magazinesDetail]], [[magazines]], [[magazinesTurret]] |SEEALSO=  
| [[magazinesAmmoFull]], [[magazinesAmmoCargo]], [[magazinesDetail]], [[magazines]], [[magazinesTurret]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}



Revision as of 23:15, 23 December 2020

Hover & click on the images for description

Description

Description:
Returns all vehicle's magazines and their ammo count (also works on supply boxes). When applied to a unit (soldier), the command behaves differently and will omit magazines already loaded into unit's weapons. Use magazinesAmmoFull to return all magazines.
Groups:
Unit InventoryVehicle Inventory

Syntax

Syntax:
magazinesAmmo vehicle
Parameters:
vehicle: Object - unit or vehicle or container. When transport is supplied, the command returns vehicle's magazines not the cargo. When container is supplied, the command behaves identically to magazinesAmmoCargo
Return Value:
Array of Arrays in format:

Alternative Syntax

Syntax:
magazinesAmmo [vehicle, includeEmpty]        (Since Arma 3 v1.99.146475)
Parameters:
vehicle: Object - unit or vehicle.
includeEmpty (Optional): Boolean - true to include empty magazines. Default: false
Return Value:
Array of Arrays in format:

Examples

Example 1:
_magazinesAmmo = magazinesAmmo player; /* [ ["30Rnd_65x39_caseless_mag",30], ["30Rnd_65x39_caseless_mag",30], ["16Rnd_9x21_Mag",16], ["SmokeShellGreen",1], ["Chemlight_green",1], ["HandGrenade",1] ] */
Example 2:
_magazinesAmmo = magazinesAmmo Mi_48; /* [ ["250Rnd_30mm_APDS_shells",250], ["250Rnd_30mm_HE_shells",250], ["8Rnd_LG_scalpel",8], ["38Rnd_80mm_rockets",38] ] */

Additional Information

See also:
magazinesAmmoFullmagazinesAmmoCargomagazinesDetailmagazinesmagazinesTurret

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

Bottom Section

Posted on December 20, 2014 - 14:41 (UTC)
Actium
When used on vehicles this will only return all magazines associated with a single turretPath (which one depends on the actual armament of the vehicle, usually the first armed turretPath or alternatively turretPath [-1]).
If you want to get all turrets' magazines, use allTurrets and magazinesTurret. --Actium (talk) 15:41, 20 December 2014 (CET)