Navigation
API > API/Plugins > API/Plugins/Niagara > API/Plugins/Niagara/UNiagaraDataChannelLibrary
Description
LEGACY FUNCTION: Please use non-legacy version. Initializes and returns the Niagara Data Channel writer to write N elements to the given data channel. This function is now legacy and and will soon be deprecated. Please use the new non-legacy function.
| Name | WriteToNiagaraDataChannel |
| 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 (BlueprintCallable, Category=NiagaraDataChannel,
DisplayName="Write To Niagara Data Channel (Batch) (Legacy)",
Meta=(AdvancedDisplay="SearchParams, DebugSource", Keywords="niagara DataChannel", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true", AutoCreateRefTerm="DebugSource"))
static UNiagaraDataChannelWriter * WriteToNiagaraDataChannel
(
const UObject * WorldContextObject,
const UNiagaraDataChannelAsset * Channel,
FNiagaraDataChannelSearchParameters SearchParams,
int32 Count,
bool bVisibleToGame,
bool bVisibleToCPU,
bool bVisibleToGPU,
const FString & DebugSource
)
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. |
| Count | The number of elements to write |
| bVisibleToGame | If true, the data written to this data channel is visible to Blueprint and C++ logic reading from it |
| bVisibleToCPU | If true, the data written to this data channel is visible to Niagara CPU emitters |
| bVisibleToGPU | If true, the data written to this data channel is visible to Niagara GPU emitters |
| DebugSource | Instigator for this write, used in the debug hud to track writes to the data channel from different sources |