Difference between revisions of "getAmmoCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
 
{{Command|Comments=
 
{{Command|Comments=
____________________________________________________________________________________________
 
  
 
| arma3 |Game name=
 
| arma3 |Game name=
Line 7: Line 6:
  
 
|gr1= Vehicle Inventory |GROUP1=
 
|gr1= Vehicle Inventory |GROUP1=
____________________________________________________________________________________________
 
  
 
| Returns the amount (1 is full) of ammo resources in the cargo space of a rearm vehicle. <br><br>
 
| Returns the amount (1 is full) of ammo resources in the cargo space of a rearm vehicle. <br><br>
 
{{Informative | Since Arma 3 v1.94.145939 the return value for vehicles that are not configured to have ability to rearm other vehicles is -1. (Prior to that the value was negative infinity)}} |DESCRIPTION=
 
{{Informative | Since Arma 3 v1.94.145939 the return value for vehicles that are not configured to have ability to rearm other vehicles is -1. (Prior to that the value was negative infinity)}} |DESCRIPTION=
____________________________________________________________________________________________
 
  
 
| '''getAmmoCargo''' vehicle  |SYNTAX=
 
| '''getAmmoCargo''' vehicle  |SYNTAX=
Line 22: Line 19:
 
|x1= <code>value = [[getAmmoCargo]] myVehicleName;</code>|EXAMPLE1=  
 
|x1= <code>value = [[getAmmoCargo]] myVehicleName;</code>|EXAMPLE1=  
  
____________________________________________________________________________________________
 
  
 
| [[setAmmoCargo]], [[getFuelCargo]], [[getRepairCargo]] |SEEALSO=  
 
| [[setAmmoCargo]], [[getFuelCargo]], [[getRepairCargo]] |SEEALSO=  
  
 
|  |MPBEHAVIOUR=  
 
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
 
 
}}
 
}}
  

Revision as of 01:07, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns the amount (1 is full) of ammo resources in the cargo space of a rearm vehicle.

Template:Informative
Groups:
Vehicle Inventory

Syntax

Syntax:
getAmmoCargo vehicle
Parameters:
vehicle: Object
Return Value:
Number - ammo cargo value, -1 if ammo cargo is not supported, 0 if the vehicle is !alive or isNull

Examples

Example 1:
value = getAmmoCargo myVehicleName;

Additional Information

See also:
setAmmoCargogetFuelCargogetRepairCargo

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 22, 2014 - 17:16 (UTC)
AgentRev
Prior to Arma 3 v1.93.145625 If the vehicle is not alive, it always returns Nothing, which you should check for using isNil.
If the vehicle is unable to carry that type of cargo, it returns -1.#IND, which you should check for using finite or < 0.