Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Animation > AnimNotifies > UAnimNotifyState_TimedParticleEffect

Light Theme

Dark Theme

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.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimNotifyState

UAnimNotifyState_TimedParticleEffect

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h
Include	#include "Animation/AnimNotifies/AnimNotifyState_TimedParticleEffect.h"

Syntax

class UAnimNotifyState_TimedParticleEffect : public UAnimNotifyState

Remarks

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.

Variables

	Name	Description
bool	bDestroyAtEnd	Whether or not we destroy the component at the end of the notify or instead just stop the emitters.
FVector	LocationOffset	Offset from the socket / bone location.
TArray< UPartic...	PreviousPSTemplates	The following arrays are used to handle property changes during a state.
TArray< FName >	PreviousSocketNames
UParticleSystem...	PSTemplate	The particle system template to use when spawning the particle component.
FRotator	RotationOffset	Offset from the socket / bone rotation.
FName	SocketName	The socket within our mesh component to attach to when we spawn the particle component.

Constructors

	Name	Description
	UAnimNotifyState_TimedParticleEffect ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	FString	GetNotifyName_Implementation()	Overridden from UAnimNotifyState to provide custom notify name.
	bool	ValidateParameters ( USkeletalMeshComponent* MeshCo... )

Overridden from UAnimNotifyState

		Name	Description
	void	NotifyBegin ( USkeletalMeshComponent* MeshCo..., UAnimSequenceBase* Animation, float TotalDuration )
	void	NotifyEnd ( USkeletalMeshComponent* MeshCo..., UAnimSequenceBase* Animation )
	void	NotifyTick ( USkeletalMeshComponent* MeshCo..., UAnimSequenceBase* Animation, float FrameDeltaTime )

Overridden from UObject

		Name	Description
	void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss