docs.unity3d.com
    Show / Hide Table of Contents

    Class DisplayElementConfiguration

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

    Inheritance
    Object
    DisplayElementConfiguration
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Multiplayer.Tools.NetStatsMonitor
    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
    Type Description
    CounterConfiguration

    GraphConfiguration

    Graph configuration if Type is set to LineGraph or StackedAreaGraph.

    Declaration
    public GraphConfiguration GraphConfiguration { get; set; }
    Property Value
    Type Description
    GraphConfiguration

    Label

    The label of the display element.

    Declaration
    public string Label { get; set; }
    Property Value
    Type Description
    String

    Stats

    The list of stats represented by MetricId to display.

    Declaration
    public List<MetricId> Stats { get; set; }
    Property Value
    Type Description
    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
    [Tooltip("The label to display for this visual element in the on-screen display. 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.")]
    public DisplayElementType Type { get; set; }
    Property Value
    Type Description
    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()
    Implements
    ISerializationCallbackReceiver.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()
    Implements
    ISerializationCallbackReceiver.OnBeforeSerialize()
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on 26 October 2023