UNiagaraSystem

Container for multiple emitters that combine together to create a particle system effect.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSystem.h

Include

#include "NiagaraSystem.h"

Syntax

UCLASS (BlueprintType)
class UNiagaraSystem : public UFXSystemAsset

Remarks

Container for multiple emitters that combine together to create a particle system effect.

Variables

Name Description

Protected variable UProperty Transient

TArray < FNiagar ...

 

ActiveCompilations

Protected variable UProperty Category, EditAnywhere, Meta

bool

 

bAutoDeactivate

Public variable UProperty Category, EditAnywhere, AdvancedDisplay

uint32 : 1

 

bBakeOutRapidIteration

Experimental feature that allows us to bake out rapid iteration parameters during the normal compile process.

Public variable UProperty Category, EditAnywhere

bool

 

bDumpDebugEmitterInfo

Public variable UProperty Category, EditAnywhere

bool

 

bDumpDebugSystemInfo

Public variable UProperty Category, EditAnywhere, AdvancedDisplay assetregistrysearchable

bool

 

bExposeToLibrary

If this system is exposed to the library.

Public variable UProperty Category, EditAnywhere, Meta

uint32 : 1

 

bFixedBounds

Whether or not fixed bounds are enabled.

Protected variable UProperty

bool

 

bHasSystemScriptDIsWithPerInstanceData

Protected variable

bool

 

bIsolateEnabled

Public variable UProperty Category, EditAnywhere, AdvancedDisplay assetregistrysearchable

bool

 

bIsTemplateAsset

Protected variable UProperty Category, EditAnywhere, Meta

bool

 

bOverrideScalabilitySettings

Protected variable

FNiagaraSystemS ...

 

CurrentScalabilitySettings

Protected variable UProperty

UNiagaraEditorD ...

 

EditorData

Data used by the editor to maintain UI state etc..

Public variable UProperty Transient

FNiagaraParamet ...

 

EditorOnlyAddedParameters

Protected variable UProperty Category, EditAnywhere

UNiagaraEffectT ...

 

EffectType

Protected variable

TArray < TShared ...

 

EmitterCompiledData

Protected variable UProperty

TArray < FNiagar ...

 

EmitterHandles

Handles to the emitter this System will simulate.

Protected variable UProperty

FNiagaraUserRed ...

 

ExposedParameters

Variables exposed to the outside work for tweaking

Protected variable UProperty Category, EditAnywhere, Meta

FBox

 

FixedBounds

The fixed bounding box value. bFixedBounds is the condition whether the fixed bounds can be edited.

Protected variable

FOnSystemCompil ...

 

OnSystemCompiledDelegate

A multicast delegate which is called whenever the script has been compiled (successfully or not).

Protected variable

FOnSystemPostEd ...

 

OnSystemPostEditChangeDelegate

A multicast delegate which is called whenever this system's properties are changed.

Protected variable UProperty Category, EditAnywhere

TArray < UNiagar ...

 

ParameterCollectionOverrides

Public variable UProperty

TArray < UNiagar ...

 

ScratchPadScripts

Protected variable UProperty

FNiagaraSystemC ...

 

SystemCompiledData

Protected variable UProperty Category, EditAnywhere, Meta

FNiagaraSystemS ...

 

SystemScalabilityOverrides

Protected variable UProperty

UNiagaraScript ...

 

SystemSpawnScript

/** Category of this system. */

Protected variable UProperty

UNiagaraScript ...

 

SystemUpdateScript

The script which defines the System parameters, and which generates the bindings from System parameter to emitter parameter.

Public variable UProperty Category, EditAnywhere, AdvancedDisplay assetregistrysearchable

FText

 

TemplateAssetDescription

Public variable UProperty

UTexture2D *...

 

ThumbnailImage

Internal: The thumbnail image.

Public variable UProperty

uint32 : 1

 

ThumbnailImageOutOfDate

Internal: Indicates the thumbnail image is out of date.

Public variable UProperty Transient

FNiagaraSystemU ...

 

UpdateContext

Protected variable UProperty

TArray < FName >

 

UserDINamesReadInSystemScripts

Protected variable UProperty Category, EditAnywhere

int32

 

WarmupTickCount

Number of ticks to process for warmup. You can set by this or by time via WarmupTime.

Protected variable UProperty Category, EditAnywhere

float

 

WarmupTickDelta

Delta time to use for warmup ticks.

Protected variable UProperty Category, EditAnywhere

float

 

WarmupTime

Warm up time in seconds.

Constructors

Name Description

Public function

UNiagaraSystem

(
    const FObjectInitializer & ObjectIn...
)

Public function

UNiagaraSystem

(
    FVTableHelper & Helper
)

Functions

Name Description

Public function

FNiagaraEmit ...

 

AddEmitterHandle

(
    UNiagaraEmitter & SourceEmitter,
    FName EmitterName
)

Adds a new emitter handle to this System.

Public function Const

void

 

AddToInstanceCountStat

(
    int32 NumInstances,
    bool bSolo
)

Public function

FNiagaraEmit ...

 

DuplicateEmitterHandle

(
    const FNiagaraEmitterHandle & Emitt...,
    FName EmitterName
)

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

