1. Epic GamesDeveloper
  3. UNiagaraDataChannelLibrary

UNiagaraDataChannelLibrary

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

API > API/Plugins > API/Plugins/Niagara

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

   
Name UNiagaraDataChannelLibrary
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDataChannelFunctionLibrary.h
Include Path #include "NiagaraDataChannelFunctionLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraDataChannelLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataChannelLibrary ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataChannelFunctionLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static UNiagaraDataChannelReader * CreateDataChannelReader ( const UObject* WorldContextObject,
const UNiagaraDataChannel* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bReadPreviousFrame
)

   NiagaraDataChannelFunctionLibrary.h  

static UNiagaraDataChannelReader * CreateDataChannelReader_WithContext ( const UObject* WorldContextObject,
const UNiagaraDataChannel* Channel,
FNDCAccessContextInst& AccessContext,
bool bReadPreviousFrame
)

   NiagaraDataChannelFunctionLibrary.h  

static UNiagaraDataChannelWriter * CreateDataChannelWriter ( const UObject* WorldContextObject,
const UNiagaraDataChannel* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
int32 Count,
bool bVisibleToGame,
bool bVisibleToCPU,
bool bVisibleToGPU,
const FString& DebugSource
)

   NiagaraDataChannelFunctionLibrary.h  

static UNiagaraDataChannelWriter * CreateDataChannelWriter_WithContext ( const UObject* WorldContextObject,
const UNiagaraDataChannel* Channel,
FNDCAccessContextInst& AccessContext,
int32 Count,
bool bVisibleToGame,
bool bVisibleToCPU,
bool bVisibleToGPU,
const FString& DebugSource
)

   NiagaraDataChannelFunctionLibrary.h  

static UNiagaraDataChannelHandler * FindDataChannelHandler ( const UObject* WorldContextObject,
const UNiagaraDataChannel* Channel
)

   NiagaraDataChannelFunctionLibrary.h  

static int32 GetDataChannelElementCount ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bReadPreviousFrame
)

 LEGACY FUNCTION: Please use non-legacy version. NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • Category=NiagaraDataChannel
  • Meta=(bReadPreviousFrame="true", DisplayName="Get Data Channel Element Count (Legacy)", AdvancedDisplay="SearchParams, bReadPreviousFrame", Keywords="niagara DataChannel num size", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static int32 GetDataChannelElementCount_WithContext ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNDCAccessContextInst& AccessContext,
bool bReadPreviousFrame
)

 Returns the number of readable elements in the given data channel NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • BlueprintInternalUseOnly
  • Category=NiagaraDataChannel
  • Meta=(bReadPreviousFrame="true", Keywords="niagara DataChannel num size", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void GetMembersInNDCAccessContextInstance ( const FNDCAccessContextInst& AccessContext,
UScriptStruct* ContextStruct
)

 Gets the members from the internal Struct of an FNDCAccessContextIns. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • BlueprintCallable
  • Category="Niagara Data Channel"
  • Meta=(HidePin="ContextStruct")

static UNiagaraDataChannelHandler * GetNiagaraDataChannel ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel
)

   NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • Category=NiagaraDataChannel
  • Meta=(Keywords="niagara DataChannel", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void GetSinglePropertyInNDCAccessContextInstance ( const FNDCAccessContextInst& AccessContext,
UScriptStruct* ContextStruct,
FName PropertyName,
int32& Value
)

 Gets a specific property within the internal data of an FNDCAccessContextInst. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • BlueprintCallable
  • CustomThunk
  • Category="Niagara Data Channel"
  • Meta=(CustomStructureParam="Value", AutoCreateRefTerm="Value")

static FNDCAccessContextInst & GetUsableAccessContextFromNDC ( const UNiagaraDataChannelAsset* DataChannel
)

 Returns the access context for use when accessing a Niagara Data channel. NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • BlueprintInternalUseOnly
  • Category="Niagara Data Channel"

static FNDCAccessContextInst & GetUsableAccessContextFromNDCRef ( const FNiagaraDataChannelReference& NDCRef
)

 Returns the access context for use when accessing a Niagara Data channel. NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • BlueprintInternalUseOnly
  • Category="Niagara Data Channel"
Creates a new NDCAccessContext with a specified internal struct type. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • BlueprintCallable
  • CustomThunk
  • Category="Niagara Data Channel"
  • Meta=(HidePin="ContextStruct")
Prepares an Access Context ready for accessing a Niagara Data Channel. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • BlueprintCallable
  • Category="Niagara Data Channel"

static UNiagaraDataChannelReader * ReadFromNiagaraDataChannel ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bReadPreviousFrame
)

 LEGACY FUNCTION: Please use non-legacy version. NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • Category=NiagaraDataChannel
  • DisplayName="Read From Niagara Data Channel (Batch) (Legacy)"
  • Meta=(AdvancedDisplay="SearchParams", Keywords="niagara DataChannel", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static UNiagaraDataChannelReader * ReadFromNiagaraDataChannel_WithContext ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNDCAccessContextInst& AccessContext,
bool bReadPreviousFrame
)

 Initializes and returns the Niagara Data Channel reader for the given data channel. NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • BlueprintInternalUseOnly
  • Category=NiagaraDataChannel
  • DisplayName="Read From Niagara Data Channel (Batch)"
  • Meta=(Keywords="niagara DataChannel", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void ReadFromNiagaraDataChannelSingle ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
int32 Index,
FNiagaraDataChannelSearchParameters SearchParams,
bool bReadPreviousFrame,
ENiagartaDataChannelReadResult& ReadResult
)

 LEGACY FUNCTION: Please use non-legacy version. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • Category=NiagaraDataChannel
  • DisplayName="Read From Niagara Data Channel (Legacy)"
  • Meta=(bReadPreviousFrame="true", AdvancedDisplay="SearchParams, bReadPreviousFrame", ExpandEnumAsExecs="ReadResult", Keywords="niagara DataChannel", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void ReadFromNiagaraDataChannelSingle_WithContext ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
int32 Index,
FNDCAccessContextInst& AccessContext,
bool bReadPreviousFrame,
ENiagartaDataChannelReadResult& ReadResult
)

 Reads a single entry from the given data channel, if possible. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • Category=NiagaraDataChannel
  • DisplayName="Read From Niagara Data Channel"
  • Meta=(bReadPreviousFrame="true", ExpandEnumAsExecs="ReadResult", Keywords="niagara DataChannel", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void SetMembersInNDCAccessContextInstance ( FNDCAccessContextInst& AccessContext,
UScriptStruct* ContextStruct
)

 Sets the members in the internal Struct of an FNDCAccessContextIns. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • BlueprintCallable
  • Category="Niagara Data Channel"
  • Meta=(HidePin="ContextStruct")

static void SetSinglePropertyInNDCAccessContextInstance ( FNDCAccessContextInst& AccessContext,
UScriptStruct* ContextStruct,
FName PropertyName,
const int32& Value
)

 Sets a specific property within the internal data of an FNDCAccessContextInst. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • BlueprintCallable
  • CustomThunk
  • Category="Niagara Data Channel"
  • Meta=(CustomStructureParam="Value", AutoCreateRefTerm="Value")

static void SubscribeToNiagaraDataChannel ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
const FOnNewNiagaraDataChannelPublish& UpdateDelegate,
int32& UnsubscribeToken
)

 LEGACY FUNCTION: Please use non-legacy version. NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • Category=NiagaraDataChannel
  • Meta=(DisplayName="Subscribe To Niagara Data Channel (Legacy)", Keywords="niagara DataChannel event reader subscription delegate listener updates", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void SubscribeToNiagaraDataChannel_WithContext ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNDCAccessContextInst& AccessContext,
const FOnNewNiagaraDataChannelPublish& UpdateDelegate,
int32& UnsubscribeToken
)

 Subscribes to a single data channel and calls a delegate every times new data is written to the data channel. NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • Category=NiagaraDataChannel
  • Meta=(Keywords="niagara DataChannel event reader subscription delegate listener updates", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void UnsubscribeFromNiagaraDataChannel ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
const int32& UnsubscribeToken
)

 Removes a prior registration from a data channel NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • Category=NiagaraDataChannel
  • Meta=(Keywords="niagara DataChannel event reader subscription delegate listener updates", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static UNiagaraDataChannelWriter * WriteToNiagaraDataChannel ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
int32 Count,
bool bVisibleToGame,
bool bVisibleToCPU,
bool bVisibleToGPU,
const FString& DebugSource
)

 LEGACY FUNCTION: Please use non-legacy version. NiagaraDataChannelFunctionLibrary.h
  • 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_WithContext ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNDCAccessContextInst& AccessContext,
int32 Count,
bool bVisibleToBlueprint,
bool bVisibleToNiagaraCPU,
bool bVisibleToNiagaraGPU,
const FString& DebugSource
)

 Initializes and returns the Niagara Data Channel writer to write N elements to the given data channel. NiagaraDataChannelFunctionLibrary.h
  • BlueprintCallable
  • BlueprintInternalUseOnly
  • Category=NiagaraDataChannel
  • DisplayName="Write To Niagara Data Channel (Batch)"
  • Meta=(AdvancedDisplay="DebugSource", Keywords="niagara DataChannel", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true", AutoCreateRefTerm="DebugSource", bVisibleToBlueprint="true", bVisibleToNiagaraCPU="true", bVisibleToNiagaraGPU="true")

static void WriteToNiagaraDataChannelSingle ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bVisibleToBlueprint,
bool bVisibleToNiagaraCPU,
bool bVisibleToNiagaraGPU
)

 LEGACY FUNCTION: Please use non-legacy version. NiagaraDataChannelFunctionLibrary.h
  • BlueprintInternalUseOnly
  • Category=NiagaraDataChannel
  • DisplayName="Write To Niagara Data Channel (Legacy)"
  • Meta=(bVisibleToBlueprint="true", bVisibleToNiagaraCPU="true", bVisibleToNiagaraGPU="true", AdvancedDisplay="bVisibleToBlueprint, bVisibleToNiagaraCPU, bVisibleToNiagaraGPU, SearchParams", 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
)

 Writes a single element to a Niagara Data Channel. NiagaraDataChannelFunctionLibrary.h
  • 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")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page