1. Epic GamesDeveloper
  3. FNiagaraSystemInstance

FNiagaraSystemInstance

Unreal Engine C++ API Reference > Plugins > Niagara

References

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

Syntax

class FNiagaraSystemInstance

Variables

  Type Name Description
Public variable uint32 ActiveGPUEmitterCount  
Public variable FInstanceParameters GatheredInstanceParameters  
Public variable int32 GPUDataInterfaceInstanceDataSize  
Public variable TArray< TPair< TWeakObjectPtr< UNiagaraDataInterface >, int32 > > GPUDataInterfaces  
Public variable bool GPUParamIncludeInterpolation  
Public variable ENiagaraSystemInstanceState SystemInstanceState  
Public variable uint32 TotalGPUParamSize Transient data that is accumulated during tick.

Constructors

  Type Name Description
Public function  

FNiagaraSystemInstance ( UWorld& InWorld,
UNiagaraSystem& InAsset,
FNiagaraUserRedirectionParameterStore* InOverrideParameters,
USceneComponent* InAttachComponent,
ENiagaraTickBehavior InTickBehavior,
bool bInPooled
)

 Creates a new Niagara system instance.

Destructors

  Type Name Description
Public function Virtual   Cleanup

Functions

  Type Name Description
Public function void

Activate ( EResetMode InResetMode
)

  
Public function void

AdvanceSimulation ( int32 TickCountToSimulate,
float TickDeltaSeconds
)

 Manually advances this system's simulation by the specified number of ticks and tick delta.
Public function Static bool

AllocateSystemInstance ( FNiagaraSystemInstancePtr& OutSystemInstanceAllocation,
UWorld& InWorld,
UNiagaraSystem& InAsset,
FNiagaraUserRedirectionParameterStore* InOverrideParameters,
USceneComponent* InAttachComponent,
ENiagaraTickBehavior InTickBehavior,
bool bInPooled
)

  
Public function void Void RebindParameterCollection(UNiagaraParameterCollectionInstance* OldInstance, UNiagaraParameterCollectionInstance* NewInstance);
Public function Const ETickingGroup Calculates which tick group the instance should be in.
Public function void

Cleanup ()

  
Public function void  
Public function void  
Public function void

Complete ( bool bExternalCompletion
)

  
Public function FNiagaraDataSet *

CreateEventDataSet ( FName EmitterName,
FName EventName
)

  
Public function void

Deactivate ( bool bImmediate
)

  
Public function Static bool

DeallocateSystemInstance ( FNiagaraSystemInstancePtr& SystemInstanceAllocation
)

  
Public function Const void

Dump ()

 Dumps all of this systems info to the log.
Public function void Dumps information about the instances tick to the log
Public function FNiagaraEmitterParameters &

EditEmitterParameters ( int32 EmitterIdx
)

  
Public function Const void

EvaluateBoundFunction ( FName FunctionName,
bool& UsedOnCpu,
bool& UsedOnGpu
)

  
Public function void

FinalizeTick_GameThread ( bool bEnqueueGPUTickIfNeeded
)

 Final phase of system instance tick.
Public function void * Returns the instance data for a particular interface for this System.
Public function Const const void *  
Public function int32  
Public function TDataType *  
Public function Const const TDataType *  
Public function void Only call from within the script execution states. Does nothing if not capturing a frame.
Public function void  
Public function void  
Public function TArray< TSharedPtr< struct FNiagaraScriptDebuggerInfo, ESPMode::ThreadSafe > > * Only call from within the script execution states. Value is null if not capturing a frame.
Public function TSharedPtr< struct FNiagaraScriptDebuggerInfo, ESPMode::ThreadSafe >

GetActiveCaptureWrite ( const FName& InHandleName,
ENiagaraScriptUsage InUsage,
const FGuid& InUsageId
)

 Only call from within the script execution states. Value is nullptr if not capturing a frame.
Public function ENiagaraExecutionState  
Public function Const float

GetAge ()

  
Public function Const bool  
Public function USceneComponent *  
Public function Const FNiagaraGpuComputeDispatchInterface *  
Public function Const const FString &  
Public function const void

GetDataInterfaceInstanceDataInfo ( int32 Index,
UNiagaraDataInterface*& OutInterface,
void*& OutInstanceData
)

  
Public function FNiagaraEmitterInstance *  
Public function Const TConstArrayView< FNiagaraEmitterExecutionIndex >  
Public function Const FBox

GetEmitterFixedBounds ( FName EmitterName
)

  
Public function Const const FNiagaraEmitterParameters &

GetEmitterParameters ( int32 EmitterIdx,
bool PreviousFrame
)

  
Public function Const const TArray< TSharedRef< FNiagaraEmitterInstance, ESPMode::ThreadSafe > > &  
Public function TArray< TSharedRef< FNiagaraEmitterInstance, ESPMode::ThreadSafe > > &  
Public function Const FNiagaraDataSet *

GetEventDataSet ( FName EmitterName,
FName EventName
)

  
Public function Const ERHIFeatureLevel::Type  
Public function Const const FNiagaraGlobalParameters &

GetGlobalParameters ( bool PreviousFrame
)

  
Public function Const FNiagaraSystemInstanceID

GetId ()

  
Public function FNiagaraParameterStore &  
Public function Const bool  
Public function Const float  
Public function Const const FBox &  
Public function float Calculates the distance to use for distance based LODing / culling.
Public function Const FNiagaraLWCConverter

GetLWCConverter ( bool bLocalSpaceEmitter
)

  
Public function Const FTransform

GetLWCSimToWorld ( bool bLocalSpaceEmitter
)

  
Public function Const const FVector3f &  
Public function Const float  
Public function FNiagaraUserRedirectionParameterStore *  
Public function Const const FNiagaraUserRedirectionParameterStore *  
Public function Const const FNiagaraOwnerParameters &

GetOwnerParameters ( bool PreviousFrame
)

  
Public function UNiagaraParameterCollectionInstance *  
Public function Const uint32

GetParameterIndex ( bool PreviousFrame
)

  
Public function Const const FNiagaraPerInstanceDIFuncInfo &  
Public function Const UActorComponent *  
Public function Const int32  
Public function Const ENiagaraExecutionState  
Public function TSharedPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > Gets the simulation for the supplied emitter handle.
Public function Const UNiagaraSystem *  
Public function FNDIStageTickHandler *  
Public function Const FBox  
Public function FNiagaraSystemGpuComputeProxy *  
Public function Const int32  
Public function Const const FNiagaraSystemParameters &

GetSystemParameters ( bool PreviousFrame
)

  
Public function Const TSharedPtr< FNiagaraSystemSimulation, ESPMode::ThreadSafe >  
Public function Const ENiagaraTickBehavior Get the current tick behavior
Public function Const int32  
Public function Const UWorld *  
Public function Const FNiagaraWorldManager *  
Public function Const const FTransform & Gets the current world transform of the system
Public function bool Handles completion of the system and returns true if the system is complete.
Public function bool  
Public function bool Void SetHasGPUEmitters(bool bInHasGPUEmitters) { bHasGPUEmitters = bInHasGPUEmitters; }
Public function Const bool  
Public function void

Init ( bool bInForceSolo
)

 Initializes this System instance to simulate the supplied System.
Public function void  
Public function Const bool Int32 GetNumParticles(int32 EmitterIndex) const { return ParameterNumParticleBindings[EmitterIndex].GetValue(); } float GetSpawnCountScale(int32 EmitterIndex) const { return ParameterSpawnCountScaleBindings[EmitterIndex].GetValue(); }
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsSolo ()

  
Public function void

ManualTick ( float DeltaSeconds,
const FGraphEventRef& MyCompletionGraphEvent
)

  
Public function Const bool  
Public function FOnDestroyed &  
Public function FOnInitialized & Gets a multicast delegate which is called whenever this instance is initialized with an System asset.
Public function void

OnPooledReuse ( UWorld& NewWorld
)

  
Public function FOnReset &

