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.
Closeexpected | The assumed Assert value. |
actual | The exact Assert value. |
message | The string used to describe the Assert. |
comparer | Method to compare expected and actual arguments have the same value. |
Assert that the values are equal.
Show message when the expected
and actual
are not equal. If no comparer is specified, EqualityComparer<T>.Default
is used.
using UnityEngine; using UnityEngine.Assertions;
public class AssertionExampleClass : MonoBehaviour { void Update() { // Make sure the Game Object is always tagged as "Player" Assert.AreEqual("Player", gameObject.tag); } }
Another example:
using UnityEngine; using UnityEngine.Assertions;
// Assert.AreEqual and Assert.AreNotEqual example // // Compare 32 to 32. AreNotEqual prints message. // Compare 32 to 33. AreEqual prints message.
public class Example : MonoBehaviour { void Start() { int expectedInt = 32; int actualInt = 32;
// Do not show message (32 is equal to 32). Assert.AreEqual(expectedInt, actualInt, "AreEqual: " + expectedInt + " equals " + actualInt);
// Show message (32 is equal to 32). Assert.AreNotEqual(expectedInt, actualInt, "AreNotEqual: " + expectedInt + " not equal to " + actualInt);
actualInt = 33;
// Show message (32 is not equal to 33). Assert.AreEqual(expectedInt, actualInt, "AreEqual: " + expectedInt + " equals " + actualInt);
// Do not show message (32 is not equal to 33). Assert.AreNotEqual(expectedInt, actualInt, "AreNotEqual: " + expectedInt + " not equal to " + actualInt); } }
And another example:
using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Assertions;
// Assertion.Assert.AreEqual example // // Compare Vector2Int Assert using IEqualityComparer.
public class Example : MonoBehaviour { // Implement the EqualityComparer class. class EqualityComparer : IEqualityComparer<Vector2Int> { // Compare two Vector2Int structures. // These represent the expected and actual values. public bool Equals(Vector2Int v1, Vector2Int v2) { if ((v1.x == v2.x) && (v1.y == v2.y)) { return true; } else { return false; } }
public int GetHashCode(Vector2Int v) { int vCode = v.x ^ v.y; return vCode.GetHashCode(); } }
void Start() { // Creates three Vector2Int structures. v1 and v3 have equal values. Vector2Int v1 = new Vector2Int(1, 2); Vector2Int v2 = new Vector2Int(2, 1); Vector2Int v3 = new Vector2Int(1, 2);
// Display missing matches between the three Vector2Int structures. EqualityComparer comparer = new EqualityComparer();
Debug.Log("Comparison of v1 against v2"); Assert.AreEqual(v1, v2, "v1 does not matches v2", comparer); Assert.AreNotEqual(v1, v2, "v1 matches v2", comparer);
Debug.Log("Comparison of v1 against v3"); Assert.AreEqual(v1, v3, "v1 does not matches v3", comparer); Assert.AreNotEqual(v1, v3, "v1 matches v3", comparer);
Debug.Log("Comparison of v2 against v3"); Assert.AreEqual(v2, v3, "v2 does not matches v3", comparer); Assert.AreNotEqual(v2, v3, "v2 matches v3", comparer); } }
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.