class in UnityEngine.Assertions
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseThe Assert class contains assertion methods for setting invariants in the code.
All method calls will be conditionally included only in a development
build, unless specified explicitly. See BuildOptions.ForceEnableAssertions.
The inclusion of an assertion is controlled by the UNITY_ASSERTIONS
define.
Assert throws exceptions whenever an assertion fails.
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.
using UnityEngine; using UnityEngine.Assertions;
public class AssertionExampleClass : 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); } }
AreApproximatelyEqual | Assert the values are approximately equal. |
AreEqual | Assert that the values are equal. |
AreNotApproximatelyEqual | Asserts that the values are approximately not equal. |
AreNotEqual | Assert that the values are not equal. |
IsFalse | Return true when the condition is false. Otherwise return false. |
IsNotNull | Assert that the value is not null. |
IsNull | Assert the value is null. |
IsTrue | Asserts that the condition is true. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.