STARK: Implement the main menu #1415

DouglasLiuDev · 2018-05-15T03:53:54Z

This pull request is corresponding to the task of implementing the main menu in TLJ.

The first attempt I just did some simple things.

I move onScreenChanged() to the StaticLocationScreen since I think all of the menus will need to resize text.

Now I just make a simple MainMenuScreen class with nothing in it and let the game load it when it starts, so that I can use the debug mode to dump the resources. But now there is a major problem. When I do this, an assertion failed in resourcereference.cpp, line 61, as below

assert(resource->getIndex() == element.getIndex());

I printed out those values. Most of the time both of them are zeros but at a point element.getIndex() becomes 69.

I guess this is related to how TLG loads its resources and now I am still not very clear about it.

FYI, I add the line _currentScreen->open() in UserInterface::init(), which I think is necessary. The reason why it wasn't there before, I guess, is that the game will trigger a video to play when it starts, which triggers thechangeScreen() and therefore trigger the open().

~~I made some stupid things in sync my branch and a typo in the name of commits. Hope it is fine.~~

bgK · 2018-05-15T17:10:29Z

But now there is a major problem. When I do this, an assertion failed in resourcereference.cpp, line 61.

What happens is indeed related to how the engine loads its resources. Resources can be loaded from two kinds of resource trees. The world resource tree and the static resource tree. You changed the user interface code to open the main menu which opens a static location that needs resources from the static tree. When a static location is loaded the engine will only load resources from the static tree. The code that starts a new game upon engine startup is still there. It tries to load world resources which fails.

residualvm/engines/stark/stark.cpp

Line 154 in c1284ad

setStartupLocation();

The call to setStartupLocation should be replaced with something that opens the main menu. The code in setStartupLocation will be useful for the new game button on the main menu.

I made some stupid things in sync my branch and a typo in the name of commits. Hope it is fine.

What a great occasion to make yourself familiar with the interactive rebase feature of git. You should be able to rebase your branch on top of master and remove the unwanted commits with it. Read some documentation about it to understand it. But the gist is to run git rebase -i origin/master and then delete the unwanted commits in the text editor. That will reapply the commits you did not delete on top of the latest version of the code.
Worst case scenario, you can still recover your commits from your github branch.
Also, I suggest you setup git to rebase instead of merging when pulling to avoid the creation of merge commits ($ git config branch.master.rebase true).

DouglasLiuDev · 2018-05-16T08:35:01Z

I have rebased my branches to clean up the mess I left before now. Thanks for the help 😄

Right now the game shall open with the main menu. But now there is another major problem: For some reason, all buttons on the main menu separate the clicking area and the helping text. Due to this reason, the original isMouseInside() is not able to correctly check the bounding area since it just check image, smacker and text, while those buttons' areas contain only text and are very tiny. Right now I am not sure how to get the original bounding area. I tried to compare the resources dumped from main menu and diary index but there is nothing remarkable.

There is another small problem: there are two special widgets on the main menu: "VERSION INFO" and "VERSION INFO REALLY". Strange names and the current version renders them differently compared to the steam version, as below:

Steam version:

ResidualVM version:

Seems like those texts are generated by other things. Not sure about this.

bgK · 2018-05-16T11:24:57Z

Those buttons' areas contain only text and are very tiny. Right now I am not sure how to get the original bounding area.

Seems like the buttons use an empty VisualText to mark the clickable areas. What happens is that VisualText::createTexture recomputes the visual size based on the text content. In this case it is empty, resulting in very small rects. VisualText::createTexture needs to change to use the existing rect width and height if it is defined in the resources instead of computing them from the text content.

Seems like those texts are generated by other things. Not sure about this.

Yes, this is a special case that should be handled in the main menu code.

DouglasLiuDev · 2018-05-16T14:32:58Z

The VisualText is modified to properly set the bounding area when the text is blank. I choose to actually check the string instead of hardcoded so as to prevent unexpected cases in the game data, ~~although I believe this will not happen.~~

I'll add the version information issue into the project and tackle it later.

bgK · 2018-05-16T16:57:15Z

engines/stark/visual/text.cpp

@@ -144,4 +159,13 @@ void VisualText::resetTexture() {
 	createTexture();
 }

+bool VisualText::isBlank() {
+	for (auto c : _text) {
+		if (c != ' ' && c != '\r' && c != '\n' && c != '\t') {


You can use isSpace from util.h instead.

bgK · 2018-05-16T17:00:25Z

engines/stark/visual/text.cpp

@@ -144,4 +159,13 @@ void VisualText::resetTexture() {
 	createTexture();
 }

+bool VisualText::isBlank() {
+	for (auto c : _text) {


We can't use c++11 features yet. That means no foreach and no auto :(

ResidualVM follows the same rules as ScummVM, and we don't do c++11 there either. This is mostly because the CI server has not yet been updated with c++11 compatible compilers for all platforms.

I see that the override specifier is used heavily so I thought c++11 is available. Looks like the c++11-compat.h redefines it. Neat.

bgK · 2018-05-16T17:03:48Z

engines/stark/visual/text.h

@@ -62,6 +63,9 @@ class VisualText : public Visual {
 	void createTexture();
 	void freeTexture();

+	// Check whether the text is blank


Please use Doxygen style comments when documenting methods/classes (so they appear in http://doxygen.residualvm.org/).

bgK · 2018-05-16T17:08:24Z

engines/stark/ui/menu/mainmenu.cpp

+			"NewGame",
+			nullptr,
+			nullptr));
+	_widgets.back()->setupSounds(0, 1);


Please fix the whitespaces here. We use tabs for indentation and spaces for alignment (see http://wiki.scummvm.org/index.php/Code_Formatting_Conventions).

DouglasLiuDev · 2018-05-17T04:10:40Z

engines/stark/visual/text.cpp

-		_originalRect.right = _originalRect.left + maxScaledLineWidth;
-		_originalRect.bottom = _originalRect.top + StarkGfx->scaleHeightOriginalToCurrent(_targetHeight);
+		_originalRect.right = _originalRect.left + _targetWidth;
+		_originalRect.bottom = _originalRect.top + _targetHeight;


The previous implementation is wrong. The width and height should not be scaled according to the resolution since the testing of the bounding box is based on original resolution.

bgK · 2018-05-17T06:12:08Z

This is working quite well now 👍

bgK · 2018-05-17T06:13:02Z

engines/stark/services/userinterface.cpp

@@ -67,9 +69,14 @@ UserInterface::~UserInterface() {
 void UserInterface::init() {
 	_cursor = new Cursor(_gfx);

-	_currentScreen = _gameScreen = new GameScreen(_gfx, _cursor);
+	_mainMenuScreen = new MainMenuScreen(_gfx, _cursor);


_mainMenuScreen is never freed (memory leak).

bgK · 2018-05-17T06:13:41Z

engines/stark/ui/menu/mainmenu.cpp

@@ -0,0 +1,111 @@
+#include "engines/stark/ui/menu/mainmenu.h"


Please include the standard ResidualVM licence header for new files.

DouglasLiuDev · 2018-05-17T06:47:46Z

engines/stark/services/services.h

@@ -97,7 +97,7 @@ class StarkServices : public Common::Singleton<StarkServices> {
 #define StarkGameInterface      StarkServices::instance().gameInterface
 #define StarkUserInterface      StarkServices::instance().userInterface
 #define StarkFontProvider       StarkServices::instance().fontProvider
-#define StarkGameDescription	StarkServices::instance().gameDescription
+#define StarkGameDescription    StarkServices::instance().gameDescription


Add this field so that MainMenuScreen may check the game version.

DouglasLiuDev · 2018-05-17T06:51:14Z

engines/stark/ui/menu/locationscreen.cpp

@@ -180,6 +180,9 @@ void StaticLocationWidget::onClick() {
 		_soundMouseClick->play();
 	}

+	// Ensure the click sound is played completely
+	while (_soundMouseClick->isPlaying()) {};
+


Based on the original game (steam version here), the click sound is completely played before the action is executed. Although using while loop here will freeze the game, that will also happen in the original game, so this should be enough "original...ish".

Wait the pointer needs to be checked beforehand.

DouglasLiuDev · 2018-05-17T08:27:14Z

I am planning to implement the Quit and Credits, but I am not sure how to find out their corresponding resources.

For Credits I need to load the credits fmv but right now I have no idea how to find the name. As for Quit, according to the original game (steam version), when the user hits the button, there will be a message box coming up to let user chooses "yes" or "no" with either mouse or keyboard, no idea how to find those resources. I can't screenshot the message box since the steam version has problems rendering it properly.

@bgK Maybe we can discuss on email if the solution is a bit complex.

bgK · 2018-05-17T11:10:56Z

I don't have enough time to write a full answer right now. The credits video is global\xarc\0e02.bbb. The Funcom logo that plays before the main menu is displayed is global\xarc\1402.bbb. Both are hardcoded in the game executable. I don't think there are resource descriptors.

There are a few other confirmation dialog boxes. I believe those are actually skinned Windows dialogs. We'll have to come up with a replacement solution. Perhaps we could use ResidualVM GUI dialogs.

DouglasLiuDev · 2018-05-18T03:13:11Z

engines/stark/ui/menu/mainmenu.cpp

@@ -132,6 +132,12 @@ void MainMenuScreen::helpTextHandler(StaticLocationWidget &widget, const Common:
 	}
 }

+void MainMenuScreen::creditsHandler() {
+	if (!isDemo()) {
+		StarkUserInterface->requestFMVPlayback("0e02.bbb");


There is no 0e02.bbb in the demo game data. So demo has no credits video or with a different name?

DouglasLiuDev · 2018-05-18T03:28:54Z

One small ~~and strange yet a little bit funny~~ thing to ask: in my steam version game, before the FunCom logo video, there is a screen that fades very quickly with a text "Please Wait...". Do we need to make that too? 😂😂😂

bgK · 2018-05-18T05:49:54Z

engines/stark/ui/menu/locationscreen.cpp

@@ -171,6 +178,8 @@ void StaticLocationWidget::onClick() {

 	if (_soundMouseClick) {
 		_soundMouseClick->play();
+		// Ensure the click sound is played completely
+		while (_soundMouseClick->isPlaying()) {};


It's not good to busy-wait for something to complete. The game appears unresponsive while waiting and the CPU is used at 100%.
In game engine design it's best to have a single game loop that roughly checks for user input, updates the simulated world and then renders. So far, Stark has managed to follow that rule. So here, we'll need to find another solution to let the sound fully play. Perhaps something is stopping the sound, preventing it from completing while it should not. Perhaps this code needs to wait for the sound to complete by checking each frame if it is finished.

DouglasLiuDev · 2018-05-18T10:23:17Z

Some names are changed. Just my personal preference.
The overall idea of fixing the busy-wait of clicking sound is to delay the performance of changing the displayed screen. Now changeScreen() only issues a request of changing the screen without actually changing it. The UserInterface will handle the change only when the required sound stops playing.
Due to this change, right now any StaticLocationWidget is not encouraged to perform anything right after the call to changeScreen(). Therefore, the MainMenuScreen makes a new field called _closeAction to store a pointer to a function, which handles what needs to be done after the change of screen and will be called in the close() of the screen.
I understand it is generally bad to have busy-waiting, but I kind of doubt how much benefit we gain from such a large change...

Commits are discarded.

bgK · 2018-05-18T11:19:32Z

I understand it is generally bad to have busy-waiting, but I kind of doubt how much benefit we gain from such a large change...

You're right, this is quite a mess. Maybe it's better to just synchronously wait. But in that case there should at least be a delay in the loop body to keep the CPU usage down.

DouglasLiuDev · 2018-05-20T04:31:56Z

engines/stark/services/userinterface.cpp

-	_diaryIndexScreen->onScreenChanged();
+
+	if (!isInGameScreen()) {
+		_currentScreen->onScreenChanged();


There will be more Screen added to UserInterface later. Since StaticLocationScreen will release all the resources when it is closed, there is no need to notify the change of screen resolution for a not currently displayed screen.

DouglasLiuDev · 2018-05-20T05:42:00Z

One problem: even though now the game will "quit" to the main menu, if choose to start the game again, the game will just go back to the previous state, not start a completely new one. Is there a way to reset the whole GameScreen, or maybe something to twist in ResourceProvider?

DouglasLiuDev · 2018-05-21T07:54:28Z

A rebasing has been done to sync with the master.

bgK · 2018-05-21T08:24:41Z

engines/stark/stark.cpp

 	if (ConfMan.hasKey("save_slot")) {
-		// Load game from specified slot, if any
+		_resourceProvider->initGlobal();


Those two calls are redundant now. loadGameState already calls them.

DouglasLiuDev requested a review from bgK May 15, 2018 03:53

DouglasLiuDev force-pushed the branch-mainmenu branch 3 times, most recently from de2e9f6 to 57c5f99 Compare May 16, 2018 08:09

bgK reviewed May 16, 2018

View reviewed changes

DouglasLiuDev commented May 17, 2018

View reviewed changes

bgK reviewed May 17, 2018

View reviewed changes

DouglasLiuDev commented May 17, 2018

View reviewed changes

DouglasLiuDev commented May 18, 2018

View reviewed changes

bgK reviewed May 18, 2018

View reviewed changes

DouglasLiuDev force-pushed the branch-mainmenu branch from f69be9f to 992ea67 Compare May 18, 2018 10:13

DouglasLiuDev force-pushed the branch-mainmenu branch from 88d997c to f3886fb Compare May 18, 2018 10:42

DouglasLiuDev force-pushed the branch-mainmenu branch from f3886fb to 7a6a8fd Compare May 19, 2018 10:53

DouglasLiuDev commented May 20, 2018

View reviewed changes

DouglasLiuDev added 21 commits May 21, 2018 15:30

STARK: Game opens with main menu look

5726d0c

STARK: Fix the empty text bounding area

6f740ca

STARK: Style problems fixed

e779bc8

STARK: Fix blank text bounding box and implement help text

4bf241d

STARK: Implement NewGame and some small fixing

8428870

STARK: Fix a "tab and space" problem

8a4c5a2

STARK: Rough implement the Quit

1aabd67

STARK: Implement the Credits and fix a small sound bug

2ee8a4c

STARK: Add the FunCom logo video

a4bcc01

STARk: Apply the backPreScreen on DiaryIndexScreen

22e1864

STARK: Change some names, personal preference

53af862

STARK: Add delay in waiting of the click sound

2e80596

STARK: Optimize UserInterface::init()

7b6672d

STARK: Optimize UserInterface::onScreenChanged()

84fde63

STARK: Roughly let the game "quit" to the main menu

0fd953f

STARK: Completely implement quiting to main menu

8335718

STARK: Better implement NewGame

c8bc2c9

STARK: Preserve the rough load function

bc6ac77

STARK: Improve on current loading and NewGame

14a5bde

STARK: Small fixing

52ab0d9

STARK: Remove a semicolon

90c0bd1

DouglasLiuDev force-pushed the branch-mainmenu branch from 31cb6e1 to 90c0bd1 Compare May 21, 2018 07:34

STARK: Ensure the game to load in GameScreen

1ecb316

DouglasLiuDev force-pushed the branch-mainmenu branch 2 times, most recently from 92a1544 to 1ecb316 Compare May 21, 2018 08:17

bgK reviewed May 21, 2018

View reviewed changes

STARK: Remove redundant calls

ce316f3

bgK merged commit a6cc6e7 into residualvm:master May 21, 2018

Faalagorn mentioned this pull request Jun 4, 2018

STARK: version info here instead of actual version is shown in the main menu #1439

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

STARK: Implement the main menu #1415

STARK: Implement the main menu #1415

DouglasLiuDev commented May 15, 2018 •

edited

bgK commented May 15, 2018

DouglasLiuDev commented May 16, 2018

bgK commented May 16, 2018

DouglasLiuDev commented May 16, 2018

bgK May 16, 2018

bgK May 16, 2018

DouglasLiuDev May 17, 2018

bgK May 16, 2018

bgK May 16, 2018

DouglasLiuDev May 17, 2018

bgK commented May 17, 2018

bgK May 17, 2018

DouglasLiuDev May 17, 2018

bgK May 17, 2018

DouglasLiuDev May 17, 2018 •

edited

DouglasLiuDev May 17, 2018 •

edited

DouglasLiuDev May 17, 2018

DouglasLiuDev commented May 17, 2018

bgK commented May 17, 2018

DouglasLiuDev May 18, 2018

DouglasLiuDev commented May 18, 2018

bgK May 18, 2018

DouglasLiuDev commented May 18, 2018 •

edited

bgK commented May 18, 2018

DouglasLiuDev May 20, 2018

DouglasLiuDev commented May 20, 2018

DouglasLiuDev commented May 21, 2018

bgK May 21, 2018

		@@ -0,0 +1,111 @@
		#include "engines/stark/ui/menu/mainmenu.h"

STARK: Implement the main menu #1415

STARK: Implement the main menu #1415

Conversation

DouglasLiuDev commented May 15, 2018 • edited

bgK commented May 15, 2018

DouglasLiuDev commented May 16, 2018

bgK commented May 16, 2018

DouglasLiuDev commented May 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bgK commented May 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DouglasLiuDev May 17, 2018 • edited

Choose a reason for hiding this comment

DouglasLiuDev May 17, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DouglasLiuDev commented May 17, 2018

bgK commented May 17, 2018

Choose a reason for hiding this comment

DouglasLiuDev commented May 18, 2018

Choose a reason for hiding this comment

DouglasLiuDev commented May 18, 2018 • edited

bgK commented May 18, 2018

Choose a reason for hiding this comment

DouglasLiuDev commented May 20, 2018

DouglasLiuDev commented May 21, 2018

Choose a reason for hiding this comment

DouglasLiuDev commented May 15, 2018 •

edited

DouglasLiuDev May 17, 2018 •

edited

DouglasLiuDev May 17, 2018 •

edited

DouglasLiuDev commented May 18, 2018 •

edited