Difference between revisions of "getAmmoCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class="command_description"> <dt></dt>" to "<dl class="command_description"> <dt></dt>")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(4 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
|r1= [[Number]] - ammo cargo value, -1 if ammo cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]
 
|r1= [[Number]] - ammo cargo value, -1 if ammo cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]
  
|x1= <code>value = [[getAmmoCargo]] myVehicleName;</code>
+
|x1= <sqf>value = getAmmoCargo myVehicleName;</sqf>
  
|seealso= [[setAmmoCargo]], [[getFuelCargo]], [[getRepairCargo]]
+
|seealso= [[setAmmoCargo]] [[getFuelCargo]] [[getRepairCargo]]
 
}}
 
}}
  
Line 31: Line 31:
 
If the vehicle is unable to carry that type of cargo, it returns [[Number#Number_Type|-1.#IND]], which you should check for using [[finite]] or [[a_less_b | <]] 0.
 
If the vehicle is unable to carry that type of cargo, it returns [[Number#Number_Type|-1.#IND]], which you should check for using [[finite]] or [[a_less_b | <]] 0.
 
</dd>
 
</dd>
 +
 
</dl>
 
</dl>

Latest revision as of 11:23, 13 May 2022

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.
Since Arma 3 v1.96 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)
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:
setAmmoCargo getFuelCargo getRepairCargo

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
Posted on December 22, 2014 - 17:16 (UTC)
AgentRev
Prior to Arma 3 v1.94 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.