Navigation
API > API/Plugins > API/Plugins/Niagara
| Name | UNiagaraDataChannel |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDataChannel.h |
| Include Path | #include "NiagaraDataChannel.h" |
Syntax
UCLASS (Abstract, EditInlineNew, MinimalAPI, prioritizeCategories=("Data Channel"))
class UNiagaraDataChannel : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraDataChannel
Derived Classes
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnforceTickGroupReadWriteOrder | bool | If true we ensure that all writes happen in or before the Tick Group specified in EndWriteTickGroup and that all reads happen in tick groups after this. | NiagaraDataChannel.h |
|
| bKeepPreviousFrameData | bool | If true, we keep our previous frame's data. | NiagaraDataChannel.h |
|
| ChannelVariables | TArray< FNiagaraDataChannelVariable > | The variables that define the data contained in this Data Channel. | NiagaraDataChannel.h |
|
| FinalWriteTickGroup | TEnumAsByte< ETickingGroup > | The final tick group that this data channel can be written to. | NiagaraDataChannel.h |
|
| LayoutInfo | FNiagaraDataChannelLayoutInfoPtr | Data layout for payloads in Niagara datasets. | NiagaraDataChannel.h | |
| RTFence | FRenderCommandFence | NiagaraDataChannel.h | ||
| VersionGuid | FGuid | NiagaraDataChannel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraDataChannelGameDataPtr CreateGameData() |
Creates a new GameData for this NDC. | NiagaraDataChannel.h | |
virtual UNiagaraDataChannelHandler * CreateHandler
(
UWorld* OwningWorld |
Create the appropriate handler object for this data channel. | NiagaraDataChannel.h | |
void ForEachDataChannel
(
TAction Func |
NiagaraDataChannel.h | ||
const UNiagaraDataChannelAsset * GetAsset() |
NiagaraDataChannel.h | ||
| If we are enforcing tick group read/write ordering the this returns the final tick group that this NDC can be written to. | NiagaraDataChannel.h | ||
const FNiagaraDataChannelLayoutInfoPtr GetLayoutInfo() |
NiagaraDataChannel.h | ||
TConstArrayView< FNiagaraDataChannelVariable > GetVariables() |
NiagaraDataChannel.h | ||
FGuid GetVersion() |
Can be used to track structural changes that would need recompilation of downstream assets. | NiagaraDataChannel.h | |
bool IsValid() |
NiagaraDataChannel.h | ||
bool KeepPreviousFrameData () |
If true, we keep our previous frame's data. | NiagaraDataChannel.h | |
bool ShouldEnforceTickGroupReadWriteOrder() |
NiagaraDataChannel.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
NiagaraDataChannel.h | ||
virtual bool IsReadyForFinishDestroy() |
NiagaraDataChannel.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedDataChannel |
NiagaraDataChannel.h | ||
virtual void PostInitProperties() |
NiagaraDataChannel.h | ||
virtual void PostLoad() |
NiagaraDataChannel.h | ||
virtual void PreEditChange
(
FProperty* PropertyAboutToChange |
NiagaraDataChannel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void ForEachDataChannel
(
TFunc Func |
NiagaraDataChannel.h |