Difference between revisions of "DCS func getDescentCapacity"

From DCS World Wiki - Hoggitworld.com
(Created page with "{{Template:dcs_funcs |fName= getDescentCapacity |vNum= 2.5.6 |par1= Unit |par2= |par3= |par4= |desc= Returns the number of infantry that can be emb...")
(No difference)

Revision as of 10:26, 19 August 2021

Scripting Root

Envrioment: Mission Scripting
Function: getDescentCapacity Added with: 2.5.6
Member Of: Unit
Syntax: number Unit.getDescentCapacity(Class Self )
Description: Returns the number of infantry that can be embark onto the aircraft. Only returns a value if run on airplanes or helicopters.


Returns nil if run on ground or ship units.


Return Value: number
Return Example: 14
Examples: Returns the capacity of a unit named "Huey"
   local hueyCap = Unit.getByName('Huey'):getDescentCapacity()
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: As of DCS 1.5 this function works on both ground units and aircraft.