[Documentation] Errors and Validation


Validation Panel

The Validation Panel is a critical tool for ensuring your scenario is playable and free of errors. It performs real-time checks on your scenario’s data, such as:

  • Broken Links: Navigation to non-existent scenes.
  • Asset Errors: References to missing images or audio files.
  • Logic Errors: Missing keywords or invalid conditions.
  • ID Collisions: Duplicate IDs for items or scenes.

Using the Validation Panel

You can open the panel by clicking the Errors button in the top navigation bar. The button shows the current number of errors in your scenario.

Entering Play

You can also enter play mode by clicking the Play button in the top navigation bar. The button shows the current number of errors in your scenario. The game will attempt to load the scenario, even in broken state, to allow you to playtest part of the scenario. But it is possible that the errors prevent loading (ex: missing ressources). For example, you can playtest scene1 (without errors); but if scene2 has errors, when you try to navigate to scene2, the game might crash or fail to load.

View Modes

The panel offers several ways to view and organize errors:

  1. Scenes Mode: Groups errors by the scene they occur in. This is usually the best way to fix errors room by room.
  2. Entities Mode: Groups errors by the type of entity (Items, Verbs, Global Scenario Data).
  3. Grouped Mode: Groups identical errors together (e.g., if multiple items reference the same missing asset).
  4. List Mode: A flat list of all errors in the scenario.

Fixing Errors

Each error in the list has an Edit (✎) button. Clicking this button will attempt to open the relevant property in the Inspector, or as close to it as possible. That property, or property container should be highlighted in red.

Tips

While the “Play” button allows you to test scenarios with errors, it is highly recommended to fix all errors before publishing or sharing your scenario.

Leave a comment

Log in with itch.io to leave a comment.