RealDocs

FMontageSubStepper::PlayRate

property Engine Since unknown
#include "Animation/AnimMontage.h"
Access: private

Description

Effective play rate used for the current sub-step, derived from Cached_CombinedPlayRate and, if present, the TimeStretchCurve's local rate at the current position.

Caveats & Gotchas

  • Not the same value as the montage's own PlayRate property on FAnimMontageInstance — this is the sub-stepper's derived, per-substep rate that also folds in TimeStretchCurve adjustments.
  • Can differ frame to frame even with a constant montage play rate if a TimeStretchCurve is driving local speed variation.

Signature

float PlayRate;

Return Type

float

Example

Deriving DeltaMove from PlayRate C++
// Engine-internal, conceptually:
// DeltaMove = PlayRate * ClampedDeltaTime * (bPlayingForward ? 1.f : -1.f)

Version History

Introduced in: unknown

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.