getRepairCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (local args, global effect)
m (Text replacement - "AgentRevolution" to "AgentRev")
 
(46 intermediate revisions by 6 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= local|= Arguments in MP
|arg= global
|eff= global|= Effects in MP
____________________________________________________________________________________________


| Returns the amount of repair resources from empty (0) to full (1) in the cargo space of a repair vehicle.  |= Description
|gr1= Vehicle Inventory
____________________________________________________________________________________________


| '''getRepairCargo''' vehicle |= Syntax
|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)}}


|p1= vehicle: [[Object]] |= Parameter 1
|s1= [[getRepairCargo]] vehicle


| [[Number]] |= RETURNVALUE
|p1= vehicle: [[Object]]


|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>|= EXAMPLE1
|x1= <sqf>value = getRepairCargo vehicleName;</sqf>


____________________________________________________________________________________________
|seealso= [[setRepairCargo]] [[getAmmoCargo]] [[getFuelCargo]]
 
| [[setRepairCargo]], [[getAmmoCargo]], [[getFuelCargo]] |= SEEALSO
 
|  |= 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:17 (UTC)</dd>
<dd class="notedate">Posted on December 22, 2014 - 17:17 (UTC)</dd>
<dt class="note">[[User:AgentRev|AgentRev]]</dt>
<dt class="note">[[User:AgentRevolution|AgentRevolution]]</dt>
<dd class="note">
<dd class="note">
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]].
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>
<!-- DISCONTINUE Notes -->
 
{{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 23:07, 4 May 2024

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 2014-12-22 - 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.
DreadedEntity - c
Posted on Apr 24, 2022 - 06:13 (UTC)
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