Merge branch 'viewport-resized-handler' into 'master'

Implement onViewportResized Handler

See merge request OpenMW/openmw!5276

Author: Capostrophic

apps/openmw/mwbase/luamanager.hpp

@@ -97,6 +97,7 @@ namespace MWBase
         virtual void questUpdated(const ESM::RefId& questId, int stage) = 0;
         // `arg` is either forwarded from MWGui::pushGuiMode or empty
         virtual void uiModeChanged(const MWWorld::Ptr& arg) = 0;
+        virtual void viewportResized(int width, int height) = 0;
         virtual void savePermanentStorage(const std::filesystem::path& userConfigPath) = 0;
 
         // TODO: notify LuaManager about other events

apps/openmw/mwgui/windowmanagerimp.cpp

@@ -1357,6 +1357,8 @@ namespace MWGui
         // Re-apply any controller-specific window changes.
         reapplyActiveControllerWindow();
 
+        MWBase::Environment::get().getLuaManager()->viewportResized(x, y);
+
         // TODO: check if any windows are now off-screen and move them back if so
     }
 

apps/openmw/mwlua/luamanagerimp.cpp

@@ -479,6 +479,18 @@ namespace MWLua
             playerScripts->uiModeChanged(argId, false);
     }
 
+    void LuaManager::viewportResized(int width, int height)
+    {
+        if (!mPlayer.isEmpty())
+        {
+            PlayerScripts* playerScripts = dynamic_cast<PlayerScripts*>(mPlayer.getRefData().getLuaScripts());
+            if (playerScripts)
+                playerScripts->onViewportResized(width, height);
+        }
+
+        mMenuScripts.onViewportResized(width, height);
+    }
+
     void LuaManager::actorDied(const MWWorld::Ptr& actor)
     {
         if (actor.isEmpty())

apps/openmw/mwlua/luamanagerimp.hpp

@@ -109,6 +109,7 @@ namespace MWLua
         void objectTeleported(const MWWorld::Ptr& ptr) override;
         void questUpdated(const ESM::RefId& questId, int stage) override;
         void uiModeChanged(const MWWorld::Ptr& arg) override;
+        void viewportResized(int width, int height) override;
         void actorDied(const MWWorld::Ptr& actor) override;
         void onDialogueResponse(
             const MWWorld::Ptr& actor, const ESM::DialInfo& info, const ESM::Dialogue& record) override;

apps/openmw/mwlua/menuscripts.hpp

@@ -24,7 +24,8 @@ namespace MWLua
             : LuaUtil::ScriptsContainer(lua, "Menu")
             , mInputProcessor(this)
         {
-            registerEngineHandlers({ &mOnFrameHandlers, &mStateChanged, &mConsoleCommandHandlers, &mUiModeChanged });
+            registerEngineHandlers({ &mOnFrameHandlers, &mStateChanged, &mConsoleCommandHandlers,
+                &mViewportResizedHandlers, &mUiModeChanged });
         }
 
         void processInputEvent(const MWBase::LuaManager::InputEvent& event)
@@ -42,6 +43,8 @@ namespace MWLua
             return !mConsoleCommandHandlers.mList.empty();
         }
 
+        void onViewportResized(int width, int height) { callEngineHandlers(mViewportResizedHandlers, width, height); }
+
         void uiModeChanged() { callEngineHandlers(mUiModeChanged); }
 
     private:
@@ -50,6 +53,7 @@ namespace MWLua
         EngineHandlerList mOnFrameHandlers{ "onFrame" };
         EngineHandlerList mStateChanged{ "onStateChanged" };
         EngineHandlerList mConsoleCommandHandlers{ "onConsoleCommand" };
+        EngineHandlerList mViewportResizedHandlers{ "onViewportResized" };
         EngineHandlerList mUiModeChanged{ "_onUiModeChanged" };
     };
 }

apps/openmw/mwlua/playerscripts.hpp

@@ -20,7 +20,8 @@ namespace MWLua
             : LocalScripts(lua, obj)
             , mInputProcessor(this)
         {
-            registerEngineHandlers({ &mConsoleCommandHandlers, &mOnFrameHandlers, &mQuestUpdate, &mUiModeChanged });
+            registerEngineHandlers({ &mConsoleCommandHandlers, &mOnFrameHandlers, &mQuestUpdate,
+                &mViewportResizedHandlers, &mUiModeChanged });
         }
 
         void processInputEvent(const MWBase::LuaManager::InputEvent& event)
@@ -38,6 +39,8 @@ namespace MWLua
             return !mConsoleCommandHandlers.mList.empty();
         }
 
+        void onViewportResized(int width, int height) { callEngineHandlers(mViewportResizedHandlers, width, height); }
+
         // `arg` is either forwarded from MWGui::pushGuiMode or empty
         void uiModeChanged(ObjectId arg, bool byLuaAction)
         {
@@ -53,6 +56,7 @@ namespace MWLua
         EngineHandlerList mConsoleCommandHandlers{ "onConsoleCommand" };
         EngineHandlerList mOnFrameHandlers{ "onFrame" };
         EngineHandlerList mQuestUpdate{ "onQuestUpdate" };
+        EngineHandlerList mViewportResizedHandlers{ "onViewportResized" };
         EngineHandlerList mUiModeChanged{ "_onUiModeChanged" };
     };
 

docs/source/reference/lua-scripting/engine_handlers.rst

@@ -147,6 +147,9 @@ Engine handler is a function defined by a script, that can be called by the engi
       |     mode, command, selectedObject)
     - | User entered `command` in in-game console. Called if either
       | `mode` is not default or `command` starts with prefix `lua`.
+  * - onViewportResized(width, height)
+    - | Called when the game viewport is resized.
+      | Provides the new width and height of the viewport in pixels.
 
 **Only for local scripts attached to a player**