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

UNiagaraComponent is the primitive component for a Niagara System.

   
Name UNiagaraComponent
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraComponent.h
Include Path #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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraComponent ( const FObjectInitializer& ObjectInitializer
)

   NiagaraComponent.h  

Structs

Name Remarks
FEmitterOverrideInfo  

Typedefs

Name Type Remarks Include Path
FOnSynchronizedWithAssetParameters TMulticastDelegate_NoParams< void >   NiagaraComponent.h
FOnSystemInstanceChanged TMulticastDelegate_NoParams< void >   NiagaraComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AutoAttachLocationRule EAttachmentRule Options for how we handle our location when we attach to the AutoAttachParent, if bAutoManageAttachment is true. NiagaraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Attachment
  • Meta=(EditCondition="bAutoManageAttachment")
AutoAttachParent TWeakObjectPtr< USceneComponent > Component we automatically attach to when activated, if bAutoManageAttachment is true. NiagaraComponent.h
  • VisibleInstanceOnly
  • BlueprintReadWrite
  • Category=Attachment
  • Meta=(EditCondition="bAutoManageAttachment")
AutoAttachRotationRule EAttachmentRule Options for how we handle our rotation when we attach to the AutoAttachParent, if bAutoManageAttachment is true. NiagaraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Attachment
  • Meta=(EditCondition="bAutoManageAttachment")
AutoAttachScaleRule EAttachmentRule Options for how we handle our scale when we attach to the AutoAttachParent, if bAutoManageAttachment is true. NiagaraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Attachment
  • Meta=(EditCondition="bAutoManageAttachment")
AutoAttachSocketName FName Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true. NiagaraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Attachment
  • Meta=(EditCondition="bAutoManageAttachment")
bAutoAttachWeldSimulatedBodies uint32 Option for how we handle bWeldSimulatedBodies when we attach to the AutoAttachParent, if bAutoManageAttachment is true. NiagaraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Attachment
  • Meta=(EditCondition="bAutoManageAttachment")
bAutoManageAttachment uint32 True if we should automatically attach to AutoAttachParent when activated, and detach from our parent when completed. NiagaraComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Attachment
bEnablePreviewLODDistance uint32   NiagaraComponent.h  
bWaitForCompilationOnActivate uint32   NiagaraComponent.h
  • EditAnywhere
  • Category=Compilation
MaxTimeBeforeForceUpdateTransform float Time between forced UpdateTransforms for systems that use dynamically calculated bounds, Which is effectively how often the bounds are shrunk. NiagaraComponent.h  
OnSystemFinished FOnNiagaraSystemFinished Called when the particle system is done. NiagaraComponent.h
  • BlueprintAssignable
  • DuplicateTransient
PoolingMethod ENCPoolMethod How to handle pooling for this component instance. NiagaraComponent.h  
PreviewLODDistance float   NiagaraComponent.h  
PreviewMaxDistance float   NiagaraComponent.h  
SimCacheDebugNumFramesToCapture TOptional< int32 >   NiagaraComponent.h
  • EditAnywhere
  • Category="Niagara Utilities"
  • Meta=(UIMin="1", ClampMin="1", DisplayName="NumFramesToCapture")

Protected

Name Type Remarks Include Path Unreal Specifiers
AgeUpdateMode ENiagaraAgeUpdateMode Defines the mode use when updating the System age. NiagaraComponent.h  
Asset TObjectPtr< UNiagaraSystem >   NiagaraComponent.h
  • EditAnywhere
  • Category="Niagara"
  • Meta=(DisplayName="Niagara System Asset")
AssetExposedParametersChangedHandle FDelegateHandle   NiagaraComponent.h  
bActivateShouldResetWhenReady uint32 Should we try and reset when ready? NiagaraComponent.h  
bAllowScalability uint32 Controls whether we allow scalability culling for this component. NiagaraComponent.h
  • EditAnywhere
  • Category=Niagara
  • BlueprintGetter=GetAllowScalability
  • BlueprintSetter=SetAllowScalability
bAutoDestroy uint32   NiagaraComponent.h  
bAwaitingActivationDueToNotReady uint32 Did we try and activate but fail due to the asset being not yet ready. Keep looping. NiagaraComponent.h  
bCanRenderWhileSeeking bool Whether or not the component can render while seeking to the desired age. NiagaraComponent.h  
bDesiredPauseState uint32 Stores the current state for pause/unpause desired by the use. NiagaraComponent.h  
bDidAutoAttach uint32 Did we auto attach during activation? Used to determine if we should restore the relative transform during detachment. NiagaraComponent.h  
bDuringUpdateContextReset uint32 Flag to mark us as currently changing auto attachment as part of Activate/Deactivate so we don't reset in the OnAttachmentChanged() callback. NiagaraComponent.h  
bEnableGpuComputeDebug uint32 When true the GPU simulation debug display will enabled, allowing information used during simulation to be visualized. NiagaraComponent.h
  • EditAnywhere
  • Category=Parameters
bForceLocalPlayerEffect uint32 Flag allowing us to force this Effect to be considered a LocalPlayer Effect. NiagaraComponent.h  
bForceSolo uint32 When true, this component's system will be force to update via a slower "solo" path rather than the more optimal batched path with other instances of the same system. NiagaraComponent.h  
bIsCulledByScalability uint32 True if this component has been culled by the scalability manager. NiagaraComponent.h  
bIsFullyComplete uint32 True if this component has been fully completed. NiagaraComponent.h  
bIsSeeking bool Whether or not the component is currently seeking to the desired time. NiagaraComponent.h  
bLockDesiredAgeDeltaTimeToSeekDelta bool   NiagaraComponent.h  
bOverrideWarmupSettings uint32 When true then this instance will override the system's warmup settings. NiagaraComponent.h
  • EditAnywhere
  • Category=Warmup
bOwnerAllowsScalabiltiy uint32 Whether the owner of this component allows it to be scalability culled. NiagaraComponent.h  
bRecachePSOs uint32 Request recache the PSOs NiagaraComponent.h  
bRenderingEnabled uint32   NiagaraComponent.h  
CreateSceneComponentUtilsFunction TFunction< INiagaraSceneComponentUtils *()>   NiagaraComponent.h  
CullProxy TObjectPtr< class UNiagaraCullProxyComponent >   NiagaraComponent.h
  • Transient
CurrLocalBounds FBox   NiagaraComponent.h  
CustomTimeDilation float   NiagaraComponent.h  
DesiredAge float The desired age of the System instance. NiagaraComponent.h  
EmitterOverrideInfos TArray< FEmitterOverrideInfo >   NiagaraComponent.h  
ForceUpdateTransformTime float   NiagaraComponent.h  
InstanceParameterOverrides TMap< FNiagaraVariableBase, FNiagaraVariant >   NiagaraComponent.h
  • EditAnywhere
  • Category="Niagara"
InstanceParameterOverridesCache TMap< FNiagaraVariableBase, FNiagaraVariant >   NiagaraComponent.h
  • Transient
LastHandledDesiredAge float The last desired age value that was handled by the tick function. NiagaraComponent.h  
MaxSimTime float The maximum amount of time in seconds to spend seeking to the desired age in a single frame. NiagaraComponent.h  
OnSynchronizedWithAssetParametersDelegate FOnSynchronizedWithAssetParameters   NiagaraComponent.h  
OnSystemInstanceChangedDelegate FOnSystemInstanceChanged   NiagaraComponent.h  
OverrideParameters FNiagaraUserRedirectionParameterStore   NiagaraComponent.h  
RandomSeedOffset int32 Offsets the deterministic random seed of all emitters. NiagaraComponent.h
  • EditAnywhere
  • Category="Randomness"
SavedAutoAttachRelativeLocation FVector Saved relative transform before auto attachment. NiagaraComponent.h  
SavedAutoAttachRelativeRotation FRotator   NiagaraComponent.h  
SavedAutoAttachRelativeScale3D FVector   NiagaraComponent.h  
ScalabilityEffectType UNiagaraEffectType *   NiagaraComponent.h  
ScalabilityManagerHandle int32   NiagaraComponent.h  
SeekDelta float The delta time used when seeking to the desired age. NiagaraComponent.h  
SimCache TObjectPtr< class UNiagaraSimCache >   NiagaraComponent.h
  • Transient
SystemFixedBounds FBox   NiagaraComponent.h  
SystemInstanceController FNiagaraSystemInstanceControllerPtr   NiagaraComponent.h  
TemplateParameterOverrides TMap< FNiagaraVariableBase, FNiagaraVariant >   NiagaraComponent.h
  • EditAnywhere
  • Category="Niagara"
TemplateParameterOverridesCache TMap< FNiagaraVariableBase, FNiagaraVariant >   NiagaraComponent.h
  • Transient
TickBehavior ENiagaraTickBehavior Allows you to control how Niagara selects the tick group, changing this while an instance is active will result in not change as it is cached. NiagaraComponent.h
  • EditAnywhere
  • Category="Niagara"
  • Meta=(DisplayName="Niagara Tick Behavior")
WarmupTickCount int32 Number of ticks to process for warmup of the system. NiagaraComponent.h
  • EditAnywhere
  • Category=Warmup
  • Meta=(EditCondition="bOverrideWarmupSettings", ClampMin="0")
WarmupTickDelta float Delta time used when ticking the system in warmup mode. NiagaraComponent.h
  • EditAnywhere
  • Category=Warmup
  • Meta=(EditCondition="bOverrideWarmupSettings", ForceUnits=s, UIMin="0.01", UIMax="1")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AdvanceSimulation ( int32 TickCount,
float TickDeltaSeconds
)

 Advances this system's simulation by the specified number of ticks and delta time. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

void AdvanceSimulationByTime ( float SimulateTime,
float TickDeltaSeconds
)

 Advances this system's simulation by the specified time in seconds and delta time. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

void BeginUpdateContextReset()

   NiagaraComponent.h  

void ClearEmitterFixedBounds ( FName EmitterName
)

 Clear any previously set fixed bounds for the emitter instance. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

void ClearSimCache ( bool bResetSystem
)

 Clear any active simulation cache. NiagaraComponent.h
  • BlueprintCallable
  • Category=SimCache

void ClearSystemFixedBounds()

 Clear any previously set fixed bounds for the system instance. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

INiagaraSceneComponentUtils * CreateSceneComponentUtils()

 DO NOT USE THIS IN EXTERNAL CODE as it is subject to change Methods to handle interop between Actor/Entity/Desc NiagaraComponent.h  

void DestroyInstance()

   NiagaraComponent.h  

void DestroyInstanceNotComponent()

   NiagaraComponent.h  

void EndUpdateContextReset()

   NiagaraComponent.h  

void EnsureOverrideParametersConsistent()

   NiagaraComponent.h  
Find the value of an overridden parameter. NiagaraComponent.h  

ENiagaraAgeUpdateMode GetAgeUpdateMode()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Age Update Mode")

bool GetAllowScalability()

   NiagaraComponent.h
  • BlueprintGetter

UNiagaraSystem * GetAsset()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara System Asset")
Gets the current value of a parameter which is being used by the simulation. NiagaraComponent.h  

float GetCustomTimeDilation()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

UNiagaraDataInterface * GetDataInterface ( const FString& Name
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

float GetDesiredAge ()

 Gets the desired age of the System instance. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Desired Age")

FBox GetEmitterFixedBounds ( FName EmitterName
) const

 Gets the fixed bounds for an emitter instance. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

ENiagaraExecutionState GetExecutionState()

   NiagaraComponent.h  

bool GetForceLocalPlayerEffect()

   NiagaraComponent.h
  • BlueprintGetter

bool GetForceSolo()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Is In Forced Solo Mode")
Gets whether or not the delta time used to tick the system instance when using desired age is locked to the seek delta. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

float GetMaxSimTime ()

 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. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Max Desired Age Tick Delta")

ENiagaraOcclusionQueryMode GetOcclusionQueryMode()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  NiagaraComponent.h  
  NiagaraComponent.h  

FParticlePerfStatsContext GetPerfStatsContext()

   NiagaraComponent.h  

float GetPreviewLODDistance()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Preview
  • Meta=(Keywords="preview LOD Distance scalability")

bool GetPreviewLODDistanceEnabled()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Preview
  • Meta=(Keywords="preview LOD Distance scalability")

int32 GetRandomSeedOffset()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Random Seed Offset")

bool GetRenderingEnabled()

 Gets whether or not rendering is enabled for this component. NiagaraComponent.h  

ENiagaraExecutionState GetRequestedExecutionState()

   NiagaraComponent.h  

int32 GetScalabilityManagerHandle()

   NiagaraComponent.h  

float GetSeekDelta ()

 Gets the delta value which is used when seeking from the current age, to the desired age. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Desired Age Seek Delta")

UNiagaraSimCache * GetSimCache()

 Get the active simulation cache, will return null if we do not have an active one. NiagaraComponent.h
  • BlueprintCallable
  • Category=SimCache
Gets the fixed bounds for the system instance. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

FNiagaraSystemInstance * GetSystemInstance()

   NiagaraComponent.h  

FNiagaraSystemInstanceControllerPtr GetSystemInstanceController ()

   NiagaraComponent.h  

FNiagaraSystemInstanceControllerConstPtr GetSystemInstanceController ()

   NiagaraComponent.h  
  NiagaraComponent.h  

ENiagaraTickBehavior GetTickBehavior()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Tick Behavior")

bool GetVariableBool ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara bool parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Bool)", Keywords="user parameter variable bool")

FLinearColor GetVariableColor ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara Linear Color parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (LinearColor)", Keywords="user parameter variable color")

float GetVariableFloat ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara float parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Float)", Keywords="user parameter variable float")

int32 GetVariableInt ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara int parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Int32)", Keywords="user parameter variable int")

FMatrix GetVariableMatrix ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara matrix parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Matrix)", Keywords="user parameter variable matrix")

FVector GetVariablePosition ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara Position parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Position)", Keywords="user parameter variable vector position lwc")

FQuat GetVariableQuat ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara quaternion parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Quaternion)", Keywords="user parameter variable quaternion rotation")

FVector2D GetVariableVec2 ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara Vector2 parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Vector2)", Keywords="user parameter variable vector")

FVector GetVariableVec3 ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara Vector3 parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Vector3)", Keywords="user parameter variable vector")

FVector4 GetVariableVec4 ( FName InVariableName,
bool& bIsValid
) const

 Gets a Niagara Vector4 parameter by name. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Niagara Variable (Vector4)", Keywords="user parameter variable vector")

bool HasParameterOverride ( const FNiagaraVariableBase& InKey
) const

   NiagaraComponent.h  
Initializes this component for capturing a performance baseline. NiagaraComponent.h
  • BlueprintCallable
  • Category=Performance
  • Meta=(Keywords="Niagara Performance")

bool InitializeSystem()

   NiagaraComponent.h  

bool IsActiveForUpdateContext()

   NiagaraComponent.h  

bool IsComplete()

   NiagaraComponent.h  

bool IsLocalPlayerEffect()

 Is this an effect on or linked to the local player. NiagaraComponent.h  

bool IsPaused()

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

bool IsRegisteredWithScalabilityManager()

   NiagaraComponent.h  

bool IsUsingCullProxy()

   NiagaraComponent.h  

bool IsWorldReadyToRun()

   NiagaraComponent.h  

void OnPooledReuse ( UWorld* NewWorld
)

   NiagaraComponent.h  

FOnSynchronizedWithAssetParameters & OnSynchronizedWithAssetParameters()

   NiagaraComponent.h  

FOnSystemInstanceChanged & OnSystemInstanceChanged()

   NiagaraComponent.h  

void PostLoadNormalizeOverrideNames()

   NiagaraComponent.h  

void ReinitializeSystem()

 Called on when an external object wishes to force this System to reinitialize itself from the System data. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Reinitialize System")

