Editor setup

In the game: Rhai Studio

Rhai Studio is an editor inside the game: syntax colors, Ctrl+S saves and reloads, errors above the editor, a new-mod wizard, and a console that runs Rhai against the live game. Install it like any mod and press F9.

On your desktop: definitions for autocomplete

Oxidizer describes everything scripts can use in Rhai definition files, written to:

<game documents>/oxidizer/definitions/
├── ksa.d.rhai          the game's modules: ksa::Program::controlled_vehicle(), ...
├── __static__.d.rhai   game object members (v.id, v.get_surface_speed()) and Oxidizer's own functions
└── ...                 Rhai's built-in functions

They are rewritten whenever the game or Oxidizer updates. Each entry has its types, as scripts see them (int, float, bool, String, or a game type), and which game types have each member:

/// `KSA.Universe.SetSimulationSpeed`
fn set_simulation_speed(simulationSpeed: float, alert: bool) -> ();

/// the game method `GetBarometricAltitude` on Vehicle
fn get_barometric_altitude(obj: Obj) -> float;

To use them, open your mod's folder in an editor with Rhai support and add the definitions folder to the workspace. In Visual Studio Code, install a Rhai extension (search the marketplace for "Rhai") and use File > Add Folder to Workspace... with the definitions folder.

Even without autocomplete, the files are a searchable list of everything in the game: search them for a word like throttle to find what you can call.