STARK: Introduce a onGameLoop event to stop abusing onRender for updates

Fixes #1492 where rendering the screen to save a screenshot would run
some dialog related script updates.

engines/stark/services/userinterface.cpp

@@ -116,10 +116,16 @@ void UserInterface::init() {
 	_fmvScreen->play("1402.bbb");
 }
 
-void UserInterface::update() {
+void UserInterface::onGameLoop() {
 	StarkStaticProvider->onGameLoop();
 
+	_currentScreen->handleGameLoop();
+
 	// Check for UI mouse overs
+	// TODO: Call mouse move only if the mouse position actually changed
+	// probably some code will need to be moved to gameloop handling to
+	// account for the case where hotspots move and the mouse cursor needs
+	// to be updated regardless of the mouse actually moved.
 	_currentScreen->handleMouseMove();
 }
 

engines/stark/services/userinterface.h

@@ -67,7 +67,10 @@ public:
 	virtual ~UserInterface();
 
 	void init();
-	void update();
+
+	/** Called once per game loop. */
+	void onGameLoop();
+
 	void render();
 	void handleMouseMove(const Common::Point &pos);
 	void handleMouseUp();

engines/stark/stark.cpp

@@ -377,7 +377,7 @@ void StarkEngine::updateDisplayScene() {
 
 	// Render the current scene
 	// Update the UI state before displaying the scene
-	_userInterface->update();
+	_userInterface->onGameLoop();
 
 	// Tell the UI to render, and update implicitly, if this leads to new mouse-over events.
 	_userInterface->render();

engines/stark/ui/menu/locationscreen.cpp

@@ -73,15 +73,20 @@ void StaticLocationScreen::freeWidgets() {
 	_hoveredWidgetIndex = -1;
 }
 
-void StaticLocationScreen::onMouseMove(const Common::Point &pos) {
-	int newHoveredWidget = -1;
-
+void StaticLocationScreen::onGameLoop() {
 	for (uint i = 0; i < _widgets.size(); i++) {
 		StaticLocationWidget *widget = _widgets[i];
 		if (widget->isVisible()) {
 			widget->onGameLoop();
 		}
+	}
+}
 
+void StaticLocationScreen::onMouseMove(const Common::Point &pos) {
+	int newHoveredWidget = -1;
+
+	for (uint i = 0; i < _widgets.size(); i++) {
+		StaticLocationWidget *widget = _widgets[i];
 		widget->onMouseMove(pos);
 
 		if (widget->isVisible() && widget->isMouseInside(pos)) {

engines/stark/ui/menu/locationscreen.h

@@ -57,6 +57,7 @@ protected:
 	// Window API
 	void onMouseMove(const Common::Point &pos) override;
 	void onClick(const Common::Point &pos) override;
+	void onGameLoop() override;
 	void onRender() override;
 
 	Common::Array<StaticLocationWidget *> _widgets;

engines/stark/ui/menu/settingsmenu.cpp

@@ -198,8 +198,7 @@ void SettingsMenuScreen::close() {
 	StaticLocationScreen::close();
 }
 
-void SettingsMenuScreen::onMouseMove(const Common::Point &pos) {
-	StaticLocationScreen::onMouseMove(pos);
+void SettingsMenuScreen::onGameLoop() {
 	_soundManager.update();
 }
 

engines/stark/ui/menu/settingsmenu.h

@@ -74,7 +74,7 @@ public:
 	// StaticLocationScreen API
 	void open() override;
 	void close() override;
-	void onMouseMove(const Common::Point &pos) override;
+	void onGameLoop() override;
 
 	void handleMouseUp();
 

engines/stark/ui/screen.h

@@ -63,6 +63,9 @@ public:
 	/** Draw the screen */
 	virtual void render() = 0;
 
+	/** Called once per game loop when the screen is active. */
+	virtual void handleGameLoop() {}
+
 	/** Called when the screen resolution changes */
 	virtual void onScreenChanged() {}
 
@@ -80,6 +83,7 @@ public:
 	SingleWindowScreen(Name name, Gfx::Driver *gfx, Cursor *cursor) :
 			Screen(name), Window(gfx, cursor) {}
 
+	void handleGameLoop() override { Window::handleGameLoop(); }
 	void render() override { Window::render(); }
 
 	void handleMouseMove() override { Window::handleMouseMove(); }

engines/stark/ui/window.cpp

@@ -37,6 +37,14 @@ Window::Window(Gfx::Driver *gfx, Cursor *cursor) :
 Window::~Window() {
 }
 
+void Window::handleGameLoop() {
+	if (!_visible) {
+		return;
+	}
+
+	onGameLoop();
+}
+
 void Window::render() {
 	if (!_visible) {
 		return;

engines/stark/ui/window.h

@@ -69,6 +69,9 @@ public:
 	/** Called by the user interface when the mouse is double clicked inside the window */
 	void handleDoubleClick();
 
+	/** Called once per game loop when the screen is active. */
+	void handleGameLoop();
+
 	/** Called by the user interface in the render phase of the game loop */
 	void render();
 
@@ -86,6 +89,7 @@ protected:
 	virtual void onClick(const Common::Point &pos) {}
 	virtual void onRightClick(const Common::Point &pos) {}
 	virtual void onDoubleClick(const Common::Point &pos) {}
+	virtual void onGameLoop() {};
 	virtual void onRender() = 0;
 
 	Common::Point getRelativeMousePosition() const;

engines/stark/ui/world/dialogpanel.cpp

@@ -117,7 +117,7 @@ void DialogPanel::renderScrollArrows() const {
 	}
 }
 
-void DialogPanel::onRender() {
+void DialogPanel::onGameLoop() {
 	// Clear completed speeches
 	if (!_currentSpeech || !_currentSpeech->isPlaying()) {
 		_currentSpeech = nullptr;
@@ -143,7 +143,9 @@ void DialogPanel::onRender() {
 	if (_options.empty() && StarkDialogPlayer->areOptionsAvailable()) {
 		updateDialogOptions();
 	}
+}
 
+void DialogPanel::onRender() {
 	// Draw options if available
 	if (!_options.empty()) {
 		_activeBackGroundTexture->render(Common::Point(0, 0), false);

engines/stark/ui/world/dialogpanel.h

@@ -70,6 +70,7 @@ protected:
 	void onMouseMove(const Common::Point &pos) override;
 	void onClick(const Common::Point &pos) override;
 	void onRightClick(const Common::Point &pos) override;
+	void onGameLoop() override;
 	void onRender() override;
 
 private:

engines/stark/ui/world/fmvscreen.cpp

@@ -86,8 +86,7 @@ void FMVScreen::play(const Common::String &name) {
 	_decoder->start();
 }
 
-void FMVScreen::onRender() {
-	// TODO: Refactor this into an update method
+void FMVScreen::onGameLoop() {
 	if (isPlaying()) {
 		if (_decoder->needsUpdate()) {
 			const Graphics::Surface *decodedSurface = _decoder->decodeNextFrame();
@@ -96,7 +95,9 @@ void FMVScreen::onRender() {
 	} else {
 		stop();
 	}
+}
 
+void FMVScreen::onRender() {
 	_surfaceRenderer->render(_texture, Common::Point(0, Gfx::Driver::kTopBorderHeight),
 			Gfx::Driver::kGameViewportWidth, Gfx::Driver::kGameViewportHeight);
 }

engines/stark/ui/world/fmvscreen.h

@@ -52,6 +52,7 @@ public:
 	void stop();
 
 protected:
+	void onGameLoop() override;
 	void onRender() override;
 
 private:

engines/stark/ui/world/gamescreen.cpp

@@ -76,6 +76,12 @@ void GameScreen::close() {
 	StarkUserInterface->saveGameScreenThumbnail();
 }
 
+void GameScreen::handleGameLoop() {
+	for (int i = _gameScreenWindows.size() - 1; i >= 0; i--) {
+		_gameScreenWindows[i]->handleGameLoop();
+	}
+}
+
 void GameScreen::render() {
 	for (int i = _gameScreenWindows.size() - 1; i >= 0; i--) {
 		_gameScreenWindows[i]->render();

engines/stark/ui/world/gamescreen.h

@@ -48,6 +48,7 @@ public:
 	// Screen API
 	void open() override;
 	void close() override;
+	void handleGameLoop() override;
 	void render() override;
 	void onScreenChanged() override;
 	void handleMouseMove() override;
@@ -69,6 +70,7 @@ public:
 	/** A new entry has been added to the player's diary */
 	void notifyDiaryEntryEnabled();
 
+
 private:
 	Gfx::Driver *_gfx;
 	Cursor *_cursor;

engines/stark/ui/world/topmenu.cpp

@@ -67,7 +67,7 @@ TopMenu::~TopMenu() {
 	delete _optionsButton;
 }
 
-void TopMenu::onRender() {
+void TopMenu::onGameLoop() {
 	_widgetsVisible = (isMouseInside() && StarkUserInterface->isInteractive()) || isAnimationPlaying();
 
 	if (!_widgetsVisible) {
@@ -81,6 +81,12 @@ void TopMenu::onRender() {
 	}
 
 	updateAnimations();
+}
+
+void TopMenu::onRender() {
+	if (!_widgetsVisible) {
+		return;
+	}
 
 	_inventoryButton->render();
 	_optionsButton->render();

engines/stark/ui/world/topmenu.h

@@ -43,6 +43,7 @@ public:
 	~TopMenu() override;
 
 	// Window API
+	void onGameLoop() override;
 	void onRender() override;
 	void onMouseMove(const Common::Point &pos) override;
 	void onClick(const Common::Point &pos) override;