unreal.ToolMenuEntry

class unreal.ToolMenuEntry(name: Name = 'None', owner: ToolMenuOwner = Ellipsis, type: MultiBlockType = Ellipsis, user_interface_action_type: UserInterfaceActionType = Ellipsis, tutorial_highlight_name: Name = 'None', insert_position: ToolMenuInsert = Ellipsis, should_close_window_after_menu_selection: bool = False, script_object: ToolMenuEntryScript = Ellipsis, style_name_override: Name = 'None')

Bases: StructBase

Represents entries in menus such as buttons, checkboxes, and sub-menus.

Many entries are created for you via the methods of FToolMenuSection, such as FToolMenuSection::AddMenuEntry.

C++ Source:

  • Module: ToolMenus

  • File: ToolMenuEntry.h

Editor Properties: (see get_editor_property/set_editor_property)

  • insert_position (ToolMenuInsert): [Read-Write]

  • name (Name): [Read-Write]

  • owner (ToolMenuOwner): [Read-Write]

  • script_object (ToolMenuEntryScript): [Read-Write]

  • should_close_window_after_menu_selection (bool): [Read-Write]

  • style_name_override (Name): [Read-Write]

  • tutorial_highlight_name (Name): [Read-Write]

  • type (MultiBlockType): [Read-Write]

  • user_interface_action_type (UserInterfaceActionType): [Read-Write]

get_label() → Text

Get Label

Return type:

Text

get_tool_tip() → Text

Get Tool Tip

Return type:

Text

property insert_position: ToolMenuInsert

[Read-Write]

Type:

(ToolMenuInsert)

property name: Name

[Read-Write]

Type:

(Name)

property owner: ToolMenuOwner

[Read-Write]

Type:

(ToolMenuOwner)

property script_object: ToolMenuEntryScript

[Read-Write]

Type:

(ToolMenuEntryScript)

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)

property should_close_window_after_menu_selection: bool

[Read-Write]

Type:

(bool)

property style_name_override: Name

[Read-Write]

Type:

(Name)

property tutorial_highlight_name: Name

[Read-Write]

Type:

(Name)

property type: MultiBlockType

[Read-Write]

Type:

(MultiBlockType)

property user_interface_action_type: UserInterfaceActionType

[Read-Write]

Type:

(UserInterfaceActionType)