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_name, setup_undo=True) → Name

Add Module

Parameters:

• module_name (Name)

• class (type(Class))

• parent_module_name (Name)

• setup_undo (bool)

Return type:

Name

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

Add Target to Array Connector

Parameters:

• connector_key (RigElementKey)

• target_key (RigElementKey)

• setup_undo (bool)

• auto_resolve_other_connectors (bool)

• check_valid_connection (bool)

Return type:

bool

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

Auto Connect Modules

Parameters:

• module_names (Array[Name])

• 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_name, variable_name, source_path, setup_undo=True) → bool

Bind Module Variable

Parameters:

• module_name (Name)

• 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

can_connect_connector_to_elements(connector_key, target_keys) → Text or None

Can Connect Connector to Elements

Parameters:

• connector_key (RigElementKey)

• target_keys (Array[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

connect_connector_to_elements(connector_key, target_keys, setup_undo=True, auto_resolve_other_connectors=True, check_valid_connection=True) → bool

Connect Connector to Elements

Parameters:

• connector_key (RigElementKey)

• target_keys (Array[RigElementKey])

• setup_undo (bool)

• auto_resolve_other_connectors (bool)

• check_valid_connection (bool)

Return type:

bool

delete_module(module_name, setup_undo=True) → bool

Delete Module

Parameters:

• module_name (Name)

• setup_undo (bool)

Return type:

bool

deselect_module(module_name) → bool

Deselect Module

Parameters:

module_name (Name)

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]

export_module_settings_to_string(module_names) → str

Export Module Settings to String

Parameters:

module_names (Array[Name])

Return type:

str

get_all_modules() → Array[Name]

Get All Modules

Return type:

Array[Name]

get_connectors_for_module(module_name) → Array[RigElementKey]

Parameters:

module_name (Name) – The name of the module reference to return

Returns:

Returns all of associated connectors for a given module name

Return type:

Array[RigElementKey]

get_module_reference(module_name) → RigModuleReference

Parameters:

module_name (Name) – The name of the module reference to return

Returns:

Returns the module for the given name

Return type:

RigModuleReference

get_selected_modules() → Array[Name]

Get Selected Modules

Return type:

Array[Name]

import_module_settings_from_string(content, optional_module_names, setup_undo=True) → bool

Import Module Settings from String

Parameters:

• content (str)

• optional_module_names (Array[Name])

• setup_undo (bool)

Return type:

bool

mirror_module(module_name, settings, setup_undo=True) → Name

Mirror Module

Parameters:

• module_name (Name)

• settings (RigVMMirrorSettings)

• setup_undo (bool)

Return type:

Name

rename_module(module_name, new_name, setup_undo=True) → Name

Rename Module

Parameters:

• module_name (Name)

• new_name (Name)

• setup_undo (bool)

Return type:

Name

reorder_module(module_name, module_index, setup_undo=True) → bool

Reorder Module

Parameters:

• module_name (Name)

• module_index (int32)

• setup_undo (bool)

Return type:

bool

reparent_module(module_name, new_parent_module_name, setup_undo=True) → bool

Reparent Module

Parameters:

• module_name (Name)

• new_parent_module_name (Name)

• setup_undo (bool)

Return type:

bool

reset_config_value_in_module(module_name, path, clear_override=True, setup_undo=True) → bool

Reset Config Value in Module

Parameters:

• module_name (Name)

• path (str)

• clear_override (bool)

• setup_undo (bool)

Return type:

bool

select_module(module_name, selected=True) → bool

Select Module

Parameters:

• module_name (Name)

• selected (bool)

Return type:

bool

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

Set Config Value in Module

Parameters:

• module_name (Name)

• variable_name (Name)

• value (str)

• setup_undo (bool)

Return type:

bool

set_module_selection(module_names) → bool

Set Module Selection

Parameters:

module_names (Array[Name])

Return type:

bool

swap_module_class(module_name, new_class, setup_undo=True) → bool

Swap Module Class

Parameters:

• module_name (Name)

• new_class (type(Class))

• setup_undo (bool)

Return type:

bool

swap_modules_of_class(old_class, new_class, setup_undo=True) → bool

Swap Modules Of Class

Parameters:

• old_class (type(Class))

• new_class (type(Class))

• setup_undo (bool)

Return type:

bool

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

Un Bind Module Variable

Parameters:

• module_name (Name)

• variable_name (Name)

• setup_undo (bool)

Return type:

bool