Difference between revisions of "getRepairCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
+
{{Command
  
| arma3 |Game name=
+
| arma3
|0.56|Game version=
+
|0.56
|arg= global|Multiplayer Arguments=
+
|arg= global
  
|gr1= Vehicle Inventory |GROUP1=
+
|gr1= Vehicle Inventory
  
 
| Returns the amount (1 is full) of repair resources in the cargo space of a repair vehicle. <br><br>
 
| Returns the amount (1 is full) of repair resources in the cargo space of a repair vehicle. <br><br>
{{Informative | Since Arma 3 v1.94.145939 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)}} |DESCRIPTION=
+
{{Informative | Since Arma 3 v1.94.145939 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 |SYNTAX=
+
| '''getRepairCargo''' vehicle
  
|p1= vehicle: [[Object]] |PARAMETER1=
+
|p1= vehicle: [[Object]]
  
| [[Number]] - repair cargo value, -1 if repair cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]] |RETURNVALUE=
+
| [[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>|EXAMPLE1=
+
|x1= <code>value = [[getRepairCargo]] vehicleName;</code>
  
  
| [[setRepairCargo]], [[getAmmoCargo]], [[getFuelCargo]] |SEEALSO=
+
| [[setRepairCargo]], [[getAmmoCargo]], [[getFuelCargo]]
  
 
|  |MPBEHAVIOUR=  
 
|  |MPBEHAVIOUR=  

Revision as of 00:42, 18 January 2021

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.

Template:Informative
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:
setRepairCargogetAmmoCargogetFuelCargo

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:17 (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.