getAmmoCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "AgentRevolution" to "AgentRev")
 
(50 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.56


|0.56|= Game version
|arg= global
____________________________________________________________________________________________


| Returns the amount of ammo resources in the cargo space of a repair vehicle.  |= Description
|gr1= Vehicle Inventory
____________________________________________________________________________________________


| '''getAmmoCargo''' vehicle |= Syntax
|descr= Returns the amount (1 is full) of ammo resources in the cargo space of a rearm vehicle.
{{Feature|informative|Since Arma 3 v1.96 the return value for vehicles that are not configured to have ability to rearm other vehicles is -1. (Prior to that the value was negative infinity)}}


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


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


|r1= [[Number]] - ammo cargo value, -1 if ammo cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]


|x1= <code>value = getAmmoCargo myVehicleName;</code>|= EXAMPLE1
|x1= <sqf>value = getAmmoCargo myVehicleName;</sqf>


____________________________________________________________________________________________
|seealso= [[setAmmoCargo]] [[getFuelCargo]] [[getRepairCargo]]
 
| [[setAmmoCargo]] |= 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:16 (UTC)</dd>
<dd class="notedate">Posted on December 22, 2014 - 17:16 (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 unable to carry that type of cargo, the returned value is [[Number#Number_Type|negative infinity]] (-1.#INF), which evaluates as neither greater than, less than, nor equal to 0.<br/>
'''Prior to {{arma3}} v1.94''' If the vehicle is not [[alive]], it always returns [[Nothing]], which you should check for using [[isNil]].<br>
If the vehicle is not [[alive]], the returned value is always [[nil]].
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 -->

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 ammo resources in the cargo space of a rearm vehicle.
Since Arma 3 v1.96 the return value for vehicles that are not configured to have ability to rearm other vehicles is -1. (Prior to that the value was negative infinity)
Groups:
Vehicle Inventory

Syntax

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

Examples

Example 1:
value = getAmmoCargo myVehicleName;

Additional Information

See also:
setAmmoCargo getFuelCargo getRepairCargo

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