1. Epic GamesDeveloper
  3. UNiagaraNode

UNiagaraNode

API > API/Plugins > API/Plugins/NiagaraEditor

   
Name UNiagaraNode
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNode.h
Include Path #include "NiagaraNode.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraNode : public UEdGraphNode

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraNode ( const FObjectInitializer& ObjectInitializer
)

   NiagaraNode.h  

Typedefs

Name Type Remarks Include Path
FOnNodeVisualsChanged TMulticastDelegate_OneParam< void, UNiagaraNode * >   NiagaraNode.h
FTranslator TNiagaraHlslTranslator< FNiagaraCompilationGraphBridge >   NiagaraNode.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddWidgetsToInputBox ( TSharedPtr< SVerticalBox > InputBox
)

 Virtual function to allow for custom widgets in the input or output box NiagaraNode.h  

virtual void AddWidgetsToOutputBox ( TSharedPtr< SVerticalBox > OutputBox
)

   NiagaraNode.h  

virtual bool AllowExternalPinTypeChanges ( const UEdGraphPin* InGraphPin
) const

 Determine whether we are allowed to change a pin's type from UI. NiagaraNode.h  

virtual bool AllowNiagaraTypeForPinTypeChange ( const FNiagaraTypeDefinition& InType,
UEdGraphPin* Pin
) const

 Determine whether or not a pin can be changed to a certain type. NiagaraNode.h  

bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 Entry point for generating the compile hash. NiagaraNode.h  

virtual void AppendFunctionAliasForContext ( const FNiagaraGraphFunctionAliasContext& InFunctionAliasContext,
FString& InOutFunctionAlias,
bool& OutOnlyOncePerNodeType
) const

   NiagaraNode.h  

virtual void BuildParameterMapHistory ( FNiagaraParameterMapHistoryBuilder& OutHistory,
bool bRecursive,
bool bFilterForCompilation
) const

 Adds the current node information to the parameter map history NiagaraNode.h  

virtual bool CanAddToGraph ( UNiagaraGraph* TargetGraph,
FString& OutErrorMsg
) const

 Apply any node-specific logic to determine if it is safe to add this node to the graph. NiagaraNode.h  

virtual bool CancelEditablePinName ( const FText& InName,
UEdGraphPin* InGraphPinObj
)

 Notify the rename was cancelled. NiagaraNode.h  

virtual bool CommitEditablePinName ( const FText& InName,
UEdGraphPin* InGraphPinObj,
bool bSuppressEvents
)

 Verify that the potential rename has produced acceptable results for a pin. NiagaraNode.h  

virtual void Compile ( FTranslator* Translator,
TArray< int32 >& Outputs
) const

   NiagaraNode.h  

virtual bool ConvertNumericPinToType ( UEdGraphPin* InGraphPin,
FNiagaraTypeDefinition TypeDef
)

 Convert the type of an existing numeric pin to a more known type. NiagaraNode.h  

virtual TSharedRef< SWidget > CreateTitleRightWidget()

   NiagaraNode.h  

void ForceChangeId ( const FGuid& InId,
bool bRaiseGraphNeedsRecompile
)

 Set the change id for this node to an explicit value. This should only be called by internal code. NiagaraNode.h  

virtual void GatherExternalDependencyData ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId,
FNiagaraScriptHashCollector& HashCollector
) const

 Go through all the external dependencies of this node in isolation and add them to the reference id list. NiagaraNode.h  

const FGuid & GetChangeId ()

 Get the change id for this node. NiagaraNode.h  

virtual TOptional< float > GetCompactModeFontSizeOverride()

   NiagaraNode.h  

virtual FText GetCompactTitle ()

 If this does not return an empty title, compact mode will be activated putting the text into the center of the node. NiagaraNode.h  

UEdGraphPin * GetInputPin ( int32 InputIndex
) const

   NiagaraNode.h  

void GetInputPins ( ContainerType& OutInputPins
) const

   NiagaraNode.h  

bool GetIsPinRenamePending ( const UEdGraphPin* Pin
)

 Returns whether or not the supplied pin has a rename pending. NiagaraNode.h  
  NiagaraNode.h  
Get the Niagara graph that owns this node NiagaraNode.h  

virtual ENiagaraNumericOutputTypeSelectionMode GetNumericOutputTypeSelectionMode()

 Gets which mode to use when deducing the type of numeric output pins from the types of the input pins. NiagaraNode.h  

UEdGraphPin * GetOutputPin ( int32 OutputIndex
) const

   NiagaraNode.h  

void GetOutputPins ( ContainerType& OutOutputPins
) const

   NiagaraNode.h  

virtual UEdGraphPin * GetPassThroughPin ( const UEdGraphPin* LocallyOwnedOutputPin,
ENiagaraScriptUsage InUsage
) const

   NiagaraNode.h  

