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

#include <AnimationRecordingSettings.h>

Public Member Functions

 FAnimationRecordingSettings ()
 

Public Attributes

bool bRecordInWorldSpace
 
bool bRemoveRootAnimation
 
bool bAutoSaveAsset
 
FFrameRate SampleFrameRate
 
float Length
 
EAnimInterpolationType Interpolation
 
TEnumAsByte< ERichCurveInterpModeInterpMode
 
TEnumAsByte< ERichCurveTangentModeTangentMode
 
bool bCheckDeltaTimeAtBeginning
 
bool bRecordTransforms
 
bool bRecordMorphTargets
 
bool bRecordAttributeCurves
 
bool bRecordMaterialCurves
 
bool bTransactRecording
 
TArray< FString > IncludeAnimationNames
 
TArray< FString > ExcludeAnimationNames
 

Static Public Attributes

static ENGINE_API const FFrameRate DefaultSampleFrameRate = FFrameRate(30, 1)
 
static ENGINE_API const float DefaultMaximumLength = 1.0f * 60.0f
 
static ENGINE_API const float UnboundedMaximumLength = 0.0f
 

Detailed Description

Settings describing how to record an animation

Constructor & Destructor Documentation

◆ FAnimationRecordingSettings()

FAnimationRecordingSettings::FAnimationRecordingSettings ( )
inline

Member Data Documentation

◆ bAutoSaveAsset

bool FAnimationRecordingSettings::bAutoSaveAsset

Whether to auto-save asset when recording is completed. Defaults to false

◆ bCheckDeltaTimeAtBeginning

bool FAnimationRecordingSettings::bCheckDeltaTimeAtBeginning

Whether to check DeltaTime at recording for pauses, turned off for TakeRecorder

◆ bRecordAttributeCurves

bool FAnimationRecordingSettings::bRecordAttributeCurves

Whether or not to record parameter curves

◆ bRecordInWorldSpace

bool FAnimationRecordingSettings::bRecordInWorldSpace

Whether to record animation in world space, defaults to true

◆ bRecordMaterialCurves

bool FAnimationRecordingSettings::bRecordMaterialCurves

Whether or not to record material curves

◆ bRecordMorphTargets

bool FAnimationRecordingSettings::bRecordMorphTargets

Whether or not to record morph targets

◆ bRecordTransforms

bool FAnimationRecordingSettings::bRecordTransforms

Whether or not to record transforms

◆ bRemoveRootAnimation

bool FAnimationRecordingSettings::bRemoveRootAnimation

Whether to remove the root bone transform from the animation

◆ bTransactRecording

bool FAnimationRecordingSettings::bTransactRecording

Whether or not to transact recording changes

◆ DefaultMaximumLength

const float FAnimationRecordingSettings::DefaultMaximumLength = 1.0f * 60.0f
static

1 minute default length

◆ DefaultSampleFrameRate

const FFrameRate FAnimationRecordingSettings::DefaultSampleFrameRate = FFrameRate(30, 1)
static

30Hz default sample frame rate

30Hz default sample rate

◆ ExcludeAnimationNames

TArray<FString> FAnimationRecordingSettings::ExcludeAnimationNames

Exclude all animation bones/curves that match this list

◆ IncludeAnimationNames

TArray<FString> FAnimationRecordingSettings::IncludeAnimationNames

Include only the animation bones/curves that match this list

◆ InterpMode

TEnumAsByte<ERichCurveInterpMode> FAnimationRecordingSettings::InterpMode

Interpolation mode for the recorded keys.

◆ Interpolation

EAnimInterpolationType FAnimationRecordingSettings::Interpolation

This defines how values between keys are calculated for transforms.

◆ Length

float FAnimationRecordingSettings::Length

Maximum length of the animation recorded (in seconds). If zero the animation will keep on recording until stopped.

◆ SampleFrameRate

FFrameRate FAnimationRecordingSettings::SampleFrameRate

Sample rate of the recorded animation

◆ TangentMode

TEnumAsByte<ERichCurveTangentMode> FAnimationRecordingSettings::TangentMode

Tangent mode for the recorded keys.

◆ UnboundedMaximumLength

const float FAnimationRecordingSettings::UnboundedMaximumLength = 0.0f
static

Length used to specify unbounded


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