FAnimNotifyEvent Struct Reference

#include <AnimTypes.h>

Inheritance diagram for FAnimNotifyEvent:

Public Member Functions
	FAnimNotifyEvent ()
virtual	~FAnimNotifyEvent ()
ENGINE_API void	RefreshTriggerOffset (EAnimEventTriggerOffsets::Type PredictedOffsetType)
ENGINE_API void	RefreshEndTriggerOffset (EAnimEventTriggerOffsets::Type PredictedOffsetType)
ENGINE_API float	GetTriggerTime () const
ENGINE_API float	GetEndTriggerTime () const
ENGINE_API float	GetDuration () const
ENGINE_API void	SetDuration (float NewDuration)
ENGINE_API bool	IsBranchingPoint () const
bool	IsBlueprintNotify () const
bool	operator== (const FAnimNotifyEvent &Other) const
ENGINE_API bool	operator< (const FAnimNotifyEvent &Other) const
virtual ENGINE_API void	SetTime (float NewTime, EAnimLinkMethod::Type ReferenceFrame=EAnimLinkMethod::Absolute) override
ENGINE_API FName	GetNotifyEventName () const
ENGINE_API FName	GetNotifyEventName (const UMirrorDataTable *MirrorDataTable) const
Public Member Functions inherited from FAnimLinkableElement
	FAnimLinkableElement ()
virtual	~FAnimLinkableElement ()
ENGINE_API void	Update ()
ENGINE_API void	Link (UAnimSequenceBase *AnimSequenceBase, float AbsTime, int32 InSlotIndex=0)
ENGINE_API void	LinkMontage (UAnimMontage *Montage, float AbsMontageTime, int32 InSlotIndex=0)
ENGINE_API void	LinkSequence (UAnimSequenceBase *Sequence, float AbsSequenceTime)
ENGINE_API void	Clear ()
ENGINE_API void	OnChanged (float NewMontageTime)
ENGINE_API float	GetTime (EAnimLinkMethod::Type ReferenceFrame=EAnimLinkMethod::Absolute) const
const UAnimSequenceBase *	GetLinkedSequence () const
const UAnimMontage *	GetLinkedMontage () const
ENGINE_API void	ChangeLinkMethod (EAnimLinkMethod::Type NewLinkMethod)
ENGINE_API void	ChangeSlotIndex (int32 NewSlotIndex)
EAnimLinkMethod::Type	GetLinkMethod () const
int32	GetSlotIndex () const
int32	GetSegmentIndex () const
void	SetSegmentIndex (int32 NewSegmentIndex)
ENGINE_API bool	ConditionalRelink ()
ENGINE_API void	RefreshSegmentOnLoad ()

Public Attributes
float	TriggerTimeOffset
float	EndTriggerTimeOffset
float	TriggerWeightThreshold
FName	NotifyName
TObjectPtr< class UAnimNotify >	Notify
TObjectPtr< class UAnimNotifyState >	NotifyStateClass
float	Duration
FAnimLinkableElement	EndLink
bool	bConvertedFromBranchingPoint
TEnumAsByte< EMontageNotifyTickType::Type >	MontageTickType
float	NotifyTriggerChance
TEnumAsByte< ENotifyFilterType::Type >	NotifyFilterType
int32	NotifyFilterLOD
bool	bCanBeFilteredViaRequest
bool	bTriggerOnDedicatedServer
bool	bTriggerOnFollower
int32	TrackIndex

Additional Inherited Members
Protected Member Functions inherited from FAnimLinkableElement
FAnimSegment *	GetSegmentAtCurrentTime ()
Protected Attributes inherited from FAnimLinkableElement
TObjectPtr< UAnimMontage >	LinkedMontage
int32	SlotIndex
int32	SegmentIndex
TEnumAsByte< EAnimLinkMethod::Type >	LinkMethod
TEnumAsByte< EAnimLinkMethod::Type >	CachedLinkMethod
float	SegmentBeginTime
float	SegmentLength
float	LinkValue
TObjectPtr< UAnimSequenceBase >	LinkedSequence

Detailed Description

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

Constructor & Destructor Documentation

FAnimNotifyEvent()

FAnimNotifyEvent::FAnimNotifyEvent ( )

inline

~FAnimNotifyEvent()

virtual FAnimNotifyEvent::~FAnimNotifyEvent ( )

