code: void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


module: Niagara

code: void InvalidateCachedSystemData()


code: int32 NumRegisteredComponents() const


code: void OnRefreshOwnerAllowsScalability()


code: void OnSystemPostChange ( [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * System )


code: void PreGarbageCollectBeginDestroy()


code: void Register ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * Component )


code: void Update ( [FNiagaraWorldManager](API\Plugins\Niagara\FNiagaraWorldManager) * Owner, float DeltaSeconds, bool bNewOnly )


code: void Unregister ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * Component )


className: FNiagaraScalabilityManager

bRefreshOwnerAllowsScalability

type: bool

EffectType

type: TObjectPtr<UNi...

LastUpdateTime

type: double

ManagedComponents

type: TArray<TObject...

State

type: TArray<FNiagar...

SystemDataIndexMap

type: TMap<UNiagaraS...


code: FNiagaraScalabilityState ( float InSignificance, bool InCulled, bool InPreviousCulled )


className: FNiagaraScalabilityState

bCulled

type: uint8:  1

LastVisibleTime

type: float


className: FNiagaraScalabilitySystemData

description: Working data and cached scalability relevant state for UNiagaraSystems.

code: struct FNiagaraScalabilitySystemData

bNeedsSignificanceForActiveOrDirty

type: uint16:  1

description: True if we need significance data for active instances of this system.

bNeedsSignificanceForCulled

description: True if we need significance data for culled instances of this system.


className: FDynamicData

description: Some proxy wide dynamic settings passed down with the emitter dynamic data.

code: struct FDynamicData

PerfStatsContext

type: FParticlePerfSt...


description: Called to allow renderers to free render state

code: void DestroyRenderState_Concurrent()


description: Args - TYPE, DIMENSION, [UE_TYPENAME], [COMPONENT_TYPE]. e.g. Vector, 3, FVector, double // LWC_TODO: Remove COMPONENT_TYPE.

code: [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * GetCustomUniformBuffer ( bool bHasVelocity, const FBox & InstanceBounds ) const


code: [TUniformBuffer](API\Runtime\Engine\TUniformBuffer)< [FPrimitiveUniformShaderParameters](API\Runtime\Engine\FPrimitiveUniformShaderParameter-) > * GetCustomUniformBufferResource ( bool bHasVelocity, const FBox & InstanceBounds ) const


code: const FMatrix & GetLocalToWorldInverse() const


code: const FVector3f & GetLWCRenderTile() const


code: const [FDynamicData](API\Plugins\Niagara\FNiagaraSceneProxy\FDynamicData) & GetProxyDynamicData() const


description: Gets whether or not this scene proxy should be rendered.

code: bool GetRenderingEnabled() const


description: Retrieves the render data for a single system


description: Return a type (or subtype) specific hash for sorting purposes

code: virtual SIZE_T GetTypeHash() const


description:
Determines the relevance of this primitive's elements to the given view. Called in the rendering thread.
The relevance of the primitive's elements to the view.

code: virtual [FPrimitiveViewRelevance](API\Runtime\Engine\FPrimitiveViewRelevance) GetViewRelevance ( const [FSceneView](API\Runtime\Engine\FSceneView) * View ) const


code: void SetProxyDynamicData ( const [FDynamicData](API\Plugins\Niagara\FNiagaraSceneProxy\FDynamicData) & NewData )


description: Sets whether or not this scene proxy should be rendered.

code: void SetRenderingEnabled ( bool bInRenderingEnabled )


code: FNiagaraSceneProxy ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * InComponent )


className: FNiagaraSceneProxy

description: Scene proxy for drawing niagara particle simulations.

code: class FNiagaraSceneProxy : public [FPrimitiveSceneProxy](API\Runtime\Engine\FPrimitiveSceneProxy)


className: FNiagaraScriptAsyncCompileData

CompileId

type: FNiagaraVMExecu...

CompileMetrics

type: FNiagaraScriptC...

ExeData

type: TSharedPtr< str...

NamedDataInterfaces

type: TMap<FName,TO...

UniqueEmitterName

type: FString


className: FNiagaraScriptAsyncOptimizeTaskStatePtr


className: FNiagaraScriptAsyncOptimizeTaskState

description: Carrier for uncompressed, and optimmized bytecode returned from optimization task.

ExternalFunctionRegisterCounts

type: TArray< uint8, ...


className: FNiagaraScriptCompileMetrics

code: struct FNiagaraScriptCompileMetrics


description: Would this data interface work on the target execution type? Only call this on the game thread.

code: bool CanExecuteOnTarget ( [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) SimTarget ) const


description: Note that this is the CDO for this type of data interface, as we often cannot guarantee that the same instance of the data interface we compiled with is the one the user ultimately executes. Only call this on the game thread.

code: [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * GetDefaultDataInterface() const


code: bool MatchesClass ( const [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass ) const


code: bool NeedsPerInstanceBinding() const


className: FNiagaraScriptDataInterfaceCompileInfo

Name

type: FName

RegisteredFunctions

description: Removed from cooked builds, if we need to add this back theTMapFunctionSpecifiers should be replaced with an array.

Type

type: FNiagaraTypeDef...

UserPtrIdx

description: Indexof the user pointer for this data interface.


code: FNiagaraScriptDataInterfaceInfo()


className: FNiagaraScriptDataInterfaceInfo

DataInterface

type: TObjectPtr< cla...


className: FNiagaraScriptDataUsageInfo

description: Struct containing usage information about a script. Things such as whether it reads attribute data, reads or writes events data etc.

bReadsAttributeData

type: bool

description: If true, this script reads attribute data.


code: FNiagaraScriptDebuggerInfo ( [FName](API\Runtime\Core\UObject\FName) InName, [ENiagaraScriptUsage](API\Plugins\Niagara\ENiagaraScriptUsage) InUsage, const [FGuid](API\Runtime\Core\Misc\FGuid) & InUsageId )


className: FNiagaraScriptDebuggerInfo

code: struct FNiagaraScriptDebuggerInfo

bWritten

type: TAtomic< bool >

Frame

type: FNiagaraDataSet

Parameters

type: FNiagaraParamet...

Usage

type: ENiagaraScriptU...

UsageId

type: FGuid


code: virtual bool Tick ( class [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) SimTarget )


className: FNiagaraScriptExecutionContext

code: struct FNiagaraScriptExecutionContext : public [FNiagaraScriptExecutionContextBase](API\Plugins\Niagara\FNiagaraScriptExecutionContextBa-)

LocalFunctionTable

type: TArray< FVMExte...

description: Table of external function delegates unique to the instance.


code: void BindData ( int32 Index, [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, int32 StartInstance, bool bUpdateInstanceCounts )


code: void BindData ( int32 Index, [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * Input, int32 StartInstance, bool bUpdateInstanceCounts )


description: Unused. These are only useful in the new SystemScript context.

code: virtual void BindSystemInstances ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * > & InSystemInstances )


code: virtual bool Execute ( class [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, float DeltaSeconds, uint32 NumInstances, const [FScriptExecutionConstantBufferTable](API\Plugins\Niagara\FScriptExecutionConstantBufferTa-) & ConstantBufferTable )


code: virtual bool GeneratePerInstanceDIFunctionTable ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Inst, [TArray](API\Runtime\Core\Containers\TArray)< struct [FNiagaraPerInstanceDIFuncInfo](API\Plugins\Niagara\FNiagaraPerInstanceDIFuncInfo) > & OutFunctions )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * > & GetDataInterfaces() const


code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > GetScriptLiterals() const


code: virtual bool Init ( class [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * InScript, [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) InTarget )


code: virtual void InitDITickLists ( class [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance )


code: bool Tick ( class [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) SimTarget )


className: TickCounter

code: static uint32 TickCounter = 0;


code: FNiagaraScriptExecutionContextBase()


className: FNiagaraScriptExecutionContextBase

DataSetInfo

type: TArray<FNiagar...

DataSetMetaTable

type: TArray<FDataSe...

DIStageTickHandler

type: FNDIStageTickHa...

FunctionTable

type: TArray< const F...

description: Table of external function delegate handles called from the VM.

Parameters

type: FNiagaraScriptI...

description: Parameter store.

Script

type: UNiagaraScript...

ScriptType

type: ENiagaraSystemS...

description: The script type this context is for.

UserPtrTable

type: TArray< void &#...

description: Table of user ptrs to pass to the VM.

VectorVMState

type: FVectorVMState...


code: FNiagaraScriptExecutionPaddingInfo()


code: FNiagaraScriptExecutionPaddingInfo ( uint32 InSrcOffset, uint32 InDestOffset, uint32 InSrcSize, uint32 InDestSize )


className: FNiagaraScriptExecutionPaddingInfo


code: void AddPaddedParamSize ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & InParamType, uint32 InOffset )


description: Adds the passed parameter to this store. Does nothing if this parameter is already present. Returns true if we added a new parameter.

code: virtual bool AddParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Param, bool bInitialize, bool bTriggerRebind, int32 * OutOffset )


code: void AddScriptParams ( [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * Script, [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) SimTarget, bool bTriggerRebind )


description: Removes all parameters from this store and releases any data.

code: virtual void Empty ( bool bClearBindings )


description: TODO: These function can probably go away entirely when we replace theFNiagaraParametersand DataInterface info in the script with anFNiagaraParameterStore. Special care with prev params and internal params will have to be taken there. Call this init function if you are using a Niagara parameter store within aUNiagaraScript.

code: void InitFromOwningScript ( [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * Script, [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) SimTarget, bool bNotifyAsDirty )


code: [FNiagaraScriptExecutionParameterStore](API\Plugins\Niagara\FNiagaraScriptExecutionParameter-) & operator= ( const [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & Other )


description: Removes the passed parameter if it exists in the store.

code: virtual bool RemoveParameter ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & Param )


description: Renames the passed parameter.

code: virtual void RenameParameter ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & Param, [FName](API\Runtime\Core\UObject\FName) NewName )


description: Removes all parameters from this store but doesn't change memory allocations.

code: virtual void Reset ( bool bClearBindings )


code: FNiagaraScriptExecutionParameterStore()


code: FNiagaraScriptExecutionParameterStore ( const [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & Other )


className: FNiagaraScriptExecutionParameterStore

description: Storage class containing actual runtime buffers to be used by the VM and the GPU. Is not the actual source for any parameter data, rather just the final place it's gathered from various other places ready for execution.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FNiagaraScriptExecutionParameterStore : public [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore)

bInitialized

type: uint8:  1

CachedScriptLiterals

type: TArray< uint8 >

ParameterSize

description: Size of the parameter data not including prev frame values or internal constants.


code: static void ArrayToJson ( const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraScriptHighlight](API\Plugins\Niagara\FNiagaraScriptHighlight) > & InHighlights, [FString](API\Runtime\Core\Containers\FString) & OutJson )


code: static void JsonToArray ( const [FString](API\Runtime\Core\Containers\FString) & InJson, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraScriptHighlight](API\Plugins\Niagara\FNiagaraScriptHighlight) > & OutHighlights )


code: bool operator== ( const [FNiagaraScriptHighlight](API\Plugins\Niagara\FNiagaraScriptHighlight) & Other ) const


className: FNiagaraScriptHighlight

Color

type: FLinearColor

DisplayName

type: FText


description: Helper that converts the data from the base type array internally into the padded out renderer-ready format.

code: void CopyParameterDataToPaddedBuffer ( uint8 * InTargetBuffer, uint32 InTargetBufferSizeInBytes ) const


description: Just the external parameters, not previous or internal...

code: uint32 GetExternalParameterSize() const


code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > GetScriptLiterals() const


description: Call this init function if you are using a Niagara parameter store within anFNiagaraScriptExecutionContext.

code: void InitFromOwningContext ( [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * Script, [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) SimTarget, bool bNotifyAsDirty )


description: The View of the set of variables represented by this ParameterStore.Bydefault it will be the variables defined by the SortedParameterOffsets, but child classes can override it so that we can share the list of Variables across different instances as it's generally read only data in game

code: virtual [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FNiagaraVariableWithOffset](API\Plugins\Niagara\FNiagaraVariableWithOffset) > ReadParameterVariables() const


description: FNiagaraScriptInstanceParameterStore.

code: FNiagaraScriptInstanceParameterStore()


className: FNiagaraScriptInstanceParameterStore

description: FNiagaraScriptInstanceParameterStore.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FNiagaraScriptInstanceParameterStore : public [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore)


code: bool NeedsPerInstanceBinding() const


className: FNiagaraScriptResolvedDataInterfaceInfo

bIsInternal

type: bool

CompileName

type: FName

ParameterStoreVariable

type: FNiagaraVariabl...

ResolvedDataInterface

type: TObjectPtr<UNi...

ResolvedSourceEmitterName

type: FString


className: FNiagaraScriptUObjectCompileInfo

Object

type: TObjectPtr< cla...

ObjectPath

type: FSoftObjectPath

RegisteredParameterMapWrites

type: TArray<FName>


code: void SetName ( [FName](API\Runtime\Core\UObject\FName) InName )


code: FNiagaraScriptVariableBinding ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & InVar )


code: FNiagaraScriptVariableBinding ( const [FName](API\Runtime\Core\UObject\FName) & InName )


className: FNiagaraScriptVariableBinding

description: Primarily a wrapper around anFNameto be used for customizations in the Selected Details panel to select a default binding to initialize module inputs. The customization implementation is FNiagaraScriptVariableBindingCustomization.


className: CritSec

code: static FCriticalSection CritSec;


className: DeferredDeletionList

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraSharedObject](API\Plugins\Niagara\FNiagaraSharedObject) * > DeferredDeletionList;


description: The owner of this object is now done with it but it may still be in use by others, possibly on other threads. Add to the deletion queue so it can be safely freed when it's no longer in use.

code: void Destroy()


className: FNiagaraSharedObject

description: Base class for objects in Niagara that are owned by one object but are then passed for reading to other objects, potentially on other threads. This class allows us to know if the object is being used so we do not overwrite it and to ensure it's lifetime so we do not access freed data.

code: class FNiagaraSharedObject

ReadRefCount

type: TAtomic< int32 ...

description: Count of other object currently reading this data.


description: Captures the simulations current frame data into the SimCache. This happens immediately so you may need to be careful with tick order of the component you are capturing from. The return can be invalid if the component can not be captured for some reason (i.e. not active). When AdvanceSimulation is true we will manually advance the simulation one frame using the provided AdvanceDeltaTime before capturing.

code: bool CaptureCurrentFrameImmediate ( [UNiagaraSimCache](API\Plugins\Niagara\UNiagaraSimCache) * SimCache, [FNiagaraSimCacheCreateParameters](API\Plugins\Niagara\FNiagaraSimCacheCreateParameters) CreateParameters, [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraComponent, [UNiagaraSimCache](API\Plugins\Niagara\UNiagaraSimCache) *& OutSimCache, bool bAdvanceSimulation, float AdvanceDeltaTime )


description: Captures a niagara sim cache. The caller is responsible for managing the lifetime of the provided component and sim cache.

code: void CaptureNiagaraSimCache ( [UNiagaraSimCache](API\Plugins\Niagara\UNiagaraSimCache) * SimCache, [FNiagaraSimCacheCreateParameters](API\Plugins\Niagara\FNiagaraSimCacheCreateParameters) CreateParameters, [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraComponent, [FNiagaraSimCacheCaptureParameters](API\Plugins\Niagara\FNiagaraSimCacheCaptureParameter-) CaptureParameters )


className: FOnCaptureComplete

code: typedef TMulticastDelegate_OneParam< void, [UNiagaraSimCache](API\Plugins\Niagara\UNiagaraSimCache) * > FOnCaptureComplete


className: FNiagaraSimCacheCapture

code: class FNiagaraSimCacheCapture


code: FNiagaraSimCacheCaptureParameters()


className: FNiagaraSimCacheCaptureParameters

bAppendToSimCache

type: uint32:  1

description: When enabled we will append to the existing simulation cache rather than destroying the existing contents.

bCaptureAllFramesImmediatly

description: When enabled we will capture all the requested frames immediatly.

bCaptureFixedNumberOfFrames

description: When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete.

bUseTimeout

description: When enabled the capture will time out if we reach the defined number of frames without anything new to capture.

CaptureRate

description: Allows for reducing the frequency of captured frames in relation to the simulation's frames.

ImmediateCaptureDeltaTime

type: float

description: The delta time in seconds to use when manually advancing the simulation.Defaults to 1 / 60th of a second(0.01666).

NumFrames

description: The max number of frames to capture.

TimeoutFrameCount

description: When we fail to capture a new frame after this many frames the capture will complete automatically.


code: FNiagaraSimCacheCreateParameters()


className: FNiagaraSimCacheCreateParameters

AttributeCaptureMode

type: ENiagaraSimCach...

description: How do we want to capture attributes for the simulation cache.

bAllowDataInterfaceCaching

description: When enabled Data Interface data will be stored in the SimCache.

bAllowInterpolation

description: When enabled we allow the cache to be generated for interpolation.

bAllowRebasing

description: When enabled allows the SimCache to be re-based.

bAllowVelocityExtrapolation

description: When enabled we allow the cache to be generated for extrapolation.

ExplicitCaptureAttributes

description: List of attributes to capture when the capture attribute capture mode is set to explicit.

InterpolationExcludeAttributes

description: List of specific Attributes to exclude interpolation for.

InterpolationIncludeAttributes

description: List of specific Attributes to include when using interpolation.

RebaseExcludeAttributes

description: List of Attributes to force exclude from the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter

RebaseIncludeAttributes

description: List of Attributes to force include in the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter


code: bool operator== ( const [FNiagaraSimCacheDataBuffers](API\Plugins\Niagara\FNiagaraSimCacheDataBuffers) & Other ) const


code: bool operator!= ( const [FNiagaraSimCacheDataBuffers](API\Plugins\Niagara\FNiagaraSimCacheDataBuffers) & Other ) const


className: FNiagaraSimCacheDataBuffers

IDToIndexTable

type: TArray< int32 >

InterpMapping

type: TArray< uint32 ...


className: FCacheBufferReadInfo

code: struct FCacheBufferReadInfo

ComponentMappingsToDataBuffer

type: TArray< uint16 ...

VariableCopyMappingsToDataBuffer

type: TArray<FVariab...


code: const [FNiagaraSimCacheVariable](API\Plugins\Niagara\FNiagaraSimCacheVariable) * FindCacheVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InVariable ) const


className: FCacheBufferWriteInfo

code: struct FCacheBufferWriteInfo


className: FVariableCopyContext

code: struct FVariableCopyContext

DestCurr

type: uint8 *

InterpMappings

type: TConstArrayView...

RebaseTransform

type: FTransform

SourceACurr

type: const uint8 ...


className: FVariableCopyFunction

code: typedef void(* FVariableCopyFunction


code: FVariableCopyMapping &40; uint16 InComponentFrom, uint16 InComponentTo, FVariableCopyFunction InCopyFunc &41;


code: FVariableCopyMapping &40; uint16 InCurrComponentFrom, uint16 InPrevComponentFrom, uint16 InCurrComponentTo, uint16 InPrevComponentTo, FVariableCopyFunction InCopyFunc &41;


className: FVariableCopyMapping

code: struct FVariableCopyMapping

CopyFunc

type: FVariableCopyFu...


code: int32 IndexOfCacheVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InVariable ) const


className: FNiagaraSimCacheDataBuffersLayout

bAllowInterpolation

type: bool

CacheBufferReadInfo

type: FCacheBufferRea...

CacheBufferWriteInfo

type: FCacheBufferWri...

LayoutName

type: FName

SimTarget

type: ENiagaraSimTarg...

Variables

type: TArray<FNiagar...


className: FNiagaraSimCacheEmitterFrame

LocalBounds

type: FBox

ParticleDataBuffers

type: FNiagaraSimCach...


code: FNiagaraSimCacheFeedbackContext()


code: FNiagaraSimCacheFeedbackContext ( bool bInAutoLogIssues )


code: ~FNiagaraSimCacheFeedbackContext()


className: FNiagaraSimCacheFeedbackContext

code: struct FNiagaraSimCacheFeedbackContext

Errors

type: TArray<FString...


className: FNiagaraSimCacheFrame

SimulationAge

type: float


className: FNiagaraSimCacheLayout


className: FNiagaraSimCacheSystemFrame


className: FNiagaraSimCacheVariable

Variable

type: FNiagaraVariabl...


className: FNiagaraSimpleClientInfo

description: Simple information on the connected client for use in continuous or immediate response UI elements.

Actors

description: List of all actors with Niagara components.

Components

description: List of all Niagara components.

Emitters

description: List of all Niagara emitters.

Systems

description: List of all system names in the scene.


className: FNiagaraSimStageData

code: struct FNiagaraSimStageData

AlternateIterationSource

type: FNiagaraDataInt...

bFirstStage

type: uint32:  1

Destination

type: FNiagaraDataBuf...

DispatchArgs

type: FNiagaraSimStag...

StageMetaData

type: constFSimulati...


className: FNiagaraSimStageDispatchArgs

code: struct FNiagaraSimStageDispatchArgs

ElementCount

description: Dispatch Element Count and optional Gpu Element Count to clip OOB threads.

IndirectBuffer

type: FRDGBuffer*...

description: Indirect dispatch buffer and the byte offset into the buffer.


className: FNiagaraSimulationStageCompilationData

bGpuDispatchForceLinear

type: bool

DirectDispatchElementType

type: ENiagaraDirectD...

DirectDispatchType

type: ENiagaraGpuDisp...

ExecuteBehavior

type: ENiagaraSimStag...

IterationSourceType

type: ENiagaraIterati...

OverrideGpuDispatchNumThreads

type: FIntVector

ParticleIterationStateRange

type: FIntPoint

StageGuid

type: FGuid


code: FNiagaraSpawnInfo ( int32 InCount, float InStartDt, float InIntervalDt, int32 InSpawnGroup )


className: FNiagaraSpawnInfo

description: Data controlling the spawning of particles

Count

description: How many particles to spawn.

InterpStartDt

description: The sub frame delta time at which to spawn the first particle.

IntervalDt

description: The sub frame delta time between each particle.

SpawnGroup

description: An integer used to identify this spawn info.


className: FNiagaraStackSection

description: Defines data for sections visible in the stack view.

Categories

type: TArray<FText>

SectionDisplayName

type: FText

SectionIdentifier

type: FName


code: bool operator== ( const [FNiagaraStatScope](API\Plugins\Niagara\FNiagaraStatScope) & Other ) const


code: FNiagaraStatScope ( [FName](API\Runtime\Core\UObject\FName) InFullName, [FName](API\Runtime\Core\UObject\FName) InFriendlyName )


code: void CopyFromSim ( uint8 * LWCData, const uint8 * SimulationData, int32 Count, int32 LWCStride, int32 SimulationStride ) const


code: template<typename DstType, typename SrcType> void CopyInternal ( uint8 * DestinationData, int32 DestStride, int32 DestOffset, const uint8 * SourceData, int32 SourceStride, int32 SourceOffset, int32 Count ) const


code: void CopyToSim ( const uint8 * LWCData, uint8 * SimulationData, int32 Count, int32 LWCStride, int32 SimulationStride ) const


code: FNiagaraStructConversionStep ( int32 InLWCBytes, int32 InLWCOffset, int32 InSimulationBytes, int32 InSimulationOffset, [ENiagaraStructConversionType](API\Plugins\Niagara\ENiagaraStructConversionType) InConversionType )


className: FNiagaraStructConversionStep

ConversionType

type: ENiagaraStructC...


description: Returns the number of channels of the current submix.

code: int32 GetNumChannels() const


description: Returns the current sample rate of the current submix.

code: float GetSampleRate() const


description: Called when a new buffer has been rendered for a given submix

code: virtual void OnNewSubmixBuffer ( const [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * OwningSubmix, float * AudioData, int32 NumSamples, int32 NumChannels, const int32 SampleRate, double AudioClock )


code: FNiagaraSubmixListener ( const [FNiagaraSubmixListener](API\Plugins\Niagara\FNiagaraSubmixListener) & Other )


description: Move submix listener.

code: FNiagaraSubmixListener ( [FNiagaraSubmixListener](API\Plugins\Niagara\FNiagaraSubmixListener) && Other )


description: Construct anFNiagaraSubmixListener

code: FNiagaraSubmixListener ( [Audio::FPatchMixer](API\Runtime\SignalProcessing\DSP\FPatchMixer) & InMixer, int32 InNumSamplesToBuffer, [Audio::FDeviceId](API\Runtime\Engine\FDeviceId) InDeviceId, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * InSoundSubmix )


code: virtual ~FNiagaraSubmixListener()


className: FNiagaraSubmixListener

description: Class used to to capture the audio stream of an arbitrary submix.

code: class FNiagaraSubmixListener : public [ISubmixBufferListener](API\Runtime\Engine\ISubmixBufferListener)


className: FCompileResultMap

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) *, [FNiagaraScriptAsyncCompileData](API\Plugins\Niagara\FNiagaraScriptAsyncCompileData) > FCompileResultMap


className: FNiagaraSystemCompiledData

DataSetCompiledData

type: FNiagaraDataSet...

InstanceParamStore

type: FNiagaraParamet...

SpawnInstanceEmitterBindings

type: TArray<FNiagar...


className: FNiagaraSystemAsyncCompileResults

CombinedCompileTime

type: float

CompilationTask

type: FNiagaraCompila...

CompileResultMap

type: FCompileResultM...

RootObjects

type: TArray<TObject...


className: FNiagaraSystemCompileMetrics

code: struct FNiagaraSystemCompileMetrics

ScriptMetrics

type: TMap<TObjectKe...


code: void AddToRenderThread ( [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * ComputeDispatchInterface )


code: void ClearTicksFromRenderThread ( [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * ComputeDispatchInterface )


code: FVector3f GetSystemLWCTile() const


code: void QueueTick ( const [FNiagaraGPUSystemTick](API\Plugins\Niagara\FNiagaraGPUSystemTick) & Tick )


code: void ReleaseTicks ( [FNiagaraGPUInstanceCountManager](API\Plugins\Niagara\FNiagaraGPUInstanceCountManager) & GPUInstanceCountManager, int32 NumTicksToRelease, bool bLastViewFamily )


code: void RemoveFromRenderThread ( [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * ComputeDispatchInterface, bool bDeleteProxy )


code: bool RequiresDistanceFieldData() const


code: bool RequiresEarlyViewData() const


code: bool RequiresRayTracingScene() const


code: bool RequiresViewUniformBuffer() const


code: FNiagaraSystemGpuComputeProxy ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * OwnerInstance )


className: FNiagaraSystemGpuComputeProxy

code: class FNiagaraSystemGpuComputeProxy


code: void Activate ( [EResetMode](API\Plugins\Niagara\FNiagaraSystemInstance\EResetMode) InResetMode )


description: Manually advances this system's simulation by the specified number of ticks and tick delta. To be advanced in this way a system must be in solo mode or moved into solo mode which will add additional overhead.

code: void AdvanceSimulation ( int32 TickCountToSimulate, float TickDeltaSeconds )


code: static bool AllocateSystemInstance ( [FNiagaraSystemInstancePtr](API\Plugins\Niagara\FNiagaraSystemInstancePtr) & OutSystemInstanceAllocation, [UWorld](API\Runtime\Engine\Engine\UWorld) & InWorld, [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) & InAsset, [FNiagaraUserRedirectionParameterStore](API\Plugins\Niagara\FNiagaraUserRedirectionParameter-) * InOverrideParameters, [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * InAttachComponent, [ENiagaraTickBehavior](API\Plugins\Niagara\ENiagaraTickBehavior) InTickBehavior, bool bInPooled )


description: Void RebindParameterCollection(UNiagaraParameterCollectionInstance* OldInstance, UNiagaraParameterCollectionInstance* NewInstance);

code: void BindParameters()


description: Calculates which tick group the instance should be in.


code: void Complete ( bool bExternalCompletion )


code: [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) * CreateEventDataSet ( [FName](API\Runtime\Core\UObject\FName) EmitterName, [FName](API\Runtime\Core\UObject\FName) EventName )


code: void Deactivate ( bool bImmediate )


code: static bool DeallocateSystemInstance ( [FNiagaraSystemInstancePtr](API\Plugins\Niagara\FNiagaraSystemInstancePtr) & SystemInstanceAllocation )


description: Dumps all of this systems info to the log.

code: void Dump() const


description: Dumps information about the instances tick to the log

code: void DumpTickInfo ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: [FNiagaraEmitterParameters](API\Plugins\Niagara\FNiagaraEmitterParameters) & EditEmitterParameters ( int32 EmitterIdx )


className: EmitterEventKey

description: Registered events for each of the emitters

code: typedef TPair< [FName](API\Runtime\Core\UObject\FName), [FName](API\Runtime\Core\UObject\FName) > EmitterEventKey


className: EResetMode

description: Defines modes for resetting the System instance.

code: enum EResetMode { ResetAll, ResetSystem, ReInit, None, }


code: void EvaluateBoundFunction ( [FName](API\Runtime\Core\UObject\FName) FunctionName, bool & UsedOnCpu, bool & UsedOnGpu ) const


className: EventDataSetMap

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [EmitterEventKey](API\Runtime\Core\Misc\TTuple), [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) * > EventDataSetMap


description: Final phase of system instance tick. Must be executed on the game thread. Returns whether the Finalize was actually done. It's possible for the finalize in a task to have already been done earlier on the GT by a WaitForAsyncAndFinalize call.

code: void FinalizeTick_GameThread ( bool bEnqueueGPUTickIfNeeded )


description: Returns the instance data for a particular interface for this System.

code: void * FindDataInterfaceInstanceData ( const [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * Interface )


code: const void * FindDataInterfaceInstanceData ( const [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * Interface ) const


code: int32 FindDataInterfaceInstanceDataIndex ( [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * Interface )


code: template<typename TDataType> const TDataType * FindTypedDataInterfaceInstanceData ( const [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * Interface ) const


code: template<typename TDataType> TDataType * FindTypedDataInterfaceInstanceData ( const [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * Interface )


description: Only call from within the script execution states. Does nothing if not capturing a frame.

code: void FinishCapture()


code: void Init &40; int32 NumEmitters &41;


className: FInstanceParameters

code: struct FInstanceParameters

ComponentTrans

type: FTransform

RequestedExecutionState

type: ENiagaraExecuti...

WorldDeltaSeconds

description: Delta time coming from the engine (not including fixed delta time, etc)


className: FOnComplete

code: typedef TBaseDelegate_OneParam< void, bool > FOnComplete


className: FOnDestroyed

code: typedef TMulticastDelegate_NoParams< void > FOnDestroyed


className: FOnInitialized

code: typedef TMulticastDelegate_NoParams< void > FOnInitialized


className: FOnPostTick

code: typedef TBaseDelegate_NoParams< void > FOnPostTick


className: FOnReset

code: typedef TMulticastDelegate_NoParams< void > FOnReset


description: Only call from within the script execution states. Value is null if not capturing a frame.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FNiagaraScriptDebuggerInfo](API\Plugins\Niagara\FNiagaraScriptDebuggerInfo), ESPMode::ThreadSafe > > * GetActiveCaptureResults()


description: Only call from within the script execution states. Value is nullptr if not capturing a frame.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FNiagaraScriptDebuggerInfo](API\Plugins\Niagara\FNiagaraScriptDebuggerInfo), ESPMode::ThreadSafe > GetActiveCaptureWrite ( const [FName](API\Runtime\Core\UObject\FName) & InHandleName, [ENiagaraScriptUsage](API\Plugins\Niagara\ENiagaraScriptUsage) InUsage, const [FGuid](API\Runtime\Core\Misc\FGuid) & InUsageId )


code: const void GetDataInterfaceInstanceDataInfo ( int32 Index, [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) *& OutInterface, void *& OutInstanceData )


code: const [FString](API\Runtime\Core\Containers\FString) & GetCrashReporterTag() const


code: [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * GetEmitterByID ( [FGuid](API\Runtime\Core\Misc\FGuid) InID )


code: TConstArrayView< [FNiagaraEmitterExecutionIndex](API\Plugins\Niagara\FNiagaraEmitterExecutionIndex) > GetEmitterExecutionOrder() const


code: FBox GetEmitterFixedBounds ( [FName](API\Runtime\Core\UObject\FName) EmitterName ) const


code: const [FNiagaraEmitterParameters](API\Plugins\Niagara\FNiagaraEmitterParameters) & GetEmitterParameters ( int32 EmitterIdx, bool PreviousFrame ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance), ESPMode::ThreadSafe > > & GetEmitters()


code: const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance), ESPMode::ThreadSafe > > & GetEmitters() const


code: [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) * GetEventDataSet ( [FName](API\Runtime\Core\UObject\FName) EmitterName, [FName](API\Runtime\Core\UObject\FName) EventName ) const


code: const [FNiagaraGlobalParameters](API\Plugins\Niagara\FNiagaraGlobalParameters) & GetGlobalParameters ( bool PreviousFrame ) const


code: const FBox & GetLocalBounds() const


description: Calculates the distance to use for distance based LODing / culling.

code: float GetLODDistance()


code: FTransform GetLWCSimToWorld ( bool bLocalSpaceEmitter ) const


code: [FNiagaraLWCConverter](API\Plugins\Niagara\FNiagaraLWCConverter) GetLWCConverter ( bool bLocalSpaceEmitter ) const


code: const FVector3f & GetLWCTile() const


code: const [FNiagaraUserRedirectionParameterStore](API\Plugins\Niagara\FNiagaraUserRedirectionParameter-) * GetOverrideParameters() const


code: const [FNiagaraOwnerParameters](API\Plugins\Niagara\FNiagaraOwnerParameters) & GetOwnerParameters ( bool PreviousFrame ) const


code: [UNiagaraParameterCollectionInstance](API\Plugins\Niagara\UNiagaraParameterCollectionInsta-) * GetParameterCollectionInstance ( [UNiagaraParameterCollection](API\Plugins\Niagara\UNiagaraParameterCollection) * Collection )


code: uint32 GetParameterIndex ( bool PreviousFrame ) const


code: const [FNiagaraPerInstanceDIFuncInfo](API\Plugins\Niagara\FNiagaraPerInstanceDIFuncInfo) & GetPerInstanceDIFunction ( [ENiagaraSystemSimulationScript](API\Plugins\Niagara\ENiagaraSystemSimulationScript) ScriptType, int32 FuncIndex ) const


code: int32 GetRandomSeedOffset() const


code: [UActorComponent](API\Runtime\Engine\Components\UActorComponent) * GetPrereqComponent() const


description: Gets the simulation for the supplied emitter handle.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance), ESPMode::ThreadSafe > GetSimulationForHandle ( const [FNiagaraEmitterHandle](API\Plugins\Niagara\FNiagaraEmitterHandle) & EmitterHandle )


code: [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * GetSystem() const


code: [FNDIStageTickHandler](API\Plugins\Niagara\FNDIStageTickHandler) * GetSystemDIStageTickHandler ( [ENiagaraScriptUsage](API\Plugins\Niagara\ENiagaraScriptUsage) Usage )


code: FBox GetSystemFixedBounds() const


code: int32 GetSystemInstanceIndex() const


code: const [FNiagaraSystemParameters](API\Plugins\Niagara\FNiagaraSystemParameters) & GetSystemParameters ( bool PreviousFrame ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNiagaraSystemSimulation](API\Plugins\Niagara\FNiagaraSystemSimulation), ESPMode::ThreadSafe > GetSystemSimulation() const


description: Get the current tick behavior


code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld() const


code: [FNiagaraWorldManager](API\Plugins\Niagara\FNiagaraWorldManager) * GetWorldManager() const


description: Gets the current world transform of the system

code: const FTransform & GetWorldTransform() const


description: Handles completion of the system and returns true if the system is complete.

code: bool HandleCompletion()


description: Void SetHasGPUEmitters(bool bInHasGPUEmitters) { bHasGPUEmitters = bInHasGPUEmitters; }

code: bool HasGPUEmitters()


description: Initializes this System instance to simulate the supplied System.

code: void Init ( bool bInForceSolo )


code: void InitGPUTick ( [FNiagaraGPUSystemTick](API\Plugins\Niagara\FNiagaraGPUSystemTick) & OutTick )


description: Int32 GetNumParticles(int32 EmitterIndex) const { return ParameterNumParticleBindings[EmitterIndex].GetValue(); } float GetSpawnCountScale(int32 EmitterIndex) const { return ParameterSpawnCountScaleBindings[EmitterIndex].GetValue(); }

code: bool IsComplete() const


code: void ManualTick ( float DeltaSeconds, const FGraphEventRef & MyCompletionGraphEvent )


description: Gets a multicast delegate which is called whenever this instance is initialized with an System asset.


code: void OnPooledReuse ( [UWorld](API\Runtime\Engine\Engine\UWorld) & NewWorld )


description: Gets a multicast delegate which is called whenever this instance is reset due to external changes in the source System asset.


className: ParameterBufferCount

code: static constexpr int32 ParameterBufferCount = 2;


description: Poll for previous frame capture requests. Once queried and bool is returned, the results are cleared from this system instance.

code: bool QueryCaptureResults ( const [FGuid](API\Runtime\Core\Misc\FGuid) & RequestId, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FNiagaraScriptDebuggerInfo](API\Plugins\Niagara\FNiagaraScriptDebuggerInfo), ESPMode::ThreadSafe >> & OutCaptureResults )


description: Request that this simulation capture a frame. Cannot capture if disabled or already completed.

code: bool RequestCapture ( const [FGuid](API\Runtime\Core\Misc\FGuid) & RequestId )


code: bool RequiresDistanceFieldData() const


code: bool RequiresEarlyViewData() const


code: bool RequiresRayTracingScene() const


code: bool RequiresViewUniformBuffer() const


description: Requests the the simulation be reset on the next tick.

code: void Reset ( [EResetMode](API\Plugins\Niagara\FNiagaraSystemInstance\EResetMode) Mode )


code: void SetActualExecutionState ( [ENiagaraExecutionState](API\Plugins\Niagara\ENiagaraExecutionState) InState )


code: void SetEmitterEnable ( [FName](API\Runtime\Core\UObject\FName) EmitterName, bool bNewEnableState )


code: void SetEmitterFixedBounds ( [FName](API\Runtime\Core\UObject\FName) EmitterName, const FBox & InLocalBounds )


code: void SetForceSolo ( bool bForceSolo )


code: void SetGpuComputeDebug ( bool bEnableDebug )


code: void SetLastRenderTime ( float TimeSeconds )


code: void SetLODDistance ( float InLODDistance, float InMaxLODDistance, bool bOverride )


description: Gets a multicast delegate which is called whenever this instance is complete.

code: void SetOnComplete ( const [FOnComplete](API\Plugins\Niagara\FNiagaraSystemInstance\FOnComplete) & InOnCompleteDelegate )


description: Gets a multicast delegate which is called after this instance has finished ticking for the frame on the game thread

code: void SetOnPostTick ( const [FOnPostTick](API\Plugins\Niagara\FNiagaraSystemInstance\FOnPostTick) & InPostTickDelegate )


code: void SetPaused ( bool bInPaused )


code: void SetPendingFinalize ( [FNiagaraSystemInstanceFinalizeRef](API\Plugins\Niagara\FNiagaraSystemInstanceFinalizeRe-) InFinalizeRef )


code: void SetRandomSeedOffset ( int32 Offset )


code: void SetRequestedExecutionState ( [ENiagaraExecutionState](API\Plugins\Niagara\ENiagaraExecutionState) InState )


code: void SetSystemFixedBounds ( const FBox & InLocalBounds )


description: The significant index for this component. i.e. this is the Nth most significant instance of it's system in the scene. Passed to the script to allow us to scale down internally for less significant systems instances.

code: void SetSystemSignificanceIndex ( int32 InIndex )


description: Set a new tick behavior, this will not move the instance straight away and will wait until the next time it is evaluated

code: void SetTickBehavior ( [ENiagaraTickBehavior](API\Plugins\Niagara\ENiagaraTickBehavior) NewTickBehavior )


code: void SetWarmupSettings ( int32 WarmupTickCount, float WarmupTickDelta )


description: Sets the world transform

code: void SetWorldTransform ( const FTransform & InTransform )


description: Only call from within the script execution states. Value is false if not capturing a frame.

code: bool ShouldCaptureThisFrame() const


description: Concurrent work for SimCache tick

code: void SimCacheTick_Concurrent ( [UNiagaraSimCache](API\Plugins\Niagara\UNiagaraSimCache) * SimCache )


description: Ticks the system using the a SimCache.

code: void SimCacheTick_GameThread ( [UNiagaraSimCache](API\Plugins\Niagara\UNiagaraSimCache) * SimCache, float DesiredAge, float DeltaSeconds, const FGraphEventRef & MyCompletionGraphEvent )


description: Perform per-tick updates on data interfaces that need it. This can cause systems to complete so cannot be parallelized.

code: void TickDataInterfaces ( float DeltaSeconds, bool bPostSimulate )


code: void TickInstanceParameters_GameThread ( float DeltaSeconds )


description: Secondary phase of the system instance tick that can be executed on any thread.

code: void Tick_Concurrent ( bool bEnqueueGPUTickIfNeeded )


description: Initial phase of system instance tick. Must be executed on the game thread.

code: void Tick_GameThread ( float DeltaSeconds )


code: void UnbindParameters ( bool bFromComplete )


code: bool UsesCollection ( const [UNiagaraParameterCollection](API\Plugins\Niagara\UNiagaraParameterCollection) * Collection ) const


description: Wait for any pending concurrent work to complete, must be called on the GameThread. The instance will be finalized if pending, this can complete the instance and remove it from the system simulation.

code: void WaitForConcurrentTickAndFinalize ( bool bEnsureComplete )


description: Wait for any pending concurrent work to complete, must be called on the GameThread. This will NOT call finalize on the instance so can leave a dangling finalize task.

code: void WaitForConcurrentTickDoNotFinalize ( bool bEnsureComplete )


description: Creates a new Niagara system instance.

code: FNiagaraSystemInstance ( [UWorld](API\Runtime\Engine\Engine\UWorld) & InWorld, [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) & InAsset, [FNiagaraUserRedirectionParameterStore](API\Plugins\Niagara\FNiagaraUserRedirectionParameter-) * InOverrideParameters, [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * InAttachComponent, [ENiagaraTickBehavior](API\Plugins\Niagara\ENiagaraTickBehavior) InTickBehavior, bool bInPooled )


description: Cleanup

code: virtual ~FNiagaraSystemInstance()


className: FNiagaraSystemInstance

code: class FNiagaraSystemInstance

GatheredInstanceParameters

type: FInstanceParame...

GPUDataInterfaces

type: TArray< TPair< ...

GPUParamIncludeInterpolation

type: bool

SystemInstanceState

type: ENiagaraSystemI...

TotalGPUParamSize

description: Transient data that is accumulated during tick.


className: FNiagaraSystemInstanceControllerPtr


code: template<typename... ArgTypes> auto Activate ( ArgTypes... Args )


code: template<typename... ArgTypes> auto AdvanceSimulation ( ArgTypes... Args )


code: template<typename... ArgTypes> void AdvanceSimulation_Deferred ( ArgTypes... Args )


code: template<typename... ArgTypes> auto CalculateTickGroup ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto ClearLODDistance ( ArgTypes... Args )


description: Render data operations.

code: [FNiagaraSystemRenderData](API\Plugins\Niagara\FNiagaraSystemRenderData) * CreateSystemRenderData ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel ) const


code: template<typename... ArgTypes> auto Deactivate ( ArgTypes... Args )


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

code: void DebugDump ( bool bFullDump )


className: FOnMaterialsUpdated

code: typedef TBaseDelegate_NoParams< void > FOnMaterialsUpdated


code: void GenerateSetDynamicDataCommands ( [FNiagaraSystemRenderData::FSetDynamicDataCommandList](API\Plugins\Niagara\FNiagaraSystemRenderData\FSetDynamicDataCommandList) & Commands, [FNiagaraSystemRenderData](API\Plugins\Niagara\FNiagaraSystemRenderData) & RenderData, const [FNiagaraSceneProxy](API\Plugins\Niagara\FNiagaraSceneProxy) & SceneProxy )


code: template<typename... ArgTypes> auto GetActualExecutionState ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto GetAge ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto GetAreDataInterfacesInitialized ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto GetAttachComponent ( ArgTypes... Args )


code: template<typename... ArgTypes> auto GetComputeDispatchInterface ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto GetEmitterFixedBounds ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto GetLocalBounds ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto GetLODDistance ( ArgTypes... Args ) const


code: [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetMaterialOverride ( const [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties) * InProps, int32 InMaterialSubIndex ) const


code: bool GetParticleValueVec3_DebugOnly ( [TArray](API\Runtime\Core\Containers\TArray)< FVector > & OutValues, [FName](API\Runtime\Core\UObject\FName) EmitterName, [FName](API\Runtime\Core\UObject\FName) ValueName ) const


code: bool GetParticleValues_DebugOnly ( [TArray](API\Runtime\Core\Containers\TArray)< float > & OutValues, [FName](API\Runtime\Core\UObject\FName) EmitterName, [FName](API\Runtime\Core\UObject\FName) ValueName ) const


code: template<typename... ArgTypes> auto GetRequestedExecutionState ( ArgTypes... Args ) const


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

code: [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * GetSoloSystemInstance() const


code: void GetStreamingMeshInfo ( const FBoxSphereBounds & OwnerBounds, [FStreamingTextureLevelContext](API\Runtime\Engine\Engine\FStreamingTextureLevelContext) & LevelContext, [TArray](API\Runtime\Core\Containers\TArray)< [FStreamingRenderAssetPrimitiveInfo](API\Runtime\Engine\Engine\FStreamingRenderAssetPrimitiveIn-) > & OutStreamingRenderAssets ) const


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

code: template<typename... ArgTypes> auto GetSystem ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto GetSystemFixedBounds ( ArgTypes... Args ) const


description: These methods are deprecated, as they expose internals that may be concurrently accessed.

code: [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * GetSystemInstance_Unsafe() const


code: template<typename... ArgTypes> auto GetTickBehavior ( ArgTypes... Args )


code: void GetUsedMaterials ( [TArray](API\Runtime\Core\Containers\TArray)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * > & OutMaterials )


code: template<typename... ArgTypes> auto HandleNeedsUIResync ( ArgTypes... Args )


description: Initializes the controller with an instance of the provided system

code: void Initialize ( [UWorld](API\Runtime\Engine\Engine\UWorld) & World, [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) & System, [FNiagaraUserRedirectionParameterStore](API\Plugins\Niagara\FNiagaraUserRedirectionParameter-) * OverrideParameters, [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * AttachComponent, [ENiagaraTickBehavior](API\Plugins\Niagara\ENiagaraTickBehavior) TickBehavior, bool bPooled, int32 RandomSeedOffset, bool bForceSolo, int32 WarmupTickCount, float WarmupTickDelta )


code: template<typename... ArgTypes> auto IsComplete ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto IsPaused ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto IsPendingSpawn ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto IsSolo ( ArgTypes... Args ) const


code: template<typename... ArgTypes> auto ManualTick ( ArgTypes... Args )


code: void NotifyRenderersComplete ( [FNiagaraSystemRenderData](API\Plugins\Niagara\FNiagaraSystemRenderData) & RenderData )


code: void OnPooledReuse ( [UWorld](API\Runtime\Engine\Engine\UWorld) & NewWorld )


code: template<typename... ArgTypes> auto OnSimulationDestroyed ( ArgTypes... Args )


code: void PostTickRenderers ( [FNiagaraSystemRenderData](API\Plugins\Niagara\FNiagaraSystemRenderData) & RenderData )


description: Deactivates the underlying system and queues it up for destruction. After calling, this interface is unusable unless you call Initialize again

code: void Release()


code: template<typename... ArgTypes> auto Reset ( ArgTypes... Args )


description: Deferred methods - With NIAGARA_SYSTEM_INSTANCE_CONTROLLER_ASYNC, these are executed in a deferred queue.

code: template<typename... ArgTypes> void Reset_Deferred ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetEmitterEnable ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetEmitterFixedBounds ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetForceSolo ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetGpuComputeDebug ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetLastRenderTime ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetLODDistance ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetOnComplete ( ArgTypes... Args )


code: void SetOnMaterialsUpdated ( const [FOnMaterialsUpdated](API\Plugins\Niagara\FNiagaraSystemInstanceController\FOnMaterialsUpdated) & Delegate )


code: template<typename... ArgTypes> auto SetOnPostTick ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetPaused ( ArgTypes... Args )


code: template<typename... ArgTypes> void SetPaused_Deferred ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetRandomSeedOffset ( ArgTypes... Args )


code: template<typename... ArgTypes> void SetRequestedExecutionState_Deferred ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetSystemFixedBounds ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetSystemSignificanceIndex ( ArgTypes... Args )


code: template<typename... ArgTypes> auto SetTickBehavior ( ArgTypes... Args )


code: template<typename... ArgTypes> void SetVariable_Deferred ( ArgTypes... Args )


code: template<typename... ArgTypes> auto WaitForConcurrentTickAndFinalize ( ArgTypes... Args )


code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FNiagaraSystemInstanceController](API\Plugins\Niagara\FNiagaraSystemInstanceController), ESPMode::ThreadSafe > FNiagaraSystemInstanceControllerConstPtr


code: template<typename... ArgTypes> auto SimCacheTick_GameThread ( ArgTypes... Args )


code: FNiagaraSystemInstanceController()


code: FNiagaraSystemInstanceController ( const [FNiagaraSystemInstanceController](API\Plugins\Niagara\FNiagaraSystemInstanceController) & )


code: ~FNiagaraSystemInstanceController()


className: FNiagaraSystemInstanceController

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

code: class FNiagaraSystemInstanceController : public [TSharedFromThis< FNiagaraSystemInstanceController, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis), private [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject)


code: void SetDebugCounter ( std::atomic< int > * InDebugCounter )


code: FNiagaraSystemInstanceFinalizeRef()


code: FNiagaraSystemInstanceFinalizeRef ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) ** InTaskEntry )


className: FNiagaraSystemInstanceFinalizeRef


className: FNiagaraSystemInstancePtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance), ESPMode::ThreadSafe > FNiagaraSystemInstancePtr


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetVariables()


className: FNiagaraSystemParameters

description: Any change to this structure, or it's GetVariables implementation will require a bump in the CustomNiagaraVersion so that we properly rebuild the scripts You must pad this struct and the results ofGetVariables()to a 16 byte boundary.

code: struct FNiagaraSystemParameters


description: Called from the render thread to give renderers an opportunity to create resources needed for rendering.

code: void CreateRenderThreadResources()


description: Gives the system's renderers an opportunity to free resources

code: void DestroyRenderState_Concurrent()


description: This must be called on the RenderThread before destruction to properly clean up resources without data race issues (i.e. from a scene proxy's destructor)

code: void Destroy_RenderThread()


code: static void ExecuteDynamicDataCommands_RenderThread ( const [FSetDynamicDataCommandList](API\Plugins\Niagara\FNiagaraSystemRenderData\FSetDynamicDataCommandList) & Commands )


className: FMaterialOverride

code: struct FMaterialOverride

EmitterRendererProperty

type: constUNiagaraR...

Material

type: TObjectPtr<UMa...


code: FSetDynamicDataCommand &40; FNiagaraRenderer &42; InRenderer, FNiagaraDynamicDataBase &42; InDynamicData &41;


className: FSetDynamicDataCommand

code: struct FSetDynamicDataCommand

DynamicData

type: FNiagaraDynamic...

Renderer

type: FNiagaraRendere...


className: FSetDynamicDataCommandList

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FSetDynamicDataCommand](API\Plugins\Niagara\FNiagaraSystemRenderData\FSetDynamicDataCommand), TInlineAllocator< 8 >> FSetDynamicDataCommandList


code: void GatherSimpleLights ( [FSimpleLightArray](API\Runtime\Engine\FSimpleLightArray) & OutParticleLights ) const


description: Called at the end of the frame, before rendering when necessary to provide renderers with render thread data

code: void GenerateSetDynamicDataCommands ( [FSetDynamicDataCommandList](API\Plugins\Niagara\FNiagaraSystemRenderData\FSetDynamicDataCommandList) & Commands, const [FNiagaraSceneProxy](API\Plugins\Niagara\FNiagaraSceneProxy) & SceneProxy, const [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * SystemInstance, TConstArrayView< [FMaterialOverride](API\Plugins\Niagara\FNiagaraSystemRenderData\FMaterialOverride) > MaterialOverrides )


description: Gets the dynamic mesh elements from all renderers

code: void GetDynamicMeshElements ( const [TArray](API\Runtime\Core\Containers\TArray)< const [FSceneView](API\Runtime\Engine\FSceneView) * > & Views, const [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & ViewFamily, uint32 VisibilityMap, [FMeshElementCollector](API\Runtime\Engine\FMeshElementCollector) & Collector, const [FNiagaraSceneProxy](API\Plugins\Niagara\FNiagaraSceneProxy) & SceneProxy )


description: Gets the total size of dynamic data allocated

code: uint32 GetDynamicDataSize() const


description: Gets the relevance of this NiagaraSystem for this view

code: [FPrimitiveViewRelevance](API\Runtime\Engine\FPrimitiveViewRelevance) GetViewRelevance ( const [FSceneView](API\Runtime\Engine\FSceneView) & View, const [FNiagaraSceneProxy](API\Plugins\Niagara\FNiagaraSceneProxy) & SceneProxy ) const


code: bool HasAnyMotionBlurEnabled() const


code: void OnSystemComplete ( const [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) & SystemInstance )


code: void PostTickRenderers ( const [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) & SystemInstance )


code: void RecacheRenderers ( const [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) & SystemInstance, const [FNiagaraSystemInstanceController](API\Plugins\Niagara\FNiagaraSystemInstanceController) & Controller )


description: Called from the render thread to give renderers an opportunity to release their resources.

code: void ReleaseRenderThreadResources()


code: void SetRenderingEnabled ( bool bInEnabled )


code: FNiagaraSystemRenderData ( const [FNiagaraSystemRenderData](API\Plugins\Niagara\FNiagaraSystemRenderData) & )


code: FNiagaraSystemRenderData ( const [FNiagaraSystemInstanceController](API\Plugins\Niagara\FNiagaraSystemInstanceController) & SystemInstanceController, const [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) & SystemInstance, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel )


className: FNiagaraSystemRenderData

description: This class wraps all data and functionality needed by a scene render proxy to render a single Niagara System Instance.

code: class FNiagaraSystemRenderData


code: FNiagaraSystemScalabilityOverride()


className: FNiagaraSystemScalabilityOverride

bOverrideCullProxySettings

type: uint32:  1

description: Controls whether we override the cull proxy settings.

bOverrideDistanceSettings

description: Controls whether we override the distance culling settings.

bOverrideGlobalBudgetScalingSettings

description: Controls whether we override the global budget scaling settings.

bOverrideInstanceCountSettings

description: Controls whether we override the instance count culling settings.

bOverridePerSystemInstanceCountSettings

description: Controls whether we override the per system instance count culling settings.

bOverrideVisibilitySettings

description: Controls whether we override the visibility culling settings.


code: FNiagaraSystemScalabilityOverrides()


code: ~FNiagaraSystemScalabilityOverrides()


className: FNiagaraSystemScalabilityOverrides

description: Container struct for an array of system scalability overrides. Enables details customization and data validation.

Overrides

type: TArray<FNiagar...


code: FNiagaraSystemScalabilitySettings()


className: FNiagaraSystemScalabilitySettings

description: Scalability settings for Niagara Systems for a particular platform set (unless overridden).

bCullByDistance

description: Controls whether distance culling is enabled.

bCullMaxInstanceCount

description: Controls whether we should cull systems based on how many instances with the same Effect Type are active.

bCullPerSystemMaxInstanceCount

description: Controls whether we should cull systems based on how many instances of the system are active.

BudgetScaling

type: FNiagaraGlobalB...

description: Settings related to scaling down FX based on the current budget usage.

CullProxyMode

type: ENiagaraCullPro...

description: Controls what, if any, proxy will be used in place of culled systems.

MaxDistance

type: float

description: Effects of this type are culled beyond this distance.

MaxInstances

description: Effects of this type will be culled when total active instances using this same EffectType exceeds this number.

MaxSystemInstances

description: Effects of this type will be culled when total active instances of the same NiagaraSystem exceeds this number.

MaxSystemProxies

description: Limit on the number of proxies that can be used at once per system.

Platforms

type: FNiagaraPlatfor...

description: The platforms on which these settings are active (unless overridden).

VisibilityCulling

type: FNiagaraSystemV...

description: Settings controlling how systems are culled by visibility.


className: FNiagaraSystemScalabilitySettingsArray

description: Container struct for an array of system scalability settings. Enables details customization and data validation.


description: Unused. These are only useful in the new SystemScript context.

code: virtual void BindSystemInstances ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * > & InSystemInstances )


code: virtual bool Execute ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, float DeltaSeconds, uint32 NumInstances, const [FScriptExecutionConstantBufferTable](API\Plugins\Niagara\FScriptExecutionConstantBufferTa-) & ConstantBufferTable )


className: FExternalFuncInfo

code: struct FExternalFuncInfo

Function

type: FVMExternalFunc...


description: Generates a table of DI calls unique to the passed system instance. These are then accesss inside the PerInstanceFunctionHook.

code: virtual bool GeneratePerInstanceDIFunctionTable ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Inst, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraPerInstanceDIFuncInfo](API\Plugins\Niagara\FNiagaraPerInstanceDIFuncInfo) > & OutFunctions )


code: virtual bool Init ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * InScript, [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) InTarget )


code: virtual bool Tick ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) SimTarget )


code: FNiagaraSystemScriptExecutionContext ( [ENiagaraSystemSimulationScript](API\Plugins\Niagara\ENiagaraSystemSimulationScript) InScriptType )


className: FNiagaraSystemScriptExecutionContext

description: Specialized exec context for system scripts. Allows us to better handle the added complication of Data Interfaces across different system instances.

code: struct FNiagaraSystemScriptExecutionContext : public [FNiagaraScriptExecutionContextBase](API\Plugins\Niagara\FNiagaraScriptExecutionContextBa-)

ExtFunctionInfo

type: TArray<FExtern...

SystemInstances

description: Array of system instances the context is currently operating on.


className: FNiagaraSystemSimCacheCaptureReply

description: Message sent from a debugger client to a connected debugger containing the results of a sim cache capture.

ComponentName

type: FName

description: Name of the captured component.

SimCacheData

type: TArray< uint8 >


className: FNiagaraSystemSimCacheCaptureRequest

description: Message sent from the debugger to a client to request a sim cache capture for a particular component.

CaptureDelayFrames

description: How many frames to delay capture.

CaptureFrames

description: How many frames to capture.

ComponentName

description: Name of the component we're going to capture.


code: void AddInstance ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance )


code: void AddSystemToTickBatch ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, [FNiagaraSystemSimulationTickContext](API\Plugins\Niagara\FNiagaraSystemSimulationTickCont-) & Context )


code: void AddTickGroupPromotion ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance )


code: void AddToInstanceList ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, [ENiagaraSystemInstanceState](API\Plugins\Niagara\ENiagaraSystemInstanceState) InstanceState )


description: Builds the constant buffer table for a given script execution

code: void BuildConstantBufferTable ( const [FNiagaraGlobalParameters](API\Plugins\Niagara\FNiagaraGlobalParameters) & GlobalParameters, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FNiagaraScriptExecutionContextBase](API\Plugins\Niagara\FNiagaraScriptExecutionContextBa-) > & ExecContext, [FScriptExecutionConstantBufferTable](API\Plugins\Niagara\FScriptExecutionConstantBufferTa-) & ConstantBufferTable ) const


className: bUseLegacyExecContexts

code: static bool bUseLegacyExecContexts;


code: void DumpInstance ( const [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Inst ) const


description: Dump information about all instances tick

code: void DumpTickInfo ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: void FlushTickBatch ( [FNiagaraSystemSimulationTickContext](API\Plugins\Niagara\FNiagaraSystemSimulationTickCont-) & Context )


code: const [FString](API\Runtime\Core\Containers\FString) & GetCrashReporterTag() const


code: [UNiagaraParameterCollectionInstance](API\Plugins\Niagara\UNiagaraParameterCollectionInsta-) * GetParameterCollectionInstance ( [UNiagaraParameterCollection](API\Plugins\Niagara\UNiagaraParameterCollection) * Collection )


code: [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * GetSystem() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * > & GetSystemInstances ( [ENiagaraSystemInstanceState](API\Plugins\Niagara\ENiagaraSystemInstanceState) State )


code: ETickingGroup GetTickGroup() const


code: const [FNiagaraTickInfo](API\Plugins\Niagara\FNiagaraTickInfo) & GetTickInfo()


code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld() const


code: bool Init ( [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * InSystem, [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, bool bInIsSolo, ETickingGroup TickGroup )


code: void InitParameterDataSetBindings ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * SystemInst )


code: void PauseInstance ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance )


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

code: void PrepareForSystemSimulate ( [FNiagaraSystemSimulationTickContext](API\Plugins\Niagara\FNiagaraSystemSimulationTickCont-) & Context )


code: void RemoveInstance ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance )


code: void RemoveFromInstanceList ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance )


code: void SetInstanceState ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance, [ENiagaraSystemInstanceState](API\Plugins\Niagara\ENiagaraSystemInstanceState) NewState )


description: Sets constant parameter values

code: void SetupParameters_GameThread ( float DeltaSeconds )


description: Called after the sim cache has been read.

code: void SimCachePostTick_Concurrent ( float DeltaSeconds, const FGraphEventRef & MyCompletionGraphEvent )


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

code: void Spawn_GameThread ( float DeltaSeconds, bool bPostActorTick )


description: Spawn any pending instances

code: void Spawn_Concurrent ( [FNiagaraSystemSimulationTickContext](API\Plugins\Niagara\FNiagaraSystemSimulationTickCont-) & Context )


description: Second phase of system sim tick that can run on any thread.

code: void Tick_Concurrent ( [FNiagaraSystemSimulationTickContext](API\Plugins\Niagara\FNiagaraSystemSimulationTickCont-) & Context )


description: First phase of system sim tick. Must run on GameThread.

code: void Tick_GameThread ( float DeltaSeconds, const FGraphEventRef & MyCompletionGraphEvent )


code: void Tick_GameThread_Internal ( float DeltaSeconds, const FGraphEventRef & MyCompletionGraphEvent )


description: Transfers a system instance from the current simulation into this one.

