Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Animation > UAnimSequenceBase

Light Theme

Dark Theme

UAnimSequenceBase

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimationAsset

UAnimSequenceBase

UAnimCompositeBase

	UAnimComposite
	UAnimMontage

UAnimSequence

UAnimStreamable

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Animation/AnimSequenceBase.h
Include	#include "Animation/AnimSequenceBase.h"

Syntax

class UAnimSequenceBase : public UAnimationAsset

Variables

	Name	Description
TArray< FAnimNo...	AnimNotifyTracks	If you change Notifies array, this will need to be rebuilt
TArray< struct ...	Notifies	Animation notifies, sorted by time (earliest notification first).
float	RateScale	Number for tweaking playback rate of this animation globally.
FRawCurveTracks	RawCurveData	Raw uncompressed float curve data
float	SequenceLength	Length (in seconds) of this AnimSequence if played back with a speed of 1.0.

Constructors

	Name	Description
	UAnimSequenceBase ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AdvanceMarkerPhaseAsFollower ( const FMarkerTickContext& Context, float DeltaRemaining, bool bLooping, float& CurrentTime, FMarkerPair& PreviousMarker, FMarkerPair& NextMarker )
void	AdvanceMarkerPhaseAsLeader ( bool bLooping, float MoveDelta, const TArray< FName >& ValidMarker..., float& CurrentTime, FMarkerPair& PrevMarker, FMarkerPair& NextMarker, TArray< FPassedMarker >& MarkersPa... )
EAnimEventTr...	CalculateOffsetForNotify ( float NotifyDisplayTime )	Calculates what (if any) offset should be applied to the trigger time of a notify given its display time
bool	CanBeUsedInComposition()
void	ClampNotifiesAtEndOfSequence()	Fix up any notifies that are positioned beyond the end of the sequence
void	EnableRootMotionSettingFromMontage ( bool bInEnableRootMotion, const ERootMotionRootLock::Type InR... )	To support anim sequence base to montage
void	EvaluateCurveData ( FBlendedCurve& OutCurve, float CurrentTime, bool bForceUseRawData )	Evaluate curve data to Instance at the time of CurrentTime
float	EvaluateCurveData ( SmartName::UID_Type CurveUID, float CurrentTime, bool bForceUseRawData )	Evaluate curve data to Instance at the time of CurrentTime
uint8 *	FindArrayProperty ( const TCHAR* PropName, FArrayProperty*& ArrayProperty, int32 ArrayIndex )	Get a pointer to the data for a given array property item.
uint8 *	FindNotifyPropertyData ( int32 NotifyIndex, FArrayProperty*& ArrayProperty )	Get a pointer to the data for a given Anim Notify.
EAdditiveAni...	GetAdditiveAnimType()	Default implementation, no additive
UAnimSequenc...	GetAdditiveBasePose()	Ideally this would be animsequcnebase, but we might have some issue with that. For now, just allow AnimSequence
void	GetAnimationPose ( FAnimationPoseData& OutPoseData, const FAnimExtractContext& Extract... )
void	GetAnimNotifies ( const float& StartTime, const float& DeltaTime, const bool bAllowLooping, TArray< FAnimNotifyEventReference >... )	Retrieves AnimNotifies given a StartTime and a DeltaTime.
void	GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition, const float& CurrentPosition, TArray< FAnimNotifyEventReference >... )	Retrieves AnimNotifies between two time positions.
const FRawCu...	GetCurveData()
float	GetFirstMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InM... )
int32	GetFrameAtTime ( const float Time )	Get the frame number for the provided time
void	GetMarkerIndicesForPosition ( const FMarkerSyncAnimPosition& Syn..., bool bLooping, FMarkerPair& OutPrevMarker, FMarkerPair& OutNextMarker, float& CurrentTime )
void	GetMarkerIndicesForTime ( float CurrentTime, bool bLooping, const TArray< FName >& ValidMarker..., FMarkerPair& OutPrevMarker, FMarkerPair& OutNextMarker )
FMarkerSyncA...	GetMarkerSyncPositionfromMarkerIndicies ( int32 PrevMarker, int32 NextMarker, float CurrentTime )
float	GetNextMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InM..., const float& StartingPosition )
int32	GetNumberOfFrames()	Return Number of Frames
float	GetPlayLength()	Returns the total play length of the montage, if played back with a speed of 1.0.
float	GetPrevMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InM..., const float& StartingPosition )
float	GetTimeAtFrame ( const int32 Frame )	Get the time at the given frame
void	HandleAssetPlayerTickedInternal ( FAnimAssetTickContext& Context, const float PreviousTime, const float MoveDelta, const FAnimTickRecord& Instance, FAnimNotifyQueue& NotifyQueue )
bool	HasCurveData ( SmartName::UID_Type CurveUID, bool bForceUseRawData )
bool	HasRootMotion()
void	InitializeNotifyTrack()
bool	IsNotifyAvailable()	Return true if anim notify is available
bool	IsValidToPlay()
void	MarkRawDataAsModified ( bool bForceNewRawDatGuid )	Store that our raw data has changed so that we can get correct compressed data later on.
void	RefreshCacheData()	Update cache data (notify tracks, sync markers)
void	RefreshCurveData()
void	RegisterOnAnimCurvesChanged ( const FOnAnimCurvesChanged& Delega... )	Registers a delegate to be called after anim curves have changed
void	RegisterOnAnimTrackCurvesChanged ( const FOnAnimTrackCurvesChanged& D... )	Registers a delegate to be called after anim track curves have changed
void	RegisterOnNotifyChanged ( const FOnNotifyChanged& Delegate )	Registers a delegate to be called after notification has changed
bool	RemoveNotifies ( const TArray< FName >& NotifiesToR... )	Remove the notifies specified
void	SortNotifies()	Sort the Notifies array by time, earliest first.
void	TickByMarkerAsFollower ( FMarkerTickRecord& Instance, FMarkerTickContext& MarkerContext, float& CurrentTime, float& OutPreviousTime, const float MoveDelta, const bool bLooping )
void	TickByMarkerAsLeader ( FMarkerTickRecord& Instance, FMarkerTickContext& MarkerContext, float& CurrentTime, float& OutPreviousTime, const float MoveDelta, const bool bLooping )
void	UnregisterOnAnimCurvesChanged ( void* Unregister )
void	UnregisterOnAnimTrackCurvesChanged ( void* Unregister )
void	UnregisterOnNotifyChanged ( void* Unregister )
void	VerifyCurveNames ( USkeleton& Skeleton, const FName& NameContainer, TArray< DataType >& CurveList )

Overridden from UAnimationAsset

	Name	Description
float	GetMaxCurrentTime()	This is used in editor only when used for transition getter this doesn't mean max time.
void	RefreshParentAssetData()
void	RemapTracksToNewSkeleton ( USkeleton* NewSkeleton, bool bConvertSpaces )
void	TickAssetPlayer ( FAnimTickRecord& Instance, FAnimNotifyQueue& NotifyQueue, FAnimAssetTickContext& Context )	Advances the asset player instance

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name	Description
FOnAnimCurvesChanged
FOnAnimCurvesChangedMulticaster
FOnAnimTrackCurvesChanged
FOnAnimTrackCurvesChangedMulticaster
FOnNotifyChanged
FOnNotifyChangedMulticaster

Deprecated Functions

	Name	Description
void	GetAnimationPose ( FCompactPose& OutPose, FBlendedCurve& OutCurve, const FAnimExtractContext& Extract... )	Use other GetAnimationPose signature
void	GetAnimNotifies ( const float& StartTime, const float& DeltaTime, const bool bAllowLooping, TArray< const FAnimNotifyEvent*... )	Use the GetAnimNotifiesFromTrackPositions that takes FAnimNotifyEventReferences instead
void	GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition, const float& CurrentPosition, TArray< const FAnimNotifyEvent*... )	Use the GetAnimNotifiesFromTrackPositions that takes FAnimNotifyEventReferences instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss