Extending InnoEngine
Section titled “Extending InnoEngine”An extension belongs to the layer that owns its behavior. Start by identifying the public contract and lifecycle, then select the appropriate host, script, backend, or product integration.
Choose the boundary
Section titled “Choose the boundary”Define project settings with stable protocols, explicit contribution ordering and generation recovery.
Persist host documents and manage temporary process output through explicit filesystem ownership.
Add a text backend through neutral shaping contracts and explicit composition-owned providers.
Start with a panel, a shared module, a modal, or an action and menu. Use the shared selection, History and state persistence contracts when your feature needs them.
| You want to change | Boundary to inspect |
|---|---|
| A panel’s internal presentation | The owning panel and presentation services |
| Editor discovery and lifecycle | Editor extension contracts, registry, and host |
| A game script capability | The actual runtime or Editor script projection |
| A neutral service implementation | Its adapter/provider contract |
| Third-party native integration | The owning backend facade, bindings, and recipe |
| Target SDK or product composition | The owning platform and distribution contributions |
Customize Console presentation is a concrete example of keeping a local change within its owner.
Add an Editor panel explains registration, host-driven drawing, readable state and retirement without requiring prior knowledge of the assembly list.
Compose lifecycle layers when a host explicitly owns an ordered update/render stack. Layers do not replace Editor panels or a runtime pipeline.
Discovery is not ownership
Section titled “Discovery is not ownership”Provide audio from host content maps a scene or another host content model into bounded emitter and listener snapshots without retaining plugin objects on the audio thread.
Add an animation binding applies neutral sampled values through a declared destination protocol.
Discovery identifies an extension and its stable metadata. The owning registry/host decides how it is constructed, activated, and retired. Do not manually invoke lifecycle callbacks or create a parallel discovery system to bypass that owner.
Keep public and internal behavior distinct
Section titled “Keep public and internal behavior distinct”Own a presentation context with borrowed platform/device dependencies, or contribute to a rendered frame through neutral models and graph contributors. Shader extensions can expand a Target or lower a primitive while retaining the same typed IR and generation owners.
A CLR public API may exist for host composition and be excluded from scripts. An internal style value is not a persistent or script protocol. Read the selected API surface before building an extension around a member.
See ownership for shared lifecycle obligations and API reference for precise contracts.
Serialization extensions
Section titled “Serialization extensions”Implement an explicit converter for domain schemas and references, or supply generated metadata for static deployment.
Code and discovery composition
Section titled “Code and discovery composition”Compose a build distribution when adding platform, content-compilation or managed-deployment contributions. Prepare Support Packs separately from a game’s final content and publication.
Compose module sources, contribute static type facts, and build an owned extension registry through the shared generation protocol.
Package a source plugin with a valid manifest and asset metadata, compose its host, and join reference recovery when a domain must preserve neutral state across publication.