UAnimInstance::IsUpdateAnimationEnabled

function Engine Since 4.0

#include "Animation/AnimInstance.h"

Access: public Specifiers: constENGINE_API

Description

Returns whether the animation update tick is currently enabled for this instance. Use this to check the state set by EnableUpdateAnimation before performing animation-dependent logic.

Caveats & Gotchas

• This only reflects the flag set by EnableUpdateAnimation. The anim instance may also be skipped for other reasons (e.g., the component's visibility-based optimization settings or URO).
• Returns true by default — animation updates are enabled unless explicitly disabled.

Signature

ENGINE_API bool IsUpdateAnimationEnabled() const

Return Type

bool

Example

Guard animation-dependent logic C++

void AMyCharacter::UpdateFootsteps()
{
	UAnimInstance* AnimInst = GetMesh()->GetAnimInstance();
	if (AnimInst && AnimInst->IsUpdateAnimationEnabled())
	{
		float FootCurve = AnimInst->GetCurveValue(FName("FootstepWeight"));
		// Process footsteps...
	}
}

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?