‪TechbloxModdingAPI  ‪v2.2.0
‪The unofficial Techblox modding API
TechbloxModdingAPI.Utility.Logging Class Reference

Utility class to access Techblox's built-in logging capabilities. The log is saved to APPDATA%..\LocalLow\FreeJam\Techblox\Player.Log More...

Static Public Member Functions

static void CommandLog (object obj)
 ‪Write a message to Techblox's command line More...
 
static void CommandLog (string msg)
 
static void CommandLogError (object obj)
 ‪Write an error message to Techblox's command line More...
 
static void CommandLogError (string msg)
 
static void CommandLogWarning (object obj)
 ‪Write a warning message to Techblox's command line More...
 
static void CommandLogWarning (string msg)
 
static void Log (object obj)
 ‪Write a regular message to Techblox's log More...
 
static void Log (string msg)
 
static void LogDebug (object obj)
 ‪Write a debug message to Techblox's log More...
 
static void LogDebug (string msg)
 
static void LogDebug< T > (object obj, T extraDebug)
 ‪Write a debug message and object to Techblox's log The reason this method exists in Svelto.Console is beyond my understanding More...
 
static void LogDebug< T > (string msg, T extraDebug)
 
static void LogError (object obj, Dictionary< string, string > extraData=null)
 ‪Write an error message to Techblox's log More...
 
static void LogError (string msg, Dictionary< string, string > extraData=null)
 
static void LogException (Exception e, object obj, Dictionary< string, string > extraData=null)
 ‪Write an exception message to Techblox's log and to the screen and exit game More...
 
static void LogException (Exception e, string msg=null, Dictionary< string, string > extraData=null)
 ‪Write an exception to Techblox's log and to the screen and exit game More...
 
static void LogWarning (object obj)
 ‪Write a warning message to Techblox's log More...
 
static void LogWarning (string msg)
 
static void MetaDebugLog (object obj)
 ‪Write a descriptive message to Techblox's log only when the API is a Debug build More...
 
static void MetaLog (object obj)
 ‪Write a descriptive message to Techblox's log including the current time and the calling method's name More...
 

Detailed Description

Utility class to access Techblox's built-in logging capabilities. The log is saved to APPDATA%..\LocalLow\FreeJam\Techblox\Player.Log

Member Function Documentation

◆ CommandLog() [1/2]

static void TechbloxModdingAPI.Utility.Logging.CommandLog ( object  obj)
inlinestatic

‪Write a message to Techblox's command line

Parameters
obj‪The object to log

◆ CommandLog() [2/2]

static void TechbloxModdingAPI.Utility.Logging.CommandLog ( string  msg)
inlinestatic

◆ CommandLogError() [1/2]

static void TechbloxModdingAPI.Utility.Logging.CommandLogError ( object  obj)
inlinestatic

‪Write an error message to Techblox's command line

Parameters
obj‪The object to log

◆ CommandLogError() [2/2]

static void TechbloxModdingAPI.Utility.Logging.CommandLogError ( string  msg)
inlinestatic

◆ CommandLogWarning() [1/2]

static void TechbloxModdingAPI.Utility.Logging.CommandLogWarning ( object  obj)
inlinestatic

‪Write a warning message to Techblox's command line

Parameters
obj‪The object to log

◆ CommandLogWarning() [2/2]

static void TechbloxModdingAPI.Utility.Logging.CommandLogWarning ( string  msg)
inlinestatic

◆ Log() [1/2]

static void TechbloxModdingAPI.Utility.Logging.Log ( object  obj)
inlinestatic

‪Write a regular message to Techblox's log

Parameters
obj‪The object to log

◆ Log() [2/2]

static void TechbloxModdingAPI.Utility.Logging.Log ( string  msg)
inlinestatic

◆ LogDebug() [1/2]

static void TechbloxModdingAPI.Utility.Logging.LogDebug ( object  obj)
inlinestatic

‪Write a debug message to Techblox's log

Parameters
obj‪The object to log

◆ LogDebug() [2/2]

static void TechbloxModdingAPI.Utility.Logging.LogDebug ( string  msg)
inlinestatic

◆ LogDebug< T >() [1/2]

static void TechbloxModdingAPI.Utility.Logging.LogDebug< T > ( object  obj,
extraDebug 
)
inlinestatic

‪Write a debug message and object to Techblox's log The reason this method exists in Svelto.Console is beyond my understanding

Template Parameters
T‪The type of the extra debug object
Parameters
obj‪The object to log
extraDebug‪The extra object to log

◆ LogDebug< T >() [2/2]

static void TechbloxModdingAPI.Utility.Logging.LogDebug< T > ( string  msg,
extraDebug 
)
inlinestatic

◆ LogError() [1/2]

static void TechbloxModdingAPI.Utility.Logging.LogError ( object  obj,
Dictionary< string, string >  extraData = null 
)
inlinestatic

‪Write an error message to Techblox's log

Parameters
obj‪The object to log
extraData‪The extra data to pass to the ILogger

◆ LogError() [2/2]

static void TechbloxModdingAPI.Utility.Logging.LogError ( string  msg,
Dictionary< string, string >  extraData = null 
)
inlinestatic

◆ LogException() [1/2]

static void TechbloxModdingAPI.Utility.Logging.LogException ( Exception  e,
object  obj,
Dictionary< string, string >  extraData = null 
)
inlinestatic

‪Write an exception message to Techblox's log and to the screen and exit game

Parameters
obj‪The object to log
e‪The exception to log
extraData‪The extra data to pass to the ILogger. This is implemented similar to LogException(Exception e, Dictionary extraData)'s extraData

◆ LogException() [2/2]

static void TechbloxModdingAPI.Utility.Logging.LogException ( Exception  e,
string  msg = null,
Dictionary< string, string >  extraData = null 
)
inlinestatic

‪Write an exception to Techblox's log and to the screen and exit game

Parameters
e‪The exception to log
extraData‪The extra data to pass to the ILogger. This is automatically populated with "OuterException#" and "OuterStacktrace#" entries

◆ LogWarning() [1/2]

static void TechbloxModdingAPI.Utility.Logging.LogWarning ( object  obj)
inlinestatic

‪Write a warning message to Techblox's log

Parameters
obj‪The object to log

◆ LogWarning() [2/2]

static void TechbloxModdingAPI.Utility.Logging.LogWarning ( string  msg)
inlinestatic

◆ MetaDebugLog()

static void TechbloxModdingAPI.Utility.Logging.MetaDebugLog ( object  obj)
inlinestatic

‪Write a descriptive message to Techblox's log only when the API is a Debug build

Parameters
obj‪The object to log

◆ MetaLog()

static void TechbloxModdingAPI.Utility.Logging.MetaLog ( object  obj)
inlinestatic

‪Write a descriptive message to Techblox's log including the current time and the calling method's name

Parameters
obj‪The object to log

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