unreal.ModularRig

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

Bases: ControlRig

Runs logic for mapping input data to transforms (the “Rig”)

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: ModularRig.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the asset

  • asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the asset

  • on_control_selected_bp (OnControlSelectedBP): [Read-Write]

execute_event_on_all_modules(event) → Array[Name]
Parameters:

event (Name) – The name of the event to run

Returns:

Returns the paths of all modules which ran the event successfully

Return type:

Array[Name]

execute_event_on_module(event, module_path) → bool

deprecated: Function has been deprecated, please rely on ExecuteEventOnModuleByName instead.

Parameters:

  • event (Name) – The name of the event to run

  • module_path (str) – The name of the module to run the event on

Returns:

Returns true if the event was run successfully

Return type:

bool

execute_event_on_module_by_name(event, module_name) → bool
Parameters:

  • event (Name) – The name of the event to run

  • module_name (Name) – The name of the module to run the event on

Returns:

Returns true if the event was run successfully

Return type:

bool

get_events_for_all_modules() → Array[Name]
Returns:

Returns all of the events supported by the modules in this modular rig

Return type:

Array[Name]

get_events_for_module(module_path) → Array[Name]

deprecated: Function has been deprecated, please rely on GetEventsForModuleByName instead.

Parameters:

module_path (str) – The path of the module to receive the events for

Returns:

Returns the names of all supported events for a given module path

Return type:

Array[Name]

get_events_for_module_by_name(module_name) → Array[Name]
Parameters:

module_name (Name) – The name of the module to receive the events for

Returns:

Returns the names of all supported events for a given module name

Return type:

Array[Name]

get_module_names() → Array[Name]
Returns:

Returns all of the module paths within this rig

Return type:

Array[Name]

get_module_paths() → Array[str]

deprecated: Function has been deprecated, please rely on GetModuleNames instead.

Returns:

Returns all of the module paths within this rig

Return type:

Array[str]

get_module_rig(module_path) → ControlRig

deprecated: Function has been deprecated, please rely on GetModuleRigByName instead.

Parameters:

module_path (str) – The path of the module to retrieve the rig for

Returns:

Returns the rig instance for a given module name

Return type:

ControlRig

get_module_rig_by_name(module_name) → ControlRig
Parameters:

module_name (Name) – The name of the module to retrieve the rig for

Returns:

Returns the rig instance for a given module name

Return type:

ControlRig

get_parent_module_name(module_name) → Name
Parameters:

module_name (Name) – The name of the module to receive the parent module name for

Returns:

Returns the parent name for a given module name (or an empty string)

Return type:

Name

get_parent_path(module_path) → str

deprecated: Function has been deprecated, please rely on GetParentModuleName instead.

Parameters:

module_path (str) – The path of the module to receive the parent path for

Returns:

Returns the parent path for a given module path (or an empty string)

Return type:

str