getFuelCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
m (Text replacement - " \| *(\[\[[a-zA-Z ]+\]\].+) \|x1=" to " |r1=$1 |x1=")
Line 16: Line 16:
|p1= vehicle: [[Object]]
|p1= vehicle: [[Object]]


| [[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>

Revision as of 21:47, 10 June 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
Vehicle Inventory

Syntax

Syntax:
Syntax needed
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