Add allow_close[] element to formspecs

v-rob · v-rob · commit 6353b9261690 · 2025-04-02T17:33:34.000-07:00
diff --git a/builtin/common/settings/dlg_change_mapgen_flags.lua b/builtin/common/settings/dlg_change_mapgen_flags.lua
@@ -177,6 +177,7 @@ local function get_formspec(dialogdata)
 
 	return (
 		"size[" .. width .. "," .. height + 0.25 .. ",true]" ..
+		"allow_close[false]" ..
 		create_textfield(description_box, setting_name, comment_text) ..
 		formspec ..
 		"button[" .. width / 2 - 2.5 .. "," .. height - 0.4 .. ";2.5,1;btn_done;" ..
diff --git a/builtin/common/settings/dlg_settings.lua b/builtin/common/settings/dlg_settings.lua
@@ -541,6 +541,7 @@ local function get_formspec(dialogdata)
 		"formspec_version[6]",
 		"size[", tostring(tabsize.width), ",", tostring(tabsize.height + extra_h), "]",
 		core.settings:get_bool("touch_gui") and "padding[0.01,0.01]" or "",
+		"allow_close[" .. tostring(dialogdata.allow_close) .. "]",
 		"bgcolor[#0000]",
 
 		-- HACK: this is needed to allow resubmitting the same formspec
@@ -809,6 +810,7 @@ if INIT == "mainmenu" then
 		local dlg = dialog_create("dlg_settings", get_formspec, buttonhandler, eventhandler)
 
 		dlg.data.page_id = update_filtered_pages("")
+		dlg.data.allow_close = false
 
 		return dlg
 	end
@@ -834,6 +836,7 @@ else
 		dialog = {}
 		dialog.data = {}
 		dialog.data.page_id = update_filtered_pages("")
+		dialog.data.allow_close = true
 		dialog.delete = function()
 			dialog = nil
 			-- only needed for the "fields.back" case, in the "fields.quit"
diff --git a/builtin/fstk/tabview.lua b/builtin/fstk/tabview.lua
@@ -85,6 +85,9 @@ local function get_formspec(self)
 		if tab.formspec_version then
 			prepend = ("formspec_version[%d]"):format(tab.formspec_version) .. prepend
 		end
+
+		prepend = prepend .. "allow_close[false]"
+
 	end
 
 	local end_button_size = 0.75
diff --git a/builtin/fstk/ui.lua b/builtin/fstk/ui.lua
@@ -57,6 +57,7 @@ function ui.get_message_formspec(title, message, btn_id)
 	return table.concat({
 		"size[14,8]",
 		"real_coordinates[true]",
+		"allow_close[false]",
 		"set_focus[", btn_id, ";true]",
 		"box[0.5,1.2;13,5;#000]",
 		("textarea[0.5,1.2;13,5;;%s;%s]"):format(title, message),
@@ -81,6 +82,7 @@ function ui.update()
 		formspec = {
 			"size[14,8]",
 			"real_coordinates[true]",
+			"allow_close[false]",
 			"set_focus[btn_reconnect_yes;true]",
 			"box[0.5,1.2;13,5;#000]",
 			("textarea[0.5,1.2;13,5;;%s;%s]"):format(
diff --git a/builtin/mainmenu/common.lua b/builtin/mainmenu/common.lua
@@ -285,6 +285,7 @@ end
 
 function confirmation_formspec(message, confirm_id, confirm_label, cancel_id, cancel_label)
 	return "size[10,2.5,true]" ..
+			"allow_close[false]" ..
 			"label[0.5,0.5;" .. message .. "]" ..
 			"style[" .. confirm_id .. ";bgcolor=red]" ..
 			"button[0.5,1.5;2.5,0.5;" .. confirm_id .. ";" .. confirm_label .. "]" ..
diff --git a/builtin/mainmenu/content/dlg_contentdb.lua b/builtin/mainmenu/content/dlg_contentdb.lua
@@ -133,6 +133,7 @@ local function get_info_formspec(size, padding, text)
 		"formspec_version[6]",
 		"size[", size.x, ",", size.y, "]",
 		"padding[0,0]",
+		"allow_close[false]",
 		"bgcolor[;true]",
 
 		"label[", padding.x + 3.625, ",4.35;", text, "]",
@@ -232,6 +233,7 @@ local function get_formspec(dlgdata)
 		"formspec_version[7]",
 		"size[", size.x, ",", size.y, "]",
 		"padding[0,0]",
+		"allow_close[false]",
 		"bgcolor[;true]",
 
 		"container[", window_padding.x, ",", window_padding.y, "]",
diff --git a/builtin/mainmenu/content/dlg_install.lua b/builtin/mainmenu/content/dlg_install.lua
@@ -29,6 +29,7 @@ local function get_loading_formspec()
 		"formspec_version[3]",
 		"size[", w, ",9.05]",
 		TOUCH_GUI and "padding[0.01,0.01]" or "position[0.5,0.55]",
+		"allow_close[false]",
 		"label[3,4.525;", fgettext("Loading..."), "]",
 	}
 	return table.concat(formspec)
@@ -122,6 +123,7 @@ local function get_formspec(data)
 		"formspec_version[3]",
 		"size[", w, ",9.05]",
 		TOUCH_GUI and "padding[0.01,0.01]" or "position[0.5,0.55]",
+		"allow_close[false]",
 		"style[title;border=false]",
 		"box[0,0;", w, ",0.8;#3333]",
 		"button[0,0;", w, ",0.8;title;", fgettext("Install $1", package.title) , "]",
diff --git a/builtin/mainmenu/content/dlg_package.lua b/builtin/mainmenu/content/dlg_package.lua
@@ -21,6 +21,7 @@ local function get_info_formspec(size, padding, text)
 		"formspec_version[6]",
 		"size[", size.x, ",", size.y, "]",
 		"padding[0,0]",
+		"allow_close[false]",
 		"bgcolor[;true]",
 
 		"label[4,4.35;", text, "]",
@@ -83,6 +84,7 @@ local function get_formspec(data)
 		"formspec_version[7]",
 		"size[", size.x, ",",  size.y, "]",
 		"padding[0,0]",
+		"allow_close[false]",
 		"bgcolor[;true]",
 
 		"container[", window_padding.x, ",", window_padding.y, "]",
diff --git a/builtin/mainmenu/dlg_clients_list.lua b/builtin/mainmenu/dlg_clients_list.lua
@@ -20,6 +20,7 @@ local function clients_list_formspec(dialogdata)
 		"formspec_version[8]",
 		"size[6,9.5]",
 		TOUCH_GUI and "padding[0.01,0.01]" or "",
+		"allow_close[false]",
 		"hypertext[0,0;6,1.5;;<global margin=5 halign=center valign=middle>",
 			fgettext("Players connected to\n$1",
 				"<b>" .. core.hypertext_escape(servername) .. "</b>") .. "]",
diff --git a/builtin/mainmenu/dlg_config_world.lua b/builtin/mainmenu/dlg_config_world.lua
@@ -125,6 +125,7 @@ local function get_formspec(data)
 
 	local retval =
 		"size[11.5,7.5,true]" ..
+		"allow_close[false]" ..
 		"label[0.5,0;" .. fgettext("World:") .. "]" ..
 		"label[1.75,0;" .. core.formspec_escape(data.worldspec.name) .. "]"
 
diff --git a/builtin/mainmenu/dlg_create_world.lua b/builtin/mainmenu/dlg_create_world.lua
@@ -282,6 +282,7 @@ local function create_world_formspec(dialogdata)
 
 	local retval =
 		"size[12.25,7.4,true]" ..
+		"allow_close[false]" ..
 
 		-- Left side
 		"container[0,0]"..
diff --git a/builtin/mainmenu/dlg_register.lua b/builtin/mainmenu/dlg_register.lua
@@ -27,6 +27,7 @@ local function register_formspec(dialogdata)
 	local retval = {
 		"formspec_version[4]",
 		"size[8,", tostring(buttons_y + 1.175), "]",
+		"allow_close[false]",
 		"set_focus[", (dialogdata.name ~= "" and "password" or "name"), "]",
 		"label[0.375,0.8;", title, "]",
 		"field[0.375,1.575;7.25,0.8;name;", core.formspec_escape(fgettext("Name")), ";",
diff --git a/builtin/mainmenu/dlg_reinstall_mtg.lua b/builtin/mainmenu/dlg_reinstall_mtg.lua
@@ -76,6 +76,7 @@ local function get_formspec(dialogdata)
 	return table.concat({
 		"formspec_version[6]",
 		"size[12.8,7]",
+		"allow_close[false]",
 		"hypertext[0.375,0.375;12.05,5.2;text;", core.formspec_escape(markup), "]",
 		"container[0.375,5.825]",
 		"style[dismiss;bgcolor=red]",
diff --git a/builtin/mainmenu/dlg_rename_modpack.lua b/builtin/mainmenu/dlg_rename_modpack.lua
@@ -20,6 +20,7 @@
 local function rename_modpack_formspec(dialogdata)
 	local retval =
 		"size[11.5,4.5,true]" ..
+		"allow_close[false]" ..
 		"button[3.25,3.5;2.5,0.5;dlg_rename_modpack_confirm;"..
 				fgettext("Accept") .. "]" ..
 		"button[5.75,3.5;2.5,0.5;dlg_rename_modpack_cancel;"..
diff --git a/builtin/mainmenu/dlg_server_list_mods.lua b/builtin/mainmenu/dlg_server_list_mods.lua
@@ -61,6 +61,7 @@ local function get_formspec(dialogdata)
 		"formspec_version[8]",
 		"size[8,9.5]",
 		TOUCH_GUI and "padding[0.01,0.01]" or "",
+		"allow_close[false]",
 		"hypertext[0,0;8,1.5;;<global margin=5 halign=center valign=middle>", heading, "]",
 		"tablecolumns[", group_by_prefix and
 			(expand_all and "indent;text" or "tree;text") or "text", "]",
diff --git a/doc/lua_api.md b/doc/lua_api.md
@@ -2866,6 +2866,13 @@ Elements
 * For information on converting forms to the new coordinate system, see `Migrating
   to Real Coordinates`.
 
+### `allow_close[<bool>]`
+
+* When set to false, the formspec will not close when the user tries to close
+  it with the Escape key or similar. Default true.
+* The formspec can still be closed with `button_exit[]` elements and
+  `core.close_formspec()`, regardless of this setting.
+
 ### `container[<X>,<Y>]`
 
 * Start of a container block, moves all physical elements in the container by
@@ -6166,8 +6173,10 @@ Call these functions only at load time!
         * `table`: See `core.explode_table_event`
         * `scrollbar`: See `core.explode_scrollbar_event`
         * Special case: `["quit"]="true"` is sent when the user actively
-          closed the form by mouse click, keypress or through a button_exit[]
+          closed the form by mouse click, keypress or through a `button_exit[]`
           element.
+        * Special case: `["try_quit"]="true"` is sent when the user tries to
+          close the formspec, but the the formspec used `allow_close[false]`.
         * Special case: `["key_enter"]="true"` is sent when the user pressed
           the Enter key and the focus was either nowhere (causing the formspec
           to be closed) or on a button. If the focus was on a text field,
diff --git a/games/devtest/mods/testformspec/formspec.lua b/games/devtest/mods/testformspec/formspec.lua
@@ -339,10 +339,11 @@ local pages = {
 	[[
 		formspec_version[3]
 		size[12,13]
+		allow_close[false]
 		image_button[0,0;1,1;logo.png;rc_image_button_1x1;1x1]
-		image_button[1,0;2,2;logo.png;rc_image_button_2x2;2x2]
+		image_button_exit[1,0;2,2;logo.png;rc_image_button_2x2;2x2 exit]
 		button[0,2;1,1;rc_button_1x1;1x1]
-		button[1,2;2,2;rc_button_2x2;2x2]
+		button_exit[1,2;2,2;rc_button_2x2;2x2 exit]
 		item_image[0,4;1,1;air]
 		item_image[1,4;2,2;air]
 		item_image_button[0,6;1,1;testformspec:node;rc_item_image_button_1x1;1x1]
@@ -575,6 +576,10 @@ core.register_on_player_receive_fields(function(player, formname, fields)
 	if fields.submit_window then
 		show_test_formspec(player:get_player_name())
 	end
+
+	if fields.try_quit then
+		core.chat_send_player(player:get_player_name(), "Quit attempt received")
+	end
 end)
 
 core.register_chatcommand("test_formspec", {
diff --git a/src/client/game.cpp b/src/client/game.cpp
@@ -1048,10 +1048,6 @@ void Game::shutdown()
 	if (g_touchcontrols)
 		g_touchcontrols->hide();
 
-	// only if the shutdown progress bar isn't shown yet
-	if (m_shutdown_progress == 0.0f)
-		showOverlayMessage(N_("Shutting down..."), 0, 0);
-
 	clouds.reset();
 
 	gui_chat_console.reset();
@@ -1063,6 +1059,10 @@ void Game::shutdown()
 		g_menumgr.deleteFront();
 	}
 
+	// only if the shutdown progress bar isn't shown yet
+	if (m_shutdown_progress == 0.0f)
+		showOverlayMessage(N_("Shutting down..."), 0, 0);
+
 	chat_backend->addMessage(L"", L"# Disconnected.");
 	chat_backend->addMessage(L"", L"");
 
diff --git a/src/gui/guiEngine.cpp b/src/gui/guiEngine.cpp
@@ -168,7 +168,6 @@ GUIEngine::GUIEngine(JoystickController *joystick,
 			"",
 			false);
 
-	m_menu->allowClose(false);
 	m_menu->lockSize(true,v2u32(800,600));
 
 	// Initialize scripting
diff --git a/src/gui/guiFormSpecMenu.cpp b/src/gui/guiFormSpecMenu.cpp
diff --git a/src/gui/guiFormSpecMenu.h b/src/gui/guiFormSpecMenu.h
