Skip to content
X4 Modding Wiki

API Reference

The API reference is organized by abstractions — the things a modder needs to interact with when writing a mod.

When you have a question like:

  • “How do I change ownership of a ship?” → look up Ship
  • “How do I list stations in a sector?” → look up Sector
  • “How do I react when a station is destroyed?” → look up Station (Events section)

You’ll find: description, properties, actions, libraries, events, examples, gotchas, related abstractions.

Categories

Section titled “Categories”

🌌 World

Section titled “🌌 World”

The spatial hierarchy where everything exists — Universe → Cluster → Sector → Zone, plus Highway and Gate.

🚀 Object types

Section titled “🚀 Object types”

Things that exist in the world — Station (and its 8 subtypes), Ship, Module, Resource region.

🏴 Factions

Section titled “🏴 Factions”

Who owns and controls things — Faction (parent), Player, NPC factions, Crew.

💰 Economy

Section titled “💰 Economy”

Ware, Trade offer, Subscription, Inventory, Cargo.

🎯 Behavior

Section titled “🎯 Behavior”

What objects do — Order, Mission, Conversation, Boarding operation.

⚙️ MD Framework

Section titled “⚙️ MD Framework”

How a mod’s code talks to the game — Cue, Library, Action, Condition (event), Expression.

🤖 Aiscript Framework

Section titled “🤖 Aiscript Framework”

How NPC behavior is defined — Order definition, Interrupt, Attention.

📦 Data layer

Section titled “📦 Data layer”

Assets and XML schemas — Macro, Component, god.xml, stationgroups.xml.

🖥️ UI / Lua

Section titled “🖥️ UI / Lua”

Player-facing UI — Helper API, Globals, third-party APIs (SN Mod Support APIs).

Prototype status

Section titled “Prototype status”

Currently filled: the Station page is the only fully-populated entry. Other pages are placeholders to demonstrate the navigation structure.