UAnimNotify

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Animation/AnimNotifies/AnimNotify.h

Include

#include "Animation/AnimNotifies/AnimNotify.h"

Syntax

class UAnimNotify : public UObject

Variables

Name Description

Public variable

bool

 

bIsNativeBranchingPoint

End UObject Interface This notify is always a branching point when used on Montages.

Public variable

bool

 

bShouldFireInEditor

Whether this notify instance should fire in animation editors

Public variable

FColor

 

NotifyColor

Color of Notify in editor

Constructors

Name Description

Public function

UAnimNotify

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual Const

bool

 

CanBePlaced

(
    UAnimSequenceBase* Animation
)

Protected function Const

UObject *...

 

GetContainingAsset()

Public function Const

float

 

GetDefaultTriggerWeightThreshold()

TriggerWeightThreshold to use when creating notifies of this type

Public function Virtual

FLinearColor

 

GetEditorColor()

Public function Virtual

FString

 

GetEditorComment()

Public function Const

FString

 

GetNotifyName()

Implementable event to get a custom name for the notify

Public function Virtual Const

UWorld *

 

GetWorld()

We don't instance UAnimNotify objects along with the animations they belong to, but we still need a way to see which world this UAnimNotify is currently operating on.

Public function Virtual

void

 

OnAnimNotifyCreatedInEditor

(
    FAnimNotifyEvent& ContainingAnimNo...
)

Public function Const

bool

 

Received_Notify

(
    USkeletalMeshComponent* MeshCo...,
    UAnimSequenceBase* Animation,
    const FAnimNotifyEventReference& E...
)

Public function Virtual

bool

 

ShouldFireInEditor()

Override this to prevent firing this notify type in animation editors

Public function Virtual

void

 

ValidateAssociatedAssets()

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

UObject Interface

Public function Virtual

void

 

PreSave

(
    FObjectPreSaveContext SaveContext
)

Presave function.

Deprecated Functions

Name Description

Public function Virtual

void

 

BranchingPointNotify

(
    FBranchingPointNotifyPayload& Bran...
)

Please use the other Notify function instead

Public function Virtual

void

 

Notify

(
    USkeletalMeshComponent* MeshCo...,
    UAnimSequenceBase* Animation,
    const FAnimNotifyEventReference& E...
)

Please use the other Notify function instead

Public function Virtual

void

 

Notify

(
    USkeletalMeshComponent* MeshCo...,
    UAnimSequenceBase* Animation
)

Please use the other Notify function instead

Public function Virtual

void

 

PreSave

(
    const ITargetPlatform* TargetP...
)

Use version that takes FObjectPreSaveContext instead.