API Documentation

The best way to get started with JetScript is the creating a new plugin tutorial.

Articles

• Getting started: creating a new plugin: How to organize files, and find
• Example plugin: fetching data: Make a simple plugin that fetches METARs from the internet and presents them to the user.
• Converting an existing aircraft: basics: With an example Laminar aircraft, we show how common Lua idioms can be translated into Javascript.
• Converting an existing aircraft: performance: With JetScript's API, code can be written more efficiently, yielding better framerates. See how, in this walkthrough with an existing Laminar aircraft.

Objects

• The simulator object is the primary interface to the simulator, and to obtaining resources like commands and datarefs.
• Dataref objects are used to access values read and write values used by the simulator and other plugins.
• Command objects signal the beginning or end of discrete events.
• Plugin objects represents plugins in the simulator.
• Timers are used to schedule events in the future.

Functions

Fetch:

• fetch() fetches a resource from the web.

UI Prompts:

• alert() is the standard alert window, just as in a web browser.
• confirm() is the standard confirmation window, just as in a web browser.
• prompt() is the standard prompt window, just as in a web browser.

Callbacks / timers:

• setInterval() creates a recurring timer event.
• setTimeout() creates a one-time timer event.
• clearInterval() cancels a recurring timer event.
• clearTimeout() cancels a one-time timer event.

Other plugin toolkits / runtimes

Here are other similar resources for X-Plane. While JetScript aims to eventually surpass these options in terms of functionality and performance, they may be better options for now!

• XLua (Docs • Github) - Ultra-Minimal Lua Plugin for X-Plane. Used for many of Laminar's default aircraft.
• Gizmo (Docs • Github) - A Lua SDK for plugins.
• SASL (Docs v2 • Docs v3) - a scripting plugin for X-Plane which connects Lua scripts and runs them in a virtual machine.
• XPLM (Docs) - X-Plane's native C-API SDK for plugins.