void RemoveParameterOverride ( const FNiagaraVariableBase& InKey
)

 Remove an override for a given parameter if one exists. NiagaraComponent.h  

void ResetSystem()

 Resets the System to it's initial pre-simulated state. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Reset System")

bool ResolveOwnerAllowsScalability ( bool bRegister
)

   NiagaraComponent.h  

void SeekToDesiredAge ( float InDesiredAge
)

 Sets the desired age of the System instance and designates that this change is a seek. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Seek to Desired Age")

void SetAgeUpdateMode ( ENiagaraAgeUpdateMode InAgeUpdateMode
)

 Sets the age update mode for the System instance. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Age Update Mode")

void SetAllowScalability ( bool bAllow
)

 Set whether this component is allowed to perform scalability checks and potentially be culled etc. NiagaraComponent.h
  • BlueprintSetter
  • Category=Scalability
  • Meta=(Keywords="LOD scalability")

void SetAsset ( UNiagaraSystem* InAsset,
bool bResetExistingOverrideParameters
)

 Switch which asset the component is using. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara System Asset")

void SetAutoDestroy ( bool bInAutoDestroy
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Auto Destroy")

void SetCanRenderWhileSeeking ( bool bInCanRenderWhileSeeking
)

 Sets whether or not the system can render while seeking. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Can Render While Seeking")

void SetCreateSceneComponentUtilsFunction ( TFunction< INiagaraSceneComponentUtils*()> Function
)

   NiagaraComponent.h  

void SetCustomTimeDilation ( float Dilation
)

 Sets the custom time dilation value for the component. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

void SetDesiredAge ( float InDesiredAge
)

 Sets the desired age of the System instance. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Desired Age")

void SetEmitterFixedBounds ( FName EmitterName,
FBox LocalBounds
)

 Sets the fixed bounds for an emitter instance, this overrides all other bounds. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

void SetForceLocalPlayerEffect ( bool bIsPlayerEffect
)

   NiagaraComponent.h
  • BlueprintSetter
  • Category=Scalability
  • Meta=(Keywords="LOD scalability")

void SetForceSolo ( bool bInForceSolo
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Forced Solo Mode")

void SetGpuComputeDebug ( bool bEnableDebug
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
Sets whether or not the delta time used to tick the system instance when using desired age is locked to the seek delta. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

void SetLODDistance ( float InLODDistance,
float InMaxLODDistance
)

   NiagaraComponent.h  

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. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Max Desired Age Tick Delta")

void SetNiagaraVariableActor ( const FString& InVariableName,
AActor* Actor
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Actor)", Keywords="user parameter variable actor")

void SetNiagaraVariableBool ( const FString& InVariableName,
bool InValue
)

 Sets a Niagara bool parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Bool)", Keywords="user parameter variable bool")

void SetNiagaraVariableFloat ( const FString& InVariableName,
float InValue
)

 Sets a Niagara float parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Float)", Keywords="user parameter variable float")

void SetNiagaraVariableInt ( const FString& InVariableName,
int32 InValue
)

 Sets a Niagara int parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Int32)", Keywords="user parameter variable int")

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

 Sets a Niagara FLinearColor parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (LinearColor)", Keywords="user parameter variable color")

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

 Sets a Niagara matrix parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Matrix)", Keywords="user parameter variable matrix")

void SetNiagaraVariableObject ( const FString& InVariableName,
UObject* Object
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Object)", Keywords="user parameter variable object")

void SetNiagaraVariablePosition ( const FString& InVariableName,
FVector InValue
)

 Sets a Niagara Position parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Position)", Keywords="user parameter variable vector position lwc")

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

 Sets a Niagara quaternion parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Quaternion)", Keywords="user parameter variable quaternion rotation")

void SetNiagaraVariableVec2 ( const FString& InVariableName,
FVector2D InValue
)

 Sets a Niagara Vector2 parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Vector2)", Keywords="user parameter variable vector")

void SetNiagaraVariableVec3 ( const FString& InVariableName,
FVector InValue
)

 Sets a Niagara Vector3 parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Vector3)", Keywords="user parameter variable vector")

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

 Sets a Niagara Vector4 parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable By String (Vector4)", Keywords="user parameter variable vector")

