1. Epic GamesDeveloper
  3. FNiagaraSystemSimulation

FNiagaraSystemSimulation

Simulation performing all system and emitter scripts for a instances of a [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) in a world.

API > API/Plugins > API/Plugins/Niagara

Simulation performing all system and emitter scripts for a instances of a UNiagaraSystem in a world.

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

Syntax

class FNiagaraSystemSimulation : public TSharedFromThis< FNiagaraSystemSimulation, ESPMode::ThreadSafe >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraSystemSimulation()

   NiagaraSystemSimulation.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FNiagaraSystemSimulation()

   NiagaraSystemSimulation.h  

Constants

Name Type Remarks Include Path
bUseLegacyExecContexts bool   NiagaraSystemSimulation.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
FNiagaraSystemSimulationTickContext friend   NiagaraSystemSimulation.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddInstance ( FNiagaraSystemInstance* Instance
)

   NiagaraSystemSimulation.h  

void AddTickGroupPromotion ( FNiagaraSystemInstance* Instance
)

   NiagaraSystemSimulation.h  

void AddToInstanceList ( FNiagaraSystemInstance* Instance,
ENiagaraSystemInstanceState InstanceState
)

   NiagaraSystemSimulation.h  

void Destroy()

   NiagaraSystemSimulation.h  

void DumpInstance ( const FNiagaraSystemInstance* Inst
) const

   NiagaraSystemSimulation.h  

void DumpTickInfo ( FOutputDevice& Ar
)

 Dump information about all instances tick NiagaraSystemSimulation.h  

const FString & GetCrashReporterTag()

   NiagaraSystemSimulation.h  

FNiagaraGpuComputeDispatchInterface * GetDispatchInterface()

   NiagaraSystemSimulation.h  

ENiagaraGPUTickHandlingMode GetGPUTickHandlingMode()

   NiagaraSystemSimulation.h  

bool GetIsSolo()

   NiagaraSystemSimulation.h  

UNiagaraParameterCollectionInstance * GetParameterCollectionInstance ( UNiagaraParameterCollection* Collection
)

   NiagaraSystemSimulation.h  

FNiagaraScriptExecutionContextBase * GetSpawnExecutionContext()

   NiagaraSystemSimulation.h  

UNiagaraSystem * GetSystem()

   NiagaraSystemSimulation.h  

ETickingGroup GetTickGroup()

   NiagaraSystemSimulation.h  

const FNiagaraTickInfo & GetTickInfo()

   NiagaraSystemSimulation.h  

FNiagaraScriptExecutionContextBase * GetUpdateExecutionContext()

   NiagaraSystemSimulation.h  

UWorld * GetWorld()

   NiagaraSystemSimulation.h  

bool Init ( UNiagaraSystem* InSystem,
UWorld* InWorld,
bool bInIsSolo,
ETickingGroup TickGroup
)

   NiagaraSystemSimulation.h  

bool IsValid()

   NiagaraSystemSimulation.h  

bool MultiTick_GameThread ( int32 TicksToProcess,
float DeltaSecondsPerTick,
float MaxSimTime,
const FGraphEventRef& MyCompletionGraphEvent
)

 Processes multiple ticks at once on the game thread. NiagaraSystemSimulation.h  

void PauseInstance ( FNiagaraSystemInstance* Instance
)

   NiagaraSystemSimulation.h  

void RemoveFromInstanceList ( FNiagaraSystemInstance* Instance
)

   NiagaraSystemSimulation.h  

void RemoveInstance ( FNiagaraSystemInstance* Instance
)

   NiagaraSystemSimulation.h  

void SetInstanceState ( FNiagaraSystemInstance* Instance,
ENiagaraSystemInstanceState NewState
)

   NiagaraSystemSimulation.h  

void SimCacheTick_Concurrent ( UNiagaraSimCache* SimCache,
float DeltaSeconds
)

 Concurrent portion of sim cache tick, can run on any thread. NiagaraSystemSimulation.h  

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

 Game thread portion of sim cache tick. Must run on GameThread. NiagaraSystemSimulation.h  

void Spawn_Concurrent ( FNiagaraSystemSimulationTickContext& Context
)

 Spawn any pending instances NiagaraSystemSimulation.h  

void Spawn_GameThread ( float DeltaSeconds,
bool bPostActorTick
)

 Spawn any pending instances, assumes that you have update tick groups ahead of time. NiagaraSystemSimulation.h  

void Tick_Concurrent ( FNiagaraSystemSimulationTickContext& Context
)

 Second phase of system sim tick that can run on any thread. NiagaraSystemSimulation.h  

void Tick_GameThread ( float DeltaSeconds,
const FGraphEventRef& MyCompletionGraphEvent
)

 First phase of system sim tick. Must run on GameThread. NiagaraSystemSimulation.h  

void TransferInstance ( FNiagaraSystemInstance* SystemInst
)

 Transfers a system instance from the current simulation into this one. NiagaraSystemSimulation.h  

void UnpauseInstance ( FNiagaraSystemInstance* Instance
)

   NiagaraSystemSimulation.h  

void UpdateTickGroups_GameThread()

 Update TickGroups for pending instances and execute tick group promotions. NiagaraSystemSimulation.h  

void WaitForConcurrentTickComplete ( bool bEnsureComplete
)

 Wait for system simulation concurrent tick to complete. NiagaraSystemSimulation.h  

void WaitForInstancesTickComplete ( bool bEnsureComplete
)

 Wait for system instances concurrent tick to complete. NiagaraSystemSimulation.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddSystemToTickBatch ( FNiagaraSystemSimulationTickContext& Context,
FNiagaraSystemInstance* Instance,
bool bIsLastInstance
)

   NiagaraSystemSimulation.h  

void BuildConstantBufferTable ( const FNiagaraGlobalParameters& GlobalParameters,
TUniquePtr< FNiagaraScriptExecutionContextBase >& ExecContext,
FScriptExecutionConstantBufferTable& ConstantBufferTable
) const

 Builds the constant buffer table for a given script execution NiagaraSystemSimulation.h  

void DumpStalledInfo()

   NiagaraSystemSimulation.h  

void FlushTickBatch ( FNiagaraSystemSimulationTickContext& Context,
bool bIsLastInstance
)

   NiagaraSystemSimulation.h  

TArray< FNiagaraSystemInstance * > & GetSystemInstances ( ENiagaraSystemInstanceState State
)

   NiagaraSystemSimulation.h  

void InitParameterDataSetBindings ( FNiagaraSystemInstance* SystemInst
)

   NiagaraSystemSimulation.h  

void PrepareForSystemSimulate ( FNiagaraSystemSimulationTickContext& Context
)

 Does any prep work for system simulation such as pulling instance parameters into a dataset. NiagaraSystemSimulation.h  

void SetupParameters_GameThread ( float DeltaSeconds
)

 Sets constant parameter values NiagaraSystemSimulation.h  

void SpawnSystemInstances ( FNiagaraSystemSimulationTickContext& Context
)

 Runs the system spawn script for new system instances. NiagaraSystemSimulation.h  

void Tick_GameThread_Internal ( float DeltaSeconds,
const FGraphEventRef& MyCompletionGraphEvent
)

   NiagaraSystemSimulation.h  

void TransferSystemSimResults ( FNiagaraSystemSimulationTickContext& Context
)

 Transfers the results of the system simulation into the emitter instances. NiagaraSystemSimulation.h  

void UpdateSystemInstances ( FNiagaraSystemSimulationTickContext& Context
)

 Runs the system update script. NiagaraSystemSimulation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page