1. Epic GamesDeveloper
  3. UK2Node

UK2Node

Abstract base class of all blueprint graph nodes.

Unreal Engine C++ API Reference > Editor > BlueprintGraph

Inheritance Hierarchy

References

   
Module BlueprintGraph
Header /Engine/Source/Editor/BlueprintGraph/Classes/K2Node.h
Include #include "K2Node.h"

Syntax

class UK2Node : public UEdGraphNode

Remarks

Abstract base class of all blueprint graph nodes.

Constructors

  Type Name Description
Public function  

UK2Node ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const bool

AllowMultipleSelfs ( bool bInputAsArray
)

  
Protected function void Attempt to broadcast an event for a user-defined pin being renamed on this node
Public function Virtual Const bool Return whether the node's execution pins should support the insert execution pin action
Public function Virtual Const bool Return whether the node's execution pins should support the remove execution pin action
Public function Virtual Const bool Returns whether this node can have breakpoints placed on it in the debugger
Public function Virtual void Clears out any cached data that needs to be regenerated after a structural blueprint change
Public function Virtual void

ConvertDeprecatedNode ( UEdGraph* Graph,
bool bOnlySafeChanges
)

 Performs a node-specific deprecation fixup, which may delete this node and replace it with another one
Public function Virtual Const FNodeHandlingFunctor *  
Public function bool

CreatePinsForFunctionEntryExit ( const UFunction* Function,
bool bForFunctionEntry
)

 Creates the pins required for a function entry or exit node (only inputs as outputs or outputs as inputs respectively)
Protected function void Helper function to properly destroy a set of pins.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function bool  
Protected function Virtual Const ERedirectType

DoPinsMatchForReconstruction ( const UEdGraphPin* NewPin,
int32 NewPinIndex,
const UEdGraphPin* OldPin,
int32 OldPinIndex
)

 Whether or not two pins match for purposes of reconnection after reconstruction.
Public function Virtual Const bool Return whether to draw this node as an entry
Public function Virtual Const bool Return whether to draw this node as an entry
Public function Virtual Const bool Return whether to draw this node as a small variable node
Public function Virtual Const void This function if used for nodes that needs CDO for validation (Called before expansion)
Public function Virtual void

ExpandNode ( FKismetCompilerContext& CompilerContext,
UEdGraph* SourceGraph
)

 Expands a node while compiling, which may add additional nodes or delete this node
Public function UK2Node *

ExpandSplitPin ( FKismetCompilerContext* CompilerContext,
UEdGraph* SourceGraph,
UEdGraphPin* Pin
)

  
Public function void

ExpandSplitPins ( FKismetCompilerContext& CompilerContext,
UEdGraph* SourceGraph
)

 Helper function for ExpandNode(), allowing other contexts to call pin expansion alone
Protected function Virtual void Handle backwards compatible fixes on load
Protected function Virtual void Fixes up structure/soft object ref pins, on both save and load
Public function Const UBlueprint * Get the Blueprint object to which this node belongs
Public function Const UClass * Util to get the generated class from a node.
Public function Virtual Const FText Return title if drawing this node in 'compact' mode
Public function Virtual Const FName  
Public function Virtual Const UClass * Returns which dynamic binding class (if any) to use for this node.
Public function Const UEdGraphPin * Get the input execution pin of this node (if one exists)
Public function Virtual Const void Replacement for GetMenuEntries().
Public function Virtual Const FText Override to provide a default category for specific node types to be listed under.
Public function Virtual Const void

GetNodeAttributes ( TArray< TKeyValuePair< FString, FString >>& OutNodeAttributes
)

 This function returns an arbitrary number of attributes that describe this node for analytics events
Public function Virtual Const int32  
Protected function Virtual Const void

GetRedirectPinNames ( const UEdGraphPin& Pin,
TArray< FString >& RedirectPinNames
)

 Determines what the possible redirect pin names are
Public function Virtual Const AActor * If this node references an actor in the level that should be selectable by "Find Actors In Level," this will return a reference to that actor
Public function Virtual Const FBlueprintNodeSignature Retrieves a unique identifier for this node type.
Public function Const UEdGraphPin * Get the output then pin of this node (if one exists)
Public function Virtual Const FText  
Public function Virtual void

HandleVariableRenamed ( UBlueprint* InBlueprint,
UClass* InVariableClass,
UEdGraph* InGraph,
const FName& InOldVarName,
const FName& InNewVarName
)

 Handle when a variable is renamed in the Blueprint Palette
Public function Const bool Return true if this node has a valid blueprint outer, or false otherwise.
Public function void

InsertNewNode ( UEdGraphPin* FromPin,
UEdGraphPin* NewLinkPin,
TSet< UEdGraphNode* >& OutNodeList
)

 Handles inserting the node between the FromPin and what the FromPin was original connected to
Public function Virtual bool Determine if the node of this type should be filtered in the actions menu
Public function Virtual Const bool

IsConnectionDisallowed ( const UEdGraphPin* MyPin,
const UEdGraphPin* OtherPin,
FString& OutReason
)

  
Public function Virtual Const bool Returns whether this node is considered 'pure' by the compiler
Public function Virtual Const bool Query if this node should be kept as part of the root set during the pruning stage of compilation.
Public function Virtual Const bool Query if this is a node that is safe to ignore (e.g., a comment node or other non-structural annotation that can be pruned with no warnings).
Protected function Const void

Message_Error ( const FString& Message,
ArgTypes... Args
)

  
Protected function Const void

Message_Note ( const FString& Message,
ArgTypes... Args
)

 Sends a message to the owning blueprint's CurrentMessageLog, if there is one available.
Protected function Const void

Message_Warn ( const FString& Message,
ArgTypes... Args
)

  
Public function Virtual Const bool Return true if adding/removing this node requires calling MarkBlueprintAsStructurallyModified on the Blueprint
Public function Virtual void Called when the connection list of one of the pins of this node is changed in the editor, after the pin has had it's literal cleared
Public function FOnUserDefinedPinRenamed & Retrieves a delegate that is called when a user-defined pin on this node is renamed
Public function Virtual void Called at the end of ReconstructNode, allows node specific work to be performed
Protected function void

PreloadObject ( UObject* ReferencedObject
)

 Ensures the specified object is preloaded. ReferencedObject can be NULL.
Public function Virtual void Called before compilation begins, giving a blueprint time to force the linker to load data
Public function Virtual void Reallocate pins during reconstruction; by default ignores the old pins and calls AllocateDefaultPins() If you override this to create additional pins you likely need to call RestoreSplitPins to restore any pins that have been split (e.g. a vector pin split into its components)
Protected function void

ReconstructSinglePin ( UEdGraphPin* NewPin,
UEdGraphPin* OldPin,
ERedirectType RedirectType
)

 Handles the actual reconstruction (copying data, links, name, etc...) from two pins that have already been matched together.
Public function Virtual Const bool

ReferencesFunction ( const FName& InFunctionName,
const UStruct* InScope
)

 Return whether this node references the specified function, identified by a name and guid pair
Public function Virtual Const bool

ReferencesVariable ( const FName& InVarName,
const UStruct* InScope
)

 Return whether this node references the specified variable, give the supplied scope.
Public function Virtual Const void Puts information about this node into the dynamic binding object.
Public function ERenamePinResult

RenameUserDefinedPin ( const FName OldName,
const FName NewName,
bool bTest
)

 Renames a user defined pin and broadcasts the result to any OnUserDefinedPinRenamed listeners on success (if bTest is false)
Protected function Virtual ERenamePinResult

RenameUserDefinedPinImpl ( const FName OldName,
const FName NewName,
bool bTest
)

 Implementation function that renames an existing pin on the node. Does not broadcast notifications.
Public function Virtual void

ReplaceReferences ( UBlueprint* InBlueprint,
UBlueprint* InReplacementBlueprint,
const FMemberReference& InSource,
const FMemberReference& InReplacement
)

 Replace any member references of source with replacement
Protected function void Helper function to restore Split Pins after ReallocatePinsDuringReconstruction, call after recreating all pins to restore split pin state.
Protected function void

RewireOldPinsToNewPins ( TArray< UEdGraphPin* >& InOldPins,
TArray< UEdGraphPin* >& InNewPins,
TMap< UEdGraphPin*, UEdGraphPin* >* NewPinToOldPin
)

 Helper function to rewire old pins to new pins during node reconstruction (or other regeneration of pins)
Public function Virtual Const bool Should draw as a bead with no location of it's own
Public function Virtual Const bool Should draw compact
Protected function Const ERedirectType

ShouldRedirectParam ( const TArray< FString >& OldPinNames,
FName& NewPinName,
const UK2Node* NewPinNode
)

 Searches ParamRedirect Map and find if there is matching new paramreturns the redirect type
Public function Virtual Const bool Return whether the node's properties display in the blueprint details panel

Overridden from UEdGraphNode

  Type Name Description
Public function Virtual void Autowire a newly created node.
Public function Virtual Const bool Can this node be created under the specified schema.
Public function Virtual Const bool Returns true if it is possible to jump to the definition of this node (e.g., if it's a variable get or a function call)
Public function Virtual Const bool

CanSplitPin ( const UEdGraphPin* Pin
)

 Whether or not struct pins belonging to this node should be allowed to be split or not.
Public function Virtual Const FString Returns the link used for external documentation for the graph node
Public function Virtual Const UObject * Returns the object that should be focused when double-clicking on this node (the object can be an actor, which selects it in the world, or a node/graph/pin)
Public function Virtual Const FLinearColor Gets the draw color of a node's title bar
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 FString

GetPinMetaData ( FName InPinName,
FName InKey
)

 Return the requested metadata for the pin if there is any
Public function Virtual Const bool Determines whether or not the node will compile in development mode.
Public function Virtual Const void Jump to the definition of this node (should only be called if CanJumpToDefinition() return true)
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 Refresh the connectors on a node, preserving as many connections as it can.
Public function Virtual Const bool Should we show the Palette Icon for this node on the node title
Public function Virtual Const void Gives each visual node a chance to do final validation before it's node is harvested for use at runtime.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool Called during saving to determine if the object's references are used in game even when the object itself is never loaded outside the editor (because e.g. its references are followed during cooking)
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Enums

  Type Name Description
Public enum EBaseNodeRefreshPriority    
Protected enum ERedirectType    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page