Difference between revisions of "getRepairCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class="command_description"> <dt></dt>" to "<dl class="command_description"> <dt></dt>")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{RV|type=command
 
{{RV|type=command
  
| arma3
+
|game1= arma3
|0.56
+
|version1= 0.56
 
|arg= global
 
|arg= global
  
 
|gr1= Vehicle Inventory
 
|gr1= Vehicle Inventory
  
| Returns the amount (1 is full) of repair resources in the cargo space of a repair vehicle. {{Feature | Informative | Since Arma 3 v1.96 the return value for vehicles that are not configured to have ability to repair other vehicles is -1. (Prior to that the value was negative infinity)}}
+
|descr= Returns the amount (1 is full) of repair resources in the cargo space of a repair vehicle. {{Feature | Informative | Since Arma 3 v1.96 the return value for vehicles that are not configured to have ability to repair other vehicles is -1. (Prior to that the value was negative infinity)}}
  
| '''getRepairCargo''' vehicle
+
|s1= [[getRepairCargo]] vehicle
  
 
|p1= vehicle: [[Object]]
 
|p1= vehicle: [[Object]]
  
|r1=[[Number]] - repair cargo value, -1 if repair cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]
+
|r1= [[Number]] - repair cargo value, -1 if repair cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]
  
|x1= <code>value = [[getRepairCargo]] vehicleName;</code>
+
|x1= <sqf>value = getRepairCargo vehicleName;</sqf>
  
|seealso= [[setRepairCargo]], [[getAmmoCargo]], [[getFuelCargo]]
+
|seealso= [[setRepairCargo]] [[getAmmoCargo]] [[getFuelCargo]]
 
}}
 
}}
  
Line 29: Line 29:
 
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>
 +
 
</dl>
 
</dl>
 +
 +
{{Note
 +
|user= DreadedEntity
 +
|timestamp= 20220424061318
 +
|text= The repair cargo does actually reduce when a repair truck repairs something, however, the default cargo amount of 1 is so high it is functionally infinite. It's inconceivable that you would drain the pool. You would need to [[setVehicleCargo|set the cargo]] to 10^-5 or 10^-6 (0.000001 or 0.0000001) before it is low enough to "realistically" run out given how physically large the storage pods on the trucks are
 +
}}

Latest revision as of 11:23, 13 May 2022

Hover & click on the images for description

Description

Description:
Returns the amount (1 is full) of repair resources in the cargo space of a repair vehicle.
Since Arma 3 v1.96 the return value for vehicles that are not configured to have ability to repair other vehicles is -1. (Prior to that the value was negative infinity)
Groups:
Vehicle Inventory

Syntax

Syntax:
getRepairCargo vehicle
Parameters:
vehicle: Object
Return Value:
Number - repair cargo value, -1 if repair cargo is not supported, 0 if the vehicle is !alive or isNull

Examples

Example 1:
value = getRepairCargo vehicleName;

Additional Information

See also:
setRepairCargo getAmmoCargo getFuelCargo

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:17 (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 Apr 24, 2022 - 06:13 (UTC)
DreadedEntity
The repair cargo does actually reduce when a repair truck repairs something, however, the default cargo amount of 1 is so high it is functionally infinite. It's inconceivable that you would drain the pool. You would need to set the cargo to 10^-5 or 10^-6 (0.000001 or 0.0000001) before it is low enough to "realistically" run out given how physically large the storage pods on the trucks are