`unreal.ControlRig`¶

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

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

C++ Source:

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]

clear_control_selection(setup_undo=False) → bool¶

Parameters:: setup_undo (bool) – If set to true the stack will record the change for undo / redo
Return type:: bool

create_transformable_control_handle(control_name) → TransformableControlHandle¶

Creates a transformable control handle for the specified control to be used by the constraints system. Should use the UObject from: ConstraintsScriptingLibrary::GetManager(UWorld* InWorld)

current_control_selection() → Array[Name]¶

Current Control Selection

classmethod find_control_rigs(outer, optional_class) → Array[ControlRig]¶

Find Control Rigs

Parameters:

Return type:

Array[ControlRig]

get_hierarchy() → RigHierarchy¶

Get Hierarchy

get_hosting_actor() → Actor¶

Find the actor the rig is bound to, if any

is_control_selected(control_name) → bool¶

Is Control Selected

property on_control_selected_bp: OnControlSelectedBP¶

[Read-Write]

request_construction() → None¶: Requests to perform construction during the next execution

select_control(control_name, select=True, setup_undo=False) → None¶

Selects or deselects an element in the hierarchy

Parameters:

control_name (Name) – The key of the element to select
select (bool) – If set to false the element will be deselected
setup_undo (bool) – If set to true the stack will record the change for undo / redo

supports_backwards_solve() → bool¶

Contains a backwards solve event

unreal.ControlRig¶