1. Epic GamesDeveloper
  3. UNiagaraNodeWithDynamicPins

UNiagaraNodeWithDynamicPins

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

API > API/Plugins > API/Plugins/NiagaraEditor

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Abstract&41;  
class UNiagaraNodeWithDynamicPins : public UNiagaraNode

Remarks

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

Functions

  Type Name Description
Public function void

AddExistingParameter ( FNiagaraVariable Parameter,
const UEdGraphPin* AddPin
)

  
Public function void

AddParameter ( const UNiagaraScriptVariable* ScriptVar,
TEnumAsByte< EEdGraphPinDirection > Direction
)

 Request a new pin.
Public function void

AddParameter ( FNiagaraVariable Parameter,
TEnumAsByte< EEdGraphPinDirection > Direction
)

 Request a new pin.
Protected function Virtual Const bool  
Public function Virtual Const bool

AllowNiagaraTypeForAddPin ( const FNiagaraTypeDefinition& InType,
EEdGraphPinDirection InDirection
)

  
Public function Virtual Const bool Determine whether or not a Niagara type is supported for an Add Pin possibility.
Protected function Virtual Const bool

CanModifyPin ( const UEdGraphPin* Pin
)

 Called to determine if this node can modify a given pin at all.
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  
Public function Virtual Const void Virtual functions to allow for custom actions in Add Pin menus.
Protected function void

CreateAddPin ( EEdGraphPinDirection Direction
)

 Creates an add pin on the node for the specified direction.
Public function Virtual EEdGraphPinDirection 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.
Public function Const bool

IsExecPin ( const UEdGraphPin* Pin
)

 Helper to identify if a pin is an Add pin.
Protected function Virtual void

MoveDynamicPin ( UEdGraphPin* Pin,
int32 MoveAmount
)

 Moves a pin among the pins of the same direction. Negative values for up, positive for down.
Protected function Virtual void 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 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

  Type Name Description
Protected function Virtual Const void  
Protected function Virtual Const void  
Protected function Virtual Const bool  
Protected function Virtual Const bool

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

 Called in subclasses to restrict renaming.

Overridden from UEdGraphNode

  Type Name Description
Public function Virtual Const void Gets a list of actions that can be done to this particular node
Public function Virtual Const bool Does the node context menu inherit parent class's menu
Public function Virtual void 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page