Validation and export

Validation

When does it happen?

Data validation happens when either the Validate setup, or the Export config button is pressed.

What does it do?

During validation, the nodes in the editor space are all processed, their returned data is put into a structure that more closely resembles that of the model config files. After this, a set of checks is performed on the collected data:

• name validation: whether the class and item names are unique, and follow the naming rules
• order validation: whether the order of the classes and items supports the parenting setup (i.e.: the parents come before their children in the lists)
• field validation: whether the values in certain fields "make sense" in their context (i.e.: an empty axis field in an animation is not desireable)

Results

• Errors: errors are issues in the data that would make it incomprehensible for the arma engine (e.g.: duplicate class names)
• Warnings: warnings are issues that would not cause severe issues, but would produce a pontentially undesireable result (e.g.: an empty selection field in an animation class would not break the engines interpretaion, but the animation would obviously not play for the lack of part to animate)
• Log: a validation log is printed to the system console, or a separate log file, depending on the setting in the addon preferences

Export

The export process takes place when the Export config button is pressed.

Steps

• output directory check: checking if an output directory path is set, and the path actually exists, if not, the process is aborted
• processing nodes: the nodes in the editor are processed, their returned data is put into a structure that more closely resembles that of the model config files
• validation: during the export process, a mandatory data validation happens, and depending on the settings, the result may cause the export process to abort
• printing: the data is printed to a model.cfg file in the export directory
• opening: depending on the settings, the exported cfg file is automatically opened in the default text editor