Quickstart¶

Creating a mission is fairly simple, the most important class in this respect is dcs.mission.Mission. This class contains all information for running a dcs mission. It is a .zip file that contains several lua data structures and other resources like briefing images, voice overs and other lua scripts.

m = dcs.Mission()
m.save('mission.miz')

This code is enough to create a mission file without any unit groups in the Caucasus(default) terrain.

To add a A-10C flight group starting from Batumi airport use the following snippet:

fg = m.flight_group_from_airport(m.country("USA"), "A-10C Flight Group",
                                 dcs.planes.A-10C, m.terrain.batumi(), group_size=2)
fg.units[0].set_player()

This adds a A-10C flight with 2 planes starting cold from a free parking slot. In the next line it also sets the first unit of the flight as player. For more options when adding a flight see dcs.mission.Mission.flight_group_from_airport().

Random mission script¶

pydcs delivers a small random mission creator script. This script was indented to show features of the framework and is also a little testbed.

It is invoked by the commandline with the following arguments:

usage: random_mission.py [-h] [-a {A-10C,Su-25T,M-2000C,Ka-50,MiG-21Bis}]
                        [-p PLAYERCOUNT] [-s {inflight,runway,warm,cold}]
                        [-t {main,CAS,CAP,refuel}]
                        [-d {random,day,night,dusk,dawn,noon}]
                        [-w {dynamic,dyncyclone,dynanti,dynone,clear}] [-u]
                        [--show-stats] [-o OUTPUT]

Random DCS mission generator

optional arguments:
  -h, --help            show this help message and exit
  -a {A-10C,Su-25T,M-2000C,Ka-50,MiG-21Bis}, --aircrafttype {A-10C,Su-25T,M-2000C,Ka-50,MiG-21Bis}
                        Player aircraft type
  -p PLAYERCOUNT, --playercount PLAYERCOUNT
  -s {inflight,runway,warm,cold}, --start {inflight,runway,warm,cold}
  -t {main,CAS,CAP,refuel}, --missiontype {main,CAS,CAP,refuel}
  -d {random,day,night,dusk,dawn,noon}, --daytime {random,day,night,dusk,dawn,noon}
  -w {dynamic,dyncyclone,dynanti,dynone,clear}, --weather {dynamic,dyncyclone,dynanti,dynone,clear}
  -u, --unhide          Show enemy pre mission
  --show-stats          Show generated missions stats
  -o OUTPUT, --output OUTPUT
                        Name and path of the generated mission

dcs.mission module¶

The mission module is the entry point to all pydcs functions.

class dcs.mission.StartType¶

Bases: enum.Enum

Enum class for start types.

Cold = None¶

Coldstart from ramp.

Warm = None¶

Warmstart from ramp.

Runway = None¶

Start from runway.

static from_string(s: str)¶

Returns the StartType enum for a string value.

[“cold”, “warm”, “runway”]

Parameters:	s – string representation of the starttype
Returns:	the correct StartType.

class dcs.mission.Mission(terrain: typing.Union=None)¶

Bases: object

This class represents the whole dcs .miz file.

A .miz file is a zip file containing all needed files to run a mission. example.miz:

• mission
• options
• warehouses
• i10n
  • DEFAULT
  • dictionary
    • mapResource
    • [localized resource files, .wav, .jpg, ...]

Parameters:	terrain – the used terrain for this mission.

season_from_start_time = None¶

If set to True the mission season will be set by the value of Mission.start_time

load_file(filename: str)¶

Load a mission file (.miz) file, replacing all current data.

Parameters:	filename – path to the mission(.miz) file.
Returns:	True if everything loaded correctly
Return type:	bool
Raises:	RuntimeError – if an unknown value is encountered

sortie_text() → str¶

Returns the mission sortie text.

Returns:	the mission sortie text

set_sortie_text(text: str)¶

Sets the mission sortie text.

Parameters:	text – text to set.

description_text() → str¶

Returns the mission description text.

Returns:	the mission description text

set_description_text(text: str)¶

Sets the mission descsription text.

Parameters:	text – text to set.

description_bluetask_text() → str¶

Returns the blue task description text.

Returns:	the blue task description text

set_description_bluetask_text(text: str)¶

Sets the red coalitions task description text.

Parameters:	text – text to set.

description_redtask_text() → str¶

Returns the red task description text.

Returns:	the red task description text

set_description_redtask_text(text: str)¶

Sets the red coalitions task description text.

Parameters:	text – text to set.

add_picture_red(filepath: str) → str¶

Adds a new briefing picture to the red coalition.

Parameters:	filepath – path to the image, jpg or bmp.
Returns:	the resource key of the picture

add_picture_blue(filepath: str) → str¶

Adds a new briefing picture to the blue coalition.

Parameters:	filepath – path to the image, jpg or bmp.
Returns:	the resource key of the picture

next_group_id()¶

Get the next free group id

Returns:	a new group id

next_unit_id()¶

Get the next free unit id

Returns:	a new unit id

next_dict_id()¶

Get the next free dictionary id

Returns:	a new dictionary id

eplrs_for(group: str) → typing.Dict¶

Searches all vehicle eplrs using groups and writes them in a mapping

Parameters:	group – which group to look for eplrs task, [“helicopter”, “plane”, “vehicle”]
Returns:	a dict mapping groups to used eplrs id

next_eplrs(group_type: str) → int¶

Get next eplrs for the given group type.

Parameters:	group_type – one of “vehicle”, “helicopter” or “plane”
Returns:	the next eplrs id to use
Return type:	int

string(s, lang='DEFAULT')¶

Create a new String() object for translation

Parameters:	s – string for lang lang – language for s
Returns:	A new String() object for string s
Return type:	String

static(name, _type: dcs.unittype.UnitType) → dcs.unit.Static¶

Creates a plain static object to be added to a group

Parameters:	name – of the static object _type (StaticType) – type of the static
Returns:	a new static object
Return type:	Static

static_group(country, name, _type: dcs.unittype.UnitType, position: dcs.mapping.Point, heading=0, hidden=False, dead=False)¶

Add a static group with 1 static object.

Parameters:	country (Country) – the object belongs too name – name of the group _type – what kind of object position (dcs.mapping.Point) – where to place the object heading – of the object hidden – should the object be hidden on the map dead – should the object be rendered as dead
Returns:	the new static group
Return type:	StaticGroup

vehicle(name, _type: dcs.unittype.VehicleType) → dcs.unit.Vehicle¶

Creates a plain vehicle unit to be added to a group

Parameters:	name – of the vehicle _type – vehicle type
Returns:	a new vehicle unit.
Return type:	Vehicle

vehicle_group(country, name, _type: dcs.unittype.VehicleType, position: dcs.mapping.Point, heading=0, group_size=1, formation=<Formation.Line: 1>, move_formation: dcs.point.PointAction=<PointAction.OffRoad: 'Off Road'>) → dcs.unitgroup.VehicleGroup¶

Adds a new vehicle group to the given country.

Parameters:	country – which the vehicle group will belong too
Returns:	the new vehicle group object
Return type:	VehicleGroup

vehicle_group_platoon(country, name, types: typing.List, position: dcs.mapping.Point, heading=0, formation=<Formation.Line: 1>, move_formation: dcs.point.PointAction=<PointAction.OffRoad: 'Off Road'>) → dcs.unitgroup.VehicleGroup¶

Adds a new vehicle group to the given country and given vehicle types.

Parameters:	country – which the vehicle group will belong too
Returns:	the new vehicle group object
Return type:	VehicleGroup

ship(name, _type: dcs.unittype.ShipType) → dcs.unit.Ship¶

Creates a plain ship unit to be added to a group

Parameters:	name – of the ship _type – ship type
Returns:	a new ship unit.
Return type:	Ship

ship_group(country, name, _type: dcs.unittype.ShipType, position: dcs.mapping.Point, heading=0, group_size=1) → dcs.unitgroup.ShipGroup¶

Adds a ship group to the given country.

Parameters:	country (Country) – which the ship group will belong too name – of the ship group _type – which kind of ship to add position (dcs.mapping.Point) – where the new group will be placed heading – initial heading of the group, only used if no additional waypoints group_size – how many ships of _type
Returns:	the new ship group object
Return type:	ShipGroup

plane_group(name) → dcs.unitgroup.PlaneGroup¶

This creates a plain plane group without any units or starting points.

This method is a advanced interface method not intended for simple use. For adding full featured plane group see

• flight_group()
• flight_group_inflight()
• flight_group_from_airport()

Parameters:	name – Group name
Returns:	A new dcs.unitgroup.PlaneGroup
Return type:	PlaneGroup

plane(name, _type: dcs.planes.PlaneType, country: dcs.country.Country)¶

Creates a new plane unit.

This method is a advanced interface method not intended for simple usage. For adding full a featured plane group see

• flight_group()
• flight_group_inflight()
• flight_group_from_airport()

Parameters:	name – unit name _type – type of the plane country (Country) – the plane belongs, needed for default liveries
Returns:	A new dcs.unit.Plane
Return type:	Plane

helicopter(name, _type: dcs.helicopters.HelicopterType, country: dcs.country.Country)¶

Creates a new helicopter unit.

This method is a advanced interface method not intended for simple usage. For adding full a featured helicopter group see

• flight_group()
• flight_group_inflight()
• flight_group_from_airport()

Parameters:	name – unit name _type – type of the helicopter country (Country) – the helicopter belongs, needed for default liveries
Returns:	A new dcs.unit.Helicopter
Return type:	Helicopter

aircraft(name, _type: dcs.unittype.FlyingType, country: dcs.country.Country) → typing.Union¶

Creates a new plane or helicopter unit, depending on the _type.

This method is a advanced interface method not intended for simple usage. For adding full a featured plane/helicopter group see

• flight_group()
• flight_group_inflight()
• flight_group_from_airport()

Parameters:	name – unit name _type – type of the aircraft country (Country) – the aircraft belongs, needed for default liveries
Returns:	A new dcs.unit.Plane or dcs.unit.Helicopter
Return type:	Helicopter

helicopter_group(name) → dcs.unitgroup.HelicopterGroup¶

Creates a plain helicopter group without any units or starting points.

This method is a advanced interface method not intended for simple usage. For adding a full featured helicopter group see

• flight_group()
• flight_group_inflight()
• flight_group_from_airport()

Parameters:	name – Group name
Returns:	A new dcs.unitgroup.HelicopterGroup
Return type:	HelicopterGroup

flight_group_inflight(country, name: str, aircraft_type: dcs.unittype.FlyingType, position: dcs.mapping.Point, altitude: int, speed=None, maintask: typing.Union=None, group_size: int=1) → typing.Union¶

Add a new Plane/Helicopter group inflight.

The type of the resulting group depends on the given aircraft_type.

Parameters:	country (Country) – the new group will belong to name – of the new group aircraft_type (FlyingType) – type of all units in the group position (dcs.mapping.Point) – where the new group will be placed altitude – of the new group speed – of the new group, if none a default will be picked maintask (MainTask) – if none the default task for the aircraft_type wil be used group_size – number of units in the group(maximum 4 or 1 for certain types)
Returns:	a new dcs.unitgroup.PlaneGroup or dcs.unitgroup.HelicopterGroup
Return type:	FlyingGroup

flight_group_from_airport(country: dcs.country.Country, name, aircraft_type: dcs.unittype.FlyingType, airport: dcs.terrain.terrain.Airport, maintask: dcs.task.MainTask=None, start_type: dcs.mission.StartType=<StartType.Cold: 1>, group_size=1, parking_slots: typing.List=None) → typing.Union¶

Add a new Plane/Helicopter group at the given airport.

Runway, warm/cold start depends on the given start_type.

Parameters:	country (Country) – Country object the plane group belongs to name – Name of the aircraft group maintask (MainTask) – Task of the aircraft group aircraft_type (FlyingType) – FlyingType class that describes the aircraft_type airport (Airport) – Airport object on which to spawn the helicopter start_type (StartType) – Start from runway, cold or warm parking position parking_slots – List of parking slots to use for aircrafts group_size – number of units in the group(maximum 4 or 1 for certain types)
Returns:	a new dcs.unitgroup.PlaneGroup or dcs.unitgroup.HelicopterGroup
Return type:	FlyingGroup

flight_group_from_unit(country: dcs.country.Country, name, aircraft_type: dcs.unittype.FlyingType, carrier_unit: typing.Union, maintask: dcs.task.MainTask=None, start_type: dcs.mission.StartType=<StartType.Cold: 1>, group_size=1) → typing.Union¶

Add a new Plane/Helicopter group at the given FARP or carrier unit.

Parameters:	country (Country) – Country object the plane group belongs to name – Name of the aircraft group maintask (MainTask) – Task of the aircraft group aircraft_type (FlyingType) – FlyingType class that describes the aircraft_type carrier_unit (Unit) – Group(Ship, FARP) on which to spawn start_type (StartType) – Start from runway, cold or warm parking position, ignored for now group_size – number of units in the group(maximum 4 or 1 for certain types)
Returns:	a new dcs.unitgroup.PlaneGroup or dcs.unitgroup.HelicopterGroup
Return type:	FlyingGroup

flight_group(country: dcs.country.Country, name: str, aircraft_type: dcs.unittype.FlyingType, airport: typing.Union, position: typing.Union, altitude=3000, speed=500, maintask: typing.Union=None, start_type: dcs.mission.StartType=<StartType.Runway: 3>, group_size=1) → dcs.unitgroup.FlyingGroup¶

This is wrapper around flight_group_inflight and flight_group_from_airport.

Depending on the airport parameter a flight group will added inflight or on an airport.

Parameters:	country (Country) – Country object the plane group belongs to name – Name of the aircraft group aircraft_type (FlyingType) – FlyingType class that describes the aircraft_type airport (Airport) – Airport object on which to spawn the helicopter position (dcs.mapping.Point) – where the new group will be placed, if inflight altitude – initial altitude of the group if inflight speed – initial speed of the group if inflight maintask (MainTask) – Task of the aircraft group start_type (StartType) – Start from runway, cold or warm parking position group_size – number of units in the group(maximum 4 or 1 for certain types)
Returns:	a new dcs.unitgroup.PlaneGroup or dcs.unitgroup.HelicopterGroup
Return type:	FlyingGroup

awacs_flight(country: dcs.country.Country, name: str, plane_type: dcs.planes.PlaneType, airport: typing.Union, position: dcs.mapping.Point, race_distance=30000, heading=90, altitude=4500, speed=550, start_type: dcs.mission.StartType=<StartType.Cold: 1>, frequency=140) → dcs.unitgroup.PlaneGroup¶

Add an AWACS flight group.

This is simple way to add an AWACS flight group to your mission. It needs an initial orbit point, race distance and heading from this point.

If an airport is given the AWACS flight will start from there otherwise, it will placed 2 km in front of the reference position.

Parameters:	country (Country) – Country object the awacs group belongs to name – of the AWACS flight plane_type (PlaneType) – AWACS plane type. e.g E_3A airport (Airport) – starting airport, use None if you want it to spawn inflight position (dcs.mapping.Point) – reference point for the race-track race_distance – distance for the race-track pattern heading – direction from the referene position altitude – of the AWACS race-track speed – of the AWACS flight start_type (StartType) – of the flight if starts from airport frequency – VHF-AM frequencey in mhz
Returns:	the created AWACS flight group
Return type:	PlaneGroup

refuel_flight(country, name: str, plane_type: dcs.planes.PlaneType, airport: typing.Union, position: dcs.mapping.Point, race_distance=30000, heading=90, altitude=4500, speed=407, start_type: dcs.mission.StartType=<StartType.Cold: 1>, frequency=140, tacanchannel='10X') → dcs.unitgroup.PlaneGroup¶

Add an refuel flight group.

This is simple way to add an refuel flight group to your mission. It needs an initial orbit point, race distance and heading from this point.

If an airport is given the refuel flight will start from there otherwise, it will placed 2 km in front of the reference position.

Parameters:	country (Country) – Country object the awacs group belongs to name – of the refuel flight plane_type (PlaneType) – refuel plane type. e.g KC_135 airport (Airport) – starting airport, use None if you want it to spawn inflight position (dcs.mapping.Point) – reference point for the race-track race_distance – distance for the race-track pattern heading – direction from the referene position altitude – of the refuel race-track speed – of the refuel flight start_type (StartType) – of the flight if starts from airport frequency – VHF-AM frequencey in mhz tacanchannel – if the PlaneType supports tacan this channel will be set.
Returns:	the created refuel flight group
Return type:	PlaneGroup

escort_flight(country, name: str, escort_type: dcs.planes.PlaneType, airport: typing.Union, group_to_escort: dcs.unitgroup.FlyingGroup, start_type: dcs.mission.StartType=<StartType.Cold: 1>, group_size=2)¶

Add an escort flight group to the mission.

An escort flight is a flight group that will use the dcs.task.EscortTaskAction to escort another flight group.

If no airport is given, the escort flight will spawn near the group to escort.

Parameters:	country (Country) – the escort flight belongs too name – of the flight group escort_type (PlaneType) – PlaneType for the escort task airport (Airport) – starting airport, use None if you want it to spawn inflight group_to_escort – id of the group to escort start_type (StartType) – of the flight if starts from airport group_size – how many planes should be in the escort flight
Returns:	the created escort group
Return type:	PlaneGroup

patrol_flight(country, name: str, patrol_type: dcs.planes.PlaneType, airport: typing.Union, pos1, pos2, start_type: dcs.mission.StartType=<StartType.Cold: 1>, speed=600, altitude=4000, max_engage_distance=60000, group_size=2)¶

Add an patrol flight group to the mission.

A patrol flight is a flight group that will fly a orbit between 2 given points and will engage any incoming air threats within max_engage_distance.

If no airport is given, the patrol flight will spawn near the first patrol point(pos1).

Parameters:	country (Country) – the flight belongs too name – name of the patrol flight patrol_type (PlaneType) – PlaneType for the patrol flight airport (Airport) – starting airport, use None if you want it to spawn inflight pos1 (dcs.mapping.Point) – first orbit waypoint pos2 (dcs.mapping.Point) – second orbit waypoint start_type (StartType) – of the flight if starts from airport speed – orbit speed altitude – initial altitude and orbit altitude max_engage_distance – the distance in KM the patrol flight will respond to enemy threats group_size – how many planes should be in the flight group
Returns:	the created patrol group
Return type:	PlaneGroup

country(name)¶

Returns the country object for the mission by the given string

Parameters:	name – string representation of the country
Returns:	the object of the country, None if not found.
Return type:	Country

find_group(group_name, search='exact') → typing.Union¶

Searches a group with the given name.

Parameters:	group_name – part or exact name of the group search – search mode to use ‘exact’: whole name must match ‘match’: part of the name must match
Returns:	the group found, otherwise None
Return type:	Group

is_red(country: dcs.country.Country) → bool¶

Checks if the given country object is part o the red coalition.

Parameters:	country (Country) – object to check
Returns:	True if it is part of the red coalition, else False.
Return type:	bool

is_blue(country: dcs.country.Country) → bool¶

Checks if the given country object is part o the blue coalition.

Parameters:	country (Country) – object to check
Returns:	True if it is part of the blue coalition, else False.
Return type:	bool

stats() → typing.Dict¶

Gather some mission stats.

This method counts up the different group types and used units and returns them as easy to print dict.

Returns:	dict containing various group and unit counts.

print_stats(d)¶

Print the given mission stats to standard output.

Parameters:	d – stats dict to print, dcs.mission.Mission.stats()

reload()¶

Reloads the current loaded file

Raises:	RuntimeError – if there is currently no file loaded.

save(filename=None)¶

Save the current Mission object to the given file.

Parameters:	filename – filepath to save the Mission object show_stats (bool) – if True print mission stats to standard out.

dict()¶

class dcs.mission.MapResource(mission: dcs.mission.Mission)¶

Bases: object

MapResource is responsibly to manage all additional mission resource files.

Mission resource files are briefing images, lua scripts, sounds files.

Parameters:	mission (Mission) – the mission this MapResource belongs too, needed for dictionary ids

load_from_dict(_dict, zipf: zipfile.ZipFile, lang='DEFAULT')¶

add_resource_file(filepath, lang='DEFAULT', key=None)¶

Adds a file to the mission resource depot.

Parameters:	filepath – path to the file to add lang – language this file belongs too. key – should None, needed for loading
Returns:	resource key to use in scripts

store(zipf: zipfile.ZipFile, lang='DEFAULT')¶

class dcs.mission.Options¶

Bases: object

Should be a representation for the mission options file might be removed in the future.

load_from_dict(d)¶

dcs.task module¶

This module holds all Tasks that are possible to specifiy in dcs.

There are 2 type of tasks, a MainTask and a Task action.

• MainTasks are the flight groups main objective like CAS, CAP, SEAD, ...
• Task actions on the otherhand are specific tasks within a MainTask, these cover things like AttackGroup, Orbit, Follow, Escort, ...

Also options and commands are task actions.

class dcs.task.Modulation¶

Bases: enum.Enum

Enum for VHF frequency bands

AM = None¶

AM frequency band

FM = None¶

FM frequency band

class dcs.task.Task(_id)¶

Bases: object

Base class for task actions.

classmethod create_from_dict(d)¶

dict()¶

class dcs.task.ControlledTask(task: dcs.task.Task=None)¶

Bases: dcs.task.Task

A ControlledTask is a task action with start and stop conditions.

ControlledTask is a wrapper around a normal task action that has special methods to add start/stop conditions.

Parameters:	task – to wrap

Id = 'ControlledTask'¶

start_after_time(time: int)¶

Start the wrapped task after time seconds.

Parameters:	time – start after x seconds.

start_if_user_flag(user_flag, value: bool)¶

Start the wrapped task if user_flag has value.

Parameters:	user_flag – id of the userflag value – bool value of the flag

start_probability(probability: int)¶

Chance that the wrapped task will actually start.

Parameters:	probability – start chance in %

start_if_lua_predicate(lua_predicate: str)¶

Start wrapped task if lua condition is true.

Parameters:	lua_predicate – lua condition as string

stop_after_time(time: int)¶

Stop the wrapped task after time seconds.

Parameters:	time – start after x seconds.

stop_if_user_flag(user_flag, value: bool)¶

Stop the wrapped task if user_flag has value.

Parameters:	user_flag – id of the userflag value – bool value of the flag

stop_if_lua_predicate(lua_predicate: str)¶

Stop wrapped task if lua condition is true.

Parameters:	lua_predicate – lua condition as string

stop_after_duration(duration: int)¶

Stop task after duration seconds.

Parameters:	duration – in seconds

class dcs.task.WeaponType¶

Bases: enum.Enum

class dcs.task.TargetType¶

Bases: type

id = None¶

class dcs.task.Targets¶

Bases: object

class All¶

Bases: object

id = 'All'¶

class Air¶

Bases: object

id = 'Air'¶

class Planes¶

Bases: object

id = 'Planes'¶

class Fighters¶

Bases: object

id = 'Fighters'¶

class Targets.All.Air.Planes.Bombers¶

Bases: object

id = 'Bombers'¶

class Targets.All.Air.Helicopters¶

Bases: object

id = 'Helicopters'¶

class Targets.All.GroundUnits¶

Bases: object

id = 'Ground Units'¶

class Infantry¶

Bases: object

id = 'Infantry'¶

class Targets.All.GroundUnits.Fortifications¶

Bases: object

id = 'Fortifications'¶

class Targets.All.GroundUnits.GroundVehicles¶

Bases: object

id = 'Ground vehicles'¶

class ArmoredVehicles¶

Bases: object

id = 'Armored vehicles'¶

class Tanks¶

Bases: object

id = 'Tanks'¶

class Targets.All.GroundUnits.GroundVehicles.ArmoredVehicles.IFV¶

Bases: object

id = 'IFV'¶

class Targets.All.GroundUnits.GroundVehicles.ArmoredVehicles.APC¶

Bases: object

id = 'APC'¶

class Targets.All.GroundUnits.GroundVehicles.Artillery¶

Bases: object

id = 'Artillery'¶

class Targets.All.GroundUnits.GroundVehicles.UnarmedVehicles¶

Bases: object

id = 'Unarmed vehicles'¶

class Targets.All.GroundUnits.AirDefence¶

Bases: object

id = 'Air Defence'¶

class AAA¶

Bases: object

id = 'AAA'¶

class SAMRelated¶

Bases: object

id = 'SAM related'¶

class SRSAM¶

Bases: object

id = 'SR SAM'¶

class Targets.All.GroundUnits.AirDefence.AAA.SAMRelated.MRSAM¶

Bases: object

id = 'MR SAM'¶

class Targets.All.GroundUnits.AirDefence.AAA.SAMRelated.LRSAM¶

Bases: object

id = 'LR SAM'¶

class Targets.All.Naval¶

Bases: object

id = 'Naval'¶

class Ships¶

Bases: object

id = 'Ships'¶

class ArmedShips¶

Bases: object

id = 'Armed ships'¶

class HeavyArmedShips¶

Bases: object

id = 'Heavy armed ships'¶

class AircraftCarriers¶

Bases: object

id = 'Aircraft Carriers'¶

class Targets.All.Naval.Ships.ArmedShips.HeavyArmedShips.Cruisers¶

Bases: object

id = 'Cruisers'¶

class Targets.All.Naval.Ships.ArmedShips.HeavyArmedShips.Destroyers¶

Bases: object

id = 'Destroyers'¶

class Targets.All.Naval.Ships.ArmedShips.HeavyArmedShips.Frigates¶

Bases: object

id = 'Frigates'¶

class Targets.All.Naval.Ships.ArmedShips.HeavyArmedShips.Corvettes¶

Bases: object

id = 'Corvettes'¶

class Targets.All.Naval.Ships.ArmedShips.LightArmedShips¶

Bases: object

id = 'Light armed ships'¶

class Targets.All.Naval.Ships.UnarmedShips¶

Bases: object

id = 'Unarmed ships'¶

class Targets.All.Naval.Submarines¶

Bases: object

id = 'Submarines'¶

class dcs.task.NoTask¶

Bases: dcs.task.Task

Id = 'NoTask'¶

class dcs.task.AttackGroup(group_id=0, weapon_type: dcs.task.WeaponType=<WeaponType.Auto: 1073741822>)¶

Bases: dcs.task.Task

Attack group task action

Parameters:	group_id – group id to attack weapon_type – WeaponType to use for the attack

Id = 'AttackGroup'¶

class dcs.task.AttackUnit(unit_id=0, attack_limit: typing.Union=None, weapon_type: dcs.task.WeaponType=<WeaponType.Auto: 1073741822>, group_attack=False)¶

Bases: dcs.task.Task

Attack unit task action

Parameters:	unit_id – unit id to attack attack_limit – how much attack runs weapon_type – WeaponType to use for the attack group_attack – indicate if the unit must be attacked by all aircrafts in the group.

Id = 'AttackUnit'¶

class dcs.task.AttackMapObject(position: dcs.mapping.Point=Point(0, 0), attack_limit: typing.Union=None, weapon_type: dcs.task.WeaponType=<WeaponType.Auto: 1073741822>, group_attack=False)¶

Bases: dcs.task.Task

Id = 'AttackMapObject'¶

class dcs.task.AntishipStrikeTaskAction¶

Bases: dcs.task.Task

Id = 'EngageTargets'¶

Key = 'AntiShip'¶

dict()¶

class dcs.task.CASTaskAction¶

Bases: dcs.task.Task

Id = 'EngageTargets'¶

Key = 'CAS'¶

dict()¶

class dcs.task.SEADTaskAction¶

Bases: dcs.task.Task

Id = 'EngageTargets'¶

Key = 'SEAD'¶

dict()¶

class dcs.task.CAPTaskAction¶

Bases: dcs.task.Task

Id = 'EngageTargets'¶

Key = 'CAP'¶

dict()¶

class dcs.task.FighterSweepTaskAction¶

Bases: dcs.task.Task

Id = 'EngageTargets'¶

Key = 'FighterSweep'¶

dict()¶

class dcs.task.EscortTaskAction(group_id=None, engagement_max_dist=60000, lastwpt=None, targets: typing.List=None, position: typing.Dict=None)¶

Bases: dcs.task.Task

Id = 'Escort'¶

class dcs.task.Expend¶

Bases: enum.Enum

class dcs.task.Bombing(position: dcs.mapping.Point=Point(0, 0), weapon_type: dcs.task.WeaponType=<WeaponType.Auto: 1073741822>, expend: dcs.task.Expend=<Expend.Auto: 'Auto'>, attack_qty=1, group_attack=False, direction: typing.Union=None, altitude: typing.Union=None)¶

Bases: dcs.task.Task

Id = 'Bombing'¶

class dcs.task.BombingRunway(airport_id: int=0, weapon_type: dcs.task.WeaponType=<WeaponType.Auto: 1073741822>, expend: dcs.task.Expend=<Expend.Auto: 'Auto'>, attack_qty=1, group_attack=False, direction: typing.Union=None, altitude: typing.Union=None)¶

Bases: dcs.task.Task

Id = 'BombingRunway'¶

class dcs.task.EngageTargets(max_distance=None, targets: typing.List=None)¶

Bases: dcs.task.Task

Id = 'EngageTargets'¶

class dcs.task.EngageTargetsInZone(position: dcs.mapping.Point=Point(0, 0), radius=5000, targets: typing.List=None)¶

Bases: dcs.task.Task

Id = 'EngageTargetsInZone'¶

class dcs.task.EngageGroup(group_id=0, visible=False)¶

Bases: dcs.task.Task

Id = 'EngageGroup'¶

class dcs.task.EngageUnit(unit_id=0, visible=False)¶

Bases: dcs.task.Task

Id = 'EngageUnit'¶

class dcs.task.FireAtPoint(position: dcs.mapping.Point=Point(0, 0), rounds=None, radius=0)¶

Bases: dcs.task.Task

Id = 'FireAtPoint'¶

class dcs.task.Hold¶

Bases: dcs.task.Task

Unit will hold current position

Id = 'Hold'¶

class dcs.task.AWACSTaskAction¶

Bases: dcs.task.Task

Id = 'AWACS'¶

class dcs.task.RefuelingTaskAction¶

Bases: dcs.task.Task

Assigns the aircraft group to refuel at the nearest tanker aircraft.

Id = 'Refueling'¶

class dcs.task.Tanker¶

Bases: dcs.task.Task

Assigns the aircraft to act as an Airborne tanker.

Id = 'Tanker'¶

class dcs.task.OrbitAction(altitude=4000, speed=600, pattern: dcs.task.OrbitPattern=<OrbitPattern.RaceTrack: 'Race-Track'>)¶

Bases: dcs.task.Task

Id = 'Orbit'¶

class OrbitPattern¶

Bases: enum.Enum

class dcs.task.Follow(groupid=None, position: dcs.mapping.Point=Point(-200, 0), altitude_difference=-200, last_wpt=None)¶

Bases: dcs.task.Task

Id = 'Follow'¶

class dcs.task.Aerobatics¶

Bases: dcs.task.Task

Id = 'Aerobatics'¶

class dcs.task.Designation¶

Bases: enum.Enum

class dcs.task.FAC(callsign: int=1, designation: dcs.task.Designation=<Designation.Auto: 'Auto'>, frequency: int=30, modulation: dcs.task.Modulation=<Modulation.FM: 1>, number: int=1)¶

Bases: dcs.task.Task

Id = 'FAC'¶

class dcs.task.FACEngageGroup(group_id: int=0, visible=False, weapon_type: dcs.task.WeaponType=<WeaponType.Auto: 1073741822>, priority: int=0, callsign: int=1, designation: dcs.task.Designation=<Designation.Auto: 'Auto'>, frequency: int=30, modulation: dcs.task.Modulation=<Modulation.FM: 1>, datalink=True, number: int=1)¶

Bases: dcs.task.Task

Id = 'FAC_EngageGroup'¶

class dcs.task.Land(position: dcs.mapping.Point=Point(0, 0), duration: int=None)¶

Bases: dcs.task.Task

Helicopter landing task.

If added to a helicopter group, the group will land at the given coordinates for the given duration.

Parameters:	position – dcs.mapping.Point where to land duration – how long the helicopter should stay on ground in seconds.

Id = 'Land'¶

class dcs.task.Embarking(position: dcs.mapping.Point=Point(0, 0), groupids: typing.List=None, distribution: typing.Dict=None, duration: int=None)¶

Bases: dcs.task.Task

Pickup task for helicopters.

Helicopter group will land at the given coordinates and will pickup the given groups.

Parameters:	position – dcs.mapping.Point where to land and pickup groupids – list of groups to pickup distribution – dictionary with heli unit to groups to pickup mapping {heliunit: [grp1, grp2], ..} duration – how long the helicopter should stay on ground and wait in seconds.

Id = 'Embarking'¶

class dcs.task.EmbarkToTransport(position: dcs.mapping.Point=Point(0, 0), zone_radius=200, concrete_unitid=None)¶

Bases: dcs.task.Task

Task for ground units that will get picked up by a helicopter

Parameters:	position – dcs.mapping.Point where to wait to get picked up. zone_radius – radius around the point where the group will embark. concrete_unitid – if specified the group will embark to exaclty this unit.

Id = 'EmbarkToTransport'¶

class dcs.task.DisembarkFromTransport(position: dcs.mapping.Point=Point(0, 0), zone_radius=200)¶

