In-game settings menu using separate Lua environment (#15614)

src/script/cpp_api/CMakeLists.txt

@@ -16,6 +16,8 @@ set(common_SCRIPT_CPP_API_SRCS
 
 set(client_SCRIPT_CPP_API_SRCS
 	${CMAKE_CURRENT_SOURCE_DIR}/s_client.cpp
+	${CMAKE_CURRENT_SOURCE_DIR}/s_client_common.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/s_mainmenu.cpp
+	${CMAKE_CURRENT_SOURCE_DIR}/s_pause_menu.cpp
 	PARENT_SCOPE)
 

src/script/cpp_api/s_base.cpp

@@ -203,9 +203,13 @@ void ScriptApiBase::checkSetByBuiltin()
 {
 	lua_State *L = getStack();
 
-	if (m_gamedef) {
-		CHECK(CUSTOM_RIDX_READ_VECTOR, "read_vector");
-		CHECK(CUSTOM_RIDX_PUSH_VECTOR, "push_vector");
+	CHECK(CUSTOM_RIDX_READ_VECTOR, "read_vector");
+	CHECK(CUSTOM_RIDX_PUSH_VECTOR, "push_vector");
+
+	if (getType() == ScriptingType::Server ||
+			(getType() == ScriptingType::Async && m_gamedef) ||
+			getType() == ScriptingType::Emerge ||
+			getType() == ScriptingType::Client) {
 		CHECK(CUSTOM_RIDX_READ_NODE, "read_node");
 		CHECK(CUSTOM_RIDX_PUSH_NODE, "push_node");
 	}

src/script/cpp_api/s_base.h

@@ -47,7 +47,8 @@ enum class ScriptingType: u8 {
 	Client,
 	MainMenu,
 	Server,
-	Emerge
+	Emerge,
+	PauseMenu,
 };
 
 class Server;

src/script/cpp_api/s_client.cpp

@@ -126,34 +126,6 @@ void ScriptApiClient::environment_step(float dtime)
 	}
 }
 
-void ScriptApiClient::on_formspec_input(const std::string &formname,
-	const StringMap &fields)
-{
-	SCRIPTAPI_PRECHECKHEADER
-
-	// Get core.registered_on_chat_messages
-	lua_getglobal(L, "core");
-	lua_getfield(L, -1, "registered_on_formspec_input");
-	// Call callbacks
-	// param 1
-	lua_pushstring(L, formname.c_str());
-	// param 2
-	lua_newtable(L);
-	StringMap::const_iterator it;
-	for (it = fields.begin(); it != fields.end(); ++it) {
-		const std::string &name = it->first;
-		const std::string &value = it->second;
-		lua_pushstring(L, name.c_str());
-		lua_pushlstring(L, value.c_str(), value.size());
-		lua_settable(L, -3);
-	}
-	try {
-		runCallbacks(2, RUN_CALLBACKS_MODE_OR_SC);
-	} catch (LuaError &e) {
-		getClient()->setFatalError(e);
-	}
-}
-
 bool ScriptApiClient::on_dignode(v3s16 p, MapNode node)
 {
 	SCRIPTAPI_PRECHECKHEADER

src/script/cpp_api/s_client.h

@@ -35,7 +35,6 @@ public:
 	void on_damage_taken(int32_t damage_amount);
 	void on_hp_modification(int32_t newhp);
 	void environment_step(float dtime);
-	void on_formspec_input(const std::string &formname, const StringMap &fields);
 
 	bool on_dignode(v3s16 p, MapNode node);
 	bool on_punchnode(v3s16 p, MapNode node);

src/script/cpp_api/s_client_common.cpp

@@ -0,0 +1,39 @@
+// Luanti
+// SPDX-License-Identifier: LGPL-2.1-or-later
+// Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+// Copyright (C) 2017 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
+// Copyright (C) 2025 grorp
+
+#include "s_client_common.h"
+#include "s_internal.h"
+#include "client/client.h"
+
+bool ScriptApiClientCommon::on_formspec_input(const std::string &formname,
+		const StringMap &fields)
+{
+	SCRIPTAPI_PRECHECKHEADER
+
+	// Get core.registered_on_formspec_inputs
+	lua_getglobal(L, "core");
+	lua_getfield(L, -1, "registered_on_formspec_input");
+	// Call callbacks
+	// param 1
+	lua_pushstring(L, formname.c_str());
+	// param 2
+	lua_newtable(L);
+	StringMap::const_iterator it;
+	for (it = fields.begin(); it != fields.end(); ++it) {
+		const std::string &name = it->first;
+		const std::string &value = it->second;
+		lua_pushstring(L, name.c_str());
+		lua_pushlstring(L, value.c_str(), value.size());
+		lua_settable(L, -3);
+	}
+	try {
+		runCallbacks(2, RUN_CALLBACKS_MODE_OR_SC);
+	} catch (LuaError &e) {
+		getClient()->setFatalError(e);
+		return true;
+	}
+	return readParam<bool>(L, -1);
+}

src/script/cpp_api/s_client_common.h

@@ -0,0 +1,16 @@
+// Luanti
+// SPDX-License-Identifier: LGPL-2.1-or-later
+// Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+// Copyright (C) 2017 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
+// Copyright (C) 2025 grorp
+
+#pragma once
+
+#include "cpp_api/s_base.h"
+#include "util/string.h"
+
+class ScriptApiClientCommon : virtual public ScriptApiBase
+{
+public:
+	bool on_formspec_input(const std::string &formname, const StringMap &fields);
+};

src/script/cpp_api/s_pause_menu.cpp

@@ -0,0 +1,20 @@
+// Luanti
+// SPDX-License-Identifier: LGPL-2.1-or-later
+// Copyright (C) 2025 grorp
+
+#include "s_pause_menu.h"
+#include "cpp_api/s_internal.h"
+
+void ScriptApiPauseMenu::open_settings()
+{
+	SCRIPTAPI_PRECHECKHEADER
+
+	int error_handler = PUSH_ERROR_HANDLER(L);
+
+	lua_getglobal(L, "core");
+	lua_getfield(L, -1, "open_settings");
+
+	PCALL_RES(lua_pcall(L, 0, 0, error_handler));
+
+	lua_pop(L, 2); // Pop core, error handler
+}

src/script/cpp_api/s_pause_menu.h

@@ -0,0 +1,13 @@
+// Luanti
+// SPDX-License-Identifier: LGPL-2.1-or-later
+// Copyright (C) 2025 grorp
+
+#pragma once
+
+#include "cpp_api/s_base.h"
+
+class ScriptApiPauseMenu : virtual public ScriptApiBase
+{
+public:
+	void open_settings();
+};