1. Epic GamesDeveloper
  3. UAnimNotifyState_TimedNiagaraEffect

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.

API > API/Plugins > API/Plugins/NiagaraAnimNotifies

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.

   
Name UAnimNotifyState_TimedNiagaraEffect
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraAnimNotifies/Public/AnimNotifyState_TimedNiagaraEffect.h
Include Path #include "AnimNotifyState_TimedNiagaraEffect.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimNotifyState_TimedNiagaraEffect ( const FObjectInitializer& ObjectInitializer
)

   AnimNotifyState_TimedNiagaraEffect.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bApplyRateScaleAsTimeDilation bool Should we set the animation rate scale as time dilation on the spawn effect? AnimNotifyState_TimedNiagaraEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=NiagaraSystem
bDestroyAtEnd bool Whether or not we destroy the component at the end of the notify or instead just stop the emitters. AnimNotifyState_TimedNiagaraEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=NiagaraSystem
  • Meta=(DisplayName="Destroy Immediately", ToolTip="Whether the Niagara 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. AnimNotifyState_TimedNiagaraEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=NiagaraSystem
  • Meta=(ToolTip="Offset from the socket or bone to place the Niagara system")
RotationOffset FRotator Offset from the socket / bone rotation. AnimNotifyState_TimedNiagaraEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=NiagaraSystem
  • Meta=(ToolTip="Rotation offset from the socket or bone for the Niagara system")
Scale FVector Scale to spawn the Niagara system at. AnimNotifyState_TimedNiagaraEffect.h
  • EditAnywhere
  • Category=NiagaraSystem
SocketName FName The socket within our mesh component to attach to when we spawn the Niagara component. AnimNotifyState_TimedNiagaraEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=NiagaraSystem
  • Meta=(ToolTip="The socket or bone to attach the system to", AnimNotifyBoneName="true")
Template TObjectPtr< UNiagaraSystem > The niagara system template to use when spawning the niagara component. AnimNotifyState_TimedNiagaraEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=NiagaraSystem
  • Meta=(DisplayName="Niagara System", ToolTip="The niagara system to spawn for the notify state")

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString GetNotifyName_Implementation()

 Overridden from UAnimNotifyState to provide custom notify name. AnimNotifyState_TimedNiagaraEffect.h  

UFXSystemComponent * GetSpawnedEffect ( UMeshComponent* MeshComp
)

 Return FXSystemComponent created from SpawnEffect. AnimNotifyState_TimedNiagaraEffect.h
  • BlueprintCallable
  • Category="AnimNotify"

Overridden from UAnimNotifyState

Name Remarks Include Path Unreal Specifiers

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

   AnimNotifyState_TimedNiagaraEffect.h  

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

   AnimNotifyState_TimedNiagaraEffect.h  

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

   AnimNotifyState_TimedNiagaraEffect.h  

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

   AnimNotifyState_TimedNiagaraEffect.h  

Protected

Name Remarks Include Path Unreal Specifiers

FName GetSpawnedComponentTag()

   AnimNotifyState_TimedNiagaraEffect.h  

virtual UFXSystemComponent * SpawnEffect ( USkeletalMeshComponent* MeshComp,
UAnimSequenceBase* Animation
) const

 Spawns the NiagaraSystemComponent. Called from Notify. AnimNotifyState_TimedNiagaraEffect.h  

bool ValidateParameters ( USkeletalMeshComponent* MeshComp
) const

   AnimNotifyState_TimedNiagaraEffect.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page