UEdGraphPin * GetPinByPersistentGuid ( const FGuid& InGuid
) const

   NiagaraNode.h  

virtual UObject * GetReferencedAsset()

 Gets the asset referenced by this node, or nullptr if there isn't one. NiagaraNode.h  

UNiagaraScriptSource * GetSource()

 Get the source object NiagaraNode.h  

virtual UEdGraphPin * GetTracedOutputPin ( UEdGraphPin* LocallyOwnedOutputPin,
bool bFilterForCompilation,
TArray< const UNiagaraNode* >* OutNodesVisitedDuringTrace
) const

 Traces one of this node's output pins to its source output pin. NiagaraNode.h  

virtual void GetWildcardPinHoverConnectionTextAddition ( const UEdGraphPin* WildcardPin,
const UEdGraphPin* OtherPin,
ECanCreateConnectionResponse ConnectionResponse,
FString& OutString
) const

   NiagaraNode.h  

bool IsParameterMapPin ( const UEdGraphPin* Pin
) const

   NiagaraNode.h  

virtual bool IsPinNameEditable ( const UEdGraphPin* GraphPinObj
) const

 Determine whether or not a pin should be renamable. NiagaraNode.h  

virtual bool IsPinNameEditableUponCreation ( const UEdGraphPin* GraphPinObj
) const

 Determine whether or not a specific pin should immediately be opened for rename. NiagaraNode.h  

void MarkNodeRequiresSynchronization ( FString Reason,
bool bRaiseGraphNeedsRecompile
)

 Identify that this node has undergone changes that will require synchronization with a compiled script. NiagaraNode.h  

FOnNodeVisualsChanged & OnVisualsChanged()

   NiagaraNode.h  

virtual void OpenReferencedAsset()

   NiagaraNode.h  

virtual bool RefreshFromExternalChanges ()

 Refreshes the node due to external changes, e.g. the underlying function changed for a function call node. NiagaraNode.h  

void RequestNewPinType ( UEdGraphPin* PinToChange,
FNiagaraTypeDefinition NewType
)

 Request a pin type change to a specific type. NiagaraNode.h  

virtual void ResolveNumerics ( const UEdGraphSchema_Niagara* Schema,
bool bSetInline,
TMap< TPair< FGuid, class UEdGraphNode* >, FNiagaraTypeDefinition >* PinCache
)

   NiagaraNode.h  

void SetIsPinRenamePending ( const UEdGraphPin* Pin,
bool bInIsRenamePending
)

 Sets whether or not the supplied pin has a rename pending. NiagaraNode.h  

virtual bool ShouldShowPinNamesInCompactMode()

   NiagaraNode.h  

virtual bool SubstituteCompiledPin ( FTranslator* Translator,
UEdGraphPin** LocallyOwnedPin
)

 Allows a node to replace a pin that is about to be compiled with another pin. NiagaraNode.h  

virtual void UpdateCompileHashForNode ( FSHA1& HashState
) const

 Old style compile hash code. To be removed in the future. NiagaraNode.h  

virtual bool VerifyEditablePinName ( const FText& InName,
FText& OutErrorMessage,
const UEdGraphPin* InGraphPinObj
) const

 Verify that the potential rename has produced acceptable results for a pin. NiagaraNode.h  

Overridden from UEdGraphNode

Name Remarks Include Path Unreal Specifiers

virtual void AutowireNewNode ( UEdGraphPin* FromPin
)

   NiagaraNode.h  

virtual bool CanCreateUnderSpecifiedSchema ( const UEdGraphSchema* Schema
) const

   NiagaraNode.h  

virtual TSharedPtr< SGraphNode > CreateVisualWidget()

   NiagaraNode.h  

virtual void GetNodeContextMenuActions ( UToolMenu* Menu,
UGraphNodeContextMenuContext* Context
) const

   NiagaraNode.h  

virtual UEdGraphPin * GetPassThroughPin ( const UEdGraphPin* LocallyOwnedOutputPin
) const

   NiagaraNode.h  

virtual void GetPinHoverText ( const UEdGraphPin& Pin,
FString& HoverTextOut
) const

   NiagaraNode.h  

virtual void NodeConnectionListChanged()

   NiagaraNode.h  

virtual void OnPinRemoved ( UEdGraphPin* InRemovedPin
)

   NiagaraNode.h  

virtual void OnRenameNode ( const FString& NewName
)

   NiagaraNode.h  

virtual void PinConnectionListChanged ( UEdGraphPin* Pin
)

   NiagaraNode.h  

virtual void PinDefaultValueChanged ( UEdGraphPin* Pin
)

   NiagaraNode.h  

virtual void PinTypeChanged ( UEdGraphPin* Pin
)

   NiagaraNode.h  

virtual void PostPlacedNewNode()

   NiagaraNode.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   NiagaraNode.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual int32 CompileInputPin ( FTranslator* Translator,
UEdGraphPin* Pin
) const

   NiagaraNode.h  

bool CompileInputPins ( FTranslator* Translator,
TArray< int32 >& OutCompiledInputs
) const

   NiagaraNode.h  

virtual bool GenerateCompileHashForClassMembers ( const UClass* InClass,
FNiagaraCompileHashVisitor* InVisitor
) const

 Go through all class members for a given UClass on this object and hash them into the visitor. NiagaraNode.h  

virtual void GetCompilationInputPins ( FPinCollectorArray& InputPins
) const

   NiagaraNode.h  

virtual void GetCompilationOutputPins ( FPinCollectorArray& OutputPins
) const

   NiagaraNode.h  

void GetInputPinsInternal ( ContainerType& OutInputPins
) const

   NiagaraNode.h  

void GetOutputPinsInternal ( ContainerType& OutOutputPins
) const

   NiagaraNode.h  

bool GetTooltipTextForKnownPin ( const UEdGraphPin& Pin,
FText& OutTooltip
) const

 If the pin is a known name (like Engine.DeltaTime) this tries to return a default tooltip for it. NiagaraNode.h  

virtual bool IsValidPinToCompile ( UEdGraphPin* Pin
) const

   NiagaraNode.h  

virtual bool NestedPropertiesAppendCompileHash ( const void* Container,
const UStruct* Struct,
EFieldIteratorFlags::SuperClassFlags IteratorFlags,
const FString& BaseName,
FNiagaraCompileHashVisitor* InVisitor
) const

 Helper function to hash arbitrary UProperty entries (Arrays, Maps, Structs, etc). NiagaraNode.h  

bool NiagaraNodeAppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 Write out the specific entries for UNiagaraNode into the visitor hash. NiagaraNode.h  

void NumericResolutionByPins ( const UEdGraphSchema_Niagara* Schema,
TArrayView< UEdGraphPin*const > InputPins,
TArrayView< UEdGraphPin*const > OutputPins,
bool bFixInline,
TMap< TPair< FGuid, UEdGraphNode* >, FNiagaraTypeDefinition >* PinCache
)

   NiagaraNode.h  

virtual bool OnNewPinTypeRequested ( UEdGraphPin* PinToChange,
FNiagaraTypeDefinition NewType
)

 Pin type changes are handled by the individual subclasses to account for pin sets (like the if node or select node) NiagaraNode.h  

virtual void OnPostSynchronizationInReallocatePins()

   NiagaraNode.h  

virtual bool PinAppendCompileHash ( const UEdGraphPin* InPin,
FNiagaraCompileHashVisitor* InVisitor
) const

 Write out the specific entries of this pin to the visitor hash. NiagaraNode.h  

virtual bool PODPropertyAppendCompileHash ( const void* Container,
FProperty* Property,
const FString& PropertyName,
FNiagaraCompileHashVisitor* InVisitor
) const

 For a simple Plain old data type UProperty, hash the data. NiagaraNode.h  

bool ReallocatePins ( bool bMarkNeedsResynchronizeOnChange
)

   NiagaraNode.h  

virtual void RegisterPassthroughPin ( FNiagaraParameterMapHistoryBuilder& OutHistory,
UEdGraphPin* InputPin,
UEdGraphPin* OutputPin,
bool bFilterForCompilation,
bool bVisitInputPin
) const

 Basically routes the pin through the parameter map builder so that it looks like a regular pin. NiagaraNode.h  

virtual FNiagaraTypeDefinition ResolveCustomNumericType ( const TArray< FNiagaraTypeDefinition >& NonNumericInputs
) const

   NiagaraNode.h  

virtual void RouteParameterMapAroundMe ( FNiagaraParameterMapHistoryBuilder& OutHistory,
bool bRecursive
) const

 Route input parameter map to output parameter map if it exists. NiagaraNode.h  

Overridden from UEdGraphNode

Name Remarks Include Path Unreal Specifiers

virtual void GatherForLocalization ( FPropertyLocalizationDataGatherer& PropertyLocalizationDataGatherer,
const EPropertyLocalizationGathererTextFlags GatherTextFlags
) const

   NiagaraNode.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool SetPinDefaultToTypeDefaultIfUnset ( UEdGraphPin* InPin
)

   NiagaraNode.h  

static UEdGraphPin * TraceOutputPin ( UEdGraphPin* LocallyOwnedOutputPin,
bool bFilterForCompilation,
TArray< const UNiagaraNode* >* OutNodesVisitedDuringTrace
)

 Traces a node's output pins to its source output pin. NiagaraNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page