Engine: Add requestRedraw method

Author: adazem009

include/scratchcpp/iengine.h

@@ -159,7 +159,13 @@ class LIBSCRATCHCPP_EXPORT IEngine
         virtual bool broadcastByPtrRunning(Broadcast *broadcast, VirtualMachine *sourceScript) = 0;
 
         /*!
-         * Call this from a block implementation to force a "screen refresh".
+         * Call this from a block implementation to force a redraw (screen refresh).
+         * \note This has no effect in "run without screen refresh" custom blocks.
+         */
+        virtual void requestRedraw() = 0;
+
+        /*!
+         * Call this from a block implementation to break the execution of the current frame.
          * \note This has no effect in "run without screen refresh" custom blocks.
          */
         virtual void breakFrame() = 0;

src/engine/internal/engine.cpp

@@ -554,6 +554,11 @@ bool Engine::broadcastByPtrRunning(Broadcast *broadcast, VirtualMachine *sourceS
     return false;
 }
 
+void Engine::requestRedraw()
+{
+    m_redrawRequested = true;
+}
+
 void Engine::breakFrame()
 {
     m_breakFrame = true;
@@ -950,6 +955,7 @@ void Engine::finalize()
     m_runningScripts.clear();
     m_scriptsToRemove.clear();
     m_running = false;
+    m_redrawRequested = false;
     m_breakFrame = false;
     m_skipFrame = false;
     m_lockFrame = false;

src/engine/internal/engine.h

@@ -73,6 +73,8 @@ class Engine : public IEngine
         bool broadcastRunning(unsigned int index, VirtualMachine *sourceScript) override;
         bool broadcastByPtrRunning(Broadcast *broadcast, VirtualMachine *sourceScript) override;
 
+        void requestRedraw() override;
+
         void breakFrame() override;
         bool breakingCurrentFrame() override;
 
@@ -161,6 +163,7 @@ class Engine : public IEngine
         bool m_spriteFencingEnabled = true;
 
         bool m_running = false;
+        bool m_redrawRequested = false;
         bool m_breakFrame = false;
         bool m_skipFrame = false;
         bool m_lockFrame = false;

test/mocks/enginemock.h

@@ -59,6 +59,8 @@ class EngineMock : public IEngine
         MOCK_METHOD(bool, broadcastRunning, (unsigned int, VirtualMachine *), (override));
         MOCK_METHOD(bool, broadcastByPtrRunning, (Broadcast *, VirtualMachine *), (override));
 
+        MOCK_METHOD(void, requestRedraw, (), (override));
+
         MOCK_METHOD(void, breakFrame, (), (override));
         MOCK_METHOD(bool, breakingCurrentFrame, (), (override));