getAmmoCargo: Difference between revisions

Latest revision as of 02:20, 18 February 2025

0.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.
Groups:: Vehicle Inventory

Syntax

Syntax:: getAmmoCargo vehicle
Parameters:: vehicle: Object
Return Value:: Number - ammo cargo value between 0 (empty, destroyed or null Object) and 1 (full), -1 if ammo cargo is not supported
before 1.96 -inf was be returned if vehicle did not support ammo cargo
before 1.94 Nothing was be returned if vehicle was not alive

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
-|0.56|= Game version
+|version1= 0.56
-|arg= global|= Arguments in MP
-____________________________________________________________________________________________
-| Returns the amount (1 is full) of ammo resources in the cargo space of a refuel vehicle. <br><br>
+|arg= global
-{{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)}} |DESCRIPTION=
-____________________________________________________________________________________________
-| '''getAmmoCargo''' vehicle  |SYNTAX=
+|gr1= Vehicle Inventory
-|p1= vehicle: [[Object]] |PARAMETER1=
+|descr= Returns the amount (1 is full) of ammo resources in the cargo space of a rearm vehicle.
-| [[Number]] - ammo cargo value, -1 if ammo cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]] |RETURNVALUE=
+|s1= [[getAmmoCargo]] vehicle
+|p1= vehicle: [[Object]]
-|x1= <code>value = [[getAmmoCargo]] myVehicleName;</code>|EXAMPLE1=
+|r1= [[Number]] - ammo cargo value between 0 (empty, [[alive|destroyed]] or [[isNull|null]] [[Object]]) and 1 (full), -1 if ammo cargo is not supported<br>
+before {{GVI|arma3|1.96|size= 0.75}} -[[finite|inf]] was be returned if ''vehicle'' did not support ammo cargo<br>
+before {{GVI|arma3|1.94|size= 0.75}} [[Nothing]] was be returned if ''vehicle'' was not [[alive]]
-____________________________________________________________________________________________
+|x1= <sqf>value = getAmmoCargo myVehicleName;</sqf>
-| [[setAmmoCargo]], [[getFuelCargo]], [[getRepairCargo]] |SEEALSO=
+|seealso= [[setAmmoCargo]] [[getFuelCargo]] [[getRepairCargo]]
-|  |MPBEHAVIOUR=
-____________________________________________________________________________________________
 }}
-<h3 style='display:none'>Notes</h3>
-<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 -->
-<dl class="command_description">
-<dd class="notedate">Posted on December 22, 2014 - 17:16 (UTC)</dd>
-<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
-<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/>
-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>
-</dl>
-<!-- DISCONTINUE Notes -->