Difference between revisions of "getFuelCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ")
m (Text replacement - " |r1=[[" to " |r1= [[")
 
Line 15: Line 15:
 
|p1= vehicle: [[Object]]
 
|p1= vehicle: [[Object]]
  
|r1=[[Number]] - fuel cargo value, -1 if fuel cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]
+
|r1= [[Number]] - fuel cargo value, -1 if fuel cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]
  
 
|x1= <code>value = [[getFuelCargo]] myVehicleName;</code>
 
|x1= <code>value = [[getFuelCargo]] myVehicleName;</code>

Latest revision as of 23:47, 7 August 2021

Hover & click on the images for description

Description

Description:
Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle.
Since Arma 3 v1.96 the return value for vehicles that are not configured to have ability to refuel other vehicles is -1. (Prior to that the value was negative infinity)
Groups:
Vehicle Inventory

Syntax

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

Examples

Example 1:
value = getFuelCargo myVehicleName;

Additional Information

See also:
setFuelCargogetAmmoCargogetRepairCargo

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.
Posted on September 6, 2019 - 07:19 (UTC)
killzone_kid
If you have ACE mod installed, note that it removes fuel cargo from vehicles so it could appear that the command always returns 0