1. Epic GamesDeveloper
  3. UAnimationBlueprintLibrary

UAnimationBlueprintLibrary

Blueprint library for altering and analyzing animation / skeletal data

API > API/Editor > API/Editor/AnimationBlueprintLibrary

Blueprint library for altering and analyzing animation / skeletal data

   
Name UAnimationBlueprintLibrary
Type class
Header File /Engine/Source/Editor/AnimationBlueprintLibrary/Public/AnimationBlueprintLibrary.h
Include Path #include "AnimationBlueprintLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="AnimationLibrary"))  
class UAnimationBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static UAnimNotify * AddAnimationNotifyEvent ( UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName,
float StartTime,
TSubclassOf< UAnimNotify > NotifyClass
)

 Adds an Animation Notify Event to Notify track in the given Animation with the given Notify creation data AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static void AddAnimationNotifyEventObject ( UAnimSequenceBase* AnimationSequenceBase,
float StartTime,
UAnimNotify* Notify,
FName NotifyTrackName
)

 Adds an the specific Animation Notify to the Animation Sequence (requires Notify's outer to be the Animation Sequence) AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static UAnimNotifyState * AddAnimationNotifyStateEvent ( UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName,
float StartTime,
float Duration,
TSubclassOf< UAnimNotifyState > NotifyStateClass
)

 Adds an Animation Notify State Event to Notify track in the given Animation with the given Notify State creation data AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static void AddAnimationNotifyStateEventObject ( UAnimSequenceBase* AnimationSequenceBase,
float StartTime,
float Duration,
UAnimNotifyState* NotifyState,
FName NotifyTrackName
)

 Adds an the specific Animation Notify State to the Animation Sequence (requires Notify State's outer to be the Animation Sequence) AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static void AddAnimationNotifyTrack ( UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName,
FLinearColor TrackColor
)

 Adds an Animation Notify Track to the Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|AnimationNotifies"

static void AddAnimationSyncMarker ( UAnimSequence* AnimationSequence,
FName MarkerName,
float Time,
FName NotifyTrackName
)

 Adds an Animation Sync Marker to Notify track in the given Animation with the corresponding Marker Name and Time AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MarkerSyncing"

static void AddCurve ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
ERawCurveTrackTypes CurveType,
bool bMetaDataCurve
)

 Adds an Animation Curve by Type and Name to the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static bool AddCurveInternal ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
int32 CurveFlags,
ERawCurveTrackTypes SupportedCurveType
)

 Returns true if successfully added, false if it was already existing. AnimationBlueprintLibrary.h  

static void AddCurveKeysInternal ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
const TArray< float >& Times,
const TArray< DataType >& KeyData
)

 Curve helper functions. AnimationBlueprintLibrary.h  

static void AddFloatCurveKey ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
const float Time,
const float Value
)

 Adds a Float Key to the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void AddFloatCurveKeys ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
const TArray< float >& Times,
const TArray< float >& Values
)

 Adds a multiple of Float Keys to the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void AddMetaData ( UAnimationAsset* AnimationAsset,
TSubclassOf< UAnimMetaData > MetaDataClass,
UAnimMetaData*& MetaDataInstance
)

 Creates and Adds an instance of the specified MetaData Class to the given Animation Asset AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MetaData"

static void AddMetaDataObject ( UAnimationAsset* AnimationAsset,
UAnimMetaData* MetaDataObject
)

 Adds an instance of the specified MetaData Class to the given Animation Asset (requires MetaDataObject's outer to be the Animation Asset) AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MetaData"

static void AddNodeAssetOverride ( UAnimBlueprint* AnimBlueprint,
const UAnimationAsset* Target,
UAnimationAsset* Override,
bool bPrintAppliedOverrides
)

 Adds an Animation Asset override for the provided AnimationBlueprint, replacing any instance of Target with Override AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(ScriptMethod)

static void AddTransformationCurveKey ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
const float Time,
const FTransform& Transform
)

 Adds a Transformation Key to the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void AddTransformationCurveKeys ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
const TArray< float >& Times,
const TArray< FTransform >& Transforms
)

 Adds a multiple of Transformation Keys to the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void AddVectorCurveKey ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
const float Time,
const FVector Vector
)

 Adds a Vector Key to the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void AddVectorCurveKeys ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
const TArray< float >& Times,
const TArray< FVector >& Vectors
)

 Adds a multiple of Vector Keys to the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void AddVirtualBone ( const UAnimSequence* AnimationSequence,
FName SourceBoneName,
FName TargetBoneName,
FName& VirtualBoneName
)

 Adds a Virtual Bone between the Source and Target Bones to the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|VirtualBones"

static bool ContainsMetaDataOfClass ( const UAnimationAsset* AnimationAsset,
TSubclassOf< UAnimMetaData > MetaDataClass
)

 Checks whether or not the given Animation Asset contains Meta Data Instance of the specified Meta Data Class AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|MetaData"

static void CopyAnimationCurveNamesToSkeleton ( USkeleton* OldSkeleton,
USkeleton* NewSkeleton,
UAnimSequenceBase* SequenceBase,
ERawCurveTrackTypes CurveType
)

 Ensures that any curve names that do not exist on the NewSkeleton are added to it, in which case the SmartName on the actual curve itself will also be updated AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"
  • Meta=(DeprecatedFunction, DeprecationMessage="It is no longer necessary to copy curve names to the skeleton. If metadata is required to be updated, please use the metadata setting APIs.")

static void CopyAnimNotifiesFromSequence ( UAnimSequenceBase* SourceAnimationSequenceBase,
UAnimSequenceBase* DestinationAnimationSequenceBase,
bool bDeleteExistingNotifies
)

 Copies animation notifies from Src Animation Sequence to Dest. AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static bool DoesBoneCurveNameExistInternal ( USkeleton* Skeleton,
FName BoneName
)

   AnimationBlueprintLibrary.h  

static void DoesBoneNameExist ( UAnimSequence* AnimationSequence,
FName BoneName,
bool& bExists
)

 Checks whether or not the given Bone Name exist on the Skeleton referenced by the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Skeleton"

static bool DoesBoneNameExistInternal ( USkeleton* Skeleton,
FName BoneName
)

   AnimationBlueprintLibrary.h  

static bool DoesCurveExist ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
ERawCurveTrackTypes CurveType
)

 Checks whether or not the given Curve Name exist on the Skeleton referenced by the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static bool DoesSmartNameExist ( UAnimSequence* AnimationSequence,
FName Name
)

   AnimationBlueprintLibrary.h  

static bool DoesVirtualBoneNameExistInternal ( USkeleton* Skeleton,
FName BoneName
)

   AnimationBlueprintLibrary.h  

static bool EvaluateBoneTimecodeAndSlateAttributesAtTime ( const FName BoneName,
const UAnimSequenceBase* AnimationSequenceBase,
const float EvalTime,
FQualifiedFrameTime& OutQualifiedFrameTime,
FString& Slate
)

 Evaluates timecode attributes (e.g. "TCFrame", "TCSecond", etc.) and TCSlate of the root bone and returns the resulting qualified frame time. AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static bool EvaluateRootBoneTimecodeAttributesAtTime ( const UAnimSequenceBase* AnimationSequenceBase,
const float EvalTime,
FQualifiedFrameTime& OutQualifiedFrameTime
)

 Evaluates timecode attributes (e.g. "TCFrame", "TCSecond", etc.) of the root bone and returns the resulting qualified frame time. AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static bool EvaluateRootBoneTimecodeSubframeAttributeAtTime ( const UAnimSequenceBase* AnimationSequenceBase,
const float EvalTime,
float& OutSubframe
)

 Evaluates the subframe timecode attribute (e.g. "TCSubframe") of the root bone and returns the resulting value. AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static FTransform ExtractRootTrackTransform ( const UAnimSequenceBase* AnimationSequenceBase,
float Time
)

 Gets the root transform from the raw animation at Time AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Animation"

