RealDocs

UAnimInstance::EnableUpdateAnimation

function Engine Since 4.0
#include "Animation/AnimInstance.h"
Access: public Specifiers: ENGINE_API

Description

Enables or disables the animation update tick for this instance. When disabled, the anim graph stops evaluating and the character freezes in its current pose until re-enabled.

Caveats & Gotchas

  • Disabling updates does not reset the pose — the mesh holds whatever pose was last evaluated. This is useful for freeze-frame effects but can look broken if the character is mid-blend.
  • This only affects the anim instance tick. Physics, cloth simulation, and other skeletal mesh features continue unless disabled separately on the component.

Signature

ENGINE_API void EnableUpdateAnimation(bool bEnable)

Parameters

Name Type Description Default
bEnable bool True to enable animation updates, false to pause them.

Return Type

void

Example

Pause animation during a menu screen C++
void AMyCharacter::OnMenuOpened()
{
	if (UAnimInstance* AnimInst = GetMesh()->GetAnimInstance())
	{
		AnimInst->EnableUpdateAnimation(false);
	}
}

void AMyCharacter::OnMenuClosed()
{
	if (UAnimInstance* AnimInst = GetMesh()->GetAnimInstance())
	{
		AnimInst->EnableUpdateAnimation(true);
	}
}

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.