1. Epic GamesDeveloper
  3. UAnimNotifyState_TimedParticleEffect

UAnimNotifyState_TimedParticleEffect

Timed Particle Effect Notify Allows a looping particle effect to be played in an animation that will activate at the beginning of the notify and deactivate at the end.

API > API/Runtime > API/Runtime/Engine

Timed Particle Effect Notify Allows a looping particle effect to be played in an animation that will activate at the beginning of the notify and deactivate at the end.

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

Syntax

UCLASS (Blueprintable, Meta=(DisplayName="Timed Particle Effect"), MinimalAPI)  
class UAnimNotifyState_TimedParticleEffect : public UAnimNotifyState

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimNotifyState_TimedParticleEffect ( const FObjectInitializer& ObjectInitializer
)

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDestroyAtEnd bool Whether or not we destroy the component at the end of the notify or instead just stop the emitters. Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h
  • EditAnywhere
  • Category=ParticleSystem
  • Meta=(DisplayName="Destroy Immediately", ToolTip="Whether the particle system should be immediately destroyed at the end of the notify state or be allowed to finish")
LocationOffset FVector Offset from the socket / bone location. Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h
  • EditAnywhere
  • Category=ParticleSystem
  • Meta=(ToolTip="Offset from the socket or bone to place the particle system")
PreviousPSTemplates TArray< TObjectPtr< UParticleSystem > > The following arrays are used to handle property changes during a state. Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h
  • Transient
PreviousSocketNames TArray< FName >   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h
  • Transient
PSTemplate TObjectPtr< UParticleSystem > The particle system template to use when spawning the particle component. Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h
  • EditAnywhere
  • Category=ParticleSystem
  • Meta=(ToolTip="The particle system to spawn for the notify state")
RotationOffset FRotator Offset from the socket / bone rotation. Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h
  • EditAnywhere
  • Category=ParticleSystem
  • Meta=(ToolTip="Rotation offset from the socket or bone for the particle system")
SocketName FName The socket within our mesh component to attach to when we spawn the particle component. Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h
  • EditAnywhere
  • Category=ParticleSystem
  • Meta=(ToolTip="The socket or bone to attach the system to")

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString GetNotifyName_Implementation()

 Overridden from UAnimNotifyState to provide custom notify name. Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

Overridden from UAnimNotifyState

Name Remarks Include Path Unreal Specifiers

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

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

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

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

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

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

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

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

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

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

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

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool ValidateParameters ( USkeletalMeshComponent* MeshComp
)

   Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page