Difference between revisions of "getFuelCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
Line 11: Line 11:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle. <br><br>
+
| 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)}} |DESCRIPTION=
|DESCRIPTION=
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
Line 20: Line 19:
 
|p1= vehicle: [[Object]] |PARAMETER1=
 
|p1= vehicle: [[Object]] |PARAMETER1=
  
| [[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]] |RETURNVALUE=
  
|x1= <code>value = [[getFuelCargo]] myVehicleName;</code>|EXAMPLE1=  
+
|x1= <code>value = [[getFuelCargo]] myVehicleName;</code>|EXAMPLE1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]] |SEEALSO=  
+
| [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]] |SEEALSO=
 
 
____________________________________________________________________________________________
 
 
}}
 
}}
  
Line 38: Line 35:
  
 
<h3 style='display:none'>Bottom Section</h3>
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
  
 
<!-- CONTINUE Notes -->
 
<!-- CONTINUE Notes -->
Line 50: Line 44:
 
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>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on September 6, 2019 - 07:19 (UTC)</dd>
 
<dd class="notedate">Posted on September 6, 2019 - 07:19 (UTC)</dd>
 
<dt class="note">[[User:killzone_kid|killzone_kid]]</dt>
 
<dt class="note">[[User:killzone_kid|killzone_kid]]</dt>

Revision as of 03:04, 25 September 2020

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