Verse Runtime Error Reporting provides a detailed report of runtime errors in your Verse scripts. The report is a tool to help you identify problems with your code and fix them.
Reports provide thorough error details so you can understand what’s going wrong in your gameplay code. For example:
Error Diagnostic - A designated code to identify the type of runtime error.
Error Description - A detailed description of what the diagnostic means.
Number of Occurences - The total number of times an event is reported.
Runtime error reports are categorized based on the result of the Verse code executing and entering a state it cannot recover from (i.e. an infinite loop or allocating too much memory). When your code becomes unrecoverable, it’s called a runtime error.
At the point of the runtime error, the faulty code execution is captured in the callstack, and is used to group the occurrences of runtime errors of an identical nature.
Runtime Errors
Runtime errors capture information such as:
Coding errors not caught by the compiler
Issues that would cause your island to crash
The Verse compiler currently cannot detect conditions in Verse code that would produce errors at runtime, such as integer overflows or infinite recursion. Such problematic code might appear to compile correctly at a glance, but not all problems can be caught by the compiler’s semantic analysis alone.
When your code executes at runtime, it may trigger runtime errors. When a runtime error occurs, all further Verse execution for the current device is halted. (This behaviour is subject to change in the future). Other devices may continue to execute, but it is not recommended to leave your code running in this state; instead, it is recommended that you identify the issue triggering the runtime error(s) and fix them.
Refer to the Debugging Your Game with Debug Draw document for more information on how to fix runtime errors.
Refer to the Performance Dashboard document to understand how these metrics can be used alongside the runtime error report.
Reports
Projects in the Creator Portal have a number of tools to help you understand your island’s performance and audience after publishing your island. You can also use the Verse Runtime Error Reporting feature to better understand your island’s performance before you publish your island.
You can find this report on the Project Navigation menu under Technical, this opens the Verse Errors tab. Errors will also present during a play session. From here you can search through runtime error reports and filter the Environment View to show:
All
Live
Reports include:
Timestamps to surface the most recent instance and earliest instance of a runtime error.
Playtest and Private Code view that includes a dropdown list of link codes.
Catching runtime errors before publishing gives you the chance to fix your code so players have the best experience possible on your island.