void SetOcclusionQueryMode ( ENiagaraOcclusionQueryMode Mode
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

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

   NiagaraComponent.h  

void SetPaused ( bool bInPaused
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

void SetPreviewLODDistance ( bool bEnablePreviewLODDistance,
float PreviewLODDistance,
float PreviewMaxDistance
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Preview
  • Meta=(Keywords="preview LOD Distance scalability")

void SetRandomSeedOffset ( int32 NewRandomSeedOffset
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Random Seed Offset")

void SetRenderingEnabled ( bool bInRenderingEnabled
)

 Sets whether or not rendering is enabled for this component. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Rendering Enabled")

void SetSeekDelta ( float InSeekDelta
)

 Sets the delta value which is used when seeking from the current age, to the desired age. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Desired Age Seek Delta")

void SetSimCache ( UNiagaraSimCache* SimCache,
bool bResetSystem
)

 Sets the simulation cache to use for the component. NiagaraComponent.h
  • BlueprintCallable
  • Category=SimCache

void SetSystemFixedBounds ( FBox LocalBounds
)

 Sets the fixed bounds for the system instance, this overrides all other bounds. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara

void SetSystemSignificanceIndex ( int32 InIndex
)

 The significant index for this component. NiagaraComponent.h  

void SetTickBehavior ( ENiagaraTickBehavior NewTickBehavior
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Tick Behavior")

void SetUserParametersToDefaultValues()

 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. NiagaraComponent.h  

void SetVariableActor ( FName InVariableName,
AActor* Actor
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Actor)", Keywords="user parameter variable actor")

void SetVariableBool ( FName InVariableName,
bool InValue
)

 Sets a Niagara bool parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Bool)", Keywords="user parameter variable bool")

void SetVariableFloat ( FName InVariableName,
float InValue
)

 Sets a Niagara float parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Float)", Keywords="user parameter variable float")

void SetVariableInt ( FName InVariableName,
int32 InValue
)

 Sets a Niagara int parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Int32)", Keywords="user parameter variable int")

void SetVariableLinearColor ( FName InVariableName,
const FLinearColor& InValue
)

 Sets a Niagara FLinearColor parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (LinearColor)", Keywords="user parameter variable color")

void SetVariableMaterial ( FName InVariableName,
UMaterialInterface* Object
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Material)", Keywords="user parameter variable material")

void SetVariableMatrix ( FName InVariableName,
const FMatrix& InValue
)

 Sets a Niagara matrix parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Matrix)", Keywords="user parameter variable matrix")

void SetVariableObject ( FName InVariableName,
UObject* Object
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Object)", Keywords="user parameter variable object")

void SetVariablePosition ( FName InVariableName,
FVector InValue
)

 Sets a Niagara Position parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Position)", Keywords="user parameter variable vector position lwc")

void SetVariableQuat ( FName InVariableName,
const FQuat& InValue
)

 Sets a Niagara quaternion parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Quaternion)", Keywords="user parameter variable quaternion rotation")

void SetVariableStaticMesh ( FName InVariableName,
UStaticMesh* InValue
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Static Mesh)", Keywords="user parameter variable mesh")

void SetVariableTexture ( FName InVariableName,
UTexture* Texture
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Texture)", Keywords="user parameter variable texture")

void SetVariableTextureRenderTarget ( FName InVariableName,
UTextureRenderTarget* TextureRenderTarget
)

   NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (TextureRenderTarget)")

void SetVariableVec2 ( FName InVariableName,
FVector2D InValue
)

 Sets a Niagara Vector2 parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Vector2)", Keywords="user parameter variable vector")

void SetVariableVec3 ( FName InVariableName,
FVector InValue
)

 Sets a Niagara Vector3 parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Vector3)", Keywords="user parameter variable vector")

void SetVariableVec4 ( FName InVariableName,
const FVector4& InValue
)

 Sets a Niagara Vector4 parameter by name, overriding locally if necessary. NiagaraComponent.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Niagara Variable (Vector4)", Keywords="user parameter variable vector")

void UpgradeDeprecatedParameterOverrides()

   NiagaraComponent.h  

Overridden from UFXSystemComponent

Name Remarks Include Path Unreal Specifiers

virtual void ActivateSystem ( bool bFlagAsJustAttached
)

   NiagaraComponent.h  

virtual void DeactivateImmediate()

   NiagaraComponent.h  

virtual uint32 GetApproxMemoryUsage()

   NiagaraComponent.h  

virtual UFXSystemAsset * GetFXSystemAsset()

   NiagaraComponent.h  

virtual void ReleaseToPool()

   NiagaraComponent.h  

virtual void SetActorParameter ( FName ParameterName,
AActor* Param
)

   NiagaraComponent.h  

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

 Set AutoAttachParent, AutoAttachSocketName, AutoAttachLocationRule, AutoAttachRotationRule, AutoAttachScaleRule to the specified parameters. NiagaraComponent.h  

virtual void SetBoolParameter ( FName ParameterName,
bool Param
)

   NiagaraComponent.h  

virtual void SetColorParameter ( FName ParameterName,
FLinearColor Param
)

   NiagaraComponent.h  

virtual void SetEmitterEnable ( FName EmitterName,
bool bNewEnableState
)

   NiagaraComponent.h  

virtual void SetFloatParameter ( FName ParameterName,
float Param
)

   NiagaraComponent.h  

virtual void SetIntParameter ( FName ParameterName,
int Param
)

   NiagaraComponent.h  

virtual void SetUseAutoManageAttachment ( bool bAutoManage
)

   NiagaraComponent.h  

virtual void SetVectorParameter ( FName ParameterName,
FVector Param
)

   NiagaraComponent.h  

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual void CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FMaterialInterfacePSOPrecacheParamsList& OutParams
)

   NiagaraComponent.h  

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   NiagaraComponent.h  

virtual int32 GetNumMaterials()

   NiagaraComponent.h  

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

   NiagaraComponent.h  

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

   NiagaraComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   NiagaraComponent.h  

virtual bool IsVisible()

   NiagaraComponent.h  

virtual void OnAttachmentChanged()

   NiagaraComponent.h  

virtual void OnChildAttached ( USceneComponent* ChildComponent
)

   NiagaraComponent.h  

virtual void OnChildDetached ( USceneComponent* ChildComponent
)

   NiagaraComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void Activate ( bool bReset
)

   NiagaraComponent.h  

virtual const UObject * AdditionalStatObject()

   NiagaraComponent.h  

virtual void Deactivate()

   NiagaraComponent.h  

virtual bool IsReadyForOwnerToAutoDestroy()

   NiagaraComponent.h  

virtual void OnComponentCreated()

   NiagaraComponent.h  

virtual void OnComponentDestroyed ( bool bDestroyingHierarchy
)

   NiagaraComponent.h  

virtual void PostApplyToComponent()

   NiagaraComponent.h  

virtual bool RequiresGameThreadEndOfFrameRecreate()

   NiagaraComponent.h  

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

   NiagaraComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   NiagaraComponent.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   NiagaraComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraComponent.h  

virtual void PostLoad()

   NiagaraComponent.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   NiagaraComponent.h  

virtual void Serialize ( FStructuredArchive::FRecord Record
)

   NiagaraComponent.h  

Overridden from UObjectBase

Name Remarks Include Path Unreal Specifiers

virtual FName GetFNameForStatID()

   NiagaraComponent.h  

Protected

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

   NiagaraComponent.h  

virtual void CreateRenderState_Concurrent ( FRegisterComponentContext* Context
)

   NiagaraComponent.h  

virtual void DestroyRenderState_Concurrent()

   NiagaraComponent.h  

virtual void OnEndOfFrameUpdateDuringTick()

   NiagaraComponent.h  

virtual void OnRegister()

   NiagaraComponent.h  

virtual void OnUnregister()

   NiagaraComponent.h  

virtual void SendRenderDynamicData_Concurrent()

   NiagaraComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   NiagaraComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   NiagaraComponent.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page