RealDocs

UAnimInstance::Montage_StopWithBlendOut

function Engine Blueprint Since 5.1
#include "Animation/AnimInstance.h"
Access: public Specifiers: UFUNCTIONBlueprintCallable

Description

Stops a montage and blends it out using the provided FAlphaBlendArgs, overriding the blend-out values stored in the montage asset.

Caveats & Gotchas

  • Passing nullptr stops all active montages simultaneously, which can interrupt unrelated montages playing on different slots — be explicit when multiple montages are active.
  • The blend curve specified in BlendOut affects the alpha ramp-down but does not alter the notify or section callbacks already scheduled in the montage timeline.

Signature

ENGINE_API void Montage_StopWithBlendOut(const FAlphaBlendArgs& BlendOut, const UAnimMontage* Montage = nullptr);

Parameters

Name Type Description Default
BlendOut const FAlphaBlendArgs& Alpha blend arguments controlling the blend-out curve and duration.
Montage const UAnimMontage* The montage to stop. Pass nullptr to stop all active montages. nullptr

Return Type

void

Example

Immediately stop a montage with a quick custom blend-out C++
FAlphaBlendArgs SnapOut(0.05f);
SnapOut.BlendOption = EAlphaBlendOption::Linear;
AnimInstance->Montage_StopWithBlendOut(SnapOut, AttackMontage);

Version History

Introduced in: 5.1

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.