unreal.EditorScriptableSingleClickTool

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

Bases: ScriptableSingleClickTool

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

C++ Source:

  • Plugin: ScriptableToolsFramework

  • Module: EditorScriptableToolsFramework

  • File: EditorScriptableSingleClickTool.h

Editor Properties: (see get_editor_property/set_editor_property)

  • 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_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_tooltip (Text): [Read-Write] Tooltip used for this Tool in (eg) icons/etc

  • want_mouse_hover (bool): [Read-Write] Enable Hover support API functions OnHoverHitTest / OnHoverBegin / OnHoverUpdate / OnHoverEnd for Mouse devices. Defaults to disabled.