Function ScriptCompileErrorHook

primedev/squirrel/squirrel.cpp:431–486

template <ScriptContext context> void (*SQCompileError)(HSQUIRRELVM sqvm, const char* error, const char* file, int line, int column);
template <ScriptContext context>
void __fastcall ScriptCompileErrorHook(HSQUIRRELVM sqvm, const char* error, const char* file, int line, int column)
{
	bool bIsFatalError = g_pSquirrel[context]->m_bFatalCompilationErrors;
	ScriptContext realContext = context; // ui and client use the same function so we use this for prints
	if (IsUIVM(context, sqvm))
	{
		realContext = ScriptContext::UI;
		bIsFatalError = g_pSquirrel[ScriptContext::UI]->m_bFatalCompilationErrors;
	}

	auto logger = getSquirrelLoggerByContext(realContext);

	const char* ownerName = "Vanilla";
	std::string filePath = g_pModManager->NormaliseModFilePath(fs::path("scripts/vscripts") / file);
	auto it = g_pModManager->m_ModFiles.find(filePath);
	if (it != g_pModManager->m_ModFiles.end())
	{
		ModOverrideFile& modFile = it->second;
		ownerName = modFile.m_pOwningMod ? modFile.m_pOwningMod->Name.c_str() : "Unknown";
	}

	logger->error("COMPILE ERROR {}", error);
	logger->error("{} line [{}] column [{}]", file, line, column);
	logger->error("This can be caused by a broken mod, or incompatibilities between mods.");
	logger->error("{} belongs to {}", file, ownerName);

	// use disconnect to display an error message for the compile error, but only if the compilation error was fatal
	// todo, we could get this from sqvm itself probably, rather than hooking sq_compiler_create
	if (bIsFatalError)
	{
		// kill dedicated server if we hit this
		if (IsDedicatedServer())
		{
			logger->error("Exiting dedicated server, compile error is fatal");
			// flush the logger before we exit so debug things get saved to log file
			logger->flush();
			exit(EXIT_FAILURE);
		}
		else
		{
			Cbuf_AddText(
				Cbuf_GetCurrentPlayer(),
				fmt::format("disconnect \"Encountered {} script compilation error, see console for details.\"", GetContextName(realContext))
					.c_str(),
				cmd_source_t::kCommandSrcCode);

			// likely temp: show console so user can see any errors, as error message wont display if ui is dead
			// maybe we could disable all mods other than the coremods and try a reload before doing this?
			// could also maybe do some vgui bullshit to show something visually rather than console
			if (realContext == ScriptContext::UI)
				Cbuf_AddText(Cbuf_GetCurrentPlayer(), "showconsole", cmd_source_t::kCommandSrcCode);
		}
	}

	// dont call the original function since it kills game lol
}

template <ScriptContext context> int64_t (*RegisterSquirrelFunction)(CSquirrelVM* sqvm, SQFuncRegistration* funcReg, char unknown);