code: void TransferInstance ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * SystemInst )


description: Runs the system spawn script for new system instances.

code: void SpawnSystemInstances ( [FNiagaraSystemSimulationTickContext](API\Plugins\Niagara\FNiagaraSystemSimulationTickCont-) & Context )


code: void UnpauseInstance ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * Instance )


description: Transfers the results of the system simulation into the emitter instances.

code: void TransferSystemSimResults ( [FNiagaraSystemSimulationTickContext](API\Plugins\Niagara\FNiagaraSystemSimulationTickCont-) & Context )


description: Update TickGroups for pending instances and execute tick group promotions.

code: void UpdateTickGroups_GameThread()


description: Wait for system simulation concurrent tick to complete. If bEnsureComplete is true we will trigger an ensure if it is not complete.

code: void WaitForConcurrentTickComplete ( bool bEnsureComplete )


description: Wait for system instances concurrent tick to complete. If bEnsureComplete is true we will trigger an ensure if it is not complete.

code: void WaitForInstancesTickComplete ( bool bEnsureComplete )


className: FNiagaraSystemSimulation

description: Simulation performing all system and emitter scripts for a instances of aUNiagaraSystemin a world.

code: class FNiagaraSystemSimulation : public [TSharedFromThis< FNiagaraSystemSimulation, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

AllWorkCompleteGraphEvent

type: FGraphEventRef

description: Event to track all work is complete, i.e. System Concurrent, Instance Concurrent, Finalize

ConcurrentTickGraphEvent

description: Event to track the system simulation async tick is complete.

CrashReporterTag

type: FString

DataSetToEmitterEventParameters

type: TArray<TArray<...

description: Binding to push system attributes into each emitter event parameters.

DataSetToEmitterGPUParameters

description: Binding to push system attributes into each emitter gpu parameters.

DataSetToEmitterRendererParameters

description: Binding to push system attributes into each emitter renderer parameters.

DataSetToEmitterSpawnParameters

description: Binding to push system attributes into each emitter spawn parameters.

DataSetToEmitterUpdateParameters

description: Binding to push system attributes into each emitter update parameters.

DispatchInterface

type: FNiagaraGpuComp...

EffectType

type: TWeakObjectPtr<...

description: We cache off the effect type in the unlikely even that someone GCs the System from under us so that we can keep the effect types instance count etc accurate.

MainDataSet

type: FNiagaraDataSet

description: Data set for the Running instance state.

MaxDeltaTime

type: TOptional< floa...

PausedDataSet

description: Data set for the Paused instance state.

PendingTickGroupPromotions

description: List of instances that are pending a tick group promotion.

SpawnExecContext

type: TUniquePtr<FNi...

SpawnGlobalSpawnCountScaleParam

type: FNiagaraParamet...

SpawningDataSet

description: Data set for the Spawning instance state.

SpawnInstanceParameterDataSet

description: As there's a 1 to 1 relationship between system instance and their execution in this simulation we must pull all that instances parameters into a dataset for simulation.

SpawnInstanceParameterToDataSetBinding

description: Bindings that pull per component parameters into the spawn parameter dataset.

SpawnNumSystemInstancesParam

description: Direct bindings for Engine variables in System Spawn and Update scripts.

System

type: UNiagaraSystem...

description: System of instances being simulated.

SystemInstancesPerState

description: System instance per state.

SystemTickGroup

type: ETickingGroup

description: Which tick group we are in, only valid when not in Solo mode.

TickBatch

type: FNiagaraSystemT...

description: Current tick batch we're filling ready for processing, potentially in an async task.

TickInfo

type: FNiagaraTickInf...

UpdateInstanceParameterToDataSetBinding

description: Bindings that pull per component parameters into the update parameter dataset.

World

type: UWorld*

description: World this system simulation belongs to.


className: FNiagaraSystemSimulationPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNiagaraSystemSimulation](API\Plugins\Niagara\FNiagaraSystemSimulation), ESPMode::ThreadSafe > FNiagaraSystemSimulationPtr


className: FNiagaraSystemSimulationRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FNiagaraSystemSimulation](API\Plugins\Niagara\FNiagaraSystemSimulation), ESPMode::ThreadSafe > FNiagaraSystemSimulationRef


description: Runs the system update script.

code: void UpdateSystemInstances ( [FNiagaraSystemSimulationTickContext](API\Plugins\Niagara\FNiagaraSystemSimulationTickCont-) & Context )


code: FNiagaraSystemSimulationTickContext ( class [FNiagaraSystemSimulation](API\Plugins\Niagara\FNiagaraSystemSimulation) * InOwner, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * > & InInstances, [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & InDataSet, float InDeltaSeconds, int32 InSpawnNum, bool bAllowAsync )


className: FNiagaraSystemSimulationTickContext

BeforeInstancesTickGraphEvents

type: FGraphEventArra...

bRunningAsync

type: bool

DataSet

type: FNiagaraDataSet...

DeltaSeconds

type: float

EffectsQuality

type: int

Instances

type: TArray<FNiagar...

Owner

type: FNiagaraSystemS...


description: Adds float data for Cpu access, returns the index into the buffer in elements.

code: uint32 AddCpuData ( TConstArrayView< float > InFloatData )


description: Called to finalize the data (done on load by the system)

code: void Finalize()


description: Get float buffer for Cpu Access.

code: TConstArrayView< float > GetCpuFloatBuffer() const


description: Get float buffer for Gpu Access.

code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetGpuFloatBuffer() const


code: [FNiagaraSystemStaticBuffers](API\Plugins\Niagara\FNiagaraSystemStaticBuffers) & operator= ( const [FNiagaraSystemStaticBuffers](API\Plugins\Niagara\FNiagaraSystemStaticBuffers) & )


code: [FNiagaraSystemStaticBuffers](API\Plugins\Niagara\FNiagaraSystemStaticBuffers) & operator= ( [FNiagaraSystemStaticBuffers](API\Plugins\Niagara\FNiagaraSystemStaticBuffers) && )


code: FNiagaraSystemStaticBuffers ( const [FNiagaraSystemStaticBuffers](API\Plugins\Niagara\FNiagaraSystemStaticBuffers) & )


code: FNiagaraSystemStaticBuffers ( [FNiagaraSystemStaticBuffers](API\Plugins\Niagara\FNiagaraSystemStaticBuffers) && )


description: Adds float data for Gpu access, returns the index into the buffer in elements.

code: uint32 AddGpuData ( TConstArrayView< float > InFloatData )


className: FNiagaraSystemStaticBuffers

description: Static buffers shared between all instances built once on load.

code: struct FNiagaraSystemStaticBuffers


className: FNiagaraSystemTickBatch

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) *, TInlineAllocator< 4 > > FNiagaraSystemTickBatch


code: void Add ( const [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * System, bool bReInit )


code: void Add ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & Emitter, bool bReInit )


code: void Add ( const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * Script, bool bReInit )


code: void Add ( const [UNiagaraParameterCollection](API\Plugins\Niagara\UNiagaraParameterCollection) * Collection, bool bReInit )


description: Adds all currently active systems.

code: void AddAll ( bool bReInit )


code: void AddSoloComponent ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * Component, bool bReInit )


description: Handles any pending reinits or resets of system instances in this update context.

code: void CommitUpdate()


className: FCustomWorkDelegate

code: typedef TBaseDelegate_OneParam< void, [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * > FCustomWorkDelegate


code: void SetDestroyOnAdd ( bool bInDestroyOnAdd )


code: void SetOnlyActive ( bool bInOnlyActive )


code: void SetDestroySystemSim ( bool bInDestroySystemSim )


code: FNiagaraSystemUpdateContext ( [FNiagaraSystemUpdateContext](API\Plugins\Niagara\FNiagaraSystemUpdateContext) & Other )


code: FNiagaraSystemUpdateContext ( const [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * System, bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )


code: FNiagaraSystemUpdateContext ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & Emitter, bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )


code: FNiagaraSystemUpdateContext ( const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * Script, bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )


code: FNiagaraSystemUpdateContext ( const [UNiagaraParameterCollection](API\Plugins\Niagara\UNiagaraParameterCollection) * Collection, bool bReInit, bool bInDestroyOnAdd, bool bInOnlyActive, bool bInDestroySystemSim )


className: FNiagaraSystemUpdateContext

description: Helper for reseting/reinitializing Niagara systems currently active when they are being edited. Can be used inside a scope with Systems being reinitialized on destruction or you can store the context and useCommitUpdate()to trigger reinitialization. For example, this can be split between PreEditChange and PostEditChange to ensure problematic data is not modified during execution of a system.


className: FNiagaraSystemVisibilityCullingSettings

description: Scalability settings for Niagara Systems for a particular platform set (unless overridden).

bAllowPreCullingByViewFrustum

type: uint32:  1

description: If true and bCullByViewFrustum is enabled, we allow view frustum checks in pre-culling.

bCullByViewFrustum

description: Controls whether view frustum culling is enabled.

bCullWhenNotRendered

description: Controls whether we cull when not rendered.

MaxTimeOutsideViewFrustum

description: Effects will be culled if they go longer than this time outside the view frustum.

MaxTimeWithoutRender

description: Effects will be culled if they go longer than this time without being rendered.


className: FNiagaraTickInfo

code: struct FNiagaraTickInfo


code: bool AppendCompileHash ( [FNiagaraCompileHashVisitor](API\Plugins\Niagara\FNiagaraCompileHashVisitor) * InVisitor ) const


className: BoolStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * BoolStruct;


className: BoolStructs

code: static [TSet](API\Runtime\Core\Containers\TSet)< [UStruct](API\Runtime\CoreUObject\UObject\UStruct) * > BoolStructs;


className: ColorStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * ColorStruct;


className: CoordinateSpaceEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * CoordinateSpaceEnum;


className: EAllowUnfriendlyStruct

code: enum EAllowUnfriendlyStruct { Deny, Allow, }


className: ExecutionStateEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * ExecutionStateEnum;


className: ExecutionStateSourceEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * ExecutionStateSourceEnum;


className: FloatStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * FloatStruct;


className: FloatStructs

code: static [TSet](API\Runtime\Core\Containers\TSet)< [UStruct](API\Runtime\CoreUObject\UObject\UStruct) * > FloatStructs;


className: FTypeFlags

code: enum FTypeFlags { TF_None = 0x00, TF_Static = 0x01, TF_SerializedAsLWC = 0x02, TF_AllowLWC_DEPRECATED = 0x04, }


className: FUnderlyingType

code: enum FUnderlyingType { UT_None = 0, UT_Class, UT_Struct, UT_Enum, }


className: FunctionDebugStateEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * FunctionDebugStateEnum;


description: Helper to get the correct typedef for templated code.

code: template<typename T> static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & Get()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetBoolDef()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetBoolStruct()


description: Gets the class ptr for this type if it is a class.

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetClass() const


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetCollisionEventDef()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetColorDef()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetColorStruct()


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetCoordinateSpaceEnum()


code: [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetEnum() const


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetExecutionStateEnum()


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetExecutionStateSouceEnum()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetFloatStruct()


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetFunctionDebugStateEnum()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetGenericNumericDef()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetHalfDef()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetGenericNumericStruct()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetHalfStruct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetHalfVec2Def()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetHalfVec2Struct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetHalfVec3Def()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetHalfVec3Struct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetHalfVec4Def()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetIDStruct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetIntDef()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetIntStruct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetMatrix4Def()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetMatrix4Struct()


code: static [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) GetNumericOutputType ( TConstArrayView< [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) > TypeDefinintions, [ENiagaraNumericOutputTypeSelectionMode](API\Plugins\Niagara\ENiagaraNumericOutputTypeSelecti-) SelectionMode )


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) > & GetNumericTypes()


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetOrientationAxisEnum()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetParameterMapDef()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetParameterMapStruct()


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetParameterPanelCategoryEnum()


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetParameterScopeEnum()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetPositionDef()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetPositionStruct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetQuatDef()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetQuatStruct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetRandInfoDef()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetRandInfoStruct()


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetScriptContextEnum()


code: [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetScriptStruct() const


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetScriptUsageEnum()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetSimCacheClassDef()


code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetSimulationTargetEnum()


code: [UStruct](API\Runtime\CoreUObject\UObject\UStruct) * GetStruct() const


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetUMaterialDef()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetUObjectDef()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetUStaticMeshDef()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetUTextureDef()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetUTextureRenderTargetDef()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetVec2Def()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetVec2Struct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetVec3Def()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetVec3Struct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetVec4Def()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetVec4Struct()


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetWildcardStruct()


code: static const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & GetWildcardDef()


className: HalfStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * HalfStruct;


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * HalfVec2Struct;


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * HalfVec3Struct;


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * HalfVec4Struct;


className: IDStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * IDStruct;


className: IntStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * IntStruct;


className: IntStructs

code: static [TSet](API\Runtime\Core\Containers\TSet)< [UStruct](API\Runtime\CoreUObject\UObject\UStruct) * > IntStructs;


code: static bool IsLossyConversion ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & FromType, const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & ToType )


code: bool IsSameBaseDefinition ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & Other ) const


