unreal.NiagaraDataChannelLibrary

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

Bases: BlueprintFunctionLibrary

A C++ and Blueprint accessible library of utility functions for accessing Niagara DataChannel

C++ Source:

• Plugin: Niagara

• Module: Niagara

• File: NiagaraDataChannel.h

classmethod get_niagara_data_channel(world_context_object, channel) → NiagaraDataChannelHandler

Get Niagara Data Channel

Parameters:

• world_context_object (Object) –

• channel (NiagaraDataChannelAsset) –

Return type:

NiagaraDataChannelHandler

classmethod read_from_niagara_data_channel(world_context_object, channel, search_params, read_previous_frame) → NiagaraDataChannelReader

Initializes and returns the Niagara Data Channel reader for the given data channel.

Parameters:

• world_context_object (Object) –

• channel (NiagaraDataChannelAsset) –

• search_params (NiagaraDataChannelSearchParameters) –

• read_previous_frame (bool) –

Return type:

NiagaraDataChannelReader

classmethod write_to_niagara_data_channel(world_context_object, channel, search_params, count, visible_to_game, visible_to_cpu, visible_to_gpu) → NiagaraDataChannelWriter

Initializes and returns the Niagara Data Channel writer to write N elements to the given data channel.

Parameters:

• world_context_object (Object) –

• channel (NiagaraDataChannelAsset) –

• search_params (NiagaraDataChannelSearchParameters) –

• count (int32) –

• visible_to_game (bool) –

• visible_to_cpu (bool) –

• visible_to_gpu (bool) –

Return type:

NiagaraDataChannelWriter