getAmmoCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\| * )+\}\}" to "}}")
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command
 
|game1= arma3
|version1= 0.56


| arma3
|0.56
|arg= global
|arg= global


|gr1= Vehicle Inventory
|gr1= Vehicle Inventory


| Returns the amount (1 is full) of ammo resources in the cargo space of a rearm vehicle. <br><br>
|descr= Returns the amount (1 is full) of ammo resources in the cargo space of a rearm vehicle.
{{Informative | Since Arma 3 v1.94.145939 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)}}
{{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)}}


| '''getAmmoCargo''' vehicle
|s1= [[getAmmoCargo]] vehicle


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


| [[Number]] - ammo cargo value, -1 if ammo cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]]
|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>
|x1= <code>value = [[getAmmoCargo]] myVehicleName;</code>


 
|seealso= [[setAmmoCargo]], [[getFuelCargo]], [[getRepairCargo]]
| [[setAmmoCargo]], [[getFuelCargo]], [[getRepairCargo]]
 
}}
}}


<dl class="command_description">


{{GameCategory|arma3|New Scripting Commands}}
<dt></dt>
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<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|AgentRev]]</dt>
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
<dd class="note">
<dd class="note">
'''Prior to Arma 3 v1.93.145625''' If the vehicle is not [[alive]], it always returns [[Nothing]], which you should check for using [[isNil]].<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 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>
<!-- DISCONTINUE Notes -->

Revision as of 17:05, 13 June 2021

Arma 3 logo black.png0.56
GAGlobal
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:
setAmmoCargogetFuelCargogetRepairCargo

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.
Retrieved from "https://community.bistudio.com/wiki?title=getAmmoCargo&oldid=275862"