Navigation
API > API/Plugins > API/Plugins/NiagaraAnimNotifies
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&40;Blueprintable, Meta&61;&40;DisplayName&61;"Timed Niagara Effect"&41;, MinimalAPI&41;
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
| Type | 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. | |
| TObjectPtr< UNiagaraSystem > | Template | The niagara system template to use when spawning the niagara component. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UAnimNotifyState_TimedNiagaraEffect
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FString | Overridden from UAnimNotifyState to provide custom notify name. | ||
| FName | |||
| UFXSystemComponent * | GetSpawnedEffect
(
UMeshComponent* MeshComp |
Return FXSystemComponent created from SpawnEffect. | |
| UFXSystemComponent * | SpawnEffect
(
USkeletalMeshComponent* MeshComp, |
Spawns the NiagaraSystemComponent. Called from Notify. | |
| bool | ValidateParameters
(
USkeletalMeshComponent* MeshComp |
Overridden from UAnimNotifyState
| Type | Name | Description | |
|---|---|---|---|
| void | NotifyBegin
(
USkeletalMeshComponent* MeshComp, |
||
| void | NotifyEnd
(
USkeletalMeshComponent* MeshComp, |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| void | NotifyBegin
(
USkeletalMeshComponent* MeshComp, |
Please use the other NotifyBegin function instead | |
| void | NotifyEnd
(
USkeletalMeshComponent* MeshComp, |
Please use the other NotifyEnd function instead |