UAbilityTask_PlayMontageAndWait

Ability task to simply play a montage.

Windows
MacOS
Linux

Inheritance Hierarchy

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](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
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

Public variable

 

BlueprintInternalUseOnly

Public variable

 

DefaultToSelf

Public variable

 

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.

Public variable UProperty BlueprintAssignable

FMontageWaitSim ...

 

OnBlendOut

Public variable UProperty BlueprintAssignable

FMontageWaitSim ...

 

OnCancelled

Public variable UProperty BlueprintAssignable

FMontageWaitSim ...

 

OnCompleted

Public variable UProperty BlueprintAssignable

FMontageWaitSim ...

 

OnInterrupted

Constructors

Name Description

Public function

UAbilityTask_PlayMontageAndWait

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function UFunction

void

 

OnMontageBlendingOut

(
    UAnimMontage * Montage,
    bool bInterrupted
)

Public function UFunction

void

 

OnMontageEnded

(
    UAnimMontage * Montage,
    bool bInterrupted
)

Public function UFunction

void

 

OnMontageInterrupted()

Overridden from UGameplayTask

Name Description

Public function Virtual

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

Public function Virtual

void

 

ExternalCancel()

Called when the ability is asked to cancel from an outside node.

Public function Virtual Const

FString

 

GetDebugString()

Return debug string describing task

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback