UNiagaraParameterCollection | Unreal Engine 5.6 Documentation

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 (MinimalAPI)  
class UNiagaraParameterCollection : public UObject

Remarks

Asset containing a collection of global parameters usable by Niagara. Similar to Material parameter collections, any number of Niagara assets may reference attributes from this parameter collection and will get new values when they are changed.

A Niagara parameter collection can reference a Material parameter collection, so it is in sync with the values provided to a Material. To use a value from a parameter collection in a Niagara system or emitter, add a reference to it from the Parameters panel (in the Niagara Parameter Collection section).

Variables

Type	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< UNiagaraParameterCollectionInstance >	DefaultInstance
FName	FullNamespace	Transient variable holding the full namespace (NPC..)
FName	Namespace	Namespace for this parameter collection. Is enforced to be unique across all parameter collections.
FOnChanged	OnChangedDelegate
TArray< FNiagaraVariable >	Parameters
TObjectPtr< UMaterialParameterCollection >	SourceMaterialCollection	Optional set of MPC that can drive scalar and vector parameters

Constructors

	Type	Name	Description
		UNiagaraParameterCollection ( const FObjectInitializer& ObjectInitializer )

Functions

Type	Name	Description
void	AddDefaultSourceParameters ()
int32	AddParameter ( FName Name, FNiagaraTypeDefinition Type )
int32	AddParameter ( const FNiagaraVariable& Parameter )
void	BuildFullNamespace ()
FNiagaraVariable	CollectionParameterFromFriendlyParameter ( const FNiagaraVariable& FriendlyParameter )	Takes the real parameter name used under the hood and converts to the friendly name for use in the UI.
FName	ConditionalAddFullNamespace ( FName FriendlyParameterName )
FName	FriendlyNameFromParameterName ( FName ParameterName )
FString	FriendlyNameFromParameterName ( FString ParameterName )
FNiagaraVariable	FriendlyParameterFromCollectionParameter ( const FNiagaraVariable& CollectionParameter )
FNiagaraCompileHash	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.
const UNiagaraParameterCollectionInstance *	GetDefaultInstance ()
UNiagaraParameterCollectionInstance *	GetDefaultInstance ()	TODO: Optional per platform overrides of the above.
FString	GetFullNamespace ()
FName	GetFullNamespaceName ()
FName	GetNamespace ()
const TArray< FNiagaraVariable > &	GetParameters ()
TArray< FNiagaraVariable > &	GetParameters ()
const UMaterialParameterCollection *	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.
FName	ParameterNameFromFriendlyString ( const FString& FriendlyName )
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

Type	Name	Description
void	PostDuplicate ( EDuplicateMode::Type DuplicateMode )
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )	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

Navigation