Tuesday, June 24, 2014

Unity 3D ErrorManager (text logging)

Edit: Use this with Unity 4.5.x and older; for Unity 4.6 and up, please see THIS update

While I've named it ErrorManager; it could just as easily have been named TextLogManager because it can be use for so much more than just errors.

Here's the top part of the C# file - see below for download link
/// <summary>
/// ErrorLogManager 
///     - Primaryused to log errors to text file
/// Created byGregory Meach
/// DateJune 232014
/// Version1.0 (initial release)
/// LicenseDo what you wantno credit necessary
/// LiabilityNone whatsoever.
/// Example: (called from ANY other class)    
///     ErrorLogManager.sharedManager.UpdateErrorLog("fakeMethod","not found",ErrorLogManager.sharedManager.GetErrorDate());
/// Note:
///     GetErrorDate() helper returns "nowas a string
/// </summary>

public class ErrorLogManager : MonoBehaviour {
    #region ErrorLog
    public class ErrorData {
        public string method;
        public string error;
        public string dateString;
    public List<ErrorDataErrorList = new List<ErrorData>();
    private string currentLogName = string.Empty;
    private string logInitText = string.Empty;
    private bool isFirstSave = true;

    // Set this to whatever name you want to use
    private string errorLogName = "Game_ErrorLog";

    // Set this to the maximum log entries before they are auto-saved
    private int maxLogEntriesBeforeSave = 30;

    // Set this to TRUE to overwrite the log file on startup
    private bool clearErrorLogOnStartup = false;

    // Set this to FALSE to overwrite the log file on startup
    private bool useTimeStampInFileName = true;

    // Helper methods
    public string GetErrorDate() { return System.DateTime.Now.ToString("s"); }
    public string GetSavedDataPath() { return (Application.persistentDataPath + Path.DirectorySeparatorChar); }
    public string GetFileDate() { 
        string dateString = System.DateTime.Now.ToString("d"); 
        dateString = dateString.Replace("/",".");
        return dateString;

    public void UpdateErrorLog(string callingMethodstring errorMsgstring errorDate) {
        ErrorData newError = new ErrorData();
        newError.method = callingMethod;
        newError.error = errorMsg;
        newError.dateString = errorDate;
        if (ErrorList.Count > maxLogEntriesBeforeSave)

Here's the package link: ErrorManager_v1.0.unitypackage