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

Public variable

bool

 

bConvertedFromBranchingPoint

If TRUE, this notify has been converted from an old BranchingPoint.

Public variable

bool

 

bTriggerOnDedicatedServer

If disabled this notify will be skipped on dedicated servers

Public variable

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

Public variable

float

 

Duration

Public variable

FAnimLinkableEl...

 

EndLink

Linkable element to use for the end handle representing a notify state duration

Public variable

float

 

EndTriggerTimeOffset

An offset similar to TriggerTimeOffset but used for the end scrub handle of a notify state's duration

Public variable

TEnumAsByte< EM...

 

MontageTickType

Public variable

UAnimNotify ...

 

Notify

Public variable

FColor

 

NotifyColor

Color of Notify in editor

Public variable

int32

 

NotifyFilterLOD

LOD to start filtering this notify from.

Public variable

TEnumAsByte< EN...

 

NotifyFilterType

Defines a method for filtering notifies (stopping them triggering) e.g. by looking at the meshes current LOD

Public variable

FName

 

NotifyName

Public variable

UAnimNotifyStat...

 

NotifyStateClass

Public variable

float

 

NotifyTriggerChance

Defines the chance of of this notify triggering, 0 = No Chance, 1 = Always triggers

Public variable

int32

 

TrackIndex

'Track' that the notify exists on, used for visual placement in editor and sorting priority in runtime

Public variable

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

Public variable

float

 

TriggerWeightThreshold

Constructors

Name Description

Public function

FAnimNotifyEvent()

Destructors

Name Description

Public function Virtual

~FAnimNotifyEvent()

Functions

Name Description

Public function Const

float

 

GetDuration()

Public function Const

float

 

GetEndTriggerTime()

Returns the actual end time for a state notify.

Public function Const

FName

 

GetNotifyEventName()

Get the NotifyName pre-appended to "AnimNotify_", for calling the event

Public function Const

float

 

GetTriggerTime()

Returns the actual trigger time for this notify.

Public function Const

bool

 

IsBlueprintNotify()

Returns true if this is blueprint derived notifies

Public function Const

bool

 

IsBranchingPoint()

Returns true is this AnimNotify is a BranchingPoint

Public function

void

 

RefreshEndTriggerOffset

(
    EAnimEventTriggerOffsets::Type Pred...
)

Updates end trigger offset based on a combination of predicted offset and current offset

Public function

void

 

RefreshTriggerOffset

(
    EAnimEventTriggerOffsets::Type Pred...
)

Updates trigger offset based on a combination of predicted offset and current offset

Public function

void

 

SetDuration

(
    float NewDuration
)

Overridden from FAnimLinkableElement

Name Description

Public function Virtual

void

 

SetTime

(
    float NewTime,
    EAnimLinkMethod::Type ReferenceFram...
)

Sets the time of this element

Operators

Name Description

Public function Const

bool

 

operator<

(
    const FAnimNotifyEvent& Other
)

Used by UAnimSequenceBase::SortNotifies() to sort its Notifies array.

Public function Const

bool

 

operator==

(
    const FAnimNotifyEvent& Other
)

Deprecated Variables

Name Description

Public variable

float

 

DisplayTime_DEPRECATED

The user requested time for this notify

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback