UAbilityTask_PlayMontageAndWait

Ability task to simply play a montage.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGameplayTask

UAbilityTask

UAbilityTask_PlayMontageAndWait

References

Module	GameplayAbilities
Header	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/Abilities/Tasks/AbilityTask_PlayMontageAndWait.h
Include	#include "Abilities/Tasks/AbilityTask_PlayMontageAndWait.h"

Syntax

UCLASS()
class UAbilityTask_PlayMontageAndWait : public UAbilityTask

Remarks

Ability task to simply play a montage. Many games will want to make a modified version of this task that looks for game-specific events

Variables

	Name	Description
float	AnimRootMotionTranslationScale
FOnMontageBlend...	BlendingOutDelegate
	BlueprintInternalUseOnly
bool	bStopWhenAbilityEnds
	DefaultToSelf
	HidePin	Start playing an animation montage on the avatar actor and wait for it to finish If StopWhenAbilityEnds is true, this montage will be aborted if the ability ends normally.
FDelegateHandle	InterruptedHandle
FOnMontageEnded	MontageEndedDelegate
UAnimMontage &#...	MontageToPlay
FMontageWaitSim...	OnBlendOut
FMontageWaitSim...	OnCancelled
FMontageWaitSim...	OnCompleted
FMontageWaitSim...	OnInterrupted
float	Rate
FName	StartSection
float	StartTimeSeconds

Constructors

	Name	Description
	UAbilityTask_PlayMontageAndWait ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	OnMontageBlendingOut ( UAnimMontage* Montage, bool bInterrupted )
void	OnMontageEnded ( UAnimMontage* Montage, bool bInterrupted )
void	OnMontageInterrupted()
bool	StopPlayingMontage()	Checks if the ability is playing a montage and stops that montage, returns true if a montage was stopped, false if not.

Overridden from UGameplayTask

	Name	Description
void	Activate()	Called to trigger the actual task once the delegates have been set up Note that the default implementation does nothing and you don't have to call it
void	ExternalCancel()	Called when the ability is asked to cancel from an outside node.
FString	GetDebugString()	Return debug string describing task
void	OnDestroy ( bool bInOwnerFinished )	End and CleanUp the task - may be called by the task itself or by the task owner if the owner is ending.