debug

The debug namespace gives access to debug & diagnostics helper functions.

Return type

Description

void

debug.info(bool condition)
If condition is true at graph compile-time, will cause the editor to emit a build info message.
Removed in shipping builds.

void

debug.warning(bool condition)
If condition is true at graph compile-time, will cause the editor to emit a build warning message.
Removed in shipping builds.

void

debug.error(bool condition)
If condition is true at graph compile-time, will cause the editor to emit a build error message.
Removed in shipping builds.

void

debug.assert(bool condition)
If condition is true at graph compile-time, will cause the editor to emit a build error message.
If condition is false at runtime, will cause the editor to pause the simulation and select the particle for inspection / debugging.
Removed in shipping builds.

These can be useful to emit diagnostics inside templates. Each have a node equivalent.
A couple of core-library templates use these to emit warnings when incorrect combinations of properties are used (for example, the event multiplier node)