Custom Health Checks

Custom Health Checks

You can create your own health checks that integrate with the Health window scanner. Scene Pilot Pro includes a CustomCheckTemplate.cs template in the Editor/Checks folder. Custom checks are discovered automatically via reflection - no registration code needed.

How to Create a Custom Check

1. Copy CustomCheckTemplate.cs to your own Editor scripts folder and rename it.
2. Remove the #if false guard at the top of the file.
3. Implement the ISceneCheck interface (see example below).
4. Your check will appear in the Health window automatically on the next scan.

Requirements

• The script must be in an Editor folder or an Editor-only assembly.
• The class must implement ISceneCheck from the Kronnect.ScenePilotPro namespace.
• The class must have a parameterless constructor.
• CheckId must be unique across all checks (use a prefix like custom.).

Interface Reference

Every custom check implements these members:

Context Data

The SPPContext object passed to Run provides pre-collected scene data:

Example

using System.Collections.Generic;
using UnityEngine;
using Kronnect.ScenePilotPro;

public class MyCustomCheck : ISceneCheck
{
    public string CheckId => "custom.my_check";
    public string DisplayName => "My Custom Check";
    public CheckCategory Category => CheckCategory.Health;
    public CheckSeverity DefaultSeverity => CheckSeverity.Warning;
    public FixTier FixTier => FixTier.ReportGuidance;
    public string Description => "Describe what this check does.";

    public IEnumerable<CheckResult> Run(SPPContext context)
    {
        foreach (GameObject go in context.AllGameObjects)
        {
            if (go == null) continue;

            bool hasIssue = false; // Replace with your condition

            if (hasIssue)
            {
                yield return new CheckResult(
                    CheckId, DefaultSeverity, FixTier,
                    "Issue found on '" + go.name + "'.", go)
                {
                    DisplayName = DisplayName,
                    Guidance = "Explain how to resolve this issue."
                };
            }
        }
    }

    public bool ApplyFix(CheckResult result, SPPContext context)
    {
        return false; // Implement if FixTier is AutoFixable
    }

    public int ApplyFixAll(IList<CheckResult> results, SPPContext context)
    {
        return 0; // Return number of items fixed
    }
}