Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > FAnimUpdateRateParameters

Light Theme

Dark Theme

FAnimUpdateRateParameters

Container for Animation Update Rate parameters.

Windows

MacOS

Linux

References

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

Syntax

struct FAnimUpdateRateParameters

Remarks

Container for Animation Update Rate parameters. They are shared for all components of an Actor, so they can be updated in sync.

Variables

	Name	Description
float	AdditionalTime	Total time of the last series of skipped updates
int32	BaseNonRenderedUpdateRate	Rate of animation evaluation when non rendered (off screen and dedicated servers).
TArray< float >	BaseVisibleDistanceFactorThesholds	Array of MaxDistanceFactor to use for AnimUpdateRate when mesh is visible (rendered).
uint8: 1	bInterpolateSkippedFrames	When skipping a frame, should it be interpolated or frozen?
uint8: 1	bShouldUseLodMap	Whether or not to use the defined LOD/Frameskip map instead of separate distance factor thresholds
uint8: 1	bShouldUseMinLod	If set, LOD/Frameskip map will be queried with mesh's MinLodModel instead of current LOD (PredictedLODLevel)
uint8: 1	bSkipEvaluation	(This frame) animation evaluation should be skipped.
uint8: 1	bSkipUpdate	(This frame) animation update should be skipped.
int32	EvaluationRate	How often animation will be evaluated.
TMap< int32, in...	LODToFrameSkipMap	Map of LOD levels to frame skip amounts.
int32	MaxEvalRateForInterpolation	Max Evaluation Rate allowed for interpolation to be enabled.
EOptimizeMode	OptimizeMode	Cache which Update Rate Optimization mode we are using
EUpdateRateShif...	ShiftBucket	The bucket to use when deciding which counter to use to calculate shift values
int32	SkippedEvalFrames	Number of evaluate frames that have been skipped in a row
int32	SkippedUpdateFrames	Number of update frames that have been skipped in a row
float	ThisTickDelta	The delta time of the last tick
float	TickedPoseOffestTime	Track time we have lost via skipping
int32	UpdateRate	How often animation will be updated/ticked. 1 = every frame, 2 = every 2 frames, etc.

Constructors

	Name	Description
	FAnimUpdateRateParameters()	Default constructor.

Functions

	Name	Description
bool	DoEvaluationRateOptimizations()	Return true if evaluation rate should be optimized at all
float	GetInterpolationAlpha()	Amount to interpolate bone transforms
float	GetRootMotionInterp()	Amount to interpoilate root motion
float	GetTimeAdjustment()	Called when we are ticking a pose to make sure we accumulate all needed time
FColor	GetUpdateRateDebugColor()	Returns color to use for debug UI
void	SetLookAheadMode ( float DeltaTime, uint8 UpdateRateShift, float LookAheadAmount )	Set parameters and verify inputs for Lookahead mode, which handles Root Motion
void	SetTrailMode ( float DeltaTime, uint8 UpdateRateShift, int32 NewUpdateRate, int32 NewEvaluationRate, bool bNewInterpSkippedFrames )	Set parameters and verify inputs for Trail Mode (original behaviour - skip frames, track skipped time and then catch up afterwards).
bool	ShouldInterpolateSkippedFrames()	Getter for bInterpolateSkippedFrames
bool	ShouldSkipEvaluation()	Getter for bSkipEvaluation
bool	ShouldSkipUpdate()	Getter for bSkipUpdate

Enums

	Name	Description
	EOptimizeMode

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss