Reduce the amount of sliding NPCs by caching and replaying animations (#811)

* Greatly reduce the amount of sliding NPCs by caching and replaying animations

Having a single `LatestAction` wasn't enough to bring Actors into a correct animation state. Now non-cell-owners (aka party members) will replay recently run animations when an Actor is being set up in their world

* No need for start actions, also removed `g_actionsSkipIntermediate` and related code

* Replace actions with instant counterparts when possible

* Simplify `ActionsToReplay` serialization in AssignCharacterResponse and CharacterSpawnRequest

`ApplyDifferential` doesn't work like I expected, and on top of that it doesn't cut that much bytes. We should be fine

* Add ability to replay actions manually in ComponentDebugView

* Small AnimationEventLists reorganization and renames

* Delay actions queued for replay if the first one is `IdleForceDefaultState`

(temporary solution)

* Replace `IdleForceDefaultState` plus a delay with a proper solution (call to `RevertAnimationGraphManager`)

* Remove redundant check in `ActorMediator::ForceAction`

Since we now check for readiness in `AnimationSystem::Update`

* More AnimationEventLists actions, remove some Exits, clean up

* Move call to `RefineReplayCache` to the right place; drop useless exit action

* Introduce `EarlyAnimationBufferComponent` to improve animation sync on cell enter

Particularly, when a party member enters the cell first, before the leader. Note that this commit also reverts af0561f (PR #762) as storing `LatestWeapEquipAnimation` is no longer necessary

* Add more actions to AnimationEventLists

* Address review comments: String -> std::string_view, and other misc and naming fixes

Author: miredirex

Code/client/Components.h

@@ -5,6 +5,8 @@
 
 #include <Components/LocalAnimationComponent.h>
 #include <Components/RemoteAnimationComponent.h>
+#include <Components/EarlyAnimationBufferComponent.h>
+#include <Components/ReplayedActionsDebugComponent.h>
 #include <Components/FormIdComponent.h>
 #include <Components/InterpolationComponent.h>
 #include <Components/WaitingForAssignmentComponent.h>

Code/client/Components/EarlyAnimationBufferComponent.h

@@ -0,0 +1,17 @@
+#pragma once
+
+#ifndef TP_INTERNAL_COMPONENTS_GUARD
+#error Include Components.h instead
+#endif
+
+#include <Structs/ActionEvent.h>
+
+/**
+ * @brief `LocalAnimationComponent` is typically added several frames after the Actor 
+ * has been spawned, causing some of the earliest actions to be missed and not sent 
+ * over the network. `EarlyAnimationBufferComponent` takes care of this.
+ */
+struct EarlyAnimationBufferComponent
+{
+    Vector<ActionEvent> Actions{};
+};

Code/client/Components/RemoteAnimationComponent.h

@@ -9,4 +9,6 @@ struct RemoteAnimationComponent
     List<ActionEvent> TimePoints;
     ActionEvent LastRanAction;
     ActionEvent LastProcessedAction;
+    uint32_t ReplayCount;
+    bool ResetAnimationGraphForReplay{false};
 };

Code/client/Components/ReplayedActionsDebugComponent.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#ifndef TP_INTERNAL_COMPONENTS_GUARD
+#error Include Components.h instead
+#endif
+
+#include <Structs/ActionReplayChain.h>
+
+/**
+ * @brief Used for in-game animation debugging purposes. Makes it easier
+ * to see which actions were replayed on a particular Actor.
+ * 
+ * @see ComponentView
+ */
+struct ReplayedActionsDebugComponent
+{
+    ActionReplayChain ActionsReceivedForReplay;
+};

Code/client/Games/ActorExtension.h

@@ -19,7 +19,6 @@ struct ActorExtension
     void SetPlayer(bool aSet) noexcept;
 
     ActionEvent LatestAnimation{};
-    ActionEvent LatestWeapEquipAnimation{};
     size_t GraphDescriptorHash = 0;
 
   private:

Code/client/Games/Animation.cpp

@@ -54,9 +54,6 @@ uint8_t TP_MAKE_THISCALL(HookPerformAction, ActorMediator, TESActionData* apActi
         if (res)
         {
             pExtension->LatestAnimation = action;
-            
-            if(apAction->action->formID == 0x132AF)
-                pExtension->LatestWeapEquipAnimation = action;
         }
 
         World::Get().GetRunner().Trigger(action);
@@ -117,7 +114,7 @@ bool ActorMediator::ForceAction(TESActionData* apAction) noexcept
     uint8_t result = 0;
 
     auto pActor = static_cast<Actor*>(apAction->actor);
-    if (!pActor || pActor->animationGraphHolder.IsReady())
+    if (pActor)
     {
         result = TiltedPhoques::ThisCall(PerformComplexAction, this, apAction);
 

Code/client/Games/Animation/IAnimationGraphManagerHolder.h

@@ -29,7 +29,10 @@ struct IAnimationGraphManagerHolder
     virtual bool GetVariableBool(BSFixedString* apVariable, bool* apReturn);
 
     bool SetVariableFloat(BSFixedString* apVariable, float aValue);
+    bool SetVariableInt(BSFixedString* apVariable, int32_t aValue);
+    bool SetVariableBool(BSFixedString* apVariable, bool aValue);
     bool IsReady();
+    bool RevertAnimationGraphManager();
 
     bool ReSendAnimationEvent(BSFixedString* apAnimEvent);
 };

Code/client/Games/IAnimationGraphManagerHolder.cpp

@@ -12,6 +12,30 @@ bool IAnimationGraphManagerHolder::SetVariableFloat(BSFixedString* apVariable, f
     return TiltedPhoques::ThisCall(InternalSetFloatVariable, this, apVariable, aValue);
 }
 
+bool IAnimationGraphManagerHolder::SetVariableInt(BSFixedString* apVariable, int32_t aValue)
+{
+    TP_THIS_FUNCTION(TSetIntVariable, bool, IAnimationGraphManagerHolder, BSFixedString*, int32_t);
+    POINTER_SKYRIMSE(TSetIntVariable, InternalSetIntVariable, 32886);
+
+    return TiltedPhoques::ThisCall(InternalSetIntVariable, this, apVariable, aValue);
+}
+
+bool IAnimationGraphManagerHolder::SetVariableBool(BSFixedString* apVariable, bool aValue)
+{
+    TP_THIS_FUNCTION(TSetBoolVariable, bool, IAnimationGraphManagerHolder, BSFixedString*, bool);
+    POINTER_SKYRIMSE(TSetBoolVariable, InternalSetBoolVariable, 32885);
+
+    return TiltedPhoques::ThisCall(InternalSetBoolVariable, this, apVariable, aValue);
+}
+
+bool IAnimationGraphManagerHolder::RevertAnimationGraphManager()
+{
+    TP_THIS_FUNCTION(TRevertAnimationGraphManager, bool, IAnimationGraphManagerHolder);
+    POINTER_SKYRIMSE(TRevertAnimationGraphManager, InternalRevertAnimationGraphManager, 32883);
+
+    return TiltedPhoques::ThisCall(InternalRevertAnimationGraphManager, this);
+}
+
 bool IAnimationGraphManagerHolder::IsReady()
 {
     BSAnimationGraphManager* pAnimationGraph = nullptr;

Code/client/Services/Debug/DebugService.cpp

@@ -44,6 +44,8 @@
 #include <AI/AIProcess.h>
 
 #include <Messages/RequestRespawn.h>
+#include <Messages/PartyCreateRequest.h>
+#include <Messages/PartyLeaveRequest.h>
 
 #include <Games/Misc/SubtitleManager.h>
 #include <Games/Overrides.h>
@@ -189,7 +191,10 @@ void DebugService::OnUpdate(const UpdateEvent& acUpdateEvent) noexcept
         {
             s_f7Pressed = true;
 
-            //
+            if (!m_world.GetPartyService().IsInParty())
+                m_transport.Send(PartyCreateRequest{});
+            else
+                m_transport.Send(PartyLeaveRequest{});
         }
     }
     else

Code/client/Services/Debug/Views/AnimDebugView.cpp

@@ -1,4 +1,3 @@
-
 #include <imgui.h>
 #include <EquipManager.h>
 #include <services/DebugService.h>
@@ -133,6 +132,12 @@ void DebugService::DrawAnimDebugView()
         s_cachedKeys[hash] = pActor->formID;
     }
 
+    if (ImGui::Button("Revert animation graph"))
+    {
+        spdlog::info("RevertAnimationGraphManager success? {}",
+                      pActor->animationGraphHolder.RevertAnimationGraphManager());
+    }
+
     if (ImGui::BeginTabBar("##Tabs", ImGuiTabBarFlags_None))
     {
         if (ImGui::BeginTabItem("Variables"))