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_WithContext |
| Type | function |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDataChannelFunctionLibrary.h |
| Include Path | #include "NiagaraDataChannelFunctionLibrary.h" |
| Source | /Engine/Plugins/FX/Niagara/Source/Niagara/Private/NiagaraDataChannelFunctionLibrary.cpp |
UFUNCTION (BlueprintInternalUseOnly, Category=NiagaraDataChannel,
DisplayName="Write To Niagara Data Channel",
Meta=(bVisibleToBlueprint="true", bVisibleToNiagaraCPU="true", bVisibleToNiagaraGPU="true", Keywords="niagara DataChannel event writer", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true"))
static void WriteToNiagaraDataChannelSingle_WithContext
(
const UObject * WorldContextObject,
const UNiagaraDataChannelAsset * Channel,
FNDCAccessContextInst & AccessContext,
bool bVisibleToBlueprint,
bool bVisibleToNiagaraCPU,
bool bVisibleToNiagaraGPU
)
Parameters
| Name | Remarks |
|---|---|
| WorldContextObject | World to execute in |
| Channel | The channel to write to |
| AccessContext | Context allowing passing of NDC type specific information between the caller and internal Data Channel that can control internal routing and help feedback information to the caller. |
| 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 |