Skip to content

Stack commands

minisky

ADDWPT

Aliases: WPTYPE

ADDWPT acidx, FLYBY|FLY-BY|FLYOVER|FLY-OVER|FLYTURN|FLY-TURN
Python API

Select FLYBY, FLYOVER, or FLYTURN through the ADDWPT mode form.

acidx An existing aircraft callsign. Internal Type: int.
mode Accepted: FLYBY, FLY-BY, FLYOVER, FLY-OVER, FLYTURN, FLY-TURN. Internal Type: WaypointMode.
ADDWPT acidx, TURNRAD|TURNRADIUS|TURNSPD|TURNSPEED|TURNHDG|TURNHDGR|TURNHDGRATE, OFF
Python API

Clear a turn parameter through the ADDWPT mode form.

acidx An existing aircraft callsign. Internal Type: int.
parameter Accepted: TURNRAD, TURNRADIUS, TURNSPD, TURNSPEED, TURNHDG, TURNHDGR, TURNHDGRATE. Internal Type: TurnParameter.
ADDWPT acidx, TURNRAD|TURNRADIUS, value
Python API

Set a fly-turn radius through ADDWPT.

acidx An existing aircraft callsign. Internal Type: int.
value (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, > 0. Internal Type: float. Internal Unit: meter.
ADDWPT acidx, TURNSPD|TURNSPEED, value
Python API

Set fly-turn CAS through ADDWPT.

acidx An existing aircraft callsign. Internal Type: int.
value Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: > 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
ADDWPT acidx, TURNHDG|TURNHDGR|TURNHDGRATE, value
Python API

Set a fly-turn heading rate through ADDWPT, in degrees per second.

acidx An existing aircraft callsign. Internal Type: int.
value Constraints: > 0, finite. Internal Type: float. Internal Unit: degree · second⁻¹.
ADDWPT acidx, TAKEOFF, runway
Python API

Add a takeoff waypoint from an explicit runway.

Examples:

ADDWPT KL204 TAKEOFF EHAM/RW06
acidx An existing aircraft callsign. Internal Type: int.
runway (e.g. EHAM/RW06, LFPG/RWY23) Internal Type: RunwayReference.
ADDWPT acidx, TAKEOFF
Python API

Add a takeoff waypoint using a runway already in the route or current position.

acidx An existing aircraft callsign. Internal Type: int.
ADDWPT acidx, waypoint, altitude, airspeed, _after, before
Python API

Insert a route waypoint before an existing waypoint.

acidx An existing aircraft callsign. Internal Type: int.
waypoint One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
    Internal Type: CoordinateWaypoint.
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
    Internal Type: NamedWaypoint.
altitude One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
before A command token (internally upper-cased). Internal Type: str.
ADDWPT acidx, waypoint, altitude, airspeed, after
Python API

Insert a route waypoint after an existing waypoint.

acidx An existing aircraft callsign. Internal Type: int.
waypoint One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
    Internal Type: CoordinateWaypoint.
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
    Internal Type: NamedWaypoint.
altitude One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
after A command token (internally upper-cased). Internal Type: str.
ADDWPT acidx, waypoint, altitude, airspeed
Python API

Append a route waypoint with optional altitude and airspeed constraints.

Examples:

ADDWPT KL204 SPL FL250 250KT[CAS]
ADDWPT KL204 RTM,,250KT[CAS]
acidx An existing aircraft callsign. Internal Type: int.
waypoint One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
    Internal Type: CoordinateWaypoint.
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
    Internal Type: NamedWaypoint.
altitude One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
Optional; omission uses the callback default.

ADDWPTMODE

ADDWPTMODE acidx
Python API

Show the current waypoint insertion/fly-turn mode.

acidx An existing aircraft callsign. Internal Type: int.
ADDWPTMODE acidx, FLYBY|FLY-BY|FLYOVER|FLY-OVER|FLYTURN|FLY-TURN
Python API

Select FLYBY, FLYOVER, or FLYTURN waypoint mode.

acidx An existing aircraft callsign. Internal Type: int.
mode Accepted: FLYBY, FLY-BY, FLYOVER, FLY-OVER, FLYTURN, FLY-TURN. Internal Type: WaypointMode.
ADDWPTMODE acidx, TURNRAD|TURNRADIUS, value
Python API

Set the default fly-turn radius.

acidx An existing aircraft callsign. Internal Type: int.
value (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, > 0. Internal Type: float. Internal Unit: meter.
ADDWPTMODE acidx, TURNSPD|TURNSPEED, value
Python API

Set the default fly-turn CAS.

acidx An existing aircraft callsign. Internal Type: int.
value Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: > 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
ADDWPTMODE acidx, TURNHDG|TURNHDGR|TURNHDGRATE, value
Python API

Set the default fly-turn heading rate in degrees per second.

acidx An existing aircraft callsign. Internal Type: int.
value Constraints: > 0, finite. Internal Type: float. Internal Unit: degree · second⁻¹.
ADDWPTMODE acidx, TURNRAD|TURNRADIUS|TURNSPD|TURNSPEED|TURNHDG|TURNHDGR|TURNHDGRATE, OFF
Python API

Clear a route turn radius, CAS, or heading-rate default.

acidx An existing aircraft callsign. Internal Type: int.
parameter Accepted: TURNRAD, TURNRADIUS, TURNSPD, TURNSPEED, TURNHDG, TURNHDGR, TURNHDGRATE. Internal Type: TurnParameter.

AFTER

AFTER acidx, afterwp, ADDWPT, waypoint, alt, airspeed
Python API

Insert a waypoint after an existing route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
afterwp A command token (internally upper-cased). Internal Type: str.
waypoint One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
    Internal Type: CoordinateWaypoint.
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
    Internal Type: NamedWaypoint.
alt One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
Optional; omission uses the callback default.

ALT

ALT idx, alt, vspd
Python API

Select the autopilot altitude, optionally with a vertical speed.

Selecting an altitude disengages VNAV for this aircraft. When no vertical speed is given and the currently selected vertical speed opposes the required climb/descent direction, it is reset so the default vertical speed is used.

Examples:

ALT KL204 FL200 1500FT/MIN
idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
alt Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
vspd One of:
  • (e.g. 1500FT/MIN, 7.62MPS) Constraints: finite. Internal Type: float. Internal Unit: meter · second⁻¹.
  • None
Optional; omission uses the callback default.

ASAS

Aliases: CD, CDMETHOD

ASAS
Python API

Enable conflict detection.

ASAS enabled
Python API

Enable or disable conflict detection.

enabled True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.

AT

AT acidx, atwp
Python API

Show all constraints and stacked commands at a route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
AT acidx, atwp, ALT
Python API

Show the altitude constraint at a route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
AT acidx, atwp, SPD|SPEED
Python API

Show the airspeed constraint at a route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
AT acidx, atwp, DO|STACK
Python API

Show commands stacked at a route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
AT acidx, atwp, ALT, value
Python API

Set the altitude constraint at a route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
value Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
AT acidx, atwp, SPD|SPEED, value
Python API

Set the airspeed constraint at a route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
value One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
AT acidx, atwp, constraints
Python API

Set or clear the altitude/airspeed constraint pair at a route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
constraints (e.g. FL100/250KT[CAS], ---/M0.78, FL100/---) Internal Type: AtConstraints.
AT acidx, atwp, DEL|DELETE|CLR|CLEAR, ALT
Python API

Clear a waypoint altitude constraint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
AT acidx, atwp, DEL|DELETE|CLR|CLEAR, SPD|SPEED
Python API

Clear a waypoint airspeed constraint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
AT acidx, atwp, DEL|DELETE|CLR|CLEAR, BOTH
Python API

Clear waypoint altitude and airspeed constraints.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
AT acidx, atwp, DEL|DELETE|CLR|CLEAR, ALL
Python API

Clear all constraints and stacked commands at a waypoint.

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
AT acidx, atwp, DO|STACK, command_text
Python API

Store a command to execute when a route waypoint is passed.

Important

Note that we deliberately differ from bluesky in a subtle way. BlueSky supports an implicit-ownship shorthand. For example, BlueSky interprets HX2 AT WPT10 STACK ALT 95FT[STD] as though the deferred command were HX2 ALT 95FT[STD] (the HX2 target here is injected implicitly by bluesky)

Minisky intentionally does not infer or inject that aircraft target. Write the complete deferred command instead: HX2 AT WPT10 STACK HX2 ALT 95FT[STD] (or the equivalent command-first form HX2 AT WPT10 STACK ALT HX2 95FT[STD]).

The same rule applies to nested conditional commands. A BlueSky scenario line such as HX2 AT WPT9D STACK ATSPD 200KT[CAS] HX2 ALT 100FT[STD] should be HX2 AT WPT9D STACK HX2 ATSPD 200KT[CAS] HX2 ALT 100FT[STD] in minisky: the deferred ATSPD command must itself be complete.

See also:

acidx An existing aircraft callsign. Internal Type: int.
atwp A command token (internally upper-cased). Internal Type: str.
command_text Internal Type: str.

ATALT

ATALT acidx, targalt, cmdtxt
Python API

Schedule a command for when an aircraft crosses an altitude.

acidx An existing aircraft callsign. Internal Type: int.
targalt Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
cmdtxt Internal Type: str.

ATDIST

ATDIST acidx, position, targdist, cmdtxt
Python API

Schedule a command for crossing a distance.

acidx An existing aircraft callsign. Internal Type: int.
position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
targdist (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.
cmdtxt Internal Type: str.

ATSPD

ATSPD acidx, target, cmdtxt
Python API

Schedule a command for crossing an explicit CAS in m/s or Mach target.

acidx An existing aircraft callsign. Internal Type: int.
target One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
cmdtxt Internal Type: str.

BANK

Aliases: BANKLIM

BANK idx
Python API

Show the bank-angle limit for an aircraft or selection.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
BANK idx, bankangle
Python API

Set the bank-angle limit for an aircraft or selection.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
bankangle Constraints: > 0, finite, < 90. Internal Type: float. Internal Unit: degree.

BEFORE

BEFORE acidx, beforewp, ADDWPT, waypoint, alt, airspeed
Python API

Insert a waypoint before an existing route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
beforewp A command token (internally upper-cased). Internal Type: str.
waypoint One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
    Internal Type: CoordinateWaypoint.
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
    Internal Type: NamedWaypoint.
alt One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
Optional; omission uses the callback default.

BOX

BOX name, first, second, top, bottom
Python API

Define a box-shaped area from two opposite corners.

name A command token (internally upper-cased). Internal Type: str.
first One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
second One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
top One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.
bottom One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.

CIRCLE

CIRCLE name, center, radius, top, bottom
Python API

Define a circular area.

name A command token (internally upper-cased). Internal Type: str.
center One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
radius (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.
top One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.
bottom One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.

CLRCRECMD

CLRCRECMD
Python API

Clear the list of commands issued for newly created aircraft.

Remove all command lines previously added with CRECMD.

CRE

Aliases: CREATE

CRE callsign, actype, position, hdg, alt, airspeed
Python API

Create an aircraft.

Examples:

CRE KL204 B744 52.0 4.0 90 FL100 250KT[CAS]
CRE AF007 A359 SUGOL 180 FL360 M0.85
CRE KLM10 A320 EHAM/RW06 * 0FT[STD] 150KT[CAS]
callsign A command token (internally upper-cased). Internal Type: str.
actype A command token (internally upper-cased). Internal Type: str.
position A waypoint, airport, runway, aircraft, or coordinate expression resolved against navigation data and traffic. One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Types: LatLonDegrees or RunwayPosition.
hdg One of:
  • Heading relative to true north in degrees. (e.g. 090, 090T) Constraints: finite. Internal Type: TrueHeadingDeg. Internal Unit: degree.
  • Heading relative to magnetic north in degrees. (e.g. 090M) Constraints: finite. Internal Type: MagneticHeadingDeg. Internal Unit: degree.
  • The * literal, meaning derive the heading from another command argument. Accepted: *. Internal Type: RunwayHeadingRequest.
  • None
Optional; omission uses the callback default.
alt Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter. Optional; omission uses the callback default.
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
Optional; omission uses the callback default.

CRECMD

CRECMD
Python API

Show commands issued for every newly created aircraft.

CRECMD ?
Python API

Show commands issued for every newly created aircraft.

CRECMD cmdline
Python API

Add a command to issue for every newly created aircraft.

cmdline Internal Type: str.

CRECONFS

CRECONFS callsign, actype, targetidx, dpsi, dcpa, tlosh, dH, tlosv, airspeed
Python API

Create an aircraft in conflict with a target aircraft.

The intruder position, track and airspeed are computed such that, relative to the target aircraft, separation is lost after the given time with the given distance at the closest point of approach. The protected-zone radius and height from the config (asas_pzr, asas_pzh) are taken into account. Omitting the vertical offset creates a level conflict; omitted vertical LoS time defaults to the horizontal LoS time, and omitted airspeed uses the ownship ground speed.

callsign Callsign of the new intruder. A command token (internally upper-cased). Internal Type: str.
actype Aircraft type of the new intruder. A command token (internally upper-cased). Internal Type: str.
targetidx Ownship aircraft index. An existing aircraft callsign. Internal Type: int.
dpsi Angle between ownship and intruder tracks. Constraints: finite. Internal Type: float. Internal Unit: degree.
dcpa Requested horizontal separation at CPA. (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.
tlosh Time until horizontal loss of separation. (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
dH Initial vertical offset; None creates a level conflict. One of:
  • (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite. Internal Type: float. Internal Unit: meter.
  • None
Optional; omission uses the callback default.
tlosv Time until vertical loss of separation; defaults to tlosh. One of:
  • (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
  • None
Optional; omission uses the callback default.
airspeed Explicit intruder CAS/Mach; omitted uses ownship ground speed. One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
Optional; omission uses the callback default.

DATE

DATE
Python API

Report the current simulation UTC timestamp.

DATE day, month, year
Python API

Set the calendar date at midnight UTC.

day Constraints: >= 1, <= 31. Internal Type: int.
month Constraints: >= 1, <= 12. Internal Type: int.
year Constraints: >= 1. Internal Type: int.
DATE day, month, year, time
Python API

Set the calendar date and UTC time.

day Constraints: >= 1, <= 31. Internal Type: int.
month Constraints: >= 1, <= 12. Internal Type: int.
year Constraints: >= 1. Internal Type: int.
time (e.g. 12:34:56, 12:34:56.123456) Internal Type: time.

DEFWPT

DEFWPT name
Python API

Inspect a scenario-specific waypoint or report that its name is available.

name A command token (internally upper-cased). Internal Type: str.
DEFWPT name, DEL|DELETE
Python API

Delete a scenario-specific waypoint.

name A command token (internally upper-cased). Internal Type: str.
DEFWPT name, position
Python API

Define a scenario-specific waypoint from a position.

Examples:

DEFWPT MYWPT 52.3 4.7
name A command token (internally upper-cased). Internal Type: str.
position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
DEFWPT name, position, DEL|DELETE
Python API

Delete a waypoint from the DEFWPT name,position,DEL form.

name A command token (internally upper-cased). Internal Type: str.
position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
DEFWPT name, position, waypoint_type
Python API

Define a scenario-specific waypoint with an explicit waypoint type.

name A command token (internally upper-cased). Internal Type: str.
position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
waypoint_type A command token (internally upper-cased). Internal Type: str.

DEL

Aliases: DELETE

DEL target, additional_targets
Python API

Delete an element (aircraft, wind field, area shape, or group).

DEL = "DEL" ( "WIND" | area-name | group-name
              | selection { selection } ) ;
selection = aircraft-id | group-name | "*" | "ALL" ;

A sole stored group deletes its member aircraft and releases the group, matching BlueSky. In a multi-selection form a group expands to aircraft but the group definition remains.

target A command token (internally upper-cased). Internal Type: str.
additional_targets A command token (internally upper-cased). Internal Type: str. Optional; omission uses the callback default. Repeatable.

DELAY

DELAY time, cmdline
Python API

Delay a stack command by a time interval.

Like schedule, but the given time is relative to the current simulation time.

time (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
cmdline Internal Type: str.

DELRTE

Aliases: DELROUTE

DELRTE
Python API

Delete the route when a single aircraft exists.

DELRTE acidx
Python API

Delete an aircraft route.

acidx An existing aircraft callsign. Internal Type: int.

DELWPT

Aliases: DELWP

DELWPT acidx, *
Python API

Delete the complete route using BlueSky's DELWPT callsign,* form.

acidx An existing aircraft callsign. Internal Type: int.
DELWPT acidx, wpname
Python API

Delete a waypoint from an aircraft route.

acidx An existing aircraft callsign. Internal Type: int.
wpname A command token (internally upper-cased). Internal Type: str.

DEST

DEST acidx
Python API

Show the destination of an aircraft.

acidx An existing aircraft callsign. Internal Type: int.
DEST acidx, waypoint, airspeed
Python API

Set the destination with an optional CAS in m/s or Mach constraint.

acidx An existing aircraft callsign. Internal Type: int.
waypoint One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
    Internal Type: CoordinateWaypoint.
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
    Internal Type: NamedWaypoint.
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
Optional; omission uses the callback default.

DIRECT

Aliases: DCT, DIRECTTO, DIRTO

DIRECT acidx, wpname
Python API

Fly an aircraft directly to a waypoint in its route.

acidx An existing aircraft callsign. Internal Type: int.
wpname A command token (internally upper-cased). Internal Type: str.

DTLOOK

DTLOOK
Python API

Report the default conflict-detection lookahead.

DTLOOK time
Python API

Set the default conflict-detection lookahead.

time (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
DTLOOK time, first, additional
Python API

Set conflict-detection lookahead for selected aircraft.

time (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
first An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
additional An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray. Optional; omission uses the callback default. Repeatable.

DTMULT

Aliases: RTF

DTMULT mult
Python API

Set the simulation speed multiplier.

The loop targets a simulation step every simdt / speed wall-clock seconds, so a larger multiplier makes simulated time advance faster relative to the wall clock.

mult Constraints: > 0, finite. Internal Type: float.

DTNOLOOK

DTNOLOOK
Python API

Report the default post-resolution no-look interval.

DTNOLOOK time
Python API

Set the default post-resolution no-look interval.

time (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
DTNOLOOK time, first, additional
Python API

Set the post-resolution no-look interval for selected aircraft.

time (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
first An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
additional An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray. Optional; omission uses the callback default. Repeatable.

ECHO

Aliases: PRINT

ECHO text
Python API

Print a console message.

The message goes to stdout with prefix, and to every callback registered with subscribe. It also overwrites output_buffer, so an earlier message read_output_buffer has not drained yet is lost.

text Message to echo; each line is printed separately. Internal Type: str.

GETWIND

GETWIND position, alt
Python API

Report wind at an aviation position and optional altitude.

position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
alt One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.

GROUP

GROUP
Python API

List all stored traffic groups.

GROUP groupname
Python API

List the aircraft in a traffic group.

groupname A command token (internally upper-cased). Internal Type: str.
GROUP groupname, first_member, additional_members
Python API

Create or extend a traffic group from selections or an area.

groupname A command token (internally upper-cased). Internal Type: str.
first_member A command token (internally upper-cased). Internal Type: str.
additional_members A command token (internally upper-cased). Internal Type: str. Optional; omission uses the callback default. Repeatable.

HDG

Aliases: HEADING, TURN

HDG idx, hdg
Python API

Select the autopilot heading.

When a wind field is defined and the aircraft is airborne (above 50 ft), the commanded track is computed from the given heading and the local wind; otherwise track equals heading. Selecting a heading disengages LNAV for this aircraft.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
hdg One of:
  • Heading relative to true north in degrees. (e.g. 090, 090T) Constraints: finite. Internal Type: TrueHeadingDeg. Internal Unit: degree.
  • Heading relative to magnetic north in degrees. (e.g. 090M) Constraints: finite. Internal Type: MagneticHeadingDeg. Internal Unit: degree.

HELP

Aliases: ?

HELP cmd
Python API

Show help for a command.

cmd A command token (internally upper-cased). Internal Type: str.

HOLD

Aliases: PAUSE

HOLD
Python API

Set simulation state to HOLD.

Pauses the advance of simulation time and triggers the plugin hold hooks. Stack commands are still processed while holding, so the simulation can be resumed with the OP command.

IC

Aliases: LOAD, OPEN

IC scn
Python API

Load a scenario file.

Resets the simulation, reads the scenario file relative to the project root, and buffers its timestamped commands for execution when the simulation time passes their timestamps.

scn Internal Type: str.

LINE

LINE name, start, end
Python API

Draw a line between two positions.

name A command token (internally upper-cased). Internal Type: str.
start One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
end One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.

LISTRTE

LISTRTE acidx, ipagetxt
Python API

Show an aircraft route in the console.

acidx An existing aircraft callsign. Internal Type: int.
ipagetxt A command token (internally upper-cased). Internal Type: str. Optional; omission uses the callback default.

LNAV

LNAV idx
Python API

Show LNAV state for an aircraft or selection.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
LNAV idx, flag
Python API

Enable or disable LNAV for an aircraft or selection.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
flag True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.

LSVAR

LSVAR
Python API

List registered variable parents.

LSVAR varname
Python API

Show information about a simulation variable.

varname A non-empty command field. Spaces or commas terminate bare fields, surrounding quotes are removed. Internal Type: str.

MAGVAR

Aliases: MAGDEC, MAGDECL, VAR

MAGVAR position
Python API

Show magnetic variation at an aviation position.

position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.

MCRE

MCRE n, lat_min, lon_min, lat_max, lon_max, actype, acalt, airspeed
Python API

Create multiple aircraft at random positions in a lat/lon box.

Callsigns are generated randomly (two letters plus a sequence number). Heading is drawn uniformly from 1-360 deg; when not given, altitude is drawn from 2000-39000 ft and calibrated airspeed from 250-450 kts. The default area is the North Sea region.

n Constraints: > 0. Internal Type: int.
lat_min (e.g. 52.5, N52'30') Constraints: finite, >= -90, <= 90. Internal Type: float. Internal Unit: degree. Optional; omission uses the callback default.
lon_min (e.g. 4.5, E004'30') Constraints: finite, >= -180, <= 180. Internal Type: float. Internal Unit: degree. Optional; omission uses the callback default.
lat_max (e.g. 52.5, N52'30') Constraints: finite, >= -90, <= 90. Internal Type: float. Internal Unit: degree. Optional; omission uses the callback default.
lon_max (e.g. 4.5, E004'30') Constraints: finite, >= -180, <= 180. Internal Type: float. Internal Unit: degree. Optional; omission uses the callback default.
actype A command token (internally upper-cased). Internal Type: str. Optional; omission uses the callback default.
acalt One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
Optional; omission uses the callback default.

MOVE

MOVE idx, position, alt, hdg, airspeed, vspd
Python API

Instantaneously move an aircraft to a new position/state.

Optional state values are left unchanged when omitted. Setting a vertical speed disengages VNAV.

idx An existing aircraft callsign. Internal Type: int.
position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
alt New altitude; also becomes the selected altitude. One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.
hdg New heading; also becomes the autopilot track command. One of:
  • Heading relative to true north in degrees. (e.g. 090, 090T) Constraints: finite. Internal Type: TrueHeadingDeg. Internal Unit: degree.
  • Heading relative to magnetic north in degrees. (e.g. 090M) Constraints: finite. Internal Type: MagneticHeadingDeg. Internal Unit: degree.
  • None
Optional; omission uses the callback default.
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.
  • None
Optional; omission uses the callback default.
vspd New vertical speed; setting it disengages VNAV. One of:
  • (e.g. 1500FT/MIN, 7.62MPS) Constraints: finite. Internal Type: float. Internal Unit: meter · second⁻¹.
  • None
Optional; omission uses the callback default.

NOISE

NOISE
Python API

Report trajectory-noise state.

NOISE noise
Python API

Enable or disable trajectory and surveillance noise.

noise True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.

NORESO

NORESO
Python API

Show aircraft that nobody will avoid.

NORESO first, additional
Python API

Toggle the nobody-avoids flag for selected aircraft.

first An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
additional An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray. Optional; omission uses the callback default. Repeatable.

OP

Aliases: CONTINUE, RUN, START

Set simulation state to OPERATE.

Resumes (or starts) advancing simulation time. Also re-anchors the system time reference syst to the current wall-clock time plus one simulation step.

ORIG

ORIG acidx
Python API

Show the origin of an aircraft.

acidx An existing aircraft callsign. Internal Type: int.
ORIG acidx, waypoint
Python API

Set the origin of an aircraft.

acidx An existing aircraft callsign. Internal Type: int.
waypoint One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
    Internal Type: CoordinateWaypoint.
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
    Internal Type: NamedWaypoint.

PERFSTATS

Aliases: PERFDATA, PERFINFO

PERFSTATS acidx
Python API

Report the current performance state of an aircraft.

Includes flight phase, thrust, drag, fuel flow, speed and vertical-speed envelopes, and ceiling in aviation units (kN, kg/s, kts, fpm, ft).

acidx An existing aircraft callsign. Internal Type: int.

PLUGINS

Aliases: PLUG-IN, PLUG-INS, PLUGIN, SIMPLUGIN

PLUGINS
Python API

List loaded and available plugins.

PLUGINS LIST
Python API

List loaded and available plugins.

PLUGINS LOAD, plugin_name
Python API

Load a plugin by name.

plugin_name A command token (internally upper-cased). Internal Type: str.
PLUGINS plugin_name
Python API

Load a plugin by name.

plugin_name A command token (internally upper-cased). Internal Type: str.

POLY

Aliases: POLYGON

POLY name, points
Python API

Define a polygon from position vertices.

name A command token (internally upper-cased). Internal Type: str.
points One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees. Optional; omission uses the callback default. Repeatable.

POLYALT

POLYALT name, top, bottom, first, additional
Python API

Define a polygon between top and bottom altitudes.

name A command token (internally upper-cased). Internal Type: str.
top Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
bottom Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
first One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
additional One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees. Optional; omission uses the callback default. Repeatable.

POLYLINE

Aliases: LINES, POLYLINES

POLYLINE name, first, additional
Python API

Draw a multi-segment line through position vertices.

name A command token (internally upper-cased). Internal Type: str.
first One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
additional One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees. Optional; omission uses the callback default. Repeatable.

POS

Aliases: AIRPORT, AIRWAY, AIRWAYS, AWY, RUNWAYS

POS name
Python API

Show information on an aircraft, airport, waypoint or navaid.

name A command token (internally upper-cased). Internal Type: str.

PRIORULES

PRIORULES
Python API

Show priority-rule support and state.

PRIORULES flag, FF1|FF2|FF3|LAY1|LAY2
Python API

Enable or disable priority rules using a selected rule code.

flag True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.
priority_code Accepted: FF1, FF2, FF3, LAY1, LAY2. Internal Type: str.

QUIT

Aliases: CLOSE, END, EXIT, Q, STOP

QUIT
Python API

Stop the simulation.

Sets the simulation state to END and asks the runner to exit its loop. If the runner was configured with minisky.Runner.prevent_shutdown, the loop keeps running and only the state changes.

REALTIME

Aliases: RT

REALTIME
Python API

Report realtime mode.

REALTIME flag
Python API

Enable or disable realtime mode.

flag True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.

RESET

RESET
Python API

Reset all simulation objects (stack RESET command).

Returns the simulation to its initial state: simulation time back to 0 s, timestep back to 1 s, the simulated UTC clock to today at 00:00:00, and all traffic, stack, navigation database, area filters, console output, replaceable entities (autopilot, performance models, etc.) and plugin timers/hooks reset to their defaults.

RESO

RESO
Python API

Show the current and available conflict-resolution methods.

RESO OFF
Python API

Disable conflict resolution.

RESO MVP
Python API

Select and enable MVP conflict resolution.

RESOOFF

RESOOFF
Python API

Show aircraft that perform no resolution manoeuvres.

RESOOFF first, additional
Python API

Toggle resolution manoeuvres for selected aircraft.

first An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
additional An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray. Optional; omission uses the callback default. Repeatable.

RFACH

Aliases: HRESOFAC, HRFAC, RESOFACH

RFACH
Python API

Show the horizontal resolution factor.

RFACH factor
Python API

Set the horizontal resolution factor.

factor Constraints: > 0, finite. Internal Type: float.

RFACV

Aliases: RESOFACV

RFACV
Python API

Show the vertical resolution factor.

RFACV factor
Python API

Set the vertical resolution factor.

factor Constraints: > 0, finite. Internal Type: float.

RMETHH

RMETHH
Python API

Show horizontal resolution-method settings.

RMETHH BOTH|SPD|HDG|NONE|ON|OFF|OF
Python API

Configure horizontal resolution degrees of freedom.

value Accepted: BOTH, SPD, HDG, NONE, ON, OFF, OF. Internal Type: str.

RMETHV

RMETHV
Python API

Show vertical resolution-method settings.

RMETHV NONE|ON|OFF|OF|V/S
Python API

Configure vertical resolution degrees of freedom.

value Accepted: NONE, ON, OFF, OF, V/S. Internal Type: str.

RSZONEDH

Aliases: RESOZONEDH

RSZONEDH
Python API

Show the absolute vertical resolution zone.

RSZONEDH zonedh
Python API

Set the absolute vertical resolution-zone height.

zonedh (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.

RSZONER

Aliases: RESOZONER

RSZONER
Python API

Show the absolute horizontal resolution zone.

RSZONER zoner
Python API

Set the absolute horizontal resolution-zone radius.

zoner (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.

RTA

RTA acidx, wpname, time
Python API

Set a required time of arrival at a route waypoint.

acidx An existing aircraft callsign. Internal Type: int.
wpname A command token (internally upper-cased). Internal Type: str.
time (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.

SCENARIO

Aliases: SCEN

SCENARIO name
Python API

Set the scenario name for the current simulation.

name Internal Type: str.

SCHEDULE

SCHEDULE time, cmdline
Python API

Schedule a stack command at a specific simulation time.

The command is inserted into the scenario buffer, keeping the buffer sorted by execution time.

time (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
cmdline Internal Type: str.

SEED

SEED value
Python API

Set the random seed for this simulation (stack SEED command).

Seeds this runtime's Python and NumPy generators so stochastic scenario elements are reproducible without affecting other runtimes.

value Internal Type: int.

SELECTIMPL

Aliases: IMPL, IMPLEMENT, IMPLEMENTATION

SELECTIMPL
Python API

List replaceable classes.

SELECTIMPL basename
Python API

Show the current and available implementations for a replaceable.

basename A command token (internally upper-cased). Internal Type: str.
SELECTIMPL basename, implname
Python API

Select an implementation for a replaceable class.

basename A command token (internally upper-cased). Internal Type: str.
implname A command token (internally upper-cased). Internal Type: str.

SPD

Aliases: SPEED

SPD idx, airspeed
Python API

Select CAS in m/s or Mach explicitly.

Examples:

SPD KL204 250KT[CAS]
SPD KL204 M0.78
idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
airspeed One of:
  • Calibrated airspeed normalized to metres per second. (e.g. 250KT[CAS], 128MPS[CAS]) Constraints: >= 0, finite. Internal Type: CasMps. Internal Unit: meter · second⁻¹.
  • Mach number. (e.g. M0.78, M.78) Constraints: > 0, finite. Internal Type: Mach.

SWTOC

SWTOC idx
Python API

Show Top-of-Climb state for an aircraft or selection.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
SWTOC idx, flag
Python API

Enable or disable Top-of-Climb logic.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
flag True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.

SWTOD

SWTOD idx
Python API

Show Top-of-Descent state for an aircraft or selection.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
SWTOD idx, flag
Python API

Enable or disable Top-of-Descent logic.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
flag True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.

THR

THR idx
Python API

Report autothrottle state and fixed throttle when applicable.

idx An existing aircraft callsign. Internal Type: int.
THR idx, AUTO|OFF
Python API

Enable autothrottle.

idx An existing aircraft callsign. Internal Type: int.
THR idx, IDLE
Python API

Disable autothrottle and select idle thrust.

idx An existing aircraft callsign. Internal Type: int.
THR idx, throttle
Python API

Disable autothrottle and set a fixed throttle fraction.

idx An existing aircraft callsign. Internal Type: int.
throttle (e.g. 0.8, 80%) Constraints: >= 0, finite, <= 1. Internal Type: float.

TIME

TIME
Python API

Report the current simulation UTC timestamp.

TIME RUN
Python API

Set simulation UTC to the start of the current UTC day.

TIME REAL
Python API

Set simulation UTC from the current local wall clock.

TIME UTC
Python API

Set simulation UTC from the current UTC wall clock.

TIME time
Python API

Set only the time-of-day, preserving BlueSky's 1900-01-01 date behavior.

time (e.g. 12:34:56, 12:34:56.123456) Internal Type: time.

UNGROUP

UNGROUP groupname, first_member, additional_members
Python API

Remove several selections from a stored group.

groupname A command token (internally upper-cased). Internal Type: str.
first_member A command token (internally upper-cased). Internal Type: str.
additional_members A command token (internally upper-cased). Internal Type: str. Optional; omission uses the callback default. Repeatable.

VNAV

VNAV idx
Python API

Show VNAV state for an aircraft or selection.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
VNAV idx, flag
Python API

Enable or disable VNAV for an aircraft or selection.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
flag True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.

VS

VS idx, vspd
Python API

Select the autopilot vertical speed.

Setting a vertical speed disengages VNAV for this aircraft.

idx An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
vspd (e.g. 1500FT/MIN, 7.62MPS) Constraints: finite. Internal Type: float. Internal Unit: meter · second⁻¹.

WIND

WIND position, DEL|DELETE
Python API

Clear wind defined at a position.

position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
WIND position, direction, speed
Python API

Define altitude-independent wind.

Examples:

WIND 52 4 270 20KT
position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
direction Constraints: finite. Internal Type: float. Internal Unit: degree.
speed (e.g. 10MPS, 600FT/MIN, 20KT, 90KMH) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter · second⁻¹.
WIND position, _omitted, direction, speed
Python API

Define constant wind with an omitted altitude.

Examples:

WIND 52 4,,270 20KT
position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
direction Constraints: finite. Internal Type: float. Internal Unit: degree.
speed (e.g. 10MPS, 600FT/MIN, 20KT, 90KMH) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter · second⁻¹.
WIND position, first, additional
Python API

Define altitude-dependent wind vectors.

Examples:

WIND 52 4 FL050 270 20KT FL100 300 30KT
position One of:
  • All of:
    • latitude (e.g. 52.5, N52'30')
    • longitude (e.g. 4.5, E004'30')
  • All of:
    • waypoint (e.g. SUGOL, EHAM, EHAM/RW06)
Internal Type: LatLonDegrees.
first All of:
  • altitude (e.g. FL100, 10000FT[STD], 3048M[STD])
  • direction (e.g. 270)
  • speed (e.g. 10MPS, 600FT/MIN, 20KT, 90KMH)
Internal Type: WindLevel.
additional All of:
  • altitude (e.g. FL100, 10000FT[STD], 3048M[STD])
  • direction (e.g. 270)
  • speed (e.g. 10MPS, 600FT/MIN, 20KT, 90KMH)
Internal Type: WindLevel. Optional; omission uses the callback default. Repeatable.

ZONEDH

Aliases: DHPZ, PZDH, PZHEIGHT

ZONEDH
Python API

Report the default protected-zone half-height.

ZONEDH height
Python API

Set the default protected-zone half-height.

height (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.
ZONEDH height, first, additional
Python API

Set the protected-zone half-height for selected aircraft.

height (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.
first An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
additional An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray. Optional; omission uses the callback default. Repeatable.

ZONER

Aliases: PZR, PZRADIUS, RPZ

ZONER
Python API

Report the default protected-zone radius.

ZONER radius
Python API

Set the default protected-zone radius.

radius (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.
ZONER radius, first, additional
Python API

Set the protected-zone radius for selected aircraft.

radius (e.g. 5NM, 9.26KM, 9260M, 3000FT) Constraints: finite, >= 0. Internal Type: float. Internal Unit: meter.
first An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray.
additional An aircraft, traffic group, or */ALL, resolved to traffic indices. (e.g. *, ALL) Internal Type: ndarray. Optional; omission uses the callback default. Repeatable.

example

PASSENGERS

PASSENGERS index
Python API

Show the number of passengers on an aircraft.

index An existing aircraft callsign. Internal Type: int.
PASSENGERS index, count
Python API

Set the number of passengers on an aircraft.

index An existing aircraft callsign. Internal Type: int.
count Constraints: >= 0, <= 500. Internal Type: int.

multicopter

BATT

BATT idx
Python API

Report the battery state of charge, power draw and endurance.

idx An existing aircraft callsign. Internal Type: int.

HOVER

HOVER idx, duration, alt
Python API

Hold position, optionally for a fixed time at a given altitude.

Suspends LNAV/VNAV, commands zero ground speed, and holds the given altitude (the current one when omitted) — with an altitude the aircraft moves there vertically, at a fixed position. With a duration, the route resumes once position and altitude have been held that long; without one, the aircraft hovers until LNAV is re-engaged. Repeating the command while hovering updates the hold time and altitude, and a plain ALT command changes the hover altitude as well.

idx An existing aircraft callsign. Internal Type: int.
duration One of:
  • (e.g. 90, 01:30, 01:02:03) Constraints: >= 0, finite. Internal Type: float. Internal Unit: second.
  • None
Optional; omission uses the callback default.
alt One of:
  • Barometric pressure altitude on the standard-pressure reference. (e.g. FL100, 10000FT[STD], 3048M[STD]) Constraints: finite. Internal Type: StdPressureAltM. Internal Unit: meter.
  • None
Optional; omission uses the callback default.

MCOPT

MCOPT idx
Python API

Report whether multicopter behavior is enabled for an aircraft.

idx An existing aircraft callsign. Internal Type: int.
MCOPT idx, flag
Python API

Enable or disable multicopter behavior for an aircraft.

idx An existing aircraft callsign. Internal Type: int.
flag True: TRUE, YES, Y, 1, ON. False: FALSE, NO, N, 0, OFF. Internal Type: bool.

YAW

YAW idx, hdg
Python API

Command the body heading (nose direction) of a multicopter.

The velocity vector keeps following the track command from the FMS or conflict resolution, so this rotates the aircraft in place.

idx An existing aircraft callsign. Internal Type: int.
hdg One of:
  • Heading relative to true north in degrees. (e.g. 090, 090T) Constraints: finite. Internal Type: TrueHeadingDeg. Internal Unit: degree.
  • Heading relative to magnetic north in degrees. (e.g. 090M) Constraints: finite. Internal Type: MagneticHeadingDeg. Internal Unit: degree.

YAWRATE

YAWRATE idx
Python API

Report the maximum yaw rate of a multicopter.

idx An existing aircraft callsign. Internal Type: int.
YAWRATE idx, yawrate
Python API

Set the maximum yaw rate of a multicopter.

idx An existing aircraft callsign. Internal Type: int.
yawrate Constraints: > 0, finite. Internal Type: float. Internal Unit: degree · second⁻¹.

tangram

TANGRAM

TANGRAM
Python API

Show the status of the tangram Redis bridge.