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 > Plugins > NiagaraAnimNotifies > UAnimNotifyState_TimedNiagaraEffect

Light Theme

Dark Theme

UAnimNotifyState_TimedNiagaraEffect

Timed Niagara Effect Notify Allows a looping Niagara 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_TimedNiagaraEffect

UAnimNotifyState_TimedNiagaraEffectAdvanced

References

Module	NiagaraAnimNotifies
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraAnimNotifies/Public/AnimNotifyState_TimedNiagaraEffect.h
Include	#include "AnimNotifyState_TimedNiagaraEffect.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Meta=(DisplayName="Timed Niagara Effect"))
class UAnimNotifyState_TimedNiagaraEffect : public UAnimNotifyState

Remarks

Timed Niagara Effect Notify Allows a looping Niagara 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.
FRotator	RotationOffset	Offset from the socket / bone rotation.
FName	SocketName	The socket within our mesh component to attach to when we spawn the Niagara component.
UNiagaraSystem ...	Template	The niagara system template to use when spawning the niagara component.

Constructors

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

Functions

	Name	Description
FString	GetNotifyName_Implementation()	Overridden from UAnimNotifyState to provide custom notify name.
FName	GetSpawnedComponentTag()
UFXSystemCom...	GetSpawnedEffect ( UMeshComponent* MeshComp )	Return FXSystemComponent created from SpawnEffect.
UFXSystemCom...	SpawnEffect ( USkeletalMeshComponent* MeshCo..., UAnimSequenceBase* Animation )	Spawns the NiagaraSystemComponent. Called from Notify.
bool	ValidateParameters ( USkeletalMeshComponent* MeshCo... )

Overridden from UAnimNotifyState

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

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

Take our survey

Dismiss