Quick Start

Learn what Validatox can do and how basic functionalities are implemented

Check out the video wiki at: https://www.youtube.com/watch?v=bPDNtff5fY4

What is Validatox?

Validatox is a lightweight Editor tool that allows for reference and custom logic validation. Each entity that is able to run validation logic is called a Validator.

The package comes with some implemented validators such as the GuardValidator that is dedicated in validating all the field references in the project.

Whithin Validatox, it is also possible to create custom validators that can be implemented in order to validate any kind of logic in your project, from naming conventions, component dependencies and more.

Setup

When importing the package, Validatox will be already set up and ready to go.

It is highly recommended to place any custom validator script inside the Editor folder in order to not undergo problems while building the game.

Analogously, place any actual validator object inside the Editor folder.

The Hub & Logs

The Hub is the Editor window that gathers information about the validation status of all validators in the project. In order to bring it up, in the top toolbar select: Window -> Validatox -> Hub.

The window has different sections that are useful to inspect only certain types of validators. Also, it is possible to use filters on the left in order to filter only validators that have certain properties. Every action perormed by Validatox will print the result in the Log window, which can be brought up by selecting Window -> Validatox -> Logs.

When logs will be printed by a certain validator, in the Log window it will be possible to click the small button near the log in order to inspect the validator that printed the selected log.

Guard validation

Learn how to use and to customize the Guard validation framework.

Custom validators

Create custom validators to cover custom functionalities validation.

Editor scripting

Customize how validators are shown in the inspector and extends functionalities for custom validators representation.

Learn

Learn by doing. Look at some examples for creating a custom validator from start to end and more. The examples library will be continuously updated with new examples.

Last updated