1. Epic GamesDeveloper
  3. UAnimNotifyState

UAnimNotifyState

API > API/Runtime > API/Runtime/Engine

   
Name UAnimNotifyState
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimNotifies/AnimNotifyState.h
Include Path #include "Animation/AnimNotifies/AnimNotifyState.h"

Syntax

UCLASS (Abstract, EditInlineNew, Blueprintable, Const, HideCategories=Object, CollapseCategories,  
       Meta=(ShowWorldContextPin), MinimalAPI)  
class UAnimNotifyState : public UObject

Inheritance Hierarchy

Derived Classes

UAnimNotifyState derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimNotifyState ( const FObjectInitializer& ObjectInitializer
)

   Animation/AnimNotifies/AnimNotifyState.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsNativeBranchingPoint bool End UObject Interface This notify is always a branching point when used on Montages. Animation/AnimNotifies/AnimNotifyState.h  
bShouldFireInEditor bool Whether this notify state instance should fire in animation editors Animation/AnimNotifies/AnimNotifyState.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=AnimNotify
NotifyColor FColor Color of Notify in editor Animation/AnimNotifies/AnimNotifyState.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AnimNotify

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void BranchingPointNotifyBegin ( FBranchingPointNotifyPayload& BranchingPointPayload
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void BranchingPointNotifyEnd ( FBranchingPointNotifyPayload& BranchingPointPayload
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void BranchingPointNotifyTick ( FBranchingPointNotifyPayload& BranchingPointPayload,
float FrameDeltaTime
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual bool CanBePlaced ( UAnimSequenceBase* Animation
) const

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void DrawCanvasInEditor ( FCanvas& Canvas,
FSceneView& View,
USkeletalMeshComponent* MeshComp,
const UAnimSequenceBase* Animation,
const FAnimNotifyEvent& NotifyEvent
) const

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void DrawInEditor ( FPrimitiveDrawInterface* PDI,
USkeletalMeshComponent* MeshComp,
const UAnimSequenceBase* Animation,
const FAnimNotifyEvent& NotifyEvent
) const

   Animation/AnimNotifies/AnimNotifyState.h  

float GetDefaultTriggerWeightThreshold()

 TriggerWeightThreshold to use when creating notifies of this type Animation/AnimNotifies/AnimNotifyState.h
  • BlueprintNativeEvent

virtual FLinearColor GetEditorColor()

   Animation/AnimNotifies/AnimNotifyState.h  

virtual FString GetEditorComment()

   Animation/AnimNotifies/AnimNotifyState.h  

FString GetNotifyName()

 Implementable event to get a custom name for the notify Animation/AnimNotifies/AnimNotifyState.h
  • BlueprintNativeEvent

virtual void NotifyBegin ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation,
float TotalDuration,
const FAnimNotifyEventReference& EventReference
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void NotifyBegin ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation,
float TotalDuration
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void NotifyEnd ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation,
const FAnimNotifyEventReference& EventReference
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void NotifyEnd ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void NotifyTick ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation,
float FrameDeltaTime,
const FAnimNotifyEventReference& EventReference
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void NotifyTick ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation,
float FrameDeltaTime
)

   Animation/AnimNotifies/AnimNotifyState.h  

virtual void OnAnimNotifyCreatedInEditor ( FAnimNotifyEvent& ContainingAnimNotifyEvent
)

   Animation/AnimNotifies/AnimNotifyState.h  

bool Received_NotifyBegin ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation,
float TotalDuration,
const FAnimNotifyEventReference& EventReference
) const

   Animation/AnimNotifies/AnimNotifyState.h
  • BlueprintImplementableEvent
  • Meta=(AutoCreateRefTerm="EventReference")

bool Received_NotifyEnd ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation,
const FAnimNotifyEventReference& EventReference
) const

   Animation/AnimNotifies/AnimNotifyState.h
  • BlueprintImplementableEvent
  • Meta=(AutoCreateRefTerm="EventReference")

bool Received_NotifyTick ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation,
float FrameDeltaTime,
const FAnimNotifyEventReference& EventReference
) const

   Animation/AnimNotifies/AnimNotifyState.h
  • BlueprintImplementableEvent
  • Meta=(AutoCreateRefTerm="EventReference")

virtual bool ShouldFireInEditor()

 Override this to prevent firing this notify state type in animation editors Animation/AnimNotifies/AnimNotifyState.h  

virtual void ValidateAssociatedAssets()

   Animation/AnimNotifies/AnimNotifyState.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

 UObject Interface Animation/AnimNotifies/AnimNotifyState.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Animation/AnimNotifies/AnimNotifyState.h  

Protected

Name Remarks Include Path Unreal Specifiers

UObject * GetContainingAsset()

   Animation/AnimNotifies/AnimNotifyState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page