UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AnimInstance.h File Reference

Go to the source code of this file.

Classes

struct  FParallelEvaluationData
 
struct  FA2Pose
 
struct  FA2CSPose
 
struct  FQueuedMontageBlendingOutEvent
 
struct  FQueuedMontageBlendedInEvent
 
struct  FQueuedMontageEndedEvent
 
struct  FQueuedMontageSectionChangedEvent
 
struct  FNativeTransitionBinding
 
struct  FNativeStateBinding
 
struct  FMontageActiveSlotTracker
 
class  UAnimInstance
 

Namespaces

namespace  UE
 
namespace  UE::Anim
 

Macros

#define ANIMINST_PostCompileValidation   WITH_EDITOR
 

Typedefs

typedef TArray< FTransformFTransformArrayA2
 
using UE::Anim::FSlotInertializationRequest = TPair< float, const UBlendProfile * >
 

Enumerations

enum class  EMontagePlayReturnType : uint8 { MontageLength , Duration }
 

Functions

 DECLARE_DELEGATE_OneParam (FOnMontageStarted, UAnimMontage *) DECLARE_DELEGATE_TwoParams(FOnMontageEnded
 
UAnimMontage bool DECLARE_DELEGATE_TwoParams (FOnMontageBlendingOutStarted, UAnimMontage *, bool) DECLARE_DELEGATE_OneParam(FOnMontageBlendedInEnded
 
UAnimMontage bool UAnimMontageDECLARE_DELEGATE_ThreeParams (FOnMontageSectionChanged, UAnimMontage *, FName, bool) DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnMontageStartedMCDelegate
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams (FOnMontageEndedMCDelegate, UAnimMontage *, Montage, bool, bInterrupted)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE (FOnAllMontageInstancesEndedMCDelegate)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams (FOnMontageBlendingOutStartedMCDelegate, UAnimMontage *, Montage, bool, bInterrupted)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnMontageBlendedInEndedMCDelegate, UAnimMontage *, Montage)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams (FOnMontageSectionChangedMCDelegate, UAnimMontage *, Montage, FName, SectionName, bool, bLooped)
 
 DECLARE_DELEGATE_RetVal (bool, FCanTakeTransition)
 
 DECLARE_DELEGATE_ThreeParams (FOnGraphStateChanged, const struct FAnimNode_StateMachine &, int32, int32)
 
 DECLARE_DELEGATE_OneParam (FOnAddCustomAnimationCurves, UAnimInstance *) DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FPlayMontageAnimNotifyDelegate
 

Variables

UAnimMontage bool UAnimMontage UAnimMontage Montage
 
 FName
 
 NotifyName
 
const FBranchingPointNotifyPayload BranchingPointPayload
 

Macro Definition Documentation

◆ ANIMINST_PostCompileValidation

#define ANIMINST_PostCompileValidation   WITH_EDITOR

Typedef Documentation

◆ FTransformArrayA2

Enumeration Type Documentation

◆ EMontagePlayReturnType

Enumerator
MontageLength 
Duration 

Function Documentation

◆ DECLARE_DELEGATE_OneParam() [1/2]

DECLARE_DELEGATE_OneParam ( FOnAddCustomAnimationCurves  ,
UAnimInstance  
)

Delegate that allows users to insert custom animation curve values - for now, it's only single, not sure how to make this to multi delegate and retrieve value sequentially, so Delegate called by 'PlayMontageNotify' and 'PlayMontageNotifyWindow'

◆ DECLARE_DELEGATE_OneParam() [2/2]

DECLARE_DELEGATE_OneParam ( FOnMontageStarted  ,
UAnimMontage  
)

◆ DECLARE_DELEGATE_RetVal()

DECLARE_DELEGATE_RetVal ( bool  ,
FCanTakeTransition   
)

Delegate that native code can hook to provide additional transition logic

◆ DECLARE_DELEGATE_ThreeParams() [1/2]

DECLARE_DELEGATE_ThreeParams ( FOnGraphStateChanged  ,
const struct FAnimNode_StateMachine ,
int32  ,
int32   
)

Delegate that native code can hook into to handle state entry/exit

◆ DECLARE_DELEGATE_ThreeParams() [2/2]

UAnimMontage bool UAnimMontage * DECLARE_DELEGATE_ThreeParams ( FOnMontageSectionChanged  ,
UAnimMontage ,
FName  ,
bool   
)

Delegate for when Montage is started

◆ DECLARE_DELEGATE_TwoParams()

UAnimMontage bool DECLARE_DELEGATE_TwoParams ( FOnMontageBlendingOutStarted  ,
UAnimMontage ,
bool   
)

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE()

DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FOnAllMontageInstancesEndedMCDelegate  )

Delegate for when all montage instances have ended.

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam()

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam ( FOnMontageBlendedInEndedMCDelegate  ,
UAnimMontage ,
Montage   
)

Delegate for when Montage finished blending in

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams()

DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams ( FOnMontageSectionChangedMCDelegate  ,
UAnimMontage ,
Montage  ,
FName  ,
SectionName  ,
bool  ,
bLooped   
)

Delegate for when Montage changes sections

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams() [1/2]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams ( FOnMontageBlendingOutStartedMCDelegate  ,
UAnimMontage ,
Montage  ,
bool  ,
bInterrupted   
)

Delegate for when Montage started to blend out, whether interrupted or finished DesiredWeight of this montage becomes 0.f, but this still contributes to the output pose

bInterrupted = true if it was not property finished

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams() [2/2]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams ( FOnMontageEndedMCDelegate  ,
UAnimMontage ,
Montage  ,
bool  ,
bInterrupted   
)

Delegate for when Montage is completed, whether interrupted or finished Weight of this montage is 0.f, so it stops contributing to output pose

bInterrupted = true if it was not property finished

Variable Documentation

◆ BranchingPointPayload

const FBranchingPointNotifyPayload BranchingPointPayload

◆ FName

◆ Montage

◆ NotifyName

NotifyName