Fix 462: Player crouched state resets after setPedAnimation() was called

Added a new parameter to setPedAnimation. Setting the parameter to true will restore the crouch task when the animation ends If ped was ducked before playing animation.

Author: codenulls

Client/game_sa/CPedIntelligenceSA.cpp

@@ -94,3 +94,9 @@ CTaskSimpleUseGunSAInterface* CPedIntelligenceSA::GetTaskUseGun()
 
     return pTaskUseGun;
 }
+
+CTaskSAInterface* CPedIntelligenceSA::SetTaskDuckSecondary(unsigned short nLengthOfDuck)
+{
+    auto SetTaskDuckSecondary = (CTaskSAInterface * (__thiscall*)(CPedIntelligenceSAInterface*, unsigned short))0x601230;
+    return SetTaskDuckSecondary(internalInterface, nLengthOfDuck);
+}

Client/game_sa/CPedIntelligenceSA.h

@@ -69,4 +69,5 @@ class CPedIntelligenceSA : public CPedIntelligence
     CVehicleScanner*              GetVehicleScanner();
     bool                          TestForStealthKill(CPed* pPed, bool bUnk);
     CTaskSimpleUseGunSAInterface* GetTaskUseGun();
+    CTaskSAInterface*             SetTaskDuckSecondary(unsigned short nLengthOfDuck);
 };

Client/mods/deathmatch/logic/CClientGame.cpp

@@ -276,6 +276,7 @@ CClientGame::CClientGame(bool bLocalPlay)
     g_pMultiplayer->SetGamePlayerDestructHandler(CClientGame::StaticGamePlayerDestructHandler);
     g_pMultiplayer->SetGameProjectileDestructHandler(CClientGame::StaticGameProjectileDestructHandler);
     g_pMultiplayer->SetGameModelRemoveHandler(CClientGame::StaticGameModelRemoveHandler);
+    g_pMultiplayer->SetGameRunNamedAnimDestructorHandler(CClientGame::StaticGameRunNamedAnimDestructorHandler);
     g_pMultiplayer->SetGameEntityRenderHandler(CClientGame::StaticGameEntityRenderHandler);
     g_pMultiplayer->SetFxSystemDestructionHandler(CClientGame::StaticFxSystemDestructionHandler);
     g_pMultiplayer->SetDrivebyAnimationHandler(CClientGame::StaticDrivebyAnimationHandler);
@@ -3758,6 +3759,11 @@ void CClientGame::StaticGameModelRemoveHandler(ushort usModelId)
     g_pClientGame->GameModelRemoveHandler(usModelId);
 }
 
+void CClientGame::StaticGameRunNamedAnimDestructorHandler(class CTaskSimpleRunNamedAnimSAInterface* pTask)
+{
+    g_pClientGame->GameRunNamedAnimDestructorHandler(pTask);
+}
+
 void CClientGame::StaticGameEntityRenderHandler(CEntitySAInterface* pGameEntity)
 {
     if (pGameEntity)
@@ -4773,7 +4779,7 @@ bool CClientGame::ObjectDamageHandler(CObjectSAInterface* pObjectInterface, floa
             {
                 return true;
             }
-            CLuaArguments  Arguments;
+            CLuaArguments Arguments;
             Arguments.PushNumber(fLoss);
 
             CClientEntity* pClientAttacker = pPools->GetClientEntity((DWORD*)pAttackerInterface);
@@ -4919,6 +4925,20 @@ void CClientGame::GameModelRemoveHandler(ushort usModelId)
     // m_pGameEntityXRefManager->OnGameModelRemove(usModelId);
 }
 
+void CClientGame::GameRunNamedAnimDestructorHandler(class CTaskSimpleRunNamedAnimSAInterface* pTask)
+{
+    auto it = m_mapOfRunNamedAnimTasks.find(pTask);
+    if (it != m_mapOfRunNamedAnimTasks.end())
+    {
+        CClientPed* pPed = it->second;
+        if (pPed && pPed->IsCrouchToBeSetOnAnimEnd())
+        {
+            pPed->GetGamePlayer()->GetPedIntelligence()->SetTaskDuckSecondary(0);
+        }
+        m_mapOfRunNamedAnimTasks.erase(pTask);
+    }
+}
+
 void CClientGame::TaskSimpleBeHitHandler(CPedSAInterface* pPedAttacker, ePedPieceTypes hitBodyPart, int hitBodySide, int weaponId)
 {
     bool bOldBehaviour = !IsGlitchEnabled(GLITCH_HITANIM);
@@ -6930,6 +6950,11 @@ void CClientGame::RemoveAnimationAssociationFromMap(CAnimBlendAssociationSAInter
     m_mapOfCustomAnimationAssociations.erase(pAnimAssociation);
 }
 
+void CClientGame::InsertRunNamedAnimTaskToMap(class CTaskSimpleRunNamedAnimSAInterface* pTask, CClientPed* pPed)
+{
+    m_mapOfRunNamedAnimTasks[pTask] = pPed;
+}
+
 void CClientGame::PedStepHandler(CPedSAInterface* pPedSA, bool bFoot)
 {
     CLuaArguments Arguments;

Client/mods/deathmatch/logic/CClientGame.h

@@ -73,6 +73,7 @@ class CClientGame
 {
     friend class CPacketHandler;
     typedef std::map<CAnimBlendAssociationSAInterface*, std::shared_ptr<CIFPAnimations> > AnimAssociations_type;
+    typedef std::map<class CTaskSimpleRunNamedAnimSAInterface*, CClientPed*>              RunNamedAnimTask_type;
 
 public:
     enum eStatus
@@ -520,6 +521,7 @@ class CClientGame
     static void StaticGamePlayerDestructHandler(CEntitySAInterface* pPlayer);
     static void StaticGameProjectileDestructHandler(CEntitySAInterface* pProjectile);
     static void StaticGameModelRemoveHandler(ushort usModelId);
+    static void StaticGameRunNamedAnimDestructorHandler(class CTaskSimpleRunNamedAnimSAInterface* pTask);
     static bool StaticWorldSoundHandler(const SWorldSoundEvent& event);
     static void StaticGameEntityRenderHandler(CEntitySAInterface* pEntity);
     static void StaticTaskSimpleBeHitHandler(CPedSAInterface* pPedAttacker, ePedPieceTypes hitBodyPart, int hitBodySide, int weaponId);
@@ -562,6 +564,7 @@ class CClientGame
     void        GamePlayerDestructHandler(CEntitySAInterface* pPlayer);
     void        GameProjectileDestructHandler(CEntitySAInterface* pProjectile);
     void        GameModelRemoveHandler(ushort usModelId);
+    void        GameRunNamedAnimDestructorHandler(class CTaskSimpleRunNamedAnimSAInterface* pTask);
     bool        WorldSoundHandler(const SWorldSoundEvent& event);
     void        TaskSimpleBeHitHandler(CPedSAInterface* pPedAttacker, ePedPieceTypes hitBodyPart, int hitBodySide, int weaponId);
     AnimationId DrivebyAnimationHandler(AnimationId animGroup, AssocGroupId animId);
@@ -615,6 +618,7 @@ class CClientGame
 
     void InsertAnimationAssociationToMap(CAnimBlendAssociationSAInterface* pAnimAssociation, const std::shared_ptr<CIFPAnimations>& pIFPAnimations);
     void RemoveAnimationAssociationFromMap(CAnimBlendAssociationSAInterface* pAnimAssociation);
+    void InsertRunNamedAnimTaskToMap(class CTaskSimpleRunNamedAnimSAInterface* pTask, CClientPed* pPed);
 
     void PedStepHandler(CPedSAInterface* pPed, bool bFoot);
     void VehicleWeaponHitHandler(SVehicleWeaponHitEvent& event);
@@ -834,6 +838,8 @@ class CClientGame
     std::map<unsigned int, std::shared_ptr<CClientIFP> > m_mapOfIfpPointers;
     std::set<CClientPed*>                                m_setOfPedPointers;
     AnimAssociations_type                                m_mapOfCustomAnimationAssociations;
+    // Key is the task and value is the CClientPed*
+    RunNamedAnimTask_type m_mapOfRunNamedAnimTasks;
 };
 
 extern CClientGame* g_pClientGame;

Client/mods/deathmatch/logic/CClientPed.cpp

@@ -90,6 +90,7 @@ void CClientPed::Init(CClientManager* pManager, unsigned long ulModelID, bool bI
 
     m_pRequester = pManager->GetModelRequestManager();
 
+    m_bCrouchToBeSetOnAnimEnd = false;
     m_bisNextAnimationCustom = false;
     m_bisCurrentAnimationCustom = false;
     m_strCustomIFPBlockName = "Default";
@@ -5094,7 +5095,7 @@ CClientEntity* CClientPed::GetContactEntity()
         if (pEntity)
         {
             CEntitySAInterface* pInterface = pEntity->GetInterface();
-            eEntityType entityType = pInterface ? pEntity->GetEntityType() : ENTITY_TYPE_NOTHING;
+            eEntityType         entityType = pInterface ? pEntity->GetEntityType() : ENTITY_TYPE_NOTHING;
             if (entityType == ENTITY_TYPE_VEHICLE || entityType == ENTITY_TYPE_OBJECT)
             {
                 return pPools->GetClientEntity((DWORD*)pInterface);
@@ -5666,8 +5667,8 @@ void CClientPed::RunAnimation(AssocGroupId animGroup, AnimationId animID)
     }
 }
 
-void CClientPed::RunNamedAnimation(std::unique_ptr<CAnimBlock>& pBlock, const char* szAnimName, int iTime, int iBlend, bool bLoop, bool bUpdatePosition, bool bInterruptable,
-                                   bool bFreezeLastFrame, bool bRunInSequence, bool bOffsetPed, bool bHoldLastFrame)
+void CClientPed::RunNamedAnimation(std::unique_ptr<CAnimBlock>& pBlock, const char* szAnimName, int iTime, int iBlend, bool bLoop, bool bUpdatePosition,
+                                   bool bInterruptable, bool bFreezeLastFrame, bool bRunInSequence, bool bOffsetPed, bool bHoldLastFrame)
 {
     /* lil_Toady: this seems to break things
     // Kill any current animation that might be running
@@ -5725,6 +5726,7 @@ void CClientPed::RunNamedAnimation(std::unique_ptr<CAnimBlock>& pBlock, const ch
             if (pTask)
             {
                 pTask->SetAsPedTask(m_pPlayerPed, TASK_PRIORITY_PRIMARY);
+                g_pClientGame->InsertRunNamedAnimTaskToMap(reinterpret_cast<CTaskSimpleRunNamedAnimSAInterface*>(pTask->GetInterface()), this);
             }
         }
         else
@@ -5775,16 +5777,16 @@ void CClientPed::KillAnimation()
 }
 
 std::unique_ptr<CAnimBlock> CClientPed::GetAnimationBlock()
-{ 
+{
     if (m_pAnimationBlock)
     {
         return g_pGame->GetAnimManager()->GetAnimBlock(m_pAnimationBlock->GetInterface());
     }
-    return nullptr; 
+    return nullptr;
 }
 const char* CClientPed::GetAnimationName()
-{ 
-    return m_strAnimationName; 
+{
+    return m_strAnimationName;
 }
 
 void CClientPed::PostWeaponFire()
@@ -6177,21 +6179,21 @@ std::unique_ptr<CAnimBlendAssociation> CClientPed::GetAnimAssociation(CAnimBlend
         return nullptr;
     }
 
-    auto pReplacedAnimation = GetReplacedAnimation(pOriginalHierarchyInterface);
+    auto                            pReplacedAnimation = GetReplacedAnimation(pOriginalHierarchyInterface);
     CAnimBlendHierarchySAInterface* pReplacedInterface = nullptr;
     if (pReplacedAnimation != nullptr)
     {
         pReplacedInterface = pReplacedAnimation->pAnimationHierarchy;
     }
 
     CAnimManager* pAnimationManager = g_pGame->GetAnimManager();
-    auto pAnimAssociation = pAnimationManager->RpAnimBlendClumpGetFirstAssociation(pClump);
+    auto          pAnimAssociation = pAnimationManager->RpAnimBlendClumpGetFirstAssociation(pClump);
     while (pAnimAssociation)
     {
         auto pAnimNextAssociation = pAnimationManager->RpAnimBlendGetNextAssociation(pAnimAssociation);
         auto pAnimHierarchy = pAnimAssociation->GetAnimHierarchy();
         if (pAnimHierarchy)
-        {  
+        {
             CAnimBlendHierarchySAInterface* pInterface = pAnimHierarchy->GetInterface();
             if (pInterface == pOriginalHierarchyInterface)
             {
@@ -6205,7 +6207,6 @@ std::unique_ptr<CAnimBlendAssociation> CClientPed::GetAnimAssociation(CAnimBlend
         pAnimAssociation = std::move(pAnimNextAssociation);
     }
     return nullptr;
-
 }
 
 CSphere CClientPed::GetWorldBoundingSphere()

Client/mods/deathmatch/logic/CClientPed.h

@@ -418,12 +418,12 @@ class CClientPed : public CClientStreamElement, public CAntiCheatModule
     bool IsDoingGangDriveby();
     void SetDoingGangDriveby(bool bDriveby);
 
-    bool        IsRunningAnimation();
-    void        RunAnimation(AssocGroupId animGroup, AnimationId animID);
-    void        RunNamedAnimation(std::unique_ptr<CAnimBlock>& pBlock, const char* szAnimName, int iTime = -1, int iBlend = 250, bool bLoop = true, bool bUpdatePosition = true,
-                                  bool bInterruptable = false, bool bFreezeLastFrame = true, bool bRunInSequence = false, bool bOffsetPed = false,
-                                  bool bHoldLastFrame = false);
-    void                        KillAnimation();
+    bool IsRunningAnimation();
+    void RunAnimation(AssocGroupId animGroup, AnimationId animID);
+    void RunNamedAnimation(std::unique_ptr<CAnimBlock>& pBlock, const char* szAnimName, int iTime = -1, int iBlend = 250, bool bLoop = true,
+                           bool bUpdatePosition = true, bool bInterruptable = false, bool bFreezeLastFrame = true, bool bRunInSequence = false,
+                           bool bOffsetPed = false, bool bHoldLastFrame = false);
+    void KillAnimation();
     std::unique_ptr<CAnimBlock> GetAnimationBlock();
     const char*                 GetAnimationName();
 
@@ -541,6 +541,8 @@ class CClientPed : public CClientStreamElement, public CAntiCheatModule
     void _GetIntoVehicle(CClientVehicle* pVehicle, unsigned int uiSeat, unsigned char ucDoor);
 
     void Respawn(CVector* pvecPosition = NULL, bool bRestoreState = false, bool bCameraCut = false);
+    void SetCrouchToBeSetOnAnimEnd(bool bSetOnEnd) { m_bCrouchToBeSetOnAnimEnd = bSetOnEnd; }
+    bool IsCrouchToBeSetOnAnimEnd() { return m_bCrouchToBeSetOnAnimEnd; }
 
     void NotifyCreate();
     void NotifyDestroy();
@@ -709,4 +711,5 @@ class CClientPed : public CClientStreamElement, public CAntiCheatModule
 
     // Key: Internal GTA animation, Value: Custom Animation
     ReplacedAnim_type m_mapOfReplacedAnimations;
+    bool              m_bCrouchToBeSetOnAnimEnd;
 };

Client/mods/deathmatch/logic/luadefs/CLuaPedDefs.cpp

@@ -1990,6 +1990,7 @@ int CLuaPedDefs::SetPedAnimation(lua_State* luaVM)
     bool           bUpdatePosition = true;
     bool           bInterruptable = true;
     bool           bFreezeLastFrame = true;
+    bool           bCrouchToBeSetOnAnimEnd = false;
 
     CScriptArgReader argStream(luaVM);
     argStream.ReadUserData(pEntity);
@@ -2006,13 +2007,21 @@ int CLuaPedDefs::SetPedAnimation(lua_State* luaVM)
     argStream.ReadBool(bInterruptable, true);
     argStream.ReadBool(bFreezeLastFrame, true);
     argStream.ReadNumber(iBlend, 250);
+    argStream.ReadBool(bCrouchToBeSetOnAnimEnd, false);
 
     if (!argStream.HasErrors())
     {
         if (CStaticFunctionDefinitions::SetPedAnimation(*pEntity, strBlockName == "" ? NULL : strBlockName.c_str(),
                                                         strAnimName == "" ? NULL : strAnimName.c_str(), iTime, iBlend, bLoop, bUpdatePosition, bInterruptable,
                                                         bFreezeLastFrame))
         {
+            CClientPed* pPed = static_cast<CClientPed*>(pEntity);
+            if (!pPed->IsDucked())
+            {
+                bCrouchToBeSetOnAnimEnd = false;
+            }
+
+            pPed->SetCrouchToBeSetOnAnimEnd(bCrouchToBeSetOnAnimEnd);
             lua_pushboolean(luaVM, true);
             return 1;
         }

Client/mods/deathmatch/logic/rpc/CPedRPCs.cpp

@@ -252,23 +252,29 @@ void CPedRPCs::SetPedAnimation(CClientEntity* pSource, NetBitStreamInterface& bi
             if (!blockName.empty())
             {
                 std::string animName;
-                int iTime;
-                int iBlend = 250;
-                bool bLoop, bUpdatePosition, bInterruptable, bFreezeLastFrame;
-
-                if (bitStream.ReadString<unsigned char>(animName) &&
-                    bitStream.Read(iTime) &&
-                    bitStream.ReadBit(bLoop) &&
-                    bitStream.ReadBit(bUpdatePosition) &&
-                    bitStream.ReadBit(bInterruptable) &&
-                    bitStream.ReadBit(bFreezeLastFrame))
-                 {
+                int         iTime;
+                int         iBlend = 250;
+                bool        bLoop, bUpdatePosition, bInterruptable, bFreezeLastFrame, bCrouchToBeSetOnAnimEnd;
+
+                if (bitStream.ReadString<unsigned char>(animName) && bitStream.Read(iTime) && bitStream.ReadBit(bLoop) && bitStream.ReadBit(bUpdatePosition) &&
+                    bitStream.ReadBit(bInterruptable) && bitStream.ReadBit(bFreezeLastFrame))
+                {
                     if (bitStream.Version() >= 0x065)
+                    {
                         bitStream.Read(iBlend);
+                        bitStream.ReadBit(bCrouchToBeSetOnAnimEnd);
+                        if (!pPed->IsDucked())
+                        {
+                            bCrouchToBeSetOnAnimEnd = false;
+                        }
+                    }
 
                     std::unique_ptr<CAnimBlock> pBlock = g_pGame->GetAnimManager()->GetAnimationBlock(blockName.c_str());
                     if (pBlock)
+                    {
                         pPed->RunNamedAnimation(pBlock, animName.c_str(), iTime, iBlend, bLoop, bUpdatePosition, bInterruptable, bFreezeLastFrame);
+                        pPed->SetCrouchToBeSetOnAnimEnd(bCrouchToBeSetOnAnimEnd);
+                    }
                 }
             }
             else
@@ -283,7 +289,7 @@ void CPedRPCs::SetPedAnimationProgress(CClientEntity* pSource, NetBitStreamInter
 {
     // Read out the player and vehicle id
     std::string animName;
-    float fProgress;
+    float       fProgress;
 
     if (bitStream.ReadString<unsigned char>(animName))
     {
@@ -313,7 +319,7 @@ void CPedRPCs::SetPedAnimationProgress(CClientEntity* pSource, NetBitStreamInter
 void CPedRPCs::SetPedAnimationSpeed(CClientEntity* pSource, NetBitStreamInterface& bitStream)
 {
     std::string animName;
-    float fSpeed;
+    float       fSpeed;
 
     if (bitStream.ReadString<unsigned char>(animName))
     {

Client/multiplayer_sa/CMultiplayerSA.h

@@ -130,6 +130,7 @@ class CMultiplayerSA : public CMultiplayer
     void SetGamePlayerDestructHandler(GamePlayerDestructHandler* pHandler);
     void SetGameProjectileDestructHandler(GameProjectileDestructHandler* pHandler);
     void SetGameModelRemoveHandler(GameModelRemoveHandler* pHandler);
+    void SetGameRunNamedAnimDestructorHandler(GameRunNamedAnimDestructorHandler* pHandler);
     void SetGameEntityRenderHandler(GameEntityRenderHandler* pHandler);
     void SetFxSystemDestructionHandler(FxSystemDestructionHandler* pHandler);
     void SetDrivebyAnimationHandler(DrivebyAnimationHandler* pHandler);