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

Light Theme

Dark Theme

FAnimNotifyEvent

Triggers an animation notify.

Windows

MacOS

Linux

Inheritance Hierarchy

FAnimLinkableElement

FAnimNotifyEvent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Animation/AnimTypes.h
Include	#include "Animation/AnimTypes.h"

Syntax

struct FAnimNotifyEvent : public FAnimLinkableElement

Remarks

Triggers an animation notify. Each AnimNotifyEvent contains an AnimNotify object which has its Notify method called and passed to the animation.

Variables

	Name	Description
bool	bConvertedFromBranchingPoint	If TRUE, this notify has been converted from an old BranchingPoint.
bool	bTriggerOnDedicatedServer	If disabled this notify will be skipped on dedicated servers
bool	bTriggerOnFollower	If enabled this notify will trigger when the animation is a follower in a sync group (by default only the sync group leaders notifies trigger
float	Duration
FAnimLinkableEl...	EndLink	Linkable element to use for the end handle representing a notify state duration
float	EndTriggerTimeOffset	An offset similar to TriggerTimeOffset but used for the end scrub handle of a notify state's duration
FGuid	Guid	Guid for tracking notifies in editor
TEnumAsByte< EM...	MontageTickType
UAnimNotify ...	Notify
FColor	NotifyColor	Color of Notify in editor
int32	NotifyFilterLOD	LOD to start filtering this notify from.
TEnumAsByte< EN...	NotifyFilterType	Defines a method for filtering notifies (stopping them triggering) e.g. by looking at the meshes current LOD
FName	NotifyName
UAnimNotifyStat...	NotifyStateClass
float	NotifyTriggerChance	Defines the chance of of this notify triggering, 0 = No Chance, 1 = Always triggers
int32	TrackIndex	'Track' that the notify exists on, used for visual placement in editor and sorting priority in runtime
float	TriggerTimeOffset	An offset from the DisplayTime to the actual time we will trigger the notify, as we cannot always trigger it exactly at the time the user wants
float	TriggerWeightThreshold

Constructors

	Name	Description
	FAnimNotifyEvent()

Destructors

	Name	Description
	~FAnimNotifyEvent()

Functions

	Name	Description
float	GetDuration()
float	GetEndTriggerTime()	Returns the actual end time for a state notify.
FName	GetNotifyEventName()	Get the NotifyName pre-appended to "AnimNotify_", for calling the event
float	GetTriggerTime()	Returns the actual trigger time for this notify.
bool	IsBlueprintNotify()	Returns true if this is blueprint derived notifies
bool	IsBranchingPoint()	Returns true is this AnimNotify is a BranchingPoint
void	PostSerialize ( const FArchive& Ar )
void	RefreshEndTriggerOffset ( EAnimEventTriggerOffsets::Type Pred... )	Updates end trigger offset based on a combination of predicted offset and current offset
void	RefreshTriggerOffset ( EAnimEventTriggerOffsets::Type Pred... )	Updates trigger offset based on a combination of predicted offset and current offset
bool	Serialize ( FArchive& Ar )
void	SetDuration ( float NewDuration )

Overridden from FAnimLinkableElement

		Name	Description
	void	SetTime ( float NewTime, EAnimLinkMethod::Type ReferenceFram... )	Sets the time of this element

Operators

		Name	Description
	bool	operator< ( const FAnimNotifyEvent& Other )	Used by UAnimSequenceBase::SortNotifies() to sort its Notifies array.
	bool	operator== ( const FAnimNotifyEvent& Other )

Deprecated Variables

		Name	Description
	float	DisplayTime_DEPRECATED	The user requested time for this notify

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

Take our survey

Dismiss