[Scummvm-git-logs] scummvm master -> cc714bd2928cd6e0862d3216df3dbbedaa41f09a

[sluicebox]

This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
cc714bd292 SCI: Only throttle kGameIsRestarting from game loops


Commit: cc714bd2928cd6e0862d3216df3dbbedaa41f09a
    https://github.com/scummvm/scummvm/commit/cc714bd2928cd6e0862d3216df3dbbedaa41f09a
Author: sluicebox (22204938+sluicebox at users.noreply.github.com)
Date: 2021-10-30T13:19:09-05:00

Commit Message:
SCI: Only throttle kGameIsRestarting from game loops

Prevents extra speed throttling from being applied when a script queries
the restart flag. Some rooms such as the KQ6 caves and the QFG4 caves do
this on every game cycle. In practice, this extra throttling didn't seem
to have much effect, but the intent is to only throttle game loops and
the script patches that fix inner loops.

Updated script patches to call kGameIsRestarting like game loops.

Changed paths:
    engines/sci/engine/kmisc.cpp
    engines/sci/engine/script_patches.cpp


diff --git a/engines/sci/engine/kmisc.cpp b/engines/sci/engine/kmisc.cpp
index 64e8ea6eb4..265e306a80 100644
--- a/engines/sci/engine/kmisc.cpp
+++ b/engines/sci/engine/kmisc.cpp
@@ -60,11 +60,16 @@ reg_t kRestartGame16(EngineState *s, int argc, reg_t *argv) {
 ** Returns the restarting_flag in acc
 */
 reg_t kGameIsRestarting(EngineState *s, int argc, reg_t *argv) {
-	s->r_acc = make_reg(0, s->gameIsRestarting);
+	// Always return the previous flag value
+	const int16 previousRestartingFlag = s->gameIsRestarting;
 
-	if (argc) { // Only happens during replay
-		if (!argv[0].toUint16()) // Set restarting flag
-			s->gameIsRestarting = GAMEISRESTARTING_NONE;
+	// Games pass zero to clear the restarting flag from their Game:doit method on
+	// each cycle. Other scripts query the restarting flag by passing no parameters.
+	if (argc > 0 && argv[0].toUint16() == 0) {
+		s->gameIsRestarting = GAMEISRESTARTING_NONE;
+	} else {
+		// Only speed throttle calls from game loops or our script patches.
+		return make_reg(0, previousRestartingFlag);
 	}
 
 	uint32 neededSleep = 30;
@@ -133,7 +138,7 @@ reg_t kGameIsRestarting(EngineState *s, int argc, reg_t *argv) {
 	s->speedThrottler(neededSleep);
 
 	s->_paletteSetIntensityCounter = 0;
-	return s->r_acc;
+	return make_reg(0, previousRestartingFlag);
 }
 
 reg_t kHaveMouse(EngineState *s, int argc, reg_t *argv) {
diff --git a/engines/sci/engine/script_patches.cpp b/engines/sci/engine/script_patches.cpp
index 41f7b2b7b1..0f6cf95ef2 100644
--- a/engines/sci/engine/script_patches.cpp
+++ b/engines/sci/engine/script_patches.cpp
@@ -1799,8 +1799,9 @@ static const uint16 freddypharkasPatchIntroScaling[] = {
 	0x35, 0x0a,                      // ldi 0a
 	0xa3, 0x02,                      // sal local[2]
 	// start of new inner loop
-	0x39, 0x00,                      // pushi 00
-	0x43, 0x2c, 0x00,                // callk GameIsRestarting (add this to trigger our speed throttler)
+	0x78,                            // push1
+	0x76,                            // push0
+	0x43, 0x2c, 0x02,                // callk GameIsRestarting 02 (add this to trigger our speed throttler)
 	PATCH_ADDTOOFFSET(+47),          // skip almost all of inner loop
 	0x33, 0xca,                      // jmp [inner loop start]
 	PATCH_END
@@ -2172,7 +2173,7 @@ static const uint16 hoyle4PatchCrazyEightsSound[] = {
 
 // In Gin Rummy, sound 404 plays when undercutting the computer but it gets
 //  interrupted. layEmOut:changeState sets a half-second delay, which is long
-//  long enough for the undercut sound when the computer wins, but not this one.
+//  enough for the undercut sound when the computer wins, but not this one.
 //
 // We fix this by increasing the delay to a full second when playing sound 404.
 //
@@ -5749,8 +5750,9 @@ static const uint16 kq6SignatureTalkingInventory[] = {
 
 static const uint16 kq6PatchTalkingInventory[] = {
 	PATCH_ADDTOOFFSET(+2),
-	0x39, 0x00,                         // pushi 00
-	0x43, 0x2c, 0x00,                   // callk GameIsRestarting [ custom throttling ]
+	0x78,                               // push1
+	0x76,                               // push0
+	0x43, 0x2c, 0x02,                   // callk GameIsRestarting 02 [ custom throttling ]
 	0x34, PATCH_UINT16(0x0000),         // ldi 0000 [ exit loop ]
 	PATCH_END
 };
@@ -13336,23 +13338,23 @@ static const uint16 qfg3SignatureCombatSpeedThrottling1[] = {
 
 static const uint16 qfg3PatchCombatSpeedThrottling1[] = {
 	0x76,                               // push0  (no link, freed +2 bytes)
-	0x43, 0x42, 0x00,                   // callk GetTime, 0d
+	0x43, 0x42, 0x00,                   // callk GetTime, 00
 	0xa1, 0x58,                         // sag global[88] (no push, leave time in acc)
 	0x8b, 0x01,                         // lsl local[1] (stack up the local instead, freed +1 byte)
+	0xa3, 0x01,                         // sal local[1] (update with new time)
 	0x1c,                               // ne?
-	0x31, 0x0c,                         // bnt 12d [after sal]
+	0x31, 0x08,                         // bnt 08 [ GameIsRestarting  0 ]
 										//
 	0x81, 0xd2,                         // lag global[210] (load into acc instead of stack)
 	0x76,                               // push0 (push0 instead of ldi 0, freed +1 byte)
 	0x22,                               // lt? (flip the comparison)
-	0x31, 0x06,                         // bnt 6d [after sal]
+	0x31, 0x02,                         // bnt 02 [ GameIsRestarting  0 ]
 										//
 	0xe1, 0xd2,                         // -ag global[210]
-	0x81, 0x58,                         // lag global[88]
-	0xa3, 0x01,                         // sal local[1]
-
-	0x76,                               // push0 (0 call args)
-	0x43, 0x2c, 0x00,                   // callk GameIsRestarting, 0d (add this to trigger our speed throttler)
+										//
+	0x39, 0x01,                         // push 01
+	0x76,                               // push0
+	0x43, 0x2c, 0x02,                   // callk GameIsRestarting, 02 (add this to trigger our speed throttler)
 	PATCH_END
 };