1. Epic GamesDeveloper
  3. FNiagaraSystemInstanceController

FNiagaraSystemInstanceController

This is the main asynchronous interface for controlling operation of a single instance of a Niagara System.

API > API/Plugins > API/Plugins/Niagara

This is the main asynchronous interface for controlling operation of a single instance of a Niagara System.

   
Name FNiagaraSystemInstanceController
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSystemInstanceController.h
Include Path #include "NiagaraSystemInstanceController.h"

Syntax

class FNiagaraSystemInstanceController :  
    public TSharedFromThis< FNiagaraSystemInstanceController, ESPMode::ThreadSafe > ,  
    private FGCObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  NiagaraSystemInstanceController.h  
  NiagaraSystemInstanceController.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FNiagaraSystemInstanceController()

   NiagaraSystemInstanceController.h  

Typedefs

Name Type Remarks Include Path
FMaterialOverride FNiagaraSystemRenderData::FMaterialOverride   NiagaraSystemInstanceController.h
FOnMaterialsUpdated TBaseDelegate_NoParams< void >   NiagaraSystemInstanceController.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bNeedsOverrideParametersTicked uint32   NiagaraSystemInstanceController.h  
bNeedsRendererRecache uint32   NiagaraSystemInstanceController.h  
bNeedsUpdateEmitterMaterials uint32   NiagaraSystemInstanceController.h  
EmitterMaterials TArray< FMaterialOverride >   NiagaraSystemInstanceController.h  
OnMaterialsUpdatedDelegate FOnMaterialsUpdated   NiagaraSystemInstanceController.h  
OverrideParameters FNiagaraUserRedirectionParameterStore *   NiagaraSystemInstanceController.h  
SystemInstance FNiagaraSystemInstancePtr   NiagaraSystemInstanceController.h  
WorldManager FNiagaraWorldManager *   NiagaraSystemInstanceController.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

auto Activate ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto AdvanceSimulation ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void AdvanceSimulation_Deferred ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto CalculateTickGroup ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto ClearLODDistance ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FMaterialInterfacePSOPrecacheParamsList& List
) const

   NiagaraSystemInstanceController.h  

FNiagaraSystemRenderData * CreateSystemRenderData ( ERHIFeatureLevel::Type FeatureLevel
) const

 Render data operations. NiagaraSystemInstanceController.h  

auto Deactivate ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void DebugDump ( bool bFullDump
)

 Dumps system instance state and info to the log (Used by fx.Niagara.DumpComponents commandlet) NiagaraSystemInstanceController.h  

void GenerateSetDynamicDataCommands ( FNiagaraSystemRenderData::FSetDynamicDataCommandList& Commands,
FNiagaraSystemRenderData& RenderData,
const FNiagaraSceneProxy& SceneProxy
)

   NiagaraSystemInstanceController.h  

auto GetActualExecutionState ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto GetAge ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto GetAreDataInterfacesInitialized ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto GetAttachComponent ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto GetComputeDispatchInterface ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto GetEmitterFixedBounds ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

ENiagaraGpuComputeTickStage::Type GetGpuComputeTickStage()

   NiagaraSystemInstanceController.h  

auto GetLocalBounds ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto GetLODDistance ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

UMaterialInterface * GetMaterialOverride ( const UNiagaraRendererProperties* InProps,
int32 InMaterialSubIndex
) const

   NiagaraSystemInstanceController.h  

void GetMaterialStreamingInfo ( FNiagaraMaterialAndScaleArray& OutMaterialAndScales
) const

   NiagaraSystemInstanceController.h  

auto GetRequestedExecutionState ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

FNiagaraSystemInstance * GetSoloSystemInstance()

 Solo systems should be okay to access the system instance/simulation, as they are ticked manually, not concurrently. NiagaraSystemInstanceController.h  

FNiagaraSystemSimulationPtr GetSoloSystemSimulation()

   NiagaraSystemInstanceController.h  

void GetStreamingMeshInfo ( const FBoxSphereBounds& OwnerBounds,
FStreamingTextureLevelContext& LevelContext,
TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingRenderAssets
) const

   NiagaraSystemInstanceController.h  

auto GetSystem ( ArgTypes... Args
) const

 The goal is to get this list of methods down to only accessors that don't change throughout the lifetime of the system. NiagaraSystemInstanceController.h  

auto GetSystemFixedBounds ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

FNiagaraSystemInstance * GetSystemInstance_Unsafe()

 These methods are deprecated, as they expose internals that may be concurrently accessed. NiagaraSystemInstanceController.h  

FNiagaraSystemInstanceID GetSystemInstanceID()

   NiagaraSystemInstanceController.h  

FNiagaraSystemSimulationPtr GetSystemSimulation_Unsafe()

   NiagaraSystemInstanceController.h  

auto GetTickBehavior ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

SIZE_T GetTotalBytesUsed()

   NiagaraSystemInstanceController.h  

void GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials
)

   NiagaraSystemInstanceController.h  

auto HandleNeedsUIResync ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

bool HasValidSimulation()

   NiagaraSystemInstanceController.h  

void Initialize ( UWorld& World,
UNiagaraSystem& System,
FNiagaraUserRedirectionParameterStore* OverrideParameters,
USceneComponent* AttachComponent,
ENiagaraTickBehavior TickBehavior,
bool bPooled,
int32 RandomSeedOffset,
bool bForceSolo,
int32 WarmupTickCount,
float WarmupTickDelta
)

 Initializes the controller with an instance of the provided system NiagaraSystemInstanceController.h  

auto IsComplete ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto IsPaused ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto IsPendingSpawn ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

auto IsSolo ( ArgTypes... Args
) const

   NiagaraSystemInstanceController.h  

bool IsValid()

   NiagaraSystemInstanceController.h  

auto ManualTick ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto MultiTick ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void NotifyRenderersComplete ( FNiagaraSystemRenderData& RenderData
)

   NiagaraSystemInstanceController.h  

void OnPooledReuse ( UWorld& NewWorld
)

   NiagaraSystemInstanceController.h  

auto OnSimulationDestroyed ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void PostTickRenderers ( FNiagaraSystemRenderData& RenderData
)

   NiagaraSystemInstanceController.h  

void Release ()

 Deactivates the underlying system and queues it up for destruction. NiagaraSystemInstanceController.h  

auto Reset ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void Reset_Deferred ( ArgTypes... Args
)

 Deferred methods - With NIAGARA_SYSTEM_INSTANCE_CONTROLLER_ASYNC, these are executed in a deferred queue. NiagaraSystemInstanceController.h  

auto SetEmitterEnable ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetEmitterFixedBounds ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetForceSolo ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetGpuComputeDebug ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetLastRenderTime ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetLODDistance ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetOnComplete ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void SetOnMaterialsUpdated ( const FOnMaterialsUpdated& Delegate
)

   NiagaraSystemInstanceController.h  

auto SetOnPostTick ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetPaused ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void SetPaused_Deferred ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetRandomSeedOffset ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void SetRequestedExecutionState_Deferred ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetSystemFixedBounds ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetSystemSignificanceIndex ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SetTickBehavior ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

void SetVariable_Deferred ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto SimCacheTick_GameThread ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

auto WaitForConcurrentTickAndFinalize ( ArgTypes... Args
)

   NiagaraSystemInstanceController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page