Unreal context menus

samples/unreal_context_menu.py

@@ -0,0 +1,72 @@
+'''
+    Adds Context menus to assets in the browser.
+    to specify an asset context use the asset type as parent_path.
+
+    full list of ui names here https://dev.epicgames.com/community/snippets/exo/unreal-engine-editor-ui-menu-names
+
+    and the kwarg context_menu on the root noode
+
+'''
+
+import unreal
+import unimenu
+
+
+def test_function():
+    selected = unreal.EditorUtilityLibrary.get_selected_assets()
+    unreal.AssetEditorSubsystem().open_editor_for_assets(selected)
+
+
+config = {
+    'label': 'StaticMesh Tools',
+    'kwargs': {
+        'root_menu': "ContentBrowser.AssetContextMenu.StaticMesh",
+        "menu_section": "GetAssetActions"
+                },
+
+    'items':
+
+        [
+            {
+                'command': 'test_function()',
+                'label': 'Open Selected Asset',
+                "icon": "MessageLog.TabIcon",
+                "tooltip": "tooltip",
+
+            },
+            {
+                'label': 'label',
+                'separator': True,
+                "icon": "BlueprintEditor.AddNewFunction",
+                "tooltip": "tooltip separator",
+
+            },
+            {
+                'command': 'print("hello 2")',
+                'label': 'tool2',
+                'icon': "BlueprintEditor.AddNewEventGraph"
+
+            },
+            {
+                'label': 'Tools',
+
+                'items':
+                    [
+                        {
+                            'command': 'print("hello 1")',
+                            'label': 'tool1',
+                            'icon': "MessageLog.TabIcon"
+                        },
+                        {
+                            'command': 'print("hello 2")',
+                            'label': 'tool2',
+                            'icon': "MessageLog.TabIcon"
+                        }
+                    ]
+            }
+        ]
+}
+
+# test teardown
+node = unimenu.load(config)
+app_node = node.setup(backlink=False)

unimenu/apps/unreal.py

@@ -6,10 +6,18 @@ class MenuNodeUnreal(MenuNodeAbstract):
 
     @property
     def _default_root_parent(self):
+        # Default menu root
+        parent_path = "LevelEditor.MainMenu"
+
+        # Optional root
+        if self.kwargs.get('root_menu'):
+            # full list of ui names here https://dev.epicgames.com/community/snippets/exo/unreal-engine-editor-ui-menu-names
+            parent_path = f"{self.kwargs['root_menu']}"
+
+        # Extend the root
         if self.parent_path:
-            parent_path = f"LevelEditor.MainMenu.{self.parent_path}"  # todo make this more flexible
-        else:
-            parent_path = "LevelEditor.MainMenu"
+            parent_path = f"{parent_path}.{self.parent_path}"
+
         unreal_menus = unreal.ToolMenus.get()
         parent_menu = unreal_menus.find_menu(parent_path)
         return parent_menu
@@ -22,16 +30,28 @@ def setup(self, parent_app_node=None, backlink=True):
         unreal_menus.refresh_all_widgets()
 
     def _setup_sub_menu(self, parent_app_node=None) -> unreal.ToolMenu:
+        # Default Section
+        target_section_name = "PythonTools"
+
+        if self.kwargs.get('menu_section'):
+            # change target section
+            target_section_name = self.kwargs['menu_section']
+
         return parent_app_node.add_sub_menu(
             owner=parent_app_node.menu_name,
-            section_name="PythonTools",
+            section_name=target_section_name,
             name=self.id,  # todo check if needs to be unique like in add_to_menu
             label=self.label,  # todo add label support
             tool_tip=self.tooltip
         )
 
     def _setup_menu_item(self, parent_app_node=None) -> unreal.ToolMenuEntry:
         """add a menu item to the script menu"""
+        target_section_name = "Scripts"
+        if self.kwargs.get('menu_section'):
+            # change target section
+            target_section_name = self.kwargs['menu_section']
+
         entry = unreal.ToolMenuEntry(
             name=self.id,  # this needs to be unique! if not set, it's autogenerated
             type=unreal.MultiBlockType.MENU_ENTRY,
@@ -48,18 +68,24 @@ def _setup_menu_item(self, parent_app_node=None) -> unreal.ToolMenuEntry:
         if self.tooltip:
             entry.set_tool_tip(self.tooltip)
         if self.icon:
-            entry.set_icon(self.icon)  # naive implementation todo improve
+            # it is not possible to register custom icons with Python, can only use the built-in icons
+            # Icon's are here ...\Engine\Content\Editor\Slate\Icons - look for the icon name here
+            # style_names can be found here ...\Engine\Source\Editor\EditorStyle\Private\SlateEditorStyle.cpp - look for the name here
+            # e.g. Set( "BlueprintEditor.AddNewMacroDeclaration", new IMAGE_BRUSH( "Icons/icon_Blueprint_AddMacro_40px", Icon40x40) );
+            #            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^         <--         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+            entry.set_icon("EditorStyle", style_name=self.icon)
 
-        parent_app_node.add_menu_entry("Scripts", entry)  # always returns None
+        parent_app_node.add_menu_entry(target_section_name, entry)  # always returns None
         return entry
 
     def _setup_separator(self, parent_app_node=None):
-        # todo not working yet
         """add a separator to the script menu"""
-        # see https://docs.unrealengine.com/4.27/en-US/PythonAPI/class/ToolMenu.html
-        # todo what is diff with dynamic section?
-        return parent_app_node.add_section(section_name=self.label + "_section", label=self.label + "_label")
+        target_section_name = self.label + "_section"
+        if self.kwargs.get('menu_section'):
+            # change target section
+            target_section_name = self.kwargs['menu_section']
+        return parent_app_node.add_section(section_name=target_section_name, label=self.label)
 
     def teardown(self):
         """remove from menu"""
-        raise NotImplementedError("not yet implemented")
+        raise NotImplementedError("not yet implemented")