Choose your operating system:
Windows
macOS
Linux
| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSystem.h |
Include |
#include "NiagaraSystem.h" |
UCLASS(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 |
||
|
TObjectPtr< UNi... |
BakerGeneratedSettings |
Generated data baker settings, will be null until we have generated at least once. |
|
TObjectPtr< UNi... |
BakerSettings |
Settings used inside the baker |
|
uint32: 1 |
bAllDIsPostSimulateCanOverlapFrames |
|
|
bAllowCullingForLocalPlayers |
||
|
uint32: 1 |
bAllowCullingForLocalPlayersOverride |
The override value for bAllowCullingForLocalPlayers from the Effect Type. |
|
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 |
|
uint8: 1 |
bCastShadow |
When enabled this is the default value set on the component. |
|
bCompilationReentrantGuard |
||
|
uint32: 1 |
bCompressAttributes |
Toggles whether or not emitters within this system will try and compress their particle attributes. |
|
bDeterminism |
When disabled we will generate a RandomSeed per instance on reset which is not deterministic. |
|
|
uint32: 1 |
bDisableDebugSwitches |
If true all debug switches will be ignored in the editor. |
|
uint32: 1 |
bDisableDebugSwitchesOnCook |
If true all debug switches will be ignored for cooked builds |
|
bDumpDebugEmitterInfo |
||
|
bDumpDebugSystemInfo |
||
|
uint32: 1 |
bFixedBounds |
Whether or not fixed bounds are enabled. |
|
bFixedTickDelta |
||
|
bFullyLoaded |
||
|
uint32: 1 |
bHasAnyGPUEmitters |
|
|
uint32: 1 |
bHasDIsWithPostSimulateTick |
|
|
bHasSystemScriptDIsWithPerInstanceData |
||
|
uint32: 1 |
bIgnoreParticleReadsForAttributeTrim |
If true ParticleReads will not absolutely prevent attribute trimming - User must ensure that the appropriate attributes are preserved on the source emitter! |
|
bIsolateEnabled |
||
|
uint32: 1 |
bIsReadyToRunCached |
|
|
uint32: 1 |
bIsValidCached |
|
|
uint32: 1 |
bLwcEnabledSettingCached |
|
|
uint32: 1 |
bNeedsAsyncOptimize |
|
|
bNeedsGPUContextInitForDataInterfaces |
||
|
uint32: 1 |
bNeedsSortedSignificanceCull |
|
|
uint32: 1 |
bOverrideAllowCullingForLocalPlayers |
Controls whether we should override the Effect Type value for bAllowCullingForLocalPlayers. |
|
uint8: 1 |
bOverrideCastShadow |
Various optional overrides for component properties when spawning a system. |
|
uint8: 1 |
bOverrideCustomDepthStencilValue |
|
|
uint8: 1 |
bOverrideCustomDepthStencilWriteMask |
|
|
uint8: 1 |
bOverrideReceivesDecals |
|
|
uint8: 1 |
bOverrideRenderCustomDepth |
|
|
bOverrideScalabilitySettings |
||
|
uint8: 1 |
bReceivesDecals |
When enabled this is the default value set on the component. Whether the primitive receives decals. |
|
uint8: 1 |
bRenderCustomDepth |
When enabled this is the default value set on the component. |
|
bRequireCurrentFrameData |
When enabled, we follow the settings on the UNiagaraComponent for tick order. |
|
|
uint8: 1 |
bSupportLargeWorldCoordinates |
If true then position type values will be rebased on system activation to fit into a float precision vector. |
|
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 |
|
TSharedPtr< FNi... |
CachedTraversalData |
|
|
Category |
Category of this system. |
|
|
CrashReporterTag |
||
|
CurrentScalabilitySettings |
Scalability settings. |
|
|
CustomDepthStencilValue |
When enabled this is the default value set on the component. |
|
|
CustomDepthStencilWriteMask |
When enabled this is the default value set on the component. Mask used for stencil buffer writes. |
|
|
TObjectPtr< UNi... |
EditorData |
Data used by the editor to maintain UI state etc.. |
|
EditorOnlyAddedParameters |
||
|
TObjectPtr< UNi... |
EditorParameters |
Wrapper for editor only parameters. |
|
TObjectPtr< UNi... |
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. |
|
|
float |
FixedTickDeltaTime |
If activated, the system ticks with a fixed delta time instead of the varying game thread delta time. |
|
LibraryVisibility |
If this system is exposed to the library, or should be explicitly hidden. |
|
|
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. |
|
|
RandomSeed |
Seed used for system script random number generator. |
|
|
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 |
||
|
ScriptOptimizationCompletionEvent |
||
|
TUniquePtr< FNi... |
StaticBuffers |
|
|
SystemCompiledData |
||
|
SystemExecutionStateAccessor |
||
|
SystemScalabilityOverrides |
||
|
TObjectPtr< UNi... |
SystemSpawnScript |
The script which defines the System parameters, and which generates the bindings from System parameter to emitter parameter. |
|
TObjectPtr< UNi... |
SystemUpdateScript |
The script which defines the System parameters, and which generates the bindings from System parameter to emitter parameter. |
|
TemplateAssetDescription |
||
|
TemplateSpecification |
If this system is a regular system, a template or a behavior example. |
|
|
TObjectPtr< cla... |
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 | ||
---|---|---|---|
|
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 | ||
---|---|---|---|
|
bExposeToLibrary_DEPRECATED |
Deprecated library exposure bool. |
|
|
bIsTemplateAsset_DEPRECATED |
Deprecated template asset bool. Use the TemplateSpecification enum instead. |
|
|
ScalabilityOverrides_DEPRECATED |
Name | Description | ||
---|---|---|---|
|
PreSave ( |
Use version that takes FObjectPreSaveContext instead. |