Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > UNiagaraEmitter

Light Theme

Dark Theme

UNiagaraEmitter

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

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraEmitter

References

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

Syntax

UCLASS(MinimalAPI)
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

	Name	Description
FText	Category	Category to collate this emitter into for "add new emitter" dialogs.
ENiagaraScriptL...	LibraryVisibility	If this emitter is exposed to the library, or should be explicitly hidden.
FText	TemplateAssetDescription
ENiagaraScriptT...	TemplateSpecification
TObjectPtr< UTe...	ThumbnailImage	Internal: The thumbnail image.
FGuid	VersionToOpenInEditor	This is used as a transient value to open a specific version in the editor

Constructors

	Name	Description
	UNiagaraEmitter ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddEventHandler ( FNiagaraEventScriptProperties Event..., FGuid EmitterVersion )
void	AddMessage ( const FGuid& MessageKey, UNiagaraMessageDataBase* NewMe... )
void	AddRenderer ( UNiagaraRendererProperties* Re..., FGuid EmitterVersion )
void	AddSimulationStage ( UNiagaraSimulationStageBase* S..., FGuid EmitterVersion )
bool	CanObtainEmitterAttribute ( const FNiagaraVariableBase& InVarW..., FNiagaraTypeDefinition& OutBoundTy... )
bool	CanObtainParticleAttribute ( const FNiagaraVariableBase& InVar, const FGuid& EmitterVersion, FNiagaraTypeDefinition& OutBoundTy... )
bool	CanObtainSystemAttribute ( const FNiagaraVariableBase& InVar, FNiagaraTypeDefinition& OutBoundTy... )
bool	CanObtainUserVariable ( const FNiagaraVariableBase& InVar )
void	ChangeParentVersion ( const FGuid& NewParentVersion, const FGuid& EmitterVersion )
void	CheckVersionDataAvailable()	Makes sure that the default version data is available and fixes old emitter assets.
UNiagaraEmit...	CreateAsDuplicate ( const UNiagaraEmitter& InEmitterTo..., FName InDuplicateName, UNiagaraSystem& InDuplicateOwnerSy... )	Creates a new emitter by duplicating an existing emitter.
UNiagaraEmit...	CreateWithParentAndOwner ( FVersionedNiagaraEmitter InParentEm..., 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.
void	DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutC..., const UClass* SpecificSubclass )
UNiagaraEmit...	DuplicateWithoutMerging ( UObject* InOuter )	Duplicates this emitter, but prevents the duplicate from merging in changes from the parent emitter.
void	ForEachVersionData ( TAction Func )
const TShare...	GetCachedTraversalData ( const FGuid& EmitterVersion )	Get the cached parameter map traversal for this emitter.
FGuid	GetChangeId()	Gets a Guid which is updated any time data in this emitter is changed.
const FVersi...	GetEmitterData ( const FGuid& VersionGuid )	Returns the emitter data for a specific version or nullptr if no such version is found.
FVersionedNi...	GetEmitterData ( const FGuid& VersionGuid )	Returns the emitter data for a specific version or nullptr if no such version is found.
bool	GetForceCompileOnLoad()
const FVersi...	GetLatestEmitterData()	Returns the emitter data for latest exposed version.
FVersionedNi...	GetLatestEmitterData()	Returns the emitter data for latest exposed version.
const TMap< ...	GetMessages()
TStatId	GetStatID ( bool bGameThread, bool bConcurrent )
const FStrin...	GetUniqueEmitterName()
void	HandleVariableRemoved ( const FNiagaraVariable& InOldVaria..., bool bUpdateContexts, FGuid EmitterVersion )	Helper method for when a rename has been detected within the graph.
void	HandleVariableRenamed ( const FNiagaraVariable& InOldVaria..., const FNiagaraVariable& InNewVaria..., bool bUpdateContexts, FGuid EmitterVersion )	Helper method for when a rename has been detected within the graph.
bool	IsEnabledOnPlatform ( const FString& PlatformName )
bool	IsSynchronizedWithParent()	Whether or not this emitter is synchronized with its parent emitter.
TArray< INia...	MergeChangesFromParent()	Merges in any changes from the parent emitter into this emitter.
void	MoveRenderer ( UNiagaraRendererProperties* Re..., int32 NewIndex, FGuid EmitterVersion )
void	MoveSimulationStageToIndex ( UNiagaraSimulationStageBase* S..., int32 TargetIndex, FGuid EmitterVersion )
bool	NeedsLoadForTargetPlatform ( const ITargetPlatform* TargetP... )
void	NotifyScratchPadScriptsChanged()
FOnEmitterCo...	OnEmitterGPUCompiled()	Callback issued whenever a VM compilation successfully happened (even if the results are a script that cannot be executed due to errors)
FOnEmitterCo...	OnEmitterVMCompiled()	Callback issued whenever a VM compilation successfully happened (even if the results are a script that cannot be executed due to errors)
FOnEmitterCo...	OnGPUCompilationComplete()	Callback issued whenever a GPU compilation successfully happened (even if the results are a script that cannot be executed due to errors)
void	OnPostCompile ( const FGuid& EmitterVersion )
FOnPropertie...	OnPropertiesChanged()
FOnRenderers...	OnRenderersChanged()
void	PostEditChangeVersionedProperty ( FPropertyChangedEvent& PropertyCha..., const FGuid& Version )
void	RebindNotifications()	Helper method for binding the notifications needed for proper editor integration.
void	RemoveEventHandlerByUsageId ( FGuid EventHandlerUsageId, FGuid EmitterVersion )
void	RemoveMessage ( const FGuid& MessageKey )
void	RemoveMessageDelegateable ( const FGuid MessageKey )
void	RemoveRenderer ( UNiagaraRendererProperties* Re..., FGuid EmitterVersion )
void	RemoveSimulationStage ( UNiagaraSimulationStageBase* S..., FGuid EmitterVersion )
void	SetEditorData ( UNiagaraEditorDataBase* InEdit..., const FGuid& VersionGuid )
void	SetParent ( const FVersionedNiagaraEmitter& In... )
bool	SetUniqueEmitterName ( const FString& InName )
void	UpdateEmitterAfterLoad()
void	UpdateScalability()

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	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
bool	IsEditorOnly()	Called during saving to determine if the object is forced to be editor only or not
void	PostDuplicate ( EDuplicateMode::Type DuplicateMode )
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PostRename ( UObject* OldOuter, const FName OldName )	Called at the end of Rename(), but only if the rename was actually carried out
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from INiagaraParameterDefinitionsSubscriber

	Name	Description
