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 syntaxt see Assertions.Must.MustExtensions.
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.
| raiseExceptions | Should an exception be thrown on a failure. |
| AreApproximatelyEqual | Asserts 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. |
| AreEqual | Asserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used. |
| AreNotApproximatelyEqual | Asserts 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. |
| AreNotEqual | Asserts that the values are not equal. |
| IsFalse | Asserts that the condition is false. |
| IsNotNull | Asserts that the value is not null. |
| IsNull | Asserts that the value is null. |
| IsTrue | Asserts that the condition is true. |