DCS func getUnitProperty

From DCS World Wiki - Hoggitworld.com
Revision as of 22:49, 22 April 2018 by Grimes (talk | contribs) (Created page with "{{Template:DCS_server_funcs |fName= getUnitProperty |vNum= 2.5.0 |par1= DCS |par2= |par3= |par4= |desc= Returns the given property for the p...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Environment: Server
Function: getUnitProperty Added with: 2.5.0
Member Of: DCS
Syntax: string DCS.getUnitProperty(number unitId, string propertyId )
Description: Returns the given property for the passed unit.


Return Value: string
Return Example:
Examples:
Related Functions: Control API: setPause, getPause, stopMission, exitProcess, isMultiplayer, isServer, getModelTime, getRealTime, getMissionOptions, getAvailableCoalitions, getAvailableSlots, getCurrentMission, getMissionName, getMissionFilename, getMissionResult, getUnitProperty, getUnitType, getUnitTypeAttribute, writeDebriefing, setUserCallbacks, reloadUserScripts, makeScreenShot
Notes: List of properties.
  DCS.UNIT_RUNTIME_ID, // unique within runtime mission. int
  DCS.UNIT_MISSION_ID, // unique within mission file. int>0
  DCS.UNIT_NAME, // unit name, as assigned by mission designer.
  DCS.UNIT_TYPE, // unit type (Ural, ZU-23, etc)
  DCS.UNIT_CATEGORY,
  DCS.UNIT_GROUP_MISSION_ID, // group ID, unique within mission file. int>0
  DCS.UNIT_GROUPNAME, // group name, as assigned by mission designer.
  DCS.UNIT_GROUPCATEGORY,
  DCS.UNIT_CALLSIGN,
  DCS.UNIT_HIDDEN,// ME hiding
  DCS.UNIT_COALITION,// "blue", "red" or "unknown"
  DCS.UNIT_COUNTRY_ID,
  DCS.UNIT_TASK, //"unit.group.task"
  DCS.UNIT_PLAYER_NAME, // valid for network "humanable" units
  DCS.UNIT_ROLE,//"artillery_commander", "instructor", etc
  DCS.UNIT_INVISIBLE_MAP_ICON,//ME invisible map icon