1. Epic GamesDeveloper
  3. UNiagaraParameterCollectionInstance

UNiagaraParameterCollectionInstance

Can be used to override selected parameters from a Niagara parameter collection with another value.

API > API/Plugins > API/Plugins/Niagara

Can be used to override selected parameters from a Niagara parameter collection with another value. The values in the parameter collection instance can be set from Blueprint or C++, same as the regular parameter collection.

   
Name UNiagaraParameterCollectionInstance
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraParameterCollection.h
Include Path #include "NiagaraParameterCollection.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraParameterCollectionInstance : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraParameterCollectionInstance ( const FObjectInitializer& ObjectInitializer
)

   NiagaraParameterCollection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UNiagaraParameterCollectionInstance()

   NiagaraParameterCollection.h  

Typedefs

Name Type Remarks Include Path
FOnParameterValuesChanged TMulticastDelegate_OneParam< void, TConstArrayView< FName > >   NiagaraParameterCollection.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Collection TObjectPtr< UNiagaraParameterCollection > TODO: Abstract to some interface to allow a hierarchy like UMaterialInstance? NiagaraParameterCollection.h
  • EditAnywhere
  • Category=Instance
OverridenParameters TArray< FNiagaraVariable > When editing instances, we must track which parameters are overridden so we can pull in any changes to the default. NiagaraParameterCollection.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
DirtyParameterLock FRWLock   NiagaraParameterCollection.h  
DirtyScalarParameters TArray< TPair< FName, float > >   NiagaraParameterCollection.h  
DirtyVectorParameters TArray< TPair< FName, FLinearColor > >   NiagaraParameterCollection.h  
MaterialCollectionChangedDelegate FDelegateHandle   NiagaraParameterCollection.h  
MaterialParametersChangedHandle FDelegateHandle   NiagaraParameterCollection.h  
OnParameterValuesChanged FOnParameterValuesChanged   NiagaraParameterCollection.h  
ParametersNeedReset std::atomic< bool >   NiagaraParameterCollection.h  
ParameterStorage FNiagaraParameterStore   NiagaraParameterCollection.h  
ParameterValuesEditedHandle FDelegateHandle   NiagaraParameterCollection.h  
ParentCollectionChangedDelegate FDelegateHandle   NiagaraParameterCollection.h  
ScalarParamUpdateDelegate FDelegateHandle   NiagaraParameterCollection.h  
SourceMaterialCollectionInstance TObjectPtr< UMaterialParameterCollectionInstance >   NiagaraParameterCollection.h
  • Transient
VectorParamUpdateDelegate FDelegateHandle   NiagaraParameterCollection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddParameter ( const FNiagaraVariable& Parameter
)

   NiagaraParameterCollection.h  

void Bind ( UWorld* World
)

   NiagaraParameterCollection.h  

void Empty()

   NiagaraParameterCollection.h  

bool GetBoolParameter ( const FString& InVariableName
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Bool Parameter")

FLinearColor GetColorParameter ( const FString& InVariableName
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Color Parameter")

float GetFloatParameter ( const FString& InVariableName
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Float Parameter")

int32 GetIntParameter ( const FString& InVariableName
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Int Parameter")

void GetParameters ( TArray< FNiagaraVariable >& OutParameters
)

   NiagaraParameterCollection.h  
  NiagaraParameterCollection.h  
  NiagaraParameterCollection.h  
  NiagaraParameterCollection.h  

FQuat GetQuatParameter ( const FString& InVariableName
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Quaternion Parameter")

FVector2D GetVector2DParameter ( const FString& InVariableName
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Vector2D Parameter")

FVector4 GetVector4Parameter ( const FString& InVariableName
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Vector4 Parameter")

FVector GetVectorParameter ( const FString& InVariableName
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Get Vector Parameter")

bool IsDefaultInstance()

   NiagaraParameterCollection.h  

bool IsExternallyDriven ( const FNiagaraVariable& Parameter
) const

   NiagaraParameterCollection.h  

bool OverridesParameter ( const FNiagaraVariable& Parameter
) const

   NiagaraParameterCollection.h  

FOnParameterValuesChanged & ParameterValuesChanged()

   NiagaraParameterCollection.h  

bool RemoveParameter ( const FNiagaraVariable& Parameter
)

   NiagaraParameterCollection.h  

void RenameParameter ( const FNiagaraVariable& Parameter,
FName NewName
)

   NiagaraParameterCollection.h  

void SetBoolParameter ( const FString& InVariableName,
bool InValue
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Bool Parameter")

void SetColorParameter ( const FString& InVariableName,
FLinearColor InValue
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Color Parameter")

void SetFloatParameter ( const FString& InVariableName,
float InValue
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Float Parameter")

void SetIntParameter ( const FString& InVariableName,
int32 InValue
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Int Parameter")

void SetOverridesParameter ( const FNiagaraVariable& Parameter,
bool bOverrides
)

   NiagaraParameterCollection.h  

void SetParent ( UNiagaraParameterCollection* InParent
)

   NiagaraParameterCollection.h  

void SetQuatParameter ( const FString& InVariableName,
const FQuat& InValue
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Quaternion Parameter")

void SetVector2DParameter ( const FString& InVariableName,
FVector2D InValue
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Vector2D Parameter")

void SetVector4Parameter ( const FString& InVariableName,
const FVector4& InValue
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Vector4 Parameter")

void SetVectorParameter ( const FString& InVariableName,
FVector InValue
)

   NiagaraParameterCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DisplayName="Set Vector Parameter")

void SyncWithCollection()

 Synchronizes this instance with any changes with it's parent collection. NiagaraParameterCollection.h  

void SyncWithCollectionParameters ( TConstArrayView< FName > ParametersToRefresh
)

   NiagaraParameterCollection.h  

void Tick ( UWorld* World
)

   NiagaraParameterCollection.h  

void Unbind ( UWorld* World
)

   NiagaraParameterCollection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   NiagaraParameterCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page