Merge branch 'master' of https://github.com/minetest/minetest

1 files changed, 9 insertions, 0 deletions

diff --git a/src/script/cpp_api/s_base.h b/src/script/cpp_api/s_base.h
index e49745f4e..19ae8783b 100644
--- a/src/script/cpp_api/s_base.h
+++ b/src/script/cpp_api/s_base.h
@@ -128,6 +128,15 @@ protected:
 	friend class ModApiEnvMod;
 	friend class LuaVoxelManip;
 
+	/*
+		Subtle edge case with coroutines: If for whatever reason you have a
+		method in a subclass that's called from existing lua_CFunction
+		(any of the l_*.cpp files) then make it static and take the lua_State*
+		as an argument. This is REQUIRED because getStack() will not return the
+		correct state if called inside coroutines.
+
+		Also note that src/script/common/ is the better place for such helpers.
+	*/
 	lua_State* getStack()
 		{ return m_luastack; }