Bases: dcs.task.Task

Task for ground units that will disembark a transport helicopter

Parameters:	position – dcs.mapping.Point where the group will disembark zone_radius – radius around the point where the group will disembark.

Id = 'DisembarkFromTransport'¶

class dcs.task.CargoTransportation(groupid=None, zoneid=None)¶

Bases: dcs.task.Task

Task for Cargo transportation.

Parameters:	groupid – cargo group id zoneid – zone id to transport to??

Id = 'CargoTransportation'¶

class dcs.task.WrappedAction¶

Bases: dcs.task.Task

Id = 'WrappedAction'¶

class dcs.task.EPLRS(group_id=1)¶

Bases: dcs.task.WrappedAction

Key = 'EPLRS'¶

eplrs¶

class dcs.task.ActivateBeaconCommand(channel=10, modechannel='X', callsign='TKR', bearing=True)¶

Bases: dcs.task.WrappedAction

Key = 'ActivateBeacon'¶

static calc_tacan_frequency(mode_channel, channel, aa=True)¶

class dcs.task.RunScript(script: str='')¶

Bases: dcs.task.WrappedAction

Runs a given script string

Parameters:	script – to be executed

Key = 'Script'¶

class dcs.task.RunScriptFile(resourcekey: str='')¶

Bases: dcs.task.WrappedAction

Runs a script attached to the mission

Parameters:	resourcekey – resource key to the script file, see dcs.mission.MapResource

Key = 'ScriptFile'¶

class dcs.task.TransmitMessage(soundfile_reskey: typing.Union=None, subtitle_resstring: typing.Union=None, loop=False, subtitle_duration=5)¶

Bases: dcs.task.WrappedAction

Transmits a given sound file over the current radio channel.

Parameters:	soundfile_reskey – resource key to the sound file to transmit, see dcs.mission.MapResource subtitle_resstring – string resource key to subtitle displayed, see dcs.mission.Mission.translation loop – True or False if the sound file should be looped. subtitle_duration – how long the subtitle should be displayed in seconds.

Key = 'TransmitMessage'¶

class dcs.task.StopTransmission¶

Bases: dcs.task.WrappedAction

Stops any dcs.task.TransmitMessage task currently ongoing.

Key = 'StopTransmission'¶

class dcs.task.SetFrequencyCommand(frequency=133, modulation: dcs.task.Modulation=<Modulation.AM: 0>)¶

Bases: dcs.task.WrappedAction

Set the groups radio frequency.

Parameters:	frequency – frequency band in mhz. modulation – AM or FM, see dcs.task.Modulation

Key = 'SetFrequency'¶

class dcs.task.SwitchWaypoint(from_waypoint=1, to_waypoint=2)¶

Bases: dcs.task.WrappedAction

Switch to a different waypoint.

Parameters:	from_waypoint – from which waypoint to switch.?? to_waypoint – new current waypoint

Key = 'SwitchWaypoint'¶

class dcs.task.SetInvisibleCommand(value=True)¶

Bases: dcs.task.WrappedAction

Key = 'SetInvisible'¶

class dcs.task.SetImmortalCommand(value=True)¶

Bases: dcs.task.WrappedAction

Key = 'SetImmortal'¶

class dcs.task.MainTask¶

Bases: object

name = None¶

sub_tasks = []¶

perform_task = []¶

map = {'Fighter Sweep': <class 'dcs.task.FighterSweep'>, 'Nothing': <class 'dcs.task.Nothing'>, 'SEAD': <class 'dcs.task.SEAD'>, 'Antiship Strike': <class 'dcs.task.AntishipStrike'>, 'AFAC': <class 'dcs.task.AFAC'>, 'CAS': <class 'dcs.task.CAS'>, 'Refueling': <class 'dcs.task.Refueling'>, 'Reconnaissance': <class 'dcs.task.Reconnaissance'>, 'CAP': <class 'dcs.task.CAP'>, 'Intercept': <class 'dcs.task.Intercept'>, 'AWACS': <class 'dcs.task.AWACS'>, 'Ground Attack': <class 'dcs.task.RunwayAttack'>, 'Transport': <class 'dcs.task.Transport'>, 'Escort': <class 'dcs.task.Escort'>, 'Pinpoint Strike': <class 'dcs.task.PinpointStrike'>}¶

class dcs.task.Nothing¶

Bases: dcs.task.MainTask

id = 15¶

name = 'Nothing'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.Aerobatics'>]¶

class dcs.task.AFAC¶

Bases: dcs.task.MainTask

id = 16¶

name = 'AFAC'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.AttackGroup'>, <class 'dcs.task.AttackUnit'>, <class 'dcs.task.Bombing'>, <class 'dcs.task.AttackMapObject'>]¶

class dcs.task.AWACS¶

Bases: dcs.task.MainTask

id = 14¶

name = 'AWACS'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.RefuelingTaskAction'>]¶

perform_task = [<class 'dcs.task.AWACSTaskAction'>]¶

class dcs.task.AntishipStrike¶

Bases: dcs.task.MainTask

id = 30¶

name = 'Antiship Strike'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.AttackGroup'>, <class 'dcs.task.AttackUnit'>]¶

perform_task = [<class 'dcs.task.AntishipStrikeTaskAction'>]¶

class dcs.task.CAS¶

Bases: dcs.task.MainTask

id = 31¶

name = 'CAS'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.AttackGroup'>, <class 'dcs.task.AttackUnit'>, <class 'dcs.task.Aerobatics'>, <class 'dcs.task.RefuelingTaskAction'>]¶

perform_task = [<class 'dcs.task.CASTaskAction'>]¶

class EnrouteTasks¶

Bases: object

class EngageGroup(group_id=0, visible=False)¶

