Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

Debug.AssertFormat

Leave feedback
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

Submission failed

For 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.

Close

Cancel

public static method AssertFormat(condition: bool, format: string, params args: object[]): void;
public static void AssertFormat(bool condition, string format, params object[] args);
public static method AssertFormat(condition: bool, context: Object, format: string, params args: object[]): void;
public static void AssertFormat(bool condition, Object context, string format, params object[] args);

Parameters

conditionCondition you expect to be true.
formatA composite format string.
argsFormat arguments.
contextObject to which the message applies.

Description

Assert a condition and logs a formatted error message to the Unity console on failure.

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.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2020 Unity Technologies. Publication Date: 2020-06-05.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information