unreal.NiagaraParameterCollectionInstance

class unreal.NiagaraParameterCollectionInstance(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

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.

C++ Source:

• Plugin: Niagara

• Module: Niagara

• File: NiagaraParameterCollection.h

Editor Properties: (see get_editor_property/set_editor_property)

• collection (NiagaraParameterCollection): [Read-Write] TODO: Abstract to some interface to allow a hierarchy like UMaterialInstance?

get_bool_parameter(variable_name) → bool

Accessors from Blueprint. For now just exposing common types but ideally we can expose any somehow in future.

Parameters:

variable_name (str)

Return type:

bool

get_color_parameter(variable_name) → LinearColor

Get Color Parameter

Parameters:

variable_name (str)

Return type:

LinearColor

get_float_parameter(variable_name) → float

Get Float Parameter

Parameters:

variable_name (str)

Return type:

float

get_int_parameter(variable_name) → int32

Get Int Parameter

Parameters:

variable_name (str)

Return type:

int32

get_quat_parameter(variable_name) → Quat

Get Quat Parameter

Parameters:

variable_name (str)

Return type:

Quat

get_vector2d_parameter(variable_name) → Vector2D

Get Vector 2DParameter

Parameters:

variable_name (str)

Return type:

Vector2D

get_vector4_parameter(variable_name) → Vector4

Get Vector 4Parameter

Parameters:

variable_name (str)

Return type:

Vector4

get_vector_parameter(variable_name) → Vector

Get Vector Parameter

Parameters:

variable_name (str)

Return type:

Vector

set_bool_parameter(variable_name, value) → None

Set Bool Parameter

Parameters:

• variable_name (str)

• value (bool)

set_color_parameter(variable_name, value) → None

Set Color Parameter

Parameters:

• variable_name (str)

• value (LinearColor)

set_float_parameter(variable_name, value) → None

Set Float Parameter

Parameters:

• variable_name (str)

• value (float)

set_int_parameter(variable_name, value) → None

Set Int Parameter

Parameters:

• variable_name (str)

• value (int32)

set_quat_parameter(variable_name, value) → None

Set Quat Parameter

Parameters:

• variable_name (str)

• value (Quat)

set_vector2d_parameter(variable_name, value) → None

Set Vector 2DParameter

Parameters:

• variable_name (str)

• value (Vector2D)

set_vector4_parameter(variable_name, value) → None

TODO[mg]: add position setter for LWC

Parameters:

• variable_name (str)

• value (Vector4)

set_vector_parameter(variable_name, value) → None

Set Vector Parameter

Parameters:

• variable_name (str)

• value (Vector)