UAnimInstance::Montage_Pause

function Engine Blueprint Since 4.5

#include "Animation/AnimInstance.h"

Access: public Specifiers: UFUNCTIONBlueprintCallable

Description

Pauses the specified montage at its current position. The montage holds the last pose until Montage_Resume is called.

Caveats & Gotchas

• Animation notifies scheduled ahead of the paused position will not fire while the montage is paused — they resume firing normally when Montage_Resume is called.
• Pausing a montage does not stop blend-in or blend-out that is currently in progress; the blend weight continues to evaluate each frame even while position is frozen.

Signature

ENGINE_API void Montage_Pause(const UAnimMontage* Montage = NULL);

Parameters

Name	Type	Description	Default
Montage	const UAnimMontage*	The montage to pause. Pass NULL to pause all active montages.	NULL

Return Type

void

Example

Pause a cinematic montage during a menu open C++

void AMyCharacter::OnMenuOpened()
{
    if (UAnimInstance* Anim = GetMesh()->GetAnimInstance())
    {
        Anim->Montage_Pause(CinematicMontage);
    }
}

Version History

Introduced in: 4.5

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?