UNiagaraNode

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NiagaraEditor

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNode.h

Include

#include "NiagaraNode.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UNiagaraNode : public UEdGraphNode

Variables

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

FOnNodeVisualsC...

 

VisualsChangedDelegate

Constructors

Name Description

Public function

UNiagaraNode

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

AppendCompileHash

(
    FNiagaraCompileHashVisitor* In...
)

Entry point for generating the compile hash.

Public function Virtual

void

 

AppendFunctionAliasForContext

(
    const FNiagaraGraphFunctionAliasCon...,
    FString& InOutFunctionAlias
)

Public function Virtual Const

void

 

BuildParameterMapHistory

(
    FNiagaraParameterMapHistoryBuilder ...,
    bool bRecursive,
    bool bFilterForCompilation
)

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

void

 

Compile

(
    FHlslNiagaraTranslator* Transl...,
    TArray< int32 >& Outputs
)

Protected function Virtual

int32

 

CompileInputPin

(
    FHlslNiagaraTranslator* Transl...,
    UEdGraphPin* Pin
)

Protected function

bool

 

CompileInputPins

(
    FHlslNiagaraTranslator* Transl...,
    TArray< int32 >& OutCompiledInputs
)

Public function Virtual

bool

 

ConvertNumericPinToType

(
    UEdGraphPin* InGraphPin,
    FNiagaraTypeDefinition TypeDef
)

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

Public function

void

 

ForceChangeId

(
    const FGuid& InId,
    bool bRaiseGraphNeedsRecompile
)

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

Public function Virtual Const

void

 

GatherExternalDependencyData

(
    ENiagaraScriptUsage InMasterUsage,
    const FGuid& InMasterUsageId,
    TArray< FNiagaraCompileHash >& InR...,
    TArray< FString >& InReferencedObj...
)

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

Protected function Virtual Const

bool

 

GenerateCompileHashForClassMembers

(
    const UClass* InClass,
    FNiagaraCompileHashVisitor* In...
)

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

Public function Const

const FGuid ...

 

GetChangeId()

Get the change id for this node.

Public function Const

UEdGraphPin ...

 

GetInputPin

(
    int32 InputIndex
)

Public function Const

void

 

GetInputPins

(
    TArray< const class UEdGraphPin...
)

Public function Const

void

 

GetInputPins

(
    TArray< class UEdGraphPin* >&...
)

Public function

bool

 

GetIsPinRenamePending

(
    const UEdGraphPin* Pin
)

Returns whether or not the supplied pin has a rename pending.

Public function

UNiagaraGrap...

 

GetNiagaraGraph()

Get the Niagara graph that owns this node

Public function Const

const UNiaga...

 

GetNiagaraGraph()

Get the Niagara graph that owns this node

Public function Virtual Const

ENiagaraNume...

 

GetNumericOutputTypeSelectionMode()

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

(
    TArray< const class UEdGraphPin...
)

Public function Const

void

 

GetOutputPins

(
    TArray< class UEdGraphPin* >&...
)

Public function Virtual Const

UEdGraphPin ...

 

GetPassThroughPin

(
    const UEdGraphPin* LocallyOwne...,
    ENiagaraScriptUsage MasterUsage
)

Public function Const

UEdGraphPin ...

 

GetPinByPersistentGuid

(
    const FGuid& InGuid
)

Public function Virtual Const

UObject *...

 

GetReferencedAsset()

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

Public function Const

UNiagaraScri...

 

GetSource()

Get the source object

Public function Virtual Const

UEdGraphPin ...

 

GetTracedOutputPin

(
    UEdGraphPin* LocallyOwnedOutpu...
)

Traces one of this node's output pins to its source output pin if it is a reroute node output pin.

Public function Virtual Const

bool

 

IsPinNameEditable

(
    const UEdGraphPin* GraphPinObj
)

Determine whether or not a pin should be renamable.

Public function Virtual Const

bool

 

IsPinNameEditableUponCreation

(
    const UEdGraphPin* GraphPinObj
)

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

Protected function Virtual Const

bool

 

IsValidPinToCompile

(
    UEdGraphPin* Pin
)

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::SuperClassFlag...,
    const FString& BaseName,
    FNiagaraCompileHashVisitor* In...
)

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

Protected function Const

bool

 

NiagaraNodeAppendCompileHash

(
    FNiagaraCompileHashVisitor* In...
)

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

Protected function

void

 

NumericResolutionByPins

(
    const UEdGraphSchema_Niagara* ...,
    TArray< UEdGraphPin* >& Input...,
    TArray< UEdGraphPin* >& Outpu...,
    bool bFixInline,
    TMap< TPair< FGuid, UEdGraphNode&#...
)

Public function

FOnNodeVisua...

 

OnVisualsChanged()

Protected function Virtual Const

bool

 

PinAppendCompileHash

(
    const UEdGraphPin* InPin,
    FNiagaraCompileHashVisitor* In...
)

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* In...
)

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

Protected function

bool

 

ReallocatePins

(
    bool bMarkNeedsResynchronizeOnChang...
)

Public function Virtual

bool

 

RefreshFromExternalChanges()

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

Public function Virtual

void

 

ResolveNumerics

(
    const UEdGraphSchema_Niagara* ...,
    bool bSetInline,
    TMap< TPair< FGuid, UEdGraphNode&#...
)

Protected function Virtual Const

void

 

RouteParameterMapAroundMe

(
    FNiagaraParameterMapHistoryBuilder ...,
    bool bRecursive
)

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 Virtual

bool

 

SubstituteCompiledPin

(
    FHlslNiagaraTranslator* Transl...,
    UEdGraphPin** LocallyOwned...
)

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

Public function Virtual

void

 

SubsumeExternalDependencies

(
    TMap< const UObject*, UObject ...
)

Determine if there are any external dependencies wrt to scripts and ensure that those dependencies are sucked into the existing package.

Public function Static

UEdGraphPin ...

 

TraceOutputPin

(
    UEdGraphPin* LocallyOwnedOutpu...,
    bool bFilterForCompilation
)

Public function Virtual Const

void

 

UpdateCompileHashForNode

(
    FSHA1& HashState
)

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

Public function Virtual Const

bool

 

VerifyEditablePinName

(
    const FText& InName,
    FText& OutErrorMessage,
    const UEdGraphPin* InGraphPinO...
)

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

Overridden from UEdGraphNode

Name Description

Public function Virtual

void

 

AutowireNewNode

(
    UEdGraphPin* FromPin
)

Autowire a newly created node.

Public function Virtual Const

bool

 

CanCreateUnderSpecifiedSchema

(
    const UEdGraphSchema* Schema
)

Determine if this node can be created under the specified schema

Public function Virtual

TSharedPtr< ...

 

CreateVisualWidget()

Create a visual widget to represent this node in a graph editor or graph panel.

Protected function Virtual Const

void

 

GatherForLocalization

Public function Virtual Const

void

 

GetNodeContextMenuActions

(
    UToolMenu* Menu,
    UGraphNodeContextMenuContext* ...
)

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

 

NodeConnectionListChanged()

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

 

PinConnectionListChanged

(
    UEdGraphPin* Pin
)

Called when the connection list of one of the pins of this node is changed in the editor

Public function Virtual

void

 

PinDefaultValueChanged

(
    UEdGraphPin* Pin
)

Called when the DefaultValue of one of the pins of this node is changed in the editor

Public function Virtual

void

 

PinTypeChanged

(
    UEdGraphPin* Pin
)

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

 

PostPlacedNewNode()

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

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name

Description

FOnNodeVisualsChanged

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss