Murl Engine Lua Addon API  Version 1.0 beta
Murl.Debug.Logger

The logger class.


Table members

Functions


Murl.Debug.Logger.Init(logFileName)

Initialize the logger module. Initializing is done by the engine's core module at startup. The core sets the log file name to IEngineConfiguration::GetLogFileFullPath(). If the log file name is empty no file is written.

Init(String logFileName)

Parameters
logFileNameThe file name of the log file.

Murl.Debug.Logger.DeInit()

Deinitialize the logger module. Deinitializing is done by the engine's core module at shutdown.

DeInit()


Murl.Debug.Logger.SetLogFileName(logFileName)

Set the log file name. If the log file name is empty no file is written.

SetLogFileName(String logFileName)

Parameters
logFileNameThe file name of the log file.

Murl.Debug.Logger.GetLogFileName()

Get the log file name.

String GetLogFileName()

Returns
String The file name of the log file.

Murl.Debug.Logger.SetTraceFunctionItems(itemMask)

Set the trace items' bit mask. The itemMask parameter represents a bit mask of individual values from the IEnums::DebugOutputFunctionItem enumeration, which can be used to select individual items to trace for each function/method call.

SetTraceFunctionItems(Integer itemMask)

Parameters
itemMaskThe trace item bit mask.

Murl.Debug.Logger.GetTraceFunctionItems()

Get the trace items' bit mask.

Integer GetTraceFunctionItems()

Returns
Integer The trace item bit mask.

Murl.Debug.Logger.SetLogLevel(level)

Set the global log level.

SetLogLevel(Integer level)

Parameters
levelThe log level.

Murl.Debug.Logger.GetLogLevel()

Get the global log level.

Integer GetLogLevel()

Returns
Integer The log level.

Murl.Debug.Logger.PrintDebug(message)

Print a message to the system's debug logging output. If a log file name is set, the string is added to the file.

PrintDebug(String message)

Parameters
messageThe message string to print.

Murl.Debug.Logger.PrintError(message)

Print a message to the system's error logging output. If a log file name is set, the string is added to the file.

PrintError(String message)

Parameters
messageThe message string to print.