Difference between revisions of "getFuelCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Text replacement - ">Posted on December ([0-9]{2})[ a-zA-Z]*, ([0-9]{4})" to ">Posted on $2-12-$1")
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{Command|Comments=
+
{{RV|type=command
−
____________________________________________________________________________________________
 
  
−
| arma3 |Game name=
+
|game1= arma3
−
|0.56|Game version=
+
|version1= 0.56
−
|arg= global|Multiplayer Arguments=
 
−
____________________________________________________________________________________________
 
  
−
| Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle. <br><br>
+
|arg= global
−
{{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=
+
|gr1= Vehicle Inventory
  
−
|p1= vehicle: [[Object]] |PARAMETER1=
+
|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)}}
  
−
| [[Number]] - fuel cargo value, -1 if fuel cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]] |RETURNVALUE=
+
|s1= [[getFuelCargo]] vehicle
  
 +
|p1= vehicle: [[Object]]
  
−
|x1= <code>value = [[getFuelCargo]] myVehicleName;</code>|EXAMPLE1=
+
|r1= [[Number]] - fuel cargo value, -1 if fuel cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]
  
−
____________________________________________________________________________________________
+
|x1= <sqf>value = getFuelCargo myVehicleName;</sqf>
  
−
| [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]] |SEEALSO=
+
|seealso= [[setFuelCargo]] [[getAmmoCargo]] [[getRepairCargo]]
−
 
 
−
|  |MPBEHAVIOUR=
 
−
____________________________________________________________________________________________
 
 
}}
 
}}
  
−
<h3 style='display:none'>Notes</h3>
+
<dl class="command_description">
−
<dl class='command_description'>
 
−
<!-- Note Section BEGIN -->
 
−
 
 
−
<!-- Note Section END -->
 
−
</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}}}}]]
 
  
−
<!-- CONTINUE Notes -->
+
<dt></dt>
−
<dl class="command_description">
+
<dd class="notedate">Posted on 2014-12-22 - 17:16 (UTC)</dd>
−
<dd class="notedate">Posted on December 22, 2014 - 17:16 (UTC)</dd>
 
 
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
 
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
 
<dd class="note">
 
<dd class="note">
−
'''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/>
+
'''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.
 
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>
 +
 +
<dt><dt>
 +
<dd class="notedate">Posted on 2019-09-06 - 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 -->
 

Latest revision as of 00:13, 14 May 2023

Arma 3 logo black.png0.56
GAGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=getFuelCargo&oldid=341187"