TArray< UNia...	GetAllSourceScripts()	Get all UNiagaraScriptSourceBase of this subscriber.
TArray< UNia...	GetEditorOnlyParametersAdapters()	Get All adapters to editor only script vars owned directly by this subscriber.
const TArray...	GetParameterDefinitionsSubscriptions()
TArray< FPar...	GetParameterDefinitionsSubscriptions()
FString	GetSourceObjectPathName()	Get the path to the UObject of this subscriber.

Overridden from FNiagaraVersionedObject

	Name	Description
FGuid	AddNewVersion ( int32 MajorVersion, int32 MinorVersion )	Creates a new data entry for the given version number.
void	DeleteVersion ( const FGuid& VersionGuid )	Deletes the version data for an existing version.
void	DisableVersioning ( const FGuid& VersionGuidToUse )	Disables versioning and keeps only the data from the given version guid.
void	EnableVersioning()	Enables versioning for this emitter asset.
void	ExposeVersion ( const FGuid& VersionGuid )	Changes the exposed version. Does nothing if the guid does not exist in the version data.
FNiagaraAsse...	FindVersionData ( const FGuid& VersionGuid )	Returns the version data for the given guid, if it exists. Otherwise returns nullptr.
TArray< FNia...	GetAllAvailableVersions()	Returns all available versions for this emitter.
FNiagaraAsse...	GetExposedVersion()	Returns the version of the exposed version data (i.e. the version used when adding an emitter to a system)
TSharedPtr< ...	GetVersionDataAccessor ( const FGuid& Version )
bool	IsVersioningEnabled()	If true then this script asset uses active version control to track changes.

Classes

	Name	Description
	PrivateMemberNames

Typedefs

Name	Description
FOnEmitterCompiled
FOnPropertiesChanged
FOnRenderersChanged

Constants

Name	Description
EmitterMergeMessageId

Deprecated Variables

	Name	Description
EParticleAlloca...	AllocationMode_DEPRECATED	Use property in struct returned from GetEmitterData() instead
TArray< FString...	AttributesToPreserve_DEPRECATED	Use property in struct returned from GetEmitterData() instead
uint32: 1	bCombineEventSpawn_DEPRECATED	Use property in struct returned from GetEmitterData() instead
bool	bDeterminism_DEPRECATED	Use property in struct returned from GetEmitterData() instead
bool	bExposeToLibrary_DEPRECATED	Deprecated library exposure bool.
uint32: 1	bFixedBounds_DEPRECATED	Use property in struct returned from GetEmitterData() instead
uint32: 1	bInterpolatedSpawning_DEPRECATED	Use property in struct returned from GetEmitterData() instead
bool	bIsTemplateAsset_DEPRECATED	Deprecated template asset bool. Use the TemplateSpecification enum instead.
uint32: 1	bLimitDeltaTime_DEPRECATED	Use property in struct returned from GetEmitterData() instead
bool	bLocalSpace_DEPRECATED	------------ Most properties below this point are deprecated and stored in the versioned emitter data instead! ------------------------------------------------------------------------------------------
uint32: 1	bOverrideGlobalSpawnCountScale_DEPRECATED	Legacy bool to control overriding the global spawn count scales.
uint32: 1	bRequiresPersistentIDs_DEPRECATED	Use property in struct returned from GetEmitterData() instead
uint32: 1	bUseMaxDetailLevel_DEPRECATED	Whether to use the min detail or not.
uint32: 1	bUseMinDetailLevel_DEPRECATED	Whether to use the min detail or not.
FNiagaraEmitter...	EmitterSpawnScriptProps_DEPRECATED	Use property in struct returned from GetEmitterData() instead
FNiagaraEmitter...	EmitterUpdateScriptProps_DEPRECATED	Use property in struct returned from GetEmitterData() instead
FBox	FixedBounds_DEPRECATED	Use property in struct returned from GetEmitterData() instead
FNiagaraDetails...	GlobalSpawnCountScaleOverrides_DEPRECATED
TObjectPtr< UNi...	GraphSource_DEPRECATED	Use property in struct returned from GetEmitterData() instead
float	MaxDeltaTimePerTick_DEPRECATED	Use property in struct returned from GetEmitterData() instead
int32	MaxDetailLevel_DEPRECATED
uint32	MaxGPUParticlesSpawnPerFrame_DEPRECATED	Use property in struct returned from GetEmitterData() instead
int32	MinDetailLevel_DEPRECATED
TArray< TObject...	ParentScratchPadScripts_DEPRECATED	Use property in struct returned from GetEmitterData() instead
FNiagaraPlatfor...	Platforms_DEPRECATED	Use property in struct returned from GetEmitterData() instead
int32	PreAllocationCount_DEPRECATED	Use property in struct returned from GetEmitterData() instead
int32	RandomSeed_DEPRECATED	Use property in struct returned from GetEmitterData() instead
FNiagaraParamet...	RendererBindings_DEPRECATED
FNiagaraEmitter...	ScalabilityOverrides_DEPRECATED	Use property in struct returned from GetEmitterData() instead
TArray< TObject...	ScratchPadScripts_DEPRECATED	Use property in struct returned from GetEmitterData() instead
ENiagaraSimTarg...	SimTarget_DEPRECATED	Use property in struct returned from GetEmitterData() instead
FNiagaraEmitter...	SpawnScriptProps_DEPRECATED	Use property in struct returned from GetEmitterData() instead
FNiagaraEmitter...	UpdateScriptProps_DEPRECATED	Use property in struct returned from GetEmitterData() instead

Deprecated Functions

		Name	Description
	PRAGMA_DISAB...	PreSave ( FObjectPreSaveContext ObjectSaveCon... )	Use version that takes FObjectPreSaveContext instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel