UNiagaraDataChannelReader | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/Niagara

Initial simple API for reading and writing data in a data channel from game code / BP. Likely to be replaced in the near future with a custom BP node and a helper struct.


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

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UNiagaraDataChannelReader : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UNiagaraDataChannelReader

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
Owner	TObjectPtr< UNiagaraDataChannelHandler >		NiagaraDataChannelAccessor.h

Protected

Name	Type	Include Path
bReadingPreviousFrame	bool	NiagaraDataChannelAccessor.h
Data	FNiagaraDataChannelDataPtr	NiagaraDataChannelAccessor.h
UNiagaraDataChannelHandler	friend	NiagaraDataChannelAccessor.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
bool BeginRead ( FNDCAccessContextInst& AccessContext, bool bReadPrevFrameData )	Call before each access to the data channel to grab the correct data to read.	NiagaraDataChannelAccessor.h
void Cleanup()		NiagaraDataChannelAccessor.h
bool InitAccess ( FNiagaraDataChannelSearchParameters SearchParams, bool bReadPrevFrameData )	Call before each access to the data channel to grab the correct data to read.	NiagaraDataChannelAccessor.h	Meta=(DisplayName="Init Access (Legacy)")
int32 Num()		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
bool ReadBool ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
uint8 ReadEnum ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
double ReadFloat ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
FNiagaraID ReadID ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
int32 ReadInt ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
FLinearColor ReadLinearColor ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
FVector ReadPosition ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
FQuat ReadQuat ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
FNiagaraSpawnInfo ReadSpawnInfo ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
FVector ReadVector ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
FVector2D ReadVector2D ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")
FVector4 ReadVector4 ( FName VarName, int32 Index, bool& IsValid ) const		NiagaraDataChannelAccessor.h	BlueprintCallable Category=NiagaraDataChannel Meta=(Keywords="Niagara DataChannel")

Navigation

Syntax

Inheritance Hierarchy

Variables

Public

Protected

Functions

Public