Skip to content

Class RunDiagnostics

Namespace: Apogee.Host
Assembly: Apogee.Host.dll

The log file and the crash reports of a run, in the player's folder (user://logs and user://crashes).

public static class RunDiagnostics

Inheritance

object ← RunDiagnostics

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Methods

Start(string, string, string?)

Starts the run's diagnostics: the crash reports go to <user>/crashes, a run that left its marker in <user>/logs without ending (see ) gets its report, and a new log file is added to . Call first (the program does, as early as it can).

public static FileLogSink Start(string userDirectory, string gameName, string? gameVersion = null)

Parameters

userDirectory string

The folder of the player's files ().

gameName string

Named in the log and in crash reports.

gameVersion string?

The game's version, for crash reports.

Returns

FileLogSink

The log file, to dispose when the run ends cleanly: until then, the run counts as one that crashed.