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 > UAnimMontage

Light Theme

Dark Theme

UAnimMontage

Any property you're adding to AnimMontage and parent class has to be considered for Child Asset

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimationAsset

UAnimSequenceBase

UAnimCompositeBase

UAnimMontage

References

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

Syntax

class UAnimMontage : public UAnimCompositeBase

Remarks

Any property you're adding to AnimMontage and parent class has to be considered for Child Asset

Child Asset is considered to be only asset mapping feature using everything else in the class For example, you can just use all parent's setting for the montage, but only remap assets This isn't magic bullet unfortunately and it is consistent effort of keeping the data synced with parent If you add new property, please make sure those property has to be copied for children. If it does, please add the copy in the function RefreshParentAssetData

Variables

	Name	Description
bool	bEnableAutoBlendOut	When it hits end, it automatically blends out.
bool	bEnableRootMotionRotation	If this is on, it will allow extracting root motion rotation.
bool	bEnableRootMotionTranslation	If this is on, it will allow extracting root motion translation.
FAlphaBlend	BlendIn	Blend in option.
FAlphaBlend	BlendOut	Blend out option.
float	BlendOutTriggerTime	Time from Sequence End to trigger blend out.
TArray< int32 >	BranchingPointStateNotifyIndices	Keep track of which AnimNotify_State are marked as BranchingPoints, so we can update their state when the Montage is ticked
TArray< FCompos...	CompositeSections	Composite section.
FMarkerSyncData	MarkerData
UAnimSequence &...	PreviewBasePose	Preview Base pose for additive BlendSpace
TEnumAsByte< ER...	RootMotionRootLock	Root Bone will be locked to that position when extracting root motion.
TArray< struct ...	SlotAnimTracks	Slot data, each slot contains anim track
FName	SyncGroup	If you're using marker based sync for this montage, make sure to add sync group name.
int32	SyncSlotIndex	Wip: until we have UI working
FTimeStretchCur...	TimeStretchCurve
FName	TimeStretchCurveName	Name of optional TimeStretchCurveName to look for in Montage.

Constructors

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

Functions

	Name	Description
int32	AddAnimCompositeSection ( FName InSectionName, float StartPos )	Add Composite section with InSectionName returns index of added item returns INDEX_NONE if failed.
FSlotAnimati...	AddSlot ( FName SlotName )	Add new slot track to this montage.
float	CalculatePos ( FCompositeSection& Section, float PosWithinCompositeSection )	Utility function to calculate Animation Pos from Section, PosWithinCompositeSection
float	CalculateSequenceLength()	Gets the sequence length of the montage by calculating it from the lengths of the segments in the montage.
bool	CanUseMarkerSync()
void	CollectMarkers()	Update markers
UAnimMontage...	CreateSlotAnimationAsDynamicMontage ( UAnimSequenceBase* Asset, FName SlotNodeName, float BlendInTime, float BlendOutTime, float InPlayRate, int32 LoopCount, float BlendOutTriggerTime, float InTimeToStartMontageAt )	Utility function to create dynamic montage from AnimSequence
bool	DeleteAnimCompositeSection ( int32 SectionIndex )	Delete Composite section with InSectionName return true if success, false otherwise
FTransform	ExtractRootMotionFromTrackRange ( float StartTrackPosition, float EndTrackPosition )	Extract RootMotion Transform from a contiguous Track position range.
void	FilterOutNotifyBranchingPoints ( TArray< FAnimNotifyEventReference >... )	Filter out notifies from array that are marked as 'BranchingPoints'
const FBranc...	FindFirstBranchingPointMarker ( float StartTrackPos, float EndTrackPos )	Find first branching point marker between track positions
const FAnimT...	GetAnimationData ( FName SlotName )	Prototype function to get animation data - this will need rework
const FCompo...	GetAnimCompositeSection ( int32 SectionIndex )	Get FCompositeSection with InSectionName
FCompositeSe...	GetAnimCompositeSection ( int32 SectionIndex )	Get FCompositeSection with InSectionName
int32	GetAnimCompositeSectionIndexFromPos ( float CurrentTime, float& PosWithinCompositeSection )	Get Section Index from CurrentTime with PosWithinCompositeSection
float	GetDefaultBlendOutTime()
FName	GetGroupName()	Get the Montage's Group Name. This is the group from the first slot. Get Montage's Group Name
int32	GetSectionIndex ( FName InSectionName )	Get SectionIndex from SectionName
int32	GetSectionIndexFromPosition ( float Position )	Return Section Index from Position
float	GetSectionLength ( int32 SectionIndex )
const TArray...	GetSectionMetaData ( FName SectionName, bool bIncludeSequence, FName SlotName )	Get Section Metadata for the montage including metadata belong to the anim reference This will remove redundant entry if found - i.e. multiple same anim reference is used
FName	GetSectionName ( int32 SectionIndex )	Get SectionName from SectionIndex in TArray
void	GetSectionStartAndEndTime ( int32 SectionIndex, float& OutStartTime, float& OutEndTime )
float	GetSectionTimeLeftFromPos ( float Position )	Return time left to end of section from given position. -1.f if not a valid position
bool	HasValidSlotSetup()	True if valid, false otherwise. Will log warning if not valid.
bool	IsValidAdditiveSlot ( const FName& SlotNodeName )	Check if this slot has valid animation data
bool	IsValidSectionIndex ( int32 SectionIndex )
bool	IsValidSectionName ( FName InSectionName )
bool	IsValidSlot ( FName InSlotName )	Return true if valid slot
void	RegisterOnMontageChanged ( const FOnMontageChanged& Delegate )	Registers a delegate to be called after notification has changed
void	UnregisterOnMontageChanged ( void* Unregister )
void	UpdateLinkableElements()	Update all linkable elements contained in the montage
void	UpdateLinkableElements ( int32 SlotIdx, int32 SegmentIdx )	Update linkable elements that rely on a specific segment.

Overridden from UAnimCompositeBase

		Name	Description
	bool	ContainRecursive ( TArray< UAnimCompositeBase* > ... )	This is recursive function that look thorough internal assets and clear the reference if recursive is found.
	void	InvalidateRecursiveAsset()	This is to prevent anybody adding recursive asset to anim composite as a result of anim composite being a part of anim sequence base

Overridden from UAnimSequenceBase

	Name	Description
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	GetMarkerIndicesForTime ( float CurrentTime, bool bLooping, const TArray< FName >& ValidMarker..., FMarkerPair& OutPrevMarker, FMarkerPair& OutNextMarker )
FMarkerSyncA...	GetMarkerSyncPositionfromMarkerIndicies ( int32 PrevMarker, int32 NextMarker, float CurrentTime )
bool	HasRootMotion()	Returns whether the anim sequences this montage have root motion enabled
void	RefreshCacheData()	Update cache data (notify tracks, sync markers)

Overridden from UAnimationAsset

	Name	Description
bool	GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& A..., bool bRecursive )	Retrieve all animations that are used by this asset
TArray< FNam...	GetUniqueMarkerNames()	Return a list of unique marker names for blending compatibility
bool	IsValidAdditive()	Return true if this is valid additive animation false otherwise
void	ReplaceReferredAnimations ( const TMap< UAnimationAsset*, ... )	Replace this assets references to other animations based on ReplacementMap
void	TickAssetPlayer ( FAnimTickRecord& Instance, FAnimNotifyQueue& NotifyQueue, FAnimAssetTickContext& Context )	Advances the asset player instance

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.

Typedefs

Name	Description
FOnMontageChanged
FOnMontageChangedMulticaster

Deprecated Variables

	Name	Description
float	BlendInTime_DEPRECATED
float	BlendOutTime_DEPRECATED
TArray< struct ...	BranchingPoints_DEPRECATED	Remove this when VER_UE4_MONTAGE_BRANCHING_POINT_REMOVAL is removed.

Deprecated Functions

		Name	Description
	void	FilterOutNotifyBranchingPoints ( 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