Merge pull request #659 from rfortier/feat-modded-anim-compat

Feature: support for behavior mods

Author: RobbeBryssinck

Code/client/Games/ActorExtension.h

@@ -21,6 +21,6 @@ struct ActorExtension
     ActionEvent LatestAnimation{};
     size_t GraphDescriptorHash = 0;
 
-private:
+  private:
     uint32_t onlineFlags{0};
 };

Code/client/Games/References.cpp

@@ -39,6 +39,7 @@
 #include <Services/DebugService.h>
 #include <World.h>
 
+
 #if TP_SKYRIM64
 #include <Combat/CombatController.h>
 #include <AI/AITimer.h>
@@ -49,6 +50,8 @@
 #include <Structs/Fallout4/AnimationGraphDescriptor_Master_Behavior.h>
 #endif
 
+extern const AnimationGraphDescriptor* BehaviorVarPatch(BSAnimationGraphManager* pManager, Actor* pActor);
+
 using ScopedReferencesOverride = ScopedOverride<TESObjectREFR>;
 thread_local uint32_t ScopedReferencesOverride::s_refCount = 0;
 
@@ -219,6 +222,11 @@ void TESObjectREFR::SaveAnimationVariables(AnimationVariables& aVariables) const
 
             auto pDescriptor = AnimationGraphDescriptorManager::Get().GetDescriptor(pExtendedActor->GraphDescriptorHash);
 
+            // Modded behavior check if descriptor wasn't found
+            extern const AnimationGraphDescriptor* BehaviorVarPatch(BSAnimationGraphManager * pManager, Actor * pActor);
+            if (!pDescriptor)
+                pDescriptor = BehaviorVarPatch(pManager, pActor);
+
             if (!pDescriptor)
                 return;
 
@@ -227,10 +235,9 @@ void TESObjectREFR::SaveAnimationVariables(AnimationVariables& aVariables) const
             if (!pVariableSet)
                 return;
 
-            aVariables.Booleans = 0;
-
-            aVariables.Floats.resize(pDescriptor->FloatLookupTable.size());
-            aVariables.Integers.resize(pDescriptor->IntegerLookupTable.size());
+            aVariables.Booleans.assign(pDescriptor->BooleanLookUpTable.size(), false);
+            aVariables.Floats.assign(pDescriptor->FloatLookupTable.size(), 0.f);
+            aVariables.Integers.assign(pDescriptor->IntegerLookupTable.size(), 0);
 
 #if TP_FALLOUT4
             // TODO: maybe send a var with the variables indicating first or third person?
@@ -251,14 +258,14 @@ void TESObjectREFR::SaveAnimationVariables(AnimationVariables& aVariables) const
                         continue;
 
                     if (pFirstPersonVariables->data[*firstPersonIdx] != 0)
-                        aVariables.Booleans |= (1ull << i);
+                        aVariables.Booleans[i] = true;
 
                     continue;
                 }
 #endif
 
                 if (pVariableSet->data[idx] != 0)
-                    aVariables.Booleans |= (1ull << i);
+                    aVariables.Booleans[i] = true;
             }
 
             for (size_t i = 0; i < pDescriptor->FloatLookupTable.size(); ++i)
@@ -339,6 +346,10 @@ void TESObjectREFR::LoadAnimationVariables(const AnimationVariables& aVariables)
 
             auto pDescriptor = AnimationGraphDescriptorManager::Get().GetDescriptor(pExtendedActor->GraphDescriptorHash);
 
+            // Modded behavior check if descriptor wasn't found
+            if (!pDescriptor)
+                pDescriptor = BehaviorVarPatch(pManager, pActor);
+
             if (!pDescriptor)
                 return;
 
@@ -361,7 +372,7 @@ void TESObjectREFR::LoadAnimationVariables(const AnimationVariables& aVariables)
 
                 if (pVariableSet->size > idx)
                 {
-                    pVariableSet->data[idx] = (aVariables.Booleans & (1ull << i)) != 0;
+                    pVariableSet->data[idx] = aVariables.Booleans.size() > i ? aVariables.Booleans[i] : false;
                 }
             }
 

Code/client/Games/Skyrim/Actor.cpp

@@ -49,6 +49,8 @@
 #include <Forms/BGSOutfit.h>
 #include <Forms/TESObjectARMO.h>
 
+#include <ModCompat/BehaviorVar.h>
+
 #ifdef SAVE_STUFF
 
 #include <Games/Skyrim/SaveLoad.h>
@@ -542,18 +544,8 @@ bool Actor::IsDead() const noexcept
 
 bool Actor::IsDragon() const noexcept
 {
-    // TODO: if anyone has a better way of doing this, please do tell.
-    BSAnimationGraphManager* pManager = nullptr;
-    animationGraphHolder.GetBSAnimationGraph(&pManager);
-
-    if (!pManager)
-        return false;
-
-    const auto* pGraph = pManager->animationGraphs.Get(pManager->animationGraphIndex);
-    if (!pGraph)
-        return false;
-
-    return AnimationGraphDescriptor_BHR_Master::m_key == pManager->GetDescriptorKey();
+    const ActorExtension* pExtension = const_cast<Actor*>(this)->GetExtension();
+    return BehaviorVar::IsDragon(pExtension->GraphDescriptorHash);
 }
 
 void Actor::Kill() noexcept

Code/client/Games/Skyrim/PlayerCharacter.cpp

@@ -22,6 +22,8 @@
 
 #include <Forms/TESObjectCELL.h>
 
+#include <ModCompat/BehaviorVar.h>
+
 int32_t PlayerCharacter::LastUsedCombatSkill = -1;
 
 TP_THIS_FUNCTION(TPickUpObject, char, PlayerCharacter, TESObjectREFR* apObject, int32_t aCount, bool aUnk1, bool aUnk2);
@@ -162,7 +164,7 @@ void TP_MAKE_THISCALL(HookSetBeastForm, void, void* apUnk1, void* apUnk2, bool a
 {
     if (!aEntering)
     {
-        PlayerCharacter::Get()->GetExtension()->GraphDescriptorHash = AnimationGraphDescriptor_Master_Behavior::m_key;
+        PlayerCharacter::Get()->GetExtension()->GraphDescriptorHash = BehaviorVar::GetHumanoidHash();
         World::Get().GetRunner().Trigger(BeastFormChangeEvent());
     }
 

Code/client/ModCompat/BehaviorOrig.Fallout4

@@ -0,0 +1,37 @@
+#include "BehaviorVarsMap.h"
+#define MAGIC_ENUM_RANGE_MAX 400
+#include "magic_enum.hpp"
+
+namespace BehaviorOrig
+{
+template <typename V> void GenerateFromEnum(uint64_t aKey)
+{
+    using namespace magic_enum;
+    constexpr size_t count = enum_count<V>();
+    constexpr auto variables_values = enum_values<V>();
+    constexpr auto variables_names = enum_names<V>();
+    BehaviorVars sig;
+
+    sig.m_key = aKey;
+    for (size_t index = 0; index < count; index++)
+    {
+        TiltedPhoques::String name(variables_names[index]);
+        uint32_t value = enum_integer(variables_values[index]);
+
+        // Remove the leading 'k'
+        name = name.substr(1, name.size() - 1);
+
+        sig.m_nameMap[name] = value;
+        sig.m_valueMap[value] = name;
+    }
+
+    BehaviorVarsMap::getInstance().Register(sig);
+};
+
+#ifdef TP_SKYRIM
+#include "BehaviorOrig.Skyrim"
+#else
+#include "BehaviorOrig.Fallout4"
+#endif
+
+} // namespace BehaviorOrig

Code/client/ModCompat/BehaviorOrig.Skyrim

@@ -0,0 +1,107 @@
+param (
+    [string]$name = "Skyrim"
+)
+
+Set-PSDebug -Trace 1
+
+$output = "BehaviorOrig$name.obs"
+$path = "..\..\encoding\Structs\$name"
+$files = Get-ChildItem $path -Filter *_*.cpp 
+
+# Output everything to the target file.
+$(
+
+
+"// DO NOT EDIT, MACHINE-GENERATED CODE
+//
+// This is an admittedly dirty approach, but done with the best of intentions.
+//
+// The idea is to minimize intrusion into the STR Devs's base code, but we 
+// need some information that isn't exposed (the behavior variables' strings,
+// not just their enum values). This is needed so we can translate the numeric
+// original behavior vars back to their string names, so we can then look up the
+// NEW numeric value when behaviors are modified.
+// 
+// That would require a simple code change, but one needed so ubiquitously
+// it is intrusive. If the STR team gives permission for the change, this
+// can all be cleaned up. Unless and until they do, we make some edited copies
+// of the relevant behavior structs in their own namespace to provide the needed info.
+//
+// Would be so much easier if Nemesis simply added new vars to the end of the 
+// list, rather than randomly rearranging it. Rumor is Pandora does it correctly.
+//
+"
+
+
+$creatures = "`r`nvoid BehaviorOrigInit()`r`n{`r`n"
+
+foreach ($f in $files)
+{
+    $path = $f.FullName
+    $pathparts = Get-Item $path
+    $file = $pathparts.Name
+    $creature = $pathparts.BaseName
+    $creatures = $creatures + "    (void) $creature::getInstance();`r`n"
+
+    $extract = "`r`nclass $creature`r`n{`r`n  private:"
+    $extract 
+
+    # For the enum declaration, match non-greedy to stop at first close brace.
+    # Master_Behavior special case since they include more stuff.
+    # Also even more special for Fallout 3rd-person, since they inject namespaces
+    # we need a look-behind to get rid of it.
+    $pattern = "namespace TP"
+    $extract = [Regex]::Match((Get-Content $path -Raw), $pattern).Value
+    if ([string]::IsNullOrEmpty($extract)) {
+        $pattern = "(?s) *enum Variables(.*?)};"
+    } else {
+        $pattern = "(?s)(?<=namespace TP`r`n{`r`n) *enum Variables(.*?)};"
+    }
+
+    $extract = [Regex]::Match((Get-Content $path -Raw), $pattern).Value
+    $extract
+
+    $pattern = "key =.*;"
+    $extract = [Regex]::Match((Get-Content $path -Raw), $pattern).Value
+
+    # If no key was found in the .cpp file it is because for some creatures it is in .h file
+    if ([string]::IsNullOrEmpty($extract))
+    {
+        $hpath = Get-Item $path
+        $hpath = Join-Path $hpath.DirectoryName ($hpath.BaseName + ".h")
+        $extract = [Regex]::Match((Get-Content $hpath -Raw), $pattern).Value
+    }
+
+    $extract = '    static const uint64_t m_' + $extract + "`r`n"
+    $extract
+
+    # Constructor
+    $extract = "    // Constructor
+    $creature()
+    {
+        BehaviorOrig::GenerateFromEnum<Variables>(m_key);
+    }
+
+    // Singleton
+    $creature($creature const&) = delete;
+    void operator=($creature const&) = delete;
+
+  public:
+    static $creature& getInstance()
+    {
+        // The only instance. Guaranteed lazy initiated
+        // Guaranteed that it will be destroyed correctly
+        static $creature instance;
+
+        return instance;
+    }`r`n};"
+
+    $extract
+}
+
+$creatures = $creatures + "};`r`n"
+$creatures
+
+
+) *>&1 > $output
+# Close redirection