DCS World Wiki - Hoggitworld.com - User contributions [en]

DCS func getClosestPointOnRoads

2023-01-28T10:25:23Z

Loophole 62ndFF:

{{Template:dcs_funcs

|fName= getClosestPointOnRoads

|vNum= 2.5

|par1= [[DCS_singleton_land|land]]

|par2=

|par3=

|par4=

|desc= Returns the X and Y values of a coordinate on the nearest road from the given point.

NOTE that this function does not use vec2 or vec3. It uses individual values representing a vec2 for x and y.

Valid road type values: 'roads' and 'railroads'

|rtnType= number, number

|rtnExample= 233324, 423423

|reqType1= string

|reqName1= roadType

|reqType2= number

|reqName2= xCoord

|reqType3= number

|reqName3= yCoord

|reqType4=

|optType1=

|optName1=

|optType2=

|related=
[[DCS_singleton_land|'''land functions:''']] {{listOflandFuncs}}

|examples= The following returns the closest road to a point.
local testPoint = trigger.misc.getZone('test').point
local x, y = land.getClosestPointOnRoads('roads',testPoint.x, testPoint.z)

|notes=
}}
[[Category:Singleton Functions|getHeight]]
[[Category:Game Patch 2.5.0|getClosestPointOnRoads]]

DCS func getPoint

2023-01-28T09:16:48Z

Loophole 62ndFF:

