Navigation
API > API/Plugins > API/Plugins/GameplayAbilities
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
| Name | UAbilityTask_PlayMontageAndWait |
| Type | class |
| Header File | /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
| Include Path | #include "Abilities/Tasks/AbilityTask_PlayMontageAndWait.h" |
Syntax
UCLASS (MinimalAPI)
class UAbilityTask_PlayMontageAndWait : public UAbilityTask
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGameplayTask → UAbilityTask → UAbilityTask_PlayMontageAndWait
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BlueprintInternalUseOnly | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | |||
| DefaultToSelf | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | |||
| 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. | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | ||
| OnBlendedIn | FMontageWaitSimpleDelegate | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
|
|
| OnBlendOut | FMontageWaitSimpleDelegate | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
|
|
| OnCancelled | FMontageWaitSimpleDelegate | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
|
|
| OnCompleted | FMontageWaitSimpleDelegate | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
|
|
| OnInterrupted | FMontageWaitSimpleDelegate | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnGameplayAbilityCancelled() |
Callback function for when the owning Gameplay Ability is cancelled | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | |
void OnMontageBlendedIn
(
UAnimMontage* Montage |
Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | ||
void OnMontageBlendingOut
(
UAnimMontage* Montage, |
Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | ||
void OnMontageEnded
(
UAnimMontage* Montage, |
Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | ||
void OnMontageInterrupted() |
Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
Overridden from UGameplayTask
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Activate() |
Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | ||
virtual void ExternalCancel () |
Called when the ability is asked to cancel from an outside node. | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h | |
virtual FString GetDebugString() |
Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool StopPlayingMontage() |
Checks if the ability is playing a montage and stops that montage, returns true if a montage was stopped, false if not. | Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |
Overridden from UGameplayTask
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnDestroy
(
bool AbilityEnded |
Abilities/Tasks/AbilityTask_PlayMontageAndWait.h |