FNiagaraExt_StackItemReference

A reference to an item inside a Niagara System such as an emitter, script, module, input or renderer.

API > API/Plugins > API/Plugins/NiagaraEditor

A reference to an item inside a Niagara System such as an emitter, script, module, input or renderer.

   
Name FNiagaraExt_StackItemReference
Type struct
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraExternalSystemEditorUtilities.h
Include Path #include "NiagaraExternalSystemEditorUtilities.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FNiagaraExt_StackItemReference

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraExt_StackItemReference ( UNiagaraSystem* InSystem,
FName InEmitterName,
FName InScriptName,
FName InModuleName
)

   NiagaraExternalSystemEditorUtilities.h  
Copy constructor and assignment clear cached UObject pointers so that a copy with a different InputNameStack always re-resolves rather than returning a stale cached input. NiagaraExternalSystemEditorUtilities.h  
  NiagaraExternalSystemEditorUtilities.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
EmitterName FName   NiagaraExternalSystemEditorUtilities.h
  • EditAnywhere
  • Category="Stack Item"
InputNameStack TArray< FName > Input Name stack. NiagaraExternalSystemEditorUtilities.h
  • EditAnywhere
  • Category="Stack Item"
ModuleName FName Name of the module to reference. Requires a valid ScriptName. NiagaraExternalSystemEditorUtilities.h
  • EditAnywhere
  • Category="Stack Item"
RendererIndex int32 Index of a renderer to reference. Requires a valid EmitterName. NiagaraExternalSystemEditorUtilities.h
  • EditAnywhere
  • Category="Stack Item"
ScriptName FName   NiagaraExternalSystemEditorUtilities.h
  • EditAnywhere
  • Category="Stack Item"
System TObjectPtr< UNiagaraSystem >   NiagaraExternalSystemEditorUtilities.h
  • EditAnywhere
  • Category="Stack Item"

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedInput TWeakObjectPtr< UNiagaraStackFunctionInput >   NiagaraExternalSystemEditorUtilities.h  
CachedModule TWeakObjectPtr< UNiagaraStackModuleItem >   NiagaraExternalSystemEditorUtilities.h  
CachedScript TWeakObjectPtr< UNiagaraStackScriptItemGroup > IMPORTANT: These caches are only valid for a single operation and should never be stored long-term. NiagaraExternalSystemEditorUtilities.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FNiagaraEmitterHandle * GetEmitter ( FNiagaraExternalEditContext& Context,
bool bRequired
) const

   NiagaraExternalSystemEditorUtilities.h  

UNiagaraStackFunctionInput * GetInput ( FNiagaraExternalEditContext& Context,
bool bRequired
) const

   NiagaraExternalSystemEditorUtilities.h  

UNiagaraStackModuleItem * GetModule ( FNiagaraExternalEditContext& Context,
bool bRequired
) const

   NiagaraExternalSystemEditorUtilities.h  

UNiagaraRendererProperties * GetRenderer ( FNiagaraExternalEditContext& Context,
bool bRequired
) const

   NiagaraExternalSystemEditorUtilities.h  

UNiagaraStackScriptItemGroup * GetScript ( FNiagaraExternalEditContext& Context,
bool bRequired
) const

   NiagaraExternalSystemEditorUtilities.h  

UNiagaraSystem * GetSystem ( FNiagaraExternalEditContext& Context
) const

   NiagaraExternalSystemEditorUtilities.h  
  NiagaraExternalSystemEditorUtilities.h  

void PushInput ( FName Name
)

   NiagaraExternalSystemEditorUtilities.h  

void SetEmitter ( FNiagaraEmitterHandle* Emitter
)

   NiagaraExternalSystemEditorUtilities.h  

void SetEmitter ( FName InEmitterName
)

   NiagaraExternalSystemEditorUtilities.h  
  NiagaraExternalSystemEditorUtilities.h  

void SetInput ( FName Name
)

   NiagaraExternalSystemEditorUtilities.h  
  NiagaraExternalSystemEditorUtilities.h  

void SetModule ( FName InModuleName
)

   NiagaraExternalSystemEditorUtilities.h  

void SetRenderer ( int32 InRendererIndex
)

   NiagaraExternalSystemEditorUtilities.h  
  NiagaraExternalSystemEditorUtilities.h  

void SetScript ( FName InScriptName
)

   NiagaraExternalSystemEditorUtilities.h  

Operators

Name Remarks Include Path Unreal Specifiers
  NiagaraExternalSystemEditorUtilities.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page