unreal.EditorScriptableModularBehaviorTool

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

Bases: ScriptableModularBehaviorTool

Editor-Only variant of UScriptableModularBehaviorTool, which gives access to Editor-Only BP functions

C++ Source:

  • Plugin: ScriptableToolsFramework

  • Module: EditorScriptableToolsFramework

  • File: EditorScriptableModularBehaviorTool.h

Editor Properties: (see get_editor_property/set_editor_property)

  • custom_icon_path (str): [Read-Write] deprecated: Use ToolIconTexture instead.

  • custom_tool_builder_class (type(Class)): [Read-Write]

  • group_tags (ScriptableToolGroupSet): [Read-Write] Tool Tagging Support

  • show_tool_in_editor (bool): [Read-Write] A generic flag to indicate whether this Tool should be shown in the UE Editor. This may be interpreted in different ways

  • tool_category (Text): [Read-Write] Category of this Tool, will be used in (eg) Tool Palette Section headers

  • tool_icon_texture (Texture2D): [Read-Write]

  • tool_long_name (Text): [Read-Write] Long Name of this Tool, will be used in (eg) longer labels like the Accept/Cancel toolbar

  • tool_name (Text): [Read-Write] Name of this Tool, will be used in (eg) Toolbars

  • tool_shutdown_type (ScriptableToolShutdownType): [Read-Write] Specifies how the user exits this Tool, either Accept/Cancel-style or Complete-style

  • tool_startup_requirements (ScriptableToolStartupRequirements): [Read-Write]

  • tool_target_tool_builder_class (type(Class)): [Read-Write]

  • tool_tooltip (Text): [Read-Write] Tooltip used for this Tool in (eg) icons/etc