1. Epic GamesDeveloper
  3. FAnimMontageInstance

FAnimMontageInstance

API > API/Runtime > API/Runtime/Engine

   
Name FAnimMontageInstance
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimMontage.h
Include Path #include "Animation/AnimMontage.h"

Syntax

USTRUCT ()  
struct FAnimMontageInstance

Constructors

Name Remarks Include Path Unreal Specifiers

FAnimMontageInstance ( UAnimInstance* InAnimInstance
)

   Animation/AnimMontage.h  
  Animation/AnimMontage.h  

Variables

Public

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

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveBlendProfile UBlendProfile * Active blend profile. Animation/AnimMontage.h  
ActiveBlendProfileMode EBlendProfileMode   Animation/AnimMontage.h  
ActiveStateBranchingPoints TArray< FAnimNotifyEvent > Currently Active AnimNotifyState, stored as a copy of the event as we need to call NotifyEnd on the event after a deletion in the editor. Animation/AnimMontage.h
  • Transient
AnimInstance TWeakObjectPtr< UAnimInstance > Reference to AnimInstance Animation/AnimMontage.h  
bInterrupted bool Need to save if it's interrupted or not this information is crucial for gameplay Animation/AnimMontage.h  
Blend FAlphaBlend   Animation/AnimMontage.h
  • Transient
BlendStartAlpha float The current start linear alpha value of the blend. This is not stored inside the FAlphaBlend struct. Animation/AnimMontage.h  
DisableRootMotionCount int32   Animation/AnimMontage.h
  • Transient
ForcedNextFromPosition TOptional< float > Optional evaluation range to use next update (ignoring the real delta time). Animation/AnimMontage.h  
ForcedNextToPosition TOptional< float >   Animation/AnimMontage.h  
InstanceID int32 Unique ID for this instance. Animation/AnimMontage.h  
MontageSubStepper FMontageSubStepper   Animation/AnimMontage.h  
MontageSyncFollowers TArray< struct FAnimMontageInstance * > Followers this Montage will synchronize Animation/AnimMontage.h  
MontageSyncLeader FAnimMontageInstance * Leader this Montage will follow Animation/AnimMontage.h  
MontageSyncUpdateFrameCounter uint32 Frame counter to sync montages once per frame Animation/AnimMontage.h  
NextSections TArray< int32 > List of next sections per section - index of array is section id Animation/AnimMontage.h  
NotifyWeight float Transient NotifyWeight - Weight for spawned notifies, modified slightly to make sure Animation/AnimMontage.h  
PlayRate float   Animation/AnimMontage.h  
Position float   Animation/AnimMontage.h  
PreviousWeight float Transient PreviousWeight - Weight of previous tick Animation/AnimMontage.h  
PrevSections TArray< int32 > List of prev sections per section - index of array is section id Animation/AnimMontage.h  
SyncGroupName FName Sync group name Animation/AnimMontage.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddReferencedObjects ( FReferenceCollector& Collector
)

 Reference has to be managed manually Animation/AnimMontage.h  

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

   Animation/AnimMontage.h  

bool CanUseMarkerSync()

 Return true if it can use marker sync Animation/AnimMontage.h  

void EditorOnly_PreAdvance()

   Animation/AnimMontage.h  

const UBlendProfile * GetActiveBlendProfile()

   Animation/AnimMontage.h  

const EBlendProfileMode GetActiveBlendProfileMode()

   Animation/AnimMontage.h  

const FAlphaBlend & GetBlend()

 Get the current blend info. Animation/AnimMontage.h  

float GetBlendStartAlpha()

   Animation/AnimMontage.h  

float GetBlendTime()

   Animation/AnimMontage.h  

FName GetCurrentSection()

   Animation/AnimMontage.h  

float GetDeltaMoved()

   Animation/AnimMontage.h  

float GetDesiredWeight()

   Animation/AnimMontage.h  

int32 GetInstanceID()

 Getters Animation/AnimMontage.h  

const FAnimMontageInstance * GetMontageSyncLeader()

   Animation/AnimMontage.h  

FName GetNextSection()

   Animation/AnimMontage.h  

int32 GetNextSectionID ( int32 const& CurrentSectionID
) const

   Animation/AnimMontage.h  

float GetPlayRate()

   Animation/AnimMontage.h  

float GetPosition()

   Animation/AnimMontage.h  

float GetPreviousPosition()

   Animation/AnimMontage.h  

FName GetSectionNameFromID ( int32 const& SectionID
) const

   Animation/AnimMontage.h  

int32 GetSyncGroupIndex()

   Animation/AnimMontage.h  

FName GetSyncGroupName()

   Animation/AnimMontage.h  

float GetWeight()

 Get Weight Animation/AnimMontage.h  

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

 Delegate function handlers Animation/AnimMontage.h  

void Initialize ( UAnimMontage* InMontage
)

   Animation/AnimMontage.h  

bool IsActive()

 Returns true if this montage is active (valid and not blending out) Animation/AnimMontage.h  

bool IsPlaying()

   Animation/AnimMontage.h  

bool IsRootMotionDisabled()

   Animation/AnimMontage.h  

bool IsStopped()

   Animation/AnimMontage.h  

bool IsValid()

   Animation/AnimMontage.h  

bool JumpToSectionName ( FName const& SectionName,
bool bEndOfSection
)

   Animation/AnimMontage.h  

void MontageSync_Follow ( FAnimMontageInstance* NewLeaderMontageInstance
)

 Montage to Montage Synchronization. Animation/AnimMontage.h  

void MontageSync_PostUpdate()

 PostUpdate - Sync if updated after Leader. Animation/AnimMontage.h  

void MontageSync_PreUpdate()

 PreUpdate - Sync if updated before Leader. Animation/AnimMontage.h  

void MontageSync_StopFollowing()

 Stop following our leader Animation/AnimMontage.h  

void MontageSync_StopLeading()

 Stop leading, release all followers. Animation/AnimMontage.h  

void Pause()

   Animation/AnimMontage.h  

void Play ( float InPlayRate
)

 Blend in with the supplied play rate. Other blend settings will come from the Montage asset. Animation/AnimMontage.h  

void Play ( float InPlayRate,
const FMontageBlendSettings& BlendInSettings
)

 Blend in with the supplied blend settings. Animation/AnimMontage.h  

void PopDisableRootMotion()

   Animation/AnimMontage.h  

void PushDisableRootMotion()

 Disable RootMotion. Animation/AnimMontage.h  

void SetDesiredWeight ( float InValue
)

 Set the Desired Weight Animation/AnimMontage.h  

void SetNextPositionWithEvents ( float InFromPosition,
float InToPosition
)

 Set the evaluation range of this animation for the next animation update tick. Animation/AnimMontage.h  

void SetNextPositionWithEvents ( float InPosition
)

 Set the next position of this animation for the next animation update tick. Animation/AnimMontage.h  

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

   Animation/AnimMontage.h  

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

   Animation/AnimMontage.h  

void SetPlaying ( bool bInPlaying
)

   Animation/AnimMontage.h  

void SetPlayRate ( float const& InPlayRate
)

   Animation/AnimMontage.h  

void SetPosition ( float const& InPosition
)

 Setters Animation/AnimMontage.h  

void SetWeight ( float InValue
)

 Set the weight Animation/AnimMontage.h  

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

 Simulate is same as Advance, but without calling any events or touching any of the instance data. Animation/AnimMontage.h  

void Stop ( const FAlphaBlend& InBlendOut,
bool bInterrupt
)

 Blend out with the supplied FAlphaBlend. Other blend settings will come from the Montage asset. Animation/AnimMontage.h  

void Stop ( const FMontageBlendSettings& InBlendOutSettings,
bool bInterrupt
)

 Blend out with the supplied blend settings. Animation/AnimMontage.h  

void Terminate()

   Animation/AnimMontage.h  

void UpdateWeight ( float DeltaTime
)

 Montage Tick happens in 2 phases Animation/AnimMontage.h  

Static

Name Remarks Include Path Unreal Specifiers

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
)

   Animation/AnimMontage.h  

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

   Animation/AnimMontage.h  

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

   Animation/AnimMontage.h  

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 Animation/AnimMontage.h  

static bool ValidateInstanceAfterNotifyState ( const TWeakObjectPtr< UAnimInstance >& InAnimInstance,
const UAnimNotifyState* InNotifyStateClass
)

 Notify may invalidate current montage instance. Animation/AnimMontage.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page