unreal.ControlRigBlueprint
¶
-
class
unreal.
ControlRigBlueprint
(outer=None, name='None')¶ Bases:
unreal.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 windowsblueprint_description
(str): [Read-Write] Shows up in the content browser tooltip when the blueprint is hoveredblueprint_display_name
(str): [Read-Write] Overrides the BP’s display name in the editor UIblueprint_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.controller
(RigVMController): [Read-Write] Controllerdeprecate
(bool): [Read-Write] Deprecates the Blueprint, marking the generated class with the CLASS_Deprecated flagdraw_container
(ControlRigDrawContainer): [Read-Write] Draw Containergenerate_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.gizmo_library
(ControlRigGizmoLibrary): [Read-Write] Gizmo Libraryhide_categories
(Array(str)): [Read-Write] Additional HideCategories. These are added to HideCategories from parent.influences
(RigInfluenceMapPerEvent): [Read-Write] Influencesmodel
(RigVMGraph): [Read-Write] Modelrun_construction_script_in_sequencer
(bool): [Read-Write] whether or not you want to continuously rerun the construction script for an actor in sequencerrun_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 completestatistics
(RigVMStatistics): [Read-Only] Statisticsthumbnail_info
(ThumbnailInfo): [Read-Only] Information for thumbnail renderingvm_compile_settings
(RigVMCompileSettings): [Read-Write] VMCompile Settings
-
property
controller
¶ [Read-Only] Controller
- Type
-
classmethod
get_currently_open_rig_blueprints
()¶ Get Currently Open Rig Blueprints
- Returns
- Return type
-
get_hierarchy_modifier
() → ControlRigHierarchyModifier¶ Get Hierarchy Modifier
- Returns
- Return type
-
get_preview_mesh
() → SkeletalMesh¶ Get Preview Mesh
- Returns
- Return type
-
property
model
¶ [Read-Only] Model
- 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
¶ [Read-Write] VMCompile Settings
- Type