Skip to content

KernelAPI reference

Class RunResult

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

How a run ended.

C#
public sealed record RunResult : IEquatable<RunResult>

Inheritance

object ← RunResult

Implements

IEquatable<RunResult>

Constructors

RunResult(long, long, IReadOnlyList<string>, Exception?)

How a run ended.

C#
public RunResult(long Updates, long Frames, IReadOnlyList<string> Captures, Exception? Error)

Parameters

Updates long

Fixed updates simulated.

Frames long

Frames rendered.

Captures IReadOnlyList<string>

Paths of the screenshots written by the script, in order.

Error Exception?

The exception that stopped the run, or null when it ended normally.

Properties

Captures

Paths of the screenshots written by the script, in order.

C#
public IReadOnlyList<string> Captures { get; init; }

Property Value

IReadOnlyList<string>

Error

The exception that stopped the run, or null when it ended normally.

C#
public Exception? Error { get; init; }

Property Value

Exception?

Frames

Frames rendered.

C#
public long Frames { get; init; }

Property Value

long

Updates

Fixed updates simulated.

C#
public long Updates { get; init; }

Property Value

long

Methods

<Clone>$()

C#
public RunResult <Clone>$()

Returns

RunResult

Deconstruct(out long, out long, out IReadOnlyList<string>, out Exception?)

C#
public void Deconstruct(out long Updates, out long Frames, out IReadOnlyList<string> Captures, out Exception? Error)

Parameters

Updates long

Frames long

Captures IReadOnlyList<string>

Error Exception?

Equals(object?)

C#
public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(RunResult?)

C#
public bool Equals(RunResult? other)

Parameters

other RunResult?

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(RunResult?, RunResult?)

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

Parameters

left RunResult?

right RunResult?

Returns

bool

operator !=(RunResult?, RunResult?)

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

Parameters

left RunResult?

right RunResult?

Returns

bool