Ticket #8485: kyra_timers_v1.patch

kyra/kyra.cpp

@@ -330 +330 @@
         _pathfinderFlag = 0;
         _lastFindWayRet = 0;
         _sceneChangeState = _loopFlag2 = 0;
-        
+        _timerNextRun = 0;
+
         _movFacingTable = new int[150];
         assert(_movFacingTable);
         _movFacingTable[0] = 8;
@@ -449 +450 @@
         loadSpecialEffectShapes();
         loadItems();
         loadMainScreen();
+        setupTimers();
         loadPalette("PALETTE.COL", _screen->_currentPalette);
-        _screen->setScreenPalette(_screen->_currentPalette);
+
         // XXX
         initAnimStateList();
         setCharactersInDefaultScene();
 
         _gameSpeed = 50;
-        
+        _tickLength = (uint8)(1000.0 / _gameSpeed);
+
         if (!_scriptInterpreter->loadScript("_STARTUP.EMC", _npcScriptData, _opcodeTable, _opcodeTableSize, 0)) {
                 error("Could not load \"_STARTUP.EMC\" script");
         }
@@ -498 +501 @@
                                 _mouseY = event.mouse.y;
                                 break;
                         case OSystem::EVENT_QUIT:
-                                _quitFlag = true;
+                                quitGame();
                                 break;
                         default:
                                 break;
                         }
                 }
+                _sprites->updateSceneAnims();
+                updateAllObjectShapes();
+
+                if (_currentCharacter->sceneId == 210) {
+                        //XXX
+                }
+
                 if (amount > 0) {
                         _system->delayMillis((amount > 10) ? 10 : amount);
                 }
@@ -516 +526 @@
         while (!_quitFlag) {
                 int32 frameTime = (int32)_system->getMillis();
 
-                _sprites->updateSceneAnims();
-                updateAllObjectShapes();
+                updateGameTimers();
 
                 delay((frameTime + _gameSpeed) - _system->getMillis());
         }
@@ -1244 +1253 @@
 
 void KyraEngine::setCharacterPositionWithUpdate(int character) {
         debug(9, "setCharacterPositionWithUpdate(%d)", character);
-        // XXX game_updateAnimsFlags
+        _sprites->updateSceneAnims();
         setCharacterPosition(character, 0);
         updateAllObjectShapes();
         // XXX processPalette
@@ -1445 +1454 @@
         loadBitmap(fileNameBuffer, 3, 3, 0);
 
         _sprites->loadSceneShapes();
-        // TODO: check there it is done normally
+
+        _screen->fillRect(4, 4, 312, 136, 0, 0);
+        _screen->updateScreen();
         _screen->setScreenPalette(_screen->_currentPalette);
         _screen->copyRegion(4, 4, 4, 4, 308, 132, 3, 0);
 
@@ -2067 +2078 @@
         bool runLoop = true;
         uint8 currPage;
         OSystem::Event event;
-        uint8 tickLength = (uint8)(1000.0 / _gameSpeed);
+        int16 delayTime;
 
         //while( towns_isEscKeyPressed() )
                 //towns_getKey();
 
-        uint32 timeToEnd = strlen(chatStr) * 8 * tickLength + _system->getMillis();
+        uint32 timeToEnd = strlen(chatStr) * 8 * _tickLength + _system->getMillis();
 
         if (chatDuration != -1 ) {
                 switch ( _configTalkspeed) {
@@ -2085 +2096 @@
         }
 
         if (chatDuration != -1)
-                chatDuration *= tickLength;
+                chatDuration *= _tickLength;
 
-        //disableTimer(0x13);
-        //disableTimer(0x0E);
-        //disableTimer(0x12);
-        //towns_flushKeyb();
+        disableTimer(14);
+        disableTimer(18);
+        disableTimer(19);
 
         uint32 timeAtStart = _system->getMillis();
         uint32 loopStart;
@@ -2104 +2114 @@
 
                 if( _system->getMillis() < timeToEnd && !hasUpdatedNPCs) {
                         hasUpdatedNPCs = true;
-                        //disableTimer(0x0F);
+                        disableTimer(16);
                         _charSayUnk4 = 4;
                         animRefreshNPC(0);
                         animRefreshNPC(_charSayUnk1);
@@ -2116 +2126 @@
                         }
                 }
 
-                //updateGameTimers();
+                updateGameTimers();
                 _sprites->updateSceneAnims();
                 restoreAllObjectBackgrounds();
                 preserveAnyChangedBackgrounds();
@@ -2148 +2158 @@
                                 break;
                         }
                 }
