Skip to content

fix PlayAnimMontage OnBlendOut #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ciberusps wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix PlayAnimMontage OnBlendOut #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab23854
fix PlayAnimMontage OnBlendOut
Ciberusps Nov 18, 2025
c3a65f2
Update UHLSTTask_PlayAnimMontage.cpp
Ciberusps Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 0 additions & 58 deletions Source/UHLStateTree/Private/Net/UHLMontageReplicatorObject.cpp
View file
Open in desktop

This file was deleted.

256 changes: 166 additions & 90 deletions Source/UHLStateTree/Private/Tasks/UHLSTTask_PlayAnimMontage.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

#include "Tasks/UHLSTTask_PlayAnimMontage.h"

#include "StateTreeAsyncExecutionContext.h"
#include "StateTreeExecutionContext.h"
#include "GameFramework/Character.h"
#include "Animation/AnimInstance.h"
#include "Net/UHLMontageReplicatorObject.h"
#include "StateTreeLinker.h"

#include UE_INLINE_GENERATED_CPP_BY_NAME(UHLSTTask_PlayAnimMontage)
Expand All @@ -21,42 +21,179 @@ USkeletalMeshComponent* FUHLSTTask_PlayAnimMontage::ResolveMesh(const FInstanceD
return InstanceData.Character ? InstanceData.Character->GetMesh() : nullptr;
}

bool FUHLSTTask_PlayAnimMontage::IsMontagePlaying(USkeletalMeshComponent* Mesh, const UAnimMontage* Montage) const
bool FUHLSTTask_PlayAnimMontage::PlayMontage(
FStateTreeExecutionContext& Context,
FInstanceDataType& InstanceData,
USkeletalMeshComponent* Mesh) const
{
if (!Mesh) return false;
bool bPlayedSuccessfully = false;
float MontageLength = -1.0f;
UAnimInstance* AnimInstance = Mesh->GetAnimInstance();
if (!AnimInstance) return false;
return AnimInstance->Montage_IsPlaying(Montage);
}

static void UHL_BindMontageDelegates(
FStateTreeExecutionContext& Context,
UAnimInstance* AnimInstance,
UAnimMontage* Montage,
FUHLSTTask_PlayAnimMontage::FInstanceDataType& InstanceData)
{
if (!AnimInstance || !Montage) return;
InstanceData.BoundAnimInstance = AnimInstance;
FOnMontageEnded Ended;
Ended.BindLambda([&InstanceData](UAnimMontage* InMontage, bool bInterrupted)
// If a starting section is provided, jump to it; otherwise use starting position
if (Mesh == InstanceData.Character->GetMesh())
{
InstanceData.bInterruptedTriggered |= bInterrupted;
InstanceData.bCompletedTriggered |= !bInterrupted;
});
AnimInstance->Montage_SetEndDelegate(Ended, Montage);
// Playing on Character's main mesh will replicate to simulated proxies when executed on the server
MontageLength = InstanceData.Character->PlayAnimMontage(InstanceData.AnimMontage, InstanceData.PlayRate);
if (InstanceData.StartingSection != NAME_None)
{
AnimInstance->Montage_JumpToSection(InstanceData.StartingSection, InstanceData.AnimMontage);
}
else if (InstanceData.StartingPosition > 0.0f)
{
AnimInstance->Montage_SetPosition(InstanceData.AnimMontage, InstanceData.StartingPosition);
}
}
else
{
MontageLength = AnimInstance->Montage_Play(InstanceData.AnimMontage, InstanceData.PlayRate, EMontagePlayReturnType::MontageLength, InstanceData.StartingSection != NAME_None ? 0.0f : InstanceData.StartingPosition, true);
if (InstanceData.StartingSection != NAME_None)
{
AnimInstance->Montage_JumpToSection(InstanceData.StartingSection, InstanceData.AnimMontage);
}
}

const FStateTreeWeakExecutionContext WeakContext = Context.MakeWeakExecutionContext();

FOnMontageBlendingOutStarted BlendOut;
BlendOut.BindLambda([&InstanceData](UAnimMontage* InMontage, bool bInterrupted)
Mesh->GetWorld()->GetTimerManager().SetTimerForNextTick([WeakContext, AnimInstance]()
{
InstanceData.bBlendOutTriggered = true;
InstanceData.bInterruptedTriggered |= bInterrupted;
if (!AnimInstance)
{
return;
}

FStateTreeStrongExecutionContext StrongContext = WeakContext.MakeStrongExecutionContext();
if (!StrongContext.IsValid())
{
return;
}

FUHLSTTask_PlayAnimMontage::FInstanceDataType* InstanceDataPtr = StrongContext.GetInstanceDataPtr<FUHLSTTask_PlayAnimMontage::FInstanceDataType>();
if (!InstanceDataPtr)
{
return;
}

const bool bBindBlendOut = InstanceDataPtr->bFinishTaskOnBlendOut;
const bool bBindEnd = InstanceDataPtr->bFinishTaskOnCompleted || InstanceDataPtr->bFinishTaskOnInterrupted;
if (!bBindBlendOut && !bBindEnd)
{
return;
}

InstanceDataPtr->BoundAnimInstance = AnimInstance;

if (bBindBlendOut)
{
FOnMontageBlendingOutStarted BlendOutDelegate;
BlendOutDelegate.BindLambda(
[WeakContext](UAnimMontage* Montage, bool bInterrupted)
{
FStateTreeStrongExecutionContext StrongContext = WeakContext.MakeStrongExecutionContext();
if (!StrongContext.IsValid())
{
return;
}

FUHLSTTask_PlayAnimMontage::FInstanceDataType* InstanceDataPtr = StrongContext.GetInstanceDataPtr<FUHLSTTask_PlayAnimMontage::FInstanceDataType>();
if (!InstanceDataPtr)
{
return;
}

if (Montage != InstanceDataPtr->AnimMontage)
{
return;
}

if (InstanceDataPtr->bBlendOutTriggered)
{
return;
}

InstanceDataPtr->bBlendOutTriggered = true;
InstanceDataPtr->bInterruptedTriggered |= bInterrupted;
InstanceDataPtr->bCompletedTriggered |= !bInterrupted;

const bool bShouldSucceed = InstanceDataPtr->bSucceededResult && !bInterrupted;
const EStateTreeFinishTaskType FinishType = bShouldSucceed ? EStateTreeFinishTaskType::Succeeded : EStateTreeFinishTaskType::Failed;
WeakContext.FinishTask(FinishType);
}
);

AnimInstance->Montage_SetBlendingOutDelegate(BlendOutDelegate, InstanceDataPtr->AnimMontage);
}

if (bBindEnd)
{
FOnMontageEnded EndDelegate;
EndDelegate.BindLambda(
[WeakContext](UAnimMontage* Montage, bool bInterrupted)
{
FStateTreeStrongExecutionContext StrongContext = WeakContext.MakeStrongExecutionContext();
if (!StrongContext.IsValid())
{
return;
}

FUHLSTTask_PlayAnimMontage::FInstanceDataType* InstanceDataPtr = StrongContext.GetInstanceDataPtr<FUHLSTTask_PlayAnimMontage::FInstanceDataType>();
if (!InstanceDataPtr)
{
return;
}

if (Montage != InstanceDataPtr->AnimMontage)
{
return;
}

if (InstanceDataPtr->bBlendOutTriggered)
{
return;
}

if (bInterrupted)
{
if (!InstanceDataPtr->bFinishTaskOnInterrupted || InstanceDataPtr->bInterruptedTriggered)
{
return;
}

InstanceDataPtr->bInterruptedTriggered = true;

const bool bShouldSucceed = InstanceDataPtr->bSucceededResult && !bInterrupted;
const EStateTreeFinishTaskType FinishType = bShouldSucceed ? EStateTreeFinishTaskType::Succeeded : EStateTreeFinishTaskType::Failed;
WeakContext.FinishTask(FinishType);
return;
}

if (!InstanceDataPtr->bFinishTaskOnCompleted || InstanceDataPtr->bCompletedTriggered)
{
return;
}

InstanceDataPtr->bCompletedTriggered = true;

const bool bShouldSucceed = InstanceDataPtr->bSucceededResult;
const EStateTreeFinishTaskType FinishType = bShouldSucceed ? EStateTreeFinishTaskType::Succeeded : EStateTreeFinishTaskType::Failed;
WeakContext.FinishTask(FinishType);
}
);

AnimInstance->Montage_SetEndDelegate(EndDelegate, InstanceDataPtr->AnimMontage);
}
});
AnimInstance->Montage_SetBlendingOutDelegate(BlendOut, Montage);

bPlayedSuccessfully = (MontageLength > 0.f);
return bPlayedSuccessfully;
}

EStateTreeRunStatus FUHLSTTask_PlayAnimMontage::EnterState(FStateTreeExecutionContext& Context, const FStateTreeTransitionResult& Transition) const
{
FInstanceDataType& InstanceData = Context.GetInstanceData(*this);
InstanceData.bCompletedTriggered = false;
InstanceData.bInterruptedTriggered = false;
InstanceData.bBlendOutTriggered = false;
InstanceData.BoundAnimInstance.Reset();
if (!InstanceData.Character || !InstanceData.AnimMontage)
{
return EStateTreeRunStatus::Failed;
Expand All @@ -83,76 +220,15 @@ EStateTreeRunStatus FUHLSTTask_PlayAnimMontage::EnterState(FStateTreeExecutionCo
}
else
{
if (InstanceData.Character->HasAuthority())
{
UUHLMontageReplicatorObject* Replicator = NewObject<UUHLMontageReplicatorObject>(InstanceData.Character);
Replicator->Initialize(InstanceData.Character);
InstanceData.Character->AddReplicatedSubObject(Replicator);
Replicator->Multicast_StopAllMontages(Mesh, 0.25f);
}
else
{
AnimInstance->StopAllMontages(0.25f);
}
AnimInstance->StopAllMontages(0.25f);
}
}

// If a starting section is provided, jump to it; otherwise use starting position
if (Mesh == InstanceData.Character->GetMesh())
{
// Playing on Character's main mesh will replicate to simulated proxies when executed on the server
InstanceData.Character->PlayAnimMontage(InstanceData.AnimMontage, InstanceData.PlayRate);
if (InstanceData.StartingSection != NAME_None)
{
AnimInstance->Montage_JumpToSection(InstanceData.StartingSection, InstanceData.AnimMontage);
}
else if (InstanceData.StartingPosition > 0.0f)
{
AnimInstance->Montage_SetPosition(InstanceData.AnimMontage, InstanceData.StartingPosition);
}
}
else
{
if (InstanceData.Character->HasAuthority())
{
UUHLMontageReplicatorObject* Replicator = NewObject<UUHLMontageReplicatorObject>(InstanceData.Character);
Replicator->Initialize(InstanceData.Character);
InstanceData.Character->AddReplicatedSubObject(Replicator);
Replicator->Multicast_PlayMontage(
Mesh,
InstanceData.AnimMontage,
InstanceData.PlayRate,
InstanceData.StartingPosition,
InstanceData.StartingSection);
}
else
{
AnimInstance->Montage_Play(InstanceData.AnimMontage, InstanceData.PlayRate, EMontagePlayReturnType::MontageLength, InstanceData.StartingSection != NAME_None ? 0.0f : InstanceData.StartingPosition, true);
if (InstanceData.StartingSection != NAME_None)
{
AnimInstance->Montage_JumpToSection(InstanceData.StartingSection, InstanceData.AnimMontage);
}
}
}

// Bind delegates for completion/interrupt/BlendOut and request transition directly
UHL_BindMontageDelegates(Context, AnimInstance, InstanceData.AnimMontage, InstanceData);

bool bSuccessPlayMontage = PlayMontage(Context, InstanceData, Mesh);

return EStateTreeRunStatus::Running;
}

EStateTreeRunStatus FUHLSTTask_PlayAnimMontage::Tick(FStateTreeExecutionContext& Context, const float DeltaTime) const
{
FInstanceDataType& InstanceData = Context.GetInstanceData(*this);
if ((InstanceData.bFinishTaskOnCompleted && InstanceData.bCompletedTriggered)
|| (InstanceData.bFinishTaskOnInterrupted && InstanceData.bInterruptedTriggered)
|| (InstanceData.bFinishTaskOnBlendOut && InstanceData.bBlendOutTriggered))
{
return InstanceData.bSucceededResult ? EStateTreeRunStatus::Succeeded : EStateTreeRunStatus::Failed;
}
return FStateTreeTaskCommonBase::Tick(Context, DeltaTime);
}

void FUHLSTTask_PlayAnimMontage::ExitState(FStateTreeExecutionContext& Context, const FStateTreeTransitionResult& Transition) const
{
FInstanceDataType& InstanceData = Context.GetInstanceData(*this);
Expand Down
43 changes: 0 additions & 43 deletions Source/UHLStateTree/Public/Net/UHLMontageReplicatorObject.h
View file
Open in desktop

This file was deleted.

Loading