Save repeat and duration

CHANGELOG.md

@@ -52,6 +52,7 @@
     Bug #6168: Weather particles flicker for a frame at start of storms
     Bug #6172: Some creatures can't open doors
     Bug #6174: Spellmaking and Enchanting sliders differences from vanilla
+    Bug #6177: Followers of player follower stop following after waiting for a day
     Bug #6184: Command and Calm and Demoralize and Frenzy and Rally magic effects inconsistencies with vanilla
     Bug #6197: Infinite Casting Loop
     Bug #6253: Multiple instances of Reflect stack additively
@@ -81,6 +82,7 @@
     Bug #6416: Morphs are applied to the wrong target
     Bug #6429: Wyrmhaven: Can't add AI packages to player
     Feature #890: OpenMW-CS: Column filtering
+    Feature #1465: "Reset" argument for AI functions
     Feature #2554: Modifying an object triggers the instances table to scroll to the corresponding record
     Feature #2780: A way to see current OpenMW version in the console
     Feature #3616: Allow Zoom levels on the World Map

apps/esmtool/record.cpp

@@ -30,7 +30,7 @@ void printAIPackage(const ESM::AIPackage& p)
     {
         std::cout << "    Travel Coordinates: (" << p.mTravel.mX << ","
                   << p.mTravel.mY << "," << p.mTravel.mZ << ")" << std::endl;
-        std::cout << "    Travel Unknown: " << p.mTravel.mUnk << std::endl;
+        std::cout << "    Should repeat: " << p.mTravel.mShouldRepeat << std::endl;
     }
     else if (p.mType == ESM::AI_Follow || p.mType == ESM::AI_Escort)
     {
@@ -38,12 +38,12 @@ void printAIPackage(const ESM::AIPackage& p)
                   << p.mTarget.mY << "," << p.mTarget.mZ << ")" << std::endl;
         std::cout << "    Duration: " << p.mTarget.mDuration << std::endl;
         std::cout << "    Target ID: " << p.mTarget.mId.toString() << std::endl;
-        std::cout << "    Unknown: " << p.mTarget.mUnk << std::endl;
+        std::cout << "    Should repeat: " << p.mTarget.mShouldRepeat << std::endl;
     }
     else if (p.mType == ESM::AI_Activate)
     {
         std::cout << "    Name: " << p.mActivate.mName.toString() << std::endl;
-        std::cout << "    Activate Unknown: " << p.mActivate.mUnk << std::endl;
+        std::cout << "    Should repeat: " << p.mActivate.mShouldRepeat << std::endl;
     }
     else {
         std::cout << "    BadPackage: " << Misc::StringUtils::format("0x%08X", p.mType) << std::endl;

apps/openmw/mwmechanics/aiactivate.cpp

@@ -48,6 +48,7 @@ namespace MWMechanics
     {
         std::unique_ptr<ESM::AiSequence::AiActivate> activate(new ESM::AiSequence::AiActivate());
         activate->mTargetId = mObjectId;
+        activate->mRepeat = getRepeat();
 
         ESM::AiSequence::AiPackageContainer package;
         package.mType = ESM::AiSequence::Ai_Activate;
@@ -56,7 +57,7 @@ namespace MWMechanics
     }
 
     AiActivate::AiActivate(const ESM::AiSequence::AiActivate *activate)
-        : mObjectId(activate->mTargetId)
+        : AiActivate(activate->mTargetId, activate->mRepeat)
     {
     }
 }

apps/openmw/mwmechanics/aiescort.cpp

@@ -37,11 +37,8 @@ namespace MWMechanics
     }
 
     AiEscort::AiEscort(const ESM::AiSequence::AiEscort *escort)
-        : mCellId(escort->mCellId), mX(escort->mData.mX), mY(escort->mData.mY), mZ(escort->mData.mZ)
+        : TypedAiPackage<AiEscort>(escort->mRepeat), mCellId(escort->mCellId), mX(escort->mData.mX), mY(escort->mData.mY), mZ(escort->mData.mZ)
-        // mDuration isn't saved in the save file, so just giving it "1" for now if the package has a duration.
+        , mDuration(escort->mData.mDuration)
-        // The exact value of mDuration only matters for repeating packages.
-        // Previously mRemainingDuration could be negative even when mDuration was 0. Checking for > 0 should fix old saves.
-        , mDuration(escort->mRemainingDuration > 0)
         , mRemainingDuration(escort->mRemainingDuration)
         , mCellX(std::numeric_limits<int>::max())
         , mCellY(std::numeric_limits<int>::max())
@@ -103,10 +100,12 @@ namespace MWMechanics
         escort->mData.mX = mX;
         escort->mData.mY = mY;
         escort->mData.mZ = mZ;
+        escort->mData.mDuration = mDuration;
         escort->mTargetId = mTargetActorRefId;
         escort->mTargetActorId = mTargetActorId;
         escort->mRemainingDuration = mRemainingDuration;
         escort->mCellId = mCellId;
+        escort->mRepeat = getRepeat();
 
         ESM::AiSequence::AiPackageContainer package;
         package.mType = ESM::AiSequence::Ai_Escort;

apps/openmw/mwmechanics/aifollow.cpp

@@ -52,12 +52,9 @@ AiFollow::AiFollow(const MWWorld::Ptr& actor, bool commanded)
 }
 
 AiFollow::AiFollow(const ESM::AiSequence::AiFollow *follow)
-    : TypedAiPackage<AiFollow>(makeDefaultOptions().withShouldCancelPreviousAi(!follow->mCommanded))
+    : TypedAiPackage<AiFollow>(makeDefaultOptions().withShouldCancelPreviousAi(!follow->mCommanded).withRepeat(follow->mRepeat))
     , mAlwaysFollow(follow->mAlwaysFollow)
-    // mDuration isn't saved in the save file, so just giving it "1" for now if the package had a duration.
+    , mDuration(follow->mData.mDuration)
-    // The exact value of mDuration only matters for repeating packages.
-    // Previously mRemainingDuration could be negative even when mDuration was 0. Checking for > 0 should fix old saves.
-    , mDuration(follow->mRemainingDuration)
     , mRemainingDuration(follow->mRemainingDuration)
     , mX(follow->mData.mX), mY(follow->mData.mY), mZ(follow->mData.mZ)
     , mCellId(follow->mCellId), mActive(follow->mActive), mFollowIndex(mFollowIndexCounter++)
@@ -144,12 +141,15 @@ bool AiFollow::execute (const MWWorld::Ptr& actor, CharacterController& characte
             if (actor.getCell()->isExterior()) //Outside?
             {
                 if (mCellId == "") //No cell to travel to
+                {
+                    mRemainingDuration = mDuration;
                     return true;
+                }
             }
-            else
+            else if (mCellId == actor.getCell()->getCell()->mName) //Cell to travel to
             {
-                if (mCellId == actor.getCell()->getCell()->mName) //Cell to travel to
+                mRemainingDuration = mDuration;
-                    return true;
+                return true;
             }
         }
     }
@@ -205,6 +205,7 @@ void AiFollow::writeState(ESM::AiSequence::AiSequence &sequence) const
     follow->mData.mX = mX;
     follow->mData.mY = mY;
     follow->mData.mZ = mZ;
+    follow->mData.mDuration = mDuration;
     follow->mTargetId = mTargetActorRefId;
     follow->mTargetActorId = mTargetActorId;
     follow->mRemainingDuration = mRemainingDuration;
@@ -212,6 +213,7 @@ void AiFollow::writeState(ESM::AiSequence::AiSequence &sequence) const
     follow->mAlwaysFollow = mAlwaysFollow;
     follow->mCommanded = isCommanded();
     follow->mActive = mActive;
+    follow->mRepeat = getRepeat();
 
     ESM::AiSequence::AiPackageContainer package;
     package.mType = ESM::AiSequence::Ai_Follow;

apps/openmw/mwmechanics/aitravel.cpp

@@ -50,7 +50,7 @@ namespace MWMechanics
     }
 
     AiTravel::AiTravel(const ESM::AiSequence::AiTravel *travel)
-        : mX(travel->mData.mX), mY(travel->mData.mY), mZ(travel->mData.mZ), mHidden(false)
+        : TypedAiPackage<AiTravel>(travel->mRepeat), mX(travel->mData.mX), mY(travel->mData.mY), mZ(travel->mData.mZ), mHidden(false)
     {
         // Hidden ESM::AiSequence::AiTravel package should be converted into MWMechanics::AiInternalTravel type
         assert(!travel->mHidden);
@@ -125,6 +125,7 @@ namespace MWMechanics
         travel->mData.mY = mY;
         travel->mData.mZ = mZ;
         travel->mHidden = mHidden;
+        travel->mRepeat = getRepeat();
 
         ESM::AiSequence::AiPackageContainer package;
         package.mType = ESM::AiSequence::Ai_Travel;

components/esm/aisequence.cpp

@@ -3,6 +3,7 @@
 #include "esmreader.hpp"
 #include "esmwriter.hpp"
 
+#include <algorithm>
 #include <memory>
 
 namespace ESM
@@ -34,12 +35,16 @@ namespace AiSequence
     {
         esm.getHNT (mData, "DATA");
         esm.getHNOT (mHidden, "HIDD");
+        mRepeat = false;
+        esm.getHNOT(mRepeat, "REPT");
     }
 
     void AiTravel::save(ESMWriter &esm) const
     {
         esm.writeHNT ("DATA", mData);
         esm.writeHNT ("HIDD", mHidden);
+        if(mRepeat)
+            esm.writeHNT("REPT", mRepeat);
     }
 
     void AiEscort::load(ESMReader &esm)
@@ -50,6 +55,15 @@ namespace AiSequence
         esm.getHNOT (mTargetActorId, "TAID");
         esm.getHNT (mRemainingDuration, "DURA");
         mCellId = esm.getHNOString ("CELL");
+        mRepeat = false;
+        esm.getHNOT(mRepeat, "REPT");
+        if(esm.getFormat() < 18)
+        {
+            // mDuration isn't saved in the save file, so just giving it "1" for now if the package has a duration.
+            // The exact value of mDuration only matters for repeating packages.
+            // Previously mRemainingDuration could be negative even when mDuration was 0. Checking for > 0 should fix old saves.
+            mData.mDuration = std::max<float>(mRemainingDuration > 0, mRemainingDuration);
+        }
     }
 
     void AiEscort::save(ESMWriter &esm) const
@@ -60,6 +74,8 @@ namespace AiSequence
         esm.writeHNT ("DURA", mRemainingDuration);
         if (!mCellId.empty())
             esm.writeHNString ("CELL", mCellId);
+        if(mRepeat)
+            esm.writeHNT("REPT", mRepeat);
     }
 
     void AiFollow::load(ESMReader &esm)
@@ -75,6 +91,15 @@ namespace AiSequence
         esm.getHNOT (mCommanded, "CMND");
         mActive = false;
         esm.getHNOT (mActive, "ACTV");
+        mRepeat = false;
+        esm.getHNOT(mRepeat, "REPT");
+        if(esm.getFormat() < 18)
+        {
+            // mDuration isn't saved in the save file, so just giving it "1" for now if the package has a duration.
+            // The exact value of mDuration only matters for repeating packages.
+            // Previously mRemainingDuration could be negative even when mDuration was 0. Checking for > 0 should fix old saves.
+            mData.mDuration = std::max<float>(mRemainingDuration > 0, mRemainingDuration);
+        }
     }
 
     void AiFollow::save(ESMWriter &esm) const
@@ -89,16 +114,22 @@ namespace AiSequence
         esm.writeHNT ("CMND", mCommanded);
         if (mActive)
             esm.writeHNT("ACTV", mActive);
+        if(mRepeat)
+            esm.writeHNT("REPT", mRepeat);
     }
 
     void AiActivate::load(ESMReader &esm)
     {
         mTargetId = esm.getHNString("TARG");
+        mRepeat = false;
+        esm.getHNOT(mRepeat, "REPT");
     }
 
     void AiActivate::save(ESMWriter &esm) const
     {
         esm.writeHNString("TARG", mTargetId);
+        if(mRepeat)
+            esm.writeHNT("REPT", mRepeat);
     }
 
     void AiCombat::load(ESMReader &esm)
@@ -166,6 +197,7 @@ namespace AiSequence
 
     void AiSequence::load(ESMReader &esm)
     {
+        int count = 0;
         while (esm.isNextSub("AIPK"))
         {
             int type;
@@ -181,6 +213,7 @@ namespace AiSequence
                 std::unique_ptr<AiWander> ptr = std::make_unique<AiWander>();
                 ptr->load(esm);
                 mPackages.back().mPackage = ptr.release();
+                ++count;
                 break;
             }
             case Ai_Travel:
@@ -188,6 +221,7 @@ namespace AiSequence
                 std::unique_ptr<AiTravel> ptr = std::make_unique<AiTravel>();
                 ptr->load(esm);
                 mPackages.back().mPackage = ptr.release();
+                ++count;
                 break;
             }
             case Ai_Escort:
@@ -195,6 +229,7 @@ namespace AiSequence
                 std::unique_ptr<AiEscort> ptr = std::make_unique<AiEscort>();
                 ptr->load(esm);
                 mPackages.back().mPackage = ptr.release();
+                ++count;
                 break;
             }
             case Ai_Follow:
@@ -202,6 +237,7 @@ namespace AiSequence
                 std::unique_ptr<AiFollow> ptr = std::make_unique<AiFollow>();
                 ptr->load(esm);
                 mPackages.back().mPackage = ptr.release();
+                ++count;
                 break;
             }
             case Ai_Activate:
@@ -209,6 +245,7 @@ namespace AiSequence
                 std::unique_ptr<AiActivate> ptr = std::make_unique<AiActivate>();
                 ptr->load(esm);
                 mPackages.back().mPackage = ptr.release();
+                ++count;
                 break;
             }
             case Ai_Combat:
@@ -231,6 +268,23 @@ namespace AiSequence
         }
 
         esm.getHNOT (mLastAiPackage, "LAST");
+
+        if(count > 1 && esm.getFormat() < 18)
+        {
+            for(auto& pkg : mPackages)
+            {
+                if(pkg.mType == Ai_Wander)
+                    static_cast<AiWander*>(pkg.mPackage)->mData.mShouldRepeat = true;
+                else if(pkg.mType == Ai_Travel)
+                    static_cast<AiTravel*>(pkg.mPackage)->mRepeat = true;
+                else if(pkg.mType == Ai_Escort)
+                    static_cast<AiEscort*>(pkg.mPackage)->mRepeat = true;
+                else if(pkg.mType == Ai_Follow)
+                    static_cast<AiFollow*>(pkg.mPackage)->mRepeat = true;
+                else if(pkg.mType == Ai_Activate)
+                    static_cast<AiActivate*>(pkg.mPackage)->mRepeat = true;
+            }
+        }
     }
 }
 }

components/esm/aisequence.hpp

@@ -81,6 +81,7 @@ namespace ESM
     {
         AiTravelData mData;
         bool mHidden;
+        bool mRepeat;
 
         void load(ESMReader &esm);
         void save(ESMWriter &esm) const;
@@ -94,6 +95,7 @@ namespace ESM
         std::string mTargetId;
         std::string mCellId;
         float mRemainingDuration;
+        bool mRepeat;
 
         void load(ESMReader &esm);
         void save(ESMWriter &esm) const;
@@ -112,6 +114,7 @@ namespace ESM
         bool mCommanded;
 
         bool mActive;
+        bool mRepeat;
 
         void load(ESMReader &esm);
         void save(ESMWriter &esm) const;
@@ -120,6 +123,7 @@ namespace ESM
     struct AiActivate : AiPackage
     {
         std::string mTargetId;
+        bool mRepeat;
 
         void load(ESMReader &esm);
         void save(ESMWriter &esm) const;

components/esm/savedgame.cpp

@@ -4,7 +4,7 @@
 #include "esmwriter.hpp"
 
 unsigned int ESM::SavedGame::sRecordId = ESM::REC_SAVE;
-int ESM::SavedGame::sCurrentFormat = 17;
+int ESM::SavedGame::sCurrentFormat = 18;
 
 void ESM::SavedGame::load (ESMReader &esm)
 {