unreal.NiagaraDataChannelReader

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

Bases: Object

Initial simple API for reading and writing data in a data channel from game code / BP. Likely to be replaced in the near future with a custom BP node and a helper struct.

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraDataChannelAccessor.h

init_access(owning_component) → bool

Call before each access to the data channel to grab the correct data to read.

Parameters:

owning_component (ActorComponent) –

Return type:

bool

num() → int32

Num

Return type:

int32

read_bool(var_name, index) → bool

Read Bool

Parameters:

  • var_name (Name) –

  • index (int32) –

Return type:

bool

read_float(var_name, index) → double

Read Float

Parameters:

  • var_name (Name) –

  • index (int32) –

Return type:

double

read_int(var_name, index) → int32

Read Int

Parameters:

  • var_name (Name) –

  • index (int32) –

Return type:

int32

read_linear_color(var_name, index) → LinearColor

Read Linear Color

Parameters:

  • var_name (Name) –

  • index (int32) –

Return type:

LinearColor

read_quat(var_name, index) → Quat

Read Quat

Parameters:

  • var_name (Name) –

  • index (int32) –

Return type:

Quat

read_vector(var_name, index) → Vector

Read Vector

Parameters:

  • var_name (Name) –

  • index (int32) –

Return type:

Vector

read_vector2d(var_name, index) → Vector2D

Read Vector 2D

Parameters:

  • var_name (Name) –

  • index (int32) –

Return type:

Vector2D

read_vector4(var_name, index) → Vector4

Read Vector 4

Parameters:

  • var_name (Name) –

  • index (int32) –

Return type:

Vector4