unreal.ToolMenuEntry

class unreal.ToolMenuEntry(name='None', owner=['None'], type=MultiBlockType.NONE, user_interface_action_type=UserInterfaceActionType.BUTTON, tutorial_highlight_name='None', insert_position=['None', ToolMenuInsertType.DEFAULT], should_close_window_after_menu_selection=True, script_object=None)

Bases: unreal.StructBase

Tool Menu Entry

C++ Source:

  • Module: ToolMenus
  • File: ToolMenuEntry.h

Editor Properties: (see get_editor_property/set_editor_property)

  • insert_position (ToolMenuInsert): [Read-Write] Insert Position
  • name (Name): [Read-Write] Name
  • owner (ToolMenuOwner): [Read-Write] Owner
  • script_object (ToolMenuEntryScript): [Read-Write] Script Object
  • should_close_window_after_menu_selection (bool): [Read-Write] Should Close Window After Menu Selection
  • tutorial_highlight_name (Name): [Read-Write] Tutorial Highlight Name
  • type (MultiBlockType): [Read-Write] Type
  • user_interface_action_type (UserInterfaceActionType): [Read-Write] User Interface Action Type
get_label() → Text

Get Label

Returns:
Return type:Text
get_tool_tip() → Text

Get Tool Tip

Returns:
Return type:Text
insert_position

(ToolMenuInsert) – [Read-Write] Insert Position

name

(Name) – [Read-Write] Name

owner

(ToolMenuOwner) – [Read-Write] Owner

script_object

(ToolMenuEntryScript) – [Read-Write] Script Object

set_icon(style_set_name, style_name="None", small_style_name="None") → None

Set Icon

Parameters:
  • style_set_name (Name) –
  • style_name (Name) –
  • small_style_name (Name) –
set_label(label) → None

Set Label

Parameters:label (Text) –
set_string_command(type, custom_type, string) → None

Set String Command

Parameters:
set_tool_tip(tool_tip) → None

Set Tool Tip

Parameters:tool_tip (Text) –
should_close_window_after_menu_selection

(bool) – [Read-Write] Should Close Window After Menu Selection

tutorial_highlight_name

(Name) – [Read-Write] Tutorial Highlight Name

type

(MultiBlockType) – [Read-Write] Type

user_interface_action_type

(UserInterfaceActionType) – [Read-Write] User Interface Action Type