Skip to content

KernelAPI reference

Class RunPreset

Namespace: MicroEngine.Core
Assembly: MicroEngine.dll
Guide: Game lifecycle and time

Defaults a composition states for the runs it hosts when neither the run (RunOptions) nor the game (Configure) chooses: a stated preset value, never a platform behaviour. A platform offers it as a capability (TryGetCapability``1); the headless platform’s preset is Deterministic, so tests that run a game headless are reproducible with no option. The platform behaves the same whatever the mode the run ends up with.

C#
public sealed record RunPreset : IEquatable<RunPreset>

Inheritance

object ← RunPreset

Implements

IEquatable<RunPreset>

Constructors

RunPreset()

C#
public RunPreset()

Properties

Testing

The preset for testing compositions: one fixed step per frame.

C#
public static RunPreset Testing { get; }

Property Value

RunPreset

TimeMode

The time mode of runs that choose none; null leaves the default, real time.

C#
public TimeMode? TimeMode { get; init; }

Property Value

TimeMode?

Methods

<Clone>$()

C#
public RunPreset <Clone>$()

Returns

RunPreset

Equals(object?)

C#
public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(RunPreset?)

C#
public bool Equals(RunPreset? other)

Parameters

other RunPreset?

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(RunPreset?, RunPreset?)

C#
public static bool operator ==(RunPreset? left, RunPreset? right)

Parameters

left RunPreset?

right RunPreset?

Returns

bool

operator !=(RunPreset?, RunPreset?)

C#
public static bool operator !=(RunPreset? left, RunPreset? right)

Parameters

left RunPreset?

right RunPreset?

Returns

bool