getFuelCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=
 
|0.56|Game version=
|0.56|= Game version
|arg= global|Multiplayer Arguments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the fuel amount (between 0 and 1) in the cargo space of a refuelling vehicle.   |= Description
| Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle. <br><br>
{{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=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''getFuelCargo''' vehicle  |= Syntax
| '''getFuelCargo''' vehicle  |SYNTAX=


|p1= vehicle: [[Object]] |= Parameter 1
|p1= vehicle: [[Object]] |PARAMETER1=


| [[Number]] |= 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]] |= SEEALSO
| [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]] |SEEALSO=  


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}
Line 42: Line 44:
<dl class="command_description">
<dl class="command_description">
<dd class="notedate">Posted on December 22, 2014 - 17:16 (UTC)</dd>
<dd class="notedate">Posted on December 22, 2014 - 17:16 (UTC)</dd>
<dt class="note">[[User:AgentRevolution|AgentRevolution]]</dt>
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
<dd class="note">
<dd class="note">
If the vehicle is unable to carry that type of cargo, the returned value is [[Number#Number_Type|negative infinity]] (-1.#INF), which evaluates as neither greater than, less than, nor equal to 0.<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 not [[alive]], the returned value is always [[nil]].
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>
<dt class="note">[[User:killzone_kid|killzone_kid]]</dt>
<dd class="note">If you have ACE mod installed, note that it removes fuel cargo from vehicles so it could appear that the command always returns 0</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 09:19, 6 September 2019

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.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)
Groups:
Uncategorised

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