Wiki

Clone wiki

jmonkeybuilder / EditorPlugin

It's a base class of a plugin which you need to use to register/initialize all your things. You need to create the main class of your plugin which extends the class com.ss.editor.plugin.EditorPlugin and to add an annotation to the class to describe some main properties of your plugin:

@PluginDescription(
        id = "com.ss.editor.plugin.example",
        version = "0.1",
        minAppVersion = "1.1.0",
        name = "Example plugin",
        description = "Example plugin"
)
public class ExamplePlugin extends EditorPlugin

Also, there are a lot of methods which you can override. The main methods which you can use are methods to extend the functionality of the Editor:

  • The method you can use to register your plugin's CSS files.
#!java
    @FromAnyThread
    public void register(@NotNull final CSSRegistry registry) {
    }
  • The method you can use to register your plugin's file creators.

#!java
    @FromAnyThread
    public void register(@NotNull final FileCreatorRegistry registry) {
    }
* The method you can use to register your plugin's editors.

#!java
    @FromAnyThread
    public void register(@NotNull final EditorRegistry registry) {
    }
  • The method you can use to register your plugin's icon file providers.
#!java
    @FromAnyThread
    public void register(@NotNull final FileIconManager iconManager) {
    }
  • The method you can use to register your plugin's file converters.
#!java
    @FromAnyThread
    public void register(@NotNull final FileConverterRegistry registry) {
    }
  • The method you can use to register your plugin's actions for the context menu in AssetTree.
#!java
    @FromAnyThread
    public void register(@NotNull final AssetTreeContextMenuFillerRegistry registry) {
    }
  • The method you can use to register your plugin's tree node factories to extends presentation of objects in some Node Trees(for example Model/Scene Tree).
#!java
    @FromAnyThread
    public void register(@NotNull final TreeNodeFactoryRegistry registry) {
    }
  • The method you can use to register your plugin's property builders to extends properties of objects in the Property Editors(for example Properties in Material/Model/Scene editors).
#!java
    @FromAnyThread
    public void register(@NotNull final PropertyBuilderRegistry registry) {
    }

Updated