Add plugins.py with several registration points for plugin classes to be inserted.

src/mcedit2/editortools/__init__.py

@@ -15,19 +15,7 @@ log = logging.getLogger(__name__)
 
 _registered_tools = []
 
-def RegisterTool(cls):
-    """
-    Register a tool class. Class must inherit from EditorTool.
-
-    >>> @RegisterTool
-    >>> class MyTool(EditorTool):
-    >>>     pass
-
-    :param cls:
-    :type cls:
-    :return:
-    :rtype:
-    """
+def registerToolClass(cls):
     if issubclass(cls, EditorTool):
         _registered_tools.append(cls)
     else:

src/mcedit2/editortools/generate.py

@@ -148,6 +148,7 @@ _pluginClasses = []
 
 def registerGeneratePlugin(cls):
     _pluginClasses.append(cls)
+    return cls
 
 _pluginClasses.append(TreeGen)
 

src/mcedit2/plugins.py

@@ -0,0 +1,106 @@
+"""
+    plugins
+"""
+from __future__ import absolute_import, division, print_function
+import logging
+from mcedit2 import editortools
+from mcedit2.editortools import generate
+from mcedit2.util import load_ui
+from mcedit2.widgets import inspector
+from mceditlib.anvil import entities
+
+log = logging.getLogger(__name__)
+
+# TODO: plugin unregistration
+# Either add a register/unregister method to plugin modules, or
+# keep track of which plugin is doing the registering and associate
+# it with its classes so MCEdit can unregister them automatically
+# Allowing plugin classes to be unregistered allows reloading plugins and disabling plugins after load times.
+
+def registerCustomWidget(cls):
+    """
+    Register a custom QWidget class with the .ui file loader. This allows custom QWidget
+    classes to be used in .ui files.
+
+    >>> from PySide import QtGui
+    >>> @registerCustomWidget
+    >>> class MyWidget(QtGui.QWidget):
+    >>>     pass
+
+    :param cls:
+    :type cls: class
+    :return:
+    :rtype: class
+    """
+    return load_ui.registerCustomWidget(cls)
+
+def registerToolClass(cls):
+    """
+    Register a tool class. Class must inherit from EditorTool.
+
+    >>> from mcedit2.editortools import EditorTool
+    >>> @registerToolClass
+    >>> class MyTool(EditorTool):
+    >>>     pass
+
+    :param cls:
+    :type cls: class
+    :return:
+    :rtype: class
+    """
+    return editortools.registerToolClass(cls)
+
+def registerGeneratePlugin(cls):
+    """
+    Register a plugin for the Generate Tool. Class must inherit from GeneratePlugin.
+
+    >>> from mcedit2.editortools.generate import GeneratePlugin
+    >>> @registerGeneratePlugin
+    >>> class MyGeneratePlugin(GeneratePlugin):
+    >>>     pass
+
+    :param cls:
+    :type cls:
+    :return:
+    :rtype:
+    """
+    return generate.registerGeneratePlugin(cls)
+
+def registerBlockInspectorWidget(ID, cls):
+    """
+    Register a widget with the Block Inspector to use when inspecting TileEntities
+    that have the given ID.
+
+    xxx make ID an attribute of cls?
+
+    >>> from PySide import QtGui
+    >>> class MyBarrelInspector(QtGui.QWidget):
+    >>>     pass
+    >>> registerBlockInspectorWidget("MyBarrel", MyBarrelInspector)
+
+    :param cls:
+    :type cls:
+    :return:
+    :rtype:
+    """
+    return inspector.registerBlockInspectorWidget(ID, cls)
+
+def registerTileEntityRefClass(ID, cls):
+    """
+    Register a TileEntityRef class with the world loader to create when loading a TileEntity
+    with the given ID.
+
+    xxx specify world format here, too.
+
+    >>> from mceditlib.anvil.entities import PCTileEntityRefBase
+    >>> class MyBarrelRef(PCTileEntityRefBase):
+    >>>     pass
+    >>> registerTileEntityRefClass("MyBarrel", MyBarrelRef)
+
+    :param cls:
+    :type cls:
+    :return:
+    :rtype:
+    """
+    # xxx this is anvil.entities - delegate to correct world format
+    return entities.registerTileEntityRefClass(ID, cls)

src/mcedit2/widgets/inspector.py

@@ -16,7 +16,7 @@ tileEntityEditorClasses = {
     "Hopper": HopperEditorWidget,
 }
 
-def registerInspectorWidget(ID, widgetClass):
+def registerBlockInspectorWidget(ID, widgetClass):
     tileEntityEditorClasses[ID] = widgetClass
 
 class InspectorWidget(QtGui.QWidget):

src/mcedit2/worldview/worldview.py

@@ -33,6 +33,7 @@ from mceditlib.util import displayName
 
 def worldMeshVertexSize(worldMesh):
     """
+    xxx what is this for??
 
     :type worldMesh: WorldScene
     """