Improved custom animation hooks for readability

Rewrote HOOK_CAnimBlendAssocGroup_CopyAnimation in C++ for more clarity, it is shorter now, and thus more readable.

Moved HOOK_CAnimBlendAssoc_destructor to CMultiplayerSA_HookDestructors.cpp

Author: codenulls

Client/game_sa/CAnimBlendAssociationSA.h

@@ -35,6 +35,9 @@ class CAnimBlendAssociationSAInterface
     short                           sAnimID;                        // 44
     short                           sFlags;                         // or1 = started?, or64 = referenced?   // 46
     DWORD*                          pCallback;                      // 48
+    DWORD*                          pCallbackFunc;                  // 52
+    DWORD*                          pCallbackData;                  // 56
+                                                                    // Total: 60 bytes
 };
 
 class CAnimBlendAssociationSA : public CAnimBlendAssociation

Client/multiplayer_sa/CMultiplayerSA.h

@@ -21,8 +21,6 @@
 
 #include "CRemoteDataSA.h"
 
-typedef void(__thiscall* hCAnimBlendStaticAssociation_FreeSequenceArray)(CAnimBlendStaticAssociationSAInterface* pThis);
-
 class CRemoteDataSA;
 #define DEFAULT_NEAR_CLIP_DISTANCE  ( 0.3f )
 
@@ -42,6 +40,13 @@ enum eRadioStationID
     WCTR,
 };
 
+typedef void(__thiscall* hCAnimBlendStaticAssociation_FreeSequenceArray)(CAnimBlendStaticAssociationSAInterface* pThis);
+typedef void(__cdecl *  hUncompressAnimation) (CAnimBlendHierarchySAInterface * pAnimBlendHierarchyInterface);
+typedef void *(__cdecl *  hCAnimBlendAssociation_NewOperator) (size_t iSizeInBytes);
+
+typedef CAnimBlendAssociationSAInterface * (__thiscall *  hCAnimBlendAssociation_Constructor_staticAssocByReference)
+(CAnimBlendAssociationSAInterface * pThis, CAnimBlendStaticAssociationSAInterface& StaticAssociationByReference);
+
 class CMultiplayerSA : public CMultiplayer
 {
     friend class COffsetsMP;

Client/multiplayer_sa/CMultiplayerSA_CustomAnimations.cpp

@@ -5,33 +5,28 @@
 #include <../game_sa/CAnimBlendAssociationSA.h>
 #include <../game_sa/CAnimBlendAssocGroupSA.h>
 
-DWORD FUNC_NEW_OPERATOR = 0x082119A;
-DWORD FUNC_CAnimBlendAssociation_Constructor = 0x04CF080;
 DWORD FUNC_CAnimBlendAssociation__ReferenceAnimBlock = 0x4CEA50;
 DWORD FUNC_UncompressAnimation = 0x4D41C0;
 DWORD FUNC_CAnimBlendAssociation__CAnimBlendAssociation_hierarchy = 0x4CEFC0;
 
-DWORD RETURN_CAnimBlendAssoc_destructor = 0x4CECF6;
 DWORD RETURN_CAnimBlendAssocGroup_CopyAnimation_NORMALFLOW = 0x4CE151;
 DWORD RETURN_CAnimBlendAssocGroup_CopyAnimation = 0x4CE187;
 DWORD RETURN_CAnimBlendAssocGroup_CopyAnimation_ERROR = 0x4CE199;
 DWORD RETURN_CAnimManager_AddAnimation = 0x4D3AB1;
 DWORD RETURN_CAnimManager_AddAnimationAndSync = 0x4D3B41;
 DWORD RETURN_CAnimManager_BlendAnimation_Hierarchy = 0x4D4577;
 
-CAnimBlendAssocDestructorHandler* m_pCAnimBlendAssocDestructorHandler = nullptr;
+auto CAnimBlendStaticAssociation_FreeSequenceArray = (hCAnimBlendStaticAssociation_FreeSequenceArray)0x4ce9a0;
+auto UncompressAnimation = (hUncompressAnimation)0x4d41c0;
+auto CAnimBlendAssociation_NewOperator = (hCAnimBlendAssociation_NewOperator)0x082119A;
+auto CAnimBlendAssociation_Constructor_staticAssocByReference = (hCAnimBlendAssociation_Constructor_staticAssocByReference)0x4CF080;
+
 AddAnimationHandler*              m_pAddAnimationHandler = nullptr;
 AddAnimationAndSyncHandler*       m_pAddAnimationAndSyncHandler = nullptr;
 AssocGroupCopyAnimationHandler*   m_pAssocGroupCopyAnimationHandler = nullptr;
 BlendAnimationHierarchyHandler*   m_pBlendAnimationHierarchyHandler = nullptr;
 
 int _cdecl OnCAnimBlendAssocGroupCopyAnimation(AssocGroupId animGroup, int iAnimId);
-auto CAnimBlendStaticAssociation_FreeSequenceArray = (hCAnimBlendStaticAssociation_FreeSequenceArray)0x4ce9a0;
-
-void CMultiplayerSA::SetCAnimBlendAssocDestructorHandler(CAnimBlendAssocDestructorHandler* pHandler)
-{
-    m_pCAnimBlendAssocDestructorHandler = pHandler;
-}
 
 void CMultiplayerSA::SetAddAnimationHandler(AddAnimationHandler* pHandler)
 {
@@ -53,42 +48,22 @@ void CMultiplayerSA::SetBlendAnimationHierarchyHandler(BlendAnimationHierarchyHa
     m_pBlendAnimationHierarchyHandler = pHandler;
 }
 
-void __cdecl CAnimBlendAssoc_destructor(CAnimBlendAssociationSAInterface* pThis)
-{
-    if (m_pCAnimBlendAssocDestructorHandler)
-    {
-        m_pCAnimBlendAssocDestructorHandler(pThis);
-    }
-}
-
-void _declspec(naked) HOOK_CAnimBlendAssoc_destructor()
+CAnimBlendAssociationSAInterface * __cdecl CAnimBlendAssocGroup_CopyAnimation ( RpClump* pClump, CAnimBlendAssocGroupSAInterface* pAnimAssocGroupInterface, AnimationId animID )
 {
-    _asm
-    {
-        push    ecx
+	auto pAnimAssociationInterface = reinterpret_cast < CAnimBlendAssociationSAInterface * > (CAnimBlendAssociation_NewOperator ( sizeof (CAnimBlendAssociationSAInterface)));
+	if (pAnimAssociationInterface)
+	{
+		CAnimBlendStaticAssociationSAInterface staticAnimAssociationInterface;
 
-        push    ecx
-        call    CAnimBlendAssoc_destructor
-        add     esp, 0x4
+		m_pAssocGroupCopyAnimationHandler(&staticAnimAssociationInterface, pAnimAssociationInterface, pClump, pAnimAssocGroupInterface, animID);
 
-        pop     ecx
+		UncompressAnimation(staticAnimAssociationInterface.pAnimHeirarchy);
 
-        push    esi
-        mov     esi, ecx
-        mov     eax, [esi+10h]
-        jmp     RETURN_CAnimBlendAssoc_destructor
-    }
-}
+		CAnimBlendAssociation_Constructor_staticAssocByReference(pAnimAssociationInterface, staticAnimAssociationInterface);
 
-CAnimBlendStaticAssociationSAInterface* __cdecl AllocateStaticAssociationMemory(void)
-{
-    return new CAnimBlendStaticAssociationSAInterface;
-}
-
-void __cdecl DeleteStaticAssociation(CAnimBlendStaticAssociationSAInterface* pAnimStaticAssoc)
-{
-    CAnimBlendStaticAssociation_FreeSequenceArray(pAnimStaticAssoc);
-    delete pAnimStaticAssoc;
+		CAnimBlendStaticAssociation_FreeSequenceArray(&staticAnimAssociationInterface);
+	}
+	return pAnimAssociationInterface;
 }
 
 void _declspec(naked) HOOK_CAnimBlendAssocGroup_CopyAnimation()
@@ -104,88 +79,21 @@ void _declspec(naked) HOOK_CAnimBlendAssocGroup_CopyAnimation()
         {
             popad
 
-            push    ecx
-            push    ebp
-            mov     ebp, esp
-            sub esp, 4
-
-            push    eax
-            push    ecx
-            push    edi
-
-            // create CAnimBlendAssociation
-            push    3Ch
-            call    FUNC_NEW_OPERATOR
-            add     esp, 4
-
-            mov     [ebp-4], eax
-            push    eax
-
-            // Allocate memory for our new static association
-            call    AllocateStaticAssociationMemory
-            mov     edi, eax
-
-            // push the static association
-            push    edi
-            call    m_pAssocGroupCopyAnimationHandler //CAnimBlendAssocGroup_CopyAnimation
-            add     esp, 14h
+			push    esi
 
-            mov     ecx, [ebp-4]
+            push    eax // animID
+            push    ecx // pAnimAssocGroupInterface
+            push    edi // pClump
+			call    CAnimBlendAssocGroup_CopyAnimation
+			add     esp, 0Ch
 
-            add     esp, 4 // remove space for local var
-            mov     esp, ebp
-            pop     ebp
-
-            // save eax and ecx for later to check whether current animation is custom or not
-            // after calling FUNC_CAnimBlendAssociation_Constructor function
-            push    eax // isCustomAnimation ( bool )
-            push    ecx // pIFPAnimations
-
-            // get "this" from stack that we pushed first
-            mov     ecx, [esp+8]
-            mov     ecx, [ecx+4]
-            sub     eax, edx
-            push    esi
-
-            // copy the static association to esi
-            mov     esi, edi
-            test    esi, esi
-            jz      ERROR_CopyAnimation
-            mov     eax, [esi+10h]
-            push    eax
-            mov     eax, 04D41C0h
-            call    eax
-            add     esp, 4
-            mov     eax, [esp+4] // pAnimAssociation
-            mov     [esp+20h], eax
             test    eax, eax
-            mov     [esp+18h], 0
             jz      ERROR_CopyAnimation
-            push    esi
-            mov     ecx, eax
-            call    FUNC_CAnimBlendAssociation_Constructor
-            mov     edi, eax
-
-            // Delete our static association, since we no longer need it
-            push    esi
-            call    DeleteStaticAssociation
-            add     esp, 4
-
-            mov     ecx, [esp+4] // pIFPAnimations
-            mov     eax, [esp+8] // isCustomAnimation
 
-            // put CAnimBlendAssociation in eax
-            mov     eax, edi
-            add     esp, 0Ch
             jmp     RETURN_CAnimBlendAssocGroup_CopyAnimation
 
-            ERROR_CopyAnimation:
-            add     esp, 0Ch
-            // Delete our static association
-            push    edi
-            call    DeleteStaticAssociation
-            add     esp, 4
-            jmp    RETURN_CAnimBlendAssocGroup_CopyAnimation_ERROR
+			ERROR_CopyAnimation:
+			jmp		RETURN_CAnimBlendAssocGroup_CopyAnimation_ERROR
         }
     }
 

Client/multiplayer_sa/CMultiplayerSA_HookDestructors.cpp

@@ -13,6 +13,7 @@
 
 namespace
 {
+	CAnimBlendAssocDestructorHandler* m_pCAnimBlendAssocDestructorHandler = nullptr;
     GameObjectDestructHandler*     pGameObjectDestructHandler = NULL;
     GameVehicleDestructHandler*    pGameVehicleDestructHandler = NULL;
     GamePlayerDestructHandler*     pGamePlayerDestructHandler = NULL;
@@ -140,6 +141,34 @@ namespace
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 //
+void __cdecl CAnimBlendAssoc_destructor(CAnimBlendAssociationSAInterface* pThis)
+{
+	if (m_pCAnimBlendAssocDestructorHandler)
+	{
+		m_pCAnimBlendAssocDestructorHandler(pThis);
+	}
+}
+
+DWORD RETURN_CAnimBlendAssoc_destructor = 0x4CECF6;
+void _declspec(naked) HOOK_CAnimBlendAssoc_destructor()
+{
+	_asm
+	{
+		push    ecx
+
+		push    ecx
+		call    CAnimBlendAssoc_destructor
+		add     esp, 0x4
+
+		pop     ecx
+
+		push    esi
+		mov     esi, ecx
+		mov     eax, [esi + 10h]
+		jmp     RETURN_CAnimBlendAssoc_destructor
+	}
+}
+
 void _cdecl OnCObjectDestructor(DWORD calledFrom, CObjectSAInterface* pObject)
 {
     // Tell client to check for things going away
@@ -489,6 +518,11 @@ void _declspec(naked) HOOK_CStreamingRemoveModel()
 // Set handlers
 //
 //////////////////////////////////////////////////////////////////////////////////////////
+void CMultiplayerSA::SetCAnimBlendAssocDestructorHandler(CAnimBlendAssocDestructorHandler* pHandler)
+{
+	m_pCAnimBlendAssocDestructorHandler = pHandler;
+}
+
 void CMultiplayerSA::SetGameObjectDestructHandler(GameObjectDestructHandler* pHandler)
 {
     pGameObjectDestructHandler = pHandler;