Update Mission Script API

Bruno Carneiro 2026-02-13 20:44:28 +00:00
parent 38818f3535
commit 565390175c

@ -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](External Types.-). 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 |
|----------|-------------| |----------|-------------|
| [Mission And Battle](Mission And Battle.-) | **AMission**, **ABattle**, **IBattle**, **DoTimeout** | | [Mission And Battle](Mission-And-Battle) | **AMission**, **ABattle**, **IBattle**, **DoTimeout** |
| [Gameplay](Gameplay.-) | **IGamePlay** — main interface to the game (actors, HUD, triggers, section files, etc.) | | [Gameplay](Gameplay) | **IGamePlay** — main interface to the game (actors, HUD, triggers, section files, etc.) |
| [Time And Difficulty](Time And Difficulty.-) | **ITime**, **DifficultySetting** | | [Time And Difficulty](Time-And-Difficulty) | **ITime**, **DifficultySetting** |
| [Player](Player.-) | **Player** | | [Player](Player) | **Player** |
| [Events And Section File](Events And Section File.-) | **GameEventId**, **ISectionFile** | | [Events And Section File](Events-And-Section-File) | **GameEventId**, **ISectionFile** |
| [Pathfinding And Terrain](Pathfinding And Terrain.-) | **RecalcPathState**, **PathType**, **LandTypes**, **IRecalcPathParams**, **ActorName** | | [Pathfinding And Terrain](Pathfinding-And-Terrain) | **RecalcPathState**, **PathType**, **LandTypes**, **IRecalcPathParams**, **ActorName** |
| [Script Loading](Script Loading.-) | **IScriptRemote**, **ScriptRemote** | | [Script Loading](Script-Loading) | **IScriptRemote**, **ScriptRemote** |
| [External Types](External Types.-) | 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](World.-) | Index of world types | | [World](World) | Index of world types |
| [Actor Hierarchy](Actor Hierarchy.-) | **AiActor**, **AiPerson**, **AiCart**, **AiGroup**, damage types, **CrewFunction** | | [Actor Hierarchy](Actor-Hierarchy) | **AiActor**, **AiPerson**, **AiCart**, **AiGroup**, damage types, **CrewFunction** |
| [Air](Air.-) | **AiAircraft**, **AiAirGroup**, air waypoints, enums, **EnemyAirInterf** | | [Air](Air) | **AiAircraft**, **AiAirGroup**, air waypoints, enums, **EnemyAirInterf** |
| [Ground](Ground.-) | **AiGroundActor**, **GroundStationary**, buildings, bomb explosion, enums | | [Ground](Ground) | **AiGroundActor**, **GroundStationary**, buildings, bomb explosion, enums |
| [Triggers Spawns And Targets](Triggers Spawns And Targets.-) | **AiTrigger**, **AiAction**, **AiBirthPlace**, **AiAirport**, **AiTarget**, **Regiment** | | [Triggers Spawns And Targets](Triggers-Spawns-And-Targets) | **AiTrigger**, **AiAction**, **AiBirthPlace**, **AiAirport**, **AiTarget**, **Regiment** |
| [Time And User Labels](Time And User Labels.-) | **ITime** (cross-link), **GPUserLabel**, **GPUserIconType** | | [Time And User Labels](Time-And-User-Labels) | **ITime** (cross-link), **GPUserLabel**, **GPUserIconType** |
## Quick start ## Quick start