Class CrashReport

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

A text file that describes a run that stopped on an error, for a tester to send: the game and engine versions, the operating system and runtime, the platform’s facts (IPlatformDiagnostics), the last measured frame and its slowest systems when Diagnostics measured, and the error with its stack trace. The desktop launcher writes one when a game’s run fails and names it on standard error.

C#

public static class CrashReport

Inheritance

object ← CrashReport

Methods

Describe(Game, Exception)

The report’s text for error, which stopped game.

C#

public static string Describe(Game game, Exception error)

Parameters

game Game

error Exception

Returns

string

Exceptions

ArgumentNullException

An argument is null.

Write(Game, Exception, string)

Writes the report into directory (created if needed) as crash-<UTC time>.txt and returns its path.

C#

public static string Write(Game game, Exception error, string directory)

Parameters

game Game

error Exception

directory string

Returns

string

Exceptions

ArgumentNullException

An argument is null.

IOException

The file cannot be written.

UnauthorizedAccessException

The folder is not writable.