unreal.NiagaraDataInterfaceArrayFunctionLibrary

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

Bases: BlueprintFunctionLibrary

C++ and Blueprint library for accessing array types

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraDataInterfaceArrayFunctionLibrary.h

classmethod get_niagara_array_bool(niagara_system, override_name) → Array[bool]

Gets a copy of Niagara Bool Data.

Parameters:
Return type:

Array[bool]

classmethod get_niagara_array_bool_value(niagara_system, override_name, index) → bool

Gets a single value within a Niagara Array Bool.

Parameters:
Return type:

bool

classmethod get_niagara_array_color(niagara_system, override_name) → Array[LinearColor]

Gets a copy of Niagara FLinearColor Data.

Parameters:
Return type:

Array[LinearColor]

classmethod get_niagara_array_color_value(niagara_system, override_name, index) → LinearColor

Gets a single value within a Niagara Array FLinearColor.

Parameters:
Return type:

LinearColor

classmethod get_niagara_array_float(niagara_system, override_name) → Array[float]

Gets a copy of Niagara Float Data.

Parameters:
Return type:

Array[float]

classmethod get_niagara_array_float_value(niagara_system, override_name, index) → float

Gets a single value within a Niagara Array Float.

Parameters:
Return type:

float

classmethod get_niagara_array_int32(niagara_system, override_name) → Array[int32]

Gets a copy of Niagara Int32 Data.

Parameters:
Return type:

Array[int32]

classmethod get_niagara_array_int32_value(niagara_system, override_name, index) → int32

Gets a single value within a Niagara Array Int32.

Parameters:
Return type:

int32

classmethod get_niagara_array_matrix(niagara_system, override_name, apply_lwc_rebase=True) → Array[Matrix]

Gets a copy of Niagara FMatrix Data.

Parameters:

  • niagara_system (NiagaraComponent)

  • override_name (Name)

  • apply_lwc_rebase (bool) – When enabled the matrix translation will have the simulation tile offset added to it

Return type:

Array[Matrix]

classmethod get_niagara_array_matrix_value(niagara_system, override_name, index, apply_lwc_rebase=True) → Matrix

Gets a single value within a Niagara Array FMatrix.

Parameters:

  • niagara_system (NiagaraComponent)

  • override_name (Name)

  • index (int32)

  • apply_lwc_rebase (bool) – When enabled the matrix translation will have the simulation tile offset added to it

Return type:

Matrix

classmethod get_niagara_array_position(niagara_system, override_name) → Array[Vector]

Gets a copy of Niagara Position Data.

Parameters:
Return type:

Array[Vector]

classmethod get_niagara_array_position_value(niagara_system, override_name, index) → Vector

Gets a single value within a Niagara Array Position.

Parameters:
Return type:

Vector

classmethod get_niagara_array_quat(niagara_system, override_name) → Array[Quat]

Gets a copy of Niagara FQuat Data.

Parameters:
Return type:

Array[Quat]

classmethod get_niagara_array_quat_value(niagara_system, override_name, index) → Quat

Gets a single value within a Niagara Array FQuat.

Parameters:
Return type:

Quat

classmethod get_niagara_array_u_int8(niagara_system, override_name) → Array[int32]

Gets a copy of Niagara UInt8 Data.

Parameters:
Return type:

Array[int32]

classmethod get_niagara_array_u_int8_value(niagara_system, override_name, index) → int32

Gets a single value within a Niagara Array UInt8.

Parameters:
Return type:

int32

classmethod get_niagara_array_vector(niagara_system, override_name) → Array[Vector]

Gets a copy of Niagara FVector Data.

Parameters:
Return type:

Array[Vector]

classmethod get_niagara_array_vector2d(niagara_system, override_name) → Array[Vector2D]

Gets a copy of Niagara FVector2D Data.

Parameters:
Return type:

Array[Vector2D]

classmethod get_niagara_array_vector2d_value(niagara_system, override_name, index) → Vector2D

Gets a single value within a Niagara Array FVector2D.

Parameters:
Return type:

Vector2D

classmethod get_niagara_array_vector4(niagara_system, override_name) → Array[Vector4]

Gets a copy of Niagara FVector4 Data.

Parameters:
Return type:

Array[Vector4]

classmethod get_niagara_array_vector4_value(niagara_system, override_name, index) → Vector4

Gets a single value within a Niagara Array FVector4.

Parameters:
Return type:

Vector4

classmethod get_niagara_array_vector_value(niagara_system, override_name, index) → Vector

Gets a single value within a Niagara Array FVector.

Parameters:
Return type:

Vector

classmethod set_niagara_array_bool(niagara_system, override_name, array_data) → None

Sets Niagara Array Bool Data.

Parameters:
classmethod set_niagara_array_bool_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array Bool.

Parameters:
classmethod set_niagara_array_color(niagara_system, override_name, array_data) → None

Sets Niagara Array FLinearColor Data.

Parameters:
classmethod set_niagara_array_color_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array FLinearColor.

Parameters:
classmethod set_niagara_array_float(niagara_system, override_name, array_data) → None

Sets Niagara Array Float Data.

Parameters:
classmethod set_niagara_array_float_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array Float.

Parameters:
classmethod set_niagara_array_int32(niagara_system, override_name, array_data) → None

Sets Niagara Array Int32 Data.

Parameters:
classmethod set_niagara_array_int32_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array Int32.

Parameters:
classmethod set_niagara_array_matrix(niagara_system, override_name, array_data, apply_lwc_rebase=True) → None

Sets Niagara Array FMatrix Data.

Parameters:

  • niagara_system (NiagaraComponent)

  • override_name (Name)

  • array_data (Array[Matrix])

  • apply_lwc_rebase (bool) – When enabled the matrix translation will have the simulation tile offset subtracted from it

classmethod set_niagara_array_matrix_value(niagara_system, override_name, index, value, size_to_fit, apply_lwc_rebase=True) → None

Sets a single value within a Niagara Array FMatrix.

Parameters:

  • niagara_system (NiagaraComponent)

  • override_name (Name)

  • index (int32)

  • value (Matrix)

  • size_to_fit (bool)

  • apply_lwc_rebase (bool) – When enabled the matrix translation will have the simulation tile offset subtracted from it

classmethod set_niagara_array_position(niagara_system, override_name, array_data) → None

Sets Niagara Array FVector Data.

Parameters:
classmethod set_niagara_array_position_value(niagara_system, override_name, index, value, size_to_fit) → None

Set Niagara Array Position Value

Parameters:
classmethod set_niagara_array_quat(niagara_system, override_name, array_data) → None

Sets Niagara Array FQuat Data.

Parameters:
classmethod set_niagara_array_quat_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array FQuat.

Parameters:
classmethod set_niagara_array_u_int8(niagara_system, override_name, array_data) → None

Sets Niagara Array UInt8 Data.

Parameters:
classmethod set_niagara_array_u_int8_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array UInt8.

Parameters:
classmethod set_niagara_array_vector(niagara_system, override_name, array_data) → None

Sets Niagara Array FVector Data.

Parameters:
classmethod set_niagara_array_vector2d(niagara_system, override_name, array_data) → None

Sets Niagara Array FVector2D Data.

Parameters:
classmethod set_niagara_array_vector2d_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array FVector2D.

Parameters:
classmethod set_niagara_array_vector4(niagara_system, override_name, array_data) → None

Sets Niagara Array FVector4 Data.

Parameters:
classmethod set_niagara_array_vector4_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array FVector4.

Parameters:
classmethod set_niagara_array_vector_value(niagara_system, override_name, index, value, size_to_fit) → None

Sets a single value within a Niagara Array FVector.

Parameters: