NOTE: This class is deprecated. Use Logging instead (see ExampleMod for example) This class consists of functions that write error messages to text files for you to read. It also lets you write logs to text files. More...

Collaboration diagram for Terraria.ModLoader.ErrorLogger:

Static Public Member Functions
static void	ClearLogs ()
	NOTE: Deprecated. Deletes all log files. More...

static void	Log (object param, bool alternateOutput=false)
	NOTE: Deprecated. Please use your own ILog instead, see ExampleMod for an example Allows you to log an object for your own testing purposes. The message will be added to the Logs.txt file in the Logs folder. More...

static void	Log (string message)
	NOTE: Deprecated. Please use your own ILog instead, see ExampleMod for an example You can use this method for your own testing purposes. The message will be added to the Logs.txt file in the Logs folder. More...

Static Public Attributes
static readonly string	LogPath = Logging.LogDir
	NOTE: Deprecated. Use Logging.LogDir instead The file path to which logs are written and stored. More...

Static Private Attributes
static Object	logLock = new Object()

Detailed Description

NOTE: This class is deprecated. Use Logging instead (see ExampleMod for example) This class consists of functions that write error messages to text files for you to read. It also lets you write logs to text files.

Definition at line 15 of file ErrorLogger.cs.

Member Function Documentation

◆ ClearLogs()

static void Terraria.ModLoader.ErrorLogger.ClearLogs ( )

static

NOTE: Deprecated. Deletes all log files.

Definition at line 81 of file ErrorLogger.cs.

                                       {
            lock (logLock) {
                if (!Directory.Exists(Logging.LogDir))
                    Directory.CreateDirectory(Logging.LogDir);
 
                string[] files = new string[] {
                    LogPath + Path.DirectorySeparatorChar + "Logs.txt",
                    LogPath + Path.DirectorySeparatorChar + "Network Error.txt",
                    LogPath + Path.DirectorySeparatorChar + "Runtime Error.txt",
                };
                foreach (var file in files) {
                    try {
                        File.Delete(file);
                    }
                    catch (Exception) {
                        // Don't worry about it, modder or player might have the file open in tail or notepad.
                    }
                }
            }
        }

References Terraria.ModLoader.Logging.LogDir, Terraria.ModLoader.ErrorLogger.logLock, and Terraria.ModLoader.ErrorLogger.LogPath.

◆ Log() [1/2]

static void Terraria.ModLoader.ErrorLogger.Log	(	object	param,
		bool	alternateOutput = `false`
	)

static

NOTE: Deprecated. Please use your own ILog instead, see ExampleMod for an example Allows you to log an object for your own testing purposes. The message will be added to the Logs.txt file in the Logs folder.

Parameters

param	The object to be logged.
alternateOutput	If true, the object's data will be manually retrieved and logged. If false, the object's ToString method is logged.

Definition at line 47 of file ErrorLogger.cs.

                                                                           {
            string getParamString() {
                StringBuilder sb = new StringBuilder();
                sb.AppendLine("Object type: " + param.GetType());
                foreach (PropertyInfo property in param.GetType().GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)) {
                    sb.AppendLine("PROPERTY " + property.Name + " = " + property.GetValue(param, null) + "\n");
                }
 
                foreach (FieldInfo field in param.GetType().GetFields(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)) {
                    sb.AppendLine("FIELD " + field.Name + " = " + (field.GetValue(param).ToString() != "" ? field.GetValue(param) : "(Field value not found)") + "\n");
                }
 
                foreach (MethodInfo method in param.GetType().GetMethods(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)) {
                    sb.AppendLine("METHOD " + method.Name + "\n");
                }
 
                int temp = 0;
 
                foreach (ConstructorInfo constructor in param.GetType().GetConstructors(BindingFlags.Public | BindingFlags.NonPublic)) {
                    temp++;
                    sb.AppendLine("CONSTRUCTOR " + temp + " : " + constructor.Name + "\n");
                }
 
                return sb.ToString();
            }
 
            Log(!alternateOutput ? param.ToString() : getParamString());
        }

References Terraria.ModLoader.ErrorLogger.Log().

Here is the call graph for this function:

◆ Log() [2/2]

static void Terraria.ModLoader.ErrorLogger.Log ( string message )

static

NOTE: Deprecated. Please use your own ILog instead, see ExampleMod for an example You can use this method for your own testing purposes. The message will be added to the Logs.txt file in the Logs folder.

Definition at line 30 of file ErrorLogger.cs.

        {
            if (AssemblyManager.FirstModInStackTrace(new StackTrace(), out string modName) && ModLoader.GetMod(modName) is Mod mod) {
                mod.Logger.Info(message);
            }
            else {
                Logging.tML.WarnFormat("Tried to forward ErrorLogger.Log for mod {0} but failed (mod not found!)", modName);
            }
        }