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.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

NiagaraAnimNotifies

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraAnimNotifies/Public/AnimNotifyState_TimedNiagaraEffect.h

Include

#include "AnimNotifyState_TimedNiagaraEffect.h"

Syntax

UCLASS(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

Public variable UProperty Category, EditAnywhere, Meta

bool

 

bDestroyAtEnd

Whether or not we destroy the component at the end of the notify or instead just stop the emitters.

Public variable UProperty Category, EditAnywhere, Meta

FVector

 

LocationOffset

Offset from the socket / bone location.

Public variable UProperty Category, EditAnywhere, Meta

FRotator

 

RotationOffset

Offset from the socket / bone rotation.

Public variable UProperty Category, EditAnywhere, Meta

FName

 

SocketName

The socket within our mesh component to attach to when we spawn the Niagara component.

Public variable UProperty Category, EditAnywhere, Meta

TObjectPtr< UNi...

 

Template

The niagara system template to use when spawning the niagara component.

Constructors

Name Description

Public function

UAnimNotifyState_TimedNiagaraEffect

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

FString

 

GetNotifyName_Implementation()

Overridden from UAnimNotifyState to provide custom notify name.

Protected function Const

FName

 

GetSpawnedComponentTag()

Public function UFunction BlueprintCallable, Category

UFXSystemCom...

 

GetSpawnedEffect

(
    UMeshComponent* MeshComp
)

Return FXSystemComponent created from SpawnEffect.

Protected function Virtual Const

UFXSystemCom...

 

SpawnEffect

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

Spawns the NiagaraSystemComponent. Called from Notify.

Protected function Const

bool

 

ValidateParameters

(
    USkeletalMeshComponent* MeshCo...
)

Overridden from UAnimNotifyState

Name Description

Public function Virtual

void

 

NotifyBegin

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

Public function Virtual

void

 

NotifyEnd

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

Deprecated Functions

Name Description

Public function Virtual

void

 

NotifyBegin

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

Please use the other NotifyBegin function instead

Public function Virtual

void

 

NotifyEnd

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

Please use the other NotifyEnd function instead