| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSystem.h |
Include |
#include "NiagaraSystem.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UNiagaraSystem :
public UFXSystemAsset,
public INiagaraParameterDefinitionsSubscriber
Container for multiple emitters that combine together to create a particle system effect.
Name | Description | ||
---|---|---|---|
|
ActiveCompilations |
||
|
ActiveInstances |
Total active instances of this system. |
|
|
AssetGuid |
||
|
BakerGeneratedSettings |
Generated data baker settings, will be null until we have generated at least once. |
|
|
BakerSettings |
Settings used inside the baker |
|
|
bAutoDeactivate |
||
|
uint32: 1 |
bBakeOutRapidIteration |
Experimental feature that allows us to bake out rapid iteration parameters during the normal compile process. |
|
uint32: 1 |
bBakeOutRapidIterationOnCook |
If true bBakeOutRapidIteration will be made to be true during cooks |
|
uint32: 1 |
bCompressAttributes |
Toggles whether or not emitters within this system will try and compress their particle attributes. |
|
uint32: 1 |
bDisableAllDebugSwitches |
If true, forcefully disables all debug switches |
|
bDumpDebugEmitterInfo |
||
|
bDumpDebugSystemInfo |
||
|
bExposeToLibrary |
If this system is exposed to the library. |
|
|
uint32: 1 |
bFixedBounds |
Whether or not fixed bounds are enabled. |
|
bFullyLoaded |
||
|
uint32: 1 |
bHasAnyGPUEmitters |
|
|
uint32: 1 |
bHasDIsWithPostSimulateTick |
|
|
bHasSystemScriptDIsWithPerInstanceData |
||
|
bIsolateEnabled |
||
|
uint32: 1 |
bIsReadyToRunCached |
|
|
uint32: 1 |
bIsValidCached |
|
|
bNeedsGPUContextInitForDataInterfaces |
||
|
uint32: 1 |
bNeedsSortedSignificanceCull |
|
|
bOverrideScalabilitySettings |
||
|
bRequireCurrentFrameData |
When enabled, we follow the settings on the UNiagaraComponent for tick order. |
|
|
uint32: 1 |
bTrimAttributes |
If true Particle attributes will be removed from the DataSet if they are unnecessary (are never read by ParameterMap) |
|
uint32: 1 |
bTrimAttributesOnCook |
If true bTrimAttributes will be made to be true during cooks |
|
CrashReporterTag |
||
|
CurrentScalabilitySettings |
||
|
EditorData |
Data used by the editor to maintain UI state etc.. |
|
|
EditorOnlyAddedParameters |
||
|
EditorParameters |
Wrapper for editor only parameters. |
|
|
EffectType |
||
|
EmitterCompiledData |
||
|
EmitterExecutionOrder |
Array of emitter indices sorted by execution priority. |
|
|
EmitterExecutionStateAccessors |
||
|
EmitterHandles |
Handles to the emitter this System will simulate. |
|
|
EmitterSpawnInfoAccessors |
||
|
ExposedParameters |
Variables exposed to the outside work for tweaking |
|
|
FixedBounds |
The fixed bounding box value. bFixedBounds is the condition whether the fixed bounds can be edited. |
|
|
TOptional< floa... |
MaxDeltaTime |
|
|
MessageKeyToMessageMap |
Messages associated with the System asset. |
|
|
OnSystemCompiledDelegate |
A multicast delegate which is called whenever the script has been compiled (successfully or not). |
|
|
OnSystemPostEditChangeDelegate |
A multicast delegate which is called whenever this system's properties are changed. |
|
|
ParameterCollectionOverrides |
||
|
ParameterDefinitionsSubscriptions |
Subscriptions to definitions of parameters. |
|
|
RendererCompletionOrder |
Array of renderer indices to notify system Completion, in order of execution |
|
|
RendererDrawOrder |
Precomputed emitter renderer draw order, since emitters & renderers are not dynamic we can do this. |
|
|
RendererPostTickOrder |
Array of renderer indices to notify system PostTick, in order of execution |
|
|
ScratchPadScripts |
||
|
SystemCompiledData |
||
|
SystemExecutionStateAccessor |
||
|
SystemScalabilityOverrides |
||
|
UNiagaraScript ... |
SystemSpawnScript |
/** Category of this system. */ |
|
UNiagaraScript ... |
SystemUpdateScript |
The script which defines the System parameters, and which generates the bindings from System parameter to emitter parameter. |
|
TemplateAssetDescription |
||
|
TemplateSpecification |
||
|
UTexture2D *... |
ThumbnailImage |
Internal: The thumbnail image. |
|
uint32: 1 |
ThumbnailImageOutOfDate |
Internal: Indicates the thumbnail image is out of date. |
|
UpdateContext |
||
|
UserDINamesReadInSystemScripts |
||
|
WarmupTickCount |
Number of ticks to process for warmup. You can set by this or by time via WarmupTime. |
|
|
float |
WarmupTickDelta |
Delta time to use for warmup ticks. |
|
float |
WarmupTime |
Warm up time in seconds. |
Name | Description | |
---|---|---|
|
UNiagaraSystem ( |
|
|
UNiagaraSystem ( |
Name | Description | ||
---|---|---|---|
|
FNiagaraEmit... |
AddEmitterHandle ( |
Adds a new emitter handle to this System. |
|
AddEmitterHandleDirect ( |
Adds a new emitter handle to this system without copying the original asset. |
|
|
AddMessage ( |
||
|
AddToInstanceCountStat |
||
|
CacheFromCompiledData() |
Cache data & accessors from the compiled data, allows us to avoid per instance. |
|
|
CanObtainEmitterAttribute ( |
||
|
CanObtainSystemAttribute ( |
||
|
CanObtainUserVariable ( |
||
|
ComputeEmitterPriority ( |
Computes emitter priorities based on the dependency information. |
|
|
ComputeEmittersExecutionOrder() |
Computes the order in which the emitters in the Emitters array will be ticked and stores the results in EmitterExecutionOrder. |
|
|
ComputeRenderersDrawOrder() |
Computes the order in which renderers will render |
|
|
FNiagaraEmit... |
DuplicateEmitterHandle ( |
Duplicates an existing emitter handle and adds it to the System. |
|
EnsureFullyLoaded() |
||
|
FindDataInterfaceDependencies ( |
Queries all the data interfaces in the array for emitter dependencies. |
|
|
FindEventDependencies ( |
Looks at all the event handlers in the emitter to determine which other emitters it depends on. |
|
|
ForceGraphToRecompileOnNextCheck() |
||
|
ForEachScript ( |
Performs the passed action for all scripts in this system. |
|
|
GenerateStatID() |
||
|
int32 & |
GetActiveInstancesCount() |
|
|
const FGuid ... |
GetAssetGuid() |
|
|
const UNiaga... |
GetBakerGeneratedSettings() |
|
|
UNiagaraBake... |
GetBakerSettings() |
|
|
const FStrin... |
GetCrashReporterTag() |
|
|
const UNiaga... |
GetEditorData() |
Gets editor specific data stored with this system. |
|
UNiagaraEdit... |
GetEditorData() |
Gets editor specific data stored with this system. |
|
UNiagaraEdit... |
GetEditorParameters() |
Gets editor specific parameters stored with this system |
|
UNiagaraEffe... |
GetEffectType() |
|
|
const TArray... |
GetEmitterCompiledData() |
|
|
TConstArrayV... |
GetEmitterExecutionOrder() |
|
|
TConstArrayV... |
GetEmitterExecutionStateAccessors() |
|
|
FNiagaraEmit... |
GetEmitterHandle ( |
|
|
const FNiaga... |
GetEmitterHandle ( |
|
|
const TArray... |
GetEmitterHandles() |
Gets an array of the emitter handles. |
|
const TArray... |
GetEmitterHandles() |
Gets an array of the emitter handles. |
|
TConstArrayV... |
GetEmitterSpawnInfoAccessors ( |
|
|
const FNiaga... |
GetExposedParameters() |
From the last compile, what are the variables that were exported out of the system for external use? |
|
FNiagaraUser... |
GetExposedParameters() |
|
|
GetFixedBounds() |
||
|
GetIsolateEnabled() |
||
|
TOptional< f... |
GetMaxDeltaTime() |
|
|
const TMap< ... |
GetMessages() |
|
|
int |
GetNumEmitters() |
|
|
GetOverrideScalabilitySettings() |
||
|
UNiagaraPara... |
GetParameterCollectionOverride ( |
|
|
TConstArrayV... |
GetRendererCompletionOrder() |
|
|
TConstArrayV... |
GetRendererDrawOrder() |
|
|
TConstArrayV... |
GetRendererPostTickOrder() |
|
|
const FNiaga... |
GetScalabilitySettings() |
|
|
GetStatID |
||
|
const FNiaga... |
GetSystemCompiledData() |
|
|
const FNiaga... |
GetSystemExecutionStateAccessor() |
|
|
const UNiaga... |
GetSystemSpawnScript() |
|
|
UNiagaraScri... |
GetSystemSpawnScript() |
Gets the System script which is used to populate the System parameters and parameter bindings. |
|
const UNiaga... |
GetSystemUpdateScript() |
|
|
UNiagaraScri... |
GetSystemUpdateScript() |
|
|
const TArray... |
GetUserDINamesReadInSystemScripts() |
|
|
GetWarmupTickCount() |
||
|
float |
GetWarmupTickDelta() |
|
|
float |
GetWarmupTime() |
|
|
HandleVariableRemoved ( |
Helper method to handle when an internal variable has been removed. |
|
|
HandleVariableRenamed ( |
Helper method to handle when an internal variable has been renamed. |
|
|
HasAnyGPUEmitters() |
||
|
HasDIsWithPostSimulateTick() |
||
|
HasOutstandingCompilationRequests ( |
Are there any pending compile requests? |
|
|
HasSystemScriptDIsWithPerInstanceData() |
||
|
InvalidateActiveCompiles() |
Invalidates any active compilation requests which will ignore their results. |
|
|
IsLooping() |
||
|
IsReadyToRun() |
||
|
IsValid() |
Returns true if this system is valid and can be instanced. False otherwise. |
|
|
NeedsGPUContextInitForDataInterfaces() |
||
|
NeedsSortedSignificanceCull() |
||
|
NeedsWarmup() |
||
|
OnScalabilityCVarChanged() |
||
|
FOnSystemCom... |
OnSystemCompiled() |
Delegate called when the system's dependencies have all been compiled. |
|
FOnSystemPos... |
OnSystemPostEditChange() |
Delegate called on PostEditChange. |
|
PollForCompilationComplete() |
If we have a pending compile request, is it done with yet? |
|
|
RecomputeExecutionOrderForDataInterface ( |
||
|
RecomputeExecutionOrderForEmitter ( |
||
|
ReferencesInstanceEmitter ( |
Determines if this system has the supplied emitter as an editable and simulating emitter instance. |
|
|
RefreshSystemParametersFromEmitter ( |
Updates the system's rapid iteration parameters from a specific emitter. |
|
|
RegisterActiveInstance() |
||
|
RemoveEmitterHandle ( |
Removes the provided emitter handle. |
|
|
RemoveEmitterHandlesById |
Removes the emitter handles which have an Id in the supplied set. |
|
|
RemoveMessage ( |
||
|
RemoveMessageDelegateable ( |
||
|
RemoveSystemParametersForEmitter ( |
Removes the system's rapid iteration parameters for a specific emitter. |
|
|
RequestCompile ( |
Request that any dirty scripts referenced by this system be compiled. |
|
|
RequestCompileForEmitter ( |
||
|
SetBakerGeneratedSettings ( |
||
|
SetEffectType ( |
||
|
SetFixedBounds ( |
||
|
SetIsolateEnabled ( |
||
|
SetOverrideScalabilitySettings ( |
||
|
ShouldAutoDeactivate() |
||
|
UnregisterActiveInstance() |
||
|
UpdateSystemAfterLoad() |
||
|
UsesCollection ( |
||
|
UsesEmitter ( |
||
|
UsesScript ( |
||
|
WaitForCompilationComplete |
Blocks until all active compile jobs have finished |
Name | Description | ||
---|---|---|---|
|
BeginCacheForCookedPlatformData ( |
Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects |
|
|
BeginDestroy() |
Called before destroying the object. |
|
|
GetAssetRegistryTags ( |
Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PreEditChange ( |
This is called when a property is about to be modified externally |
|
|
PreSave ( |
Presave function. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name | Description | ||
---|---|---|---|
|
GetAllSourceScripts() |
Get all UNiagaraScriptSourceBase of this subscriber. |
|
|
GetEditorOnlyParametersAdapters() |
Get All adapters to editor only script vars owned directly by this subscriber. |
|
|
GetOwnedParameterDefinitionsSubscribers() |
Get all subscribers that are owned by this subscriber. |
|
|
GetParameterDefinitionsSubscriptions() |
||
|
const TArray... |
GetParameterDefinitionsSubscriptions() |
|
|
GetSourceObjectPathName() |
Get the path to the UObject of this subscriber. |
Name |
Description |
---|---|
FOnSystemCompiled |
|
FOnSystemPostEditChange |
Name |
Description |
---|---|
kStartNewOverlapGroupBit |
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. |
Name | Description | ||
---|---|---|---|
|
bIsTemplateAsset_DEPRECATED |
||
|
ScalabilityOverrides_DEPRECATED |