Interface ILogger

Logger interface.

Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
public interface ILogger

Properties

FilterLogType

To selective enable debug log message.

Declaration
LogType FilterLogType { get; set; }
Property Value
LogType

LogEnabled

To runtime toggle debug logging [ON/OFF].

Declaration
bool LogEnabled { get; set; }
Property Value
System.Boolean

LogHandler

Set Logger.ILogHandler.

Declaration
ILogHandler LogHandler { get; set; }
Property Value
ILogHandler

Methods

IsLogTypeAllowed(LogType)

Check logging is enabled based on the LogType.

Declaration
bool IsLogTypeAllowed(LogType logType)
Parameters
LogType logType

Returns
System.Boolean

Return true in case logs of LogType will be logged otherwise returns false.

Log(LogType, Object, String)

Logs a formatted message.

Declaration
void Log(LogType logType, Object context, string message)
Parameters
LogType logType

The type of the log message.
Object context

Object to which the message applies.
System.String message

Message to log.

Log(LogType, Object)

Logs message to the Flax Console using default logger.

Declaration
void Log(LogType logType, object message)
Parameters
LogType logType

System.Object message

Log(LogType, Object, Object)

Logs message to the Flax Console using default logger.

Declaration
void Log(LogType logType, object message, Object context)
Parameters
LogType logType

System.Object message

Object context

Log(LogType, String, Object)

Logs message to the Flax Console using default logger.

Declaration
void Log(LogType logType, string tag, object message)
Parameters
LogType logType

System.String tag

System.Object message

Log(LogType, String, Object, Object)

Logs message to the Flax Console using default logger.

Declaration
void Log(LogType logType, string tag, object message, Object context)
Parameters
LogType logType

System.String tag

System.Object message

Object context

Log(Object)

Logs message to the Flax Console using default logger.

Declaration
void Log(object message)
Parameters
System.Object message

Log(String, Object)

Logs message to the Flax Console using default logger.

Declaration
void Log(string tag, object message)
Parameters
System.String tag

System.Object message

Log(String, Object, Object)

Logs message to the Flax Console using default logger.

Declaration
void Log(string tag, object message, Object context)
Parameters
System.String tag

System.Object message

Object context

LogError(String, Object)

A variant of ILogger.Info that logs an error message.

Declaration
void LogError(string tag, object message)
Parameters
System.String tag

System.Object message

LogError(String, Object, Object)

A variant of ILogger.Info that logs an error message.

Declaration
void LogError(string tag, object message, Object context)
Parameters
System.String tag

System.Object message

Object context

LogException(Exception)

A variant of ILogger.Info that logs an exception message.

Declaration
void LogException(Exception exception)
Parameters
System.Exception exception

LogException(Exception, Object)

A variant of ILogHandler.LogFormat that logs an exception message.

Declaration
void LogException(Exception exception, Object context)
Parameters
System.Exception exception

Runtime Exception.
Object context

Object to which the message applies.

LogFormat(LogType, String, Object[])

Logs a formatted message.

Declaration
void LogFormat(LogType logType, string format, params object[] args)
Parameters
LogType logType

System.String format

System.Object[] args

LogWarning(String, Object)

A variant of Logger.Info that logs an warning message.

Declaration
void LogWarning(string tag, object message)
Parameters
System.String tag

System.Object message

LogWarning(String, Object, Object)

A variant of Logger.Info that logs an warning message.

Declaration
void LogWarning(string tag, object message, Object context)
Parameters
System.String tag

System.Object message

Object context

Extension Methods