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

Light Theme

Dark Theme

UNiagaraParameterCollection

Asset containing a collection of global parameters usable by Niagara.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraParameterCollection

References

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

Syntax

UCLASS()
class UNiagaraParameterCollection : public UObject

Remarks

Asset containing a collection of global parameters usable by Niagara.

Variables

	Name	Description
FGuid	CompileId	Used to track whenever something of note changes in this parameter collection that might invalidate a compilation downstream of a script/emitter/system.
TObjectPtr< UNi...	DefaultInstance
FName	Namespace	Namespace for this parameter collection. Is enforced to be unique across all parameter collections.
FOnChanged	OnChangedDelegate
TArray< FNiagar...	Parameters
TObjectPtr< UMa...	SourceMaterialCollection	Optional set of MPC that can drive scalar and vector parameters

Constructors

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

Functions

	Name	Description
void	AddDefaultSourceParameters()
int32	AddParameter ( const FNiagaraVariable& Parameter )
int32	AddParameter ( FName Name, FNiagaraTypeDefinition Type )
FNiagaraVari...	CollectionParameterFromFriendlyParameter ( const FNiagaraVariable& FriendlyPa... )	Takes the real parameter name used under the hood and converts to the friendly name for use in the UI.
FString	FriendlyNameFromParameterName ( FString ParameterName )
FNiagaraVari...	FriendlyParameterFromCollectionParameter ( const FNiagaraVariable& Collection... )
FNiagaraComp...	GetCompileHash()	The compile Id is an indicator to any compiled scripts that reference this collection that contents may have changed and a recompile is recommended to be safe.
UNiagaraPara...	GetDefaultInstance()	TODO: Optional per platform overrides of the above.
FString	GetFullNamespace()
FName	GetNamespace()
TArray< FNia...	GetParameters()
const UMater...	GetSourceCollection()
int32	IndexOfParameter ( const FNiagaraVariable& Var )
void	MakeNamespaceNameUnique()
FString	ParameterNameFromFriendlyName ( const FString& FriendlyName )	Takes the friendly name presented to the UI and converts to the real parameter name used under the hood.
void	RefreshCompileId()	If for any reason this data has changed externally and needs recompilation and it isn't autodetected, use this method.
void	RemoveParameter ( const FNiagaraVariable& Parameter )
void	RenameParameter ( FNiagaraVariable& Parameter, FName NewName )

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name	Description
FOnChanged

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

Take our survey

Cancel