Enablegames.eagDebug Class Reference

Enablegames Debug class for logging and debugging purposes. More...

Inherits MonoBehaviour.

Static Public Member Functions
static void	DebugOn (Egdb mode)
	Turns on debugging for the specified mode(s).
static void	DebugOff (Egdb mode)
	Disables the specified debug mode.
static void	LogWarning (Egdb mode, object warning, Object target=null)
	Logs a warning message.
static void	LogError (Egdb mode, object error, Object target=null)
	Logs an error message with the specified debug mode.
static void	LogException (Egdb mode, Exception exception)
	Logs the specified exception if the given debug mode is enabled.
static void	LogException (Egdb mode, Exception exception, GameObject target)
	Logs an exception if the specified debug mode is enabled.
static void	Log (LogType type, Egdb mode, int level, string tag, string message)
	Logs a message with the specified log type, debug mode, level, tag, and message.
static void	Log (LogType type, Egdb mode, int level, string message)
	Logs a message with the specified type, debug mode, level, and message.
static void	Log (Egdb mode, int level, string message)
	Writes a log message with the specified mode, level, and message.
static void	Log (Egdb mode, string message)
	Logs a message to the log file.
static void	Log (string message)
	Logs a message to the debug console.

Static Public Attributes
static Mode	loggerMode = Mode.Default
	Represents the logging mode for the eagDebug class.
static Egdb	debugMode = Egdb.None
	The debug mode used by the eagDebug class for logging and debugging purposes.

Properties
static eagDebug	Instance [get]
	Represents the singleton instance of the eagDebug class.

Detailed Description

Enablegames Debug class for logging and debugging purposes.

Member Function Documentation

DebugOff()

static void Enablegames.eagDebug.DebugOff ( Egdb mode )

inlinestatic

Disables the specified debug mode.

Parameters

mode	The debug mode to disable.

DebugOn()

static void Enablegames.eagDebug.DebugOn ( Egdb mode )

inlinestatic

Turns on debugging for the specified mode(s).

Parameters

mode	The debug mode(s) to enable.

Log() [1/5]

static void Enablegames.eagDebug.Log ( Egdb mode, int level, string message )

inlinestatic

Writes a log message with the specified mode, level, and message.

Parameters

mode	The mode for the log message. Use the Egdb enumeration for available options.
level	The level of the log message.
message	The message to log.

Here is the call graph for this function:

Log() [2/5]

static void Enablegames.eagDebug.Log ( Egdb mode, string message )

inlinestatic

Logs a message to the log file.

Parameters

mode	The debug mode to log the message under.
message	The message to be logged.

Here is the call graph for this function:

Log() [3/5]

static void Enablegames.eagDebug.Log ( LogType type, Egdb mode, int level, string message )

inlinestatic

Logs a message with the specified type, debug mode, level, and message.

Parameters

type	The type of the log message (LogType).
mode	The debug mode (Egdb) for the log message.
level	The debug level (int) for the log message.
message	The log message (string).

Log() [4/5]

static void Enablegames.eagDebug.Log ( LogType type, Egdb mode, int level, string tag, string message )

inlinestatic

Logs a message with the specified log type, debug mode, level, tag, and message.

Parameters

type	The log type.
mode	The debug mode.
level	The debug level.
tag	The tag for the log message.
message	The log message.

Here is the caller graph for this function:

Log() [5/5]

static void Enablegames.eagDebug.Log ( string message )

inlinestatic

Logs a message to the debug console.

Parameters

message

The message to log.

Here is the call graph for this function:

LogError()

static void Enablegames.eagDebug.LogError ( Egdb mode, object error, Object target = null )

inlinestatic

Logs an error message with the specified debug mode.

Parameters

mode	The debug mode to associate with the error message.
error	The error message.
target	The object associated with the error message.

Here is the caller graph for this function:

LogException() [1/2]

static void Enablegames.eagDebug.LogException ( Egdb mode, Exception exception )

inlinestatic

Logs the specified exception if the given debug mode is enabled.

Parameters

mode	The debug mode to check if logging should be enabled.
exception	The exception to log.

LogException() [2/2]

static void Enablegames.eagDebug.LogException ( Egdb mode, Exception exception, GameObject target )

inlinestatic

Logs an exception if the specified debug mode is enabled.

Parameters

mode	The debug mode to check.
exception	The exception to log.
target	Optional target object associated with the exception.

LogWarning()

static void Enablegames.eagDebug.LogWarning ( Egdb mode, object warning, Object target = null )

inlinestatic

Logs a warning message.

Parameters

mode	The debug mode for which the warning is logged.
warning	The warning message.
target	Optional target object associated with the warning.

Here is the caller graph for this function:

Member Data Documentation

debugMode

Egdb Enablegames.eagDebug.debugMode = Egdb.None

static

The debug mode used by the eagDebug class for logging and debugging purposes.

debugMode is an enum member of the Egdb enum which represents different debug modes. The debug mode determines which types of debug information should be logged. By default, the debug mode is set to Egdb.None, indicating that no debug information should be logged. To enable specific debug modes, use the DebugOn method. To disable specific debug modes, use the DebugOff method.

// Enable the 'Suki' debug mode
eagDebug.DebugOn(Egdb.Suki);
// Disable the 'Parameters' debug mode
eagDebug.DebugOff(Egdb.Parameters);

loggerMode

Mode Enablegames.eagDebug.loggerMode = Mode.Default

static

Represents the logging mode for the eagDebug class.

The logger mode determines how the debug information is logged. The available modes are:

• Default: The default logging mode. The debug information is logged according to the specified debug mode flags.
• Separate: The debug information is logged in separate log files based on the specified debug mode flags.
• Unity: The debug information is logged using Unity's built-in logging system.

Property Documentation

Instance

eagDebug Enablegames.eagDebug.Instance

staticget

Represents the singleton instance of the eagDebug class.

The Instance property allows access to the singleton instance of the eagDebug class. If no instance exists, a new GameObject is created and the eagDebug component is added to it. The instance is then stored in the Instance property for future retrieval.

---

The documentation for this class was generated from the following file:

• /Users/yiyangshang/egdl2/Assets/eag/Scripts/enablegames/Debugging/eagDebug.cs