STARK: Improve the main menu #1467

DouglasLiuDev · 2018-06-29T15:53:23Z

Implement the version info text (#1439) and the Book of Secrets in the main menu.

DouglasLiuDev · 2018-06-29T15:56:07Z

engines/stark/gfx/renderentry.cpp

 	return _visual->get<VisualImageXMG>();
 }

 VisualText *RenderEntry::getText() const {
+	if (!_visual) {
+		return nullptr;


In the implementation of GameWindow::onScreenChanged() I came across with render entries with no Visual. It feels strange to me since a RenderEntry without a Visual seems pretty useless. But anyway it needs to be handled.

DouglasLiuDev · 2018-06-29T15:57:25Z

engines/stark/services/settings.h

@@ -85,6 +85,15 @@ class Settings {
 	/** Check whether low-resolution fmv is available */
 	bool hasLowResFMV() { return _hasLowRes; }

+	/** Enable the book of secrets */
+	void enableBookOfSecrets() { 
+		ConfMan.setBool("xoBfOsterceS", true);


Just follow the name in "w_world.ini" :p

DouglasLiuDev · 2018-06-29T16:02:16Z

engines/stark/services/userinterface.h

-	void quitToMainMenu();
+	void requestQuitToMainMenu() { _quitToMainMenu = true; }
+	bool hasQuitToMainMenuRequest() { return _quitToMainMenu; }
+	void performQuitToMainMenu();


Script needs to request quitting to the main menu. In the previous implementation, immediately quitting will trigger the deallocation of the Script object and therefore crash the game ~~and it took me an eternity to realize this!!!~~ . So it is cached here and is performed later in the update part of the game's main loop.

Building with Address Sanitizer enabled helps a lot to understand these issues. It tells precisely the cause of the use after free. It's probably a bit of a pain to get it working on Windows, and IMO it's well worth having a Linux install somewhere just to be able to use it when needed.

Yeah now I know the good of Linux...

DouglasLiuDev · 2018-06-29T16:04:06Z

engines/stark/ui/menu/mainmenu.cpp

+	if (!StarkSettings->isDemo() && StarkSettings->hasBookOfSecrets()) {
+		StarkUserInterface->changeScreen(kScreenGame);
+		StarkResourceProvider->initGlobal();
+		StarkScene->setFadeLevel(1.0f);


The "Book of Secrets" will not handle the fade level by itself. I don't find a problem setting it here before the actual game starts.

Shouldn't the fade level be initialized to 1.0 in the Scene class rather than here?

DouglasLiuDev · 2018-06-29T16:06:10Z

engines/stark/ui/menu/mainmenu.cpp

+VersionInfoText::VersionInfoText() :
+		StaticLocationWidget("VERSION INFO REALLY", nullptr, nullptr) {
+	Common::String text = _copyrightSymbol + Common::String("1999 Funcom");


Since we cannot access the build version of the original executable and we are not using the Audiere library, I chose to just display the Funcom text.

DouglasLiuDev · 2018-06-29T16:07:57Z

engines/stark/ui/menu/mainmenu.cpp

+	Common::String text = _copyrightSymbol + Common::String("1999 Funcom");
+	_renderEntry->getText()->setText(text);
+	_renderEntry->setPosition(Common::Point(_posX, _posY));


The default positions of the "VERSION INFO HERE" widget in the released game and the demo are different, and both of them needs to be moved, so I chose to hard-code it.

DouglasLiuDev · 2018-06-29T16:10:36Z

engines/stark/ui/world/gamewindow.cpp

+	for (uint i = 0; i < layers.size(); ++i) {
+		renderEntries = layers[i]->listRenderEntries();
+		for (uint j = 0; j < renderEntries.size(); ++j) {
+			text = renderEntries[j]->getText();


Texts in not only the current layer but all the layers within the same location need to reset their textures when the resolution has changed, otherwise, the user may change the screen, go back to a previous layer and find size-unmatched texts.

DouglasLiuDev · 2018-06-29T16:14:22Z

A screenshot of the current version info text for reference

DouglasLiuDev · 2018-06-29T16:17:31Z

A quick way to test the Book of Secrets: Ensure that the "xoBfOsterceS" is not set in the configuration, use the debug console to change to location 3c 00, enable inventory item 15, and plant the organic leaf in the flower bed. The Book of Secrets will then be enabled.

bgK

This is looking Ok. I've added a few very minor comments.

bgK · 2018-06-29T18:10:15Z

engines/stark/ui/menu/mainmenu.cpp

+	if (!StarkSettings->isDemo() && StarkSettings->hasBookOfSecrets()) {
+		StarkUserInterface->changeScreen(kScreenGame);
+		StarkResourceProvider->initGlobal();
+		StarkScene->setFadeLevel(1.0f);


Shouldn't the fade level be initialized to 1.0 in the Scene class rather than here?

bgK · 2018-06-29T18:17:30Z

engines/stark/ui/menu/mainmenu.h

+	virtual ~VersionInfoText() {}
+
+private:
+	static const int _copyrightSymbol = -87, _posX = 16, _posY = 419;


_copyrightSymbol is the ISO-8859-1 code for the copyright symbol. It would be easier to understand what it is as a hexadecimal number (0xA9).

Also please don't put the position on the same line, they are really unrelated.

bgK · 2018-06-29T18:43:54Z

engines/stark/stark.cpp

@@ -247,6 +247,11 @@ void StarkEngine::updateDisplayScene() {
 	// Clear the screen
 	_gfx->clearScreen();

+	// Quit to main menu screen, if needed
+	if (_userInterface->hasQuitToMainMenuRequest()) {


This check feels like it does not belong here. Couldn't it be in StarkEngine::mainLoop with the quit check and the location change check?

bgK · 2018-06-29T18:57:42Z

engines/stark/ui/world/gamewindow.cpp

+	Common::Array<Resources::Layer *> layers = StarkGlobal->getCurrent()->getLocation()->listLayers();
+
+	VisualText *text = nullptr;
+	Gfx::RenderEntryArray renderEntries;


Please reduce the scope of these variables. That'd makes the code a bit easier to read, IMO.

Do you mean putting the declaration into the loop? I am not sure how compilers can optimize this these days but isn't that may potentially cause unnecessary variable creations and deallocations, especially since we have an array here?

C++ compilers are very good with these little details. For non performance critical code it's better to focus on writing simple and readable code.

In this particular case, constructing RenderEntryArray outside of the loop may prevent Return Value Optimization.

DouglasLiuDev · 2018-06-30T07:44:27Z

@bgK If there's nothing left I think we can do the merge.

bgK · 2018-06-30T08:42:57Z

Thanks!

DouglasLiuDev added 8 commits June 29, 2018 21:44

STARK: Add the version info text in the main menu

eaa0fab

STARK: Enable book of secrets in the main menu

92184a1

STARK: Enable onScreenChanged() in Cursor and GameWindow

a147441

STARK: Cache quiting to main menu and perform later

6120877

STARK: Enable exit to main menu in the book of secrets

8121a28

STARK: Improve GameWindow::onScreenChanged()

16da3ce

STARK: Implement the Book Of Secrets Open command

f1b3cab

STARK: Style typo

0d2641a

DouglasLiuDev requested a review from bgK June 29, 2018 15:53

DouglasLiuDev commented Jun 29, 2018

View reviewed changes

bgK reviewed Jun 29, 2018

View reviewed changes

DouglasLiuDev added 2 commits June 30, 2018 11:53

STARK: Small fixing

47ba0fd

STARK: Style improvement

d653b9d

bgK merged commit a03cdea into residualvm:master Jun 30, 2018

DouglasLiuDev mentioned this pull request Jun 30, 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: Improve the main menu #1467

STARK: Improve the main menu #1467

DouglasLiuDev commented Jun 29, 2018

DouglasLiuDev Jun 29, 2018

DouglasLiuDev Jun 29, 2018

DouglasLiuDev Jun 29, 2018

bgK Jun 30, 2018

DouglasLiuDev Jun 30, 2018

DouglasLiuDev Jun 29, 2018

bgK Jun 29, 2018

DouglasLiuDev Jun 29, 2018

DouglasLiuDev Jun 29, 2018

DouglasLiuDev Jun 29, 2018

DouglasLiuDev commented Jun 29, 2018

DouglasLiuDev commented Jun 29, 2018

bgK left a comment

bgK Jun 29, 2018

bgK Jun 29, 2018

bgK Jun 29, 2018

bgK Jun 29, 2018

DouglasLiuDev Jun 30, 2018

bgK Jun 30, 2018

DouglasLiuDev commented Jun 30, 2018

bgK commented Jun 30, 2018

STARK: Improve the main menu #1467

STARK: Improve the main menu #1467

Conversation

DouglasLiuDev commented Jun 29, 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

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

DouglasLiuDev commented Jun 29, 2018

DouglasLiuDev commented Jun 29, 2018

bgK left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DouglasLiuDev commented Jun 30, 2018

bgK commented Jun 30, 2018