Login Register
Smart Habits: Pre-Command Knowledge Checks and Warnings

Automatic Warning Notices for High-Risk Commands

Estimated reading: 0 minutes 7 views

Some commands carry more risk than others. Creating a file in the wrong location, modifying a component that does not exist, or rebuilding an index while one is already running can waste time and cause confusion. GameCatalyst prevents these problems with automatic warning notices that remind Vex of best practices before mistakes happen.

What are warning notices?

Warning notices are short reminders that GameCatalyst attaches to command responses. Unlike error messages that appear after something goes wrong, warnings appear proactively — before or alongside successful operations — to remind Vex of required preconditions and best practices. Think of them as gentle nudges that keep Vex on the right path.

Commands that include warnings:

  • File operations (file.create, file.edit, file.delete) — Remind Vex to verify paths with workspace.find or workspace.diagnose before writing to disk.
  • component.set — Reminds Vex to verify the target object exists before modifying its properties. Trying to set a property on a nonexistent object wastes a command call.
  • workspace.index rebuild — Reminds Vex to check the is_running status first, because starting a second rebuild while one is already active causes problems.
  • Delete operations (object.delete, file.delete) — Reminds Vex to verify targets before deletion so the wrong item is not removed accidentally.

Example warning in action:

Vex calls file.create path="Assets/Scripts/EnemyAI.cs" content="..." dry_run=false. The file is created successfully. Alongside the success response, GameCatalyst appends: “Reminder: Verify the parent directory exists and the path is valid before creating files. Use workspace.find or workspace.diagnose to confirm.” Vex reads this reminder and makes sure to run discovery commands before the next file operation.

Warnings vs. errors — what is the difference?

  • Warnings are proactive. They appear alongside successful operations to prevent future mistakes. The current operation still completes normally.
  • Errors are reactive. They appear after a command fails and include recovery guidance from WhatIs to help Vex self-correct on the next attempt.

Together, warnings and self-healing errors create a complete safety net. Warnings keep Vex on the right path before things go wrong. Errors catch and fix mistakes after they happen. You benefit from both without lifting a finger — the system handles it all automatically behind the scenes.

Share this Doc

Automatic Warning Notices for High-Risk Commands

Or copy link

CONTENTS
Antimanual

Ask our AI support assistant your questions about our platform, features, and services.

You are offline
Chatbot Avatar
What can I help you with?