getFuelCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3 |= Game name |0.56|= Game version ____________________...")
 
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(52 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.56


|0.56|= Game version
|arg= global
____________________________________________________________________________________________


| Returns the fuel amount in the cargo space of a refuelling vehicle.  |= Description
|gr1= Vehicle Inventory
____________________________________________________________________________________________


| '''getFuelCargo''' vehicle |= Syntax
|descr= Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle.
{{Feature|informative|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)}}


|p1= vehicle: [[Object]] |= Parameter 1
|s1= [[getFuelCargo]] vehicle


| [[Number]] |= RETURNVALUE
|p1= vehicle: [[Object]]


|r1= [[Number]] - fuel cargo value, -1 if fuel cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]


|x1= <code></code>|= EXAMPLE1
|x1= <sqf>value = getFuelCargo myVehicleName;</sqf>


____________________________________________________________________________________________
|seealso= [[setFuelCargo]] [[getAmmoCargo]] [[getRepairCargo]]
}}


|  |= SEEALSO
<dl class="command_description">


| |= MPBEHAVIOUR
<dt></dt>
____________________________________________________________________________________________
<dd class="notedate">Posted on 2014-12-22 - 17:16 (UTC)</dd>
}}
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
<dd class="note">
'''Prior to Arma 3 v1.94''' If the vehicle is not [[alive]], it always returns [[Nothing]], which you should check for using [[isNil]].<br>
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>


<h3 style='display:none'>Notes</h3>
<dt><dt>
<dl class='command_description'>
<dd class="notedate">Posted on 2019-09-06 - 07:19 (UTC)</dd>
<!-- Note Section BEGIN -->
<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>


<!-- Note Section END -->
</dl>
</dl>
<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}}}}]]

Latest revision as of 19:11, 15 March 2024

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:
setFuelCargo getAmmoCargo getRepairCargo

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 2014-12-22 - 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 2019-09-06 - 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