unreal.ControlRigBlueprint

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

Bases: Blueprint

Control Rig Blueprint

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRigDeveloper

  • File: ControlRigBlueprint.h

Editor Properties: (see get_editor_property/set_editor_property)

  • blueprint_category (str): [Read-Write] The category of the Blueprint, used to organize this Blueprint class when displayed in palette windows

  • blueprint_description (str): [Read-Write] Shows up in the content browser tooltip when the blueprint is hovered

  • blueprint_display_name (str): [Read-Write] Overrides the BP’s display name in the editor UI

  • blueprint_namespace (str): [Read-Write] The namespace of this blueprint (if set, the Blueprint will be treated differently for the context menu)

  • compile_mode (BlueprintCompileMode): [Read-Write] The mode that will be used when compiling this class.

  • deprecate (bool): [Read-Write] Deprecates the Blueprint, marking the generated class with the CLASS_Deprecated flag

  • draw_container (RigVMDrawContainer): [Read-Write]

  • generate_abstract_class (bool): [Read-Write] Whether or not this blueprint’s class is a abstract class or not. Should set CLASS_Abstract in the KismetCompiler.

  • generate_const_class (bool): [Read-Write] Whether or not this blueprint’s class is a const class or not. Should set CLASS_Const in the KismetCompiler.

  • hide_categories (Array[str]): [Read-Write] Additional HideCategories. These are added to HideCategories from parent.

  • hierarchy (RigHierarchy): [Read-Write]

  • hierarchy_settings (RigHierarchySettings): [Read-Write]

  • influences (RigInfluenceMapPerEvent): [Read-Write]

  • python_log_settings (ControlRigPythonSettings): [Read-Write]

  • rig_graph_display_settings (RigGraphDisplaySettings): [Read-Write]

  • run_construction_script_in_sequencer (bool): [Read-Write] whether or not you want to continuously rerun the construction script for an actor in sequencer

  • run_construction_script_on_drag (bool): [Read-Write] whether or not you want to continuously rerun the construction script for an actor as you drag it in the editor, or only when the drag operation is complete

  • shape_libraries (Array[ControlRigShapeLibrary]): [Read-Write]

  • should_cook_property_guids_value (ShouldCookBlueprintPropertyGuids): [Read-Write] Whether to include the property GUIDs for the generated class in a cooked build. note: This option may slightly increase memory usage in a cooked build, but can avoid needing to add CoreRedirect data for Blueprint classes stored within SaveGame archives.

  • thumbnail_info (ThumbnailInfo): [Read-Only] Information for thumbnail rendering

  • vm_compile_settings (RigVMCompileSettings): [Read-Write]

  • vm_runtime_settings (RigVMRuntimeSettings): [Read-Write]

add_member_variable(name, cpp_type, is_public=False, is_read_only=False, default_value='') → Name

Add Member Variable

Parameters:

  • name (Name) –

  • cpp_type (str) –

  • is_public (bool) –

  • is_read_only (bool) –

  • default_value (str) –

Return type:

Name

add_model(name='Rig Graph', setup_undo_redo=True, print_python_command=True) → RigVMGraph

Add Model

Parameters:

  • name (str) –

  • setup_undo_redo (bool) –

  • print_python_command (bool) –

Return type:

RigVMGraph

change_member_variable_type(name, cpp_type, is_public=False, is_read_only=False, default_value='') → bool

Change Member Variable Type

Parameters:

  • name (Name) –

  • cpp_type (str) –

  • is_public (bool) –

  • is_read_only (bool) –

  • default_value (str) –

Return type:

bool

create_control_rig() → ControlRig

Create Control Rig

Return type:

ControlRig

generate_python_commands(new_blueprint_name) → Array[str]

Generate Python Commands

Parameters:

new_blueprint_name (str) –

Return type:

Array[str]

get_all_models() → Array[RigVMGraph]

Get All Models

Return type:

Array[RigVMGraph]

classmethod get_available_rig_units() → Array[Struct]

Get Available Rig Units

Return type:

Array[Struct]

get_control_rig_class()

Get Control Rig Class

Return type:

type(Class)

get_controller(graph=None) → RigVMController

Get Controller

Parameters:

graph (RigVMGraph) –

Return type:

RigVMController

get_controller_by_name(graph_name='') → RigVMController

Get Controller by Name

Parameters:

graph_name (str) –

Return type:

RigVMController

classmethod get_currently_open_rig_blueprints() → Array[ControlRigBlueprint]

Get Currently Open Rig Blueprints

Return type:

Array[ControlRigBlueprint]

get_default_model() → RigVMGraph

Get Default Model

Return type:

RigVMGraph

get_hierarchy_controller() → RigHierarchyController

Get Hierarchy Controller

Return type:

RigHierarchyController

get_local_function_library() → RigVMFunctionLibrary

Get Local Function Library

Return type:

RigVMFunctionLibrary

get_member_variables() → Array[RigVMGraphVariableDescription]

Get Member Variables

Return type:

Array[RigVMGraphVariableDescription]

get_model(ed_graph=None) → RigVMGraph

Get Model

Parameters:

ed_graph (EdGraph) –

Return type:

RigVMGraph

get_or_create_controller(graph=None) → RigVMController

Get or Create Controller

Parameters:

graph (RigVMGraph) –

Return type:

RigVMController

get_preview_mesh() → SkeletalMesh

Get Preview Mesh

Return type:

SkeletalMesh

property hierarchy: RigHierarchy

[Read-Only]

Type:

(RigHierarchy)

recompile_vm() → None

Recompile VM

recompile_vm_if_required() → None

Recompile VMIf Required

remove_member_variable(name) → bool

Remove Member Variable

Parameters:

name (Name) –

Return type:

bool

remove_model(name='Rig Graph', setup_undo_redo=True, print_python_command=True) → bool

Remove Model

Parameters:

  • name (str) –

  • setup_undo_redo (bool) –

  • print_python_command (bool) –

Return type:

bool

rename_member_variable(old_name, new_name) → bool

Rename Member Variable

Parameters:

  • old_name (Name) –

  • new_name (Name) –

Return type:

bool

request_auto_vm_recompilation() → None

Request Auto VMRecompilation

request_control_rig_init() → None

Request Control Rig Init

set_auto_vm_recompile(auto_recompile) → None

Set Auto VMRecompile

Parameters:

auto_recompile (bool) –

set_preview_mesh(preview_mesh, mark_as_dirty=True) → None

IInterface_PreviewMeshProvider interface

Parameters:
suspend_notifications(suspend_notifs) → None

Suspend Notifications

Parameters:

suspend_notifs (bool) –

property vm_compile_settings: RigVMCompileSettings

[Read-Write]

Type:

(RigVMCompileSettings)