Difference between revisions of "getAmmoCargo"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[Cc]ategory:[ _]?Arma[ _]3:[ _]([^|]*)[ _]?\|.*\]\]" to "{{GameCategory|arma3|$1}}")
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
 
(19 intermediate revisions by 2 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= global|Multiplayer Arguments=
 
  
|gr1= Vehicle Inventory |GROUP1=
+
|arg= global
____________________________________________________________________________________________
 
  
| Returns the amount (1 is full) of ammo resources in the cargo space of a rearm vehicle. <br><br>
+
|gr1= Vehicle Inventory
{{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=
+
|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]] |PARAMETER1=
+
|s1= [[getAmmoCargo]] vehicle
  
| [[Number]] - ammo cargo value, -1 if ammo cargo is not supported, 0 if the vehicle is ![[alive]] or [[isNull]] |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= <code>value = [[getAmmoCargo]] myVehicleName;</code>
  
____________________________________________________________________________________________
+
|seealso= [[setAmmoCargo]], [[getFuelCargo]], [[getRepairCargo]]
 
 
| [[setAmmoCargo]], [[getFuelCargo]], [[getRepairCargo]] |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>
 
{{GameCategory|arma3|New_Scripting_Commands_List}}
 
[[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 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 -->
 

Latest revision as of 16:05, 13 June 2021

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.