1. Epic GamesDeveloper
  3. UNiagaraEmitter

UNiagaraEmitter

Niagara Emitters are particle spawners that can be reused for different effects by putting them into Niagara Systems.

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEmitter.h
Include #include "NiagaraEmitter.h"

Syntax

UCLASS&40;MinimalAPI&41;  
class UNiagaraEmitter :  
    public UObject,  
    public INiagaraParameterDefinitionsSubscriber,  
    public FNiagaraVersionedObject

Remarks

Niagara Emitters are particle spawners that can be reused for different effects by putting them into Niagara Systems. Emitters render their particles using different renderers, such as Sprite Renderers or Mesh Renderers to produce different effects.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere assetregistrysearchable FText Category Category to collate this emitter into for "add new emitter" dialogs.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay assetregistrysearchable ENiagaraScriptLibraryVisibility LibraryVisibility If this emitter is exposed to the library, or should be explicitly hidden.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay assetregistrysearchable FText TemplateAssetDescription  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay assetregistrysearchable ENiagaraScriptTemplateSpecification TemplateSpecification  
Public variable UProperty TObjectPtr< UTexture2D > ThumbnailImage Internal: The thumbnail image.
Public variable UProperty Transient FGuid VersionToOpenInEditor This is used as a transient value to open a specific version in the editor

Constructors

  Type Name Description
Public function  

UNiagaraEmitter ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddEventHandler ( FNiagaraEventScriptProperties EventHandler,
FGuid EmitterVersion
)

  
Public function void

AddRenderer ( UNiagaraRendererProperties* Renderer,
FGuid EmitterVersion
)

  
Public function void

AddSimulationStage ( UNiagaraSimulationStageBase* SimulationStage,
FGuid EmitterVersion
)

  
Public function Const bool

CanObtainEmitterAttribute ( const FNiagaraVariableBase& InVarWithUniqueNameNamespace,
FNiagaraTypeDefinition& OutBoundType
)

  
Public function Const bool

CanObtainParticleAttribute ( const FNiagaraVariableBase& InVar,
const FGuid& EmitterVersion,
FNiagaraTypeDefinition& OutBoundType
)

  
Public function Const bool  
Public function Const bool  
Public function void

ChangeParentVersion ( const FGuid& NewParentVersion,
const FGuid& EmitterVersion
)

  
Public function void Makes sure that the default version data is available and fixes old emitter assets.
Public function Static UNiagaraEmitter *

CreateAsDuplicate ( const UNiagaraEmitter& InEmitterToDuplicate,
FName InDuplicateName,
UNiagaraSystem& InDuplicateOwnerSystem
)

 Creates a new emitter by duplicating an existing emitter.
Public function Static UNiagaraEmitter *

CreateWithParentAndOwner ( FVersionedNiagaraEmitter InParentEmitter,
UObject* InOwner,
FName InName,
EObjectFlags FlagMask
)

 Creates a new emitter with the supplied emitter as a parent emitter and the supplied system as its owner.
Public function Static void

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

  
Public function UNiagaraEmitter * Duplicates this emitter, but prevents the duplicate from merging in changes from the parent emitter.
Public function Const void

ForEachVersionData ( TAction Func
)

  
Public function void

ForEachVersionData ( TAction Func
)

  
Public function Const const TSharedPtr< FNiagaraGraphCachedDataBase, ESPMode::ThreadSafe > &

GetCachedTraversalData ( const FGuid& EmitterVersion
)

 Get the cached parameter map traversal for this emitter.
Public function Const FGuid Gets a Guid which is updated any time data in this emitter is changed.
Public function FVersionedNiagaraEmitterData *

GetEmitterData ( const FGuid& VersionGuid
)

 Returns the emitter data for a specific version or nullptr if no such version is found.
Public function Const const FVersionedNiagaraEmitterData *

GetEmitterData ( const FGuid& VersionGuid
)

 Returns the emitter data for a specific version or nullptr if no such version is found.
Public function Static bool  
Public function Const const FVersionedNiagaraEmitterData * Returns the emitter data for latest exposed version.
Public function FVersionedNiagaraEmitterData * Returns the emitter data for latest exposed version.
Public function FNiagaraMessageStore &  
Public function Const TStatId

