From 9db3619cd8ce38759cc8448fe16bd112401682b8 Mon Sep 17 00:00:00 2001
From: Lion Kortlepel <development@kortlepel.com>
Date: Sun, 14 Jul 2024 01:50:31 +0200
Subject: [PATCH] cleanup and add comments to traceback feature

---
 src/TLuaEngine.cpp | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/src/TLuaEngine.cpp b/src/TLuaEngine.cpp
index 924db0f..5676a38 100644
--- a/src/TLuaEngine.cpp
+++ b/src/TLuaEngine.cpp
@@ -1161,10 +1161,9 @@ void TLuaEngine::StateThreadData::operator()() {
                         if (Error.has_value()) {
                             ErrorString = Error.value();
                         }
-                        auto DebugTracebackFn = sol::state_view(L).globals()
-                                                    .get<sol::table>("debug")
-                                                    .get<sol::protected_function>("traceback");
-                        std::string Traceback = DebugTracebackFn(ErrorString, 2); // refusing to elaborate. questions? rtfm.
+                        auto DebugTracebackFn = sol::state_view(L).globals().get<sol::table>("debug").get<sol::protected_function>("traceback");
+                        // 2 = start collecting the trace one above the current function (1=current function)
+                        std::string Traceback = DebugTracebackFn(ErrorString, 2);
                         return sol::stack::push(L, Traceback);
                     };
                     sol::protected_function Fn(RawFn, StateView["INTERNAL_ERROR_HANDLER"]);