PixelCrushers.DialogueSystem.DialogueDebug Class Reference

A simple static class to keep track of a global debug level setting for Dialogue System log messages. More...

Public Types

enum  DebugLevel { None = 0 , Error = 1 , Warning = 2 , Info = 3 }
 The debug levels. More...
 

Static Public Attributes

const string Prefix = "Dialogue System"
 Dialogue system log messages are prefixed with this string.
 

Properties

static DebugLevel level [get, set]
 The current global debug level.
 
static bool logInfo [get]
 Should the dialogue system log trace information?
 
static bool logWarnings [get]
 Should the dialogue system log warnings and trace info?
 
static bool logErrors [get]
 Should the dialogue system log critical errors?
 

Detailed Description

A simple static class to keep track of a global debug level setting for Dialogue System log messages.

The DialogueManager / DialogueSystemController sets level. You can also set it manually. This class doesn't provide any wrappers for Debug.Log() because they would intercept the reference point that the editor goes to when you double-click the log message in the console window.

Member Enumeration Documentation

◆ DebugLevel

The debug levels.

  • None: Don't log anything.
  • Error: Only log critical errors.
  • Warning: Log warnings and errors.
  • Info: Log trace information, warnings, and errors.
Enumerator
None 
Error 
Warning 
Info 

Member Data Documentation

◆ Prefix

const string PixelCrushers.DialogueSystem.DialogueDebug.Prefix = "Dialogue System"
static

Dialogue system log messages are prefixed with this string.

Property Documentation

◆ level

DebugLevel PixelCrushers.DialogueSystem.DialogueDebug.level
staticgetset

The current global debug level.

The level.

◆ logErrors

bool PixelCrushers.DialogueSystem.DialogueDebug.logErrors
staticget

Should the dialogue system log critical errors?

true to log errors; otherwise, false.

◆ logInfo

bool PixelCrushers.DialogueSystem.DialogueDebug.logInfo
staticget

Should the dialogue system log trace information?

true if it should log trace info, warnings, and errors; otherwise, false.

◆ logWarnings

bool PixelCrushers.DialogueSystem.DialogueDebug.logWarnings
staticget

Should the dialogue system log warnings and trace info?

true to log warnings and errors; otherwise, false.


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