-                delay((loopStart + _gameSpeed) - _system->getMillis());
+
+                delayTime = (loopStart + _gameSpeed) - _system->getMillis();
+                if (delayTime > 0)
+                        _system->delayMillis(delayTime);
         }
 
-        /*enableTimer(0x13);
-        enableTimer(0x0E);
-        enableTimer(0x12);
-        enableTimer(0x0F);
-        clearKyrandiaButtonIO();*/
+        enableTimer(14);
+        enableTimer(16);
+        enableTimer(18);
+        enableTimer(19);
+        //clearKyrandiaButtonIO();
 }
 
 void KyraEngine::endCharacterChat(int8 charNum, int16 convoInitialized) {
@@ -2760 +2773 @@
 void KyraEngine::copyChangedObjectsForward(int refreshFlag) {
         debug(9, "copyChangedObjectsForward(%d)", refreshFlag);
         AnimObject *curObject = _objectQueue;
+        bool changed = false;
 
         while (curObject) {
                 if (curObject->active) {
@@ -2772 +2786 @@
                                 
                                 _screen->copyRegion(xpos, ypos, xpos, ypos, width<<3, height, 2, 0, Screen::CR_CLIPPED);
                                 curObject->refreshFlag = 0;
+                                changed = true;
                         }
                 }
                 curObject = curObject->nextAnimObject;
         }
-        _screen->updateScreen();
+        if (changed)
+                _screen->updateScreen();
 }
 
 void KyraEngine::updateAllObjectShapes() {
@@ -3426 +3443 @@
                 _sprites->updateSceneAnims();
                 waitTicks(10);
                 // XXX updateMousePointer
-                // XXX updateGameTimers
+                updateGameTimers();
                 updateAllObjectShapes();
                 // XXX processPalette
                 if (_currentCharacter->sceneId == 210) {
@@ -3559 +3576 @@
         enterNewScene(sceneId, facing, 1, 1, 0);
         return returnValue;
 }
+
+#pragma mark -
+#pragma mark - Timer handling
+#pragma mark -
+
+void KyraEngine::setupTimers() {
+        debug(9, "KyraEngine::setupTimers()");
+        memset(_timers, 0, sizeof(_timers));
+
+        for (int i = 0; i < 34; i++)
+                _timers[i].active = 1;
+
+        _timers[0].func = _timers[1].func = _timers[2].func = _timers[3].func = _timers[4].func = 0; //Unused.
+        _timers[5].func = _timers[6].func = _timers[7].func = _timers[8].func = _timers[9].func = 0; //_nullsub51;
+        _timers[10].func = _timers[11].func = _timers[12].func = _timers[13].func = 0; //_nullsub50;
+        _timers[14].func = &Kyra::KyraEngine::timerCheckAnimFlag2;; //_nullsub52;
+        _timers[15].func = &Kyra::KyraEngine::timerUpdateHeadAnims; //_nullsub48;
+        _timers[16].func = &Kyra::KyraEngine::timerSetFlags1; //_nullsub47;
+        _timers[17].func = 0; //sub_15120;
+        _timers[18].func = &Kyra::KyraEngine::timerCheckAnimFlag1; //_nullsub53;
+        _timers[19].func = &Kyra::KyraEngine::timerRedrawAmulet; //_nullsub54;
+        _timers[20].func = 0; //offset _timerDummy1
+        _timers[21].func = 0; //sub_1517C; 
+        _timers[22].func = 0; //offset _timerDummy2
+        _timers[23].func = 0; //offset _timerDummy3, 
+        _timers[24].func = 0; //_nullsub45;
+        _timers[25].func = 0; //offset _timerDummy4
+        _timers[26].func = 0; //_nullsub46;
+        _timers[27].func = 0; //offset _timerDummy5, 
+        _timers[28].func = 0; //offset _timerDummy6
+        _timers[29].func = 0; //offset _timerDummy7, 
+        _timers[30].func = 0; //offset _timerDummy8, 
+        _timers[31].func = 0; //sub_151F8;
+        _timers[32].func = 0; //_nullsub61;
+        _timers[33].func = 0; //_nullsub62;
+
+        _timers[0].countdown = _timers[1].countdown = _timers[2].countdown = _timers[3].countdown = _timers[4].countdown = -1;
+        _timers[5].countdown = 5;
+        _timers[6].countdown = 7;
+        _timers[7].countdown = 8;
+        _timers[8].countdown = 9;
+        _timers[9].countdown = 7;
+        _timers[10].countdown = _timers[11].countdown = _timers[12].countdown = _timers[13].countdown = 420;
+        _timers[14].countdown = 600;
+        _timers[15].countdown = 11;
+        _timers[16].countdown = _timers[17].countdown = 7200;
+        _timers[18].countdown = _timers[19].countdown = 600;
+        _timers[20].countdown = 7200;
+        _timers[21].countdown = 18000;
+        _timers[22].countdown = 7200;
+        _timers[23].countdown = _timers[24].countdown = _timers[25].countdown = _timers[26].countdown = _timers[27].countdown = 10800;
+        _timers[28].countdown = 21600;
+        _timers[29].countdown = 7200;
+        _timers[30].countdown = 10800;
+        _timers[31].countdown = -1;
+        _timers[32].countdown = 9;
+        _timers[33].countdown = 3;
+
+}
+
+void KyraEngine::updateGameTimers() {
+        debug(9, "KyraEngine::updateGameTimers()");
+        void (Kyra::KyraEngine::*callback)(int timerNum);
+        
+        if (_system->getMillis() < _timerNextRun)
+                return;
+
+        _timerNextRun += 99999;
+
+        for (int i = 0; i < 34; i++) {
+                if (_timers[i].active && _timers[i].countdown > -1) {
+                        if (_timers[i].nextRun <=_system->getMillis()) {
+                                if (i < 5)
+                                        callback = 0;
+                                else
+                                        callback = _timers[i].func;
+
+                                if (callback)
+                                        (*this.*callback)(i);
+
+                                _timers[i].nextRun = _system->getMillis() + _timers[i].countdown * _tickLength;
+
+                        }
+                }
+                if (_timers[i].nextRun < _timerNextRun)
+                        _timerNextRun = _timers[i].nextRun;
+        }
+}
+
+void KyraEngine::clearNextEventTickCount() {
+        debug(9, "KyraEngine::clearNextEventTickCount()");
+        _timerNextRun = 0;
+}
+
+int16 KyraEngine::getTimerDelay(uint8 timer) {
+        return _timers[timer].countdown;
+}
+
+void KyraEngine::setTimerCountdown(uint8 timer, int16 countdown) {
+        debug(9, "KyraEngine::setTimerCountdown(%i, %i)", timer, countdown);
+        _timers[timer].countdown = countdown;
+
+        uint32 nextRun = _system->getMillis() + countdown;
+        if (nextRun < _timerNextRun)
+                _timerNextRun = nextRun;
+}
+
+void KyraEngine::enableTimer(uint8 timer) {
+        debug(9, "KyraEngine::enableTimer(%i)", timer);
+        _timers[timer].active = 1;
+}
+
+void KyraEngine::disableTimer(uint8 timer) {
+        debug(9, "KyraEngine::disableTimer(%i)", timer);
+        _timers[timer].active = 0;
+}
+
+void KyraEngine::timerUpdateHeadAnims(int timerNum) {
+        debug(9, "KyraEngine::timerUpdateHeadAnims(%i)", timerNum);
+        static int8 currentFrame = 0;
+        static const int8 frameTable[] = {4, 5, 4, 5, 4, 5, 0, 1, 4, 5,
+                                                                4, 4, 6, 4, 8, 1, 9, 4, -1};
+
+        if (_charSayUnk1 < 0)
+                return;
+
+        _charSayUnk4 = frameTable[currentFrame];
+        currentFrame++;
+
+        if (frameTable[currentFrame] == -1)
+                currentFrame = 0;
+
+        animRefreshNPC(0);
+        animRefreshNPC(_charSayUnk1);
+}
+
+void KyraEngine::timerSetFlags1(int timerNum) {
+        debug(9, "KyraEngine::timerSetFlags(%i)", timerNum);
+        if (_currentCharacter->sceneId == 0x1C)
+                return;
+
+        int rndNr = _rnd.getRandomNumberRng(0, 3);
+
+        for (int i = 0; i < 4; i++) {
+                if (!queryGameFlag(rndNr + 17)) {
+                        setGameFlag(rndNr + 17);
+                        break;
+                } else {
+                        rndNr++;
+                        if (rndNr > 3)
+                                rndNr = 0;
+                }
+        }
+}
+
+void KyraEngine::timerSetFlags2(int timerNum) {
+        if (!((uint32*)(_flagsTable+0x2D))[timerNum])
+                ((uint32*)(_flagsTable+0x2D))[timerNum] = 1;    
+}
+
+void KyraEngine::timerCheckAnimFlag1(int timerNum) {
+        debug(9, "KyraEngine::timerCheckAnimFlag1(%i)", timerNum);
+        if (_brandonStatusBit & 0x20) {
+                checkSpecialAnimFlags();
+                setTimerCountdown(18, -1);
+        }
+}
+
+void KyraEngine::timerCheckAnimFlag2(int timerNum) {
+        debug(9, "KyraEngine::timerCheckAnimFlag1(%i)", timerNum);
+        if (_brandonStatusBit & 0x2) {
+                checkSpecialAnimFlags();
+                setTimerCountdown(14, -1);
+        }
+}
+
+void KyraEngine::checkSpecialAnimFlags() {
+        debug(9, "KyraEngine::checkSpecialAnimFlags()");
+        if (_brandonStatusBit & 2) {
+                warning("STUB: playSpecialAnim1");
+                // XXX
+                setTimerCountdown(19, 300);
+        }
+
+        if (_brandonStatusBit & 0x20) {
+                warning("STUB: playSpecialAnim2");
+                // XXX
+                setTimerCountdown(19, 300);
+        }
+}
+
+void KyraEngine::timerRedrawAmulet(int timerNum) {
+        if (queryGameFlag(241)) {
+                drawAmulet();
+                setTimerCountdown(0x13, -1);
+        }
+}
+
+void KyraEngine::drawAmulet() {
+        static const int16 amuletTable1[] = {0x167, 0x162, 0x15D, 0x158, 0x153, 0x150, 0x155, 0x15A, 0x15F, 0x164, 0x145, -1};
+        static const int16 amuletTable3[] = {0x167, 0x162, 0x15D, 0x158, 0x153, 0x14F, 0x154, 0x159, 0x15E, 0x163, 0x144, -1};
+        static const int16 amuletTable2[] = {0x167, 0x162, 0x15D, 0x158, 0x153, 0x152, 0x157, 0x15C, 0x161, 0x166, 0x147, -1};
+        static const int16 amuletTable4[] = {0x167, 0x162, 0x15D, 0x158, 0x153, 0x151, 0x156, 0x15B, 0x160, 0x165, 0x146, -1};
+
+        _screen->hideMouse();
+
+        int i = 0;
+        while (amuletTable1[i] != -1) {
+                if (queryGameFlag(87))
+                        _screen->drawShape(0, _shapes[ 4+amuletTable1[i] ], _amuletX[0], _amuletY[0], 0, 0);
+
+                if (queryGameFlag(89))
+                        _screen->drawShape(0, _shapes[ 4+amuletTable2[i] ], _amuletX[1], _amuletY[1], 0, 0);
+
+                if (queryGameFlag(86))
+                        _screen->drawShape(0, _shapes[ 4+amuletTable3[i] ], _amuletX[2], _amuletY[2], 0, 0);
+
+                if (queryGameFlag(88))
+                        _screen->drawShape(0, _shapes[ 4+amuletTable4[i] ], _amuletX[3], _amuletY[3], 0, 0);
+
+                delay(3 * _tickLength);
+                i++;
+        }
+        _screen->showMouse();
+}
+
 } // End of namespace Kyra

