Assert

Description

The Assert class contains assertion methods for setting invariants in the code.

All method calls will be conditionally included only in the development builds, unless explicitly specified (see BuildOptions.ForceEnableAssertions). The inclusion of the assertions is controlled by UNITY_ASSERTIONS define.

A failure of an assertion method does not break the control flow of the execution. On a failure, an assertion message is logged (LogType.Assert) and the execution continues. If Assert.raiseExceptions is set to true, an AssertionException is thrown instead of logging a message.

If a debugger is attached to the project (System.Diagnostics.Debugger.IsAttached is true), AssertionException will be thrown in order to pause the excecution and invoke the debugger.

For shorter and more readable syntax see Assertions.Must.MustExtensions.

using UnityEngine;
using UnityEngine.Assertions;

public class ExampleClass : MonoBehaviour
{
    public int health;
    public GameObject go;
    void Update()
    {
        //You expect the health never to be equal to zero
        Assert.AreNotEqual(0, health);

        //The referenced GameObject should be always (in every frame) be active
        Assert.IsTrue(go.activeInHierarchy);
    }
}

For different assertions syntax see Assertions.Must.MustExtensions.

Static Variables

Static Functions