getFuelCargo: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3 |= Game name |0.56|= Game version ____________________...") |
Killzone Kid (talk | contribs) No edit summary |
||
(16 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma3 | | | arma3 |Game name= | ||
|0.56|Game version= | |||
|0.56| | |arg= global|Multiplayer Arguments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns the fuel amount in the cargo space of a | | 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 |= | | '''getFuelCargo''' vehicle |SYNTAX= | ||
|p1= vehicle: [[Object]] |= | |p1= vehicle: [[Object]] |PARAMETER1= | ||
| [[Number]] |= | | [[Number]] - fuel cargo value, -1 if fuel cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]] |RETURNVALUE= | ||
|x1= <code></code>|= | |x1= <code>value = [[getFuelCargo]] myVehicleName;</code>|EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
Line 38: | Line 40: | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
<!-- CONTINUE Notes --> | |||
<dl class="command_description"> | |||
<dd class="notedate">Posted on December 22, 2014 - 17:16 (UTC)</dd> | |||
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt> | |||
<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/> | |||
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> | |||
</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> | |||
<!-- DISCONTINUE Notes --> |
Revision as of 08:19, 6 September 2019
Description
- Description:
- Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle.
- 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