kyra/kyra.h

@@ -142 +142 @@
 struct ScriptState;
 struct ScriptData;
 class ScriptHelper;
+class KyraEngine;
+
+struct Timer {
+        bool active;
+        int16 countdown;
+        uint32 nextRun;
+        void (Kyra::KyraEngine::*func)(int timerNum);
+};
 
 class KyraEngine : public Engine {
         friend class MusicPlayer;
@@ -195 +203 @@
         void restoreTalkTextMessageBkgd(int srcPage, int dstPage);
         void drawSentenceCommand(char *sentence, int unk1);
 
+        void updateGameTimers();
+        void clearNextEventTickCount();
+        void setTimerCountdown(uint8 timer, int16 countdown);
+        int16 getTimerDelay(uint8 timer);
+        void enableTimer(uint8 timer);
+        void disableTimer(uint8 timer);
+
         WSAMovieV1 *wsa_open(const char *filename, int offscreenDecode, uint8 *palBuf);
         void wsa_close(WSAMovieV1 *wsa);
         uint16 wsa_getNumFrames(WSAMovieV1 *wsa) const;
@@ -480 +495 @@
         void setCharactersInDefaultScene();
         void resetBrandonPosionFlags();
         void initAnimStateList();
+        
+        void setupTimers();
+        void timerUpdateHeadAnims(int timerNum);
+        void timerSetFlags1(int timerNum);
+        void timerSetFlags2(int timerNum);
+        void timerCheckAnimFlag1(int timerNum);
+        void timerCheckAnimFlag2(int timerNum);
+        void checkSpecialAnimFlags();
+        void timerRedrawAmulet(int timerNum);
+        void drawAmulet();
 
         uint8 _game;
         bool _fastMode;
@@ -495 +520 @@
         uint8 _flagsTable[53];
         uint8 *_shapes[377];
         uint16 _gameSpeed;
+        uint16 _tickLength;
         uint32 _features;
         int _mouseX, _mouseY;
         bool _needMouseUpdate;
@@ -606 +632 @@
         int _roomTableSize;     
         char **_roomFilenameTable;
         int _roomFilenameTableSize;
-        
+
+        Timer _timers[34];
+        uint32 _timerNextRun;   
         static const char *_xmidiFiles[];
         static const int _xmidiFilesCount;
         
@@ -614 +642 @@
         static const int8 _addXPosTable[];
         static const int8 _charYPosTable[];
         static const int8 _addYPosTable[];
+
+        static const uint16 _amuletX[];
+        static const uint16 _amuletY[];
+
 };
 
 } // End of namespace Kyra

kyra/script_v1.cpp

@@ -373 +373 @@
 
 int KyraEngine::cmd_walkPlayerToPoint(ScriptState *script) {
         debug(9, "cmd_walkPlayerToPoint(0x%X)", script);
-        // if !stackPos(2)
-        // XXX
+
+        if (!stackPos(2)) {
+                disableTimer(19);
+                disableTimer(14);
+                disableTimer(18);
+        }
+
         int reinitScript = handleSceneChange(stackPos(0), stackPos(1), stackPos(2), stackPos(3));
-        // XXX
+
+        if (!stackPos(2)) {
+                enableTimer(19);
+                enableTimer(14);
+                enableTimer(18);
+        }
+
         if (reinitScript) {
                 _scriptInterpreter->initScript(script, script->dataPtr);
         }
@@ -520 +531 @@
 
 int KyraEngine::cmd_pauseSeconds(ScriptState *script) {
         debug(9, "cmd_pauseSeconds(0x%X)", script);
-        _system->delayMillis(stackPos(0)*1000);
+        delay(stackPos(0)*1000);
         return 0;
 }
 
@@ -921 +932 @@
         int toX = stackPos(1);
         int toY = stackPos(2);
         _pathfinderFlag2 = 1;
+        uint32 nextFrame;
         int findWayReturn = findWay(_characterList[character].x1, _characterList[character].y1, toX, toY, _movFacingTable, 150);
         _pathfinderFlag2 = 0;
         if (_lastFindWayRet < findWayReturn) {
@@ -980 +992 @@
                         continue;
                 }
                 
+                nextFrame = getTimerDelay(5 + character) * _tickLength + _system->getMillis();
                 setCharacterPosition(character, 0);
                 ++curPos;
-                // XXX
-                waitTicks(10);
-                _sprites->updateSceneAnims();
-                // XXX updateMouseCursor();
-                // XXX updateGameTimers();
-                updateAllObjectShapes();
-                // XXX processPalette();
+
+                while (_system->getMillis() < nextFrame) {
+                        _sprites->updateSceneAnims();
+                        // XXX updateMouseCursor();
+                        updateGameTimers();
+                        updateAllObjectShapes();
+                        // XXX processPalette();
+                        if ((nextFrame - _system->getMillis()) >= 10)
+                                _system->delayMillis(10);
+                }
         }
         return 0;
 }

kyra/sprites.cpp

@@ -405 +405 @@
                 _engine->_northExitHeight += 1;
         // XXX  
         memcpy(_screen->_currentPalette + 745 - 0x3D, _dat + 0x17, 0x3D);
-        _screen->setScreenPalette(_screen->_currentPalette);
         uint8 *data = _dat + 0x6B;
 
         uint16 length = READ_LE_UINT16(data);

kyra/staticres.cpp

@@ -589 +589 @@
         0, -2, -2, -2, 0, 2, 2, 2
 };
 
+const uint16 KyraEngine::_amuletX[] = {231, 275, 253, 253};
+const uint16 KyraEngine::_amuletY[] = {170, 170, 159, 181};
+
 } // End of namespace Kyra