Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

AssertFormat

Assert a condition and logs a formatted error message to the Unity console on failure.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

AssertFormat(bool, string, Object[])

Assert a condition and logs a formatted error message to the Unity console on failure.
[Conditional("UNITY_ASSERTIONS")]public static void AssertFormat(bool condition, string format, params object[] args)

Parameters

condition

bool
Condition you expect to be true.

format

string
A composite format string.

args

Object[]
Format arguments.

Remarks

Note that these methods work only if UNITY_ASSERTIONS symbol is defined. This means that if you are building assemblies externally, you need to define this symbol otherwise the call becomes a no-op. (For more details see System.Diagnostics.ConditionalAttribute on the MSDN website.

AssertFormat(bool, Object, string, Object[])

Assert a condition and logs a formatted error message to the Unity console on failure.
[Conditional("UNITY_ASSERTIONS")]public static void AssertFormat(bool condition, Object context, string format, params object[] args)

Parameters

condition

bool
Condition you expect to be true.

context

Object
Object to which the message applies.

format

string
A composite format string.

args

Object[]
Format arguments.

Remarks

Note that these methods work only if UNITY_ASSERTIONS symbol is defined. This means that if you are building assemblies externally, you need to define this symbol otherwise the call becomes a no-op. (For more details see System.Diagnostics.ConditionalAttribute on the MSDN website.