Skip to main content

Class DisplayElementConfiguration

Configuration class used by NetStatsMonitorConfiguration to be displayed at runtime by RuntimeNetStatsMonitor.

Inheritance#

System.Object

DisplayElementConfiguration

Namespace: Unity.Multiplayer.Tools.NetStatsMonitor#
Assembly: Tools.dll#
Syntax#
[Serializable]
public sealed class DisplayElementConfiguration : ISerializationCallbackReceiver

Properties#

CounterConfiguration#

Counter configuration if Type is set to Counter.

Declaration#
public CounterConfiguration CounterConfiguration { get; set; }
Property Value#
TypeDescription
CounterConfiguration

GraphConfiguration#

Graph configuration if Type is set to LineGraph or StackedAreaGraph.

Declaration#
public GraphConfiguration GraphConfiguration { get; set; }
Property Value#
TypeDescription
GraphConfiguration

Label#

The label of the display element.

Declaration#
public string Label { get; set; }
Property Value#
TypeDescription
System.String

Stats#

The list of stats represented by MetricId to display.

Declaration#
public List<MetricId> Stats { get; set; }
Property Value#
TypeDescription
System.Collections.Generic.List\<MetricId>

Type#

The DisplayElementType of the display element. The label to display for this visual element. For graphs this field is optional, as the variables displayed in the graph are shown in the legend. Consider leaving this field blank for graphs if you would like to make them more compact.

Declaration#
public DisplayElementType Type { get; set; }
Property Value#
TypeDescription
DisplayElementType

Methods#

OnAfterDeserialize()#

For internal use. Implementation for ISerializationCallbackReceiver. Called after Unity deserialize the object. This allow to keep the configuration details when reloading assemblies or making change in the code.

Declaration#
public void OnAfterDeserialize()

OnBeforeSerialize()#

For internal use. Implementation for ISerializationCallbackReceiver. Called before Unity serialize the object. This allow to keep the configuration details when reloading assemblies or making change in the code.

Declaration#
public void OnBeforeSerialize()