Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
A base node for niagara nodes with pins which can be dynamically added and removed by the user.
| Name | UNiagaraNodeWithDynamicPins |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraNodeWithDynamicPins.h |
| Include Path | #include "NiagaraNodeWithDynamicPins.h" |
Syntax
UCLASS (Abstract)
class UNiagaraNodeWithDynamicPins : public UNiagaraNode
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEdGraphNode → UNiagaraNode → UNiagaraNodeWithDynamicPins
Derived Classes
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AddPinSubCategory | const FName | The sub category for add pins. | NiagaraNodeWithDynamicPins.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddExistingParameter
(
FNiagaraVariable Parameter, |
NiagaraNodeWithDynamicPins.h | ||
void AddParameter
(
const UNiagaraScriptVariable* ScriptVar, |
NiagaraNodeWithDynamicPins.h | ||
void AddParameter
(
FNiagaraVariable Parameter, |
Request a new pin. | NiagaraNodeWithDynamicPins.h | |
UEdGraphPin * AddParameterPin
(
FNiagaraVariable Parameter, |
NiagaraNodeWithDynamicPins.h | ||
UEdGraphPin * AddParameterPin
(
const UNiagaraScriptVariable* ScriptVar, |
NiagaraNodeWithDynamicPins.h | ||
virtual bool AllowNiagaraTypeForAddPin
(
const FNiagaraTypeDefinition& InType |
Determine whether or not a Niagara type is supported for an Add Pin possibility. | NiagaraNodeWithDynamicPins.h | |
virtual bool AllowNiagaraTypeForAddPin
(
const FNiagaraTypeDefinition& InType, |
NiagaraNodeWithDynamicPins.h | ||
virtual void CollectAddPinActions
(
FNiagaraMenuActionCollector& Collector, |
Virtual functions to allow for custom actions in Add Pin menus. | NiagaraNodeWithDynamicPins.h | |
virtual EEdGraphPinDirection GetPinDirectionForNewParameters() |
Convenience method to determine whether this Node is a Map Get or Map Set when adding a parameter through the parameter panel. | NiagaraNodeWithDynamicPins.h | |
bool IsExecPin
(
const UEdGraphPin* Pin |
Helper to identify if a pin is an Add pin. | NiagaraNodeWithDynamicPins.h | |
UEdGraphPin * RequestNewTypedPin
(
EEdGraphPinDirection Direction, |
Requests a new pin be added to the node with the specified direction and type. | NiagaraNodeWithDynamicPins.h | |
UEdGraphPin * RequestNewTypedPin
(
EEdGraphPinDirection Direction, |
Requests a new pin be added to the node with the specified direction, type, and name. | NiagaraNodeWithDynamicPins.h |
Overridden from UEdGraphNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetNodeContextMenuActions
(
UToolMenu* Menu, |
NiagaraNodeWithDynamicPins.h | ||
virtual bool IncludeParentNodeContextMenu() |
NiagaraNodeWithDynamicPins.h | ||
virtual void PinConnectionListChanged
(
UEdGraphPin* Pin |
NiagaraNodeWithDynamicPins.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AllowDynamicPins() |
NiagaraNodeWithDynamicPins.h | ||
virtual bool CanModifyPin
(
const UEdGraphPin* Pin |
Called to determine if this node can modify a given pin at all. | NiagaraNodeWithDynamicPins.h | |
virtual bool CanMovePin
(
const UEdGraphPin* Pin, |
Called to determine if a pin can be moved by the user. Negative values for up, positive for down. | NiagaraNodeWithDynamicPins.h | |
virtual bool CanRemovePin
(
const UEdGraphPin* Pin |
Called to determine if a pin can be removed by the user. | NiagaraNodeWithDynamicPins.h | |
virtual bool CanRenamePin
(
const UEdGraphPin* Pin |
Called to determine if a pin can be renamed by the user. | NiagaraNodeWithDynamicPins.h | |
virtual bool CanRenamePinFromContextMenu
(
const UEdGraphPin* Pin |
NiagaraNodeWithDynamicPins.h | ||
void CreateAddPin
(
EEdGraphPinDirection Direction |
Creates an add pin on the node for the specified direction. | NiagaraNodeWithDynamicPins.h | |
virtual void MoveDynamicPin
(
UEdGraphPin* Pin, |
Moves a pin among the pins of the same direction. Negative values for up, positive for down. | NiagaraNodeWithDynamicPins.h | |
virtual void OnNewTypedPinAdded
(
UEdGraphPin*& NewPin |
Called when a new typed pin is added by the user. | NiagaraNodeWithDynamicPins.h | |
virtual void OnPinRenamed
(
UEdGraphPin* RenamedPin, |
Called when a pin is renamed. | NiagaraNodeWithDynamicPins.h | |
| NiagaraNodeWithDynamicPins.h | |||
virtual void RemoveDynamicPin
(
UEdGraphPin* Pin |
Removes a pin from this node with a transaction. | NiagaraNodeWithDynamicPins.h |
Overridden from UNiagaraNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetCompilationInputPins
(
FPinCollectorArray& InputPins |
NiagaraNodeWithDynamicPins.h | ||
virtual void GetCompilationOutputPins
(
FPinCollectorArray& OutputPins |
NiagaraNodeWithDynamicPins.h | ||
virtual bool IsValidPinToCompile
(
UEdGraphPin* Pin |
NiagaraNodeWithDynamicPins.h | ||
virtual bool VerifyEditablePinName
(
const FText& InName, |
Called in subclasses to restrict renaming. | NiagaraNodeWithDynamicPins.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsAddPin
(
const UEdGraphPin* Pin |
Helper to identify if a pin is an Add pin. | NiagaraNodeWithDynamicPins.h |