OnReset ()

 Gets a multicast delegate which is called whenever this instance is reset due to external changes in the source System asset.
Public function void  
Public function bool

QueryCaptureResults ( const FGuid& RequestId,
TArray< TSharedPtr< struct FNiagaraScriptDebuggerInfo, ESPMode::ThreadSafe >>& OutCaptureResults
)

 Poll for previous frame capture requests.
Public function void  
Public function bool

RequestCapture ( const FGuid& RequestId
)

 Request that this simulation capture a frame. Cannot capture if disabled or already completed.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void

Reset ( EResetMode Mode
)

 Requests the the simulation be reset on the next tick.
Public function void  
Public function void

SetEmitterEnable ( FName EmitterName,
bool bNewEnableState
)

  
Public function void

SetEmitterFixedBounds ( FName EmitterName,
const FBox& InLocalBounds
)

  
Public function void

SetForceSolo ( bool bForceSolo
)

  
Public function void

SetGpuComputeDebug ( bool bEnableDebug
)

  
Public function void

SetLastRenderTime ( float TimeSeconds
)

  
Public function void

SetLODDistance ( float InLODDistance,
float InMaxLODDistance,
bool bOverride
)

  
Public function void

SetOnComplete ( const FOnComplete& InOnCompleteDelegate
)

 Gets a multicast delegate which is called whenever this instance is complete.
Public function void

SetOnPostTick ( const FOnPostTick& InPostTickDelegate
)

 Gets a multicast delegate which is called after this instance has finished ticking for the frame on the game thread
Public function void

SetPaused ( bool bInPaused
)

  
Public function void  
Public function void

SetRandomSeedOffset ( int32 Offset
)

  
Public function void  
Public function void

SetSolo ( bool bInSolo
)

  
Public function void

SetSystemFixedBounds ( const FBox& InLocalBounds
)

  
Public function void

SetSystemSignificanceIndex ( int32 InIndex
)

 The significant index for this component.
Public function void Set a new tick behavior, this will not move the instance straight away and will wait until the next time it is evaluated
Public function void

SetWarmupSettings ( int32 WarmupTickCount,
float WarmupTickDelta
)

  
Public function void

SetWorldTransform ( const FTransform& InTransform
)

 Sets the world transform
Public function Const bool Only call from within the script execution states. Value is false if not capturing a frame.
Public function void Concurrent work for SimCache tick
Public function void

SimCacheTick_GameThread ( UNiagaraSimCache* SimCache,
float DesiredAge,
float DeltaSeconds,
const FGraphEventRef& MyCompletionGraphEvent
)

 Ticks the system using the a SimCache.
Public function void

Tick_Concurrent ( bool bEnqueueGPUTickIfNeeded
)

 Secondary phase of the system instance tick that can be executed on any thread.
Public function void

Tick_GameThread ( float DeltaSeconds
)

 Initial phase of system instance tick. Must be executed on the game thread.
Public function void

TickDataInterfaces ( float DeltaSeconds,
bool bPostSimulate
)

 Perform per-tick updates on data interfaces that need it.
Public function void  
Public function void

TickInstanceParameters_GameThread ( float DeltaSeconds
)

  
Public function void

UnbindParameters ( bool bFromComplete
)

  
Public function Const bool  
Public function void

WaitForConcurrentTickAndFinalize ( bool bEnsureComplete
)

 Wait for any pending concurrent work to complete, must be called on the GameThread.
Public function void

WaitForConcurrentTickDoNotFinalize ( bool bEnsureComplete
)

 Wait for any pending concurrent work to complete, must be called on the GameThread.

Classes

  Type Name Description
Public struct FInstanceParameters    

Enums

  Type Name Description
Public enum EResetMode Defines modes for resetting the System instance.  

Typedefs

Name Description
EmitterEventKey Registered events for each of the emitters
EventDataSetMap  
FOnComplete  
FOnDestroyed  
FOnInitialized  
FOnPostTick  
FOnReset  

Constants

Name Description
ParameterBufferCount  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page