getFuelCargo: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) m (Text replacement - " |r1=[[" to " |r1= [[") |
||
| (40 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma3 |= | |game1= arma3 | ||
|version1= 0.56 | |||
| | |arg= global | ||
| | |gr1= Vehicle Inventory | ||
| | |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)}} | |||
| | |s1= [[getFuelCargo]] vehicle | ||
| [[ | |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>value = getFuelCargo myVehicleName;</code> | |x1= <code>value = [[getFuelCargo]] myVehicleName;</code> | ||
|seealso= [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]] | |||
| [[setFuelCargo]], [[getAmmoCargo]], [[getRepairCargo]] | |||
}} | }} | ||
<dl class="command_description"> | |||
<dl class= | |||
< | <dt></dt> | ||
</ | |||
<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| | <dt class="note">[[User:AgentRevolution|AgentRev]]</dt> | ||
<dd class="note"> | <dd class="note"> | ||
If the vehicle is unable to carry that type of cargo, | '''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> | </dd> | ||
<dt><dt> | |||
<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> | ||
Revision as of 00:47, 8 August 2021
Description
- Description:
- Returns the fuel amount (1 is full) in the cargo space of a refueling vehicle.
- 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
- Posted on December 22, 2014 - 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 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