logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class SystemConfigSnapshotJsonBuilder

    Helper class to build a JSON representation of a system configuration snapshot.

    Inheritance
    object
    SystemConfigSnapshotJsonBuilder
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.SystemConfiguration.Application.Helpers
    Assembly: Serenity.SystemConfiguration.Application.dll
    Syntax
    public static class SystemConfigSnapshotJsonBuilder
    Remarks

    This class constructs a JSON string from an ISystemConfigurationSnapshot instance, including optional details about displays and OS monitors. It avoids dependencies on UnityEditor namespaces to remain compatible with runtime environments.

    Methods

    Build(ISystemConfigurationSnapshot, IReadOnlyList<OsMonitorInfo>, bool, bool)

    Builds a JSON string representation of the given system configuration snapshot.

    Declaration
    public static string Build(ISystemConfigurationSnapshot snapshot, IReadOnlyList<OsMonitorInfo> osMonitors, bool includeDisplays, bool includeOsMonitors)
    Parameters
    Type Name Description
    ISystemConfigurationSnapshot snapshot

    The system configuration snapshot to serialize.

    IReadOnlyList<OsMonitorInfo> osMonitors

    Optional list of OS monitor information to include.

    bool includeDisplays

    Whether to include display information in the output.

    bool includeOsMonitors

    Whether to include OS monitor information in the output.

    Returns
    Type Description
    string

    A JSON string representing the snapshot and optional details.

    In this article
    © 2026 Serenity. All Rights Reserved