Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UNiagaraSystem

UNiagaraSystem

A Niagara System contains multiple Niagara Emitters to create various effects.

API > API/Plugins > API/Plugins/Niagara

A Niagara System contains multiple Niagara Emitters to create various effects. Niagara Systems can be placed in the world, unlike Emitters, and expose User Parameters to configure an effect at runtime.

   
Name UNiagaraSystem
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSystem.h
Include Path #include "NiagaraSystem.h"

Syntax

UCLASS (BlueprintType, MinimalAPI, Meta=(LoadBehavior="LazyOnDemand"))  
class UNiagaraSystem :  
    public UFXSystemAsset ,  
    public INiagaraParameterDefinitionsSubscriber

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers
  NiagaraSystem.h  

UNiagaraSystem ( const FObjectInitializer& ObjectInitializer
)

   NiagaraSystem.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UNiagaraSystem()

   NiagaraSystem.h  

Structs

Name Remarks
FStaticBuffersDeletor  

Enums

Protected

Name Remarks
ERequestCompileStatus Used to track the status of compilation request, when using on demand they will initially be in RequestPendingOnDemand.

Typedefs

Name Type Remarks Include Path
FOnScalabilityChanged TMulticastDelegate_NoParams< void >   NiagaraSystem.h
FOnSystemCompiled TMulticastDelegate_OneParam< void, UNiagaraSystem * >   NiagaraSystem.h
FOnSystemPostEditChange TMulticastDelegate_OneParam< void, UNiagaraSystem * >   NiagaraSystem.h

Constants

Name Type Remarks Include Path
ComputeEmitterExecutionOrderMessageId const FGuid   NiagaraSystem.h
kStartNewOverlapGroupBit int32 When an index inside the EmitterExecutionOrder array has this bit set, it means the corresponding emitter cannot execute in parallel with the previous emitters due to a data dependency. NiagaraSystem.h
ResolveDIsMessageId const FGuid   NiagaraSystem.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCastShadow uint8 When enabled this is the default value set on the component. NiagaraSystem.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Rendering"
  • Meta=(DisplayName="Default Cast Shadows", EditCondition="bOverrideCastShadow")
bDumpDebugEmitterInfo uint8   NiagaraSystem.h
  • EditAnywhere
  • Category="Debug"
  • Transient
  • AdvancedDisplay
bDumpDebugSystemInfo uint8   NiagaraSystem.h
  • EditAnywhere
  • Category="Debug"
  • Transient
  • AdvancedDisplay
bFixedBounds uint32 Whether or not fixed bounds are enabled. NiagaraSystem.h
  • EditAnywhere
  • Category="System"
  • Meta=(SkipSystemResetOnChange="true", InlineEditConditionToggle)
bFullyLoaded uint8   NiagaraSystem.h  
bOverrideCastShadow uint8 Various optional overrides for component properties when spawning a system. NiagaraSystem.h
  • EditAnywhere
  • Category="Rendering"
  • Meta=(InlineEditConditionToggle="bCastShadow")
bOverrideCustomDepthStencilValue uint8   NiagaraSystem.h
  • EditAnywhere
  • Category="Rendering"
  • Meta=(InlineEditConditionToggle="CustomDepthStencilValue")
bOverrideCustomDepthStencilWriteMask uint8   NiagaraSystem.h
  • EditAnywhere
  • Category="Rendering"
  • Meta=(InlineEditConditionToggle="CustomDepthStencilWriteMask")
bOverrideReceivesDecals uint8   NiagaraSystem.h
  • EditAnywhere
  • Category="Rendering"
  • Meta=(InlineEditConditionToggle="bReceivesDecals")
bOverrideRenderCustomDepth uint8   NiagaraSystem.h
  • EditAnywhere
  • Category="Rendering"
  • Meta=(InlineEditConditionToggle="bRenderCustomDepth")
bOverrideTranslucencySortDistanceOffset uint8   NiagaraSystem.h
  • EditAnywhere
  • Category="Rendering"
  • Meta=(InlineEditConditionToggle="TranslucencySortDistanceOffset")
bOverrideTranslucencySortPriority uint8   NiagaraSystem.h
  • EditAnywhere
  • Category="Rendering"
  • Meta=(InlineEditConditionToggle="TranslucencySortPriority")
bReceivesDecals uint8 When enabled this is the default value set on the component. Whether the primitive receives decals. NiagaraSystem.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Rendering"
  • Meta=(DisplayName="Default Receives Decals", EditCondition="bOverrideReceivesDecals")
bRenderCustomDepth uint8 When enabled this is the default value set on the component. NiagaraSystem.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Rendering"
  • Meta=(DisplayName="Default Render CustomDepth Pass", EditCondition="bOverrideRenderCustomDepth")
bRequireCurrentFrameData uint8 When enabled, we follow the settings on the UNiagaraComponent for tick order. NiagaraSystem.h
  • EditAnywhere
  • Category="Performance"
  • AdvancedDisplay
bSupportLargeWorldCoordinates uint8 If true then position type values will be rebased on system activation to fit into a float precision vector. NiagaraSystem.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Rendering"
Category FText Category of this system. NiagaraSystem.h
  • AssetRegistrySearchable
  • Meta=(SkipSystemResetOnChange="true")
CustomDepthStencilValue int32 When enabled this is the default value set on the component. NiagaraSystem.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category="Rendering"
  • Meta=(DisplayName="Default CustomDepthStencil Value", editcondition="bOverrideCustomDepthStencilWriteMask", UIMin="0", UIMax="255")
CustomDepthStencilWriteMask ERendererStencilMask When enabled this is the default value set on the component. Mask used for stencil buffer writes. NiagaraSystem.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category="Rendering"
  • Meta=(DisplayName="Default CustomDepthStencil Write Mask", editcondition="bOverrideCustomDepthStencilValue")
EditorOnlyAddedParameters FNiagaraParameterStore   NiagaraSystem.h
  • Transient
LibraryVisibility ENiagaraScriptLibraryVisibility If this system is exposed to the library, or should be explicitly hidden. NiagaraSystem.h
  • AssetRegistrySearchable
  • Meta=(SkipSystemResetOnChange="true")
ParameterDefinitionsSubscriptions TArray< FParameterDefinitionsSubscription > Subscriptions to definitions of parameters. NiagaraSystem.h  
PreviewMoviePath FSoftObjectPath   NiagaraSystem.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Asset Options"
  • AssetRegistrySearchable
  • Meta=(SkipSystemResetOnChange="true", AllowedClasses="/Script/MediaAssets.FileMediaSource")
ScratchPadScripts TArray< TObjectPtr< UNiagaraScript > >   NiagaraSystem.h  
TemplateAssetDescription FText   NiagaraSystem.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Asset Options"
  • AssetRegistrySearchable
  • DisplayName="Asset Description"
  • Meta=(SkipSystemResetOnChange="true")
ThumbnailImage TObjectPtr< class UTexture2D > Internal: The thumbnail image. NiagaraSystem.h  
TranslucencySortDistanceOffset float When enabled this is the default value set on the component. NiagaraSystem.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category="Rendering"
  • Meta=(editcondition="bOverrideTranslucencySortDistanceOffset")
TranslucencySortPriority int32 When enabled this is the default value set on the component. NiagaraSystem.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category="Rendering"
  • Meta=(editcondition="bOverrideTranslucencySortPriority")
UpdateContext FNiagaraSystemUpdateContext   NiagaraSystem.h
  • Transient

Protected

Name Type Remarks Include Path Unreal Specifiers
bInitialOwnerVelocityFromActor uint8 When enabled we use the owner actor's velocity for the first frame. NiagaraSystem.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="System"
LargeWorldCoordinateTileUpdateMode TOptional< ENiagaraLwcTileUpdateMode >   NiagaraSystem.h
  • EditAnywhere
  • Category=Rendering
  • AdvancedDisplay
  • Meta=(EditCondition="bSupportLargeWorldCoordinates", EditConditionHides, DisplayAfter=bSupportLargeWorldCoordinates)

Functions

Public

Name Remarks Include Path Unreal Specifiers

FNiagaraEmitterHandle AddEmitterHandle ( UNiagaraEmitter& SourceEmitter,
FName EmitterName,
FGuid EmitterVersion
)

 Adds a new emitter handle to this System. NiagaraSystem.h  

void AddEmitterHandleDirect ( FNiagaraEmitterHandle& EmitterHandleToAdd
)

 Adds a new emitter handle to this system without copying the original asset. NiagaraSystem.h  

void AddToInstanceCountStat ( int32 NumInstances,
bool bSolo
) const

   NiagaraSystem.h  

bool AllDIsPostSimulateCanOverlapFrames()

   NiagaraSystem.h  

bool AllowCullingForLocalPlayers()

   NiagaraSystem.h  

bool AllowScalabilityForLocalPlayerFX()

   NiagaraSystem.h  

bool AllowValidation()

   NiagaraSystem.h  

bool AsyncWorkCanOverlapTickGroups()

   NiagaraSystem.h  

void CacheFromCompiledData()

 Cache data & accessors from the compiled data, allows us to avoid per instance. NiagaraSystem.h  

bool CanObtainEmitterAttribute ( const FNiagaraVariableBase& InVarWithUniqueNameNamespace,
FNiagaraTypeDefinition& OutBoundType
) const

   NiagaraSystem.h  

bool CanObtainSystemAttribute ( const FNiagaraVariableBase& InVar,
FNiagaraTypeDefinition& OutBoundType
) const

   NiagaraSystem.h  

bool CanObtainUserVariable ( const FNiagaraVariableBase& InVar
) const

   NiagaraSystem.h  

virtual bool ChangeEmitterVersion ( const FVersionedNiagaraEmitter& Emitter,
const FGuid& NewVersion
)

   NiagaraSystem.h  

bool CompileRequestsShouldBlockGC()

   NiagaraSystem.h  

bool ComputeEmitterPriority ( int32 EmitterIdx,
TArray< int32, TInlineAllocator< 32 > >& EmitterPriorities,
const TBitArray< TInlineAllocator< 32 > >& EmitterDependencyGraph
)

 Computes emitter priorities based on the dependency information. NiagaraSystem.h  

void ComputeEmittersExecutionOrder()

 Computes the order in which the emitters in the Emitters array will be ticked and stores the results in EmitterExecutionOrder. NiagaraSystem.h  

void ComputeRenderersDrawOrder()

 Computes the order in which renderers will render NiagaraSystem.h  

FNiagaraEmitterHandle DuplicateEmitterHandle ( const FNiagaraEmitterHandle& EmitterHandleToDuplicate,
FName EmitterName
)

 Duplicates an existing emitter handle and adds it to the System. NiagaraSystem.h  

void EnsureFullyLoaded()

   NiagaraSystem.h  

void FindDataInterfaceDependencies ( FVersionedNiagaraEmitterData* EmitterData,
UNiagaraScript* Script,
TArray< FVersionedNiagaraEmitter >& Dependencies
)

 Queries all the data interfaces in the array for emitter dependencies. NiagaraSystem.h  

void FindEventDependencies ( FVersionedNiagaraEmitterData* EmitterData,
TArray< FVersionedNiagaraEmitter >& Dependencies
)

 Looks at all the event handlers in the emitter to determine which other emitters it depends on. NiagaraSystem.h  

void ForceGraphToRecompileOnNextCheck()

   NiagaraSystem.h  

void ForEachPlatformSet ( TAction Func
)

 Performs the passed action for all FNiagaraPlatformSets used by this system. NiagaraSystem.h  

void ForEachScript ( TAction Func
) const

 Performs the passed action for all scripts in this system. NiagaraSystem.h  

void GatherStaticVariables ( TArray< FNiagaraVariable >& OutVars,
TArray< FNiagaraVariable >& OutEmitterVars
) const

   NiagaraSystem.h  

int32 & GetActiveInstancesCount()

   NiagaraSystem.h  

const FGuid & GetAssetGuid()

   NiagaraSystem.h  

const UNiagaraBakerSettings * GetBakerGeneratedSettings()

   NiagaraSystem.h  

UNiagaraBakerSettings * GetBakerSettings()

   NiagaraSystem.h  

const TSharedPtr< FNiagaraGraphCachedDataBase, ESPMode::ThreadSafe > & GetCachedTraversalData()

 Get the cached parameter map traversal for this emitter. NiagaraSystem.h  

bool GetCompileForEdit()

   NiagaraSystem.h  

const FString & GetCrashReporterTag()

   NiagaraSystem.h  

ENiagaraCullProxyMode GetCullProxyMode()

   NiagaraSystem.h  

const FNiagaraSystemScalabilityOverride & GetCurrentOverrideSettings()

   NiagaraSystem.h  
Gets editor specific data stored with this system. NiagaraSystem.h  
Gets editor specific data stored with this system. NiagaraSystem.h  

UNiagaraEditorParametersAdapterBase * GetEditorParameters()

 Gets editor specific parameters stored with this system NiagaraSystem.h  

UNiagaraEffectType * GetEffectType()

   NiagaraSystem.h  

const TArray< TSharedRef< const FNiagaraEmitterCompiledData > > & GetEmitterCompiledData()

   NiagaraSystem.h  

TConstArrayView< FNiagaraEmitterExecutionIndex > GetEmitterExecutionOrder()

   NiagaraSystem.h  

TConstArrayView< FNiagaraDataSetAccessor< ENiagaraExecutionState > > GetEmitterExecutionStateAccessors()

   NiagaraSystem.h  
  NiagaraSystem.h  

const FNiagaraEmitterHandle & GetEmitterHandle ( int Idx
) const

   NiagaraSystem.h  
Gets an array of the emitter handles. NiagaraSystem.h  
  NiagaraSystem.h  

TConstArrayView< FNiagaraDataSetAccessor< FNiagaraSpawnInfo > > GetEmitterSpawnInfoAccessors ( int32 EmitterIndex
) const

   NiagaraSystem.h  
  NiagaraSystem.h  
From the last compile, what are the variables that were exported out of the system for external use? NiagaraSystem.h  

FBox GetFixedBounds()

   NiagaraSystem.h  

float GetFixedTickDeltaTime()

   NiagaraSystem.h  

FBox GetInitialStreamingBounds()

   NiagaraSystem.h  

bool GetIsolateEnabled()

   NiagaraSystem.h  

ENiagaraLwcTileUpdateMode GetLargeWorldCoordinateTileUpdateMode()

   NiagaraSystem.h  

TOptional< float > GetMaxDeltaTime()

   NiagaraSystem.h  

void GetMaxInstanceCounts ( int32& OutSystemInstanceMax,
int32& OutFXTypeInstanceMax,
bool bBudgetAdjusted
) const

   NiagaraSystem.h  

FNiagaraMessageStore & GetMessageStore()

   NiagaraSystem.h  

int GetNumEmitters()

   NiagaraSystem.h  

bool GetOverrideScalabilitySettings()

   NiagaraSystem.h  

UNiagaraParameterCollectionInstance * GetParameterCollectionOverride ( UNiagaraParameterCollection* Collection
)

   NiagaraSystem.h  

ENiagaraPerformanceStateScopeMode GetPerformanceStateScopeMode()

 Returns information on the availability of performance stat scopes NiagaraSystem.h  

int32 GetRandomSeed()

   NiagaraSystem.h  

TConstArrayView< FNiagaraRendererExecutionIndex > GetRendererCompletionOrder()

   NiagaraSystem.h  

TConstArrayView< int32 > GetRendererDrawOrder()

   NiagaraSystem.h  

TConstArrayView< FNiagaraRendererExecutionIndex > GetRendererPostTickOrder()

   NiagaraSystem.h  

FNiagaraSystemScalabilityOverrides & GetScalabilityOverrides()

   NiagaraSystem.h  
  NiagaraSystem.h  
  NiagaraSystem.h  

const FNiagaraSystemScalabilitySettings & GetScalabilitySettings()

   NiagaraSystem.h  

const FNiagaraSystemStaticBuffers * GetStaticBuffers()

   NiagaraSystem.h  

TStatId GetStatID ( bool bGameThread,
bool bConcurrent
) const

   NiagaraSystem.h  

const FNiagaraSystemCompiledData & GetSystemCompiledData()

   NiagaraSystem.h  

const FNiagaraDataSetAccessor< ENiagaraExecutionState > & GetSystemExecutionStateAccessor()

   NiagaraSystem.h  

FNiagaraSystemScalabilityOverrides & GetSystemScalabilityOverrides()

   NiagaraSystem.h  
  NiagaraSystem.h  
Gets the System script which is used to populate the System parameters and parameter bindings. NiagaraSystem.h  

const FNiagaraSystemStateData & GetSystemStateData()

 Access the code system state data. NiagaraSystem.h  

const TCHAR * GetSystemStateModeString()

 Used for debug HUD / viewport to convey what mode we are running in NiagaraSystem.h  
  NiagaraSystem.h  
  NiagaraSystem.h  

int32 GetWarmupTickCount()

   NiagaraSystem.h  

float GetWarmupTickDelta()

   NiagaraSystem.h  

float GetWarmupTime()

   NiagaraSystem.h  

void GraphSourceChanged()

   NiagaraSystem.h  

void HandleVariableRemoved ( const FNiagaraVariable& InOldVariable,
bool bUpdateContexts
)

 Helper method to handle when an internal variable has been removed. NiagaraSystem.h  

void HandleVariableRenamed ( const FNiagaraVariable& InOldVariable,
const FNiagaraVariable& InNewVariable,
bool bUpdateContexts
)

 Helper method to handle when an internal variable has been renamed. NiagaraSystem.h  

bool HasActiveCompilations()

 Returns true if there are any active compilations. NiagaraSystem.h  

bool HasAnyGPUEmitters()

   NiagaraSystem.h  

bool HasDIsWithPostSimulateTick()

   NiagaraSystem.h  

bool HasFixedTickDelta()

   NiagaraSystem.h  

bool HasOutstandingCompilationRequests ( bool bIncludingGPUShaders
) const

 Are there any pending compile requests? NiagaraSystem.h  

void InvalidateActiveCompiles()

 Invalidates any active compilation requests which will ignore their results. NiagaraSystem.h  

void InvalidateCachedData()

   NiagaraSystem.h  

bool IsAllowedByScalability()

 Returns true if this emitter's platform filter allows it on this platform and quality level. NiagaraSystem.h  

bool IsInitialOwnerVelocityFromActor()

   NiagaraSystem.h  

bool IsLooping()

   NiagaraSystem.h  

bool IsReadyToRun()

   NiagaraSystem.h  

bool IsValid()

 Returns true if this system is valid and can be instanced. False otherwise. NiagaraSystem.h  

void KillAllActiveCompilations()

 Tries to abort all running shader compilations NiagaraSystem.h  

bool NeedsDeterminism()

   NiagaraSystem.h  

bool NeedsGPUContextInitForDataInterfaces()

   NiagaraSystem.h  

bool NeedsRequestCompile()

 Do we have any pending compilation requests or not NiagaraSystem.h  

bool NeedsSortedSignificanceCull()

   NiagaraSystem.h  

bool NeedsWarmup()

   NiagaraSystem.h  

void OnCompiledDataInterfaceChanged()

 Updates any post compile data based upon data interfaces. NiagaraSystem.h  

void OnCompiledUObjectChanged()

 Updates the system post UObject change. NiagaraSystem.h  

FOnScalabilityChanged & OnScalabilityChanged()

 Delegate called on effect type or effect type value change NiagaraSystem.h  

FOnSystemCompiled & OnSystemCompiled()

 Delegate called when the system's dependencies have all been compiled. NiagaraSystem.h  

FOnSystemPostEditChange & OnSystemPostEditChange()

 Delegate called on PostEditChange. NiagaraSystem.h  

bool PollForCompilationComplete ( bool bFlushRequestCompile
)

 If we have a pending compile request, is it done with yet? NiagaraSystem.h  

