Generated API Reference
Generated reference. Do not edit these pages directly. The canonical input is
Docs/generated/api.json, produced from the engine’s native codegen metadata parser.
This reference describes the declarations in the model’s engine-native-codegen scope. The current inventory is available to embedding projects as an experimental, revision-pinned API; no broad stable compatibility promise is implied.
| Reference | Symbols | Coverage |
|---|---|---|
| Native script methods | 997 | Native methods exported to scripts. |
| Entity properties | 132 | Generated entity property contracts. |
| Engine events | 122 | Server, client, common, and mapper events. |
| Script types | 997 | Entities, enums, value types, reference types, fields, and methods. |
| Engine settings | 279 | Read-only engine settings grouped by domain. |
| Migration rules | 28 | Native metadata migration declarations. |
Model quality
| Signal | Count |
|---|---|
| Addressable symbols | 2555 |
| Symbols with descriptions | 2555 |
| Symbols missing descriptions | 0 |
| Symbols without source provenance | 14 |
| Metadata source files | 43 |
| Explicit contract declarations | 3 |
| Explicitly classified symbols | 2555 |
| Unclassified default symbols | 0 |
Stability labels
| Label | Symbols |
|---|---|
experimental |
2554 |
internal |
1 |
Scope contract
The complete current inventory is experimental since 2022.1.0.wip. The declaration pins 2555 stable IDs with SHA-256 7a8bef24e97c589f0113e44ee76aaacfc531585cd0203ca075b38bbbe8560ccf; any symbol addition, removal, or stable-ID change fails generation until an owner reviews and updates both pins.
The native-codegen surface is offered for evaluation only, and stays revision-pinned until supported release lines exist.
SymbolCount and InventorySha256 force owner review of every addition, removal or stable-ID change
Contract source: Source/Common/Common.h:47
Scope
Included:
- native script enums, value types, reference types, entities, properties, methods, and events
- engine settings parsed from ExportSettings
- native migration rules
- source-authored API contracts parsed from ApiContract
Excluded from the current model:
- project-authored script metadata, including remote calls
- CMake options and stage helpers
- BuildTools command-line interfaces
- package layouts and native extension ABI details
Project-facing CMake declarations are intentionally outside this model; use the separate generated CMake project-interface reference.
The main BuildTools command line is also outside this model; use the separate parser-backed CLI reference.
Package declarations and payloads use their own runtime-consumed contract; use the separate package interface reference.
Source links follow the repository’s master branch. The path and line stored in the canonical JSON are the generated provenance record; revision-pinned links remain part of the publication roadmap.