unreal.EdGraphNode_Comment

class unreal.EdGraphNode_Comment(outer: Object | None = None, name: Name | str = 'None')

Bases: EdGraphNode

Ed Graph Node Comment

C++ Source:

  • Module: UnrealEd

  • File: EdGraphNode_Comment.h

Editor Properties: (see get_editor_property/set_editor_property)

  • color_comment_bubble (bool): [Read-Write] Whether to use Comment Color to color the background of the comment bubble shown when zoomed out.

  • comment_bubble_visible_in_details_panel (bool): [Read-Write] Whether to show a zoom-invariant comment bubble when zoomed out (making the comment readable at any distance).

  • comment_color (LinearColor): [Read-Write] Color to style comment with

  • error_msg (str): [Read-Write] Error/Warning description

  • font_size (int32): [Read-Write] Size of the text in the comment box

  • move_mode (CommentBoxMode): [Read-Write] Whether the comment should move any fully enclosed nodes around when it is moved

  • node_details (Text): [Read-Write] Details field if more info is needed to be communicated (will show up in tooltip)

get_comment_color() → LinearColor

Gets the background color of a comment node.

Return type:

LinearColor

get_comment_text() → str

Returns the comment text of a comment node.

Return type:

str

get_nodes_in_comment() → Array[K2Node]

Returns the K2 nodes contained within the given comment node. Only UK2Node-derived nodes are returned; nested comments and other non-K2 node types are excluded. Membership is explicitly maintained when comments are created programmatically. Note: if the comment is manually moved or resized in the editor, membership is rebuilt spatially and may diverge from the programmatic assignment.

Return type:

Array[K2Node]

set_comment_color(color) → None

Sets the background color of a comment node.

Parameters:

color (LinearColor)

set_comment_text(new_text) → None

Sets the comment text of a comment node.

Parameters:

new_text (str)