STARK: Implement the save & load menu #1422

Dougaak · 2018-05-29T06:21:57Z

This PR is corresponding to implement the save & load menu of The Longest Journey.

Dougaak · 2018-05-31T03:58:08Z

engines/stark/stark.cpp

@@ -336,7 +336,8 @@ Common::Error StarkEngine::loadGameState(int slot) {

 bool StarkEngine::canSaveGameStateCurrently() {
 	// Disallow saving when there is no level loaded or when a script is running
-	return _global->getLevel() && _userInterface->isInteractive();
+	// or when the save & load menu is currently displayed
+	return _global->getLevel() && _userInterface->isInteractive() && !_userInterface->isInSaveLoadMenuScreen();
 }


I used to try an implementation that allows saving through GMM while the save & load menu is displayed, but it is kind of complex since the menu needs to be notified when a save slot is updated and update the thumbnail of the corresponding widget. Maybe just disable the saving is a better approach?

Disabling saving from the GMM when in the saveload menu to avoid too much complication sounds good to me.

Dougaak · 2018-05-31T09:48:36Z

engines/stark/ui/menu/saveloadmenu.cpp

@@ -113,7 +131,16 @@ void SaveMenuScreen::open() {
 }

 void SaveMenuScreen::onSlotSelected(int slot) {
-	g_engine->saveGameState(slot, "TestSave");
+	int chapter = StarkGlobal->getCurrentChapter();
+


What does the returned value of getCurrentChapter() really mean? I thought it was the index of the chapter, but calling this function in Chapter 1 gives me value 10.

Dougaak · 2018-05-31T09:50:26Z

engines/stark/ui/menu/saveloadmenu.cpp

+		_textDesc(gfx),
+		_textTime(gfx),
+		_isMouseHovered(false) {
+	// Load the corresponding save slot data
 	Common::String filename = StarkEngine::formatSaveName(ConfMan.getActiveDomainName().c_str(), _slot);
 	Common::InSaveFile *save = g_system->getSavefileManager()->openForLoading(filename);
 	if (save) {


I feel like putting a delete save; at the end is needed, but it will crash the game. The StarkEngine::loadGameState() also doesn't delete the save, why is that?

The constructor for StateReadStream() is two arguments, the file and a flag (DisposeAfterUse::YES and DisposeAfterUse::NO) the flag indicates if the input file should be deleted or not after use.

In your case you used it with 1 argument which looks like that defaults to the 2 argument case with the flag set to dispose. I am not exactly sure where that is happening since the constructor to SubReadStream defaults the dispose to NO (see common/substeam.h). StateReadStream is a SeekableSubReadStream which is also a SubReadStream.

So you don't need to delete save since that is already being done by the destructor of StateReadStream, but just to be clear you may want to explicitly set the 2nd argument to be DisposeAfterUse::YES in the constructor of StateReadStream.

Alternately, you can set it to NO and delete the save manually.

Dougaak · 2018-05-31T09:57:44Z

Beware
I change the SaveMetaData class to include the second part of the saving time, which may invalidate old save data. New save data may also have problems loading to old ResidualVM.

bgK · 2018-05-31T10:47:53Z

I change the SaveMetaData class to include the second part of the saving time, which may invalidate old save data. New save data may also have problems loading to old ResidualVM.

Hi, Please increment the save version number and load the seconds for saves that have at least the new version number. This way old saves remain compatible.

residualvm/engines/stark/services/stateprovider.h

Line 127 in 76c628a

static const uint kSaveVersion = 9;

dafioram · 2018-05-31T11:44:23Z

engines/stark/ui/menu/saveloadmenu.cpp

+				metadata.saveHour, metadata.saveMinute, metadata.saveSecond,
+				metadata.saveMonth, metadata.saveDay, metadata.saveYear % 100));
+		_textTime.setColor(_textColor);
+		_textTime.setFont(FontProvider::FontType::kCustomFont, 3);


I think you want FontProvider::kCustomFont instead of FontProvider::FontType::kCustomFont.

bgK

What does the returned value of getCurrentChapter() really mean? I thought it was the index of the chapter, but calling this function in Chapter 1 gives me value 10.

It's more a progress marker than exactly the chapter number. To obtain the actual chapter number, you need to divide that value by 10.

bgK · 2018-05-31T16:49:28Z

engines/stark/stark.cpp

@@ -336,7 +336,8 @@ Common::Error StarkEngine::loadGameState(int slot) {

 bool StarkEngine::canSaveGameStateCurrently() {
 	// Disallow saving when there is no level loaded or when a script is running
-	return _global->getLevel() && _userInterface->isInteractive();
+	// or when the save & load menu is currently displayed
+	return _global->getLevel() && _userInterface->isInteractive() && !_userInterface->isInSaveLoadMenuScreen();
 }


Disabling saving from the GMM when in the saveload menu to avoid too much complication sounds good to me.

bgK · 2018-05-31T17:00:18Z

engines/stark/ui/menu/saveloadmenu.cpp

+	if (chapter == 0) {
+		desc = "Prologue";
+	} else {
+		desc = Common::String::format("Chapter %d", chapter);


Ultimately, chapter names will have to come from chapters.ini so they are localized. But I guess having them hardcoded is fine for the first version. The original engine uses the string before the colon in chapters.ini.

bgK · 2018-05-31T17:02:36Z

engines/stark/ui/menu/saveloadmenu.cpp

+		// Obtain the thumbnail
+		Graphics::Surface *thumb = metadata.readGameScreenThumbnail(&stream);
+		_texture->update(thumb);
+		delete thumb;


Graphics::Surface is very stupid. ->free() needs to be called as well.

Dougaak · 2018-06-02T03:17:54Z

@bgK Currently SaveDataWidget will load and update its thumbnail and text only when it is created and clicked on the save menu. Obviously it is unrealistic to update the content on every frame. But the GMM provides saving and deleting operations, which will invalidate the current menu screen's content. Implementing the updating on the change from GMM is going to be a complex task, and it feels like unnecessary for such a strange behaviour. ~~I mean, who on earth will open two save & load menus just for fun?~~

So, is it okay to just block both saving and loading from GMM when the game is in save & load menu?

p.s. Currently, the saving is already blocked. Deleting a save data through GMM while the load menu is displayed will make the corresponding widget, if it's on the current page, unresponsive.

Dougaak · 2018-06-02T05:06:57Z

A new service for retrieving the chapter title and subtitle from chapters.ini is created. This would also be helpful when implementing the conversation log, I guess.

bgK · 2018-06-02T06:00:21Z

So, is it okay to just block both saving and loading from GMM when the game is in save & load menu?

Sure, ok.

bgK · 2018-06-02T06:01:19Z

engines/stark/services/gamechapter.cpp

+
+	Common::String line, title, subtitle;
+
+	// Assume that the formats of all chapters.ini are the same


Did you notice Common::INIFile?

Oops, didn't see that. I'll take a look.

Dougaak · 2018-06-02T07:27:02Z

The current mechanism of capturing the screenshot will also capture the cursor. I have spent some time trying to get rid of it, but the best I could get will also remove the model from the thumbnail. Any suggestion?

bgK · 2018-06-03T07:07:14Z

The current mechanism of capturing the screenshot will also capture the cursor. I have spent some time trying to get rid of it, but the best I could get will also remove the model from the thumbnail. Any suggestion?

A simple way would be to re-render the game window only just before capturing the screenshot. (And maybe re-render the whole screen afterwards if that causes glitches)

Dougaak · 2018-06-03T08:22:25Z

A simple way would be to re-render the game window only just before capturing the screenshot.

Already tried this before. Simply re-render the game window (or even the game screen) will cause only the background rendered, without the models. Calling updateScreen() after will also render the cursor.

Still can't figure out what causes this.

bgK · 2018-06-03T08:28:14Z

Already tried this before. Simply re-render the game window (or even the game screen) will cause only the background rendered, without the models.

Oh, right. The depth buffer needs to be cleared for the depths tests to work correctly. Calling StarkGfx->clearScreen should do it.

bgK · 2018-06-03T12:36:31Z

engines/stark/ui/menu/saveloadmenu.cpp

+		}
+
+		// Obtain the thumbnail
+		Graphics::Surface *thumb = metadata.readGameScreenThumbnail(&stream);


The thumbnail is only available since save metadata version 9. Most of my saves are older than that and show garbage instead of the thumbnail.

bgK · 2018-06-03T12:49:34Z

engines/stark/ui/menu/saveloadmenu.cpp

+	// Freeze the screen for a while to let the user notice the change
+	widget->loadSaveDataElements();
+	render();
+	g_system->updateScreen();


Use GfxDriver->flipBuffer() instead not to break the Driver abstraction.

bgK · 2018-06-03T12:55:10Z

engines/stark/ui/menu/saveloadmenu.cpp

+	lineSurface.free();
+
+	// Set the position
+	_thumbPos.x = 41 + (_slot % 3) * (_thumbWidth + 39);


There could be constants for the number of slots per lines, the number of slot lines and the number of slots per page to make the code easier to understand.

bgK · 2018-06-03T12:56:56Z

engines/stark/ui/menu/saveloadmenu.cpp

+}
+
+void SaveLoadMenuScreen::changePage(int page) {
+	assert(page >= 0 && page <= 10);


Please add a constant for the maximum number of pages. We may want to increase that number as the ResidualVM save and load dialogs have a lot more slots.

Dougaak · 2018-06-03T13:51:35Z

engines/stark/ui/menu/diaryindex.cpp

@@ -94,7 +94,7 @@ void DiaryIndexScreen::open() {
 	_widgets.push_back(new StaticLocationWidget(
 			"Back",
 			CLICK_HANDLER(DiaryIndexScreen, backHandler),
-			MOVE_HANDLER(DiaryIndexScreen, widgetTextColorHandler)));
+			nullptr));


Just found out that this text will not change to blue in the original game.

Dougaak · 2018-06-03T13:52:56Z

engines/stark/ui/menu/saveloadmenu.cpp

+			_texture->update(thumb);
+			thumb->free();
+			delete thumb;
+		}


I don't have save data older than version 9. Could you please check this code for me?

It's working, thanks!

This is my collection of old saved games in case you need it: https://filenurse.com/download/361b5da097c32696eff053a7b026ad7b.html

A lot of them were made back when some entity save handlers were missing, so they don't load all the state, but oh well...

Dougaak added 2 commits May 29, 2018 14:15

STARK: Get all location widgets rendered

f4d4254

STARK: Seperate Save and Load menu

340b55f

Dougaak requested a review from bgK May 29, 2018 06:23

STARK: First rough implementation of the SaveDataWidget

5559fee

Dougaak force-pushed the branch-saveload branch 2 times, most recently from cb1dc6b to 5559fee Compare May 29, 2018 10:43

STARK: Small improvements

ecf1d59

Dougaak commented May 31, 2018

View reviewed changes

Dougaak added 2 commits May 31, 2018 14:53

STARK: Implement the blue outline of SaveDataWidget

43e16b5

STARK: Implement the rest of SaveDataWidget

6f6041a

Dougaak commented May 31, 2018

View reviewed changes

dafioram reviewed May 31, 2018

View reviewed changes

Dougaak added 2 commits May 31, 2018 21:32

STARK: Make compatible to old save data

02f2e96

STARK: Implement page changing in save & load menu

6d4d377

bgK reviewed May 31, 2018

View reviewed changes

Dougaak added 2 commits June 1, 2018 21:44

STARK: Small fixing

f23694a

STARK: Implement the "freezing" after saving

99ed199

STARK: Obtain the chapter title and subtitle from chapters.ini

7fecbcb

bgK reviewed Jun 2, 2018

View reviewed changes

Dougaak added 2 commits June 2, 2018 14:10

STARK: Prevent loading from GMM in save & load menu

5885b53

STARK: Change to use Common::INIFile

a8dc2ec

STARK: Exclude the cursor when saving the thumbnail

3b4270e

Dougaak force-pushed the branch-saveload branch from bfeb0b4 to 3b4270e Compare June 3, 2018 09:11

STARK: Change resetTextTexture() to onScreenChanged()

b35914a

bgK reviewed Jun 3, 2018

View reviewed changes

STARK: Small fixing

0f76320

Dougaak commented Jun 3, 2018

View reviewed changes

Merge branch 'master' into branch-saveload

11f3c87

bgK merged commit 88fd362 into residualvm:master Jun 4, 2018

Dougaak deleted the branch-saveload branch June 26, 2018 13:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

STARK: Implement the save & load menu #1422

STARK: Implement the save & load menu #1422

Dougaak commented May 29, 2018

Dougaak May 31, 2018

bgK May 31, 2018

Dougaak May 31, 2018

Dougaak May 31, 2018

dafioram May 31, 2018

Dougaak commented May 31, 2018

bgK commented May 31, 2018

dafioram May 31, 2018

bgK left a comment

bgK May 31, 2018

bgK May 31, 2018

bgK May 31, 2018

Dougaak commented Jun 2, 2018

Dougaak commented Jun 2, 2018

bgK commented Jun 2, 2018

bgK Jun 2, 2018

Dougaak Jun 2, 2018

Dougaak commented Jun 2, 2018

bgK commented Jun 3, 2018

Dougaak commented Jun 3, 2018

bgK commented Jun 3, 2018

bgK Jun 3, 2018

bgK Jun 3, 2018

bgK Jun 3, 2018

bgK Jun 3, 2018

Dougaak Jun 3, 2018

Dougaak Jun 3, 2018 •

edited

bgK Jun 3, 2018


		Common::String line, title, subtitle;

		// Assume that the formats of all chapters.ini are the same

STARK: Implement the save & load menu #1422

STARK: Implement the save & load menu #1422

Conversation

Dougaak commented May 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

Dougaak commented May 31, 2018

bgK commented May 31, 2018

Choose a reason for hiding this comment

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

Dougaak commented Jun 2, 2018

Dougaak commented Jun 2, 2018

bgK commented Jun 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dougaak commented Jun 2, 2018

bgK commented Jun 3, 2018

Dougaak commented Jun 3, 2018

bgK commented Jun 3, 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

Dougaak Jun 3, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dougaak Jun 3, 2018 •

edited