Action Validator

v1.0

circle-info

The Action Validator is especially useful when writing your own actions, either by yourself or with your friendly AI. It will help guide best practices and catch potential mistakes.

Open the Action Validator window with Tools/Juicy Actions/Action Validation. The window will take a few moments to load as it gathers and analyses all of the Actions in the project.

Don't worry, these warnings will be fixed before Juicy Actions is shipped!

All Actions will be displayed, and you can choose how they are ordered, and filter with a string.

Warnings will be dispalyed in yellow. Hover over the Lifecycle and Validation warnings to learn more with a tooltip.

After loading the window, the console will produce a report. This report can be very useful to your favorite AI overlord who may be helping you fix up your scripts β€” just copy/paste the report and ask your minion to help out. You may wish to remind your AI companion that the Action.cs class has many helpful comments on how to properly set up new Actions.

Suppressing Warnings

There may be cases where an action has a valid reason to break the guidelines. If thats the case, you can add these comments to your script and the Action Validator will ignore any issues.

Comment
Effect

// VALIDATION_IGNORE: Random

Suppress all Random-related warnings

// VALIDATION_IGNORE: Time

Suppress all Time/Clock-related warnings

// VALIDATION_IGNORE: Blackboard

Suppress Blackboard warnings

// VALIDATION_IGNORE: TimeBeforeNextAction

Suppress timeBeforeNextAction constructor check

// VALIDATION_IGNORE: HasDuration

Suppress warnings about HasDuration() not being exactly true or false

// VALIDATION_IGNORE: DurationZero

Supress warnings when the transitionDuration defaults to 0

// VALIDATION_IGNORE: Logging

Suppress warnings about not using the logging methods on the Action.cs parent class

// VALIDATION_IGNORE: Lifecycle

Suppress warnings about end of lifecycle methods missing

// VALIDATION_IGNORE: BaseValue

Suppress warnings about HasBaseValue() and related required method overrides

// VALIDATION_IGNORE: Executor

Suppress ALL Executor usage warnings

// VALIDATION_IGNORE_ALL

Suppress ALL validation warnings for the file

Last updated