{{Template:dcs_funcs

|fName= getPoint

|vNum= 1.2.0

|par1= [[DCS_Class_Object|Object]]

|par2= [[DCS_Class_Spot| Spot]]

|par3=

|par4=

|desc= Returns a vec3 table of the x, y, and z coordinates for the position of the given object in 3D space. Coordinates are dependent on the position of the maps origin. In the case of the Caucuses theater, the origin is located in the Crimean region of the map.

Function also works with [[DCS_Class_Unit|Unit]], [[DCS_Class_Weapon|Weapon]], [[DCS_Class_Static_Object|Static Object]], [[DCS_Class_Scenery_Object|Scenery Object]], [[DCS_Class_Airbase|Airbase]]

|rtnType= vec3

|rtnExample=
Vec3 = {
x = Distance North-south,
y = Distance above height 0,
z = Distance East-West
}

|reqType1= Class

|reqName1= Self

|reqType2=

|reqName2=

|optType1=

|optType2=

|related=
[[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}
[[DCS_Class_Spot|'''Spot Functions:''']] {{listofScriptingSpotFuncs}}

|examples= The following prints the target coordinates to the log.
local targetCoord = Unit.getByName('killMeNow'):getPoint()
env.info('The World Coordinates of the target are: X: ' .. targetCoord.x .. ' Y: ' .. targetCoord.y .. ' Z: ' .. targetCoord.z)

|notes= '''Remember''' that the Vec3 x, y and z do ''not'' follow the normal intuitive orientation conventions. 'x' is the north-south axis, 'z' is the east-west axis, and 'y' is the vertical/height axis! Also, Vec3 x & y to ''not'' correlate to Vec2 x & y!
}}
[[Category:Class Functions|getPoint]]
[[Category:Game Patch 1.2.0|getPoint]]

DCS func getPoint

2023-01-28T09:15:47Z

Loophole 62ndFF:

{{Template:dcs_funcs

|fName= getPoint

|vNum= 1.2.0

|par1= [[DCS_Class_Object|Object]]

|par2= [[DCS_Class_Spot| Spot]]

|par3=

|par4=

|desc= Returns a vec3 table of the x, y, and z coordinates for the position of the given object in 3D space. Coordinates are dependent on the position of the maps origin. In the case of the Caucuses theater, the origin is located in the Crimean region of the map.

Function also works with [[DCS_Class_Unit|Unit]], [[DCS_Class_Weapon|Weapon]], [[DCS_Class_Static_Object|Static Object]], [[DCS_Class_Scenery_Object|Scenery Object]], [[DCS_Class_Airbase|Airbase]]

|rtnType= vec3

|rtnExample=
Vec3 = {
x = Distance,
y = Distance,
z = Distance
}

|reqType1= Class

|reqName1= Self

|reqType2=

|reqName2=

|optType1=

|optType2=

|related=
[[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}
[[DCS_Class_Spot|'''Spot Functions:''']] {{listofScriptingSpotFuncs}}

|examples= The following prints the target coordinates to the log.
local targetCoord = Unit.getByName('killMeNow'):getPoint()
env.info('The World Coordinates of the target are: X: ' .. targetCoord.x .. ' Y: ' .. targetCoord.y .. ' Z: ' .. targetCoord.z)

|notes= '''Remember''' that the Vec3 x, y and z do ''not'' follow the normal intuitive orientation conventions. 'x' is the north-south axis, 'z' is the east-west axis, and 'y' is the vertical/height axis! Also, Vec3 x & y to ''not'' correlate to Vec2 x & y!
}}
[[Category:Class Functions|getPoint]]
[[Category:Game Patch 1.2.0|getPoint]]

DCS func getPoint

2023-01-28T09:15:01Z

Loophole 62ndFF:

{{Template:dcs_funcs

|fName= getPoint

|vNum= 1.2.0

|par1= [[DCS_Class_Object|Object]]

|par2= [[DCS_Class_Spot| Spot]]

|par3=

|par4=

|desc= Returns a vec3 table of the x, y, and z coordinates for the position of the given object in 3D space. Coordinates are dependent on the position of the maps origin. In the case of the Caucuses theater, the origin is located in the Crimean region of the map.

Function also works with [[DCS_Class_Unit|Unit]], [[DCS_Class_Weapon|Weapon]], [[DCS_Class_Static_Object|Static Object]], [[DCS_Class_Scenery_Object|Scenery Object]], [[DCS_Class_Airbase|Airbase]]

|rtnType= vec3

|rtnExample=
Vec3 = {
x = Distance,
y = Distance,
z = Distance
}

|reqType1= Class

|reqName1= Self

|reqType2=

|reqName2=

|optType1=

|optType2=

|related=
[[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}
[[DCS_Class_Spot|'''Spot Functions:''']] {{listofScriptingSpotFuncs}}

|examples= The following prints the target coordinates to the log.
local targetCoord = Unit.getByName('killMeNow'):getPoint()
env.info('The World Coordinates of the target are: X: ' .. targetCoord.x .. ' Y: ' .. targetCoord.y .. ' Z: ' .. targetCoord.z)

|notes= '''Remember''' that the Vec3 x, y and z do ''not'' follow the normal intuitive orientation conventions. 'x' is the north-south axis, 'z' is the east-west axis, and 'y' is the vertical/height axis!
}}
[[Category:Class Functions|getPoint]]
[[Category:Game Patch 1.2.0|getPoint]]

DCS func getPosition

2023-01-28T09:09:41Z

Loophole 62ndFF:

{{Template:dcs_funcs

|fName= getPosition

|vNum= 1.2.0

|par1= [[DCS_Class_Object|Object]]

|par2= [[DCS_Class_Spot| Spot]]

|par3=

|par4=

|desc= Returns a Position3 table of the objects current position and orientation in 3D space. X, Y, Z values are unit vectors defining the objects orientation. Coordinates are dependent on the position of the maps origin. In the case of the Caucuses theater, the origin is located in the Crimean region of the map.

Function also works with [[DCS_Class_Unit|Unit]], [[DCS_Class_Weapon|Weapon]], [[DCS_Class_Static_Object|Static Object]], [[DCS_Class_Scenery_Object|Scenery Object]], [[DCS_Class_Airbase|Airbase]]

|rtnType= Position3

|rtnExample= Position 3 is a table consisting of the point and orientation tables.
Position3 = { p = Vec3,
x = Vec3,
y = Vec3,
z = Vec3 }

|reqType1= Class

|reqName1= Self

|reqType2=

|reqName2=

|optType1=

|optType2=

|related=
[[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}

|examples= Assigns a value for the heading and pitch of the unit.

local unit = Unit.getByName('Bob')
local unitpos = unit:getPosition()
local Heading = math.atan2(unitpos.x.z, unitpos.x.x)
local Pitch = math.asin(unitpos.x.y)

|notes=
}}
[[Category:Class Functions|getPosition]]
[[Category:Game Patch 1.2.0|getPosition]]

DCS func log

2023-01-27T05:24:31Z

Loophole 62ndFF: Created page with "net.log("''string''") will write an "INFO" entry to the DCS log file, with the message "LuaNET (Main): ''string''" The full set of arguments supported for net.log() are curre..."

net.log("''string''") will write an "INFO" entry to the DCS log file, with the message "LuaNET (Main): ''string''"

The full set of arguments supported for net.log() are currently undocumented.

DCS func getGroup

2023-01-26T01:45:30Z

Loophole 62ndFF:

{{Template:dcs_funcs

|fName= getGroup

|vNum= 1.2.0

|par1= [[DCS_Class_Unit|Unit]]

|par2=

|par3=

|par4=

|desc= Returns the Group object that the Unit belongs to.

|rtnType= [[DCS_Class_Group|Group]]

|rtnExample=

|reqType1= Class

|reqName1= Self

|reqType2=

|reqName2=

|optType1=

|optType2=

|examples=

|related= [[DCS_Class_Unit|'''Unit Functions:''']] {{listOfScriptingUnitFuncs}}
[[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}

[[DCS_Class_Coalition_Object| '''Coalition Object Functions:''']] {{listofScriptingCoaObjectFuncs}}

|notes= Due to a bug client groups are not accessible at present 1.5.3 and 2.0.2.
'''Warning:''' In version 2.8.2, unit:getGroup() will return nil if the unit is a ground unit that is dead (this includes units referenced in UNIT_LOST and DEAD events). It might return nil for air units as well, depending on timing of the events.
}}
[[Category:Class Functions|getGroup]]
[[Category:Game Patch 1.2.0|getGroup]]

DCS func getGroup

2023-01-26T01:45:00Z

Loophole 62ndFF:

{{Template:dcs_funcs

|fName= getGroup

|vNum= 1.2.0

|par1= [[DCS_Class_Unit|Unit]]

|par2=

|par3=

|par4=

|desc= Returns the Group object that the Unit belongs to.

|rtnType= [[DCS_Class_Group|Group]]

|rtnExample=

|reqType1= Class

|reqName1= Self

|reqType2=

|reqName2=

|optType1=

|optType2=

|examples=

|related= [[DCS_Class_Unit|'''Unit Functions:''']] {{listOfScriptingUnitFuncs}}
[[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}

[[DCS_Class_Coalition_Object| '''Coalition Object Functions:''']] {{listofScriptingCoaObjectFuncs}}

|notes= Due to a bug client groups are not accessible at present 1.5.3 and 2.0.2.
In version 2.8.2, unit:getGroup() will return nil if the unit is a ground unit that is dead (this includes units referenced in UNIT_LOST and DEAD events). It might return nil for air units as well, depending on timing of the events.
}}
[[Category:Class Functions|getGroup]]
[[Category:Game Patch 1.2.0|getGroup]]

MIST groupToPoint

2023-01-22T02:20:24Z

Loophole 62ndFF:

{{Mission Scripting

|fName= mist.groupToPoint

|vNum = Mist 2.0

|desc= This function will set the task of the specified group to go a the point defined by a zones location. 'group' can be either a group name or a group table. The destination point can be either a zoneTable structure or a zoneName. 'form' is the default formation name as defined by the scripting engine. (See mist.ground.buildWP or the Scripting Engine wiki for details). 'Heading' is the final heading the group will be oriented in once it reaches its destination. 'speed' is the speed in kilometers per hour that the group will travel at to reach its destination. 'ignoreRoads' controls whether the group will try to use roads to get to the point.

|rtnType= nothing

|reqType1= table/string

|reqName1= group/groupName

|reqType2= table/string

|reqName2= zoneTable/zoneName

|reqType3=

|optType1= string

|optName1= form

|optType2= number

|optName2= heading

|optType3= number

|optName3= speed

|optType4= boolean

|optName4= ignoreRoads

|varExamples= group = 'myGroup'
or
group = Group.getByName('myGroup')

table = 'myZone'
table = zoneTable

form =
"Off Road" - moving off-road in Column formation
"On Road" - moving on road in Column formation
"Rank" - moving off road in Row formation
"Cone" - moving in Wedge formation
"Vee" - moving in Vee formation
"Diamond" - moving in Diamond formation
"EchelonL" - moving in Echelon Left formation
"EchelonR" - moving in Echelon Right formation

heading = -360 to 360

speed = any positive number. (Group limited by lowest max speed of vehicles in the group)

ignoreRoads = boolean (any value) True if you don't want the group to use roads. Otherwise if the destination is further than 1.3* the radius of the destination zone the group will automatically seek out a road to go to the destination.

|rtnExamples= nothing

|example= <code>
mist.groupToPoint('myGroup', 'myZone', nil, 35, 30)
mist.groupToPoint('myGroup2', 'myZone', 'cone', nil, nil, true)
</code>

|notes=
A zoneTable structure is a Lua table in the form:
<nowiki>{
point = { x, y, z },
radius = </nowiki>''metres''<nowiki>
}</nowiki>

The zoneTable.point is a standard DCS Vec3 structure.

|funcs= {{listOfMistGroupOrders}}

}}
[[Category: MIST|groupToPoint]]

MIST groupToPoint

2023-01-22T02:07:49Z

Loophole 62ndFF:

{{Mission Scripting

|fName= mist.groupToPoint

|vNum = Mist 2.0

|desc= This function will set the task of the specified group to go a the point defined by a zones location. 'group' can be either a group name or a group table. The destination point can be either a zoneTable structure or a zoneName. 'form' is the default formation name as defined by the scripting engine. (See mist.ground.buildWP or the Scripting Engine wiki for details). 'Heading' is the final heading the group will be oriented in once it reaches its destination. 'speed' is the speed in kilometers per hour that the group will travel at to reach its destination. 'ignoreRoads' controls whether the group will try to use roads to get to the point.

|rtnType= nothing

|reqType1= table/string

|reqName1= group/groupName

|reqType2= table/string

|reqName2= zoneTable/zoneName

|reqType3=

|optType1= string

|optName1= form

|optType2= number

|optName2= heading

|optType3= number

|optName3= speed

|optType4= boolean

|optName4= ignoreRoads

|varExamples= group = 'myGroup'
or
group = Group.getByName('myGroup')

table = 'myZone'
table = zoneTable

form =
"Off Road" - moving off-road in Column formation
"On Road" - moving on road in Column formation
"Rank" - moving off road in Row formation
"Cone" - moving in Wedge formation
"Vee" - moving in Vee formation
"Diamond" - moving in Diamond formation
"EchelonL" - moving in Echelon Left formation
"EchelonR" - moving in Echelon Right formation

heading = -360 to 360

speed = any positive number. (Group limited by lowest max speed of vehicles in the group)

ignoreRoads = boolean (any value) True if you don't want the group to use roads. Otherwise if the destination is further than 1.3* the radius of the destination zone the group will automatically seek out a road to go to the destination.

|rtnExamples= nothing

|example= <code>

mist.groupToPoint('myGroup', 'myZone', nil, 35, 30)
mist.groupToPoint('myGroup2', 'myZone', 'cone', nil, nil, true)
</code>

|notes=

|funcs= {{listOfMistGroupOrders}}

}}
[[Category: MIST|groupToPoint]]

MIST groupToPoint

2023-01-22T02:00:30Z

Loophole 62ndFF:

{{Mission Scripting

|fName= mist.groupToPoint

|vNum = Mist 2.0

|desc= This function will set the task of the specified group to go a the point defined by a zones location. group can be either a group name or a group table. point can be a zoneTable or zoneName. form is the default formation name in as defined by the scripting engine. See mist.ground.buildWP or the Scripting Engine wiki for details. Heading is the final heading the group will be oriented in once it reaches its destination. speed is the speed in kilometers per hour that the group will travel at to reach its destination. dontUseRoads defines if the group will use a road to get to the point.

|rtnType= nothing

|reqType1= table/string

|reqName1= group/groupName

|reqType2= table/string

|reqName2= zoneTable/zoneName

|reqType3=

|optType1= string

|optName1= form

|optType2= number

|optName2= heading

|optType3= number

|optName3= speed

|optType4= boolean

|optName4= useRoads

|varExamples= group = 'myGroup'
or
group = Group.getByName('myGroup')

table = 'myZone'
table = zoneTable

form =
"Off Road" - moving off-road in Column formation
"On Road" - moving on road in Column formation
"Rank" - moving off road in Row formation
"Cone" - moving in Wedge formation
"Vee" - moving in Vee formation
"Diamond" - moving in Diamond formation
"EchelonL" - moving in Echelon Left formation
"EchelonR" - moving in Echelon Right formation

heading = -360 to 360

speed = any positive number. (Group limited by lowest max speed of vehicles in the group)

dontUseRoads = boolean (any value) True if you don't want to force the group not use a road. Otherwise if the destination is further than 1.3* the radius of the destination zone the group will automatically seek out a road to go to the destination.

|rtnExamples= nothing

|example= <code>

mist.groupToPoint('myGroup', 'myZone', nil, 35, 30)
mist.groupToPoint('myGroup2', 'myZone', 'cone', nil, nil, true)
</code>

|notes=

|funcs= {{listOfMistGroupOrders}}

}}
[[Category: MIST|groupToPoint]]

DCS func getUnits

2023-01-06T01:51:11Z

Loophole 62ndFF:

{{Template:dcs_funcs

|fName= getUnits

|vNum= 1.2.0

|par1= [[DCS_Class_Group|Group]]

|par2=

|par3=

|par4=

|desc= Returns a table of unit objects indexed in unit order. Useful for getting unit specific data for every unit in the group.

|rtnType= table of [[DCS_Class_Unit|Unit]] objects

|rtnExample=

|reqType1= Class

|reqName1= Self

|reqType2=

|reqName2=

|optType1=

|optType2=

|examples= The following would run a function if any of the aircraft in the groups fuel level is below 10%
for index, data in pairs(Group.getByName('CAP1'):getUnits())
if Unit.getFuel(data) < 0.1 then
abortMission('CAP1')
end
end
|related=
[[DCS_Class_Group|'''Group Functions:''']] {{listOfScriptingGroupFuncs}}
|notes= For train groups, getUnits() will always return just a single unit, regardless of the number of carriages in the train.
}}
[[Category:Class Functions|getUnits]]
[[Category:Game Patch 1.2.0|getUnits]]

DCS Class Airbase

2023-01-04T00:53:52Z

Loophole 62ndFF:

{{Template:DCSscriptingClasses
|cName= Airbase

|vNum= 1.2.4

|xVar= none

|inVar= [[DCS_Class_Object|Object]], [[DCS_Class_Coalition_Object|Coalition Object]]

|desc= Represents airbases: airdromes, helipads and ships with flying decks or landing pads.

|type= Airbase.Category enumerator that stores types of airbases.
Note that Airbase.Category values are not obtained by calling ''airbase'':getCategory() - that calls Object.getCategory(''airbase'') and will always return the value Object.Category.BASE. Instead you need to use ''airbase'':getDesc().category to obtain the Airbase.Category!
Airbase.Category = {
AIRDROME = 0,
HELIPAD = 1,
SHIP = 2,

|structures= Airbase Description Table
Airbase.Desc = extends Desc {
category = Airbase.Category
}
A sample return of getDesc() on an airbase.

{
["life"] = 3600,
["attributes"] = {
["Airfields"] = true,
},
["_origin"] = "",
["category"] = 0,
["typeName"] = "Anapa-Vityazevo",
["displayName"] = "Anapa-Vityazevo",
}

|staticFuncs= [[DCS_func_getByName|Airbase.getByName]]
[[DCS_func_getDescByName|Airbase.getDescByName]]

|memberFuncs= {{listOfScriptingAirbaseFuncs}}

'''Inherited from [[DCS_Class_Object| Object Class:]]''' {{listofScriptingObjectFuncs}}

'''Inherited from [[DCS_Class_Coalition_Object| Coalition Object Class:]]'''
{{listofScriptingCoaObjectFuncs}}

|funcs= [[DCS_func_getAirbases|coalition.getAirbases]]

|events= [[DCS_event_takeoff|takeoff]], [[DCS_event_land|land]], [[DCS_event_base_captured|base_captured]]

'''For ships:''' [[DCS_event_shot|shot]], [[DCS_event_hit|hit]], [[DCS_event_dead|dead]], [[DCS_event_birth|birth]], [[DCS_event_shooting_start|shooting_start]], [[DCS_event_shooting_end|shooting_end]]

|notes=

}}
[[Category:Game Patch 1.2.4|Airbase class]]

DCS Class Weapon

2023-01-04T00:50:57Z

Loophole 62ndFF:

{{Template:DCSscriptingClasses
|cName= Weapon

|vNum= 1.2.4

|xVar=

|inVar= [[DCS_Class_Object|Object]], [[DCS_Class_Coalition_Object|Coalition Object]]
|desc= Represents a weapon object: shell, rocket, missile and bomb

|type= [[DCS_enum_weapon|Weapon.flag]] is a complex enumerator used to describe the type of weapon. Information can be found on the linked page because it is a headache to summarize quickly.
 Note that Weapon.Category values are not obtained by calling ''weapon'':getCategory() - that calls Object.getCategory(''weapon'') and will always return the value Object.Category.WEAPON. Instead you need to use ''weapon'':getDesc().category to find the Weapon.Category!
{{DCS_enum_weapon_category}}

{{DCS_enum_weapon_guidanceType}}

{{DCS_enum_weapon_missileCategory}}

{{DCS_enum_weapon_wareheadType}}

|}

|structures=

Common Weapon description table shared by all weapons:

Weapon.Desc = extends Object.Desc {
category = enum Weapon.Category,
warhead = {
type = enum Weapon.WarheadType,
mass = Mass,
caliber = Distance,
explosiveMass = Mass or nil, --for HE and AP(+HE) warheads only
shapedExplosiveMass = Mass or nil, --for shaped explosive warheads only
shapedExplosiveArmorThickness = Distance or nil ----for shaped explosive warheads only
}
}

Missile Description

Weapon.DescMissile = extends Weapon.Desc {
guidance = enum Weapon.GuidanceType,
rangeMin = Distance,
rangeMaxAltMin = Distance,
rangeMaxAltMax = Distance,
altMin = Distance,
altMax = Distance,
Nmax = number,
fuseDist = Distance
}

Rocket Description

Weapon.DescRocket = extends Weapon.Desc {
distMin = Distance,
distMax = Distance
}

Bomb Description
Weapon.DescBomb = extends Weapon.Desc {
guidance = enum Weapon.GuidanceType,
altMin = Distance,
altMax = Distance,

|staticFuncs=

|memberFuncs= {{listOfScriptingWeaponFuncs}}

'''Inherited from [[DCS_Class_Object| Object Class:]]''' {{listofScriptingObjectFuncs}}

'''Inherited from [[DCS_Class_Coalition_Object| Coalition Object Class:]]'''
{{listofScriptingCoaObjectFuncs}}

|funcs=

|events= [[DCS_event_shot|shot]], [[DCS_event_hit|hit]], [[DCS_event_shooting_start|shooting_start]], [[DCS_event_shooting_end|shooting_end]]

|notes= Weapon objects can be gathered through the use of event handlers.

}}
[[Category:Game Patch 1.2.4|Weapon Class]]

DCS enum weapon

2023-01-04T00:46:50Z

Loophole 62ndFF:

{{Template:DCSenumertorTables

|name= Weapon

|vNum= 1.2.0

|desc= The Weapon enumerator contains tables used to identify the capabilities and types of a particular weapon. Additionally the Weapon.flag table is large table that defines every category of weapon.

[[DCS_enum_weapon_flag|Weapon.flag]] information is available in its own article.

|uses= The Weapon.flag enumerators are commonly used to define the weapons the AI are allowed to use for a given task. Alternatively information like category or guidance type can be used as generalized criteria for assorted scripts. For example instead of making a table of every single laser guided missile you can simply check its guidance type.

|format= Tables are formatted as.
<code>
Weapon.Category = {
SHELL,
MISSILE,
ROCKET,
BOMB,
TORPEDO
}
</code>
Guidance type is available for all missiles and some bombs
<code>
Weapon.GuidanceType = {
INS,
IR,
RADAR_ACTIVE,
RADAR_SEMI_ACTIVE,
RADAR_PASSIVE,
TV,
LASER,
TELE
}
</code>

<code>
Weapon.MissileCategory = {
AAM,
SAM,
BM,
ANTI_SHIP,
CRUISE,
OTHER
}

<code>
Weapon.WarheadType = {
AP,
HE,
SHAPED_EXPLOSIVE
}
</code>

|constants=
Weapon.Category
0 = SHELL
1 = MISSILE
2 = ROCKET
3 = BOMB
''tbd'' = TORPEDO
Guidance Types
1 = INS
2 = IR
3 = RADAR_ACTIVE
4 = RADAR_SEMI_ACTIVE
5 = RADAR_PASSIVE
6 = TV
7 = LASER
8 = TELE
Missile Types
1 = AAM
2 = SAM
3 = BM
4 = ANTI_SHIP
5 = CRUISE
6 = OTHER
Warhead Types
0 = AP
1 = HE
2 = SHAPED_CHARGE

|notes=
}}

DCS Class Static Object

2023-01-04T00:40:15Z

Loophole 62ndFF:

{{Template:DCSscriptingClasses
|cName= StaticObject

|vNum= 1.2.0

|xVar= none

|inVar= [[DCS_Class_Object| Object]], [[DCS_Class_Coalition_Object| Coalition Object]]

|desc= Represents static objects added in the Mission Editor or via scripting commands.

|type= StaticObject.Category enum that stores StaticObject categories. Note that StaticObject.Category values are not obtained by calling ''static'':getCategory() - that calls Object.getCategory(''static'') and will always return the value Object.Category.STATIC. Instead you need to use ''static'':getDesc().category to find the StaticObject.Category!

StaticObject.Category = {
"VOID": 0,
"UNIT": 1,
"WEAPON": 2,
"STATIC": 3,
"BASE": 4,
"SCENERY": 5,
"CARGO": 6
}

|structures=

|staticFuncs= [[DCS_func_getByName|StaticObject.getByName]]

[[DCS_func_getDescByName|StaticObject.getDescByName]]

|memberFuncs= {{listofScriptingStaticFuncs}}

'''Inherited from [[DCS_Class_Object| Object Class:]]''' {{listofScriptingObjectFuncs}}

'''Inherited from [[DCS_Class_Coalition_Object| Coalition Object Class:]]''' {{listofScriptingCoaObjectFuncs}}

|funcs=

|events=

|notes= Cargo objects are still static objects and retain access to the whole static object class functions. The function [[DCS_func_getCategory|Object.getCategory()]] will return a value of 6 for cargo objects instead of 3 as it would for any other type of static object.

}}

DCS Class Unit

2023-01-04T00:36:30Z

Loophole 62ndFF:

{{Template:DCSscriptingClasses
|cName= Unit

|vNum= 1.2.0

|xVar=

|inVar= [[DCS_Class_Object|Object]], [[DCS_Class_Coalition_Object|Coalition Object]]

|desc= Represents units: airplanes, helicopters, vehicles, ships and armed ground structures.

|type= enumerator for Unit categories. Note that Unit.Category values are not obtained by calling ''unit'':getCategory() - that calls Object.getCategory(''unit'') and will always return the value Object.Category.UNIT. Instead you need to use ''unit'':getDesc().category to find the Unit.Category!
Unit.Category = {
AIRPLANE = 0,
HELICOPTER = 1,
GROUND_UNIT = 2,
SHIP = 3,
STRUCTURE = 4
}

Refueling system
Unit.RefuelingSystem = {
BOOM_AND_RECEPTACLE = 0,
PROBE_AND_DROGUE = 1
}

Sensor Types

Unit.SensorType = {
OPTIC = 0,
RADAR = 1,
IRST = 2,
RWR = 3
}
Optic Types

Unit.OpticType = {
TV = 0, --TV-sensor
LLTV = 1, --Low-level TV-sensor
IR = 2 --Infra-Red optic sensor
}

Radar Types

Unit.RadarType = {
AS = 0, --air search radar
SS = 1 --surface/land search radar
}
|structures=

|staticFuncs= [[DCS_func_getByName|Unit.getByName]]

[[DCS_func_getDescByName|Unit.getDescByName]]

|memberFuncs= {{listOfScriptingUnitFuncs}}

'''Inherited from [[DCS_Class_Object| Object Class:]]''' {{listofScriptingObjectFuncs}}

'''Inherited from [[DCS_Class_Coalition_Object| Coalition Object Class:]]'''
{{listofScriptingCoaObjectFuncs}}

|funcs= Group Class Functions: [[DCS_func_getUnits|getUnits]], [[DCS_func_getUnit|getUnit]]

|events= [[DCS_event_shot|shot]], [[DCS_event_hit|hit]], [[DCS_event_takeoff|takeoff]], [[DCS_event_land|land]], [[DCS_event_crash|crash]], [[DCS_event_ejection|ejection]], [[DCS_event_refueling|refueling]], [[DCS_event_dead|dead]], [[DCS_event_pilot_dead|pilot_dead]], [[DCS_event_base_captured|base_captured]], [[DCS_event_refueling_stop|refueling_stop]], [[DCS_event_birth|birth]], [[DCS_event_human_failure|human_failure]], [[DCS_event_engine_startup|engine_startup]], [[DCS_event_engine_shutdown|engine_shutdown]], [[DCS_event_player_enter_unit|player_enter_unit]], [[DCS_event_player_leave_unit|player_leave_unit]], [[DCS_event_shooting_start|shooting_start]], [[DCS_event_shooting_end|shooting_end]]

|notes=

}}
[[Category:Game Patch 1.2.0|Unit Class]]