Navigation
API > API/Plugins > API/Plugins/Niagara
| Name | FNiagaraSystemInstance |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSystemInstance.h |
| Include Path | #include "NiagaraSystemInstance.h" |
Syntax
class FNiagaraSystemInstance : public FNiagaraSystemInstanceFixLayout
Inheritance Hierarchy
- FNiagaraSystemInstanceFixLayout → FNiagaraSystemInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraSystemInstance
(
UWorld& InWorld, |
Creates a new Niagara system instance. | NiagaraSystemInstance.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNiagaraSystemInstance() |
Cleanup | NiagaraSystemInstance.h |
Structs
| Name | Remarks |
|---|---|
| FInstanceParameters |
Enums
Public
| Name | Remarks |
|---|---|
| EResetMode | Defines modes for resetting the System instance. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| EmitterEventKey | TPair< FName, FName > | Registered events for each of the emitters | NiagaraSystemInstance.h |
| EventDataSetMap | TMap< EmitterEventKey, FNiagaraDataSet * > | NiagaraSystemInstance.h | |
| FOnComplete | TBaseDelegate_OneParam< void, bool > | NiagaraSystemInstance.h | |
| FOnDestroyed | TMulticastDelegate_NoParams< void > | NiagaraSystemInstance.h | |
| FOnInitialized | TMulticastDelegate_NoParams< void > | NiagaraSystemInstance.h | |
| FOnPostTick | TBaseDelegate_NoParams< void > | NiagaraSystemInstance.h | |
| FOnReset | TMulticastDelegate_NoParams< void > | NiagaraSystemInstance.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ParameterBufferCount | int32 | NiagaraSystemInstance.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveGPUEmitterCount | uint32 | NiagaraSystemInstance.h | ||
| GatheredInstanceParameters | FInstanceParameters | NiagaraSystemInstance.h | ||
| GPUDataInterfaceInstanceDataSize | int32 | NiagaraSystemInstance.h | ||
| GPUDataInterfaces | TArray< TPair< TWeakObjectPtr< UNiagaraDataInterface >, int32 > > | NiagaraSystemInstance.h | ||
| GPUParamIncludeInterpolation | uint8 | NiagaraSystemInstance.h | ||
| SystemInstanceState | ENiagaraSystemInstanceState | NiagaraSystemInstance.h | ||
| SystemState_CurrentLoopAgeEnd | float | NiagaraSystemInstance.h | ||
| SystemState_CurrentLoopAgeStart | float | NiagaraSystemInstance.h | ||
| SystemState_CurrentLoopDelay | float | NiagaraSystemInstance.h | ||
| SystemState_CurrentLoopDuration | float | NiagaraSystemInstance.h | ||
| SystemState_LoopCount | int32 | NiagaraSystemInstance.h | ||
| SystemState_RandomStream | FRandomStream | NiagaraSystemInstance.h | ||
| TickBehavior | ENiagaraTickBehavior | NiagaraSystemInstance.h | ||
| TotalGPUParamSize | uint32 | Transient data that is accumulated during tick. | NiagaraSystemInstance.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActualExecutionState | ENiagaraExecutionState | Copy of simulations internal state so that it can be passed to emitters etc. | NiagaraSystemInstance.h | |
| Age | float | The age of the System instance. | NiagaraSystemInstance.h | |
| AttachComponent | TWeakObjectPtr< USceneComponent > | NiagaraSystemInstance.h | ||
| bAlreadyBound | uint8 | NiagaraSystemInstance.h | ||
| bDataInterfacesHaveTickPostreqs | uint8 | The system contains data interfaces that can have tick group post requisites. | NiagaraSystemInstance.h | |
| bDataInterfacesHaveTickPrereqs | uint8 | The system contains data interfaces that can have tick group prerequisites. | NiagaraSystemInstance.h | |
| bDataInterfacesInitialized | uint8 | NiagaraSystemInstance.h | ||
| bForceSolo | uint8 | NiagaraSystemInstance.h | ||
| bHasGPUEmitters | uint8 | If this system has emitters that will run GPU Simulations | NiagaraSystemInstance.h | |
| bLODDistanceIsOverridden | uint8 | NiagaraSystemInstance.h | ||
| bLODDistanceIsValid | uint8 | NiagaraSystemInstance.h | ||
| bNeedsUIResync | uint8 | NiagaraSystemInstance.h | ||
| bNotifyOnCompletion | uint8 | NiagaraSystemInstance.h | ||
| bPooled | uint8 | True if the system instance is pooled. Prevents unbinding of parameters on completing the system | NiagaraSystemInstance.h | |
| bSolo | uint8 | Indicates whether this instance must update itself rather than being batched up as most instances are. | NiagaraSystemInstance.h | |
| bWasSoloPriorToCaptureRequest | bool | NiagaraSystemInstance.h | ||
| CachedDeltaSeconds | float | Cached delta time, written during Tick_GameThread and used during other phases. | NiagaraSystemInstance.h | |
| CapturedFrames | TMap< FGuid, TSharedPtr< TArray< TSharedPtr< struct FNiagaraScriptDebuggerInfo, ESPMode::ThreadSafe > >, ESPMode::ThreadSafe > > | NiagaraSystemInstance.h | ||
| ComputeDispatchInterfacePtr | TSharedPtr< FNiagaraGpuComputeDispatchInterface > | NiagaraSystemInstance.h | ||
| ConcurrentTickBatchGraphEvent | FGraphEventRef | NiagaraSystemInstance.h | ||
| ConcurrentTickGraphEvent | FGraphEventRef | Graph event to track pending concurrent work. | NiagaraSystemInstance.h | |
| CrashReporterTag | FString | Tag we feed into crash reporter for this instance. | NiagaraSystemInstance.h | |
| CurrentCapture | TSharedPtr< TArray< TSharedPtr< struct FNiagaraScriptDebuggerInfo, ESPMode::ThreadSafe > >, ESPMode::ThreadSafe > | NiagaraSystemInstance.h | ||
| CurrentCaptureGuid | TSharedPtr< FGuid, ESPMode::ThreadSafe > | NiagaraSystemInstance.h | ||
| CurrentFrameIndex | uint8 | Used for double buffered global/system/emitter parameters | NiagaraSystemInstance.h | |
| DataInterfaceInstanceData | TArray< uint8, TAlignedHeapAllocator< 16 > > | Per instance data for any data interfaces requiring it. | NiagaraSystemInstance.h | |
| DataInterfaceInstanceDataOffsets | TArray< TPair< TWeakObjectPtr< UNiagaraDataInterface >, int32 > > | Map of data interfaces to their instance data. | NiagaraSystemInstance.h | |
| DeferredResetMode | EResetMode | If async work was running when we request an Activate we will store the reset mode and perform in finalize to avoid stalling the GameThread. | NiagaraSystemInstance.h | |
| EmitterEventDataSetMap | EventDataSetMap | NiagaraSystemInstance.h | ||
| EmitterParameters | TArray< FNiagaraEmitterParameters > | NiagaraSystemInstance.h | ||
| Emitters | TArray< FNiagaraEmitterInstanceRef > | TArray |
NiagaraSystemInstance.h | |
| FeatureLevel | ERHIFeatureLevel::Type | The feature level of for this component instance. | NiagaraSystemInstance.h | |
| FinalizeRef | FNiagaraSystemInstanceFinalizeRef | When using concurrent ticking this will be valid until it's complete. | NiagaraSystemInstance.h | |
| FixedBounds_CNC | FBox | NiagaraSystemInstance.h | ||
| FixedBounds_GT | FBox | Optional user specified bounds. | NiagaraSystemInstance.h | |
| GlobalParameters | FNiagaraGlobalParameters | NiagaraSystemInstance.h | ||
| ID | FNiagaraSystemInstanceID | NiagaraSystemInstance.h | ||
| IDName | FName | NiagaraSystemInstance.h | ||
| InstanceParameters | FNiagaraParameterStore | Per system instance parameters. | NiagaraSystemInstance.h | |
| LastRenderTime | float | The last time this system rendered | NiagaraSystemInstance.h | |
| LocalBounds | FBox | Current calculated local bounds. | NiagaraSystemInstance.h | |
| LODDistance | float | LODDistance driven by our component. | NiagaraSystemInstance.h | |
| LWCTile | FVector3f | The LWC tile of this system instance, used to offset all local simulation relative to the origin | NiagaraSystemInstance.h | |
| MaxLODDistance | float | NiagaraSystemInstance.h | ||
| OnCompleteDelegate | FOnComplete | NiagaraSystemInstance.h | ||
| OnDestroyedDelegate | FOnDestroyed | NiagaraSystemInstance.h | ||
| OnInitializedDelegate | FOnInitialized | NiagaraSystemInstance.h | ||
| OnPostTickDelegate | FOnPostTick | NiagaraSystemInstance.h | ||
| OnResetDelegate | FOnReset | NiagaraSystemInstance.h | ||
| OverrideParameters | FNiagaraUserRedirectionParameterStore * | NiagaraSystemInstance.h | ||
| OwnerParameters | FNiagaraOwnerParameters | NiagaraSystemInstance.h | ||
| ParametersValid | uint8 | NiagaraSystemInstance.h | ||
| PerInstanceDIFunctions | TArray< FNiagaraPerInstanceDIFuncInfo > | A set of function bindings for DI calls that must be made per system instance. | NiagaraSystemInstance.h | |
| PostTickDataInterfaces | TArray< int32 > | NiagaraSystemInstance.h | ||
| PreTickDataInterfaces | TArray< int32 > | NiagaraSystemInstance.h | ||
| PreviousLocation | TOptional< FVector > | NiagaraSystemInstance.h | ||
| RandomSeed | int32 | Random seed used for system simulation random number generation. | NiagaraSystemInstance.h | |
| RandomSeedOffset | int32 | A system-wide offset to permute the deterministic random seed (allows for variance among multiple instances while still being deterministic) | NiagaraSystemInstance.h | |
| RequestedExecutionState | ENiagaraExecutionState | Execution state requested by external code/BPs calling Activate/Deactivate. | NiagaraSystemInstance.h | |
| SceneComponentUtils | TUniquePtr< INiagaraSceneComponentUtils > | NiagaraSystemInstance.h | ||
| SignificanceIndex | int32 | Index of how significant this system is in the scene. | NiagaraSystemInstance.h | |
| System | UNiagaraSystem * | NiagaraSystemInstance.h | ||
| SystemGpuComputeProxy | TUniquePtr< FNiagaraSystemGpuComputeProxy > | NiagaraSystemInstance.h | ||
| SystemInstanceIndex | int32 | Index of this instance in the system simulation. | NiagaraSystemInstance.h | |
| SystemParameters | FNiagaraSystemParameters | NiagaraSystemInstance.h | ||
| SystemSimulation | TSharedPtr< class FNiagaraSystemSimulation, ESPMode::ThreadSafe > | NiagaraSystemInstance.h | ||
| SystemSpawnDIStageTickHandler | FNDIStageTickHandler | NiagaraSystemInstance.h | ||
| SystemUpdateDIStageTickHandler | FNDIStageTickHandler | NiagaraSystemInstance.h | ||
| TickCount | int32 | The tick count of the System instance. | NiagaraSystemInstance.h | |
| TimeSinceLastForceUpdateTransform | float | Time since we last forced a bounds update. | NiagaraSystemInstance.h | |
| WarmupTickCount | int32 | NiagaraSystemInstance.h | ||
| WarmupTickDelta | float | NiagaraSystemInstance.h | ||
| World | UWorld * | NiagaraSystemInstance.h | ||
| WorldTransform | FTransform | NiagaraSystemInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Activate
(
EResetMode InResetMode |
NiagaraSystemInstance.h | ||
void AdvanceSimulation
(
int32 TickCountToSimulate, |
Manually advances this system's simulation by the specified number of ticks and tick delta. | NiagaraSystemInstance.h | |
void BindParameters() |
Void RebindParameterCollection(UNiagaraParameterCollectionInstance* OldInstance, UNiagaraParameterCollectionInstance* NewInstance); | NiagaraSystemInstance.h | |
void BindToParameterStore
(
FNiagaraParameterStore& ParameterStore |
Bindings Override Parameters / Instance Parameters / System Simulation Parameters to the provded parameter store I.e. | NiagaraSystemInstance.h | |
ETickingGroup CalculateTickGroup() |
Calculates which tick group the instance should be in. | NiagaraSystemInstance.h | |
void Cleanup() |
NiagaraSystemInstance.h | ||
void ClearEventDataSets() |
NiagaraSystemInstance.h | ||
void ClearLODDistance() |
NiagaraSystemInstance.h | ||
void Complete
(
bool bExternalCompletion |
NiagaraSystemInstance.h | ||
FNiagaraDataSet * CreateEventDataSet
(
FName EmitterName, |
NiagaraSystemInstance.h | ||
void Deactivate
(
bool bImmediate |
NiagaraSystemInstance.h | ||
void Dump() |
Dumps all of this systems info to the log. | NiagaraSystemInstance.h | |
void DumpTickInfo
(
FOutputDevice& Ar |
Dumps information about the instances tick to the log | NiagaraSystemInstance.h | |
FNiagaraEmitterParameters & EditEmitterParameters
(
int32 EmitterIdx |
NiagaraSystemInstance.h | ||
void EvaluateBoundFunction
(
FName FunctionName, |
NiagaraSystemInstance.h | ||
void FinalizeTick_GameThread
(
bool bEnqueueGPUTickIfNeeded |
Final phase of system instance tick. | NiagaraSystemInstance.h | |
void * FindDataInterfaceInstanceData
(
const UNiagaraDataInterface* Interface |
Returns the instance data for a particular interface for this System. | NiagaraSystemInstance.h | |
const void * FindDataInterfaceInstanceData
(
const UNiagaraDataInterface* Interface |
NiagaraSystemInstance.h | ||
int32 FindDataInterfaceInstanceDataIndex
(
UNiagaraDataInterface* Interface |
NiagaraSystemInstance.h | ||
TDataType * FindTypedDataInterfaceInstanceData
(
const UNiagaraDataInterface* Interface |
NiagaraSystemInstance.h | ||
const TDataType * FindTypedDataInterfaceInstanceData
(
const UNiagaraDataInterface* Interface |
NiagaraSystemInstance.h | ||
void FinishCapture() |
Only call from within the script execution states. Does nothing if not capturing a frame. | NiagaraSystemInstance.h | |
void FlipParameterBuffers() |
NiagaraSystemInstance.h | ||
void GenerateAndSubmitGPUTick() |
NiagaraSystemInstance.h | ||
TArray< TSharedPtr< struct FNiagaraScriptDebuggerInfo, ESPMode::ThreadSafe > > * GetActiveCaptureResults() |
Only call from within the script execution states. Value is null if not capturing a frame. | NiagaraSystemInstance.h | |
TSharedPtr< struct FNiagaraScriptDebuggerInfo, ESPMode::ThreadSafe > GetActiveCaptureWrite
(
const FName& InHandleName, |
Only call from within the script execution states. Value is nullptr if not capturing a frame. | NiagaraSystemInstance.h | |
ENiagaraExecutionState GetActualExecutionState() |
NiagaraSystemInstance.h | ||
float GetAge() |
NiagaraSystemInstance.h | ||
bool GetAreDataInterfacesInitialized() |
NiagaraSystemInstance.h | ||
USceneComponent * GetAttachComponent() |
NiagaraSystemInstance.h | ||
FNiagaraGpuComputeDispatchInterface * GetComputeDispatchInterface() |
NiagaraSystemInstance.h | ||
const FString & GetCrashReporterTag() |
NiagaraSystemInstance.h | ||
const void GetDataInterfaceInstanceDataInfo
(
int32 Index, |
NiagaraSystemInstance.h | ||
FNiagaraEmitterInstance * GetEmitterByID
(
FNiagaraEmitterID ID |
NiagaraSystemInstance.h | ||
TConstArrayView< FNiagaraEmitterExecutionIndex > GetEmitterExecutionOrder() |
NiagaraSystemInstance.h | ||
FBox GetEmitterFixedBounds
(
FName EmitterName |
NiagaraSystemInstance.h | ||
const FNiagaraEmitterParameters & GetEmitterParameters
(
int32 EmitterIdx, |
NiagaraSystemInstance.h | ||
TConstArrayView< FNiagaraEmitterInstanceRef > GetEmitters () |
NiagaraSystemInstance.h | ||
TArrayView< FNiagaraEmitterInstanceRef > GetEmitters () |
NiagaraSystemInstance.h | ||
FNiagaraDataSet * GetEventDataSet
(
FName EmitterName, |
NiagaraSystemInstance.h | ||
ERHIFeatureLevel::Type GetFeatureLevel() |
NiagaraSystemInstance.h | ||
const FNiagaraGlobalParameters & GetGlobalParameters
(
bool PreviousFrame |
NiagaraSystemInstance.h | ||
FNiagaraSystemInstanceID GetId() |
NiagaraSystemInstance.h | ||
FNiagaraParameterStore & GetInstanceParameters() |
NiagaraSystemInstance.h | ||
bool GetIsolateEnabled() |
NiagaraSystemInstance.h | ||
float GetLastRenderTime() |
NiagaraSystemInstance.h | ||
const FBox & GetLocalBounds() |
NiagaraSystemInstance.h | ||
float GetLODDistance() |
Calculates the distance to use for distance based LODing / culling. | NiagaraSystemInstance.h | |
FNiagaraLWCConverter GetLWCConverter
(
bool bLocalSpaceEmitter |
NiagaraSystemInstance.h | ||
FTransform GetLWCSimToWorld
(
bool bLocalSpaceEmitter |
NiagaraSystemInstance.h | ||
const FVector3f & GetLWCTile() |
NiagaraSystemInstance.h | ||
float GetMaxLODDistance() |
NiagaraSystemInstance.h | ||
| NiagaraSystemInstance.h | |||
| NiagaraSystemInstance.h | |||
const FNiagaraOwnerParameters & GetOwnerParameters
(
bool PreviousFrame |
NiagaraSystemInstance.h | ||
UNiagaraParameterCollectionInstance * GetParameterCollectionInstance
(
UNiagaraParameterCollection* Collection |
NiagaraSystemInstance.h | ||
uint32 GetParameterIndex
(
bool PreviousFrame |
NiagaraSystemInstance.h | ||
const FNiagaraPerInstanceDIFuncInfo & GetPerInstanceDIFunction
(
ENiagaraSystemSimulationScript ScriptType, |
NiagaraSystemInstance.h | ||
UActorComponent * GetPrereqComponent() |
NiagaraSystemInstance.h | ||
int32 GetRandomSeedOffset() |
NiagaraSystemInstance.h | ||
ENiagaraExecutionState GetRequestedExecutionState() |
NiagaraSystemInstance.h | ||
FNiagaraEmitterInstancePtr GetSimulationForHandle
(
const FNiagaraEmitterHandle& EmitterHandle |
Gets the simulation for the supplied emitter handle. | NiagaraSystemInstance.h | |
UNiagaraSystem * GetSystem() |
NiagaraSystemInstance.h | ||
FNDIStageTickHandler * GetSystemDIStageTickHandler
(
ENiagaraScriptUsage Usage |
NiagaraSystemInstance.h | ||
FBox GetSystemFixedBounds() |
NiagaraSystemInstance.h | ||
FNiagaraSystemGpuComputeProxy * GetSystemGpuComputeProxy() |
NiagaraSystemInstance.h | ||
int32 GetSystemInstanceIndex() |
NiagaraSystemInstance.h | ||
const FNiagaraSystemParameters & GetSystemParameters
(
bool PreviousFrame |
NiagaraSystemInstance.h | ||
TSharedPtr< FNiagaraSystemSimulation, ESPMode::ThreadSafe > GetSystemSimulation() |
NiagaraSystemInstance.h | ||
ENiagaraTickBehavior GetTickBehavior() |
Get the current tick behavior | NiagaraSystemInstance.h | |
int32 GetTickCount() |
NiagaraSystemInstance.h | ||
UWorld * GetWorld() |
NiagaraSystemInstance.h | ||
FNiagaraWorldManager * GetWorldManager() |
NiagaraSystemInstance.h | ||
const FTransform & GetWorldTransform() |
Gets the current world transform of the system | NiagaraSystemInstance.h | |
bool HandleCompletion() |
Handles completion of the system and returns true if the system is complete. | NiagaraSystemInstance.h | |
bool HandleNeedsUIResync() |
NiagaraSystemInstance.h | ||
bool HasGPUEmitters() |
Void SetHasGPUEmitters(bool bInHasGPUEmitters) { bHasGPUEmitters = bInHasGPUEmitters; } | NiagaraSystemInstance.h | |
bool HasPendingFinalize() |
NiagaraSystemInstance.h | ||
void Init
(
bool bInForceSolo |
Initializes this System instance to simulate the supplied System. | NiagaraSystemInstance.h | |
void InitGPUTick
(
FNiagaraGPUSystemTick& OutTick |
NiagaraSystemInstance.h | ||
void InitSystemState() |
NiagaraSystemInstance.h | ||
bool IsComplete() |
Int32 GetNumParticles(int32 EmitterIndex) const { return ParameterNumParticleBindings[EmitterIndex].GetValue(); } float GetSpawnCountScale(int32 EmitterIndex) const { return ParameterSpawnCountScaleBindings[EmitterIndex].GetValue(); } | NiagaraSystemInstance.h | |
bool IsDisabled() |
NiagaraSystemInstance.h | ||
bool IsPaused() |
NiagaraSystemInstance.h | ||
bool IsPendingSpawn() |
NiagaraSystemInstance.h | ||
bool IsReadyToRun() |
NiagaraSystemInstance.h | ||
bool IsSolo() |
NiagaraSystemInstance.h | ||
void ManualTick
(
float DeltaSeconds, |
Manually advances the simulation. Ticks on the game thread. | NiagaraSystemInstance.h | |
bool MultiTick
(
int32 TicksToProcess, |
Manually advances the simulation by multiple ticks. | NiagaraSystemInstance.h | |
bool NeedsGPUTick() |
NiagaraSystemInstance.h | ||
FOnDestroyed & OnDestroyed() |
NiagaraSystemInstance.h | ||
FOnInitialized & OnInitialized() |
Gets a multicast delegate which is called whenever this instance is initialized with an System asset. | NiagaraSystemInstance.h | |
void OnPooledReuse
(
UWorld& NewWorld |
NiagaraSystemInstance.h | ||
FOnReset & OnReset() |
Gets a multicast delegate which is called whenever this instance is reset due to external changes in the source System asset. | NiagaraSystemInstance.h | |
void OnSimulationDestroyed() |
NiagaraSystemInstance.h | ||
bool QueryCaptureResults
(
const FGuid& RequestId, |
Poll for previous frame capture requests. | NiagaraSystemInstance.h | |
void RaiseNeedsUIResync() |
NiagaraSystemInstance.h | ||
bool RequestCapture
(
const FGuid& RequestId |
Request that this simulation capture a frame. Cannot capture if disabled or already completed. | NiagaraSystemInstance.h | |
bool RequiresCurrentFrameNDC() |
NiagaraSystemInstance.h | ||
bool RequiresDepthBuffer() |
NiagaraSystemInstance.h | ||
bool RequiresEarlyViewData() |
NiagaraSystemInstance.h | ||
bool RequiresGlobalDistanceField() |
NiagaraSystemInstance.h | ||
bool RequiresRayTracingScene() |
NiagaraSystemInstance.h | ||
bool RequiresViewUniformBuffer() |
NiagaraSystemInstance.h | ||
void Reset
(
EResetMode Mode |
Requests the the simulation be reset on the next tick. | NiagaraSystemInstance.h | |
void SetActualExecutionState
(
ENiagaraExecutionState InState |
NiagaraSystemInstance.h | ||
void SetEmitterEnable
(
FName EmitterName, |
NiagaraSystemInstance.h | ||
void SetEmitterFixedBounds
(
FName EmitterName, |
NiagaraSystemInstance.h | ||
void SetForceSolo
(
bool bForceSolo |
NiagaraSystemInstance.h | ||
void SetGpuComputeDebug
(
bool bEnableDebug |
NiagaraSystemInstance.h | ||
void SetLastRenderTime
(
float TimeSeconds |
NiagaraSystemInstance.h | ||
void SetLODDistance
(
float InLODDistance, |
NiagaraSystemInstance.h | ||
void SetOnComplete
(
const FOnComplete& InOnCompleteDelegate |
Gets a multicast delegate which is called whenever this instance is complete. | NiagaraSystemInstance.h | |
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 | NiagaraSystemInstance.h | |
void SetPaused
(
bool bInPaused |
NiagaraSystemInstance.h | ||
void SetPendingFinalize
(
FNiagaraSystemInstanceFinalizeRef InFinalizeRef |
NiagaraSystemInstance.h | ||
void SetRandomSeedOffset
(
int32 Offset |
NiagaraSystemInstance.h | ||
void SetRequestedExecutionState
(
ENiagaraExecutionState InState |
NiagaraSystemInstance.h | ||
void SetSolo
(
bool bInSolo |
NiagaraSystemInstance.h | ||
void SetSystemFixedBounds
(
const FBox& InLocalBounds |
NiagaraSystemInstance.h | ||
void SetSystemSignificanceIndex
(
int32 InIndex |
The significant index for this component. | NiagaraSystemInstance.h | |
void SetTickBehavior
(
ENiagaraTickBehavior NewTickBehavior |
Set a new tick behavior, this will not move the instance straight away and will wait until the next time it is evaluated | NiagaraSystemInstance.h | |
void SetWarmupSettings
(
int32 WarmupTickCount, |
NiagaraSystemInstance.h | ||
void SetWorldTransform
(
const FTransform& InTransform |
Sets the world transform | NiagaraSystemInstance.h | |
bool ShouldCaptureThisFrame() |
Only call from within the script execution states. Value is false if not capturing a frame. | NiagaraSystemInstance.h | |
void SimCacheTick_GameThread
(
UNiagaraSimCache* SimCache, |
Ticks the system using the a SimCache. | NiagaraSystemInstance.h | |
void SimCacheTickFinalize_GameThread() |
Final step after concurrent tick has run. | NiagaraSystemInstance.h | |
void Tick_Concurrent
(
bool bEnqueueGPUTickIfNeeded |
Secondary phase of the system instance tick that can be executed on any thread. | NiagaraSystemInstance.h | |
void Tick_GameThread
(
float DeltaSeconds |
Initial phase of system instance tick. Must be executed on the game thread. | NiagaraSystemInstance.h | |
void TickDataInterfaces
(
float DeltaSeconds, |
Perform per-tick updates on data interfaces that need it. | NiagaraSystemInstance.h | |
void TickInstanceParameters_Concurrent() |
NiagaraSystemInstance.h | ||
void TickInstanceParameters_GameThread
(
float DeltaSeconds |
NiagaraSystemInstance.h | ||
void TickSystemState() |
NiagaraSystemInstance.h | ||
void UnbindFromParameterStore
(
FNiagaraParameterStore& ParameterStore |
Unbinds the parameters that would be bound via BindToParameterStore. | NiagaraSystemInstance.h | |
void UnbindParameters
(
bool bFromComplete |
NiagaraSystemInstance.h | ||
void UpdateLWCTile
(
const FVector3f& InLWCTile, |
NiagaraSystemInstance.h | ||
bool UsesCollection
(
const UNiagaraParameterCollection* Collection |
NiagaraSystemInstance.h | ||
void WaitForConcurrentTickAndFinalize
(
bool bEnsureComplete |
Wait for any pending concurrent work to complete, must be called on the GameThread. | NiagaraSystemInstance.h | |
void WaitForConcurrentTickDoNotFinalize
(
bool bEnsureComplete |
Wait for any pending concurrent work to complete, must be called on the GameThread. | NiagaraSystemInstance.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool AllocateSystemInstance
(
FNiagaraSystemInstancePtr& OutSystemInstanceAllocation, |
NiagaraSystemInstance.h | ||
static bool DeallocateSystemInstance
(
FNiagaraSystemInstancePtr& SystemInstanceAllocation |
NiagaraSystemInstance.h | ||
static const INiagaraSceneComponentUtils & GetSceneComponentUtils
(
FNiagaraSystemInstance* Instance |
NiagaraSystemInstance.h |