1. Epic GamesDeveloper
  3. UNiagaraDataChannelHandler

UNiagaraDataChannelHandler

API > API/Plugins > API/Plugins/Niagara

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

Syntax

UCLASS (Abstract, BlueprintType, MinimalAPI)  
class UNiagaraDataChannelHandler : public UObject

Inheritance Hierarchy

Derived Classes

Structs

Name Remarks
FChannelSubscription  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AccessContextType TNDCAccessContextType   NiagaraDataChannelHandler.h  
ChannelSubscriptions TArray< FChannelSubscription >   NiagaraDataChannelHandler.h  
SubscriberTokens int32 Used to generate the unsubscribe tokens that are stored in ChannelSubscriptions NiagaraDataChannelHandler.h  
TransientAccessContext FNDCAccessContextInst A transient access context instance that calling code can use for accessing this Data Channel. NiagaraDataChannelHandler.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void BeginFrame ( float DeltaTime
)

   NiagaraDataChannelHandler.h  

virtual void Cleanup()

   NiagaraDataChannelHandler.h  

FNiagaraDataChannelDataPtr CreateData()

   NiagaraDataChannelHandler.h  

virtual void EndFrame ( float DeltaTime
)

   NiagaraDataChannelHandler.h  

virtual FNiagaraDataChannelDataPtr FindData ( FNiagaraDataChannelSearchParameters SearchParams,
ENiagaraResourceAccess AccessType
)

 Legacy FindData that supports old FNiagaraDataChannelSearchParameters path. NiagaraDataChannelHandler.h  

virtual FNiagaraDataChannelDataPtr FindData ( FNDCAccessContextInst& AccessContext,
ENiagaraResourceAccess AccessType
)

 Finds the correct internal data for this data channel and the given access context. NiagaraDataChannelHandler.h  

void ForEachNDCData ( TAction Func
)

   NiagaraDataChannelHandler.h  

T * GetChannelTyped()

   NiagaraDataChannelHandler.h  

ETickingGroup GetCurrentTickGroup()

 Returns the tick group we're currently being processed or most recently processed. NiagaraDataChannelHandler.h  

const UNiagaraDataChannel * GetDataChannel()

   NiagaraDataChannelHandler.h  

UNiagaraDataChannelReader * GetDataChannelReader()

   NiagaraDataChannelHandler.h
  • BlueprintCallable
  • Category="Data Channel"

UNiagaraDataChannelWriter * GetDataChannelWriter()

   NiagaraDataChannelHandler.h
  • BlueprintCallable
  • Category="Data Channel"
Returns a pre allocated access context that you can use for accessing this data channel. NiagaraDataChannelHandler.h  

virtual void Init ( const UNiagaraDataChannel* InChannel
)

   NiagaraDataChannelHandler.h  

void NotifySubscribers ( FNiagaraDataChannelData* Source,
int32 StartIndex,
int32 NumNewElements
)

   NiagaraDataChannelHandler.h  

void OnComputeDispatchInterfaceDestroyed ( FNiagaraGpuComputeDispatchInterface* InComputeDispatchInterface
)

   NiagaraDataChannelHandler.h  

void SetOwningWorld ( FNiagaraWorldManager* InOwner
)

   NiagaraDataChannelHandler.h  

void SubscribeToDataChannelUpdates ( FOnNewNiagaraDataChannelPublish UpdateDelegate,
FNiagaraDataChannelSearchParameters SearchParams,
int32& UnsubscribeToken
)

 The provided delegate will be called whenever new entries are added to the relevant data channel. NiagaraDataChannelHandler.h
  • BlueprintCallable
  • Category="Data Channel"
  • Meta=(DisplayName="Subscribe To Data Channel Updates (Legacy)")

void SubscribeToDataChannelUpdates_WithContext ( FOnNewNiagaraDataChannelPublish UpdateDelegate,
FNDCAccessContextInst& AccessContext,
int32& UnsubscribeToken
)

 The provided delegate will be called whenever new entries are added to the relevant data channel. NiagaraDataChannelHandler.h
  • BlueprintCallable
  • Category="Data Channel"

virtual void Tick ( float DeltaTime,
ETickingGroup TickGroup
)

   NiagaraDataChannelHandler.h  

void UnsubscribeFromDataChannelUpdates ( const int32& UnsubscribeToken
)

   NiagaraDataChannelHandler.h
  • BlueprintCallable
  • Category="Data Channel"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   NiagaraDataChannelHandler.h  

virtual bool IsReadyForFinishDestroy()

   NiagaraDataChannelHandler.h  

Protected

Name Remarks Include Path Unreal Specifiers

void VerifyAccessContext ( FNDCAccessContextInst& AccessContext
)

   NiagaraDataChannelHandler.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page