unreal.ControlRigBlueprint
¶
- class unreal.ControlRigBlueprint(outer: Optional[Object] = None, name: Union[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] Blueprint Category: The category of the Blueprint, used to organize this Blueprint class when displayed in palette windowsblueprint_description
(str): [Read-Write] Blueprint Description: Shows up in the content browser tooltip when the blueprint is hoveredblueprint_display_name
(str): [Read-Write] Blueprint Display Name: Overrides the BP’s display name in the editor UIblueprint_namespace
(str): [Read-Write] Blueprint Namespace: The namespace of this blueprint (if set, the Blueprint will be treated differently for the context menu)compile_mode
(BlueprintCompileMode): [Read-Write] Compile Mode: The mode that will be used when compiling this class.deprecate
(bool): [Read-Write] Deprecate: Deprecates the Blueprint, marking the generated class with the CLASS_Deprecated flagdraw_container
(ControlRigDrawContainer): [Read-Write] Draw Containergenerate_abstract_class
(bool): [Read-Write] Generate Abstract Class: 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] Generate Const Class: 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] Hide Categories: Additional HideCategories. These are added to HideCategories from parent.hierarchy
(RigHierarchy): [Read-Write] Hierarchyhierarchy_settings
(RigHierarchySettings): [Read-Write] Hierarchy Settingsinfluences
(RigInfluenceMapPerEvent): [Read-Write] Influencespython_log_settings
(ControlRigPythonSettings): [Read-Write] Python Log Settingsrig_graph_display_settings
(RigGraphDisplaySettings): [Read-Write] Rig Graph Display Settingsrun_construction_script_in_sequencer
(bool): [Read-Write] Run Construction Script in Sequencer: whether or not you want to continuously rerun the construction script for an actor in sequencerrun_construction_script_on_drag
(bool): [Read-Write] Run Construction Script on Drag: 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 completeshape_libraries
(Array[ControlRigShapeLibrary]): [Read-Write] Shape Librariesshould_cook_property_guids_value
(ShouldCookBlueprintPropertyGuids): [Read-Write] Should Cook Property Guids Value: 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] Thumbnail Info: Information for thumbnail renderingvm_compile_settings
(RigVMCompileSettings): [Read-Write] VMCompile Settingsvm_runtime_settings
(RigVMRuntimeSettings): [Read-Write] VMRuntime Settings
- add_member_variable(name, cpp_type, is_public=False, is_read_only=False, default_value='') Name ¶
Add Member Variable
- add_model(name='Rig Graph', setup_undo_redo=True, print_python_command=True) RigVMGraph ¶
Add Model
- Parameters:
- Return type:
- change_member_variable_type(name, cpp_type, is_public=False, is_read_only=False, default_value='') bool ¶
Change Member Variable Type
- create_control_rig() ControlRig ¶
Create Control Rig
- Return type:
- get_all_models() Array[RigVMGraph] ¶
Get All Models
- Return type:
- get_controller(graph=None) RigVMController ¶
Get Controller
- Parameters:
graph (RigVMGraph) –
- Return type:
- get_controller_by_name(graph_name='') RigVMController ¶
Get Controller by Name
- Parameters:
graph_name (str) –
- Return type:
- classmethod get_currently_open_rig_blueprints() Array[ControlRigBlueprint] ¶
Get Currently Open Rig Blueprints
- Return type:
- get_default_model() RigVMGraph ¶
Get Default Model
- Return type:
- get_hierarchy_controller() RigHierarchyController ¶
Get Hierarchy Controller
- Return type:
- get_local_function_library() RigVMFunctionLibrary ¶
Get Local Function Library
- Return type:
- get_member_variables() Array[RigVMGraphVariableDescription] ¶
Get Member Variables
- Return type:
- get_model(ed_graph=None) RigVMGraph ¶
Get Model
- Parameters:
ed_graph (EdGraph) –
- Return type:
- get_or_create_controller(graph=None) RigVMController ¶
Get or Create Controller
- Parameters:
graph (RigVMGraph) –
- Return type:
- get_preview_mesh() SkeletalMesh ¶
Get Preview Mesh
- Return type:
- property hierarchy: RigHierarchy¶
[Read-Only] Hierarchy
- Type:
- set_preview_mesh(preview_mesh, mark_as_dirty=True) None ¶
IInterface_PreviewMeshProvider interface
- Parameters:
preview_mesh (SkeletalMesh) –
mark_as_dirty (bool) –
- suspend_notifications(suspend_notifs) None ¶
Suspend Notifications
- Parameters:
suspend_notifs (bool) –
- property vm_compile_settings: RigVMCompileSettings¶
[Read-Write] VMCompile Settings
- Type: