DCS func getAmmo: Difference between revisions

From DCS World Wiki - Hoggitworld.com
m 1 revision imported
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
|fName= getAmmo
|fName= getAmmo


|vNum= 1.2.0
|vNum= 1.2.4


|par1= [[DCS_Class_Unit|Unit]]
|par1= [[DCS_Class_Unit|Unit]]
Line 14: Line 14:


|desc= Returns an ammo table for all types of loaded ammunition on a given object. Ammo table is indexed by ammo type and contains a weapon description table and a count variable defining "how much" is on board.  
|desc= Returns an ammo table for all types of loaded ammunition on a given object. Ammo table is indexed by ammo type and contains a weapon description table and a count variable defining "how much" is on board.  
Note that for aircraft this function only returns ammo. It does not return non-ammo items like targeting pods, external fuel tanks, or any other non ammo item that can be mounted via the re-arm menu.


|rtnType= table
|rtnType= table
Line 88: Line 90:
}}
}}
[[Category:Class Functions|getAmmo]]
[[Category:Class Functions|getAmmo]]
[[Category:Game Patch 1.2.4|getAmmo]]

Latest revision as of 01:11, 8 February 2025

Scripting Root

Envrioment: Mission Scripting
Function: getAmmo Added with: 1.2.4
Member Of: Unit
Syntax: table Unit.getAmmo(Class Self )
Description: Returns an ammo table for all types of loaded ammunition on a given object. Ammo table is indexed by ammo type and contains a weapon description table and a count variable defining "how much" is on board.

Note that for aircraft this function only returns ammo. It does not return non-ammo items like targeting pods, external fuel tanks, or any other non ammo item that can be mounted via the re-arm menu.


Return Value: table
Return Example: A SA-15 Tor returned this table 
 {
   [1] = 
   {
       ["count"] = 8,
       ["desc"] = 
       {
           ["missileCategory"] = 2,
           ["rangeMaxAltMax"] = 12000,
           ["rangeMin"] = 1500,
           ["displayName"] = "9M330",
           ["rangeMaxAltMin"] = 8000,
           ["altMax"] = 6000,
           ["RCS"] = 0.03070000000298,
           ["box"] = 
           {
               ["min"] = 
               {
                   ["y"] = -0.26701140403748,
                   ["x"] = -1.678077340126,
                   ["z"] = -0.26600670814514,
               }, -- end of ["min"]
               ["max"] = 
               {
                   ["y"] = 0.26701140403748,
                   ["x"] = 1.8263295888901,
                   ["z"] = 0.26600670814514,
               }, -- end of ["max"]
           }, -- end of ["box"]
           ["altMin"] = 10,
           ["life"] = 2,
           ["fuseDist"] = 7,
           ["category"] = 1,
           ["guidance"] = 4,
           ["warhead"] = 
           {
               ["explosiveMass"] = 14.5,
               ["type"] = 1,
               ["caliber"] = 220,
               ["mass"] = 14.5,
           }, -- end of ["warhead"]
           ["typeName"] = "9M330",
           ["Nmax"] = 30,
       }, -- end of ["desc"]
   }, -- end of [1]
 } -- end of Tor Ammo
Examples:
Related Functions: Unit Functions: isActive, getPlayerName, getID, getNumber, getCategoryEx, getObjectID, getController, getGroup, getCallsign, getLife, getLife0, getFuel, getAmmo, getSensors, hasSensors, getRadar, getDrawArgumentValue, getNearestCargos, enableEmission, getDescentCapacity

Object Functions: isExist, destroy, getCategory, getTypeName, getDesc, hasAttribute, getName, getPoint, getPosition, getVelocity, inAir

Coalition Object Functions: getCoalition, getCountry

Notes:
Retrieved from "https://wiki-new.hoggitworld.com/index.php?title=DCS_func_getAmmo&oldid=14774"
Powered by MediaWiki