DCS enum AI

From DCS World Wiki - Hoggitworld.com
Revision as of 00:12, 12 April 2018 by Grimes (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Scripting Root

Enumerator: AI Added with: 1.2.0
Description: The AI table contains a list of constants for Options, Tasks, and Skills.
Uses: These values are used along a wide range of applications.
Format: The Task table is not indexed numerically and has no numerical values. Each key and value are the same with the only difference being capitalization.
AI.Task = {
 OrbitPattern = {},
 Designation = {},
 TurnMethod = {},
 VehicleFormation = {},
 AltitudeType = {},
 WaypointType = {},
 WeaponExpend = {}
}

The Skill table is also indexed by strings and key values.

AI.Skill = {
 PLAYER,
 CLIENT,
 AVERAGE,
 GOOD,
 HIGH,
 EXCELLENT
}

The Option table is quite different than the above two.

AI.Option = {
 Air = {
  id = {},
  val = {},
 },
 Ground = {
  id = {},
  val = {},
 },
 Naval = {
  id = {},
  val = {},
 }  
}
constants: AI.Task.OrbitPattern
"RACE_TRACK" = "Race-Track"
"CIRCLE"     = "Circle"

AI.Task.Designation

"NO"          = "No"
"WP"          = "WP"
"IR_POINTER"  = "IR-Pointer"
"LASER"       = "Laser"
"AUTO"        = "Auto"

AI.Task.TurnMethod

"FLY_OVER_POINT" = "Fly Over Point"
"FIN_POINT"      = "Fin Point"

AI.Task.VehicleFormation

"VEE"           = "Vee"
"ECHELON_RIGHT" = "EchelonR"
"OFF_ROAD"      = "Off Road"
"RANK"          = "Rank"
"ECHELON_LEFT"  = "EchelonL"
"ON_ROAD"       = "On Road"
"CONE"          = "Cone"
"DIAMOND"       = "Diamond"

AI.Task.AltitudeType,

"RADIO" = "RADIO"
"BARO"  = "BARO"

AI.Task.WaypointType

"TAKEOFF"             = "TakeOff"
"TAKEOFF_PARKING"     = "TakeOffParking"
"TURNING_POINT"       = "Turning Point"
"TAKEOFF_PARKING_HOT" = "TakeOffParkingHot"
"LAND"                = "Land"

AI.Task.WeaponExpend

"QUARTER" = "Quarter"
"TWO"     = "Two"
"ONE"     = "One"
"FOUR"    = "Four"
"HALF"    = "Half"
"ALL"     = "All"

Air Options:

AI.Option.Air.id

ROE                        = 0
REACTION_ON_THREAT         = 1
RADAR_USING                = 3
FLARE_USING                = 4
Formation                  = 5
RTB_ON_BINGO               = 6
SILENCE                    = 7
RTB_ON_OUT_OF_AMMO         = 10
ECM_USING                  = 13
PROHIBIT_AA                = 14
PROHIBIT_JETT              = 15
PROHIBIT_AB                = 16
PROHIBIT_AG                = 17
MISSILE_ATTACK             = 18
PROHIBIT_WP_PASS_REPORT    = 19
OPTION_RADIO_USAGE_CONTACT = 21
OPTION_RADIO_USAGE_ENGAGE  = 22
OPTION_RADIO_USAGE_KILL    = 23
JETT_TANKS_IF_EMPTY        = 25
FORCED_ATTACK              = 26
PREFER_VERTICAL            = 32

AI.Option.Air.val.ROE

WEAPON_FREE            = 0
OPEN_FIRE_WEAPON_FREE  = 1
OPEN_FIRE              = 2
RETURN_FIRE            = 3
WEAPON_HOLD            = 4

AI.Option.Air.val.REACTION_ON_THREAT

NO_REACTION          = 0
PASSIVE_DEFENCE      = 1
EVADE_FIRE           = 2
BYPASS_AND_ESCAPE    = 3
ALLOW_ABORT_MISSION  = 4
AAA_EVADE_FIRE       = 5 -- Note: Does not actually exist in the enum table

AI.Option.Air.val.RADAR_USING

NEVER                   = 0
FOR_ATTACK_ONLY         = 1
FOR_SEARCH_IF_REQUIRED  = 2
FOR_CONTINUOUS_SEARCH   = 3

AI.Option.Air.val.FLARE_USING

NEVER                     = 0
AGAINST_FIRED_MISSILE     = 1
WHEN_FLYING_IN_SAM_WEZ    = 2
WHEN_FLYING_NEAR_ENEMIES  = 3

AI.Option.Air.val.ECM_USING

NEVER_USE                       = 0
USE_IF_ONLY_LOCK_BY_RADAR       = 1
USE_IF_DETECTED_LOCK_BY_RADAR   = 2
ALWAYS_USE                      = 3

AI.Option.Air.val.MISSILE_ATTACK

MAX_RANGE          = 0
NEZ_RANGE          = 1
HALF_WAY_RMAX_NEZ  = 2
TARGET_THREAT_EST  = 3
RANDOM_RANGE       = 4


Ground Options:

AI.Option.Ground.id

ROE                             = 0
FORMATION                       = 5
DISPERSE_ON_ATTACK              = 8
ALARM_STATE                     = 9
ENGAGE_AIR_WEAPONS              = 20
AC_ENGAGEMENT_RANGE_RESTRICTION = 24
Restrict AAA min                = 27  -- Actual value is not in this table, but this number id represents the option. 
Restrict Targets                = 28  -- Actual value is not in this table, but this number id represents the option. 
Restrict AAA max                = 29  -- Actual value is not in this table, but this number id represents the option. 
Formation Interval              = 30  -- Actual value is not in this table, but this number id represents the option. 
Evasion of ARM                  = 31

AI.Option.Ground.val.ALARM_STATE

AUTO   = 0
GREEN  = 1
RED    = 2

AI.Option.Ground.Val.ROE

OPEN_FIRE              = 2
RETURN_FIRE            = 3
WEAPON_HOLD            = 4

Naval Options:

AI.Option.Naval.id

ROE                = 0

AI.Option.Naval.Val.ROE

OPEN_FIRE              = 2
RETURN_FIRE            = 3
WEAPON_HOLD            = 4
notes: DCS 1.5 has added a number of options. These options enumerators are 13-19.