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

#include <AnimationAsset.h>

Public Member Functions

float GetRootMotionWeight () const
 
 FAnimTickRecord ()=default
 
ENGINE_API FAnimTickRecord (UAnimSequenceBase *InSequence, bool bInLooping, float InPlayRate, float InFinalBlendWeight, float &InCurrentTime, FMarkerTickRecord &InMarkerTickRecord)
 
ENGINE_API FAnimTickRecord (UAnimSequenceBase *InSequence, bool bInLooping, float InPlayRate, bool bInIsEvaluator, float InFinalBlendWeight, float &InCurrentTime, FMarkerTickRecord &InMarkerTickRecord)
 
ENGINE_API FAnimTickRecord (UBlendSpace *InBlendSpace, const FVector &InBlendInput, TArray< FBlendSampleData > &InBlendSampleDataCache, FBlendFilter &InBlendFilter, bool bInLooping, float InPlayRate, bool bShouldTeleportToTime, bool bInIsEvaluator, float InFinalBlendWeight, float &InCurrentTime, FMarkerTickRecord &InMarkerTickRecord)
 
ENGINE_API FAnimTickRecord (UAnimMontage *InMontage, float InCurrentPosition, float InPreviousPosition, float InMoveDelta, float InWeight, TArray< FPassedMarker > &InMarkersPassedThisTick, FMarkerTickRecord &InMarkerTickRecord)
 
ENGINE_API FAnimTickRecord (UAnimMontage *InMontage, float InCurrentPosition, float InWeight, TArray< FPassedMarker > &InMarkersPassedThisTick, FMarkerTickRecord &InMarkerTickRecord)
 
ENGINE_API FAnimTickRecord (UPoseAsset *InPoseAsset, float InFinalBlendWeight)
 
ENGINE_API void GatherContextData (const FAnimationUpdateContext &InContext)
 
template<typename Type , typename... TArgs>
void MakeContextData (TArgs &&... Args)
 
bool operator< (const FAnimTickRecord &Other) const
 

Public Attributes

TObjectPtr< class UAnimationAssetSourceAsset = nullptr
 
floatTimeAccumulator = nullptr
 
float PlayRateMultiplier = 1.0f
 
float EffectiveBlendWeight = 0.0f
 
float RootMotionWeightModifier = 1.0f
 
bool bLooping = false
 
bool bIsEvaluator = false
 
bool bRequestedInertialization = false
 
bool bOverridePositionWhenJoiningSyncGroupAsLeader = false
 
bool bIsExclusiveLeader = false
 
bool bActiveContext = true
 
const UMirrorDataTableMirrorDataTable = nullptr
 
TSharedPtr< TArray< TUniquePtr< const UE::Anim::IAnimNotifyEventContextDataInterface > > > ContextData
 
union { 
 
   struct { 
 
      FBlendFilter *   BlendFilter 
 
      TArray< FBlendSampleData > *   BlendSampleDataCache 
 
      int32   TriangulationIndex 
 
      float   BlendSpacePositionX 
 
      float   BlendSpacePositionY 
 
      bool   bTeleportToTime 
 
   }   BlendSpace 
 
   struct { 
 
      float   CurrentPosition 
 
      TArray< FPassedMarker > *   MarkersPassedThisTick 
 
   }   Montage 
 
};  
 
FDeltaTimeRecordDeltaTimeRecord = nullptr
 
FMarkerTickRecordMarkerTickRecord = nullptr
 
bool bCanUseMarkerSync = false
 
float LeaderScore = 0.0f
 

Detailed Description

Information about an animation asset that needs to be ticked

Constructor & Destructor Documentation

◆ FAnimTickRecord() [1/7]

FAnimTickRecord::FAnimTickRecord ( )
default

◆ FAnimTickRecord() [2/7]

FAnimTickRecord::FAnimTickRecord ( UAnimSequenceBase InSequence,
bool  bInLooping,
float  InPlayRate,
float  InFinalBlendWeight,
float InCurrentTime,
FMarkerTickRecord InMarkerTickRecord 
)

◆ FAnimTickRecord() [3/7]

FAnimTickRecord::FAnimTickRecord ( UAnimSequenceBase InSequence,
bool  bInLooping,
float  InPlayRate,
bool  bInIsEvaluator,
float  InFinalBlendWeight,
float InCurrentTime,
FMarkerTickRecord InMarkerTickRecord 
)

◆ FAnimTickRecord() [4/7]

FAnimTickRecord::FAnimTickRecord ( UBlendSpace InBlendSpace,
const FVector InBlendInput,
TArray< FBlendSampleData > &  InBlendSampleDataCache,
FBlendFilter InBlendFilter,
bool  bInLooping,
float  InPlayRate,
bool  bShouldTeleportToTime,
bool  bInIsEvaluator,
float  InFinalBlendWeight,
float InCurrentTime,
FMarkerTickRecord InMarkerTickRecord 
)

◆ FAnimTickRecord() [5/7]

FAnimTickRecord::FAnimTickRecord ( UAnimMontage InMontage,
float  InCurrentPosition,
float  InPreviousPosition,
float  InMoveDelta,
float  InWeight,
TArray< FPassedMarker > &  InMarkersPassedThisTick,
FMarkerTickRecord InMarkerTickRecord 
)

◆ FAnimTickRecord() [6/7]

FAnimTickRecord::FAnimTickRecord ( UAnimMontage InMontage,
float  InCurrentPosition,
float  InWeight,
TArray< FPassedMarker > &  InMarkersPassedThisTick,
FMarkerTickRecord InMarkerTickRecord 
)

◆ FAnimTickRecord() [7/7]

FAnimTickRecord::FAnimTickRecord ( UPoseAsset InPoseAsset,
float  InFinalBlendWeight 
)

Member Function Documentation

◆ GatherContextData()

void FAnimTickRecord::GatherContextData ( const FAnimationUpdateContext InContext)

◆ GetRootMotionWeight()

float FAnimTickRecord::GetRootMotionWeight ( ) const
inline

◆ MakeContextData()

template<typename Type , typename... TArgs>
void FAnimTickRecord::MakeContextData ( TArgs &&...  Args)
inline

◆ operator<()

bool FAnimTickRecord::operator< ( const FAnimTickRecord Other) const
inline

This can be used with the Sort() function on a TArray of FAnimTickRecord to sort from higher leader score

Member Data Documentation

◆ [union]

union { ... } FAnimTickRecord

◆ bActiveContext

bool FAnimTickRecord::bActiveContext = true

◆ bCanUseMarkerSync

bool FAnimTickRecord::bCanUseMarkerSync = false

◆ bIsEvaluator

bool FAnimTickRecord::bIsEvaluator = false

◆ bIsExclusiveLeader

bool FAnimTickRecord::bIsExclusiveLeader = false

◆ BlendFilter

FBlendFilter* FAnimTickRecord::BlendFilter

◆ BlendSampleDataCache

TArray<FBlendSampleData>* FAnimTickRecord::BlendSampleDataCache

◆ [struct]

struct { ... } FAnimTickRecord::BlendSpace

◆ BlendSpacePositionX

float FAnimTickRecord::BlendSpacePositionX

◆ BlendSpacePositionY

float FAnimTickRecord::BlendSpacePositionY

◆ bLooping

bool FAnimTickRecord::bLooping = false

◆ bOverridePositionWhenJoiningSyncGroupAsLeader

bool FAnimTickRecord::bOverridePositionWhenJoiningSyncGroupAsLeader = false

◆ bRequestedInertialization

bool FAnimTickRecord::bRequestedInertialization = false

◆ bTeleportToTime

bool FAnimTickRecord::bTeleportToTime

◆ ContextData

◆ CurrentPosition

float FAnimTickRecord::CurrentPosition

◆ DeltaTimeRecord

FDeltaTimeRecord* FAnimTickRecord::DeltaTimeRecord = nullptr

◆ EffectiveBlendWeight

float FAnimTickRecord::EffectiveBlendWeight = 0.0f

◆ LeaderScore

float FAnimTickRecord::LeaderScore = 0.0f

◆ MarkersPassedThisTick

TArray<FPassedMarker>* FAnimTickRecord::MarkersPassedThisTick

◆ MarkerTickRecord

FMarkerTickRecord* FAnimTickRecord::MarkerTickRecord = nullptr

◆ MirrorDataTable

const UMirrorDataTable* FAnimTickRecord::MirrorDataTable = nullptr

◆ [struct]

struct { ... } FAnimTickRecord::Montage

◆ PlayRateMultiplier

float FAnimTickRecord::PlayRateMultiplier = 1.0f

◆ RootMotionWeightModifier

float FAnimTickRecord::RootMotionWeightModifier = 1.0f

◆ SourceAsset

TObjectPtr<class UAnimationAsset> FAnimTickRecord::SourceAsset = nullptr

◆ TimeAccumulator

float* FAnimTickRecord::TimeAccumulator = nullptr

◆ TriangulationIndex

int32 FAnimTickRecord::TriangulationIndex

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