unreal.ModularRigController

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

Bases: Object

Modular Rig Controller

C++ Source:

• Plugin: ControlRig

• Module: ControlRig

• File: ModularRigController.h

add_module(module_name, class_, parent_module_path, setup_undo=True) → str

Add Module

Parameters:

• module_name (Name) –

• class (type(Class)) –

• parent_module_path (str) –

• setup_undo (bool) –

Return type:

str

auto_connect_modules(module_paths, replace_existing_connections, setup_undo=True) → bool

Auto Connect Modules

Parameters:

• module_paths (Array[str]) –

• replace_existing_connections (bool) –

• setup_undo (bool) –

Return type:

bool

auto_connect_secondary_connectors(connector_keys, replace_existing_connections, setup_undo=True) → bool

Auto Connect Secondary Connectors

Parameters:

• connector_keys (Array[RigElementKey]) –

• replace_existing_connections (bool) –

• setup_undo (bool) –

Return type:

bool

bind_module_variable(module_path, variable_name, source_path, setup_undo=True) → bool

Bind Module Variable

Parameters:

• module_path (str) –

• variable_name (Name) –

• source_path (str) –

• setup_undo (bool) –

Return type:

bool

can_connect_connector_to_element(connector_key, target_key) → Text or None

Can Connect Connector to Element

Parameters:

• connector_key (RigElementKey) –

• target_key (RigElementKey) –

Returns:

out_error_message (Text):

Return type:

Text or None

connect_connector_to_element(connector_key, target_key, setup_undo=True, auto_resolve_other_connectors=True, check_valid_connection=True) → bool

Connect Connector to Element

Parameters:

• connector_key (RigElementKey) –

• target_key (RigElementKey) –

• setup_undo (bool) –

• auto_resolve_other_connectors (bool) –

• check_valid_connection (bool) –

Return type:

bool

delete_module(module_path, setup_undo=True) → bool

Delete Module

Parameters:

• module_path (str) –

• setup_undo (bool) –

Return type:

bool

disconnect_connector(connector_key, disconnect_sub_modules=False, setup_undo=True) → bool

Disconnect Connector

Parameters:

• connector_key (RigElementKey) –

• disconnect_sub_modules (bool) –

• setup_undo (bool) –

Return type:

bool

disconnect_cyclic_connectors(setup_undo=True) → Array[RigElementKey]

Disconnect Cyclic Connectors

Parameters:

setup_undo (bool) –

Return type:

Array[RigElementKey]

mirror_module(module_path, settings, setup_undo=True) → str

Mirror Module

Parameters:

• module_path (str) –

• settings (RigVMMirrorSettings) –

• setup_undo (bool) –

Return type:

str

rename_module(module_path, new_name, setup_undo=True) → str

Rename Module

Parameters:

• module_path (str) –

• new_name (Name) –

• setup_undo (bool) –

Return type:

str

reparent_module(module_path, new_parent_module_path, setup_undo=True) → str

Reparent Module

Parameters:

• module_path (str) –

• new_parent_module_path (str) –

• setup_undo (bool) –

Return type:

str

set_config_value_in_module(module_path, variable_name, value, setup_undo=True) → bool

Set Config Value in Module

Parameters:

• module_path (str) –

• variable_name (Name) –

• value (str) –

• setup_undo (bool) –

Return type:

bool

set_module_short_name(module_path, new_short_name, setup_undo=True) → bool

Set Module Short Name

Parameters:

• module_path (str) –

• new_short_name (str) –

• setup_undo (bool) –

Return type:

bool

un_bind_module_variable(module_path, variable_name, setup_undo=True) → bool

Un Bind Module Variable

Parameters:

• module_path (str) –

• variable_name (Name) –

• setup_undo (bool) –

Return type:

bool