1. Epic GamesDeveloper
  3. UAnimationSettings

UAnimationSettings

Default animation settings.

API > API/Runtime > API/Runtime/Engine

Default animation settings.

   
Name UAnimationSettings
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimationSettings.h
Include Path #include "Animation/AnimationSettings.h"

Syntax

UCLASS (Config=Engine, defaultconfig, Meta=(DisplayName="Animation"), MinimalAPI)  
class UAnimationSettings : public UDeveloperSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimationSettings ( const FObjectInitializer& ObjectInitializer
)

   Animation/AnimationSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AttributeBlendModes TMap< FName, ECustomAttributeBlendType > Animation Attribute specific blend types (by name) Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=AnimationAttributes
bEnablePerformanceLog bool If true, recompression will log performance information Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=Performance
bEnforceSupportedFrameRates bool Whether to enforce the project to only use entries from SupportedFrameRates for the animation assets, if disable will warn instead Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=AnimationData
bFirstRecompressUsingCurrentOrDefault bool If true, then the animation will be first recompressed with its current compressor if non-NULL, or with the global default compressor (specified in the engine ini) Also known as "Run Current Default Compressor" Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=Compression
bForceBelowThreshold bool If true and the existing compression error is greater than Alternative Compression Threshold, then any compression technique (even one that increases the size) with a lower error will be used until it falls below the threshold Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=Compression
BoneCustomAttributesNames TArray< FCustomAttributeSetting > List of animation attribute names to import directly on their corresponding bone names. Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=AnimationAttributes
  • Meta=(DisplayName="Bone Animation Attributes names")
BoneNamesWithCustomAttributes TArray< FString > List of bone names for which all animation attributes are directly imported on the bone. Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=AnimationAttributes
  • Meta=(DisplayName="Bone names with Animation Attributes")
BoneTimecodeCustomAttributeNameSettings FTimecodeCustomAttributeNameSettings Names that identify bone animation attributes representing the individual components of a timecode and a subframe along with a take name. Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=AnimationAttributes
  • Meta=(DisplayName="Bone Timecode Animation Attribute name settings")
bRaiseMaxErrorToExisting bool If true and the existing compression error is greater than Alternative Compression Threshold, then Alternative Compression Threshold will be effectively raised to the existing error level Animation/AnimationSettings.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="No longer used.")
bStripAnimationDataOnDedicatedServer bool If true, animation track data will be stripped from dedicated server cooked data Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=Performance
bTickAnimationOnSkeletalMeshInit bool If true, pre-4.19 behavior of zero-ticking animations during skeletal mesh init Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=Performance
CompressCommandletVersion int32 Compression version for recompress commandlet, bump this to trigger full recompressed, otherwise only new imported animations will be recompressed Animation/AnimationSettings.h
  • Config
  • VisibleAnywhere
  • Category=Compression
DefaultAttributeBlendMode ECustomAttributeBlendType Default Animation Attribute blend type Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=AnimationAttributes
DefaultFrameRate FFrameRate Project specific default frame-rate used when (re)initializing any animation based data Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=AnimationData
ForceRecompression bool If true, this will forcibly recompress every animation, this should not be checked in enabled Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=Compression
KeyEndEffectorsMatchNameArray TArray< FString > List of bone names to treat with higher precision, in addition to any bones with sockets Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=Compression
MirrorFindReplaceExpressions TArray< FMirrorFindReplaceExpression > Find and Replace Expressions used for mirroring Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=Mirroring
TransformAttributeNames TArray< FString > Names to match against when importing FBX node transform curves as attributes (can use ? and * wildcards) Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • Category=AnimationAttributes
UserDefinedStructAttributes TArray< TSoftObjectPtr< UUserDefinedStruct > > Register user defined structs as animation attributes Animation/AnimationSettings.h
  • Config
  • EditAnywhere
  • DisplayName="User Defined Struct Animation Attributes (Runtime only, Non-blendable)"
  • Category=AnimationAttributes
  • Meta=(AllowedClasses="/Script/Engine.UserDefinedStruct")

Functions

Public

Name Remarks Include Path Unreal Specifiers
Gets the complete list of bone animation attribute names to consider for import. Animation/AnimationSettings.h
  • BlueprintPure
  • Category=AnimationAttributes

const FFrameRate & GetDefaultFrameRate()

 Returns the project specific default frame-rate Animation/AnimationSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Animation/AnimationSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static UAnimationSettings * Get()

   Animation/AnimationSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page