GetStatID ( bool bGameThread,
bool bConcurrent
)

  
Public function Const const FString &  
Public function void

HandleVariableRemoved ( const FNiagaraVariable& InOldVariable,
bool bUpdateContexts,
FGuid EmitterVersion
)

 Helper method for when a rename has been detected within the graph.
Public function void

HandleVariableRenamed ( const FNiagaraVariable& InOldVariable,
const FNiagaraVariable& InNewVariable,
bool bUpdateContexts,
FGuid EmitterVersion
)

 Helper method for when a rename has been detected within the graph.
Public function Const bool

IsEnabledOnPlatform ( const FString& PlatformName
)

  
Public function Const bool Whether or not this emitter is synchronized with its parent emitter.
Public function TArray< INiagaraMergeManager::FMergeEmitterResults > Merges in any changes from the parent emitter into this emitter.
Public function void

MoveRenderer ( UNiagaraRendererProperties* Renderer,
int32 NewIndex,
FGuid EmitterVersion
)

  
Public function void

MoveSimulationStageToIndex ( UNiagaraSimulationStageBase* SimulationStage,
int32 TargetIndex,
FGuid EmitterVersion
)

  
Public function Virtual Const bool

NeedsLoadForTargetPlatform ( const ITargetPlatform* TargetPlatform
)

  
Public function void  
Public function FOnEmitterCompiled & Callback issued whenever a VM compilation successfully happened (even if the results are a script that cannot be executed due to errors)
Public function FOnEmitterCompiled & Callback issued whenever a VM compilation successfully happened (even if the results are a script that cannot be executed due to errors)
Public function FOnSimStagesChanged &  
Public function FOnEmitterCompiled & Callback issued whenever a GPU compilation successfully happened (even if the results are a script that cannot be executed due to errors)
Public function void

OnPostCompile ( const FGuid& EmitterVersion
)

  
Public function FOnPropertiesChanged &  
Public function FOnRenderersChanged &  
Public function FOnSimStagesChanged &  
Public function Virtual void

PostEditChangeVersionedProperty ( FPropertyChangedEvent& PropertyChangedEvent,
const FGuid& Version
)

  
Public function void Helper method for binding the notifications needed for proper editor integration.
Public function void

RemoveEventHandlerByUsageId ( FGuid EventHandlerUsageId,
FGuid EmitterVersion
)

  
Public function void

RemoveRenderer ( UNiagaraRendererProperties* Renderer,
FGuid EmitterVersion
)

  
Public function void

RemoveSimulationStage ( UNiagaraSimulationStageBase* SimulationStage,
FGuid EmitterVersion
)

  
Public function void

SetEditorData ( UNiagaraEditorDataBase* InEditorData,
const FGuid& VersionGuid
)

  
Public function void

SetParent ( const FVersionedNiagaraEmitter& InParent
)

  
Public function bool

SetUniqueEmitterName ( const FString& InName
)

  
Public function void  
Public function void  

Overridden from UObject

  Type Name Description
Protected function Virtual void Called before destroying the object.
Public function Virtual Const void 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
Public function Virtual Const bool Called during saving to determine if the object is forced to be editor only or not
Public function Virtual void  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

 Called at the end of Rename(), but only if the rename was actually carried out
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from INiagaraParameterDefinitionsSubscriber

  Type Name Description
Public function Virtual TArray< UNiagaraScriptSourceBase * > Get all UNiagaraScriptSourceBase of this subscriber.
Public function Virtual TArray< UNiagaraEditorParametersAdapterBase * > Get All adapters to editor only script vars owned directly by this subscriber.
Public function Virtual Const const TArray< FParameterDefinitionsSubscription > &  
Public function Virtual TArray< FParameterDefinitionsSubscription > &  
Public function Virtual Const FString Get the path to the UObject of this subscriber.

Overridden from FNiagaraVersionedObject

  Type Name Description
Public function Virtual FGuid

AddNewVersion ( int32 MajorVersion,
int32 MinorVersion
)

 Creates a new data entry for the given version number.
Public function Virtual void

DeleteVersion ( const FGuid& VersionGuid
)

 Deletes the version data for an existing version.
Public function Virtual void

DisableVersioning ( const FGuid& VersionGuidToUse
)

 Disables versioning and keeps only the data from the given version guid.
Public function Virtual void Enables versioning for this emitter asset.
Public function Virtual void

ExposeVersion ( const FGuid& VersionGuid
)

 Changes the exposed version. Does nothing if the guid does not exist in the version data.
Public function Virtual Const FNiagaraAssetVersion const *

FindVersionData ( const FGuid& VersionGuid
)

 Returns the version data for the given guid, if it exists. Otherwise returns nullptr.
Public function Virtual Const TArray< FNiagaraAssetVersion > Returns all available versions for this emitter.
Public function Virtual Const FNiagaraAssetVersion Returns the version of the exposed version data (i.e. the version used when adding an emitter to a system)
Public function Virtual TSharedPtr< FNiagaraVersionDataAccessor >

GetVersionDataAccessor ( const FGuid& Version
)

  
Public function Virtual Const bool If true then this script asset uses active version control to track changes.

Classes

  Type Name Description
Public struct PrivateMemberNames    

Typedefs

Name Description
FOnEmitterCompiled  
FOnEventHandlersChanged  
FOnPropertiesChanged  
FOnRenderersChanged  
FOnSimStagesChanged  

Constants

Name Description
EmitterMergeMessageId  

Deprecated Variables

  Type Name Description
Public variable UProperty Meta EParticleAllocationMode AllocationMode_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta TArray< FString > AttributesToPreserve_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta bool bDeterminism_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty bool bExposeToLibrary_DEPRECATED Deprecated library exposure bool.
Public variable UProperty Meta uint32: 1 bFixedBounds_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta uint32: 1 bInterpolatedSpawning_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty bool bIsTemplateAsset_DEPRECATED Deprecated template asset bool. Use the TemplateSpecification enum instead.
Public variable UProperty Meta bool bLocalSpace_DEPRECATED ------------ Most properties below this point are deprecated and stored in the versioned emitter data instead! ------------------------------------------------------------------------------------------
Public variable UProperty uint32: 1 bOverrideGlobalSpawnCountScale_DEPRECATED Legacy bool to control overriding the global spawn count scales.
Public variable UProperty Meta uint32: 1 bRequiresPersistentIDs_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty uint32: 1 bUseMaxDetailLevel_DEPRECATED Whether to use the min detail or not.
Public variable UProperty uint32: 1 bUseMinDetailLevel_DEPRECATED Whether to use the min detail or not.
Public variable UProperty Meta FNiagaraEmitterScriptProperties EmitterSpawnScriptProps_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta FNiagaraEmitterScriptProperties EmitterUpdateScriptProps_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta FBox FixedBounds_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty FNiagaraDetailsLevelScaleOverrides GlobalSpawnCountScaleOverrides_DEPRECATED  
Public variable UProperty Meta TObjectPtr< UNiagaraScriptSourceBase > GraphSource_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty int32 MaxDetailLevel_DEPRECATED  
Public variable UProperty Meta uint32 MaxGPUParticlesSpawnPerFrame_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty int32 MinDetailLevel_DEPRECATED  
Public variable UProperty Meta TArray< TObjectPtr< UNiagaraScript > > ParentScratchPadScripts_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta FNiagaraPlatformSet Platforms_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta int32 PreAllocationCount_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta int32 RandomSeed_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta FNiagaraParameterStore RendererBindings_DEPRECATED  
Public variable UProperty Meta FNiagaraEmitterScalabilityOverrides ScalabilityOverrides_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta TArray< TObjectPtr< UNiagaraScript > > ScratchPadScripts_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta ENiagaraSimTarget SimTarget_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta FNiagaraEmitterScriptProperties SpawnScriptProps_DEPRECATED Use property in struct returned from GetEmitterData() instead
Public variable UProperty Meta FNiagaraEmitterScriptProperties UpdateScriptProps_DEPRECATED Use property in struct returned from GetEmitterData() instead

Deprecated Functions

  Type Name Description
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

 Use version that takes FObjectPreSaveContext instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page