Difference between revisions of "getAmmoCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
(-1 is returned instead of -INF)
Line 7: Line 7:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns the amount of ammo resources in the cargo space of a rearm vehicle. <br/>
+
| Returns the amount of ammo resources in the cargo space of a rearm vehicle. <br><br>
Returns 0 if vehicle cannot rearm or has no resources. (Since Arma 3 v1.93.145625) |DESCRIPTION=
+
{{Informative | Since Arma 3 v1.94.145939 The returns 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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
Line 15: Line 15:
 
|p1= vehicle: [[Object]] |PARAMETER1=
 
|p1= vehicle: [[Object]] |PARAMETER1=
  
| [[Number]] |RETURNVALUE=  
+
| [[Number]] - ammo cargo value, -1 if ammo cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]] |RETURNVALUE=  
  
  
Line 46: Line 46:
 
<dd class="note">
 
<dd class="note">
 
'''Prior to Arma 3 v1.93.145625''' If the vehicle is not [[alive]], it always returns [[Nothing]], which you should check for using [[isNil]].<br/>
 
'''Prior to Arma 3 v1.93.145625''' If the vehicle is not [[alive]], it always returns [[Nothing]], which you should check for using [[isNil]].<br/>
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]].
+
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>
 
<!-- DISCONTINUE Notes -->
 
<!-- DISCONTINUE Notes -->

Revision as of 15:10, 31 July 2019

Hover & click on the images for description

Description

Description:
Returns the amount of ammo resources in the cargo space of a rearm vehicle.

Template:Informative
Groups:
Uncategorised

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)
AgentRevolution
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.