Bases: dcs.task.Task

Id = 'EngageGroup'¶

class CAS.EnrouteTasks.EngageTargetsInZone(position: dcs.mapping.Point=Point(0, 0), radius=5000, targets: typing.List=None)¶

Bases: dcs.task.Task

Id = 'EngageTargetsInZone'¶

class CAS.EnrouteTasks.EngageUnit(unit_id=0, visible=False)¶

Bases: dcs.task.Task

Id = 'EngageUnit'¶

class dcs.task.CAP¶

Bases: dcs.task.MainTask

id = 11¶

name = 'CAP'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.Aerobatics'>]¶

perform_task = [<class 'dcs.task.CAPTaskAction'>]¶

class EnrouteTasks¶

Bases: object

class EngageTargets(max_distance=None, targets: typing.List=None)¶

Bases: dcs.task.Task

Id = 'EngageTargets'¶

class CAP.EnrouteTasks.EngageTargetsInZone(position: dcs.mapping.Point=Point(0, 0), radius=5000, targets: typing.List=None)¶

Bases: dcs.task.Task

Id = 'EngageTargetsInZone'¶

class CAP.EnrouteTasks.EngageGroup(group_id=0, visible=False)¶

Bases: dcs.task.Task

Id = 'EngageGroup'¶

class CAP.EnrouteTasks.EngageUnit(unit_id=0, visible=False)¶

Bases: dcs.task.Task

Id = 'EngageUnit'¶

class dcs.task.Escort¶

Bases: dcs.task.MainTask

id = 18¶

name = 'Escort'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.EscortTaskAction'>]¶

perform_task = [<class 'dcs.task.EscortTaskAction'>]¶

class dcs.task.FighterSweep¶

Bases: dcs.task.MainTask

id = 19¶

name = 'Fighter Sweep'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.Aerobatics'>]¶

perform_task = [<class 'dcs.task.FighterSweepTaskAction'>]¶

class dcs.task.GroundAttack¶

Bases: dcs.task.MainTask

id = 32¶

name = 'Ground Attack'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.Bombing'>, <class 'dcs.task.AttackMapObject'>, <class 'dcs.task.Aerobatics'>]¶

class dcs.task.Intercept¶

Bases: dcs.task.MainTask

id = 10¶

name = 'Intercept'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.AttackGroup'>, <class 'dcs.task.AttackUnit'>, <class 'dcs.task.Aerobatics'>]¶

class dcs.task.PinpointStrike¶

Bases: dcs.task.MainTask

id = 33¶

name = 'Pinpoint Strike'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.Bombing'>, <class 'dcs.task.AttackMapObject'>]¶

class dcs.task.Reconnaissance¶

Bases: dcs.task.MainTask

id = 17¶

name = 'Reconnaissance'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.Aerobatics'>]¶

perform_task = []¶

class dcs.task.Refueling¶

Bases: dcs.task.MainTask

id = 13¶

name = 'Refueling'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>]¶

perform_task = [<class 'dcs.task.Tanker'>]¶

class dcs.task.RunwayAttack¶

Bases: dcs.task.MainTask

id = 34¶

name = 'Ground Attack'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.Bombing'>, <class 'dcs.task.BombingRunway'>, <class 'dcs.task.AttackMapObject'>]¶

perform_task = []¶

class dcs.task.SEAD¶

Bases: dcs.task.MainTask

id = 29¶

name = 'SEAD'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.AttackGroup'>, <class 'dcs.task.AttackUnit'>, <class 'dcs.task.EscortTaskAction'>]¶

perform_task = [<class 'dcs.task.SEADTaskAction'>]¶

class dcs.task.Transport¶

Bases: dcs.task.MainTask

id = 35¶

name = 'Transport'¶

sub_tasks = [<class 'dcs.task.OrbitAction'>, <class 'dcs.task.Follow'>, <class 'dcs.task.Aerobatics'>]¶

perform_task = []¶

class dcs.task.Option(value=None)¶

Bases: dcs.task.Task

Id = 'WrappedAction'¶

Key = None¶

class dcs.task.OptROE(value=0)¶

Bases: dcs.task.Option

Sets the groups rules of engagement. Ultimately defines whether or not the AI group is allowed to attack. This option can override all other tasking. With the 1.5 patch two of the values have different names in the mission editor. However the behavior is still exactly the same as before, its just labeled slightly different. The scripting engine still uses the previous values.

Key = 0¶

class Values¶

Bases: object

WeaponFree = 0¶

AI will engage any enemy group it detects. Target prioritization is based based on the threat of the target.

OpenFireWeaponFree = 1¶

AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking.

OpenFire = 2¶

AI will engage only targets specified in its taskings.

ReturnFire = 3¶

AI will only engage threats that shoot first.

WeaponHold = 4¶

AI will hold fire under all circumstances.

class dcs.task.OptReactOnThreat(value=0)¶

Bases: dcs.task.Option

Defines the allowable action for an airborne group to take in response to a threat. This option can have an effect on other tasking.

Key = 1¶

class Values¶

Bases: object

NoReaction = 0¶

No defensive actions will take place to counter threats

PassiveDefense = 1¶

AI will use jammers and other countermeasures in an attempt to defeat the threat. AI will not attempt a maneuver to defeat a threat.

EvadeFire = 2¶

AI will react by performing defensive maneuvers against incoming threats, AI will also use passive defense.

ByPassAndEscape = 3¶

AI will attempt to avoid enemy threat zones all together. This includes attempting to fly above or around threats.

AllowAbortMission = 4¶

If a threat is deemed severe enough the AI will abort its mission and return to base.

class dcs.task.OptDisparseUnderFire(value=None)¶

Bases: dcs.task.Option

Key = 8¶

dcs¶