Navigation
API > API/Plugins > API/Plugins/Niagara > API/Plugins/Niagara/UNiagaraDataChannelLibrary
Description
Writes a single element to a Niagara Data Channel. The element won't be immediately visible to readers, as it needs to be processed first. The earliest point it can be read is in the next tick group.
| Name | WriteToNiagaraDataChannelSingle |
| Type | function |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDataChannel.h |
| Include Path | #include "NiagaraDataChannel.h" |
| Source | /Engine/Plugins/FX/Niagara/Source/Niagara/Private/NiagaraDataChannel.cpp |
UFUNCTION (BlueprintInternalUseOnly, Category=NiagaraDataChannel,
DisplayName="Write To Niagara Data Channel",
Meta=(bVisibleToBlueprint="true", bVisibleToNiagaraCPU="true", bVisibleToNiagaraGPU="true", AdvancedDisplay="bVisibleToBlueprint, bVisibleToNiagaraCPU, bVisibleToNiagaraGPU, SearchParams", Keywords="niagara DataChannel event writer", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true"))
static void WriteToNiagaraDataChannelSingle
(
const UObject * WorldContextObject,
const UNiagaraDataChannelAsset * Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bVisibleToBlueprint,
bool bVisibleToNiagaraCPU,
bool bVisibleToNiagaraGPU
)
Parameters
| Name | Remarks |
|---|---|
| WorldContextObject | World to execute in |
| Channel | The channel to write to |
| SearchParams | Parameters used when retrieving a specific set of Data Channel Data to read or write like the islands data channel type. |
| bVisibleToBlueprint | If true, the data written to this data channel is visible to Blueprint and C++ logic reading from it |
| bVisibleToNiagaraCPU | If true, the data written to this data channel is visible to Niagara CPU emitters |
| bVisibleToNiagaraGPU | If true, the data written to this data channel is visible to Niagara GPU emitters |