1. Epic GamesDeveloper
  3. FAnimMontageInstance

FAnimMontageInstance

Unreal Engine C++ API Reference > Runtime > Engine > Animation

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AnimMontage.h
Include #include "Animation/AnimMontage.h"

Syntax

struct FAnimMontageInstance

Variables

  Type Name Description
Public variable bool bDidUseMarkerSyncThisTick Whether this in this tick's call to Advance we used marker based sync.
Public variable bool bEnableAutoBlendOut Enable auto blend out. This is instance set up. You can override
Public variable bool bPlaying  
Public variable float DefaultBlendTimeMultiplier Blend Time multiplier to allow extending and narrowing blendtimes.
Public variable FDeltaTimeRecord DeltaTimeRecord Transient value of time position and delta in the last frame known
Public variable TArray< FPassedMarker > MarkersPassedThisTick Markers that passed in this tick
Public variable FMarkerTickRecord MarkerTickRecord Marker tick record
Public variable TObjectPtr< class UAnimMontage > Montage Montage reference.
Public variable FOnMontageBlendingOutStarted OnMontageBlendingOutStarted  
Public variable FOnMontageEnded OnMontageEnded Delegates

Constructors

  Type Name Description
Public function    
Public function  

FAnimMontageInstance ( UAnimInstance* InAnimInstance
)

  

Functions

  Type Name Description
Public function void Reference has to be managed manually
Public function void

Advance ( float DeltaTime,
FRootMotionMovementParams* OutRootMotionParams,
bool bBlendRootMotion
)

 Simulate is same as Advance, but without calling any events or touching any of the instance data.
Public function Const bool Return true if it can use marker sync
Public function void  
Public function Const const UBlendProfile *  
Public function Const const EBlendProfileMode  
Public function Const const FAlphaBlend & Get the current blend info.
Public function Const float  
Public function Const float  
Public function Const FName  
Public function Const float  
Public function Const float  
Public function Const int32 Getters
Public function Const const FAnimMontageInstance *  
Public function Const FName  
Public function Const int32

GetNextSectionID ( int32 const& CurrentSectionID
)

  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const FName

GetSectionNameFromID ( int32 const& SectionID
)

  
Public function Const FName  
Public function Const float Get Weight
Public function void

HandleEvents ( float PreviousTrackPos,
float CurrentTrackPos,
const FBranchingPointMarker* BranchingPointMarker
)

 Delegate function handlers
Public function void

Initialize ( UAnimMontage* InMontage
)

  
Public function Const bool Returns true if this montage is active (valid and not blending out)
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function bool

JumpToSectionName ( FName const& SectionName,
bool bEndOfSection
)

  
Public function void

MontageSync_Follow ( FAnimMontageInstance* NewLeaderMontageInstance
)

 Montage to Montage Synchronization.
Public function void PostUpdate - Sync if updated after Leader.
Public function void PreUpdate - Sync if updated before Leader.
Public function void Stop following our leader
Public function void Stop leading, release all followers.
Public function void

Pause ()

  
Public function void

Play ( float InPlayRate,
const FMontageBlendSettings& BlendInSettings
)

 Blend in with the supplied blend settings.
Public function void

Play ( float InPlayRate
)

 Blend in with the supplied play rate. Other blend settings will come from the Montage asset.
Public function void  
Public function Static UAnimMontage *

PreviewSequencerMontagePosition ( FName SlotName,
USkeletalMeshComponent* SkeletalMeshComponent,
int32& InOutInstanceId,
UAnimSequenceBase* InAnimSequence,
float InFromPosition,
float InToPosition,
float Weight,
bool bLooping,
bool bFireNotifies,
bool bPlaying
)

  
Public function Static UAnimMontage *

PreviewSequencerMontagePosition ( FName SlotName,
USkeletalMeshComponent* SkeletalMeshComponent,
UAnimInstance* AnimInstance,
int32& InOutInstanceId,
UAnimSequenceBase* InAnimSequence,
float InFromPosition,
float InToPosition,
float Weight,
bool bLooping,
bool bFireNotifies,
bool bPlaying
)

  
Public function void Disable RootMotion.
Public function void

SetDesiredWeight ( float InValue
)

 Set the Desired Weight
Public function void

SetNextPositionWithEvents ( float InFromPosition,
float InToPosition
)

 Set the evaluation range of this animation for the next animation update tick.
Public function void

SetNextPositionWithEvents ( float InPosition
)

 Set the next position of this animation for the next animation update tick.
Public function bool

SetNextSectionID ( int32 const& SectionID,
int32 const& NewNextSectionID
)

  
Public function bool

SetNextSectionName ( FName const& SectionName,
FName const& NewNextSectionName
)

  
Public function void

SetPlaying ( bool bInPlaying
)

  
Public function void

SetPlayRate ( float const& InPlayRate
)

  
Public function void

SetPosition ( float const& InPosition
)

 Setters
Public function Static UAnimMontage *

SetSequencerMontagePosition ( FName SlotName,
USkeletalMeshComponent* SkeletalMeshComponent,
int32& InOutInstanceId,
UAnimSequenceBase* InAnimSequence,
float InFromPosition,
float InToPosition,
float Weight,
bool bLooping,
bool bPlaying
)

 Static functions that are used by sequencer montage support
Public function Static UAnimMontage *

SetSequencerMontagePosition ( FName SlotName,
UAnimInstance* AnimInstance,
int32& InOutInstanceId,
UAnimSequenceBase* InAnimSequence,
float InFromPosition,
float InToPosition,
float Weight,
bool bLooping,
bool bPlaying
)

  
Public function void

SetWeight ( float InValue
)

 Set the weight
Public function Const bool

SimulateAdvance ( float DeltaTime,
float& InOutPosition,
FRootMotionMovementParams& OutRootMotionParams
)

 Simulate is same as Advance, but without calling any events or touching any of the instance data.
Public function void

Stop ( const FAlphaBlend& InBlendOut,
bool bInterrupt
)

 Blend out with the supplied FAlphaBlend. Other blend settings will come from the Montage asset.
Public function void

Stop ( const FMontageBlendSettings& InBlendOutSettings,
bool bInterrupt
)

 Blend out with the supplied blend settings.
Public function void  
Public function void

UpdateWeight ( float DeltaTime
)

 Montage Tick happens in 2 phases

Deprecated Functions

  Type Name Description
Public function Const int32 Please use GetSyncGroupName

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page