UAnimInstance

class Engine Blueprint Since 4.0

Inherits: UObjectBase › UObjectBaseUtility › UObject › UAnimInstance

#include "Animation/AnimInstance.h"

Description

The runtime instance of an Animation Blueprint, responsible for evaluating the anim graph and driving a skeletal mesh. You subclass this in C++ or Blueprint to implement custom animation logic.

Caveats & Gotchas

• UAnimInstance is constrained to live Within=SkeletalMeshComponent — you cannot manually construct one and attach it to arbitrary objects.
• Access the instance at runtime via USkeletalMeshComponent::GetAnimInstance(). It may be null if no Animation Blueprint is assigned.
• Montage and curve APIs are on UAnimInstance, not on the mesh component — get the instance first.

Example

Get the anim instance from a mesh component C++

UAnimInstance* AnimInst = GetMesh()->GetAnimInstance();
if (AnimInst)
{
    AnimInst->Montage_Play(MyMontage);
}

Functions (210)

Lifecycle

27 ▼

Access	Type	Name	Description
public	function	UAnimInstance::BlueprintBeginPlay	Blueprint-implementable event called when BeginPlay is triggered on the owning skeletal mesh component.
public	function	UAnimInstance::BlueprintInitializeAnimation	Blueprint event called once when the anim instance is initialized, before any animation updates.
public	function	UAnimInstance::BlueprintUpdateAnimation	Blueprint event called every frame to update animation state.
public	function	UAnimInstance::IsInitialized	Returns whether this anim instance has completed its initialization and is ready for use.
public	function	UAnimInstance::NativeInitializeAnimation	Override in C++ subclasses to perform custom initialization when the animation instance starts.
public	function	UAnimInstance::NativeUpdateAnimation	Override in C++ subclasses to update animation variables every frame.
public	function	UAnimInstance::BlueprintPostEvaluateAnimation	Blueprint event called after the animation graph has been evaluated and final pose computed.
public	function	UAnimInstance::BlueprintThreadSafeUpdateAnimation	Thread-safe Blueprint event for updating animation variables during parallel evaluation.
public	function	UAnimInstance::EnableUpdateAnimation	Enables or disables the animation update tick for this instance.
public	function	UAnimInstance::InitializeAnimation	Initializes the animation instance, setting up all animation nodes, state machines, and internal data structures.
public	function	UAnimInstance::IsUpdateAnimationEnabled	Returns whether the animation update tick is currently enabled for this instance.
public	function	UAnimInstance::NativeBeginPlay	C++ lifecycle hook called when the owning skeletal mesh component's BeginPlay fires.
protected	function	UAnimInstance::NativeThreadSafeUpdateAnimation	Called each frame on the worker thread to update animation state in a thread-safe context.
protected	function	UAnimInstance::NativeUninitializeAnimation	Called when the anim instance is being torn down, typically when the owning skeletal mesh component is destroyed or the animation blueprint is changed at runtime.
public	function	UAnimInstance::PostEvaluateAnimation	Called after the animation graph has evaluated and produced the final bone transforms.
public	function	UAnimInstance::PostUpdateAnimation	Called on the game thread after both the main update and parallel update have completed.
public	function	UAnimInstance::UninitializeAnimation	Tears down the animation instance, releasing animation nodes and internal state.
public	function	UAnimInstance::UpdateAnimation	Main entry point for the game-thread animation update.
public	function	UAnimInstance::IsPostUpdatingAnimation	Returns true if the anim instance is currently in the post-update phase of its animation tick.
public	function	UAnimInstance::IsUpdatingAnimation	Returns true if the anim instance is currently in the update phase of its animation tick.
protected	function	UAnimInstance::NativeLinkedAnimationLayersInitialized	Called after all linked animation layer instances have been initialized and are ready to use.
protected	function	UAnimInstance::NativePostEvaluateAnimation	Called after the anim graph has been evaluated and final bone transforms are computed.
public	function	UAnimInstance::OnUROPreInterpolation_AnyThread	Called on the worker thread before URO (Update Rate Optimization) interpolation is applied.
public	function	UAnimInstance::OnUROSkipTickAnimation	Virtual callback invoked when the Update Rate Optimization (URO) system skips the animation tick for this instance.
public	function	UAnimInstance::ParallelUpdateAnimation	Called on a worker thread to perform animation graph update work in parallel with the game thread.
public	function	UAnimInstance::PreEvaluateAnimation	Called immediately before the animation graph evaluates bone transforms.
public	function	UAnimInstance::PreUpdateLinkedInstances	Called before linked animation instances are updated.