void PrecachePSOs()

   NiagaraSystem.h  

void PrepareRapidIterationParametersForCompilation()

 Updates the rapid iteration parameters for all scripts referenced by the system. NiagaraSystem.h  

bool ReferencesInstanceEmitter ( const FVersionedNiagaraEmitter& Emitter
) const

 Determines if this system has the supplied emitter as an editable and simulating emitter instance. NiagaraSystem.h  

void RefreshSystemParametersFromEmitter ( const FNiagaraEmitterHandle& EmitterHandle
)

 Updates the system's rapid iteration parameters from a specific emitter. NiagaraSystem.h  

void RegisterActiveInstance()

   NiagaraSystem.h  

void RemoveEmitterHandle ( const FNiagaraEmitterHandle& EmitterHandleToDelete
)

 Removes the provided emitter handle. NiagaraSystem.h  

void RemoveEmitterHandlesById ( const TSet< FGuid >& HandlesToRemove
)

 Removes the emitter handles which have an Id in the supplied set. NiagaraSystem.h  

void RemoveSystemParametersForEmitter ( const FNiagaraEmitterHandle& EmitterHandle
)

 Removes the system's rapid iteration parameters for a specific emitter. NiagaraSystem.h  

void ReportAnalyticsData ( bool bIsCooking
)

   NiagaraSystem.h  

bool RequestCompile ( bool bForce,
FNiagaraSystemUpdateContext* OptionalUpdateContext,
const ITargetPlatform* TargetPlatform
)

 Request that any dirty scripts referenced by this system be compiled. NiagaraSystem.h  

void ResetToEmptySystem()

 Resets internal data leaving it in a state which would have minimal cost to exist in headless builds (servers) NiagaraSystem.h  

void ResolveWarmupTickCount()

   NiagaraSystem.h  

void SetBakeOutRapidIterationOnCook ( bool bBakeOut
)

   NiagaraSystem.h  

void SetBakerGeneratedSettings ( UNiagaraBakerSettings* Settings
)

   NiagaraSystem.h  

void SetCompileForEdit ( bool bNewCompileForEdit
)

   NiagaraSystem.h  

void SetEffectType ( UNiagaraEffectType* EffectType
)

   NiagaraSystem.h  

void SetFixedBounds ( const FBox& Box
)

   NiagaraSystem.h  

void SetIsolateEnabled ( bool bIsolate
)

   NiagaraSystem.h  

void SetOverrideScalabilitySettings ( bool bOverride
)

   NiagaraSystem.h  

void SetTrimAttributesOnCook ( bool bTrim
)

   NiagaraSystem.h  

void SetWarmupTickDelta ( float InWarmupTickDelta
)

   NiagaraSystem.h  

void SetWarmupTime ( float InWarmupTime
)

   NiagaraSystem.h  

bool ShouldCompressAttributes()

   NiagaraSystem.h  

bool ShouldDisableDebugSwitches()

   NiagaraSystem.h  

bool ShouldIgnoreParticleReadsForAttributeTrim()

   NiagaraSystem.h  

bool ShouldTrimAttributes()

   NiagaraSystem.h  

bool ShouldUseRapidIterationParameters()

   NiagaraSystem.h  

bool SupportsLargeWorldCoordinates()

   NiagaraSystem.h  

void UnregisterActiveInstance()

   NiagaraSystem.h  

void UpdateScalability()

   NiagaraSystem.h  

void UpdateSystemAfterLoad()

   NiagaraSystem.h  

bool UsesCollection ( const UNiagaraParameterCollection* Collection
) const

   NiagaraSystem.h  

bool UsesEmitter ( UNiagaraEmitterBase* Emitter
) const

   NiagaraSystem.h  

bool UsesEmitter ( const FVersionedNiagaraEmitterBase& VersionedEmitter
) const

   NiagaraSystem.h  

bool UsesEmitter ( const FVersionedNiagaraEmitter& VersionedEmitter
) const

   NiagaraSystem.h  

bool UsesScript ( const UNiagaraScript* Script
) const

   NiagaraSystem.h  

void WaitForCompilationComplete ( bool bIncludingGPUShaders,
bool bShowProgress
)

 Blocks until all active compile jobs have finished NiagaraSystem.h  

void WaitForCompilationComplete_SkipPendingOnDemand ( bool bIncludingGPUShaders,
bool bShowProgress
)

 Blocks until all active compile jobs have finished but does not flush any requests that were deferred from loading. NiagaraSystem.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   NiagaraSystem.h  

virtual void BeginDestroy()

   NiagaraSystem.h  

virtual void GetAssetRegistryTagMetadata ( TMap< FName, FAssetRegistryTagMetadata >& OutMetadata
) const

   NiagaraSystem.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   NiagaraSystem.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   NiagaraSystem.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   NiagaraSystem.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

   NiagaraSystem.h  

virtual bool IsReadyForFinishDestroy()

   NiagaraSystem.h  

virtual void OnCookEvent ( UE::Cook::ECookEvent CookEvent,
UE::Cook::FCookEventContext& CookContext
)

   NiagaraSystem.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   NiagaraSystem.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraSystem.h  

virtual void PostInitProperties()

   NiagaraSystem.h  

virtual void PostLoad()

   NiagaraSystem.h  

virtual void PostRename ( UObject* OldOuter,
const FName OldName
)

   NiagaraSystem.h  

virtual void PreEditChange ( FProperty* PropertyThatWillChange
)

   NiagaraSystem.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   NiagaraSystem.h  

virtual void Serialize ( FArchive& Ar
)

   NiagaraSystem.h  

Overridden from UObjectBaseUtility

Name Remarks Include Path Unreal Specifiers

virtual bool CanBeClusterRoot()

   NiagaraSystem.h  

Overridden from INiagaraParameterDefinitionsSubscriber

Name Remarks Include Path Unreal Specifiers

virtual TArray< UNiagaraScriptSourceBase * > GetAllSourceScripts()

 Get all UNiagaraScriptSourceBase of this subscriber. NiagaraSystem.h  

virtual TArray< UNiagaraEditorParametersAdapterBase * > GetEditorOnlyParametersAdapters()

 Get All adapters to editor only script vars owned directly by this subscriber. NiagaraSystem.h  
Get all subscribers that are owned by this subscriber. NiagaraSystem.h  
  NiagaraSystem.h  
  NiagaraSystem.h  

virtual FString GetSourceObjectPathName()

 Get the path to the UObject of this subscriber. NiagaraSystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

void GenerateStatID()

   NiagaraSystem.h  

void UpdateStatID()

   NiagaraSystem.h  

Static

Name Remarks Include Path Unreal Specifiers
Append config values or settings that can change how instances of the class are cooked, including especially values that determine how version upgraded are conducted. NiagaraSystem.h  

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   NiagaraSystem.h  

static void RecomputeExecutionOrderForDataInterface ( UNiagaraDataInterface* DataInterface
)

   NiagaraSystem.h  

static void RecomputeExecutionOrderForEmitter ( const FVersionedNiagaraEmitter& InEmitter
)

   NiagaraSystem.h  

static void RequestCompileForEmitter ( const FVersionedNiagaraEmitter& InEmitter
)

   NiagaraSystem.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
AssetTags_DEPRECATED TArray< FNiagaraAssetTagDefinitionReference >   NiagaraSystem.h
  • Meta=(DeprecatedProperty)
bExposeToLibrary_DEPRECATED bool Deprecated library exposure bool. NiagaraSystem.h  
bIsTemplateAsset_DEPRECATED bool Deprecated template asset bool. Use the TemplateSpecification enum instead. NiagaraSystem.h  
MessageKeyToMessageMap_DEPRECATED TMap< FGuid, TObjectPtr< UNiagaraMessageDataBase > > Messages associated with the System asset. NiagaraSystem.h  
ScalabilityOverrides_DEPRECATED TArray< FNiagaraSystemScalabilityOverride >   NiagaraSystem.h  
TemplateSpecification_DEPRECATED ENiagaraScriptTemplateSpecification If this system is a regular system, a template or a behavior example. NiagaraSystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page