Inspector UI

As soon as the package is installed into your project, it will work out of the box, using the default rules. Most likely you want to fine-tune the way the plugin would work in your project, and you can do this with plugin editor UI, that you can access from the top bar. See the screenshot below how a plugin will change the unity editor UI.

  1. Scene summary window. The window can be disabled using plugin settings UI.
  2. Small error indication. It means there is not this object but 1 or more children of this object have a critical issue.  You can clikc on small error sign, it will expand hierarhy and will focust the first object that have an issue inside the marked game object hierarchy.
  3. Critical error indicator. Indicates that this game object has a critical issue, that needs to be solved ASAP.
  4. Warning indicator. Indicates that object has non-critical issues, but this is still something you should look at.

If you will select an object that has one or more issues, the game object inspector UI will be extended with issues description UI. See the screenshot below:

  1. Summary header. The header will be colored based on max error level and will display basic errors summary. 
  2. Name of the component & name of the rule that raised an error for this component.
  3. Available actionы for that rule. See the Automatic Resolution and Ignorind Issues chapters for more information.
  4. The rule UI designed by the rule author. Check out rules samples, to find out how to add own validator rule with own UI.

Ignoring Issues

Automatic validation can't be precise for all the corner cases. That's why there is an ability to "mute" the specific validation rule for a specific component. Just press the "Ignore" button. See the screenshot below.

Please note that rule can only be ignored for a component that is part of the saved scene.

Automatic Resolution

In case validation rule author has implemented an automatic resolution, the resolve button will appear inside the rule UI. See the screenshot below.

Check out rule code samples to find out how to define own resolution logic for the scene issues.