Metrics Overlay

Note

Metrics Overlay can be toggled in-game with F1

The metrics overlay shows useful information in-game and can be used to monitor the performance of your script variables.

Game.Metrics.StartMonitoring("My Variable", () => _someVariable);
//Game.Metrics.StopMonitoring("My Variable");

You can also profile the rest of your codes performance.

// _Ready
Game.Profiler.Start("Player Init");
PlayerSetup();
Game.Profiler.Stop("Player Init"); // The running time will be printed to the console

// _Process
Game.Profiler.StartProcess("Player Firing Logic"); 
PlayerFire();
Game.Profiler.StopProcess("Player Firing Logic"); // The running time will be displayed in the Metrics Overlay (F1)