Public function

void

 

ForceGraphToRecompileOnNextCheck()

Protected function Const

void

 

GenerateStatID()

Public function

int32 *

 

GetCycleCounter

(
    bool bGameThread,
    bool bConcurrent
)

Public function Const

const UNiaga ...

 

GetEditorData()

Gets editor specific data stored with this system.

Public function

UNiagaraEdit ...

 

GetEditorData()

Gets editor specific data stored with this system.

Public function Const

UNiagaraEffe ...

 

GetEffectType()

Public function Const

const TArray ...

 

GetEmitterCompiledData()

Public function Const

const FNiaga ...

 

GetEmitterHandle

(
    int Idx
)

Public function

FNiagaraEmit ...

 

GetEmitterHandle

(
    int Idx
)

Public function Const

const TArray ...

 

GetEmitterHandles()

Gets an array of the emitter handles.

Public function

const TArray ...

 

GetEmitterHandles()

Gets an array of the emitter handles.

Public function

FNiagaraUser ...

 

GetExposedParameters()

Public function Const

const FNiaga ...

 

GetExposedParameters()

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

Public function Const

FBox

 

GetFixedBounds()

Public function Const

bool

 

GetIsolateEnabled()

Public function

int

 

GetNumEmitters()

Public function Const

bool

 

GetOverrideScalabilitySettings()

Public function

UNiagaraPara ...

 

GetParameterCollectionOverride

(
    UNiagaraParameterCollection * C...
)

Public function

const FNiaga ...

 

GetScalabilitySettings()

Public function Const

TStatId

 

GetStatID

(
    bool bGameThread,
    bool bConcurrent
)

Public function Const

const FNiaga ...

 

GetSystemCompiledData()

Public function

UNiagaraScri ...

 

GetSystemSpawnScript()

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

Public function

UNiagaraScri ...

 

GetSystemUpdateScript()

Public function Const

const TArray ...

 

GetUserDINamesReadInSystemScripts()

Public function Const

int32

 

GetWarmupTickCount()

Public function Const

float

 

GetWarmupTickDelta()

Public function Const

float

 

GetWarmupTime()

Public function Const

bool

 

HasOutstandingCompilationRequests()

Are there any pending compile requests?

Public function Const

bool

 

HasSystemScriptDIsWithPerInstanceData()

Public function

void

 

InvalidateActiveCompiles()

Invalidates any active compilation requests which will ignore their results.

Public function Const

bool

 

IsLooping()

Public function Const

bool

 

IsReadyToRun()

Public function Const

bool

 

IsValid()

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

Public function Virtual Const

bool

 

NeedsLoadForTargetPlatform

(
    const ITargetPlatform * TargetP...
)

Public function Const

bool

 

NeedsWarmup()

Public function

void

 

OnQualityLevelChanged()

Public function

FOnSystemCom ...

 

OnSystemCompiled()

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

Public function

FOnSystemPos ...

 

OnSystemPostEditChange()

Delegate called on PostEditChange.

Public function

bool

 

PollForCompilationComplete()

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

Public function

bool

 

ReferencesInstanceEmitter

(
    UNiagaraEmitter & Emitter
)

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

Public function

void

 

RefreshSystemParametersFromEmitter

(
    const FNiagaraEmitterHandle & Emitt...
)

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

Public function

void

 

RemoveEmitterHandle

(
    const FNiagaraEmitterHandle & Emitt...
)

Removes the provided emitter handle.

Public function

void

 

RemoveEmitterHandlesById

(
    const TSet < FGuid >& HandlesToRemo...
)

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

Public function

void

 

RemoveSystemParametersForEmitter

(
    const FNiagaraEmitterHandle & Emitt...
)

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

Public function

bool

 

RequestCompile

(
    bool bForce,
    FNiagaraSystemUpdateContext * O...
)

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

Public function Static

void

 

RequestCompileForEmitter

(
    UNiagaraEmitter * InEmitter
)

Public function

void

 

SetEffectType

(
    UNiagaraEffectType * EffectType
)

Public function

void

 

SetIsolateEnabled

(
    bool bIsolate
)

Public function

void

 

SetOverrideScalabilitySettings

(
    bool bOverride
)

Public function Const

bool

 

ShouldAutoDeactivate()

Public function Const

bool

 

UsesCollection

(
    const UNiagaraParameterCollection &...
)

Public function Const

bool

 

UsesEmitter

(
    const UNiagaraEmitter * Emitter
)

Public function Const

bool

 

UsesScript

(
    const UNiagaraScript * Script
)

Public function

void

 

WaitForCompilationComplete()

Blocks until all active compile jobs have finished

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginCacheForCookedPlatformData

(
    const ITargetPlatform * TargetP...
)

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

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreEditChange

(
    FProperty * PropertyAboutToChan...
)

This is called when a property is about to be modified externally

Public function Virtual

void

 

PreSave

(
    const ITargetPlatform * TargetP...
)

Presave function.

Public function Virtual

void

 

Serialize

(
    FArchive & Ar
)

Handles reading, writing, and reference collecting using FArchive .

Typedefs

Deprecated Variables

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback