UNiagaraNodeWithDynamicPins

A base node for niagara nodes with pins which can be dynamically added and removed by the user.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NiagaraEditor

Header

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

Include

#include "NiagaraNodeWithDynamicPins.h"

Syntax

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

Remarks

A base node for niagara nodes with pins which can be dynamically added and removed by the user.

Functions

Name Description

Public function

void

 

AddParameter

(
    const UNiagaraScriptVariable* ...,
    const UEdGraphPin* AddPin
)

Request a new pin.

Public function

void

 

AddParameter

(
    FNiagaraVariable Parameter,
    const UEdGraphPin* AddPin
)

Request a new pin.

Protected function Virtual Const

bool

 

AllowDynamicPins()

Public function Virtual Const

bool

 

AllowNiagaraTypeForAddPin

(
    const FNiagaraTypeDefinition& InTy...
)

Determine whether or not a Niagara type is supported for an Add Pin possibility.

Protected function Virtual Const

bool

 

CanMovePin

(
    const UEdGraphPin* Pin,
    int32 DirectionToMove
)

Called to determine if a pin can be moved by the user. Negative values for up, positive for down.

Protected function Virtual Const

bool

 

CanRemovePin

(
    const UEdGraphPin* Pin
)

Called to determine if a pin can be removed by the user.

Protected function Virtual Const

bool

 

CanRenamePin

(
    const UEdGraphPin* Pin
)

Called to determine if a pin can be renamed by the user.

Protected function Virtual Const

bool

 

CanRenamePinFromContextMenu

(
    const UEdGraphPin* Pin
)

Public function Virtual

void

 

CollectAddPinActions

(
    FGraphActionListBuilderBase& OutAc...,
    bool& bOutCreateRemainingActions,
    UEdGraphPin* Pin
)

Used in to gather the actions for selecting the pin to add.

Protected function

void

 

CreateAddPin

(
    EEdGraphPinDirection Direction
)

Creates an add pin on the node for the specified direction.

Protected function Virtual

EEdGraphPinD...

 

GetPinDirectionForNewParameters()

Convenience method to determine whether this Node is a Map Get or Map Set when adding a parameter through the parameter panel.

Public function Const

bool

 

IsAddPin

(
    const UEdGraphPin* Pin
)

Helper to identify if a pin is an Add pin.

Protected function Virtual

void

 

MoveDynamicPin

(
    UEdGraphPin* Pin,
    int32 DirectionToMove
)

Moves a pin among the pins of the same direction. Negative values for up, positive for down.

Protected function Virtual

void

 

OnNewTypedPinAdded

(
    UEdGraphPin*& NewPin
)

Called when a new typed pin is added by the user.

Protected function Virtual

void

 

OnPinRenamed

(
    UEdGraphPin* RenamedPin,
    const FString& OldPinName
)

Called when a pin is renamed.

Protected function Virtual

bool

 

OnVerifyTextChanged

(
    const FText& NewText,
    FText& OutMessage
)

Protected function Virtual

void

 

RemoveDynamicPin

(
    UEdGraphPin* Pin
)

Removes a pin from this node with a transaction.

Public function

UEdGraphPin ...

 

RequestNewTypedPin

(
    EEdGraphPinDirection Direction,
    const FNiagaraTypeDefinition& Type
)

Requests a new pin be added to the node with the specified direction and type.

Public function

UEdGraphPin ...

 

RequestNewTypedPin

(
    EEdGraphPinDirection Direction,
    const FNiagaraTypeDefinition& Type,
    FName InName
)

Requests a new pin be added to the node with the specified direction, type, and name.

Overridden from UNiagaraNode

Name Description

Protected function Virtual Const

bool

 

IsValidPinToCompile

(
    UEdGraphPin* Pin
)

Protected function Virtual Const

bool

 

VerifyEditablePinName

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

Called in subclasses to restrict renaming.

Overridden from UEdGraphNode

Name Description

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

bool

 

IncludeParentNodeContextMenu()

Does the node context menu inherit parent class's menu

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

Constants

Name

Description

AddPinSubCategory

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