Difference between revisions of "DCS func getDescByName"

From DCS World Wiki - Hoggitworld.com
m (1 revision imported)
 
Line 5: Line 5:
 
|vNum= 1.2.0
 
|vNum= 1.2.0
  
|par1= [[DCS_Class_Object|Object]]
+
|par1= [[DCS_Class_Unit|Unit]]
  
|par2=  
+
|par2= [[DCS_Class_Static_Object|Static Object]]
  
|par3=  
+
|par3= [[DCS_Class_Weapon|Weapon]]
  
|par4=
+
|par4= [[DCS_Class_Airbase|Airbase]]
  
 
|desc= Return a description table of the specified Object type. Object does not need to be in the mission in order to query its data.
 
|desc= Return a description table of the specified Object type. Object does not need to be in the mission in order to query its data.
  
Function also works with [[DCS_Class_Unit|Unit]], [[DCS_Class_Static_Object|Static Object]], [[DCS_Class_Scenery_Object|Scenery Object]], [[DCS_Class_Airbase|Airbase]]
+
Function works with [[DCS_Class_Unit|Unit]], [[DCS_Class_Static_Object|Static Object]], [[DCS_Class_Scenery_Object|Scenery Object]], [[DCS_Class_Airbase|Airbase]]
  
 
|rtnType= table
 
|rtnType= table
Line 77: Line 77:
  
 
|related=  
 
|related=  
[[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}
+
[[DCS_Class_Unit|'''Unit Functions:''']] {{listOfScriptingUnitFuncs}}
 +
 
 +
[[DCS_Class_Unit|'''StaticObject Functions:''']] {{listofScriptingObjectFuncs}}
 +
 
 +
[[DCS_Class_Unit|'''Weapon Functions:''']] {{listOfScriptingWeaponFuncs}}
 +
 
 +
[[DCS_Class_Unit|'''Airbase Functions:''']] {{listOfScriptingAirbaseFuncs}}
  
 
|examples= local a10CDataTable = Unit.getDescByName('A-10C')
 
|examples= local a10CDataTable = Unit.getDescByName('A-10C')

Revision as of 10:29, 4 September 2021

Scripting Root

Envrioment: Mission Scripting
Function: getDescByName Added with: 1.2.0
Member Of: Unit, Static Object, Weapon, Airbase
Syntax: table Unit.getDescByName(String typeName )
Description: Return a description table of the specified Object type. Object does not need to be in the mission in order to query its data.

Function works with Unit, Static Object, Scenery Object, Airbase


Return Value: table
Return Example: A-10C Descriptor Table
{
  ["speedMax0"] = 236,
  ["massEmpty"] = 11739,
  ["tankerType"] = 0,
  ["range"] = 1500,
  ["box"] = {
   ["min"] = {
    ["y"] = -1.2815840244293,
    ["x"] = -9.1228017807007,
    ["z"] = -9.4672021865845,
   },
   ["max"] =  {
    ["y"] = 2.3696703910828,
    ["x"] = 7.6860585212708,
    ["z"] = 9.4541301727295,
   },
  },
  ["Hmax"] = 10000,
  ["Kmax"] = 0.52999997138977,
  ["category"] = 0,
  ["speedMax10K"] = 134,
  ["NyMin"] = -2,
  ["fuelMassMax"] = 5029,
  ["speedMax"] = 236,
  ["NyMax"] = 5.9000000953674,
  ["massMax"] = 21081,
  ["RCS"] = 10,
  ["displayName"] = "A-10C",
  ["life"] = 32,
  ["VyMax"] = 30,
  ["attributes"] =  {
   ["Air"] = true,
   ["Battle airplanes"] = true,
   ["NonAndLightArmoredUnits"] = true,
   ["Battleplanes"] = true,
   ["Refuelable"] = true,
   ["All"] = true,
   ["Planes"] = true,
   ["NonArmoredUnits"] = true,
  },
  ["typeName"] = "A-10C",
  ["Kab"] = 0,
 }
Examples: local a10CDataTable = Unit.getDescByName('A-10C')
Related Functions: Unit Functions: isActive, getPlayerName, getID, getNumber, getCategoryEx, getObjectID, getController, getGroup, getCallsign, getLife, getLife0, getFuel, getAmmo, getSensors, hasSensors, getRadar, getDrawArgumentValue, getNearestCargos, enableEmission, getDescentCapacity

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

Weapon Functions: getLauncher, getTarget, getCategoryEx

Airbase Functions: getCallsign, getUnit, getID, getCategoryEx, getParking, getRunways, getTechObjectPos, getRadioSilentMode, setRadioSilentMode, autoCapture, autoCaptureIsOn, setCoalition, getWarehouse,

Notes: Airbase.getDescByName was added in v1.2.6