Navigation
API > API/Runtime > API/Runtime/Engine
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.
| Name | FMontageSubStepper |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Animation/AnimMontage.h |
| Include Path | #include "Animation/AnimMontage.h" |
Syntax
struct FMontageSubStepper
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMontageSubStepper() |
Animation/AnimMontage.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasValidTimeStretchCurveData | bool | Animation/AnimMontage.h | ||
| bPlayingForward | bool | Animation/AnimMontage.h | ||
| bReachedEndOfSection | bool | Animation/AnimMontage.h | ||
| Cached_CombinedPlayRate | float | Animation/AnimMontage.h | ||
| Cached_P_Original | float | Animation/AnimMontage.h | ||
| Cached_P_Target | float | Animation/AnimMontage.h | ||
| CurrentSectionIndex | int32 | Animation/AnimMontage.h | ||
| CurrentSectionLength | float | Animation/AnimMontage.h | ||
| CurrentSectionStartTime | float | Animation/AnimMontage.h | ||
| DeltaMove | float | Animation/AnimMontage.h | ||
| Montage | const UAnimMontage * | Animation/AnimMontage.h | ||
| MontageInstance | const FAnimMontageInstance * | Animation/AnimMontage.h | ||
| PlayRate | float | Animation/AnimMontage.h | ||
| SectionEndPositions_Target | TArray< float > | Animation/AnimMontage.h | ||
| SectionStartPositions_Target | TArray< float > | Animation/AnimMontage.h | ||
| TimeRemaining | float | Animation/AnimMontage.h | ||
| TimeStretchCurveInstance | FTimeStretchCurveInstance | Animation/AnimMontage.h | ||
| TimeStretchMarkerIndex | int32 | Animation/AnimMontage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddEvaluationTime
(
float InDeltaTime |
Animation/AnimMontage.h | ||
EMontageSubStepResult Advance
(
float& InOut_P_Original, |
Animation/AnimMontage.h | ||
void ClearCachedData() |
Invalidate Cached_CombinedPlayRate to force data to be recached in 'ConditionallyUpdateCachedData' | Animation/AnimMontage.h | |
bool GetbPlayingForward() |
Animation/AnimMontage.h | ||
int32 GetCurrentSectionIndex() |
Animation/AnimMontage.h | ||
float GetDeltaMove() |
Animation/AnimMontage.h | ||
float GetRemainingPlayTimeToSectionEnd
(
const float In_P_Original |
Animation/AnimMontage.h | ||
float GetRemainingTime() |
Animation/AnimMontage.h | ||
bool HasReachedEndOfSection() |
Animation/AnimMontage.h | ||
bool HasTimeRemaining() |
Animation/AnimMontage.h | ||
void Initialize
(
const FAnimMontageInstance& InAnimInstance |
Animation/AnimMontage.h |