ConsoleInGame/Console.cs

Go to the documentation of this file.

using System;
 
namespace UnityEngine
{
    public abstract class Console : MonoBehaviour
    {
        internal string fullLog = "";
        
        private string filename = "";
        
        [Tooltip("If the console must be displayed or not.")]
        [SerializeField] protected bool show = true;
        
        [Tooltip("Should the console toggle on and off pressing the 'Toggle key'?")]
        [SerializeField] protected bool enableKeyToggle = true;
        
        [Tooltip("Key to toggle on-off the in-game console.")]
        [SerializeField] public KeyCode toggleKey = KeyCode.Space;
        
        [Tooltip("Should the logs be saved to a file in the desktop?")]
        [SerializeField] public bool saveToFile = false;
        
        [Tooltip("Maximum amount of characters displayed by the console.")]
        [SerializeField] public int maxDisplayedChars = 700;
        
        protected void OnEnable() { Application.logMessageReceived += Log; UpdateVisuals(); }
        protected void OnDisable() { Application.logMessageReceived -= Log; }
        protected void Awake() { UpdateVisuals(); }
        
        public void ToggleShow()
        {
            SetShow(!show);
        }
        
        public void SetShow(bool newValue)
        {
            show = newValue;
            UpdateVisuals();
        }
 
        private void Update()
        {
            if (enableKeyToggle && Input.GetKeyDown(toggleKey))
            {
                ToggleShow();
            }
        }
 
        private void Log(string logString, string stackTrace, LogType type)
        {
            // Keep track of the full log
            fullLog = fullLog + "\n" + logString;
            if (fullLog.Length > maxDisplayedChars)
            {
                fullLog = fullLog.Substring(fullLog.Length - maxDisplayedChars);
            }
            
 
            // Save the log in a file
            if (saveToFile)
            {
                if (filename == "")
                {
                    string desktopFolder = System.Environment.GetFolderPath(System.Environment.SpecialFolder.Desktop) + "/Unity_Console_Logs";
                    System.IO.Directory.CreateDirectory(desktopFolder);
                    string date = System.DateTime.Now.ToString("yyyy-MM-dd_HH-mm-ss");
                    filename = desktopFolder + $"/log_{Utils.GetProjectName()}_{date}.txt";
                }
                try
                {
                    System.IO.File.AppendAllText(filename, logString + "\n\n");
                }
                catch (Exception e)
                {
                    Debug.LogError($"Console logs could not be saved:\n{e.Message}");
                }
            }
            
            UpdateVisuals();
        }
 
        protected abstract void UpdateVisuals();
 
        public void Clear()
        {
            fullLog = "";
            filename = "";
            UpdateVisuals();
        }
    }
 
}