The debug namespace gives access to debug & diagnostics helper functions.
Diagnostics
| 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)
Draw helpers
| Return type | Description |
int | alignMode enumeration
|
void | debug.drawValue(bool enabled, auto value, float3 position[, float fontScale, float4 color, float2 offset, int alignMode]) [v2.15.0]If enabled is true, draws value at position (worldspace position), offsetted by offset worldspace units along the camera side/up axis.The value input can be of type int, int2, int3, int4, float, float2, float3, or float4.The fontScale parameter is a size multiplier for the text, whose size is 0.1 worldspace units wide by default, so setting a scale of 10 would make each character 1.0 world units wide. You can pass a value that depends on the distance to the view to make the text appear a constant screenspace size.The alignMode defaults to alignMode.center, it can take the following values:
Removed in shipping builds. |
void | debug.drawLine(bool enabled, float3 start, float3 end[, float4 colorStart, float4 colorEnd]) [v2.16.0]If enabled is true, draws a line between the worldspace positions start and end.You can specify the color of both extremities using colorStart and colorEnd. When not specified, they default to white.Removed in shipping builds. |
Note: The debug.draw* functions will only appear in-editor if the debug information button is activated in the editor viewport’s toolbar:
