Class AnimationBlueprintLibrary

Blueprint library for altering and analyzing animation / skeletal data

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
AnimationBlueprintLibrary
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.AnimationModifiers
Assembly: UE4DotNet.dll
Syntax
public class AnimationBlueprintLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static AnimationBlueprintLibrary DefaultObject { get; }
Property Value
Type Description
AnimationBlueprintLibrary
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

AddAnimationNotifyEvent(AnimSequence, Name, Single, Single, SubclassOf<UObject>)

Adds an Animation Notify Event to Notify track in the given Animation with the given Notify creation data

Declaration
public static AnimNotify AddAnimationNotifyEvent(AnimSequence AnimationSequence, Name NotifyTrackName, float StartTime, float Duration, SubclassOf<UObject> NotifyClass)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyTrackName
System.Single StartTime
System.Single Duration
SubclassOf<UObject> NotifyClass
Returns
Type Description
AnimNotify
| Improve this Doc View Source

AddAnimationNotifyEventObject(AnimSequence, Single, AnimNotify, Name)

Adds an the specific Animation Notify to the Animation Sequence (requires Notify's outer to be the Animation Sequence)

Declaration
public static void AddAnimationNotifyEventObject(AnimSequence AnimationSequence, float StartTime, AnimNotify Notify, Name NotifyTrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Single StartTime
AnimNotify Notify
Name NotifyTrackName
| Improve this Doc View Source

AddAnimationNotifyTrack(AnimSequence, Name, LinearColor)

Adds an Animation Notify Track to the Animation Sequence

Declaration
public static void AddAnimationNotifyTrack(AnimSequence AnimationSequence, Name NotifyTrackName, LinearColor TrackColor)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyTrackName
LinearColor TrackColor
| Improve this Doc View Source

AddAnimationSyncMarker(AnimSequence, Name, Single, Name)

Adds an Animation Sync Marker to Notify track in the given Animation with the corresponding Marker Name and Time

Declaration
public static void AddAnimationSyncMarker(AnimSequence AnimationSequence, Name MarkerName, float Time, Name NotifyTrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name MarkerName
System.Single Time
Name NotifyTrackName
| Improve this Doc View Source

AddCurve(AnimSequence, Name, ERawCurveTrackTypes, Boolean)

Adds an Animation Curve by Type and Name to the given Animation Sequence

Declaration
public static void AddCurve(AnimSequence AnimationSequence, Name CurveName, ERawCurveTrackTypes CurveType, bool bMetaDataCurve)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
ERawCurveTrackTypes CurveType
System.Boolean bMetaDataCurve
| Improve this Doc View Source

AddFloatCurveKey(AnimSequence, Name, Single, Single)

Adds a Float Key to the specified Animation Curve inside of the given Animation Sequence

Declaration
public static void AddFloatCurveKey(AnimSequence AnimationSequence, Name CurveName, float Time, float Value)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
System.Single Time
System.Single Value
| Improve this Doc View Source

AddFloatCurveKeys(AnimSequence, Name, Byte, Byte)

Adds a multiple of Float Keys to the specified Animation Curve inside of the given Animation Sequence

Declaration
public static void AddFloatCurveKeys(AnimSequence AnimationSequence, Name CurveName, byte Times, byte Values)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
System.Byte Times
System.Byte Values
| Improve this Doc View Source

AddMetaData(AnimSequence, SubclassOf<AnimMetaData>, AnimMetaData)

Creates and Adds an instance of the specified MetaData Class to the given Animation Sequence

Declaration
public static void AddMetaData(AnimSequence AnimationSequence, SubclassOf<AnimMetaData> MetaDataClass, AnimMetaData MetaDataInstance)
Parameters
Type Name Description
AnimSequence AnimationSequence
SubclassOf<AnimMetaData> MetaDataClass
AnimMetaData MetaDataInstance
| Improve this Doc View Source

AddMetaDataObject(AnimSequence, AnimMetaData)

Adds an instance of the specified MetaData Class to the given Animation Sequence (requires MetaDataObject's outer to be the Animation Sequence)

Declaration
public static void AddMetaDataObject(AnimSequence AnimationSequence, AnimMetaData MetaDataObject)
Parameters
Type Name Description
AnimSequence AnimationSequence
AnimMetaData MetaDataObject
| Improve this Doc View Source

AddTransformationCurveKey(AnimSequence, Name, Single, Transform)

Adds a Transformation Key to the specified Animation Curve inside of the given Animation Sequence

Declaration
public static void AddTransformationCurveKey(AnimSequence AnimationSequence, Name CurveName, float Time, Transform Transform)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
System.Single Time
Transform Transform
| Improve this Doc View Source

AddTransformationCurveKeys(AnimSequence, Name, Byte, Byte)

Adds a multiple of Transformation Keys to the specified Animation Curve inside of the given Animation Sequence

Declaration
public static void AddTransformationCurveKeys(AnimSequence AnimationSequence, Name CurveName, byte Times, byte Transforms)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
System.Byte Times
System.Byte Transforms
| Improve this Doc View Source

AddVectorCurveKey(AnimSequence, Name, Single, Vector)

Adds a Vector Key to the specified Animation Curve inside of the given Animation Sequence

Declaration
public static void AddVectorCurveKey(AnimSequence AnimationSequence, Name CurveName, float Time, Vector Vector)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
System.Single Time
Vector Vector
| Improve this Doc View Source

AddVectorCurveKeys(AnimSequence, Name, Byte, Byte)

Adds a multiple of Vector Keys to the specified Animation Curve inside of the given Animation Sequence

Declaration
public static void AddVectorCurveKeys(AnimSequence AnimationSequence, Name CurveName, byte Times, byte Vectors)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
System.Byte Times
System.Byte Vectors
| Improve this Doc View Source

AddVirtualBone(AnimSequence, Name, Name)

Adds a Virtual Bone between the Source and Target Bones to the given Animation Sequence

Declaration
public static Name AddVirtualBone(AnimSequence AnimationSequence, Name SourceBoneName, Name TargetBoneName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name SourceBoneName
Name TargetBoneName
Returns
Type Description
Name
| Improve this Doc View Source

ContainsMetaDataOfClass(AnimSequence, SubclassOf<AnimMetaData>)

Checks whether or not the given Animation Sequences contains Meta Data Instance of the specified Meta Data Class

Declaration
public static bool ContainsMetaDataOfClass(AnimSequence AnimationSequence, SubclassOf<AnimMetaData> MetaDataClass)
Parameters
Type Name Description
AnimSequence AnimationSequence
SubclassOf<AnimMetaData> MetaDataClass
Returns
Type Description
System.Boolean
| Improve this Doc View Source

DoesBoneNameExist(AnimSequence, Name)

Checks whether or not the given Bone Name exist on the Skeleton referenced by the given Animation Sequence

Declaration
public static bool DoesBoneNameExist(AnimSequence AnimationSequence, Name BoneName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name BoneName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

DoesCurveExist(AnimSequence, Name, ERawCurveTrackTypes)

Checks whether or not the given Curve Name exist on the Skeleton referenced by the given Animation Sequence

Declaration
public static bool DoesCurveExist(AnimSequence AnimationSequence, Name CurveName, ERawCurveTrackTypes CurveType)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
ERawCurveTrackTypes CurveType
Returns
Type Description
System.Boolean
| Improve this Doc View Source

FinalizeBoneAnimation(AnimSequence)

Apply all the changes made to Bone Tracks to Finalize. This triggers recompression. Note that this is expensive, but will require to get correct compressed data

Declaration
public static void FinalizeBoneAnimation(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
| Improve this Doc View Source

FindBonePathToRoot(AnimSequence, Name)

Finds the Bone Path from the given Bone to the Root Bone

Declaration
public static IReadOnlyCollection<Name> FindBonePathToRoot(AnimSequence AnimationSequence, Name BoneName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name BoneName
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Name>
| Improve this Doc View Source

GetAdditiveAnimationType(AnimSequence)

Retrieves the Additive Animation type for the given Animation Sequence

Declaration
public static byte GetAdditiveAnimationType(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Byte
| Improve this Doc View Source

GetAdditiveBasePoseType(AnimSequence)

Retrieves the Additive Base Pose type for the given Animation Sequence

Declaration
public static byte GetAdditiveBasePoseType(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Byte
| Improve this Doc View Source

GetAnimationInterpolationType(AnimSequence)

Retrieves the Animation Interpolation type for the given Animation Sequence

Declaration
public static EAnimInterpolationType GetAnimationInterpolationType(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
EAnimInterpolationType
| Improve this Doc View Source

GetAnimationNotifyEventNames(AnimSequence)

Retrieves all Unique Animation Notify Events found within the given Animation Sequence

Declaration
public static IReadOnlyCollection<Name> GetAnimationNotifyEventNames(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Name>
| Improve this Doc View Source

GetAnimationNotifyEvents(AnimSequence)

Retrieves all Animation Notify Events found within the given Animation Sequence

Declaration
public static IReadOnlyCollection<AnimNotifyEvent> GetAnimationNotifyEvents(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<AnimNotifyEvent>
| Improve this Doc View Source

GetAnimationNotifyEventsForTrack(AnimSequence, Name)

Retrieves all Animation Notify Events for the given Notify Track Name from the given Animation Sequence

Declaration
public static IReadOnlyCollection<AnimNotifyEvent> GetAnimationNotifyEventsForTrack(AnimSequence AnimationSequence, Name NotifyTrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyTrackName
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<AnimNotifyEvent>
| Improve this Doc View Source

GetAnimationNotifyTrackNames(AnimSequence)

Retrieves all Unique Animation Notify Track Names found within the given Animation Sequence

Declaration
public static IReadOnlyCollection<Name> GetAnimationNotifyTrackNames(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Name>
| Improve this Doc View Source

GetAnimationSyncMarkers(AnimSequence)

Retrieves all the Animation Sync Markers for the given Animation Sequence

Declaration
public static IReadOnlyCollection<AnimSyncMarker> GetAnimationSyncMarkers(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<AnimSyncMarker>
| Improve this Doc View Source

GetAnimationSyncMarkersForTrack(AnimSequence, Name)

Retrieves all Animation Sync Markers for the given Notify Track Name from the given Animation Sequence

Declaration
public static IReadOnlyCollection<AnimSyncMarker> GetAnimationSyncMarkersForTrack(AnimSequence AnimationSequence, Name NotifyTrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyTrackName
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<AnimSyncMarker>
| Improve this Doc View Source

GetAnimationTrackNames(AnimSequence)

Retrieves the Names of the individual ATracks for the given Animation Sequence

Declaration
public static IReadOnlyCollection<Name> GetAnimationTrackNames(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Name>
| Improve this Doc View Source

GetAnimNotifyEventTriggerTime(AnimNotifyEvent)

Returns the actual trigger time for a NotifyEvent

Declaration
public static float GetAnimNotifyEventTriggerTime(AnimNotifyEvent NotifyEvent)
Parameters
Type Name Description
AnimNotifyEvent NotifyEvent
Returns
Type Description
System.Single
| Improve this Doc View Source

GetBonePoseForFrame(AnimSequence, Name, Int32, Boolean)

Retrieves Bone Pose data for the given Bone Name at the specified Frame from the given Animation Sequence

Declaration
public static Transform GetBonePoseForFrame(AnimSequence AnimationSequence, Name BoneName, int Frame, bool bExtractRootMotion)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name BoneName
System.Int32 Frame
System.Boolean bExtractRootMotion
Returns
Type Description
Transform
| Improve this Doc View Source

GetBonePoseForTime(AnimSequence, Name, Single, Boolean)

Retrieves Bone Pose data for the given Bone Name at the specified Time from the given Animation Sequence

Declaration
public static Transform GetBonePoseForTime(AnimSequence AnimationSequence, Name BoneName, float Time, bool bExtractRootMotion)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name BoneName
System.Single Time
System.Boolean bExtractRootMotion
Returns
Type Description
Transform
| Improve this Doc View Source

GetBonePosesForFrame(AnimSequence, Byte, Int32, Boolean, SkeletalMesh)

Retrieves Bone Pose data for the given Bone Names at the specified Frame from the given Animation Sequence

Declaration
public static IReadOnlyCollection<Transform> GetBonePosesForFrame(AnimSequence AnimationSequence, byte BoneNames, int Frame, bool bExtractRootMotion, SkeletalMesh PreviewMesh)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Byte BoneNames
System.Int32 Frame
System.Boolean bExtractRootMotion
SkeletalMesh PreviewMesh
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Transform>
| Improve this Doc View Source

GetBonePosesForTime(AnimSequence, Byte, Single, Boolean, SkeletalMesh)

Retrieves Bone Pose data for the given Bone Names at the specified Time from the given Animation Sequence

Declaration
public static IReadOnlyCollection<Transform> GetBonePosesForTime(AnimSequence AnimationSequence, byte BoneNames, float Time, bool bExtractRootMotion, SkeletalMesh PreviewMesh)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Byte BoneNames
System.Single Time
System.Boolean bExtractRootMotion
SkeletalMesh PreviewMesh
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Transform>
| Improve this Doc View Source

GetCompressionScheme(AnimSequence)

Retrieves the Compression Scheme for the given Animation Sequence

Declaration
public static AnimCompress GetCompressionScheme(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
AnimCompress
| Improve this Doc View Source

GetFloatKeys(AnimSequence, Name)

Retrieves, a multiple of, Float Key(s) from the specified Animation Curve inside of the given Animation Sequence

Declaration
public static (IReadOnlyCollection<float>, IReadOnlyCollection<float>) GetFloatKeys(AnimSequence AnimationSequence, Name CurveName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
Returns
Type Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<System.Single>, System.Collections.Generic.IReadOnlyCollection<System.Single>>
| Improve this Doc View Source

GetFrameAtTime(AnimSequence, Single)

Retrieves the Frame Index at the specified Time Value for the given Animation Sequence

Declaration
public static int GetFrameAtTime(AnimSequence AnimationSequence, float Time)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Single Time
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetMetaData(AnimSequence)

Retrieves all Meta Data Instances from the given Animation Sequence

Declaration
public static IReadOnlyCollection<AnimMetaData> GetMetaData(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<AnimMetaData>
| Improve this Doc View Source

GetMetaDataOfClass(AnimSequence, SubclassOf<AnimMetaData>)

Retrieves all Meta Data Instances from the given Animation Sequence

Declaration
public static IReadOnlyCollection<AnimMetaData> GetMetaDataOfClass(AnimSequence AnimationSequence, SubclassOf<AnimMetaData> MetaDataClass)
Parameters
Type Name Description
AnimSequence AnimationSequence
SubclassOf<AnimMetaData> MetaDataClass
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<AnimMetaData>
| Improve this Doc View Source

GetNumFrames(AnimSequence)

Retrieves the number of animation frames for the given Animation Sequence

Declaration
public static int GetNumFrames(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetRateScale(AnimSequence)

Retrieves the (Play) Rate Scale of the given Animation Sequence

Declaration
public static float GetRateScale(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Single
| Improve this Doc View Source

GetRawTrackData(AnimSequence, Name)

Retrieves the Raw Animation Data for the given Animation Track Name and Animation Sequence

Declaration
public static (IReadOnlyCollection<Vector>, IReadOnlyCollection<Quat>, IReadOnlyCollection<Vector>) GetRawTrackData(AnimSequence AnimationSequence, Name TrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name TrackName
Returns
Type Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<Vector>, System.Collections.Generic.IReadOnlyCollection<Quat>, System.Collections.Generic.IReadOnlyCollection<Vector>>
| Improve this Doc View Source

GetRawTrackPositionData(AnimSequence, Name)

Retrieves the Raw Translation Animation Data for the given Animation Track Name and Animation Sequence

Declaration
public static IReadOnlyCollection<Vector> GetRawTrackPositionData(AnimSequence AnimationSequence, Name TrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name TrackName
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Vector>
| Improve this Doc View Source

GetRawTrackRotationData(AnimSequence, Name)

Retrieves the Raw Rotation Animation Data for the given Animation Track Name and Animation Sequence

Declaration
public static IReadOnlyCollection<Quat> GetRawTrackRotationData(AnimSequence AnimationSequence, Name TrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name TrackName
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Quat>
| Improve this Doc View Source

GetRawTrackScaleData(AnimSequence, Name)

Retrieves the Raw Scale Animation Data for the given Animation Track Name and Animation Sequence

Declaration
public static IReadOnlyCollection<Vector> GetRawTrackScaleData(AnimSequence AnimationSequence, Name TrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name TrackName
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Vector>
| Improve this Doc View Source

GetRootMotionLockType(AnimSequence)

Retrieves the Root Motion Lock Type for the given Animation Sequence

Declaration
public static byte GetRootMotionLockType(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Byte
| Improve this Doc View Source

GetSequenceLength(AnimSequence)

Retrieves the Length of the given Animation Sequence

Declaration
public static float GetSequenceLength(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTimeAtFrame(AnimSequence, Int32)

Retrieves the Time Value at the specified Frame Indexfor the given Animation Sequence

Declaration
public static float GetTimeAtFrame(AnimSequence AnimationSequence, int Frame)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Int32 Frame
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTransformationKeys(AnimSequence, Name)

Retrieves, a multiple of, Transformation Key(s) from the specified Animation Curve inside of the given Animation Sequence

Declaration
public static (IReadOnlyCollection<float>, IReadOnlyCollection<Transform>) GetTransformationKeys(AnimSequence AnimationSequence, Name CurveName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
Returns
Type Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<System.Single>, System.Collections.Generic.IReadOnlyCollection<Transform>>
| Improve this Doc View Source

GetUniqueMarkerNames(AnimSequence)

Retrieves all the Unique Names for the Animation Sync Markers contained by the given Animation Sequence

Declaration
public static IReadOnlyCollection<Name> GetUniqueMarkerNames(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Name>
| Improve this Doc View Source

GetVectorKeys(AnimSequence, Name)

Retrieves, a multiple of, Vector Key(s) from the specified Animation Curve inside of the given Animation Sequence

Declaration
public static (IReadOnlyCollection<float>, IReadOnlyCollection<Vector>) GetVectorKeys(AnimSequence AnimationSequence, Name CurveName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
Returns
Type Description
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<System.Single>, System.Collections.Generic.IReadOnlyCollection<Vector>>
| Improve this Doc View Source

IsRootMotionEnabled(AnimSequence)

Checks whether or not Root Motion is Enabled for the given Animation Sequence

Declaration
public static bool IsRootMotionEnabled(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsRootMotionLockForced(AnimSequence)

Checks whether or not Root Motion locking is Forced for the given Animation Sequence

Declaration
public static bool IsRootMotionLockForced(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsValidAnimationSyncMarkerName(AnimSequence, Name)

Checks whether or not the given Marker Name is a valid Animation Sync Marker Name

Declaration
public static bool IsValidAnimationSyncMarkerName(AnimSequence AnimationSequence, Name MarkerName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name MarkerName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsValidAnimNotifyTrackName(AnimSequence, Name)

Checks whether or not the given Track Name is a valid Animation Notify Track in the Animation Sequence

Declaration
public static bool IsValidAnimNotifyTrackName(AnimSequence AnimationSequence, Name NotifyTrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyTrackName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsValidRawAnimationTrackName(AnimSequence, Name)

Checks whether or not the given Animation Track Name is contained within the Animation Sequence

Declaration
public static bool IsValidRawAnimationTrackName(AnimSequence AnimationSequence, Name TrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name TrackName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsValidTime(AnimSequence, Single)

Checks whether or not the given Time Value lies within the given Animation Sequence's Length

Declaration
public static bool IsValidTime(AnimSequence AnimationSequence, float Time)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Single Time
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static AnimationBlueprintLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
AnimationBlueprintLibrary
| Improve this Doc View Source

RemoveAllAnimationNotifyTracks(AnimSequence)

Removes All Animation Notify Tracks from Animation Sequence

Declaration
public static void RemoveAllAnimationNotifyTracks(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
| Improve this Doc View Source

RemoveAllAnimationSyncMarkers(AnimSequence)

Removes All Animation Sync Markers found within the Animation Sequence, and returns the number of removed instances

Declaration
public static void RemoveAllAnimationSyncMarkers(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
| Improve this Doc View Source

RemoveAllBoneAnimation(AnimSequence)

Removes all Animation Bone Track Data from the given Animation Sequence

Declaration
public static void RemoveAllBoneAnimation(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
| Improve this Doc View Source

RemoveAllCurveData(AnimSequence)

Removes all Animation Curve Data from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton)

Declaration
public static void RemoveAllCurveData(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
| Improve this Doc View Source

RemoveAllMetaData(AnimSequence)

Removes all Meta Data from the given Animation Sequence

Declaration
public static void RemoveAllMetaData(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
| Improve this Doc View Source

RemoveAllVirtualBones(AnimSequence)

Removes all Virtual Bones from the given Animation Sequence

Declaration
public static void RemoveAllVirtualBones(AnimSequence AnimationSequence)
Parameters
Type Name Description
AnimSequence AnimationSequence
| Improve this Doc View Source

RemoveAnimationNotifyEventsByName(AnimSequence, Name)

Removes Animation Notify Events found by Name within the Animation Sequence, and returns the number of removed name instances

Declaration
public static int RemoveAnimationNotifyEventsByName(AnimSequence AnimationSequence, Name NotifyName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyName
Returns
Type Description
System.Int32
| Improve this Doc View Source

RemoveAnimationNotifyEventsByTrack(AnimSequence, Name)

Removes Animation Notify Events found by Track within the Animation Sequence, and returns the number of removed name instances

Declaration
public static int RemoveAnimationNotifyEventsByTrack(AnimSequence AnimationSequence, Name NotifyTrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyTrackName
Returns
Type Description
System.Int32
| Improve this Doc View Source

RemoveAnimationNotifyTrack(AnimSequence, Name)

Removes an Animation Notify Track from Animation Sequence by Name

Declaration
public static void RemoveAnimationNotifyTrack(AnimSequence AnimationSequence, Name NotifyTrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyTrackName
| Improve this Doc View Source

RemoveAnimationSyncMarkersByName(AnimSequence, Name)

Removes All Animation Sync Marker found within the Animation Sequence whose name matches MarkerName, and returns the number of removed instances

Declaration
public static int RemoveAnimationSyncMarkersByName(AnimSequence AnimationSequence, Name MarkerName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name MarkerName
Returns
Type Description
System.Int32
| Improve this Doc View Source

RemoveAnimationSyncMarkersByTrack(AnimSequence, Name)

Removes All Animation Sync Marker found within the Animation Sequence that belong to the specific Notify Track, and returns the number of removed instances

Declaration
public static int RemoveAnimationSyncMarkersByTrack(AnimSequence AnimationSequence, Name NotifyTrackName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name NotifyTrackName
Returns
Type Description
System.Int32
| Improve this Doc View Source

RemoveBoneAnimation(AnimSequence, Name, Boolean, Boolean)

Removes an Animation Curve by Name from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton) @

Declaration
public static void RemoveBoneAnimation(AnimSequence AnimationSequence, Name BoneName, bool bIncludeChildren, bool bFinalize)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name BoneName
System.Boolean bIncludeChildren
System.Boolean bFinalize
Remarks

param AnimationSequence : AnimSequence @param BoneName : Name of bone track user wants to remove @param bIncludeChildren : true if user wants to include all children of BoneName @param bFinalize : If you set this to true, it will trigger compression. If you set bFinalize to be false, you'll have to manually trigger Finalize.

| Improve this Doc View Source

RemoveCurve(AnimSequence, Name, Boolean)

Removes an Animation Curve by Name from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton)

Declaration
public static void RemoveCurve(AnimSequence AnimationSequence, Name CurveName, bool bRemoveNameFromSkeleton)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name CurveName
System.Boolean bRemoveNameFromSkeleton
| Improve this Doc View Source

RemoveMetaData(AnimSequence, AnimMetaData)

Removes the specified Meta Data Instance from the given Animation Sequence

Declaration
public static void RemoveMetaData(AnimSequence AnimationSequence, AnimMetaData MetaDataObject)
Parameters
Type Name Description
AnimSequence AnimationSequence
AnimMetaData MetaDataObject
| Improve this Doc View Source

RemoveMetaDataOfClass(AnimSequence, SubclassOf<AnimMetaData>)

Removes all Meta Data Instance of the specified Class from the given Animation Sequence

Declaration
public static void RemoveMetaDataOfClass(AnimSequence AnimationSequence, SubclassOf<AnimMetaData> MetaDataClass)
Parameters
Type Name Description
AnimSequence AnimationSequence
SubclassOf<AnimMetaData> MetaDataClass
| Improve this Doc View Source

RemoveVirtualBone(AnimSequence, Name)

Removes a Virtual Bone with the specified Bone Name from the given Animation Sequence

Declaration
public static void RemoveVirtualBone(AnimSequence AnimationSequence, Name VirtualBoneName)
Parameters
Type Name Description
AnimSequence AnimationSequence
Name VirtualBoneName
| Improve this Doc View Source

RemoveVirtualBones(AnimSequence, Byte)

Removes Virtual Bones with the specified Bone Names from the given Animation Sequence

Declaration
public static void RemoveVirtualBones(AnimSequence AnimationSequence, byte VirtualBoneNames)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Byte VirtualBoneNames
| Improve this Doc View Source

ReplaceAnimNotifies(AnimSequenceBase, SubclassOf<AnimNotify>, SubclassOf<AnimNotify>, Byte)

Replaces animation notifies in the specified Animation Sequence

Declaration
public static void ReplaceAnimNotifies(AnimSequenceBase AnimationSequence, SubclassOf<AnimNotify> OldNotifyClass, SubclassOf<AnimNotify> NewNotifyClass, byte OnNotifyReplaced)
Parameters
Type Name Description
AnimSequenceBase AnimationSequence
SubclassOf<AnimNotify> OldNotifyClass
SubclassOf<AnimNotify> NewNotifyClass
System.Byte OnNotifyReplaced
| Improve this Doc View Source

ReplaceAnimNotifyStates(AnimSequenceBase, SubclassOf<AnimNotifyState>, SubclassOf<AnimNotifyState>, Byte)

Replaces animation notifies in the specified Animation Sequence

Declaration
public static void ReplaceAnimNotifyStates(AnimSequenceBase AnimationSequence, SubclassOf<AnimNotifyState> OldNotifyClass, SubclassOf<AnimNotifyState> NewNotifyClass, byte OnNotifyStateReplaced)
Parameters
Type Name Description
AnimSequenceBase AnimationSequence
SubclassOf<AnimNotifyState> OldNotifyClass
SubclassOf<AnimNotifyState> NewNotifyClass
System.Byte OnNotifyStateReplaced
| Improve this Doc View Source

SetAdditiveAnimationType(AnimSequence, Byte)

Sets the Additive Animation type for the given Animation Sequence

Declaration
public static void SetAdditiveAnimationType(AnimSequence AnimationSequence, byte AdditiveAnimationType)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Byte AdditiveAnimationType
| Improve this Doc View Source

SetAdditiveBasePoseType(AnimSequence, Byte)

Sets the Additive Base Pose type for the given Animation Sequence

Declaration
public static void SetAdditiveBasePoseType(AnimSequence AnimationSequence, byte AdditiveBasePoseType)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Byte AdditiveBasePoseType
| Improve this Doc View Source

SetAnimationInterpolationType(AnimSequence, EAnimInterpolationType)

Sets the Animation Interpolation type for the given Animation Sequence

Declaration
public static void SetAnimationInterpolationType(AnimSequence AnimationSequence, EAnimInterpolationType InterpolationType)
Parameters
Type Name Description
AnimSequence AnimationSequence
EAnimInterpolationType InterpolationType
| Improve this Doc View Source

SetCompressionScheme(AnimSequence, AnimCompress)

Sets the Compression Scheme for the given Animation Sequence

Declaration
public static void SetCompressionScheme(AnimSequence AnimationSequence, AnimCompress CompressionScheme)
Parameters
Type Name Description
AnimSequence AnimationSequence
AnimCompress CompressionScheme
| Improve this Doc View Source

SetIsRootMotionLockForced(AnimSequence, Boolean)

Sets whether or not Root Motion locking is Forced for the given Animation Sequence

Declaration
public static void SetIsRootMotionLockForced(AnimSequence AnimationSequence, bool bForced)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Boolean bForced
| Improve this Doc View Source

SetRateScale(AnimSequence, Single)

Sets the (Play) Rate Scale for the given Animation Sequence

Declaration
public static void SetRateScale(AnimSequence AnimationSequence, float RateScale)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Single RateScale
| Improve this Doc View Source

SetRootMotionEnabled(AnimSequence, Boolean)

Sets whether or not Root Motion is Enabled for the given Animation Sequence

Declaration
public static void SetRootMotionEnabled(AnimSequence AnimationSequence, bool bEnabled)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Boolean bEnabled
| Improve this Doc View Source

SetRootMotionLockType(AnimSequence, Byte)

Sets the Root Motion Lock Type for the given Animation Sequence

Declaration
public static void SetRootMotionLockType(AnimSequence AnimationSequence, byte RootMotionLockType)
Parameters
Type Name Description
AnimSequence AnimationSequence
System.Byte RootMotionLockType

Operators

| Improve this Doc View Source

Implicit(IntPtr to AnimationBlueprintLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator AnimationBlueprintLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
AnimationBlueprintLibrary