UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMontageSubStepper Struct Reference

#include <AnimMontage.h>

Public Member Functions

 FMontageSubStepper ()
 
void Initialize (const struct FAnimMontageInstance &InAnimInstance)
 
void AddEvaluationTime (float InDeltaTime)
 
bool HasTimeRemaining () const
 
float GetRemainingTime () const
 
EMontageSubStepResult Advance (float &InOut_P_Original, const FBranchingPointMarker **OutBranchingPointMarkerPtr)
 
bool HasReachedEndOfSection () const
 
float GetRemainingPlayTimeToSectionEnd (const float In_P_Original)
 
bool GetbPlayingForward () const
 
float GetDeltaMove () const
 
int32 GetCurrentSectionIndex () const
 
void ClearCachedData ()
 

Detailed Description

Helper struct to sub step through Montages when advancing time. These require stopping at sections and branching points to potential jumps and loops. And also stepping through TimeStretchMarkers to adjust play rate based on TimeStretchCurve.

Constructor & Destructor Documentation

◆ FMontageSubStepper()

FMontageSubStepper::FMontageSubStepper ( )
inline

Member Function Documentation

◆ AddEvaluationTime()

void FMontageSubStepper::AddEvaluationTime ( float  InDeltaTime)
inline

◆ Advance()

EMontageSubStepResult FMontageSubStepper::Advance ( float InOut_P_Original,
const FBranchingPointMarker **  OutBranchingPointMarkerPtr 
)

◆ ClearCachedData()

void FMontageSubStepper::ClearCachedData ( )
inline

Invalidate Cached_CombinedPlayRate to force data to be recached in 'ConditionallyUpdateCachedData'

◆ GetbPlayingForward()

bool FMontageSubStepper::GetbPlayingForward ( ) const
inline

◆ GetCurrentSectionIndex()

int32 FMontageSubStepper::GetCurrentSectionIndex ( ) const
inline

◆ GetDeltaMove()

float FMontageSubStepper::GetDeltaMove ( ) const
inline

◆ GetRemainingPlayTimeToSectionEnd()

float FMontageSubStepper::GetRemainingPlayTimeToSectionEnd ( const float  In_P_Original)

◆ GetRemainingTime()

float FMontageSubStepper::GetRemainingTime ( ) const
inline

◆ HasReachedEndOfSection()

bool FMontageSubStepper::HasReachedEndOfSection ( ) const
inline

◆ HasTimeRemaining()

bool FMontageSubStepper::HasTimeRemaining ( ) const
inline

◆ Initialize()

void FMontageSubStepper::Initialize ( const struct FAnimMontageInstance InAnimInstance)

The documentation for this struct was generated from the following files: