unreal.MovieGraphNode

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

Bases: Object

This is a base class for all nodes that can exist in the UMovieGraphConfig network. In the editor, each node in the network will have an editor-only representation too which contains data about it’s visual position in the graph, comments, etc.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphNode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • dynamic_properties (InstancedPropertyBag): [Read-Write] Properties which can be dynamically declared on the node (vs. native properties which are always present).

  • script_tags (Array[str]): [Read-Write] Tags that can be used to identify this node within a pre/post render script. Tags can be unique in order to identify this specific node, or the same tag can be applied to multiple nodes in order to identify a grouping of nodes.

can_be_added_by_user() → bool

Determines if this node type can be added to the graph interactively by a user or via the API when constructing a graph.

Returns:

true if the object can be added via the API, false otherwise

Return type:

bool

can_be_disabled() → bool

Determines if this node can be disabled.

Return type:

bool

get_branch_restriction() → MovieGraphBranchRestriction

Determines which types of branches the node can be created in.

Return type:

MovieGraphBranchRestriction

get_exposed_properties() → Array[MovieGraphPropertyInfo]

Gets the information about properties which are currently exposed as pins on the node.

Return type:

Array[MovieGraphPropertyInfo]

get_first_connected_input_pin() → MovieGraphPin

Gets the first input pin on the node which has a connection, or nullptr if no pins are connected.

Return type:

MovieGraphPin

get_first_connected_output_pin() → MovieGraphPin

Gets the first output pin on the node which has a connection, or nullptr if no pins are connected.

Return type:

MovieGraphPin

get_input_pin(pin_label, pin_requirement=MovieGraphPinQueryRequirement.BUILT_IN_OR_DYNAMIC) → MovieGraphPin

Gets the input pin with the specified name, or nullptr if one could not be found. Most pins on a node are “built-in”, meaning they ship with the node. Dynamic pins (pins which are not built-in) can potentially have the same name as a built-in (eg, the option pins on the Select node). To disambiguate between built-in and dynamic pins, specify bIsBuiltInPin = false if trying to fetch a pin that is not built-in.

Parameters:
Return type:

MovieGraphPin

get_input_pin_properties() → Array[MovieGraphPinProperties]

Gets the properties for all input pins.

Return type:

Array[MovieGraphPinProperties]

get_input_pins() → Array[MovieGraphPin]

Gets all input pins on the node. Note that the returned array is const, so input pins cannot be added/removed from the node via this array.

Return type:

Array[MovieGraphPin]

get_keywords() → Text

Gets the keywords (space-separated) that will be searched in the node creation context menu.

Return type:

Text

get_menu_category() → Text

Gets the category that the node belongs under.

Return type:

Text

get_node_comment() → str

Get Node Comment

Return type:

str

get_node_pos_x() → int32

Get Node Pos X

Return type:

int32

get_node_pos_y() → int32

Get Node Pos Y

Return type:

int32

get_node_title(get_descriptive=False) → Text

Gets the node’s title. Optionally gets a more descriptive, multi-line title for the node if bGetDescriptive is set to true.

Parameters:

get_descriptive (bool)

Return type:

Text

get_node_validation_errors(branch_name, evaluated_config) → Array[Text] or None

Gets any validation errors that the node generated. Validation errors will halt the active render, if any. Called on the fully-evaluated node post-evaluation. Returns true if there were any errors (added to OutValidationErrors), else false.

Parameters:
Returns:

out_validation_errors (Array[Text]):

Return type:

Array[Text] or None

get_output_pin(pin_label) → MovieGraphPin

Gets the output pin with the specified name, or nullptr if one could not be found.

Parameters:

pin_label (Name)

Return type:

MovieGraphPin

get_output_pin_properties() → Array[MovieGraphPinProperties]

Gets the properties for all output pins.

Return type:

Array[MovieGraphPinProperties]

get_output_pins() → Array[MovieGraphPin]

Gets all output pins on the node. Note that the returned array is const, so output pins cannot be added/removed from the node via this array.

Return type:

Array[MovieGraphPin]

get_overrideable_property_info() → Array[MovieGraphPropertyInfo]

Gets the information about properties which can be exposed as a pin on the node.

Return type:

Array[MovieGraphPropertyInfo]

is_comment_bubble_pinned() → bool

Is Comment Bubble Pinned

Return type:

bool

is_comment_bubble_visible() → bool

Is Comment Bubble Visible

Return type:

bool

is_disabled() → bool

Determines if this node is currently disabled.

Return type:

bool

promote_property_to_pin(property_name) → None

Promotes the given PropertyName to a pinned property, if it is found in GetOverrideablePropertyInfo(). Throws a kismet (scripting) exception if it isn’t a overridable property.

Parameters:

property_name (Name)

property script_tags: None

[Read-Write] Tags that can be used to identify this node within a pre/post render script. Tags can be unique in order to identify this specific node, or the same tag can be applied to multiple nodes in order to identify a grouping of nodes.

Type:

(Array[str])

set_disabled(new_disable_state) → None

Set whether this node is currently disabled.

Parameters:

new_disable_state (bool)

set_is_comment_bubble_pinned(is_pinned) → None

Set Is Comment Bubble Pinned

Parameters:

is_pinned (uint8)

set_is_comment_bubble_visible(is_visible) → None

Set Is Comment Bubble Visible

Parameters:

is_visible (uint8)

set_node_comment(node_comment) → None

Set Node Comment

Parameters:

node_comment (str)

set_node_pos_x(node_pos_x) → None

Set Node Pos X

Parameters:

node_pos_x (int32)

set_node_pos_y(node_pos_y) → None

Set Node Pos Y

Parameters:

node_pos_y (int32)

toggle_promote_property_to_pin(property_name) → None

Toggles the promotion of the property with the given name to a pin on the node.

Parameters:

property_name (Name)

unpromote_property_from_pin(property_name) → None

Unpromotes a given PropertyName from being pinned. Throws a kismet (scripting) exception if it’s not already exposed. See GetExposedProperties()

Parameters:

property_name (Name)