1. Epic GamesDeveloper
  3. UNiagaraParameterCollection

UNiagaraParameterCollection

Asset containing a collection of global parameters usable by Niagara.

Unreal Engine C++ API Reference > Plugins > Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;MinimalAPI&41;  
class UNiagaraParameterCollection : public UObject

Remarks

Asset containing a collection of global parameters usable by Niagara.

Variables

  Type Name Description
Protected variable UProperty 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.
Protected variable UProperty TObjectPtr< UNiagaraParameterCollectionInstance > DefaultInstance  
Protected variable UProperty Category, EditAnywhere assetregistrysearchable FName Namespace Namespace for this parameter collection. Is enforced to be unique across all parameter collections.
Public variable FOnChanged OnChangedDelegate  
Protected variable UProperty TArray< FNiagaraVariable > Parameters  
Protected variable UProperty Category, EditAnywhere TObjectPtr< UMaterialParameterCollection > SourceMaterialCollection Optional set of MPC that can drive scalar and vector parameters

Constructors

  Type Name Description
Public function  

UNiagaraParameterCollection ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Public function int32  
Public function int32

AddParameter ( const FNiagaraVariable& Parameter
)

  
Public function Const FNiagaraVariable Takes the real parameter name used under the hood and converts to the friendly name for use in the UI.
Public function Const FString  
Public function Const FNiagaraVariable  
Public function Const FNiagaraCompileHash 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.
Public function Const const UNiagaraParameterCollectionInstance *  
Public function UNiagaraParameterCollectionInstance * TODO: Optional per platform overrides of the above.
Public function Const FString  
Public function Const FName  
Public function Const const TArray< FNiagaraVariable > &  
Public function TArray< FNiagaraVariable > &  
Public function Const const UMaterialParameterCollection *  
Public function int32  
Protected function void  
Public function Const FString
ParameterNameFromFriendlyName

( const FString& FriendlyName
)

 Takes the friendly name presented to the UI and converts to the real parameter name used under the hood.
Public function void If for any reason this data has changed externally and needs recompilation and it isn't autodetected, use this method.
Public function void

RemoveParameter ( const FNiagaraVariable& Parameter
)

  
Public function void

RenameParameter ( FNiagaraVariable& Parameter,
FName NewName
)

  

Overridden from UObject

  Type Name Description
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 Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name Description
FOnChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page