UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AnimationSettings.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3/*=============================================================================
4 AnimationSettings.h: Declares the AnimationSettings class.
5=============================================================================*/
6
7#pragma once
8
9#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_5
10#include "CoreMinimal.h"
14#endif
16#include "CustomAttributes.h"
17#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_5
18#include "MirrorDataTable.h"
20#endif
21#include "AnimationSettings.generated.h"
22
26
30UCLASS(config=Engine, defaultconfig, meta=(DisplayName="Animation"), MinimalAPI)
32{
34
35
36 UPROPERTY(config, VisibleAnywhere, Category = Compression)
37 int32 CompressCommandletVersion;
38
40 UPROPERTY(config, EditAnywhere, Category = Compression)
41 TArray<FString> KeyEndEffectorsMatchNameArray;
42
44 UPROPERTY(config, EditAnywhere, Category = Compression)
45 bool ForceRecompression;
46
48 UPROPERTY(config, EditAnywhere, Category = Compression)
49 bool bForceBelowThreshold;
50
54 UPROPERTY(config, EditAnywhere, Category = Compression)
55 bool bFirstRecompressUsingCurrentOrDefault;
56
58 UE_DEPRECATED(5.1, "This is being removed because it is unused")
59 UPROPERTY(config /*, EditAnywhere, Category = Compression*/, meta = (DeprecatedProperty, DeprecationMessage = "No longer used."))
60 bool bRaiseMaxErrorToExisting;
61
63 UPROPERTY(config, EditAnywhere, Category = Performance)
64 bool bEnablePerformanceLog;
65
67 UPROPERTY(config, EditAnywhere, Category = Performance)
68 bool bStripAnimationDataOnDedicatedServer;
69
71 UPROPERTY(config, EditAnywhere, Category = Performance)
72 bool bTickAnimationOnSkeletalMeshInit;
73
76 UPROPERTY(config, EditAnywhere, Category = AnimationAttributes, meta=(DisplayName="Bone Timecode Animation Attribute name settings"))
77 FTimecodeCustomAttributeNameSettings BoneTimecodeCustomAttributeNameSettings;
78
80 UPROPERTY(config, EditAnywhere, Category = AnimationAttributes, meta=(DisplayName="Bone Animation Attributes names"))
81 TArray<FCustomAttributeSetting> BoneCustomAttributesNames;
82
85 UFUNCTION(BlueprintPure, Category = AnimationAttributes)
86 ENGINE_API TArray<FString> GetBoneCustomAttributeNamesToImport() const;
87
89 UPROPERTY(config, EditAnywhere, Category = AnimationAttributes, meta=(DisplayName="Bone names with Animation Attributes"))
90 TArray<FString> BoneNamesWithCustomAttributes;
91
93 UPROPERTY(config, EditAnywhere, Category = AnimationAttributes)
95
97 UPROPERTY(config, EditAnywhere, Category = AnimationAttributes)
98 ECustomAttributeBlendType DefaultAttributeBlendMode;
99
101 UPROPERTY(config, EditAnywhere, Category = AnimationAttributes)
102 TArray<FString> TransformAttributeNames;
103
105 UPROPERTY(config, EditAnywhere, DisplayName="User Defined Struct Animation Attributes (Runtime only, Non-blendable)", Category = AnimationAttributes, meta=(AllowedClasses="/Script/Engine.UserDefinedStruct"))
107
109 UPROPERTY(config, EditAnywhere, Category = Mirroring)
110 TArray<FMirrorFindReplaceExpression> MirrorFindReplaceExpressions;
111
113 UPROPERTY(config, EditAnywhere, Category = AnimationData)
114 FFrameRate DefaultFrameRate;
115
117 UPROPERTY(config, EditAnywhere, Category = AnimationData)
118 bool bEnforceSupportedFrameRates;
119public:
120 static UAnimationSettings * Get() { return CastChecked<UAnimationSettings>(UAnimationSettings::StaticClass()->GetDefaultObject()); }
121
123 ENGINE_API const FFrameRate& GetDefaultFrameRate() const;
124
125#if WITH_EDITOR
126 ENGINE_API virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
127#endif // WITH_EDITOR
128};
#define UE_DEPRECATED(Version, Message)
Definition CoreMiscDefines.h:302
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
ECustomAttributeBlendType
Definition CustomAttributes.h:19
#define UPROPERTY(...)
UObject definition macros.
Definition ObjectMacros.h:744
#define UFUNCTION(...)
Definition ObjectMacros.h:745
#define GENERATED_UCLASS_BODY(...)
Definition ObjectMacros.h:768
#define UCLASS(...)
Definition ObjectMacros.h:776
Definition Engine.Build.cs:7
Definition Array.h:670
Definition UnrealString.h.inl:34
Definition AnimationSettings.h:32
static UAnimationSettings * Get()
Definition AnimationSettings.h:120
Definition DeveloperSettings.h:24
Definition UserDefinedStruct.h:61
Definition CustomAttributes.h:28
Definition FrameRate.h:21
Definition MirrorDataTable.h:72
Definition UnrealType.h:6865
Definition CustomAttributes.h:45