Class Debug

Class containing methods to ease debugging while developing a game.

Inheritance

System.Object

Debug

Namespace: FlaxEngine

Assembly: FlaxEngine.CSharp.dll

Syntax

public static class Debug : Object

Methods

Assert(Boolean)

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

Declaration

public static void Assert(bool condition)

Parameters

System.Boolean condition Condition you expect to be true.

Assert(Boolean, Object)

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

Declaration

public static void Assert(bool condition, Object context)

Parameters

System.Boolean condition Condition you expect to be true.

Object context Object to which the message applies.

Assert(Boolean, Object)

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

Declaration

public static void Assert(bool condition, object message)

Parameters

System.Boolean condition Condition you expect to be true.

System.Object message String or object to be converted to string representation for display.

Assert(Boolean, Object, Object)

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

Declaration

public static void Assert(bool condition, object message, Object context)

Parameters

System.Boolean condition Condition you expect to be true.

System.Object message String or object to be converted to string representation for display.

Object context Object to which the message applies.

Assert(Boolean, String)

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

Declaration

public static void Assert(bool condition, string message)

Parameters

System.Boolean condition Condition you expect to be true.

System.String message String to be converted to string representation for display.

Assert(Boolean, String, Object)

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

Declaration

public static void Assert(bool condition, string message, Object context)

Parameters

System.Boolean condition Condition you expect to be true.

System.String message String to be converted to string representation for display.

Object context Object to which the message applies.

AssertFormat(Boolean, Object, String, Object[])

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

Declaration

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

Parameters

System.Boolean condition Condition you expect to be true.

Object context Object to which the message applies.

System.String format A composite format string.

System.Object[] args Format arguments.

AssertFormat(Boolean, String, Object[])

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

Declaration

public static void AssertFormat(bool condition, string format, params object[] args)

Parameters

System.Boolean condition Condition you expect to be true.

System.String format A composite format string.

System.Object[] args Format arguments.

Log(Object)

Logs message to the Flax Console.

Declaration

public static void Log(object message)

Parameters

System.Object message String or object to be converted to string representation for display.

Log(Object, Object)

Logs message to the Flax Console.

Declaration

public static void Log(object message, Object context)

Parameters

System.Object message String or object to be converted to string representation for display.

Object context Object to which the message applies.

LogAssertion(Object)

A variant of Debug.Info that logs an assertion message to the console.

Declaration

public static void LogAssertion(object message)

Parameters

System.Object message String or object to be converted to string representation for display.

LogAssertion(Object, Object)

A variant of Debug.Info that logs an assertion message to the console.

Declaration

public static void LogAssertion(object message, Object context)

Parameters

System.Object message String or object to be converted to string representation for display.

Object context Object to which the message applies.

LogAssertionFormat(Object, String, Object[])

Logs a formatted assertion message to the Flax console.

Declaration

public static void LogAssertionFormat(Object context, string format, params object[] args)

Parameters

Object context Object to which the message applies.

System.String format A composite format string.

System.Object[] args Format arguments.

LogAssertionFormat(String, Object[])

Logs a formatted assertion message to the Flax console.

Declaration

public static void LogAssertionFormat(string format, params object[] args)

Parameters

System.String format A composite format string.

System.Object[] args Format arguments.

LogError(Object)

A variant of Debug.Info that logs an error message to the console.

Declaration

public static void LogError(object message)

Parameters

System.Object message String or object to be converted to string representation for display.

LogError(Object, Object)

A variant of Debug.Info that logs an error message to the console.

Declaration

public static void LogError(object message, Object context)

Parameters

System.Object message String or object to be converted to string representation for display.

Object context Object to which the message applies.

LogErrorFormat(Object, String, Object[])

Logs a formatted error message to the Flax console.

Declaration

public static void LogErrorFormat(Object context, string format, params object[] args)

Parameters

Object context Object to which the message applies.

System.String format A composite format string.

System.Object[] args Format arguments.

LogErrorFormat(String, Object[])

Logs a formatted error message to the Flax console.

Declaration

public static void LogErrorFormat(string format, params object[] args)

Parameters

System.String format A composite format string.

System.Object[] args Format arguments.

LogException(Exception)

A variant of Debug.Info that logs an error message to the console.

Declaration

public static void LogException(Exception exception)

Parameters

System.Exception exception Runtime Exception.

LogException(Exception, Object)

A variant of Debug.Info that logs an error message to the console.

Declaration

public static void LogException(Exception exception, Object context)

Parameters

System.Exception exception Runtime Exception.

Object context Object to which the message applies.

LogFormat(Object, String, Object[])

Logs a formatted message to the Flax Console.

Declaration

public static void LogFormat(Object context, string format, params object[] args)

Parameters

Object context Object to which the message applies.

System.String format A composite format string.

System.Object[] args Format arguments.

LogFormat(String, Object[])

Logs a formatted message to the Flax Console.

Declaration

public static void LogFormat(string format, params object[] args)

Parameters

System.String format A composite format string.

System.Object[] args Format arguments.

LogWarning(Object)

A variant of Debug.Info that logs a warning message to the console.

Declaration

public static void LogWarning(object message)

Parameters

System.Object message String or object to be converted to string representation for display.

LogWarning(Object, Object)

A variant of Debug.Info that logs a warning message to the console.

Declaration

public static void LogWarning(object message, Object context)

Parameters

System.Object message String or object to be converted to string representation for display.

Object context Object to which the message applies.

LogWarningFormat(Object, String, Object[])

Logs a formatted warning message to the Flax Console.

Declaration

public static void LogWarningFormat(Object context, string format, params object[] args)

Parameters

Object context Object to which the message applies.

System.String format A composite format string.

System.Object[] args Format arguments.

LogWarningFormat(String, Object[])

Logs a formatted warning message to the Flax Console.

Declaration

public static void LogWarningFormat(string format, params object[] args)

Parameters

System.String format A composite format string.

System.Object[] args Format arguments.

Write(LogType, String)

Logs the raw message to the log.

Declaration

public static void Write(LogType logType, string message)

Parameters

LogType logType Type of the log message. Not: fatal will stop the engine. Error may show a message popup.

System.String message The message contents.