Scripting API

Scripting API

SystemTiming

Record struct in Abyss.Core, from Abyss.Core.

A system's run, as a profiler is told it; see ISystemTimings.

public readonly record struct SystemTiming

Constructors

SystemTiming

public SystemTiming(string System, Type? Plugin, bool Fixed, long Ticks, long Allocated)

A system's run, as a profiler is told it; see ISystemTimings.

Parameters

  • System: Its name; SystemTiming.CommandsApplied for the systems' commands, applied after they all ran.
  • Plugin: The plugin that added it, or null for one no plugin did, and for the commands.
  • Fixed: Whether it ran in a fixed step.
  • Ticks: How long it took, in Stopwatch ticks: its query and resources taken and given back with it.
  • Allocated: How many bytes of C#'s heap it allocated, on its thread.

Properties

System

public string System { get; init; }

Its name; SystemTiming.CommandsApplied for the systems' commands, applied after they all ran.

Plugin

public Type? Plugin { get; init; }

The plugin that added it, or null for one no plugin did, and for the commands.

Fixed

public bool Fixed { get; init; }

Whether it ran in a fixed step.

Ticks

public long Ticks { get; init; }

How long it took, in Stopwatch ticks: its query and resources taken and given back with it.

Allocated

public long Allocated { get; init; }

How many bytes of C#'s heap it allocated, on its thread.

Constants

CommandsApplied

public const string CommandsApplied = "Commands applied"

What the systems' commands are called, applied after they all ran.