Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/EdGraph/EdGraphNode.h |
Include |
#include "EdGraph/EdGraphNode.h" |
class UEdGraphNode : public UObject
Name | Description | ||
---|---|---|---|
|
TEnumAsByte< EN... |
AdvancedPinDisplay |
Enum to indicate if a node has advanced-display-pins, and if they are shown |
|
uint8: 1 |
bCanRenameNode |
If true, this node can be renamed in the editor |
|
uint8: 1 |
bCanResizeNode |
If true, this node can be resized and should be drawn with a resize handle |
|
uint8: 1 |
bCommentBubbleMakeVisible |
Make comment bubble visible |
|
uint8: 1 |
bCommentBubblePinned |
Comment bubble pinned state |
|
uint8: 1 |
bCommentBubbleVisible |
Comment bubble visibility |
|
uint8: 1 |
bDisableOrphanPinSaving |
When true, overrides whatever OrphanedPinSaveMode specifies and behaves as if it were SaveNone. |
|
uint8: 1 |
bHasCompilerMessage |
Flag to check for compile error/warning |
|
DEPRECATED_NodeWidget |
Widget representing this node if it exists; Note: This is not safe to use in general and will be removed in the future, as there is no guarantee that only one graph editor/panel is viewing a given graph |
|
|
DeprecatedPins |
List of connector pins |
|
|
ErrorMsg |
Error/Warning description |
|
|
int32 |
ErrorType |
Flag to store node specific compile error/warning |
|
NodeComment |
Comment string that is drawn on the node |
|
|
NodeGuid |
GUID to uniquely identify this node, to facilitate diffing versions of this graph |
|
|
int32 |
NodeHeight |
Height of node in the editor; only used when the node can be resized |
|
int32 |
NodePosX |
X position of node in the editor |
|
int32 |
NodePosY |
Y position of node in the editor |
|
NodeUpgradeMessage |
Note for a node that lingers until saved |
|
|
int32 |
NodeWidth |
Width of node in the editor; only used when the node can be resized |
|
ESaveOrphanPinM... |
OrphanedPinSaveMode |
When reconstructing a node should the orphaned pins be retained and transfered to the new pin list. |
|
Pins |
Name | Description | |
---|---|---|
|
UEdGraphNode ( |
Name | Description | ||
---|---|---|---|
|
void |
AddNodeUpgradeNote ( |
Adds an upgrade note to this node |
|
void |
AddPinSearchMetaDataInfo ( |
Adds node pin data to the search metadata, override to collect more data that may be desirable to search for |
|
void |
AddReferencedObjects ( |
|
|
void |
AddSearchMetaDataInfo ( |
Add's node data to the search metadata, override to collect more data that may be desirable to search for |
|
void |
AllocateDefaultPins() |
Allocate default pins for a given node, based only the NodeType, which should already be filled in. |
|
void |
AutowireNewNode ( |
Autowire a newly created node. |
|
void |
BreakAllNodeLinks() |
Break all links on this node |
|
bool |
CanCreateUnderSpecifiedSchema ( |
Determine if this node can be created under the specified schema |
|
bool |
CanDuplicateNode() |
Whether or not this node can be safely duplicated (via copy/paste, etc...) in the graph |
|
bool |
CanJumpToDefinition() |
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) |
|
bool |
CanPasteHere ( |
Determine if this node can live in the specified graph |
|
bool |
CanSplitPin ( |
Whether or not struct pins belonging to this node should be allowed to be split or not. |
|
bool |
CanUserDeleteNode() |
Whether or not this node can be deleted by user action |
|
bool |
CanUserEditPinAdvancedViewFlag() |
Whether or not this node allows users to edit the advanced view flag of pins (actually edit the property, not the same as show/hide advanced pins). |
|
void |
ClearCompilerMessage() |
Clear error flag |
|
void |
CreateNewGuid() |
Create a new unique Guid for this node |
|
TSharedPtr< ... |
CreateNodeImage() |
Create the background image for the widget representing this node |
|
UEdGraphPin ... |
CreatePin ( |
|
|
UEdGraphPin ... |
CreatePin ( |
|
|
UEdGraphPin ... |
CreatePin ( |
|
|
UEdGraphPin ... |
CreatePin ( |
Create a new pin on this node using the supplied pin type, and return the new pin |
|
UEdGraphPin ... |
CreatePin ( |
Create a new pin on this node using the supplied info, and return the new pin |
|
CreateUniquePinName ( |
Generate a unique pin name, trying to stick close to a passed in name |
|
|
TSharedPtr< ... |
CreateVisualWidget() |
Create a visual widget to represent this node in a graph editor or graph panel. |
|
void |
DeclareCustomVersions |
|
|
void |
DestroyNode() |
Destroy the specified node |
|
void |
DestroyPin ( |
Destroys the specified pin, does not modify its owning pin's Pins list |
|
void |
DiffProperties ( |
Finds the difference in properties of node instance, for arbitrary UStructs |
|
void |
DiffProperties ( |
Finds the difference in properties of node instance, for subobjects |
|
void |
FindDiffs ( |
Gives the node the option to customize how diffs are discovered within it. |
|
UEdGraphPin ... |
FindPin ( |
Find a pin on this node with the supplied name and optional direction |
|
UEdGraphPin ... |
FindPin ( |
Find a pin on this node with the supplied name and optional direction |
|
UEdGraphPin ... |
FindPin ( |
Find a pin on this node with the supplied name and optional direction |
|
UEdGraphPin ... |
FindPinById ( |
Find the pin on this node with the supplied guid |
|
UEdGraphPin ... |
FindPinByIdChecked ( |
Find the pin on this node with the supplied guid and assert if it is not present |
|
UEdGraphPin ... |
FindPinByPredicate ( |
Find a pin using a user-defined predicate |
|
UEdGraphPin ... |
FindPinChecked ( |
Find a pin on this node with the supplied name and optional direction and assert if it is not present |
|
UEdGraphPin ... |
FindPinChecked ( |
Find a pin on this node with the supplied name and optional direction and assert if it is not present |
|
UEdGraphPin ... |
FindPinChecked ( |
Find a pin on this node with the supplied name and optional direction and assert if it is not present |
|
void |
ForEachNodeDirectlyConnected ( |
Execute a provided function once for each node that is directly connected to this node, will not include the node itself |
|
void |
ForEachNodeDirectlyConnectedIf ( |
Often we are only interested in a subset of our connections (e.g. only output pins, or only output pins except our exec pin) This function provides the ability to execute a provided function once for each node that is directly connected to this node, but first filters out which of this node's pins to consider: |
|
void |
ForEachNodeDirectlyConnectedToInputs ( |
Execute a provided function once for each node that is directly connected to this node's input pins, will not include the node itself Implementation provides an example usage of ForEachNodeDirectlyConnectedIf. |
|
void |
ForEachNodeDirectlyConnectedToOutputs ( |
Execute a provided function once for each node that is directly connected to this node's output pins, will not include the node itself Implementation provides an example usage of ForEachNodeDirectlyConnectedIf. |
|
void |
GatherForLocalization ( |
|
|
const TArray... |
GetAllPins() |
Get all pins this node owns |
|
bool |
GetCanRenameNode() |
If true, this node can be renamed in the editor |
|
FEdGraphNode... |
GetDeprecationResponse ( |
Returns the response to use when reporting a deprecation. |
|
GetDescriptiveCompiledName() |
Tries to come up with a descriptive name for the compiled output |
|
|
ENodeEnabled... |
GetDesiredEnabledState() |
Returns the specific sort of enable state this node wants |
|
GetDocumentationExcerptName() |
Returns the name of the excerpt to display from the specified external documentation link for the graph node Default behavior is to return the class name (including prefix) |
|
|
GetDocumentationLink() |
Returns the link used for external documentation for the graph node |
|
|
GetFindReferenceSearchString() |
Gets the search string to find references to this node |
|
|
UEdGraph ... |
GetGraph() |
Returns the graph that contains this node |
|
GetIconAndTint ( |
||
|
UObject *... |
GetJumpTargetForDoubleClick() |
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) |
|
GetKeywords() |
Returns the keywords that should be used when searching for this node |
|
|
void |
GetMenuEntries ( |
This function gets menu items that can be created using this node given the specified context. |
|
GetNodeBodyTintColor() |
Gets the draw color of a node's body tine |
|
|
GetNodeCommentColor() |
Get the draw color for a node's comment popup |
|
|
void |
GetNodeContextMenuActions ( |
Gets a list of actions that can be done to this particular node |
|
GetNodeTitle ( |
Gets the name of this node, shown in title bar |
|
|
GetNodeTitleColor() |
Gets the draw color of a node's title bar |
|
|
UEdGraphPin ... |
GetPassThroughPin ( |
Return the matching "pass-through" pin for the given pin (if supported by this node) |
|
UEdGraphPin ... |
GetPinAt ( |
Gets the pin at a given index |
|
GetPinDisplayName ( |
Gets the display name for a pin |
|
|
void |
GetPinHoverText ( |
Fetch the hover text for a pin when the graph is being edited. |
|
int32 |
GetPinIndex ( |
Gets the index for a pin |
|
GetPinMetaData |
Return the requested metadata for the pin if there is any |
|
|
GetPinNameOverride ( |
Gets the overridden name for the specified pin, if any |
|
|
UEdGraphPin ... |
GetPinWithDirectionAt ( |
Gets the pin with the given direction, at the given index. |
|
GetPropertyNameAndValueForDiff ( |
Returns a human-friendly description of the property in the form "PropertyName: Value". |
|
|
const UEdGra... |
GetSchema() |
Shorthand way to access the schema of the graph that owns this node |
|
GetSubGraphs() |
||
|
GetTooltipText() |
Gets the tooltip to display when over the node |
|
|
GetVisualWarningTooltipText() |
Visual Warning tooltip message to show |
|
|
bool |
HasDeprecatedReference() |
Returns true if this node references a deprecated type or member. |
|
bool |
HasExternalDependencies |
Returns whether or not this node has dependencies on an external structure If OptionalOutput isn't null, it should be filled with the known dependencies objects (Classes, Structures, Functions, etc). |
|
bool |
HasUserSetTheEnabledState() |
Has the user set the enabled state or is it still using the automatic settings? |
|
bool |
IncludeParentNodeContextMenu() |
Does the node context menu inherit parent class's menu |
|
bool |
IsAutomaticallyPlacedGhostNode() |
Returns true if this is a disabled automatically placed ghost node (see the DefaultEventNodes ini section) |
|
bool |
IsCompatibleWithGraph ( |
Determine if a node of this type can be created for the specified graph. |
|
bool |
IsCompilerRelevant() |
Return false if the node and any expansion will isolate itself during compile |
|
bool |
IsDeprecated() |
Returns true if this node is deprecated. |
|
bool |
IsDisplayAsDisabledForced() |
|
|
bool |
IsInDevelopmentMode() |
Determines whether or not the node will compile in development mode. |
|
bool |
IsIntermediateNode() |
Returns whether the node was created by UEdGraph::CreateIntermediateNode. |
|
bool |
IsNodeEnabled() |
Is the node actually enabled |
|
bool |
IsNodeUnrelated() |
Determines whether this node is unrelated to the selected nodes or not. |
|
void |
JumpToDefinition() |
Jump to the definition of this node (should only be called if CanJumpToDefinition() return true) |
|
void |
MakeAutomaticallyPlacedGhostNode() |
Marks this node as an automatically placed ghost node (see the DefaultEventNodes ini section) |
|
TSharedPtr< ... |
MakeNameValidator() |
Create a name validator for this node |
|
void |
NodeConnectionListChanged() |
Called when something external to this node has changed the connection list of any of the pins in the node |
|
void |
OnCommentBubbleToggled ( |
Called when the node's comment bubble is toggled |
|
void |
OnPinRemoved ( |
Called when a pin is removed |
|
void |
OnRenameNode ( |
Called when this node is being renamed after a successful name validation |
|
void |
OnUpdateCommentText ( |
Called to replace this nodes comment text |
|
void |
PinConnectionListChanged ( |
Called when the connection list of one of the pins of this node is changed in the editor |
|
void |
PinDefaultValueChanged ( |
Called when the DefaultValue of one of the pins of this node is changed in the editor |
|
void |
PinTypeChanged ( |
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) |
|
void |
PostPasteNode() |
Perform any fixups (deep copies of associated data, etc...) necessary after a node has been pasted in the editor |
|
void |
PostPlacedNewNode() |
A chance to initialize a new node; called just once when a new node is created, before AutowireNewNode or AllocateDefaultPins is called. |
|
void |
PrepareForCopying() |
Perform any steps necessary prior to copying a node into the paste buffer |
|
void |
ReconstructNode() |
Refresh the connectors on a node, preserving as many connections as it can. |
|
bool |
RemovePin ( |
Find a pin on this node with the supplied name and remove it, returns TRUE if successful |
|
void |
RemovePinAt ( |
Removes the specified pin from the node, preserving remaining pin ordering. |
|
void |
ResizeNode ( |
Update node size to new value |
|
void |
SetEnabledState ( |
Set the enabled state of the node to a new value |
|
void |
SetForceDisplayAsDisabled ( |
Set whether or not this node should be forced to display as disabled |
|
void |
SetMakeCommentBubbleVisible ( |
Sets a flag if the comment bubble needs to be made visible immediately |
|
void |
SetNodeUnrelated ( |
Set this node unrelated or not. |
|
bool |
ShouldDrawNodeAsControlPointOnly ( |
Returns whether to draw this node as a control point only (knot/reroute node). |
|
bool |
ShouldMakeCommentBubbleVisible() |
If the comment bubble needs to be made visible immediately |
|
bool |
ShouldMergeChildGraphs() |
If the node has a subgraph, should they be merged into the main graph? |
|
bool |
ShouldOverridePinNames() |
Whether or not this node should be given the chance to override pin names. |
|
bool |
ShowPaletteIconOnNode() |
Should we show the Palette Icon for this node on the node title |
|
bool |
ShowVisualWarning() |
If true, this node whill show the Visual Warning message |
|
void |
SnapToGrid ( |
Snap this node to a specified grid size |
|
bool |
SupportsCommentBubble() |
Returns true if this node supports comment bubbles |
|
void |
ValidateNodeDuringCompilation ( |
Gives each visual node a chance to do final validation before it's node is harvested for use at runtime. |
Name | Description | ||
---|---|---|---|
|
void |
BeginDestroy() |
Called before destroying the object. |
|
void |
ExportCustomProperties ( |
Exports the property values for the specified object as text to the output device. |
|
void |
ImportCustomProperties ( |
Exports the property values for the specified object as text to the output device. |
|
void |
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
void |
PostEditUndo() |
Called after applying a transaction to the object. |
|
void |
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
void |
PreSave ( |
Presave function. |
|
void |
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name |
Description |
|
---|---|---|
|
FCreatePinParams |
Parameter struct of less common options for CreatePin |
|
FNameParameterHelper |
Name |
Description |
---|---|
PooledPins |
Name | Description | ||
---|---|---|---|
|
UEdGraphPin ... |
CreatePin ( |
Use version that passes PinName as FName instead. |
|
UEdGraphPin ... |
CreatePin ( |
Remove when removing FString version. Exists just to resolve ambiguity |
|
UEdGraphPin ... |
CreatePin ( |
Use version that supplies Pin Category, SubCategory, and Name as an FName and uses a parameter structure for optional paramaters. |
|
UEdGraphPin ... |
CreatePin ( |
Use version that supplies Pin Category, SubCategory, and Name as an FName and uses PinContainerType instead of separate booleans for array, set, and map. |
|
PRAGMA_DISAB... |
PreSave ( |
Use version that takes FObjectPreSaveContext instead. |