Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UNiagaraComponent

UNiagaraComponent

[UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) is the primitive component for a Niagara System.

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS (ClassGroup=(Rendering, Common), Blueprintable, HideCategories=Object,  
       HideCategories=Physics, HideCategories=Collision, ShowCategories=Trigger, EditInlineNew,  
       Meta=(BlueprintSpawnableComponent, DisplayName="Niagara Particle System Component"),  
       MinimalAPI)  
class UNiagaraComponent : public UFXSystemComponent

Remarks

UNiagaraComponent is the primitive component for a Niagara System.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EAttachmentRule AutoAttachLocationRule Options for how we handle our location when we attach to the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, Meta BlueprintReadWrite visibleinstanceonly TWeakObjectPtr< USceneComponent > AutoAttachParent Component we automatically attach to when activated, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EAttachmentRule AutoAttachRotationRule Options for how we handle our rotation when we attach to the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EAttachmentRule AutoAttachScaleRule Options for how we handle our scale when we attach to the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName AutoAttachSocketName Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint32: 1 bAutoAttachWeldSimulatedBodies Option for how we handle bWeldSimulatedBodies when we attach to the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly uint32: 1 bAutoManageAttachment True if we should automatically attach to AutoAttachParent when activated, and detach from our parent when completed.
Public variable uint32: 1 bEnablePreviewLODDistance  
Public variable UProperty Category, EditAnywhere uint32: 1 bWaitForCompilationOnActivate  
Public variable UProperty float MaxTimeBeforeForceUpdateTransform Time between forced UpdateTransforms for systems that use dynamically calculated bounds, Which is effectively how often the bounds are shrunk.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly ENiagaraOcclusionQueryMode OcclusionQueryMode  
Public variable UProperty BlueprintAssignable duplicatetransient FOnNiagaraSystemFinished OnSystemFinished Called when the particle system is done.
Public variable ENCPoolMethod PoolingMethod How to handle pooling for this component instance.
Public variable float PreviewLODDistance  
Public variable float PreviewMaxDistance  

Constructors

  Type Name Description
Public function  

UNiagaraComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

Activate ( bool bReset
)

  
Public function Virtual void

ActivateSystem ( bool bFlagAsJustAttached
)

  
Public function Virtual Const const UObject *  
Public function UFunction BlueprintCallable, Category void

AdvanceSimulation ( int32 TickCount,
float TickDeltaSeconds
)

 Advances this system's simulation by the specified number of ticks and delta time.
Public function UFunction BlueprintCallable, Category void

AdvanceSimulationByTime ( float SimulateTime,
float TickDeltaSeconds
)

 Advances this system's simulation by the specified time in seconds and delta time.
Protected function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

  
Protected function Virtual void  
Public function void  
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

  
Public function UFunction BlueprintCallable, Category void

ClearEmitterFixedBounds ( FName EmitterName
)

 Clear any previously set fixed bounds for the emitter instance.
Public function UFunction BlueprintCallable, Category void

ClearSimCache ( bool bResetSystem
)

 Clear any active simulation cache.
Public function UFunction BlueprintCallable, Category void Clear any previously set fixed bounds for the system instance.
Public function Virtual void

CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FMaterialInterfacePSOPrecacheParamsList& OutParams
)

  
Protected function Virtual void

CreateRenderState_Concurrent ( FRegisterComponentContext* Context
)

  
Public function Virtual FPrimitiveSceneProxy *  
Public function Virtual void  
Public function Virtual void  
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function void  
Public function void  
Protected function Virtual void  
Public function void  
Public function Const void  
Public function Const FNiagaraVariant Find the value of an overridden parameter.
Public function Const UFunction BlueprintCallable, Category, Meta ENiagaraAgeUpdateMode  
Public function Const UFunction blueprintgetter bool  
Public function Virtual Const uint32  
Public function Const UFunction BlueprintCallable, Category, Meta UNiagaraSystem *  
Public function Const FNiagaraVariant Gets the current value of a parameter which is being used by the simulation.
Public function Const UFunction BlueprintCallable, Category float  
Public function UFunction BlueprintCallable, Category UNiagaraDataInterface *

GetDataInterface ( const FString& Name
)

  
Public function Const UFunction BlueprintCallable, Category, Meta float Gets the desired age of the System instance.
Public function Const UFunction BlueprintCallable, Category FBox

GetEmitterFixedBounds ( FName EmitterName
)

 Gets the fixed bounds for an emitter instance.
Public function Const ENiagaraExecutionState  
Public function Virtual Const FName  
Public function Const UFunction blueprintgetter bool  
Public function Const UFunction BlueprintCallable, Category, Meta bool  
Public function Virtual Const UFXSystemAsset *  
Public function Const UFunction BlueprintCallable, Category bool Gets whether or not the delta time used to tick the system instance when using desired age is locked to the seek delta.
Public function Const UFunction BlueprintCallable, Category, Meta float Get the maximum CPU time in seconds we will simulate to the desired age, when we go beyond this limit ticks will be processed in the next frame.
Public function Virtual Const int32  
Public function Const UFunction BlueprintCallable, Category ENiagaraOcclusionQueryMode  
Public function FNiagaraUserRedirectionParameterStore &  
Public function Const const FNiagaraParameterStore &  
Public function FParticlePerfStatsContext  
Public function Const UFunction BlueprintCallable, Category, Meta float  
Public function Const UFunction BlueprintCallable, Category, Meta bool  
Public function Const UFunction BlueprintCallable, Category, Meta int32  
Public function Const bool Gets whether or not rendering is enabled for this component.
Public function Const ENiagaraExecutionState  
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

  
Public function Const int32  
Public function Const UFunction BlueprintCallable, Category, Meta float Gets the delta value which is used when seeking from the current age, to the desired age.
Public function Const UFunction BlueprintCallable, Category UNiagaraSimCache * Get the active simulation cache, will return null if we do not have an active one.
Public function Virtual Const void

GetStreamingRenderAssetInfo ( FStreamingTextureLevelContext& LevelContext,
TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingRenderAssets
)

  
Public function Const UFunction BlueprintCallable, Category FBox Gets the fixed bounds for the system instance.
Public function Const FNiagaraSystemInstance *  
Public function FNiagaraSystemInstanceControllerPtr  
Public function Const FNiagaraSystemInstanceControllerConstPtr  
Public function TSharedPtr< FNiagaraSystemSimulation, ESPMode::ThreadSafe >  
Public function Const UFunction BlueprintCallable, Category, Meta ENiagaraTickBehavior  
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

  
Public function Const bool  
Public function UFunction BlueprintCallable, Category, Meta void Initializes this component for capturing a performance baseline.
Public function bool  
Public function Const bool  
Public function Const bool Is this an effect on or linked to the local player.
Public function Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Virtual void  
Public function Virtual void

OnChildAttached ( USceneComponent* ChildComponent
)

  
Public function Virtual void

OnChildDetached ( USceneComponent* ChildComponent
)

  
Public function Virtual void  
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

  
Protected function Virtual void  
Public function void

OnPooledReuse ( UWorld* NewWorld
)

  
Protected function Virtual void  
Public function FOnSynchronizedWithAssetParameters &  
Public function FOnSystemInstanceChanged &  
Protected function Virtual void  
Public function Virtual void  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function void  
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

  
Public function UFunction BlueprintCallable, Category, Meta void Called on when an external object wishes to force this System to reinitialize itself from the System data.
Public function Virtual void  
Public function void Remove an override for a given parameter if one exists.
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category, Meta void Resets the System to it's initial pre-simulated state.
Public function bool

ResolveOwnerAllowsScalability ( bool bRegister
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SeekToDesiredAge ( float InDesiredAge
)

 Sets the desired age of the System instance and designates that this change is a seek.
Protected function Virtual void  
Public function Virtual void  
Public function Virtual void

SetActorParameter ( FName ParameterName,
AActor* Param
)

  
Public function UFunction BlueprintCallable, Category, Meta void Sets the age update mode for the System instance.
Public function UFunction Category, Meta blueprintsetter void

SetAllowScalability ( bool bAllow
)

 Set whether this component is allowed to perform scalability checks and potentially be culled etc.
Public function UFunction BlueprintCallable, Category, Meta void

SetAsset ( UNiagaraSystem* InAsset,
bool bResetExistingOverrideParameters
)

 Switch which asset the component is using.
Public function void

SetAutoAttachmentParameters ( USceneComponent* Parent,
FName SocketName,
EAttachmentRule LocationRule,
EAttachmentRule RotationRule,
EAttachmentRule ScaleRule
)

 Set AutoAttachParent, AutoAttachSocketName, AutoAttachLocationRule, AutoAttachRotationRule, AutoAttachScaleRule to the specified parameters.
Public function UFunction BlueprintCallable, Category, Meta void

SetAutoDestroy ( bool bInAutoDestroy
)

  
Public function Virtual void

SetBoolParameter ( FName ParameterName,
bool Param
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetCanRenderWhileSeeking ( bool bInCanRenderWhileSeeking
)

 Sets whether or not the system can render while seeking.
Public function Virtual void

SetColorParameter ( FName ParameterName,
FLinearColor Param
)

  
Public function UFunction BlueprintCallable, Category void

SetCustomTimeDilation ( float Dilation
)

 Sets the custom time dilation value for the component.
Public function UFunction BlueprintCallable, Category, Meta void

SetDesiredAge ( float InDesiredAge
)

 Sets the desired age of the System instance.
Public function Virtual void

SetEmitterEnable ( FName EmitterName,
bool bNewEnableState
)

  
Public function UFunction BlueprintCallable, Category void

SetEmitterFixedBounds ( FName EmitterName,
FBox LocalBounds
)

 Sets the fixed bounds for an emitter instance, this overrides all other bounds.
Public function Virtual void

SetFloatParameter ( FName ParameterName,
float Param
)

  
Public function UFunction Category, Meta blueprintsetter void

SetForceLocalPlayerEffect ( bool bIsPlayerEffect
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetForceSolo ( bool bInForceSolo
)

  
Public function UFunction BlueprintCallable, Category void

SetGpuComputeDebug ( bool bEnableDebug
)

  
Public function Virtual void

SetIntParameter ( FName ParameterName,
int Param
)

  
Public function UFunction BlueprintCallable, Category void Sets whether or not the delta time used to tick the system instance when using desired age is locked to the seek delta.
Public function void

SetLODDistance ( float InLODDistance,
float InMaxLODDistance
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetMaxSimTime ( float InMaxTime
)

 Sets the maximum CPU time in seconds we will simulate to the desired age, when we go beyond this limit ticks will be processed in the next frame.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableActor ( const FString& InVariableName,
AActor* Actor
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableBool ( const FString& InVariableName,
bool InValue
)

 Sets a Niagara bool parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableFloat ( const FString& InVariableName,
float InValue
)

 Sets a Niagara float parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableInt ( const FString& InVariableName,
int32 InValue
)

 Sets a Niagara int parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableLinearColor ( const FString& InVariableName,
const FLinearColor& InValue
)

 Sets a Niagara FLinearColor parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableMatrix ( const FString& InVariableName,
const FMatrix& InValue
)

 Sets a Niagara matrix parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableObject ( const FString& InVariableName,
UObject* Object
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariablePosition ( const FString& InVariableName,
FVector InValue
)

 Sets a Niagara Position parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableQuat ( const FString& InVariableName,
const FQuat& InValue
)

 Sets a Niagara quaternion parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableVec2 ( const FString& InVariableName,
FVector2D InValue
)

 Sets a Niagara Vector2 parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableVec3 ( const FString& InVariableName,
FVector InValue
)

 Sets a Niagara Vector3 parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetNiagaraVariableVec4 ( const FString& InVariableName,
const FVector4& InValue
)

 Sets a Niagara Vector4 parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category void  
Public function void

SetParameterOverride ( const FNiagaraVariableBase& InKey,
const FNiagaraVariant& InValue
)

  
Public function UFunction BlueprintCallable, Category void

SetPaused ( bool bInPaused
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetPreviewLODDistance ( bool bEnablePreviewLODDistance,
float PreviewLODDistance,
float PreviewMaxDistance
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetRandomSeedOffset ( int32 NewRandomSeedOffset
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetRenderingEnabled ( bool bInRenderingEnabled
)

 Sets whether or not rendering is enabled for this component.
Public function UFunction BlueprintCallable, Category, Meta void

SetSeekDelta ( float InSeekDelta
)

 Sets the delta value which is used when seeking from the current age, to the desired age.
Public function UFunction BlueprintCallable, Category void

SetSimCache ( UNiagaraSimCache* SimCache,
bool bResetSystem
)

 Sets the simulation cache to use for the component.
Public function UFunction BlueprintCallable, Category void

SetSystemFixedBounds ( FBox LocalBounds
)

 Sets the fixed bounds for the system instance, this overrides all other bounds.
Public function void The significant index for this component.
Public function UFunction BlueprintCallable, Category, Meta void  
Public function Virtual void

SetUseAutoManageAttachment ( bool bAutoManage
)

  
Public function void Removes all local overrides and replaces them with the values from the source System - note: this also removes the editor overrides from the component as it is used by the pooling mechanism to prevent values leaking between different instances.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableActor ( FName InVariableName,
AActor* Actor
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableBool ( FName InVariableName,
bool InValue
)

 Sets a Niagara bool parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableFloat ( FName InVariableName,
float InValue
)

 Sets a Niagara float parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableInt ( FName InVariableName,
int32 InValue
)

 Sets a Niagara int parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableLinearColor ( FName InVariableName,
const FLinearColor& InValue
)

 Sets a Niagara FLinearColor parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableMaterial ( FName InVariableName,
UMaterialInterface* Object
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableMatrix ( FName InVariableName,
const FMatrix& InValue
)

 Sets a Niagara matrix parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableObject ( FName InVariableName,
UObject* Object
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetVariablePosition ( FName InVariableName,
FVector InValue
)

 Sets a Niagara Position parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableQuat ( FName InVariableName,
const FQuat& InValue
)

 Sets a Niagara quaternion parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableStaticMesh ( FName InVariableName,
UStaticMesh* InValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableTexture ( FName InVariableName,
UTexture* Texture
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableTextureRenderTarget ( FName InVariableName,
UTextureRenderTarget* TextureRenderTarget
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableVec2 ( FName InVariableName,
FVector2D InValue
)

 Sets a Niagara Vector2 parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableVec3 ( FName InVariableName,
FVector InValue
)

 Sets a Niagara Vector3 parameter by name, overriding locally if necessary.
Public function UFunction BlueprintCallable, Category, Meta void

SetVariableVec4 ( FName InVariableName,
const FVector4& InValue
)

 Sets a Niagara Vector4 parameter by name, overriding locally if necessary.
Public function Virtual void

SetVectorParameter ( FName ParameterName,
FVector Param
)

  
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  
Public function void  

Typedefs

Name Description
FOnSynchronizedWithAssetParameters  
FOnSystemInstanceChanged  

See Also

ANiagaraActor

UNiagaraSystem

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page