tfs/IL-2-Cliffs-of-Dover
tfs/IL-2-Cliffs-of-Dover
1
0
Wiki

Update Mission Script API

Bruno Carneiro 2026-02-13 20:29:50 +00:00
parent f9a9790379
commit 9f8c10a7bd
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Mission-Script-API.md

@ -2,7 +2,7 @@
This folder documents the API available to mission scripts. Mission scripts derive from `AMission` and are loaded by the game at runtime. This folder documents the API available to mission scripts. Mission scripts derive from `AMission` and are loaded by the game at runtime.
Mission scripts also use additional types such as `LimbNames`, `NamedDamageTypes`, `Point2d`, and `Point3d`; those are summarized in [external-types.md](external-types.md). Mission scripts also use additional types such as `LimbNames`, `NamedDamageTypes`, `Point2d`, and `Point3d`; those are summarized in [external-types](external-types).
## How mission scripts are loaded ## How mission scripts are loaded
@ -16,25 +16,25 @@ Mission scripts also use additional types such as `LimbNames`, `NamedDamageTypes
| Document | Description | | Document | Description |
|----------|-------------| |----------|-------------|
| [01-mission-and-battle.md](01-mission-and-battle.md) | **AMission**, **ABattle**, **IBattle**, **DoTimeout** | | [01-mission-and-battle](01-mission-and-battle) | **AMission**, **ABattle**, **IBattle**, **DoTimeout** |
| [02-gameplay.md](02-gameplay.md) | **IGamePlay** — main interface to the game (actors, HUD, triggers, section files, etc.) | | [02-gameplay](02-gameplay) | **IGamePlay** — main interface to the game (actors, HUD, triggers, section files, etc.) |
| [03-time-and-difficulty.md](03-time-and-difficulty.md) | **ITime**, **DifficultySetting** | | [03-time-and-difficulty](03-time-and-difficulty) | **ITime**, **DifficultySetting** |
| [04-player.md](04-player.md) | **Player** | | [04-player](04-player) | **Player** |
| [05-events-and-section-file.md](05-events-and-section-file.md) | **GameEventId**, **ISectionFile** | | [05-events-and-section-file](05-events-and-section-file) | **GameEventId**, **ISectionFile** |
| [06-pathfinding-and-terrain.md](06-pathfinding-and-terrain.md) | **RecalcPathState**, **PathType**, **LandTypes**, **IRecalcPathParams**, **ActorName** | | [06-pathfinding-and-terrain](06-pathfinding-and-terrain) | **RecalcPathState**, **PathType**, **LandTypes**, **IRecalcPathParams**, **ActorName** |
| [07-script-loading.md](07-script-loading.md) | **IScriptRemote**, **ScriptRemote** | | [07-script-loading](07-script-loading) | **IScriptRemote**, **ScriptRemote** |
| [external-types.md](external-types.md) | Additional types used by missions (limbs, damage, geometry) | | [external-types](external-types) | Additional types used by missions (limbs, damage, geometry) |
### World ### World
| Document | Description | | Document | Description |
|----------|-------------| |----------|-------------|
| [world/README.md](world/README.md) | Index of world types | | [world-README](world-README) | Index of world types |
| [world/01-actor-hierarchy.md](world/01-actor-hierarchy.md) | **AiActor**, **AiPerson**, **AiCart**, **AiGroup**, damage types, **CrewFunction** | | [world-01-actor-hierarchy](world-01-actor-hierarchy) | **AiActor**, **AiPerson**, **AiCart**, **AiGroup**, damage types, **CrewFunction** |
| [world/02-air.md](world/02-air.md) | **AiAircraft**, **AiAirGroup**, air waypoints, enums, **EnemyAirInterf** | | [world-02-air](world-02-air) | **AiAircraft**, **AiAirGroup**, air waypoints, enums, **EnemyAirInterf** |
| [world/03-ground.md](world/03-ground.md) | **AiGroundActor**, **GroundStationary**, buildings, bomb explosion, enums | | [world-03-ground](world-03-ground) | **AiGroundActor**, **GroundStationary**, buildings, bomb explosion, enums |
| [world/04-triggers-spawns-targets.md](world/04-triggers-spawns-targets.md) | **AiTrigger**, **AiAction**, **AiBirthPlace**, **AiAirport**, **AiTarget**, **Regiment** | | [world-04-triggers-spawns-targets](world-04-triggers-spawns-targets) | **AiTrigger**, **AiAction**, **AiBirthPlace**, **AiAirport**, **AiTarget**, **Regiment** |
| [world/05-time-and-user-labels.md](world/05-time-and-user-labels.md) | **ITime** (cross-link), **GPUserLabel**, **GPUserIconType** | | [world-05-time-and-user-labels](world-05-time-and-user-labels) | **ITime** (cross-link), **GPUserLabel**, **GPUserIconType** |
## Quick start ## Quick start