unreal.MovieGraphPin

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

Bases: Object

Movie Graph Pin

C++ Source:

• Plugin: MovieRenderPipeline

• Module: MovieRenderPipelineCore

• File: MovieGraphPin.h

Editor Properties: (see get_editor_property/set_editor_property)

• edges (Array[MovieGraphEdge]): [Read-Write] A list of edges between pins. This is marked as TextExportTransient so that when we copy/paste nodes, we don’t copy the edges, as they are rebuilt after paste based on the editor graph connections.

• node (MovieGraphNode): [Read-Write] The node that this pin belongs to.

• properties (MovieGraphPinProperties): [Read-Write]

allows_multiple_connections() → bool

Allows Multiple Connections

Return type:

bool

can_create_connection(other_pin) → bool

Can Create Connection

Parameters:

other_pin (MovieGraphPin)

Return type:

bool

edge_count() → int32

Gets the number of edges connected to this pin. May include invalid edges (which can happen if connected to an invalid node).

Return type:

int32

property edges: None

[Read-Only] A list of edges between pins. This is marked as TextExportTransient so that when we copy/paste nodes, we don’t copy the edges, as they are rebuilt after paste based on the editor graph connections.

Type:

(Array[MovieGraphEdge])

get_all_connected_pins() → Array[MovieGraphPin]

Gets all connected pins.

Return type:

Array[MovieGraphPin]

get_connected_nodes() → Array[MovieGraphNode]

Utility function for scripting which gathers all of the nodes connected to this particular pin. Equivalent to looping through all of the edges, getting the connected pin, and then getting the node associated with that pin.

Return type:

Array[MovieGraphNode]

get_first_connected_pin(follow_reroute_connections=False) → MovieGraphPin

Gets the first pin connected to this pin. Returns nullptr if no valid connection exists. If bFollowRerouteConnections is true, this method will continue traversing the graph past reroute nodes until a non-reroute pin is found.

Parameters:

follow_reroute_connections (bool)

Return type:

MovieGraphPin

is_connected() → bool

Is Connected

Return type:

bool

is_connection_to_branch_allowed(other_pin) → Text or None

Determines if the connection between this pin and OtherPin follows branch restriction rules. OutError is populated with an error if the connection should be rejected and the function will return false.

Parameters:

other_pin (MovieGraphPin)

Returns:

out_error (Text):

Return type:

Text or None

is_input_pin() → bool

Is Input Pin

Return type:

bool

is_output_pin() → bool

Is Output Pin

Return type:

bool

is_pin_direction_compatible_with(other_pin) → bool

Determines if this pin’s direction is compatible with another pin’s direction. One needs to be an input, and the other an output.

Parameters:

other_pin (MovieGraphPin)

Return type:

bool

is_type_compatible_with(other_pin) → bool

Determines if this pin’s type is compatible with another pin’s type. Generally the types have to match exactly in order to be compatible, but there may be cases where different types can be used interchangeably.

Parameters:

other_pin (MovieGraphPin)

Return type:

bool

property node: MovieGraphNode

[Read-Only] The node that this pin belongs to.

Type:

(MovieGraphNode)

property properties: MovieGraphPinProperties

[Read-Only]

Type:

(MovieGraphPinProperties)