Using the Debug Class

Unity has a Debug class with some really useful functions for speeding up development, testing, and debugging.

You probably already use Debug.Log() to add messages to the Console, such as keeping track of variables or notifying you of certain conditions:

Debug.Log("Player inside trigger area");
Debug.Log("X value: " + x.ToString());

If you don’t use Debug.Log() you should! It will print anything you want into Unity’s console window while running the game in the Editor.

Warnings and Error

The Debug class also lets you write warnings and errors to the Console. This lets you give yourself valuable feedback when debugging.

In the Console window you will see a different icon next to the message is you log a warning or error.

Debug.LogError("This is a debug error message");
Debug.LogWarning("This is a debug warning message");

Pause the Game

Call Debug.Break() to pause your game in the Editor, allowing you to freeze the action at a particular point and look what’s happening:

Debug.Break();

Lines

The Debug class also lets you draw lines inside the Scene view while your game is playing. This is invaluable for working with linecasts and raycasts as it lets you see exactly what is happening in your scene, taking out the guesswork.

Debug.DrawLine() takes a start point, an end point, and a colour and draws a line (only visible in the Scene window while the game is running):

[code language=”csharp”]
Debug.DrawLine(transform.position, othertransform.position, Color.magenta);
[/code]

Debug.DrawRay() is similar, but draws a ray from an origin position in a given direction:

Debug.DrawRay(transform.positon, Vector3.up, Color.blue);

Link

Unity documentation for the Debug class: Unity Scripting API: Debug.