KernelAPI reference
Class Engine
Namespace: MicroEngine.Kernel
Assembly: MicroEngine.Kernel.dll
Guide: Modules and the frame schedule
A composed engine: its services, its fixed frame schedule, its clock, its events and its capabilities. A loop (the game runner, a host, a test) drives it frame by frame: it advances Clock and runs the phases in order.
public sealed class EngineInheritance
Properties
Capabilities
The declared optional features.
public CapabilityRegistry Capabilities { get; }Property Value
Clock
The loop’s clock, following the engine’s TimeSettings.
public FrameClock Clock { get; }Property Value
Lifecycle
The engine’s events; the loop and hosts raise them.
public EngineLifecycle Lifecycle { get; }Property Value
Log
The engine’s log (ILog service).
public ILog Log { get; }Property Value
Schedule
The frame systems; fixed (IsFrozen).
public FrameSchedule Schedule { get; }Property Value
Services
The services registered by the modules.
public ServiceRegistry Services { get; }Property Value
Time
The time policy the engine was built with.
public TimeSettings Time { get; }Property Value
Methods
Run(FramePhase, in FrameContext)
Runs the systems of phase with context.
public void Run(FramePhase phase, in FrameContext context)Parameters
phase FramePhase
context FrameContext
RunFixedStep(in FrameContext)
Runs the four fixed phases, in order, for one step: PreFixed, FixedUpdate, Physics, PostFixed.
public void RunFixedStep(in FrameContext step)Parameters
step FrameContext
TryGetCapability<T>(out T?)
The capability declared as T, if there is one.
public bool TryGetCapability<T>(out T? capability) where T : classParameters
capability T?
Returns
Type Parameters
T