Documentation
Docs/en/reference/native-extension/index.md
Generated Native Extension Interface
Generated reference. Do not edit directly. Update
BuildTools/NativeExtensionInterface.json, then runpython BuildTools/docs_native_extension.py --write.
| Index | Roles | Hooks | Bindings | Canonical JSON | Guide |
This interface describes engine-owned composition and hook contracts for project-native C++ sources. It does not document any particular game’s extension implementation.
Contract status
| Field | Value |
|---|---|
| Stability | experimental |
| Support policy | Source-compatible use is documented for a pinned engine revision; independently built binary compatibility is not promised. |
| Source manifest | BuildTools/NativeExtensionInterface.json |
| Contract digest | 6a8b5d9d6b95a80f67104ddfabe3a7b42051b1b8944eb79ef6954c93d83a635d |
| Reference | Entries | Purpose |
|---|---|---|
| Roles | 6 | CMake source routing, libraries, headers, and consumers. |
| Hooks | 8 | Optional declarations, call sites, defaults, and compatibility state. |
| Bindings | 6 | Registration, namespace, pointer, and dependency rules. |
Boundary
Included:
- role-scoped project C++ source registration through AddEngineSources
- metadata/codegen participation of registered project sources
- optional EngineHook declarations, signatures, owning roles, call sites, and generated fallback behavior
- native binding and namespace rules required by generated script exports
Excluded:
- project-local extension implementations, dependencies, settings, persistence, and release policy
- third-party SDK ABI and project-specific native library packaging
- client host/runtime updater ABI and compatibility across independently built engine revisions
- native scripting backend internals controlled by FO_NATIVE_SCRIPTING