inlinevirtual

Member Function Documentation

GetDuration()

float FAnimNotifyEvent::GetDuration

(

)

const

GetEndTriggerTime()

float FAnimNotifyEvent::GetEndTriggerTime

(

)

const

Returns the actual end time for a state notify. In some cases this may be different from DisplayTime + Duration

GetNotifyEventName() [1/2]

FName FAnimNotifyEvent::GetNotifyEventName

(

)

const

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

GetNotifyEventName() [2/2]

FName FAnimNotifyEvent::GetNotifyEventName

(

const UMirrorDataTable *

MirrorDataTable

)

const

Get the mirrored NotifyName pre-appended to "AnimNotify_", for calling the event. If Notify is not mirrored returns result of GetNotifyEventName()

GetTriggerTime()

float FAnimNotifyEvent::GetTriggerTime

(

)

const

Returns the actual trigger time for this notify. In some cases this may be different to the DisplayTime that has been set

IsBlueprintNotify()

bool FAnimNotifyEvent::IsBlueprintNotify ( ) const

inline

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

IsBranchingPoint()

bool FAnimNotifyEvent::IsBranchingPoint

(

)

const

Returns true is this AnimNotify is a BranchingPoint

operator<()

bool FAnimNotifyEvent::operator< ( const FAnimNotifyEvent &  Other ) const

inline

This can be used with the Sort() function on a TArray of FAnimNotifyEvents to sort the notifies array by time, earliest first.

operator==()

bool FAnimNotifyEvent::operator== ( const FAnimNotifyEvent &  Other ) const

inline

RefreshEndTriggerOffset()

void FAnimNotifyEvent::RefreshEndTriggerOffset

(

EAnimEventTriggerOffsets::Type

PredictedOffsetType

)

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

RefreshTriggerOffset()

void FAnimNotifyEvent::RefreshTriggerOffset

(

EAnimEventTriggerOffsets::Type

PredictedOffsetType

)

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

SetDuration()

void FAnimNotifyEvent::SetDuration

(

float

NewDuration

)

SetTime()

void FAnimNotifyEvent::SetTime ( float  NewTime, EAnimLinkMethod::Type  ReferenceFrame = EAnimLinkMethod::Absolute  )

overridevirtual

Sets the time of this element

Parameters

NewTime	The time to set this element to
ReferenceFrame	The kind of time being passed to this method

Reimplemented from FAnimLinkableElement.

Member Data Documentation

bCanBeFilteredViaRequest

bool FAnimNotifyEvent::bCanBeFilteredViaRequest

Allow notify event to be filtered if requested at runtime (e. g. via an Anim Graph Message)

bConvertedFromBranchingPoint

bool FAnimNotifyEvent::bConvertedFromBranchingPoint

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

bTriggerOnDedicatedServer

bool FAnimNotifyEvent::bTriggerOnDedicatedServer

If disabled this notify will be skipped on dedicated servers

bTriggerOnFollower

bool FAnimNotifyEvent::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

Duration

float FAnimNotifyEvent::Duration

EndLink

FAnimLinkableElement FAnimNotifyEvent::EndLink

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

EndTriggerTimeOffset

float FAnimNotifyEvent::EndTriggerTimeOffset

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

MontageTickType

TEnumAsByte<EMontageNotifyTickType::Type> FAnimNotifyEvent::MontageTickType

Notify

TObjectPtr<class UAnimNotify> FAnimNotifyEvent::Notify

NotifyFilterLOD

int32 FAnimNotifyEvent::NotifyFilterLOD

LOD to start filtering this notify from.

NotifyFilterType

TEnumAsByte<ENotifyFilterType::Type> FAnimNotifyEvent::NotifyFilterType

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

NotifyName

FName FAnimNotifyEvent::NotifyName

NotifyStateClass

TObjectPtr<class UAnimNotifyState> FAnimNotifyEvent::NotifyStateClass

NotifyTriggerChance

float FAnimNotifyEvent::NotifyTriggerChance

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

TrackIndex

int32 FAnimNotifyEvent::TrackIndex

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

TriggerTimeOffset

float FAnimNotifyEvent::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

TriggerWeightThreshold

float FAnimNotifyEvent::TriggerWeightThreshold

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Public/Animation/AnimTypes.h
• Engine/Source/Runtime/Engine/Private/Animation/AnimTypes.cpp