Difference between revisions of "DCS func getUnit"

Latest revision as of 17:40, 16 August 2023

Envrioment:	Mission Scripting

Function:	getUnit	Added with: 1.2.0

Member Of:	Group, Airbase
Syntax:	Unit Group.getUnit(Class self , number UnitIndex )
Description:	Returns the unit object of the specified unitIndex within the group. If the index is not valid, this function will return nil. If called from Airbase class it will return the unit or static object associated with the airbase.

Return Value:	Unit
Return Example:	any positive number

Examples:	Returns the first unit in a group local unit1 = Group.getByName('tanks'):getUnit(1)
Related Functions:	Group Functions: isExist, activate, destroy, getCategory, getCoalition, getName, getID, getUnit, getUnits, getSize, getInitialSize, getController, enableEmission AirbaseFunctions: getCallsign, getUnit, getID, getCategoryEx, getParking, getRunways, getTechObjectPos, getDispatcherTowerPos, getRadioSilentMode, setRadioSilentMode, autoCapture, autoCaptureIsOn, setCoalition, getWarehouse,
Notes:

@@ Line 7: / Line 7: @@
 |par1= [[DCS_Class_Group|Group]]
-|par2=
+|par2= [[DCS_Class_Airbase|Airbase]]
 |par3=
@@ Line 14: / Line 14: @@
 |desc= Returns the unit object of the specified unitIndex within the group. If the index is not valid, this function will return nil.
+If called from Airbase class it will return the unit or static object associated with the airbase.
 |rtnType= [[DCS_Class_Unit|Unit]]
@@ Line 19: / Line 21: @@
 |rtnExample= any positive number
-|reqType1= number
+|reqType1= Class
-|reqName1= unitIndex
+|reqName1= self
-|reqType2=
+|reqType2= number
-|reqName2=
+|reqName2= UnitIndex
+|reqType3=
 |optType1=
@@ Line 36: / Line 40: @@
 |related=
 [[DCS_Class_Group|'''Group Functions:''']] {{listOfScriptingGroupFuncs}}
+[[DCS_Class_Airbase|'''AirbaseFunctions:''']] {{listOfScriptingAirbaseFuncs}}
 |notes=
 }}
 [[Category:Class Functions|getUnit]]
+[[Category:Game Patch 1.2.0|getUnit]]