UNiagaraParameterCollectionInstance

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraParameterCollectionInstance

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraParameterCollection.h

Include

#include "NiagaraParameterCollection.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UNiagaraParameterCollectionInstance : public UObject

Variables

Name Description

Public variable UProperty Category, EditAnywhere

UNiagaraParamet...

 

Collection

TODO: Abstract to some interface to allow a hierarchy like UMaterialInstance?

Public variable UProperty

TArray< FNiagar...

 

OverridenParameters

When editing instances, we must track which parameters are overridden so we can pull in any changes to the default.

Constructors

Name Description

Public function

UNiagaraParameterCollectionInstance

(
    const FObjectInitializer& ObjectIn...
)

Destructors

Functions

Name Description

Public function

bool

 

AddParameter

(
    const FNiagaraVariable& Parameter
)

Public function

void

 

Empty()

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetBoolParameter

(
    const FString& InVariableName
)

TODO: These overrides should be settable per platform.

Public function UFunction BlueprintCallable, Category, Meta

FLinearColor

 

GetColorParameter

(
    const FString& InVariableName
)

Public function UFunction BlueprintCallable, Category, Meta

float

 

GetFloatParameter

(
    const FString& InVariableName
)

Public function UFunction BlueprintCallable, Category, Meta

int32

 

GetIntParameter

(
    const FString& InVariableName
)

Public function

void

 

GetParameters

(
    TArray< FNiagaraVariable >& OutPar...
)

Public function

FNiagaraPara...

 

GetParameterStore()

Public function Const

UNiagaraPara...

 

GetParent()

Public function UFunction BlueprintCallable, Category, Meta

FQuat

 

GetQuatParameter

(
    const FString& InVariableName
)

Public function UFunction BlueprintCallable, Category, Meta

FVector2D

 

GetVector2DParameter

(
    const FString& InVariableName
)

Public function UFunction BlueprintCallable, Category, Meta

FVector4

 

GetVector4Parameter

(
    const FString& InVariableName
)

Public function UFunction BlueprintCallable, Category, Meta

FVector

 

GetVectorParameter

(
    const FString& InVariableName
)

Public function Const

bool

 

IsDefaultInstance()

Public function Const

bool

 

OverridesParameter

(
    const FNiagaraVariable& Parameter
)

Public function

bool

 

RemoveParameter

(
    const FNiagaraVariable& Parameter
)

Public function

void

 

RenameParameter

(
    const FNiagaraVariable& Parameter,
    FName NewName
)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetBoolParameter

(
    const FString& InVariableName,
    bool InValue
)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetColorParameter

(
    const FString& InVariableName,
    FLinearColor InValue
)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetFloatParameter

(
    const FString& InVariableName,
    float InValue
)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetIntParameter

(
    const FString& InVariableName,
    int32 InValue
)

Public function

void

 

SetOverridesParameter

(
    const FNiagaraVariable& Parameter,
    bool bOverrides
)

Public function

void

 

SetParent

(
    UNiagaraParameterCollection* I...
)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetQuatParameter

(
    const FString& InVariableName,
    const FQuat& InValue
)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetVector2DParameter

(
    const FString& InVariableName,
    FVector2D InValue
)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetVector4Parameter

(
    const FString& InVariableName,
    const FVector4& InValue
)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetVectorParameter

(
    const FString& InVariableName,
    FVector InValue
)

Public function

void

 

SyncWithCollection()

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

Public function

void

 

Tick()

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss