Skip to content

Document JavaScript query failure diagnostics #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JamieW105 merged 1 commit into from
Oct 28, 2026
Merged

Document JavaScript query failure diagnostics #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/Scripting/scriptingJavaScript/sandbox-values-and-diagnostics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ Use the engine-owned `Timer` facade for delayed/repeating gameplay callbacks. Sc
objects are frozen; do not attempt to modify them. Values crossing the bridge are
JSON-compatible representations of the shared engine types. A callback exception or
instruction-budget failure disables that behavior, while other scripts continue.

Engine query failures throw a JavaScript `Error` whose `message` contains the
engine's rejection reason. During Play, use `try/catch` around an optional query
and log `error.message` (or `error.stack`) to diagnose missing objects, invalid
arguments, or unavailable host features. An uncaught exception in source loading
or a lifecycle callback retains its message and available stack in the runtime
error log. A caught query error lets the behavior continue; an uncaught callback
error disables that behavior.

Generated type declarations are at
`.rustic/generated/programming/rustic_api.d.ts`; generated files may be regenerated,
so never put game logic there.
Loading