static void FinalizeBoneAnimation ( UAnimSequence* AnimationSequence
)

 Apply all the changes made to Bone Tracks to Finalize. AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"
  • Meta=(DeprecatedFunction, DeprecationMessage="FinalizeBoneAnimation has been deprecated, use UAnimDataController instead")

static FName FindBoneNameWithTimecodeAttributes ( const UAnimSequenceBase* AnimSequenceBase
)

 Given an animation sequence determine if any bones in that animation sequence has timecode attribute data. AnimationBlueprintLibrary.h  

static void FindBonePathToRoot ( const UAnimSequenceBase* AnimationSequenceBase,
FName BoneName,
TArray< FName >& BonePath
)

 Finds the Bone Path from the given Bone to the Root Bone AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static void GetAdditiveAnimationType ( const UAnimSequence* AnimationSequence,
TEnumAsByte< enum EAdditiveAnimationType >& AdditiveAnimationType
)

 Additive. AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Additive"

static void GetAdditiveBasePoseType ( const UAnimSequence* AnimationSequence,
TEnumAsByte< enum EAdditiveBasePoseType >& AdditiveBasePoseType
)

 Retrieves the Additive Base Pose type for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Additive"

static void GetAnimationCurveNames ( const UAnimSequenceBase* AnimationSequenceBase,
ERawCurveTrackTypes CurveType,
TArray< FName >& CurveNames
)

 Retrieves the Names of the individual float curves for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Animation"

static void GetAnimationGraphs ( UAnimBlueprint* AnimationBlueprint,
TArray< UAnimationGraph* >& AnimationGraphs
)

 Returns all Animation Graphs contained by the provided Animation Blueprint AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(ScriptMethod)

static void GetAnimationInterpolationType ( const UAnimSequence* AnimationSequence,
EAnimInterpolationType& InterpolationType
)

 Retrieves the Animation Interpolation type for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Interpolation"

static void GetAnimationNotifyEventNames ( const UAnimSequenceBase* AnimationSequenceBase,
TArray< FName >& EventNames
)

 Retrieves all Unique Animation Notify Events found within the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static void GetAnimationNotifyEvents ( const UAnimSequenceBase* AnimationSequenceBase,
TArray< FAnimNotifyEvent >& NotifyEvents
)

 Retrieves all Animation Notify Events found within the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static void GetAnimationNotifyEventsForTrack ( const UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName,
TArray< FAnimNotifyEvent >& Events
)

 Retrieves all Animation Notify Events for the given Notify Track Name from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static void GetAnimationNotifyTrackNames ( const UAnimSequenceBase* AnimationSequenceBase,
TArray< FName >& TrackNames
)

 Retrieves all Unique Animation Notify Track Names found within the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|AnimationNotifies"

static void GetAnimationSyncMarkers ( const UAnimSequence* AnimationSequence,
TArray< FAnimSyncMarker >& Markers
)

 Retrieves all the Animation Sync Markers for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|MarkerSyncing"

static void GetAnimationSyncMarkersForTrack ( const UAnimSequence* AnimationSequence,
FName NotifyTrackName,
TArray< FAnimSyncMarker >& Markers
)

 Retrieves all Animation Sync Markers for the given Notify Track Name from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|MarkerSyncing"

static void GetAnimationTrackNames ( const UAnimSequenceBase* AnimationSequenceBase,
TArray< FName >& TrackNames
)

 Retrieves the Names of the individual ATracks for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Animation"

static float GetAnimNotifyEventDuration ( const FAnimNotifyEvent& NotifyEvent
)

 Returns the duration for a NotifyEvent, only non-zero for Anim Notify States AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|AnimationNotifies"

static float GetAnimNotifyEventTriggerTime ( const FAnimNotifyEvent& NotifyEvent
)

 Returns the actual trigger time for a NotifyEvent AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|AnimationNotifies"

static void GetBoneCompressionSettings ( const UAnimSequence* AnimationSequence,
UAnimBoneCompressionSettings*& CompressionSettings
)

 Retrieves the Bone Compression Settings for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Compression"

static void GetBonePoseForFrame ( const UAnimSequenceBase* AnimationSequenceBase,
FName BoneName,
int32 Frame,
bool bExtractRootMotion,
FTransform& Pose
)

 Retrieves Bone Pose data for the given Bone Name at the specified Frame from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Pose"

static void GetBonePoseForTime ( const UAnimSequenceBase* AnimationSequenceBase,
FName BoneName,
float Time,
bool bExtractRootMotion,
FTransform& Pose
)

 Retrieves Bone Pose data for the given Bone Name at the specified Time from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Pose"

static void GetBonePosesForFrame ( const UAnimSequenceBase* AnimationSequenceBase,
TArray< FName > BoneNames,
int32 Frame,
bool bExtractRootMotion,
TArray< FTransform >& Poses,
const USkeletalMesh* PreviewMesh
)

 Retrieves Bone Pose data for the given Bone Names at the specified Frame from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Pose"

static void GetBonePosesForTime ( const UAnimSequenceBase* AnimationSequenceBase,
TArray< FName > BoneNames,
float Time,
bool bExtractRootMotion,
TArray< FTransform >& Poses,
const USkeletalMesh* PreviewMesh
)

 Retrieves Bone Pose data for the given Bone Names at the specified Time from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Pose"

static void GetCurveCompressionSettings ( const UAnimSequence* AnimationSequence,
UAnimCurveCompressionSettings*& CompressionSettings
)

 Retrieves the Curve Compression Settings for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Compression"

static void GetCurveKeysInternal ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
TArray< float >& Times,
TArray< DataType >& KeyData
)

   AnimationBlueprintLibrary.h  

static void GetFloatKeys ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
TArray< float >& Times,
TArray< float >& Values
)

 Retrieves, a multiple of, Float Key(s) from the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static float GetFloatValueAtTime ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
float Time
)

 Retrieves an evaluated float value for a given time from the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void GetFrameAtTime ( const UAnimSequenceBase* AnimationSequenceBase,
const float Time,
int32& Frame
)

 Retrieves the Frame Index at the specified Time Value for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static void GetMetaData ( const UAnimationAsset* AnimationAsset,
TArray< UAnimMetaData* >& MetaData
)

 Retrieves all Meta Data Instances from the given Animation Asset AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|MetaData"

static void GetMetaDataOfClass ( const UAnimationAsset* AnimationAsset,
TSubclassOf< UAnimMetaData > MetaDataClass,
TArray< UAnimMetaData* >& MetaDataOfClass
)

 Retrieves all Meta Data Instances from the given Animation Asset AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|MetaData"

static void GetMontageSlotNames ( const UAnimMontage* AnimationMontage,
TArray< FName >& SlotNames
)

 Retrieves the Names of the Animation Slots used in the given Montage AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Montage"

static void GetNodesOfClass ( UAnimBlueprint* AnimationBlueprint,
TSubclassOf< UAnimGraphNode_Base > NodeClass,
TArray< UAnimGraphNode_Base* >& GraphNodes,
bool bIncludeChildClasses
)

 Returns all Animation Graph Nodes of the provided Node Class contained by the Animation Blueprint AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(ScriptMethod)

static const FAnimNotifyTrack & GetNotifyTrackByName ( const UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName
)

   AnimationBlueprintLibrary.h  

static void GetNumFrames ( const UAnimSequenceBase* AnimationSequenceBase,
int32& NumFrames
)

 Retrieves the number of animation frames for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Meta=(AutoCreateRefTerm="AnimationSequence")
  • Category="AnimationBlueprintLibrary|Animation"

static void GetNumKeys ( const UAnimSequenceBase* AnimationSequenceBase,
int32& NumKeys
)

 Retrieves the number of animation keys for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Meta=(AutoCreateRefTerm="AnimationSequence")
  • Category="AnimationBlueprintLibrary|Animation"

static void GetRateScale ( const UAnimSequenceBase* AnimationSequenceBase,
float& RateScale
)

 Retrieves the (Play) Rate Scale of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Animation"

