InnoEngine Manual
Section titled “InnoEngine Manual”The Manual explains how to use the engine’s implemented capabilities. Start with a task, then follow its links to the exact contracts and architectural concepts it relies on.
Editor views and preferences
Section titled “Editor views and preferences”Use the Game View for game output and focused Play input, or navigate Scene View to inspect and manipulate the presented world. Change settings and adjust scale, icons and pacing through their actual persistence owners.
Assets and content
Section titled “Assets and content”For source importing, settings, samples and retained runtime content, start with Assets, importing and deployment content.
Text and fonts
Section titled “Text and fonts”Shape text and rasterize glyphs from imported fonts, then pass their positions and coverage to your own presentation system.
Document UI
Section titled “Document UI”- Display and update a document through an explicitly composed UI service.
- Author RML with fonts and shared styles using the asset import pipeline.
- Connect UI frames to a renderer while preserving resource ownership.
Editor and projects
Section titled “Editor and projects”-
Use the script API, choose logical namespaces and understand Runtime, Editor and Authoring scopes.
-
Start the Editor and recognize its default workspace.
-
Open a project without assuming that templates have been created.
-
Read logs and current diagnostics, filter entries, copy details, and control clearing on Play.
-
Read and publish statistics through stable feature contributions.
-
Change settings in the scope that owns their persistence.
-
Read project settings as isolated values from the active project owner.
Input and application data
Section titled “Input and application data”- Read keyboard, pointer and text input during the active runtime frame.
- Save and load application data with logical keys and complete-value writes.
- Play and control audio, observe preparation and release preload ownership.
- Route audio through a mixer using semantic buses and validated processor chains.
Rendering and shaders
Section titled “Rendering and shaders”Choose a rendering task: author shaders, reuse nodes, use materials or contribute to a frame. Engine mechanisms remain independent from a plugin’s 2D/3D world model.
State, references, and lifetime
Section titled “State, references, and lifetime”-
Understand frames, suspension and shutdown through the shared Editor/Player loop.
-
Preserve and resolve a Missing reference without discarding saved intent.
-
Read current content for one operation through captured generation identities.
-
Own asynchronous work before it starts, propagate cancellation and retire its dependencies.
-
Run and stop coroutines from the host’s frame loop.
-
Schedule frame jobs with explicit dependencies and finite queue limits.
-
Route and consume events with ordered hubs and explicit subscription ownership.
-
Report and resolve current issues through an owner-bound diagnostic producer.
-
Write and retain logs with the correct script surface and host delivery policy.
-
Play an animation clip against an explicit destination or sampling-only target.
-
Understand ownership before retaining resources or participating in reload.
Data models and mathematics
Section titled “Data models and mathematics”- Order dependencies and inspect cycles with explicit consumer-to-dependency direction.
- Query objects through typed indexes while retaining separate object ownership.
- Preserve an editable graph when extension definitions become unavailable.
- Transform positions, directions and colors using the engine’s actual numeric conventions.
Extending and deploying
Section titled “Extending and deploying”- Extend InnoEngine through the boundary appropriate to your task.
- Customize Console presentation without changing its public logging contract.
- Compose lifecycle layers and overlays with explicit frame and event ownership.
- Choose a platform and product.
- Understand a backend’s responsibilities.
Using reference material
Section titled “Using reference material”The API reference distinguishes host, script, managed adapter and tooling surfaces. A public CLR member is not necessarily available to scripts. Read the linked shared contract as well as a member’s declaration. Third-party native and generated binding APIs are outside this documentation.
Serialization and reload
Section titled “Serialization and reload”Save declared state, restore independent properties across a reload, and reuse immutable captures while preserving generation ownership.
Extension discovery and reload
Section titled “Extension discovery and reload”Find current extension types without retaining old generations, and diagnose reload failures through the actual owner and admission state.
Scenes and objects
Section titled “Scenes and objects”Load and arrange scenes, choose object or scene-level behaviors, instantiate prefabs and preserve missing-script state. The task guides distinguish runtime scripts from host persistence and Editor transactions.
Plugins
Section titled “Plugins”Install or update a complete plugin package, then diagnose unavailable candidates without confusing discovery, compilation and active publication.