code: static bool IsScalarDefinition ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & Type )


code: static bool IsValidNumericInput ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & TypeDef )


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Matrix4Struct;


className: NumericStructs

code: static [TSet](API\Runtime\Core\Containers\TSet)< [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > NumericStructs;


className: NumericStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * NumericStruct;


code: bool operator== ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & Other ) const


code: bool operator!= ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & Other ) const


className: OrderedNumericTypes

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) > OrderedNumericTypes;


className: OrientationAxisEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * OrientationAxisEnum;


className: ParameterMapStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * ParameterMapStruct;


className: ParameterPanelCategoryEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * ParameterPanelCategoryEnum;


className: ParameterScopeEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * ParameterScopeEnum;


className: PositionStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * PositionStruct;


className: QuatStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * QuatStruct;


className: RandInfoStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * RandInfoStruct;


className: ScalarStructs

code: static [TSet](API\Runtime\Core\Containers\TSet)< [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * > ScalarStructs;


code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


className: ScriptContextEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * ScriptContextEnum;


className: ScriptUsageEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * ScriptUsageEnum;


code: void SetFlags ( [FTypeFlags](API\Plugins\Niagara\FNiagaraTypeDefinition\FTypeFlags) InFlags )


className: SimulationTargetEnum

code: static [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * SimulationTargetEnum;


code: [FString](API\Runtime\Core\Containers\FString) ToString ( const uint8 * ValueData ) const


className: UMaterialClass

code: static [UClass](API\Runtime\CoreUObject\UObject\UClass) * UMaterialClass;


code: static bool TypesAreAssignable ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & TypeA, const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & TypeB, bool bAllowLossyLWCConversions )


className: UObjectClass

code: static [UClass](API\Runtime\CoreUObject\UObject\UClass) * UObjectClass;


className: UTextureClass

code: static [UClass](API\Runtime\CoreUObject\UObject\UClass) * UTextureClass;


className: UTextureRenderTargetClass

code: static [UClass](API\Runtime\CoreUObject\UObject\UClass) * UTextureRenderTargetClass;


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Vec2Struct;


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Vec3Struct;


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Vec4Struct;


className: WildcardStruct

code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * WildcardStruct;


description: Construct a blank raw type definition.

code: FNiagaraTypeDefinition()


description: Construct blank raw type definition.

code: FNiagaraTypeDefinition ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


code: FNiagaraTypeDefinition ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * ClassDef )


code: FNiagaraTypeDefinition ( [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * EnumDef )


code: FNiagaraTypeDefinition ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * StructDef )


code: FNiagaraTypeDefinition ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * Property, [EAllowUnfriendlyStruct](API\Plugins\Niagara\FNiagaraTypeDefinition\EAllowUnfriendlyStruct) AllowUnfriendlyStruct )


className: FNiagaraTypeDefinition

ClassStructOrEnum

type: TObjectPtr<UOb...

description: Underlying type for this variable, use FUnderlyingType to determine type without casting This can be aUClass,UStructorUEnum.

UnderlyingType

description: See enumeration FUnderlyingType for possible values.


code: bool AppendCompileHash ( [FNiagaraCompileHashVisitor](API\Plugins\Niagara\FNiagaraCompileHashVisitor) * InVisitor ) const


code: bool IsSameBase ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & Other ) const


code: const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) * operator->() const


code: bool operator== ( const [FNiagaraTypeDefinitionHandle](API\Plugins\Niagara\FNiagaraTypeDefinitionHandle) & Other ) const


code: bool operator!= ( const [FNiagaraTypeDefinitionHandle](API\Plugins\Niagara\FNiagaraTypeDefinitionHandle) & Other ) const


code: FNiagaraTypeDefinition ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * StructDef, [EAllowUnfriendlyStruct](API\Plugins\Niagara\FNiagaraTypeDefinition\EAllowUnfriendlyStruct) AllowUnfriendlyStruct )


code: const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & operator*() const


code: FNiagaraTypeDefinitionHandle ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & Type )


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * FindNiagaraFriendlyTopLevelStruct ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * InStruct, [ENiagaraStructConversion](API\Plugins\Niagara\ENiagaraStructConversion) StructConversion )


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetLWCStruct ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * LWCStruct )


description: Attempt to get the actual LWC type for a given type that would be used in the rest of the engine etc. Used for cases where we actually need to store types in LWC format. These cannot be properly serialized currently so must be constructed at runtime from their Niagara Simulation types.

code: static [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) GetLWCType ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & InType )


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetSWCStruct ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * LWCStruct )


code: static [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) GetSWCType ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & InType )


code: static bool IsLWCStructure ( [UStruct](API\Runtime\CoreUObject\UObject\UStruct) * InStruct )


code: static bool IsLWCType ( const [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & InType )


code: static bool IsNiagaraFriendlyTopLevelStruct ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * InStruct, [ENiagaraStructConversion](API\Plugins\Niagara\ENiagaraStructConversion) StructConversion )


className: RemapTable

code: static [TMap](API\Runtime\Core\Containers\TMap)< [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) >, FRemapEntry > RemapTable;


className: RemapTableDirty

code: static std::atomic< bool > RemapTableDirty;


className: RemapTableLock

code: static FRWLock RemapTableLock;


code: static [FString](API\Runtime\Core\Containers\FString) ToString ( const uint8 * ValueData, const [UObject](API\Runtime\CoreUObject\UObject\UObject) * StructOrEnum )


description: LWC Counterparts to Niagara's base simulation types.


className: FNiagaraTypeHelper

description: Can convert aUStructwith fields of base types only (float, int... - will likely add native vector types here as well) to anFNiagaraTypeDefinition(internal representation)

code: class FNiagaraTypeHelper


code: void GenerateLayoutInfo ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Struct )