static const FRawAnimSequenceTrack & GetRawAnimationTrackByName ( const UAnimSequenceBase* AnimationSequenceBase,
const FName TrackName
)

   AnimationBlueprintLibrary.h  

static void GetRawTrackData ( const UAnimSequenceBase* AnimationSequenceBase,
const FName TrackName,
TArray< FVector >& PositionKeys,
TArray< FQuat >& RotationKeys,
TArray< FVector >& ScalingKeys
)

 Retrieves the Raw Animation Data for the given Animation Track Name and Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|RawTrackData"

static void GetRawTrackPositionData ( const UAnimSequenceBase* AnimationSequenceBase,
const FName TrackName,
TArray< FVector >& PositionData
)

 Retrieves the Raw Translation Animation Data for the given Animation Track Name and Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|RawTrackData"

static void GetRawTrackRotationData ( const UAnimSequenceBase* AnimationSequenceBase,
const FName TrackName,
TArray< FQuat >& RotationData
)

 Retrieves the Raw Rotation Animation Data for the given Animation Track Name and Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|RawTrackData"

static void GetRawTrackScaleData ( const UAnimSequenceBase* AnimationSequenceBase,
const FName TrackName,
TArray< FVector >& ScaleData
)

 Retrieves the Raw Scale Animation Data for the given Animation Track Name and Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|RawTrackData"

static void GetRootMotionLockType ( const UAnimSequence* AnimationSequence,
TEnumAsByte< ERootMotionRootLock::Type >& LockType
)

 Retrieves the Root Motion Lock Type for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|RootMotion"

static void GetSequenceLength ( const UAnimSequenceBase* AnimationSequenceBase,
float& Length
)

 Retrieves the Length of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Animation"

static void GetTimeAtFrame ( const UAnimSequenceBase* AnimationSequenceBase,
const int32 Frame,
float& Time
)

 Retrieves the Time Value at the specified Frame Indexfor the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static float GetTimeAtFrameInternal ( const UAnimSequenceBase* AnimationSequenceBase,
const int32 Frame
)

   AnimationBlueprintLibrary.h  

static int32 GetTrackIndexForAnimationNotifyTrackName ( const UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName
)

   AnimationBlueprintLibrary.h  

static void GetTransformationKeys ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
TArray< float >& Times,
TArray< FTransform >& Values
)

 Retrieves, a multiple of, Transformation Key(s) from the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void GetUniqueMarkerNames ( const UAnimSequence* AnimationSequence,
TArray< FName >& MarkerNames
)

 Retrieves all the Unique Names for the Animation Sync Markers contained by the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|MarkerSyncing"

static void GetVariableFrameStrippingSettings ( const UAnimSequence* AnimationSequence,
UVariableFrameStrippingSettings*& VariableFrameStrippingSettings
)

 Retrieves the Variable Frame Stripping Settings for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Compression"

static void GetVectorKeys ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
TArray< float >& Times,
TArray< FVector >& Values
)

 Retrieves, a multiple of, Vector Key(s) from the specified Animation Curve inside of the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static bool IsRootMotionEnabled ( const UAnimSequence* AnimationSequence
)

 Checks whether or not Root Motion is Enabled for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|RootMotion"

static bool IsRootMotionLockForced ( const UAnimSequence* AnimationSequence
)

 Checks whether or not Root Motion locking is Forced for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|RootMotion"

static bool IsValidAnimationSyncMarkerName ( const UAnimSequence* AnimationSequence,
FName MarkerName
)

 Checks whether or not the given Marker Name is a valid Animation Sync Marker Name AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static bool IsValidAnimNotifyTrackName ( const UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName
)

 Checks whether or not the given Track Name is a valid Animation Notify Track in the Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static bool IsValidRawAnimationTrackName ( const UAnimSequenceBase* AnimationSequenceBase,
const FName TrackName
)

 Checks whether or not the given Animation Track Name is contained within the Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Helpers"

static void IsValidTime ( const UAnimSequenceBase* AnimationSequenceBase,
const float Time,
bool& IsValid
)

 Checks whether or not the given Time Value lies within the given Animation Sequence's Length AnimationBlueprintLibrary.h
  • BlueprintPure
  • Category="AnimationBlueprintLibrary|Helpers"

static bool IsValidTimeInternal ( const UAnimSequenceBase* AnimationSequenceBase,
const float Time
)

   AnimationBlueprintLibrary.h  

static void RemoveAllAnimationNotifyTracks ( UAnimSequenceBase* AnimationSequenceBase
)

 Removes All Animation Notify Tracks from Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|AnimationNotifies"

static void RemoveAllAnimationSyncMarkers ( UAnimSequence* AnimationSequence
)

 Removes All Animation Sync Markers found within the Animation Sequence, and returns the number of removed instances AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MarkerSyncing"

static void RemoveAllBoneAnimation ( UAnimSequence* AnimationSequence
)

 Removes all Animation Bone Track Data from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void RemoveAllCurveData ( UAnimSequenceBase* AnimationSequenceBase
)

 Removes all Animation Curve Data from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton) AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static void RemoveAllMetaData ( UAnimationAsset* AnimationAsset
)

 Removes all Meta Data from the given Animation Asset AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MetaData"

static void RemoveAllVirtualBones ( const UAnimSequence* AnimationSequence
)

 Removes all Virtual Bones from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|VirtualBones"

static int32 RemoveAnimationNotifyEventsByName ( UAnimSequenceBase* AnimationSequenceBase,
FName NotifyName
)

 Removes Animation Notify Events found by Name within the Animation Sequence, and returns the number of removed name instances AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static int32 RemoveAnimationNotifyEventsByTrack ( UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName
)

 Removes Animation Notify Events found by Track within the Animation Sequence, and returns the number of removed name instances AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static void RemoveAnimationNotifyTrack ( UAnimSequenceBase* AnimationSequenceBase,
FName NotifyTrackName
)

 Removes an Animation Notify Track from Animation Sequence by Name AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|AnimationNotifies"

static int32 RemoveAnimationSyncMarkersByName ( UAnimSequence* AnimationSequence,
FName MarkerName
)

 Removes All Animation Sync Marker found within the Animation Sequence whose name matches MarkerName, and returns the number of removed instances AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MarkerSyncing"

static int32 RemoveAnimationSyncMarkersByTrack ( UAnimSequence* AnimationSequence,
FName NotifyTrackName
)

 Removes All Animation Sync Marker found within the Animation Sequence that belong to the specific Notify Track, and returns the number of removed instances AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MarkerSyncing"

static void RemoveBoneAnimation ( UAnimSequence* AnimationSequence,
FName BoneName,
bool bIncludeChildren,
bool bFinalize
)

 Removes an Animation Curve by Name from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton) AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Bones"

static void RemoveBoneSelectiveAnimation ( UAnimSequence* AnimationSequence,
FName BoneName,
TArray< FName > ChildrenExcluded,
bool bIncludeChildren,
bool bExcludeRecursively,
bool bFinalize
)

 Removes an Animation Curve by Name from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton) AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Bones"
  • Meta=(AutoCreateRefTerm="ChildrenExcluded")

static void RemoveCurve ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
bool bRemoveNameFromSkeleton
)

 Removes an Animation Curve by Name from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton) AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Curves"

static bool RemoveCurveInternal ( UAnimSequenceBase* AnimationSequenceBase,
FName CurveName,
ERawCurveTrackTypes SupportedCurveType
)

   AnimationBlueprintLibrary.h  

static void RemoveMetaData ( UAnimationAsset* AnimationAsset,
UAnimMetaData* MetaDataObject
)

 Removes the specified Meta Data Instance from the given Animation Asset AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MetaData"

static void RemoveMetaDataOfClass ( UAnimationAsset* AnimationAsset,
TSubclassOf< UAnimMetaData > MetaDataClass
)

 Removes all Meta Data Instance of the specified Class from the given Animation Asset AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|MetaData"

static void RemoveVirtualBone ( const UAnimSequence* AnimationSequence,
FName VirtualBoneName
)

 Removes a Virtual Bone with the specified Bone Name from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|VirtualBones"

static void RemoveVirtualBones ( const UAnimSequence* AnimationSequence,
TArray< FName > VirtualBoneNames
)

 Removes Virtual Bones with the specified Bone Names from the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|VirtualBones"

static void ReplaceAnimNotifies ( UAnimSequenceBase* AnimationSequenceBase,
TSubclassOf< UAnimNotify > OldNotifyClass,
TSubclassOf< UAnimNotify > NewNotifyClass,
FOnNotifyReplaced OnNotifyReplaced
)

 Replaces animation notifies in the specified Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static void ReplaceAnimNotifyStates ( UAnimSequenceBase* AnimationSequenceBase,
TSubclassOf< UAnimNotifyState > OldNotifyClass,
TSubclassOf< UAnimNotifyState > NewNotifyClass,
FOnNotifyStateReplaced OnNotifyStateReplaced
)

 Replaces animation notifies in the specified Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|NotifyEvents"

static FName RetrieveContainerNameForCurve ( const UAnimSequence* AnimationSequence,
FName CurveName
)

   AnimationBlueprintLibrary.h  

static ERawCurveTrackTypes RetrieveCurveTypeForCurve ( const UAnimSequenceBase* AnimationSequenceBase,
FName CurveName
)

   AnimationBlueprintLibrary.h  

static FSmartName RetrieveSmartNameForCurve ( const UAnimSequence* AnimationSequence,
FName CurveName,
FName ContainerName
)

   AnimationBlueprintLibrary.h  

static bool RetrieveSmartNameForCurve ( const UAnimSequence* AnimationSequence,
FName CurveName,
FName ContainerName,
FSmartName& SmartName
)

   AnimationBlueprintLibrary.h  

static void SetAdditiveAnimationType ( UAnimSequence* AnimationSequence,
const TEnumAsByte< enum EAdditiveAnimationType > AdditiveAnimationType
)

 Sets the Additive Animation type for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Additive"

static void SetAdditiveBasePoseType ( UAnimSequence* AnimationSequence,
const TEnumAsByte< enum EAdditiveBasePoseType > AdditiveBasePoseType
)

 Sets the Additive Base Pose type for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Additive"

static void SetAnimationInterpolationType ( UAnimSequence* AnimationSequence,
EAnimInterpolationType InterpolationType
)

 Sets the Animation Interpolation type for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Interpolation"

static void SetBoneCompressionSettings ( UAnimSequence* AnimationSequence,
UAnimBoneCompressionSettings* CompressionSettings
)

 Sets the Bone Compression Settings for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Compression"

static void SetCurveCompressionSettings ( UAnimSequence* AnimationSequence,
UAnimCurveCompressionSettings* CompressionSettings
)

 Sets the Curve Compression Settings for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Compression"

static void SetIsRootMotionLockForced ( UAnimSequence* AnimationSequence,
bool bForced
)

 Sets whether or not Root Motion locking is Forced for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|RootMotion"

static void SetRateScale ( UAnimSequenceBase* AnimationSequenceBase,
float RateScale
)

 Sets the (Play) Rate Scale for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Animation"

static void SetRootMotionEnabled ( UAnimSequence* AnimationSequence,
bool bEnabled
)

 Sets whether or not Root Motion is Enabled for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|RootMotion"

static void SetRootMotionLockType ( UAnimSequence* AnimationSequence,
TEnumAsByte< ERootMotionRootLock::Type > RootMotionLockType
)

 Sets the Root Motion Lock Type for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|RootMotion"

static void SetVariableFrameStrippingSettings ( UAnimSequence* AnimationSequence,
UVariableFrameStrippingSettings* VariableFrameStrippingSettings
)

 Sets the Variable Frame Stripping Settings for the given Animation Sequence AnimationBlueprintLibrary.h
  • BlueprintCallable
  • Category="AnimationBlueprintLibrary|Compression"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page