unreal.RigVMNode

class unreal.RigVMNode(outer=None, name='None')

Bases: unreal.Object

The Node represents a single statement within a Graph. Nodes can represent values such as Variables / Parameters, they can represent Function Invocations or Control Flow logic statements (such as If conditions of For loops). Additionally Nodes are used to represent Comment statements. Nodes contain Pins to represent parameters for Function Invocations or Value access on Variables / Parameters.

C++ Source:

• Module: RigVMDeveloper

• File: RigVMNode.h

find_pin(pin_path) → RigVMPin

Returns a Pin given it’s partial pin path below this node (for example: “Color.R”)

Parameters

pin_path (str) –

Returns

Return type

RigVMPin

get_all_pins_recursively()

Returns all of the Pins of this Node (including SubPins).

Returns

Return type

Array(RigVMPin)

get_block_index() → int32

Returns the index of the block this node belongs to

Returns

Return type

int32

get_event_name() → Name

Returns the name of the event

Returns

Return type

Name

get_graph() → RigVMGraph

Returns the Graph of this Node

Returns

Return type

RigVMGraph

get_injection_info() → RigVMInjectionInfo

Returns the injection info of this Node (or nullptr)

Returns

Return type

RigVMInjectionInfo

get_instruction_index() → int32

Returns the current index of the instruction in the stack (or INDEX_NONE)

Returns

Return type

int32

get_linked_source_nodes()

Returns a list of Nodes connected as sources to this Node as the target.

Returns

Return type

Array(RigVMNode)

get_linked_target_nodes()

Returns a list of Nodes connected as targets to this Node as the source.

Returns

Return type

Array(RigVMNode)

get_node_color() → LinearColor

Returns the color of this node - used for UI.

Returns

Return type

LinearColor

get_node_index() → int32

Returns the current index of the Node within the Graph.

Returns

Return type

int32

get_node_path() → str

Returns the a . separated string containing all of the names used to reach this Node within the Graph. (for now this is the same as the Node’s name)

Returns

Return type

str

get_node_title() → str

Returns the title of this Node - used for UI.

Returns

Return type

str

get_pins()

Returns all of the top-level Pins of this Node.

Returns

Return type

Array(RigVMPin)

get_position() → Vector2D

Returns the 2d position of this node - used for UI.

Returns

Return type

Vector2D

get_size() → Vector2D

Returns the 2d size of this node - used for UI.

Returns

Return type

Vector2D

get_tool_tip_text() → Text

Returns the tooltip of this node

Returns

Return type

Text

has_input_pin(include_io=True) → bool

Returns true if the node has any input pins

Parameters

include_io (bool) –

Returns

Return type

bool

has_io_pin() → bool

Returns true if the node has any io pins

Returns

Return type

bool

has_output_pin(include_io=True) → bool

Returns true if the node has any output pins

Parameters

include_io (bool) –

Returns

Return type

bool

has_pin_of_direction(direction) → bool

Returns true if the node has any pins of the provided direction

Parameters

direction (RigVMPinDirection) –

Returns

Return type

bool

is_defined_as_constant() → bool

Returns true if the node is defined as non-varying

Returns

Return type

bool

is_defined_as_varying() → bool

Returns true if the node is defined as non-varying

Returns

Return type

bool

is_event() → bool

Returns true if this Node is the beginning of a scope

Returns

Return type

bool

is_injected() → bool

Returns true if this is an injected node. Injected nodes are managed by pins are are not visible to the user.

Returns

Return type

bool

is_linked_to(node) → bool

Returns true if this Node is linked to another given node through any of the Nodes’ Pins.

Parameters

node (RigVMNode) –

Returns

Return type

bool

is_mutable() → bool

Returns true if this Node has side effects or internal state.

Returns

Return type

bool

is_pure() → bool

Returns true if this Node has no side-effects and no internal state.

Returns

Return type

bool

is_selected() → bool

Returns true if this Node is currently selected.

Returns

Return type

bool

is_visible_in_ui() → bool

Returns true if this should be visible in the UI

Returns

Return type

bool