unreal.AnimBlueprint

class unreal.AnimBlueprint(outer=None, name='None')

Bases: unreal.Blueprint

An Anim Blueprint is essentially a specialized Blueprint whose graphs control the animation of a Skeletal Mesh. It can perform blending of animations, directly control the bones of the skeleton, and output a final pose for a Skeletal Mesh each frame.

C++ Source:

  • Module: Engine

  • File: AnimBlueprint.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

  • 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.

  • 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

  • target_skeleton (Skeleton): [Read-Write] This is the target skeleton asset for anim instances created from this blueprint; all animations referenced by the BP should be compatible with this skeleton. For advanced use only, it is easy to cause errors if this is modified without updating or replacing all referenced animations.

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

  • use_multi_threaded_animation_update (bool): [Read-Write] Allows this anim Blueprint to update its native update, blend tree, montages and asset players on a worker thread. The compiler will attempt to pick up any issues that may occur with threaded update. For updates to run in multiple threads both this flag and the project setting “Allow Multi Threaded Animation Update” should be set.

  • warn_about_blueprint_usage (bool): [Read-Write] Selecting this option will cause the compiler to emit warnings whenever a call into Blueprint is made from the animation graph. This can help track down optimizations that need to be made.