NoaInformationOverlay

Through this class, you can register and remove Information overlay groups.

Note: When using the functions provided by the NOA Debugger, always use the symbol definition of NOA_DEBUGGER.

Static Methods

API	Description
RegisterGroup(groupName, layout, initialTargets, callbacks)	Registers an overlay group. Specify the overlay identifier name, layout settings, a list of display targets, and callbacks as parameters. Callbacks are optional, but you can use them to configure more detailed behavior. For details, refer to NoaInformationOverlayCallbacks.
RemoveGroup(groupName)	Removes the specified overlay group.
RemoveAllGroups()	Removes all overlay groups.
IsGroupRegistered(groupName)	Returns whether the specified overlay group is registered.
RefreshAll()	Refreshes the display of all overlay groups at once.

NoaInformationOverlayTargetKey

Represents a single item displayed on the Information overlay via programmatic API.

You can use each item name in Information as a key as-is.

Property	Description
Category	The Information category type.
GroupName	The data group name within each tab.
Key	The item key name.

NoaInformationOverlayLayout

The layout settings for the overlay.

Property	Description
Position	Specifies where to place the overlay.
Scale	Specifies the overlay size in the range of 0.5 to 1.5.
Axis	Specifies the direction in which items shown on the overlay are arranged.

Sample Code

using System.Collections.Generic;
using UnityEngine;
#if NOA_DEBUGGER
using NoaDebugger;
#endif

public class Example
{
    void ExampleMethod()
    {
#if NOA_DEBUGGER
        // Layout
        var layoutCustom = new NoaInformationOverlayLayout
        {
            Position = NoaDebug.OverlayPosition.LowerRight,
            Scale = 1.1f,
            Axis = NoaInformation.OverlayAxis.Horizontal,
        };

        // Callbacks
        var callbacks = new ExampleCustomOverlayCallbacks();

        // Group identifier name
        string groupName = "SampleGroup";

        // Initial display targets
        var initialTargets = new List<NoaInformationOverlayTargetKey>
        {
            new(InformationTabType.App, "Build", "Company Name"),
            new(InformationTabType.App, "Build", "Product Name"),
            new(InformationTabType.Device, "Device", "Model"),
        };

        // Register an overlay group (with callbacks)
        NoaInformationOverlay.RegisterGroup(
            groupName: groupName,
            layout: layoutCustom,
            initialTargets: initialTargets,
            callbacks: callbacks);

        // Refresh all overlay groups at once
        NoaInformationOverlay.RefreshAll();

        // Check if an overlay group is registered
        bool isRegistered = NoaInformationOverlay.IsGroupRegistered(groupName);

        // Remove an overlay group
        NoaInformationOverlay.RemoveGroup(groupName);

        // Remove all overlay groups
        NoaInformationOverlay.RemoveAllGroups();
#endif
    }
}