Skip to content

API reference

All available methods, events, and properties for scripting in radarcontrol.io.

Sandbox

Your code runs in a sandboxed environment. Only the documented APIs below are available.

Conventions

Method chaining

All aircraft control methods return this, so you can chain clearances:

javascript
aircraft.climb(fl(350)).speed(420).direct("KMART");

Case-insensitive identifiers

Waypoint names, callsigns, and other identifiers are case-insensitive:

javascript
aircraft.direct("kmart");  // Same as "KMART"
traffic.byCallsign("aal123");  // Same as "AAL123"

Named parameters

Most methods that take multiple arguments also accept a single object with named parameters:

javascript
// Positional
aircraft.hold("MERIT", { legNm: 8, turn: "L" });

// Named
aircraft.hold({ fix: "MERIT", legNm: 8, turn: "L" });

API sections

  • Event handlers - onTick, onSpawn, onConflict, approach events, handoff events, procedure events
  • Aircraft control - Clearance methods (climb, descend, speed, direct, hold, etc.) and aircraft properties
  • Traffic management - Query aircraft in your sector
  • Weather - Wind, weather cells, deviation requests
  • Context objects - Sectors, fixes, and procedures APIs
  • Datatypes - Vec2, WakeCat, ConflictAdvisories, ResolutionAdvisory, Emergency, Procedure
  • Utility functions - distance(), headingTo(), fl(), log()
  • Emergency - Emergency declaration, update, and resolution events
  • TTS - Text-to-speech for radio communications
  • Examples - Tips, best practices, and complete example scripts