Added error overlay which is used to display errors in a more user friendly way, currently only used if the CSharp compilation fails

This commit is contained in:
EvilFactory
2023-01-06 19:58:15 -03:00
parent 9fcab5ff60
commit 94c68b9fe6
7 changed files with 110 additions and 16 deletions
@@ -167,6 +167,25 @@ namespace Barotrauma
return syntaxTrees;
}
private ContentPackage FindSourcePackage(Diagnostic diagnostic)
{
if (diagnostic.Location.SourceTree == null)
{
return null;
}
string path = diagnostic.Location.SourceTree.FilePath;
foreach (var package in ContentPackageManager.AllPackages)
{
if (Path.GetFullPath(path).StartsWith(Path.GetFullPath(package.Dir)))
{
return package;
}
}
return null;
}
public List<Type> Compile()
{
IEnumerable<SyntaxTree> syntaxTrees = ParseSources();
@@ -188,6 +207,13 @@ namespace Barotrauma
foreach (Diagnostic diagnostic in failures)
{
errStr += $"\n{diagnostic}";
#if CLIENT
ContentPackage package = FindSourcePackage(diagnostic);
if (package != null)
{
LuaCsLogger.ShowErrorOverlay($"{package.Name} {package.ModVersion} is causing compilation errors. Check debug console for more details.", 7f, 7f);
}
#endif
}
LuaCsLogger.LogError(errStr, LuaCsMessageOrigin.CSharpMod);
}
@@ -13,12 +13,16 @@ namespace Barotrauma
CSharpMod,
}
class LuaCsLogger
partial class LuaCsLogger
{
#if SERVER
private const string LogPrefix = "SV";
private const int NetMaxLength = 1024;
private const int NetMaxMessages = 60;
// This is used so its possible to call logging functions inside the serverLog
// hook without creating an infinite loop
private static bool lockLog = false;
#else
private const string LogPrefix = "CL";
#endif
@@ -94,10 +98,6 @@ namespace Barotrauma
#endif
}
// This is used so its possible to call logging functions inside the serverLog
// hook without creating an infinite loop
private static bool lockLog = false;
public static void Log(string message, Color? color = null, ServerLog.MessageType messageType = ServerLog.MessageType.ServerMessage)
{
MessageLogger?.Invoke(message);
@@ -18,6 +18,7 @@ namespace Barotrauma
public bool ForceCsScripting = false;
public bool TreatForcedModsAsNormal = false;
public bool PreferToUseWorkshopLuaSetup = false;
public bool DisableErrorGUIOverlay = false;
public LuaCsSetupConfig() { }
}
@@ -91,14 +92,13 @@ namespace Barotrauma
{
Config = new LuaCsSetupConfig();
}
}
public void UpdateConfig()
{
FileStream file;
if (!File.Exists(configFileName)) file = File.Create(configFileName);
else file = File.Open(configFileName, FileMode.Truncate, FileAccess.Write);
if (!File.Exists(configFileName)) { file = File.Create(configFileName); }
else { file = File.Open(configFileName, FileMode.Truncate, FileAccess.Write); }
LuaCsConfig.Save(file, Config);
file.Close();
}
@@ -365,17 +365,12 @@ namespace Barotrauma
Stopwatch compilationTime = new Stopwatch();
compilationTime.Start();
var modTypes = CsScriptLoader.Compile();
modTypes.ForEach(t =>
{
try
{
t.GetConstructor(new Type[] { })?.Invoke(null);
}
catch (Exception ex)
{
LuaCsLogger.HandleException(ex, LuaCsMessageOrigin.CSharpMod);
}
t.GetConstructor(new Type[] { })?.Invoke(null);
});
compilationTime.Stop();
LuaCsLogger.LogMessage($"Took {compilationTime.ElapsedMilliseconds}ms to compile and run Cs Scripts.");
}