From 65d7b290a3f7a859d2a75fa44e4c3109684f63b1 Mon Sep 17 00:00:00 2001
From: Myk Taylor <myk002@yahoo.com>
Date: Mon, 24 Apr 2023 14:32:33 -0700
Subject: [PATCH] add ZScreenModal class for modal dialogs

---
 docs/changelog.txt   |  1 +
 docs/dev/Lua API.rst |  7 +++++++
 library/lua/gui.lua  | 13 +++++++++++--
 3 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/docs/changelog.txt b/docs/changelog.txt
index a3e9c6f6c..2b3438cc5 100644
--- a/docs/changelog.txt
+++ b/docs/changelog.txt
@@ -55,6 +55,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
 
 ## Lua
 - ``widgets.RangeSlider``: new mouse-controlled two-headed slider widget
+- ``gui.ZScreenModal``: ZScreen subclass for modal dialogs
 
 ## Removed
 - `title-version`: replaced by an `overlay` widget
diff --git a/docs/dev/Lua API.rst b/docs/dev/Lua API.rst
index 078cec828..9c320fc98 100644
--- a/docs/dev/Lua API.rst	
+++ b/docs/dev/Lua API.rst	
@@ -4323,6 +4323,13 @@ Here is an example skeleton for a ZScreen tool window::
 
     view = view and view:raise() or MyScreen{}:show()
 
+ZScreenModal class
+------------------
+
+A ZScreen convenience subclass that sets the attributes to something
+appropriate for modal dialogs. The game is force paused, and no input is passed
+through to the underlying viewscreens.
+
 FramedScreen class
 ------------------
 
diff --git a/library/lua/gui.lua b/library/lua/gui.lua
index e425dbcf1..b2c90d076 100644
--- a/library/lua/gui.lua
+++ b/library/lua/gui.lua
@@ -867,8 +867,17 @@ function ZScreen:onGetSelectedPlant()
     return zscreen_get_any(self, 'Plant')
 end
 
---------------------------
--- Framed screen object --
+-- convenience subclass for modal dialogs
+ZScreenModal = defclass(ZScreenModal, ZScreen)
+ZScreenModal.ATTRS{
+    defocusable = false,
+    force_pause = true,
+    pass_pause = false,
+    pass_movement_keys = false,
+    pass_mouse_clicks = false,
+}
+
+-- Framed screen object
 --------------------------
 
 -- Plain grey-colored frame.