unreal.ToolMenu

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

Bases: unreal.ToolMenuBase

Tool Menu

C++ Source:

  • Module: ToolMenus

  • File: ToolMenu.h

Editor Properties: (see get_editor_property/set_editor_property)

  • close_self_only (bool): [Read-Write] Close Self Only

  • menu_name (Name): [Read-Write] Menu Name

  • menu_owner (ToolMenuOwner): [Read-Write] Menu Owner

  • menu_parent (Name): [Read-Write] Menu Parent

  • menu_type (MultiBoxType): [Read-Write] Menu Type

  • prevent_customization (bool): [Read-Write] Prevent menu from being customized

  • searchable (bool): [Read-Write] Searchable

  • should_close_window_after_menu_selection (bool): [Read-Write] Should Close Window After Menu Selection

  • style_name (Name): [Read-Write] Style Name

  • tool_bar_force_small_icons (bool): [Read-Write] Tool Bar Force Small Icons

  • tool_bar_is_focusable (bool): [Read-Write] Tool Bar Is Focusable

  • tutorial_highlight_name (Name): [Read-Write] Tutorial Highlight Name

add_dynamic_section(section_name, object)None

Add Dynamic Section Script

Parameters
add_menu_entry(section_name, args)None

Add Menu Entry

Parameters
add_menu_entry_object(object)None

Add Menu Entry Object

Parameters

object (ToolMenuEntryScript) –

add_section(section_name, label='', insert_name='None', insert_type=ToolMenuInsertType.DEFAULT)None

Add Section Script

Parameters
add_sub_menu(owner, section_name, name, label, tool_tip='')ToolMenu

Add Sub Menu Script

Parameters
Returns

Return type

ToolMenu

property close_self_only

[Read-Write] Close Self Only

Type

(bool)

init_menu(owner, name, parent='None', type=MultiBoxType.MENU)None

Init Menu

Parameters
property menu_name

[Read-Write] Menu Name

Type

(Name)

property menu_owner

[Read-Write] Menu Owner

Type

(ToolMenuOwner)

property menu_parent

[Read-Write] Menu Parent

Type

(Name)

property menu_type

[Read-Write] Menu Type

Type

(MultiBoxType)

property prevent_customization

[Read-Write] Prevent menu from being customized

Type

(bool)

property searchable

[Read-Write] Searchable

Type

(bool)

property should_close_window_after_menu_selection

[Read-Write] Should Close Window After Menu Selection

Type

(bool)

property style_name

[Read-Write] Style Name

Type

(Name)

property tool_bar_force_small_icons

[Read-Write] Tool Bar Force Small Icons

Type

(bool)

property tool_bar_is_focusable

[Read-Write] Tool Bar Is Focusable

Type

(bool)

property tutorial_highlight_name

[Read-Write] Tutorial Highlight Name

Type

(Name)