Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Assert

class in UnityEngine.Assertions

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

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.

#pragma strict
public var health: int;
public var go: GameObject;
function 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);
}
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

raiseExceptionsShould an exception be thrown on a failure.

Static Functions

AreApproximatelyEqualAsserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f.Note: Every time you call the method with tolerance specified, a new instance of FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur.
AreEqualAsserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used.
AreNotApproximatelyEqualAsserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f.
AreNotEqualAsserts that the values are not equal.
IsFalseAsserts that the condition is false.
IsNotNullAsserts that the value is not null.
IsNullAsserts that the value is null.
IsTrueAsserts that the condition is true.