Navigation
API > API/Plugins > API/Plugins/Niagara
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).
| Name | UNiagaraParameterCollection |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraParameterCollection.h |
| Include Path | #include "NiagaraParameterCollection.h" |
Syntax
UCLASS (MinimalAPI)
class UNiagaraParameterCollection : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraParameterCollection
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraParameterCollection
(
const FObjectInitializer& ObjectInitializer |
NiagaraParameterCollection.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCollectionChanged | TMulticastDelegate_NoParams< void > | NiagaraParameterCollection.h | |
| FOnParameterValuesChanged | TMulticastDelegate_OneParam< void, TConstArrayView< FName > > | NiagaraParameterCollection.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnCollectionChangedDelegate | FOnCollectionChanged | NiagaraParameterCollection.h | ||
| OnMaterialParametersChanged | FOnParameterValuesChanged | Invoked when the collection's material source is updated with new parameter values | NiagaraParameterCollection.h | |
| OnParameterValuesEdited | FOnParameterValuesChanged | Invoked when the collection's default values are updated from the NPC editor | NiagaraParameterCollection.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 AddParameter
(
FName Name, |
NiagaraParameterCollection.h | ||
int32 AddParameter
(
const FNiagaraVariable& Parameter |
NiagaraParameterCollection.h | ||
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. | NiagaraParameterCollection.h | |
| NiagaraParameterCollection.h | |||
FName FriendlyNameFromParameterName
(
FName ParameterName |
NiagaraParameterCollection.h | ||
FString FriendlyNameFromParameterName
(
FString ParameterName |
NiagaraParameterCollection.h | ||
FNiagaraVariable FriendlyParameterFromCollectionParameter
(
const FNiagaraVariable& CollectionParameter |
NiagaraParameterCollection.h | ||
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. | NiagaraParameterCollection.h | |
| NiagaraParameterCollection.h | |||
| TODO: Optional per platform overrides of the above. | NiagaraParameterCollection.h | ||
FString GetFullNamespace() |
NiagaraParameterCollection.h | ||
FName GetFullNamespaceName() |
NiagaraParameterCollection.h | ||
FName GetNamespace() |
NiagaraParameterCollection.h | ||
TArray< FNiagaraVariable > & GetParameters () |
NiagaraParameterCollection.h | ||
const TArray< FNiagaraVariable > & GetParameters () |
NiagaraParameterCollection.h | ||
const UMaterialParameterCollection * GetSourceCollection() |
NiagaraParameterCollection.h | ||
int32 IndexOfParameter
(
const FNiagaraVariable& Var |
NiagaraParameterCollection.h | ||
FString ParameterNameFromFriendlyName
(
const FString& FriendlyName |
Takes the friendly name presented to the UI and converts to the real parameter name used under the hood. | NiagaraParameterCollection.h | |
| NiagaraParameterCollection.h | |||
void RefreshCompileId() |
If for any reason this data has changed externally and needs recompilation and it isn't autodetected, use this method. | NiagaraParameterCollection.h | |
void RemoveParameter
(
const FNiagaraVariable& Parameter |
NiagaraParameterCollection.h | ||
void RenameParameter
(
FNiagaraVariable& Parameter, |
NiagaraParameterCollection.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
NiagaraParameterCollection.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
NiagaraParameterCollection.h | ||
virtual void PostEditUndo() |
NiagaraParameterCollection.h | ||
virtual void PostLoad() |
NiagaraParameterCollection.h | ||
virtual void PreEditChange
(
FProperty* PropertyAboutToChange |
NiagaraParameterCollection.h | ||
virtual void PreEditUndo() |
NiagaraParameterCollection.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BuildFullNamespace() |
NiagaraParameterCollection.h | ||
void MakeNamespaceNameUnique() |
NiagaraParameterCollection.h | ||
void NamespaceChanged() |
NiagaraParameterCollection.h | ||
void RefreshSourceMaterialCollection() |
NiagaraParameterCollection.h |