UAnimInstance::RemovePoseSnapshot

function Engine Since 4.24

#include "Animation/AnimInstance.h"

Access: public Specifiers: virtualENGINE_API

Description

Removes a previously stored pose snapshot from this AnimInstance by name. Call this to free the snapshot once the blend-from-snapshot transition is complete and the data is no longer needed.

Caveats & Gotchas

• If no snapshot with the given name exists, the call is silently ignored — there is no return value or error to check. Always use a consistent naming convention to avoid accidental silent misses.
• Snapshots are not replicated. In a multiplayer scenario each machine manages its own snapshot independently, so removal on the server does not affect client snapshots.

Signature

ENGINE_API virtual void RemovePoseSnapshot(FName SnapshotName);

Parameters

Name	Type	Description	Default
SnapshotName	FName	Name of the stored pose snapshot to remove.	—

Return Type

void

Example

Remove snapshot after a ragdoll-to-animation blend finishes C++

void UMyAnimInstance::OnGetUpBlendFinished()
{
	// Blend from DeathPose is complete; discard the snapshot to free memory
	RemovePoseSnapshot(FName("DeathPose"));
	bIsGettingUp = false;
}

Version History

Introduced in: 4.24

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?