1. Epic GamesDeveloper
  3. FAnimNotifyEvent

FAnimNotifyEvent

Triggers an animation notify.

API > API/Runtime > API/Runtime/Engine

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

   
Name FAnimNotifyEvent
Type struct
Header File /Engine/Source/Runtime/Engine/Public/Animation/AnimTypes.h
Include Path #include "Animation/AnimTypes.h"

Syntax

USTRUCT (BlueprintType )  
struct FAnimNotifyEvent : public FAnimLinkableElement

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FAnimNotifyEvent()

   Animation/AnimTypes.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FAnimNotifyEvent()

   Animation/AnimTypes.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCanBeFilteredViaRequest bool Allow notify event to be filtered if requested at runtime (e. g. via an Anim Graph Message) Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotifyTriggerSettings
bConvertedFromBranchingPoint bool If TRUE, this notify has been converted from an old BranchingPoint. Animation/AnimTypes.h  
bTriggerOnDedicatedServer bool If disabled this notify will be skipped on dedicated servers Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotifyTriggerSettings
bTriggerOnFollower bool 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 Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotifyTriggerSettings
Duration float   Animation/AnimTypes.h  
EndLink FAnimLinkableElement Linkable element to use for the end handle representing a notify state duration Animation/AnimTypes.h  
EndTriggerTimeOffset float An offset similar to TriggerTimeOffset but used for the end scrub handle of a notify state's duration Animation/AnimTypes.h  
Guid FGuid Guid for tracking notifies in editor Animation/AnimTypes.h
  • Meta=(ExcludeFromHash)
MontageTickType TEnumAsByte< EMontageNotifyTickType::Type >   Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotifyEvent
Notify TObjectPtr< class UAnimNotify >   Animation/AnimTypes.h
  • EditAnywhere
  • Instanced
  • BlueprintReadWrite
  • Category=AnimNotifyEvent
NotifyColor FColor Color of Notify in editor Animation/AnimTypes.h  
NotifyFilterLOD int32 LOD to start filtering this notify from. Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotifyTriggerSettings
  • Meta=(ClampMin="0")
NotifyFilterType TEnumAsByte< ENotifyFilterType::Type > Defines a method for filtering notifies (stopping them triggering) e.g. by looking at the meshes current LOD Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotifyTriggerSettings
NotifyName FName   Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=AnimNotifyEvent
NotifyStateClass TObjectPtr< class UAnimNotifyState >   Animation/AnimTypes.h
  • EditAnywhere
  • Instanced
  • BlueprintReadWrite
  • Category=AnimNotifyEvent
NotifyTriggerChance float Defines the chance of this notify triggering, 0 = No Chance, 1 = Always triggers Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotifyTriggerSettings
  • Meta=(ClampMin="0.0", ClampMax="1.0")
TrackIndex int32 'Track' that the notify exists on, used for visual placement in editor and sorting priority in runtime Animation/AnimTypes.h  
TriggerTimeOffset float 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 Animation/AnimTypes.h  
TriggerWeightThreshold float   Animation/AnimTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotifyEvent

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedNotifyEventBaseName FName NotifyName used to generate CachedNotifyEventName, for invalidation Animation/AnimTypes.h  
CachedNotifyEventName FName NotifyName appended to "AnimNotify_" Animation/AnimTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetDuration()

   Animation/AnimTypes.h  
Returns the actual end time for a state notify. Animation/AnimTypes.h  
Get the NotifyName pre-appended to "AnimNotify_", for calling the event Animation/AnimTypes.h  

FName GetNotifyEventName ( const UMirrorDataTable* MirrorDataTable
) const

 Get the mirrored NotifyName pre-appended to "AnimNotify_", for calling the event. Animation/AnimTypes.h  

float GetTriggerTime ()

 Returns the actual trigger time for this notify. Animation/AnimTypes.h  

bool IsBlueprintNotify()

 Returns true if this is blueprint or native class-based notify (i.e. not a named notify) Animation/AnimTypes.h  

bool IsBranchingPoint()

 Returns true is this AnimNotify is a BranchingPoint Animation/AnimTypes.h  

void PostSerialize ( const FArchive& Ar
)

   Animation/AnimTypes.h  

void RefreshEndTriggerOffset ( EAnimEventTriggerOffsets::Type PredictedOffsetType
)

 Updates end trigger offset based on a combination of predicted offset and current offset Animation/AnimTypes.h  

void RefreshTriggerOffset ( EAnimEventTriggerOffsets::Type PredictedOffsetType
)

 Updates trigger offset based on a combination of predicted offset and current offset Animation/AnimTypes.h  

bool Serialize ( FArchive& Ar
)

   Animation/AnimTypes.h  

void SetDuration ( float NewDuration
)

   Animation/AnimTypes.h  

Overridden from FAnimLinkableElement

Name Remarks Include Path Unreal Specifiers

virtual void SetTime ( float NewTime,
EAnimLinkMethod::Type ReferenceFrame
)

 Sets the time of this element Animation/AnimTypes.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FAnimNotifyEvent& Other
) const

   Animation/AnimTypes.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DisplayTime_DEPRECATED float The user requested time for this notify Animation/AnimTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page