Components

1 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetSkelMeshComponent	Returns the USkeletalMeshComponent that owns this anim instance.

Utility

19 ▼

Access	Type	Name	Description
public	function	UAnimInstance::CalculateDirection	Computes the angle in degrees (–180 to 180) between a velocity vector and a base rotation, projected onto the horizontal plane.
public	function	UAnimInstance::GetDeltaSeconds	Returns the delta time in seconds used for the current animation update tick.
public	function	UAnimInstance::GetOwningActor	Returns the actor that owns the skeletal mesh component driving this animation instance.
public	function	UAnimInstance::GetOwningComponent	Returns the skeletal mesh component that created and hosts this animation instance.
public	function	UAnimInstance::TryGetPawnOwner	Returns the Pawn that owns the skeletal mesh component driving this animation instance, or null if the owner is not a Pawn.
public	function	UAnimInstance::Blueprint_GetMainAnimInstance	Returns the main animation instance hosted directly on the skeletal mesh component.
public	function	UAnimInstance::ClearAllTransitionEvents	Removes every queued transition request regardless of event name.
public	function	UAnimInstance::ClearTransitionEvents	Removes all queued transition requests that match the given event name.
public	function	UAnimInstance::GetInstanceAssetPlayerTimeFromEnd	Returns the time remaining in seconds until the end of the animation asset playing in the specified asset player node.
public	function	UAnimInstance::GetLODLevel	Returns the LOD level at which this animation instance is currently being evaluated, mirroring the skeletal mesh component's predicted LOD.
public	function	UAnimInstance::RequestTransitionEvent	Queues a named transition event on the animation state machine.
public	function	UAnimInstance::AddReferencedObjects	Reports non-UPROPERTY UObject references held by this animation instance to the garbage collector.
public	function	UAnimInstance::GatherDebugData	Collects debug information from all active animation graph nodes into the provided debug data structure.
public	function	UAnimInstance::GetInstanceAssetPlayerLength	Returns the total length in seconds of the animation asset referenced by the specified asset player node.
public	function	UAnimInstance::GetInstanceAssetPlayerTime	Returns the current accumulated playback time in seconds for the specified asset player node.
public	function	UAnimInstance::GetInstanceAssetPlayerTimeFraction	Returns the current accumulated playback time as a normalized fraction (0.
public	function	UAnimInstance::GetUpdateCounter	Returns the current animation graph update counter.
public	function	UAnimInstance::LockAIResources deprecated	Locks AI movement and/or logic resources on the owning pawn's AI controller so that the animation can take exclusive control during an animation-driven sequence.
public	function	UAnimInstance::UnlockAIResources deprecated	Releases AI movement and/or logic resource locks previously acquired by `LockAIResources`.

Animation Layers

3 ▼

Access	Type	Name	Description
public	function	UAnimInstance::BlueprintLinkedAnimationLayersInitialized	Blueprint event called when linked animation layers have been initialized on this anim instance.
public	function	UAnimInstance::GetLinkedInputPoseNode	Retrieves a linked input pose node by its node ID and optional link index.
public	function	UAnimInstance::InitializeGroupedLayers	Initializes grouped animation layers on this anim instance.

Asset Player

6 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetInstanceAssetPlayerIndex	Looks up the flat index of an asset player node given its state machine, state, and node name.
public	function	UAnimInstance::GetInstanceAssetPlayers	Returns a read-only reference to the array of all active asset player tick records for this animation instance.
public	function	UAnimInstance::GetInstanceAssetPlayerTimeFromEndFraction	Returns the remaining playback time of an asset player node as a normalized fraction (0.
public	function	UAnimInstance::GetInstanceRelevantAssetPlayers	Returns a read-only reference to the array of asset player tick records that are currently relevant — i.
public	function	UAnimInstance::GetMutableInstanceAssetPlayers	Returns a mutable reference to the array of all active asset player tick records.
public	function	UAnimInstance::GetMutableInstanceRelevantAssetPlayers	Returns a mutable reference to the array of relevant asset player tick records.

Blending

1 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetBlendProfileByName	Retrieves a named blend profile from the skeleton associated with this AnimInstance.

Curves

7 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetActiveCurveNames	Populates OutNames with the names of all animation curves of the given type that are currently non-zero or active.
public	function	UAnimInstance::GetAllCurveNames	Populates OutNames with the names of all currently active attribute curves.
public	function	UAnimInstance::GetAnimationCurves	Returns a read-only map of all evaluated animation curve values for the specified curve type.
public	function	UAnimInstance::GetCurveValue	Returns the current evaluated value of a named animation curve.
public	function	UAnimInstance::GetCurveValueWithDefault	Reads the current value of a named animation curve, falling back to a caller-supplied default if the curve is not currently active.
public	function	UAnimInstance::OverrideCurveValue	Forces an animation curve to a specific value, overriding whatever the animation graph produced.
public	function	UAnimInstance::RefreshCurves	Pushes the current evaluated curve values from this anim instance into the provided skeletal mesh component, updating morph targets and material parameters.

Debug

2 ▼

Access	Type	Name	Description
public	function	UAnimInstance::DisplayDebug	Draws animation debug information onto the HUD canvas when the 'Animation' debug category is active via the `showdebug Animation` console command.
public	function	UAnimInstance::DisplayDebugInstance	Draws per-instance debug information as part of the animation debug hierarchy.

Dynamics

1 ▼

Access	Type	Name	Description
public	function	UAnimInstance::ResetDynamics	Signals all simulation-style animation nodes (AnimDynamics, CCDIK, etc.

Evaluation

5 ▼

Access	Type	Name	Description
public	function	UAnimInstance::NeedsUpdate	Returns whether this anim instance requires an update this frame.
public	function	UAnimInstance::CanRunParallelWork	Returns whether this anim instance is eligible to run its animation evaluation on a worker thread in parallel with the game thread.
public	function	UAnimInstance::IsRunningParallelEvaluation	Returns true if this anim instance is currently being evaluated on a worker thread rather than the game thread.
public	function	UAnimInstance::ParallelCanEvaluate	Returns whether this AnimInstance supports evaluation on a worker thread for the given skeletal mesh.
public	function	UAnimInstance::ParallelEvaluateAnimation	Called on a worker thread to evaluate the animation graph when ParallelCanEvaluate returns true.

Inertial Blending

1 ▼

Access	Type	Name	Description
public	function	UAnimInstance::RequestSlotGroupInertialization	Requests an inertial blend transition originating from the specified montage slot group.

Linked Anim Graphs

8 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetLinkedAnimGraphInstanceByTag	Finds and returns the UAnimInstance running inside a Linked Anim Graph node that has the specified tag.
public	function	UAnimInstance::GetLinkedAnimLayerInstanceByClass	Returns the first linked layer instance whose class matches InClass, optionally allowing derived classes when bCheckForChildClass is true.
public	function	UAnimInstance::GetLinkedAnimLayerInstanceByGroup	Returns the linked anim instance that is currently running for the specified layer group.
public	function	UAnimInstance::GetLinkedAnimLayerInstanceByGroupAndClass	Returns the linked layer instance that matches both the specified group name and the specified class.
public	function	UAnimInstance::GetLinkedAnimLayerInstancesByGroup	Collects all distinct linked anim instances that are running for the specified layer group.
public	function	UAnimInstance::LinkAnimClassLayers	Links all Anim Layer nodes implemented by the specified class, allocating one linked instance per group to share state.
public	function	UAnimInstance::LinkAnimGraphByTag	Swaps the class running inside a Linked Anim Graph node identified by tag to a different UAnimInstance subclass at runtime.
public	function	UAnimInstance::UnlinkAnimClassLayers	Removes all layer links established by the specified class and resets each affected Anim Layer node to its default implementation.

Linked Graphs

1 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetLinkedAnimGraphInstancesByTag	Populates an array with all linked anim graph instances whose graph node carries the specified tag, allowing bulk access to multiple sub-graphs sharing the same tag.

Montage

63 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetCurrentActiveMontage	Returns a pointer to the first active montage found on this anim instance.
public	function	UAnimInstance::IsAnyMontagePlaying	Returns true if at least one montage is currently in the active list on this anim instance, including those that are blending out.
public	function	UAnimInstance::Montage_GetCurrentSection	Returns the name of the section currently playing in the specified montage.
public	function	UAnimInstance::Montage_GetIsStopped	Returns true if the montage is not currently active — either it was never started, has fully ended, or is in a blend-out phase.
public	function	UAnimInstance::Montage_IsActive	Returns true if the specified montage is currently active (playing or blending out).
public	function	UAnimInstance::GetActiveInstanceForMontage	Returns the active FAnimMontageInstance for a specific UAnimMontage asset, or nullptr if that montage is not currently playing.
public	function	UAnimInstance::GetActiveMontageInstance	Returns the currently active (topmost weight-contributing) montage instance, or nullptr if no montage is playing.
public	function	UAnimInstance::GetInstanceForMontage	Returns the FAnimMontageInstance for a given montage regardless of whether it is actively playing or in its blend-out phase.
public	function	UAnimInstance::GetSlotNodeGlobalWeight	Returns the global blend weight of the specified slot node, accounting for the full graph hierarchy.
public	function	UAnimInstance::IsPlayingSlotAnimation	Returns true if the given animation asset is currently playing through the specified slot node.
public	function	UAnimInstance::IsSlotActive	Returns true if the named slot node has a montage actively playing (not blending out).
public	function	UAnimInstance::Montage_GetBlendingOutDelegate	Returns a pointer to the FOnMontageBlendingOutStarted delegate for the given montage instance, enabling inspection or late binding after the montage has started playing.
public	function	UAnimInstance::Montage_GetBlendTime	Returns the current blend-in or blend-out time remaining for the montage in seconds.
public	function	UAnimInstance::Montage_GetEffectivePlayRate	Returns the actual playback speed of the montage as seen in-game, incorporating both the instance play rate and the montage asset's RateScale.
public	function	UAnimInstance::Montage_GetEndedDelegate	Returns a pointer to the FOnMontageEnded delegate for the specified montage instance, allowing callers to inspect or directly bind to it after the fact.
public	function	UAnimInstance::Montage_GetNextSectionID	Returns the section index that will play after the specified section, respecting any per-instance section redirects set via Montage_SetNextSection.
public	function	UAnimInstance::Montage_GetPlayRate	Returns the play rate set on the montage instance.
public	function	UAnimInstance::Montage_GetPosition	Returns the current playback position of the montage in seconds from the start of the asset.
public	function	UAnimInstance::Montage_GetSectionChangedDelegate	Returns a pointer to the FOnMontageSectionChanged delegate for the given montage instance, allowing inspection or late binding of a section-changed callback.
public	function	UAnimInstance::Montage_IsPlaying	Returns true if the specified montage is currently active and playing (not paused, not blending out).
public	function	UAnimInstance::Montage_JumpToSection	Immediately moves the montage playback position to the start of the named section.
public	function	UAnimInstance::Montage_JumpToSectionsEnd	Jumps the montage playback position to the end of the named section rather than its start.
public	function	UAnimInstance::Montage_Pause	Pauses the specified montage at its current position.
public	function	UAnimInstance::Montage_Play	Plays an animation montage on this anim instance.
public	function	UAnimInstance::Montage_PlayWithBlendIn	Plays a UAnimMontage asset with a custom blend-in specified by FAlphaBlendArgs, overriding the blend-in time baked into the montage asset.
public	function	UAnimInstance::Montage_Resume	Resumes a previously paused montage from the position at which it was paused.
public	function	UAnimInstance::Montage_SetBlendedInDelegate	Binds a delegate that fires once a montage has finished blending in and reached full weight.
public	function	UAnimInstance::Montage_SetBlendingOutDelegate	Binds a delegate that fires the moment a montage begins its blend-out phase — earlier than the end delegate, while the animation is still visible and weight is non-zero.
public	function	UAnimInstance::Montage_SetEndDelegate	Binds a delegate that fires when a montage finishes playing and its instance is fully stopped.
public	function	UAnimInstance::Montage_SetNextSection	Changes which section plays next after the specified section at runtime, overriding the static next-section link defined in the montage asset.
public	function	UAnimInstance::Montage_SetPlayRate	Changes the playback speed of an active montage without restarting it.
public	function	UAnimInstance::Montage_SetPosition	Jumps the montage playhead to a specific time position without restarting it.
public	function	UAnimInstance::Montage_SetSectionChangedDelegate	Binds a delegate that fires each time the active montage transitions to a new section, enabling section-driven game logic such as combo windows or state changes keyed to montage sections.
public	function	UAnimInstance::Montage_Stop	Stops a playing animation montage, blending it out over InBlendOutTime seconds.
public	function	UAnimInstance::Montage_StopGroupByName	Stops all active montages belonging to the named slot group, blending each out over the specified duration.
public	function	UAnimInstance::Montage_StopWithBlendOut	Stops a montage and blends it out using the provided FAlphaBlendArgs, overriding the blend-out values stored in the montage asset.
public	function	UAnimInstance::PlaySlotAnimationAsDynamicMontage	Creates a transient UAnimMontage wrapping the given asset and plays it through the named slot node.
public	function	UAnimInstance::StopAllMontages	Stops every currently active montage on this AnimInstance simultaneously, blending each one out over the specified duration.
public	function	UAnimInstance::StopSlotAnimation	Stops the dynamic montage playing in the given slot node and blends back to the base pose over the specified time.
public	function	UAnimInstance::Blueprint_GetSlotMontageLocalWeight	Returns the current local blend weight (0–1) of any montage playing in the named slot.
public	function	UAnimInstance::CalcSlotMontageLocalWeight	Recalculates and returns the local montage blend weight for the named slot by iterating active montage instances directly.
public	function	UAnimInstance::ClearMontageInstanceReferences	Removes all internal tracking references to a montage instance — slot weight maps, active instance lists, and slot node bookkeeping — in preparation for its destruction.
public	function	UAnimInstance::ConditionalFlushCompletedMontages	Destroys any montage instances that have reached zero weight and are queued for removal.
public	function	UAnimInstance::DynamicMontage_IsPlayingFrom	Returns true if there is currently an active dynamic montage that was created from the specified animation asset.
public	function	UAnimInstance::GetLastMontageFlushFrame	Returns the frame counter value from the last time completed montages were flushed.
public	function	UAnimInstance::GetMontageInstanceForID	Returns the FAnimMontageInstance with the given unique ID, enabling reliable lookup of a specific instance even when the same montage asset is playing multiple times concurrently.
public	function	UAnimInstance::GetSlotMontageGlobalWeight	Returns the global blend weight (0–1) contributed by the montage playing in the named slot, factoring in the overall montage weight in the animation graph.
public	function	UAnimInstance::GetSlotMontageLocalWeight	Returns the local blend weight (0–1) of any montage active in the named slot, without factoring in parent blend node weights.
public	function	UAnimInstance::IsUsingMainInstanceMontageEvaluationData	Returns whether this linked anim instance reads montage evaluation data from the main (owning) anim instance rather than maintaining its own.
public	function	UAnimInstance::MakeMontageTickRecord	Builds the per-tick evaluation record for a montage, computing which sync markers were crossed and the weighted contribution of the montage to the pose.
public	function	UAnimInstance::Montage_PlayWithBlendSettings	Plays a UAnimMontage with fully customized blend-in settings via FMontageBlendSettings, which supports BlendProfiles for per-bone weighting in addition to the curve and timing options of FAlphaBlendArgs.
public	function	UAnimInstance::Montage_StopWithBlendSettings	Stops a montage with fully customized blend-out settings via FMontageBlendSettings, supporting BlendProfiles for per-bone weighting during blend-out.
public	function	UAnimInstance::MontageSync_Follow	Synchronizes a follower montage on this instance to track the position and play rate of a leader montage on another (or the same) anim instance.
public	function	UAnimInstance::MontageSync_StopFollowing	Breaks the sync link established by MontageSync_Follow so that the follower montage resumes independent playback.
public	function	UAnimInstance::OnMontageInstanceStopped	Engine callback invoked immediately before a FAnimMontageInstance is destroyed, whether the montage finished naturally or was stopped manually.
public	function	UAnimInstance::PlaySlotAnimationAsDynamicMontage_WithBlendArgs	Variant of PlaySlotAnimationAsDynamicMontage that accepts FAlphaBlendArgs structs for blend-in and blend-out, allowing custom easing curves instead of linear blends.
public	function	UAnimInstance::PlaySlotAnimationAsDynamicMontage_WithBlendSettings	Variant of PlaySlotAnimationAsDynamicMontage that uses FMontageBlendSettings for both blend phases, providing the most complete control including sync-group-aware blending.
public	function	UAnimInstance::QueueMontageBlendedInEvent	Enqueues a blended-in notification to be dispatched at the end of the current evaluation frame, deferring the delegate until the pose pipeline has finished.
public	function	UAnimInstance::QueueMontageBlendingOutEvent	Enqueues a blending-out notification to be dispatched at the end of the current evaluation frame, deferring the delegate fire until it is safe to modify game state.
public	function	UAnimInstance::QueueMontageEndedEvent	Enqueues a montage-ended event to be dispatched at the end of the current animation update.
public	function	UAnimInstance::QueueMontageSectionChangedEvent	Enqueues a montage section-changed event for deferred dispatch after animation evaluation.
public	function	UAnimInstance::RequestMontageInertialization	Requests physics-based pose inertialization for a montage transition, producing smoother blends than traditional linear blending by carrying bone velocity through the transition.
public	function	UAnimInstance::SetUseMainInstanceMontageEvaluationData	Controls whether a linked anim instance uses montage evaluation data from the main anim instance instead of its own.

Morph Targets

2 ▼

Access	Type	Name	Description
public	function	UAnimInstance::ClearMorphTargets	Resets all morph target weights on the owning skeletal mesh to zero.
public	function	UAnimInstance::SetMorphTarget	Sets the blend weight of a named morph target on the owning skeletal mesh.

Notifies

15 ▼

Access	Type	Name	Description
public	function	UAnimInstance::AddExternalNotifyHandler	Registers an external delegate handler for a named anim notify.
public	function	UAnimInstance::GetPropagateNotifiesToLinkedInstances	Returns whether this anim instance is configured to forward its own animation notifies down to any linked child anim instances.
public	function	UAnimInstance::GetReceiveNotifiesFromLinkedInstances	Returns whether this anim instance is configured to process animation notifies that originate from any of its linked anim instances.
public	function	UAnimInstance::RemoveExternalNotifyHandler	Removes a previously registered external delegate handler for a named anim notify.
public	function	UAnimInstance::SetPropagateNotifiesToLinkedInstances	Controls whether animation notifies fired on this instance are forwarded to any linked child anim instances.
public	function	UAnimInstance::SetReceiveNotifiesFromLinkedInstances	Controls whether this anim instance processes animation notifies fired by its linked child anim instances.
public	function	UAnimInstance::WasAnimNotifyNameTriggeredInAnyState	Returns true if a notify with the given name was triggered anywhere across all state machines during the last frame.
public	function	UAnimInstance::WasAnimNotifyNameTriggeredInStateMachine	Returns true if a notify with the given name was triggered anywhere in the specified state machine during the last frame.
public	function	UAnimInstance::WasAnimNotifyStateActiveInAnyState	Returns true if the specified AnimNotifyState type was active during the previous animation evaluation, regardless of which state machine state it came from.
public	function	UAnimInstance::WasAnimNotifyStateActiveInStateMachine	Returns true if the specified AnimNotifyState type was active in any state of a particular state machine during the last animation evaluation.
public	function	UAnimInstance::WasAnimNotifyTriggeredInAnyState	Returns true if a notify of the given class was triggered anywhere across all state machines in this AnimInstance during the last frame.
public	function	UAnimInstance::WasAnimNotifyTriggeredInStateMachine	Returns true if a notify of the given class was triggered anywhere in the specified state machine during the last frame.
public	function	UAnimInstance::WasAnimNotifyNameTriggeredInSourceState	Returns true if a notify with the given name was triggered during the last frame while the specified state was the source state of a transition.
public	function	UAnimInstance::WasAnimNotifyStateActiveInSourceState	Returns true if the specified AnimNotifyState type was active specifically within the given state machine state during the last animation evaluation.
public	function	UAnimInstance::WasAnimNotifyTriggeredInSourceState	Returns true if a notify of the given class was triggered during the last frame while the specified state was the source state of a transition.

Pose

5 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetPoseSnapshot	Returns a read-only pointer to the stored pose snapshot with the given name, or nullptr if no snapshot exists under that name.
public	function	UAnimInstance::RemovePoseSnapshot	Removes a previously stored pose snapshot from this AnimInstance by name.
public	function	UAnimInstance::SavePoseSnapshot	Captures the current skeletal mesh pose and stores it internally under the given name.
public	function	UAnimInstance::SnapshotPose	Captures the current evaluated pose into an FPoseSnapshot struct for external use.
public	function	UAnimInstance::AddPoseSnapshot	Registers a pre-constructed pose snapshot under the given name.

Root Motion

4 ▼

Access	Type	Name	Description
public	function	UAnimInstance::SetRootMotionMode	Changes the root motion extraction mode at runtime, controlling whether and how root motion from animations is applied to the owning character's movement.
public	function	UAnimInstance::ShouldExtractRootMotion	Returns whether this anim instance should currently extract and apply root motion from its animations.
public	function	UAnimInstance::GetRootMotionMontageInstance	Returns a pointer to the currently active montage instance that is providing root motion, or nullptr if no montage is currently driving root motion.
public	function	UAnimInstance::QueueRootMotionBlend	Adds a root motion transform delta to the pending blend queue.

Skeleton

2 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetRequiredBones	Returns the set of bones required by the current anim graph configuration.
public	function	UAnimInstance::GetRequiredBonesOnAnyThread	Returns the set of bones required by the current anim graph configuration, safe to call from any thread including the animation worker thread.

State Machine

28 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetStateMachineIndex	Returns the index of a state machine by its name.
public	function	UAnimInstance::GetStateMachineInstance	Retrieves the runtime state machine node instance by its index.
public	function	UAnimInstance::GetStateMachineInstanceFromName	Retrieves a state machine node instance by its name as defined in the Animation Blueprint.
public	function	UAnimInstance::AddNativeStateEntryBinding	Binds a native C++ delegate that fires when the specified state in an animation state machine is entered.
public	function	UAnimInstance::AddNativeStateExitBinding	Binds a native C++ delegate that fires when the specified state in an animation state machine is exited.
public	function	UAnimInstance::AddNativeTransitionBinding	Binds a native C++ delegate to an animation state machine transition.
public	function	UAnimInstance::CanTransitionSignature	Delegate signature function used as the prototype for custom transition rule functions in state machines.
public	function	UAnimInstance::GetCurrentStateName	Returns the name of the currently active state in the given state machine.
public	function	UAnimInstance::GetInstanceCurrentStateElapsedTime	Returns the time in seconds that the state machine has been in its current state.
public	function	UAnimInstance::GetInstanceMachineWeight	Returns the current blend weight (0.
public	function	UAnimInstance::GetInstanceStateWeight	Returns the current blend weight of a specific state within a state machine, ranging from 0.
public	function	UAnimInstance::GetInstanceTransitionCrossfadeDuration	Returns the configured crossfade blend duration in seconds for a specific state machine transition.
public	function	UAnimInstance::GetInstanceTransitionTimeElapsed	Returns the time in seconds that has elapsed since the specified transition began its crossfade.
public	function	UAnimInstance::GetInstanceTransitionTimeElapsedFraction	Returns the normalized progress (0.
public	function	UAnimInstance::GetMachineDescription	Retrieves the baked (compiled) state machine description for a given state machine instance.
public	function	UAnimInstance::GetRelevantAnimLength	Returns the total length in seconds of the most relevant animation sequence in the specified state.
public	function	UAnimInstance::GetRelevantAnimTime	Returns the current playback position in seconds of the most relevant animation sequence in the specified state.
public	function	UAnimInstance::GetRelevantAnimTimeFraction	Returns the current normalized playback position (0.
public	function	UAnimInstance::GetRelevantAnimTimeRemaining	Returns the time remaining in seconds before the most relevant animation in the specified state reaches its end.
public	function	UAnimInstance::GetRelevantAnimTimeRemainingFraction	Returns the normalized time remaining (0.
public	function	UAnimInstance::GetRelevantAssetPlayerInterfaceFromState	Returns the most relevant asset player node from the specified state in a state machine.
public	function	UAnimInstance::GetStateMachineIndexAndDescription	Looks up a state machine by name and returns both its baked description and its index in a single call.
public	function	UAnimInstance::GetStateMachineInstanceDesc	Returns the baked (compiled) description of the named state machine, including its states, transitions, and entry rules.
public	function	UAnimInstance::HasNativeStateEntryBinding	Checks whether a native C++ delegate is bound to the entry event of the specified state machine state.
public	function	UAnimInstance::HasNativeStateExitBinding	Checks whether a native C++ delegate is bound to the exit event of the specified state machine state.
public	function	UAnimInstance::HasNativeTransitionBinding	Checks whether a native C++ delegate is bound to the specified state machine transition.
public	function	UAnimInstance::QueryAndMarkTransitionEvent	Checks for pending transition events matching the specified transition and marks them as consumed so they will not trigger again.
public	function	UAnimInstance::QueryTransitionEvent	Checks whether any pending transition events match the specified state machine transition without consuming them.

Subsystems

2 ▼

Access	Type	Name	Description
public	function	UAnimInstance::FindSubsystem	Searches for an animation subsystem of the specified type on this anim instance.
public	function	UAnimInstance::GetSubsystem	Retrieves an animation subsystem of the specified type from this anim instance.

Sync Groups

7 ▼

Access	Type	Name	Description
public	function	UAnimInstance::GetTimeToClosestMarker	Finds the nearest sync marker with the given name in the specified sync group and writes the time remaining until it is reached into OutMarkerTime.
public	function	UAnimInstance::HasMarkerBeenHitThisFrame	Returns true if the given sync marker was passed during the current frame's animation evaluation in the specified sync group.
public	function	UAnimInstance::IsSyncGroupBetweenMarkers	Returns true if the sync group's current playback position is between the two named markers.
public	function	UAnimInstance::GetSyncGroupIndexFromName	Returns the internal index for a named sync group.
public	function	UAnimInstance::GetSyncGroupMapRead	Returns a read-only reference to the current sync group map, which contains per-group state for all active sync groups.
public	function	UAnimInstance::GetSyncGroupPosition	Returns the current marker-relative playback position of the given sync group as an FMarkerSyncAnimPosition, which stores the previous marker name, the next marker name, and the normalized position between them.
public	function	UAnimInstance::GetUngroupedActivePlayersRead	Returns a read-only reference to the array of active asset player tick records that are not assigned to any sync group.

Properties

Access	Type	Name	Description
public	property	UAnimInstance::ActiveAnimNotifyEventReference	Array of references to currently active anim notify state events, providing additional context such as the source animation asset and notify index.
public	property	UAnimInstance::ActiveAnimNotifyState	Array of currently active anim notify states.
public	property	UAnimInstance::NotifyQueue	The queue of animation notifies pending dispatch for this frame.
public	property	UAnimInstance::OnAllMontageInstancesEnded	Delegate broadcast when the last active montage instance on this AnimInstance finishes, leaving no montages playing.
public	property	UAnimInstance::OnMontageBlendedIn	Delegate broadcast once a montage has fully blended in (its blend-in phase is complete and the weight has reached 1).
public	property	UAnimInstance::OnMontageBlendingOut	Delegate broadcast when a montage begins blending out, whether the blend-out was triggered by natural completion, an explicit stop call, or an interruption by another montage.
public	property	UAnimInstance::OnMontageEnded	Delegate broadcast when a montage finishes playing and its blend-out is complete.
public	property	UAnimInstance::OnMontageSectionChanged	Delegate broadcast whenever a montage moves to a new section, either by natural playback progression or via Montage_SetNextSection or Montage_JumpToSection.
public	property	UAnimInstance::OnMontageStarted	Delegate broadcast immediately when a montage begins playing, at the start of its blend-in phase.

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?