Difference between revisions of "getFuelCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
+
{{Command
  
| arma3 |Game name=
+
| arma3
  
|0.56|Game version=
+
|0.56
  
|arg= global|Multiplayer Arguments=
+
|arg= global
  
|gr1= Vehicle Inventory |GROUP1=
+
|gr1= Vehicle Inventory
  
 
| Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle.
 
| Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle.
{{Informative | Since Arma 3 v1.94.145939 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)}} |DESCRIPTION=
+
{{Informative | Since Arma 3 v1.94.145939 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)}}
  
| '''getFuelCargo''' vehicle |SYNTAX=
+
| '''getFuelCargo''' vehicle
  
|p1= vehicle: [[Object]] |PARAMETER1=
+
|p1= vehicle: [[Object]]
  
| [[Number]] - fuel cargo value, -1 if fuel cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]] |RETURNVALUE=
+
| [[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>|EXAMPLE1=
+
|x1= <code>value = [[getFuelCargo]] myVehicleName;</code>
  
| [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]] |SEEALSO=
+
| [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]]
 
}}
 
}}
  

Revision as of 00:36, 18 January 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. Template:Informative
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

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