UEdGraphNode_Documentation

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEdGraphNode

UEdGraphNode_Documentation

Syntax

class UEdGraphNode_Documentation : public UEdGraphNode

Variables

Name Description

Public variable

FString

 

Excerpt

Documentation Excerpt

Public variable

FString

 

Link

Documentation Link

Constructors

Name Description

Public function

UEdGraphNode_Documentation

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

SetBounds

(
    const FSlateRect& Rect
)

Set the Bounds for the comment node

Overridden from UEdGraphNode

Name Description

Public function Virtual

void

 

AllocateDefaultPins()

Allocate default pins for a given node, based only the NodeType, which should already be filled in.

Public function Virtual Const

FString

 

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)

Public function Virtual Const

FString

 

GetDocumentationLink()

Returns the link used for external documentation for the graph node

Public function Virtual Const

FSlateIcon

 

GetIconAndTint

(
    FLinearColor& OutColor
)

Public function Virtual Const

FText

 

GetNodeTitle

(
    ENodeTitleType::Type TitleType
)

Gets the name of this node, shown in title bar

Public function Virtual Const

FLinearColor

 

GetNodeTitleColor()

Gets the draw color of a node's title bar

Public function Virtual Const

FText

 

GetPinNameOverride

(
    const UEdGraphPin& Pin
)

Gets the overridden name for the specified pin, if any

Public function Virtual Const

FText

 

GetTooltipText()

Gets the tooltip to display when over the node

Public function Virtual Const

TSharedPtr< ...

 

MakeNameValidator()

Create a name validator for this node

Public function Virtual

void

 

OnRenameNode

(
    const FString& NewName
)

Called when this node is being renamed after a successful name validation

Public function Virtual

void

 

PostPlacedNewNode()

A chance to initialize a new node; called just once when a new node is created, before AutowireNewNode or AllocateDefaultPins is called.

Public function Virtual

void

 

ResizeNode

(
    const FVector2D& NewSize
)

Update node size to new value

Public function Virtual Const

bool

 

ShouldOverridePinNames()

Whether or not this node should be given the chance to override pin names.

References

Module

Engine

Header

Runtime/Engine/Classes/EdGraph/EdGraphNode_Documentation.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback