1. Epic GamesDeveloper
  3. UNiagaraNode

UNiagaraNode

Unreal Engine C++ API Reference > Plugins > NiagaraEditor

Inheritance Hierarchy

References

   
Module NiagaraEditor
Header /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNode.h
Include #include "NiagaraNode.h"

Syntax

UCLASS&40;MinimalAPI&41;  
class UNiagaraNode : public UEdGraphNode

Variables

  Type Name Description
Protected variable UProperty FGuid ChangeId The current change identifier for this node. Used to sync status with UNiagaraScripts.
Protected variable TArray< FGuid > PinsGuidsWithRenamePending  
Protected variable FOnNodeVisualsChanged VisualsChangedDelegate  

Constructors

  Type Name Description
Public function  

UNiagaraNode ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void Virtual function to allow for custom widgets in the input or output box
Public function Virtual void  
Public function Virtual Const bool Determine whether we are allowed to change a pin's type from UI.
Public function Virtual Const bool Determine whether or not a pin can be changed to a certain type.
Public function Const bool Entry point for generating the compile hash.
Public function Virtual Const void

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

  
Public function Virtual Const void

BuildParameterMapHistory ( FNiagaraParameterMapHistoryBuilder& OutHistory,
bool bRecursive,
bool bFilterForCompilation
)

 Adds the current node information to the parameter map history
Public function Virtual Const bool

CanAddToGraph ( UNiagaraGraph* TargetGraph,
FString& OutErrorMsg
)

 Apply any node-specific logic to determine if it is safe to add this node to the graph.
Public function Virtual bool

CancelEditablePinName ( const FText& InName,
UEdGraphPin* InGraphPinObj
)

 Notify the rename was cancelled.
Public function Virtual bool

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

 Verify that the potential rename has produced acceptable results for a pin.
Public function Virtual Const void

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

  
Protected function Virtual Const int32

CompileInputPin ( FTranslator* Translator,
UEdGraphPin* Pin
)

  
Protected function Const bool

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

  
Public function Virtual bool Convert the type of an existing numeric pin to a more known type.
Public function Virtual TSharedRef< SWidget >  
Public function 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.
Public function Virtual Const void

GatherExternalDependencyData ( ENiagaraScriptUsage InUsage,
const FGuid& InUsageId,
TArray< FNiagaraCompileHash >& InReferencedCompileHashes,
TArray< FString >& InReferencedObjs
)

 Go through all the external dependencies of this node in isolation and add them to the reference id list.
Protected function Virtual Const bool Go through all class members for a given UClass on this object and hash them into the visitor.
Public function Const const FGuid & Get the change id for this node.
Public function Virtual Const TOptional< float >  
Public function Virtual Const FText If this does not return an empty title, compact mode will be activated putting the text into the center of the node.
Protected function Virtual Const void  
Protected function Virtual Const void  
Public function Const UEdGraphPin *

GetInputPin ( int32 InputIndex
)

  
Public function Const void

GetInputPins ( ContainerType& OutInputPins
)

  
Protected function Const void

GetInputPinsInternal ( ContainerType& OutInputPins
)

  
Public function bool Returns whether or not the supplied pin has a rename pending.
Public function UNiagaraGraph * Get the Niagara graph that owns this node
Public function Const const UNiagaraGraph * Get the Niagara graph that owns this node
Public function Virtual Const ENiagaraNumericOutputTypeSelectionMode Gets which mode to use when deducing the type of numeric output pins from the types of the input pins.
Public function Const UEdGraphPin *

GetOutputPin ( int32 OutputIndex
)

  
Public function Const void

GetOutputPins ( ContainerType& OutOutputPins
)

  
Protected function Const void

GetOutputPinsInternal ( ContainerType& OutOutputPins
)

  
Public function Virtual Const UEdGraphPin *

GetPassThroughPin ( const UEdGraphPin* LocallyOwnedOutputPin,
ENiagaraScriptUsage InUsage
)

  
Public function Const UEdGraphPin *

GetPinByPersistentGuid ( const FGuid& InGuid
)

  
Public function Virtual Const UObject * Gets the asset referenced by this node, or nullptr if there isn't one.
Public function Const UNiagaraScriptSource * Get the source object
Protected function Const bool

GetTooltipTextForKnownPin ( const UEdGraphPin& Pin,
FText& OutTooltip
)

 If the pin is a known name (like Engine.DeltaTime) this tries to return a default tooltip for it.
Public function Virtual Const UEdGraphPin *

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

 Traces one of this node's output pins to its source output pin.
Public function Virtual Const void

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

  
Public function Const bool  
Public function Virtual Const bool

IsPinNameEditable ( const UEdGraphPin* GraphPinObj
)

 Determine whether or not a pin should be renamable.
Public function Virtual Const bool Determine whether or not a specific pin should immediately be opened for rename.
Protected function Virtual Const bool  
Public function void

MarkNodeRequiresSynchronization ( FString Reason,
bool bRaiseGraphNeedsRecompile
)

 Identify that this node has undergone changes that will require synchronization with a compiled script.
Protected function Virtual Const bool

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

 Helper function to hash arbitrary UProperty entries (Arrays, Maps, Structs, etc).
Protected function Const bool Write out the specific entries for UNiagaraNode into the visitor hash.
Protected function void

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

  
Protected function Virtual bool Pin type changes are handled by the individual subclasses to account for pin sets (like the if node or select node)
Protected function Virtual void  
Public function FOnNodeVisualsChanged &  
Public function Virtual Const void  
Protected function Virtual Const bool Write out the specific entries of this pin to the visitor hash.
Protected function Virtual Const bool

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

 For a simple Plain old data type UProperty, hash the data.
Protected function bool

ReallocatePins ( bool bMarkNeedsResynchronizeOnChange
)

  
Public function Virtual bool Refreshes the node due to external changes, e.g. the underlying function changed for a function call node.
Protected function Virtual Const void

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

 Basically routes the pin through the parameter map builder so that it looks like a regular pin.
Public function void Request a pin type change to a specific type.
Protected function Virtual Const FNiagaraTypeDefinition

ResolveCustomNumericType ( const TArray< FNiagaraTypeDefinition >& NonNumericInputs
)

  
Public function Virtual void

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

  
Protected function Virtual Const void Route input parameter map to output parameter map if it exists.
Public function void

SetIsPinRenamePending ( const UEdGraphPin* Pin,
bool bInIsRenamePending
)

 Sets whether or not the supplied pin has a rename pending.
Public function Static bool  
Public function Virtual bool  
Public function Virtual bool

SubstituteCompiledPin ( FTranslator* Translator,
UEdGraphPin** LocallyOwnedPin
)

 Allows a node to replace a pin that is about to be compiled with another pin.
Public function Static UEdGraphPin *

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

 Traces a node's output pins to its source output pin.
Public function Virtual Const void Old style compile hash code. To be removed in the future.
Public function Virtual Const bool

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

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

Overridden from UEdGraphNode

  Type Name Description
Public function Virtual void Autowire a newly created node.
Public function Virtual Const bool Determine if this node can be created under the specified schema
Public function Virtual TSharedPtr< SGraphNode > Create a visual widget to represent this node in a graph editor or graph panel.
Protected function Virtual Const void

GatherForLocalization ( FPropertyLocalizationDataGatherer& PropertyLocalizationDataGatherer,
const EPropertyLocalizationGathererTextFlags GatherTextFlags
)

  
Public function Virtual Const void Gets a list of actions that can be done to this particular node
Public function Virtual Const UEdGraphPin *

GetPassThroughPin ( const UEdGraphPin* FromPin
)

 Return the matching "pass-through" pin for the given pin (if supported by this node)
Public function Virtual Const void

GetPinHoverText ( const UEdGraphPin& Pin,
FString& HoverTextOut
)

 Fetch the hover text for a pin when the graph is being edited.
Public function Virtual void Called when something external to this node has changed the connection list of any of the pins in the node
Public function Virtual void

OnPinRemoved ( UEdGraphPin* InRemovedPin
)

 Called when a pin is removed
Public function Virtual void

OnRenameNode ( const FString& NewName
)

 Called when this node is being renamed after a successful name validation
Public function Virtual void Called when the connection list of one of the pins of this node is changed in the editor
Public function Virtual void Called when the DefaultValue of one of the pins of this node is changed in the editor
Public function Virtual void Called when one of the pins of this node has had its' pin type changed from an external source (like the SPinTypeSelector in the case of kismet)
Public function Virtual void A chance to initialize a new node; called just once when a new node is created, before AutowireNewNode or AllocateDefaultPins is called.

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name Description
FOnNodeVisualsChanged  
FTranslator  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page