Auto Register

This article will teach you how to use annotations to let UltiTools help you complete a series of tedious registration tasks.

@UltiToolsModule

Add this annotation above the class that extends UltiToolsPlugin.

This annotation can only be used in the main class of the UltiTools module to simplify the annotation configuration.

This annotation includes automatic scanning and registration of commands, listeners and configuration files under this class package name.

eventListener, cmdExecutor and config on @UltiToolsModule take effect (as of v6.3.0)

registerBukkit now resolves @EnableAutoRegister through a merged-annotation lookup that honours @AliasFor, so setting eventListener, cmdExecutor or config to false directly on @UltiToolsModule disables that registration.

import com.ultikits.ultitools.abstracts.UltiToolsPlugin;
import com.ultikits.ultitools.annotations.UltiToolsModule;
import lombok.Getter;
import com.ultikits.ultitools.annotations.Autowired;

@UltiToolsModule(
        // enable auto register listener
        eventListener = true,
        // enable auto register command executor
        cmdExecutor = true,
        // enable auto register config
        config = true,
        // scan package
        scanBasePackages = {"com.test.plugin"},
        // i18n support
        i18n = {"zh", "en"}
)
public class PluginMain extends UltiToolsPlugin {
    
    @Getter
    private static PluginMain pluginMain;

    public PluginMain() {
        super();
        pluginMain = this;
    }

    @Override
    public boolean registerSelf() {
        return true;
    }
    
    ...
}

@EnableAutoRegister

Connector constructor as of v6.3.0

The six-parameter constructor has been removed. Both connector examples below use the seven-parameter constructor and receive resourceFolderPath from their caller. For a new standalone Bukkit plugin, prefer UltiToolsAPI.connect(this) in your own JavaPlugin; see the External Plugin API.

@UltiToolsModule contains the @EnableAutoRegister annotation. If you cannot use @UltiToolsModule, you can use the @EnableAutoRegister annotation, such as if you want to use UltiTools' automatic registration in your own plugin.

Add this annotation above the class that extends UltiToolsPlugin, UltiTools will automatically register according to your configuration when loading your module:

@EnableAutoRegister(
    scanPackage = "",     // package to scan
    eventListener = true, // whether to register listener
    cmdExecutor = true,   // whether to register command executor
    config = true        // whether to register config
)
public class UltiToolsConnector extends UltiToolsPlugin {
    
    // If you need to connect to UltiTools-API, you need to override this constructor with parameters,
    // the other one without parameters is for module development.
    public UltiToolsConnector(String pluginName, String version, List<String> authors, List<String> loadAfter, int minUltiToolsVersion, String mainClass, String resourceFolderPath) {
        super(pluginName, version, authors, loadAfter, minUltiToolsVersion, mainClass, resourceFolderPath);
    }

    @Override
    public boolean registerSelf() throws IOException {
        return true;
    }

    ...
}

@ContextEntry

The connector constructor in this example is the same seven-parameter overload described under @EnableAutoRegister.

Add this annotation above the class that extends UltiToolsPlugin; it only takes effect on the register(UltiToolsPlugin) connector and adapter path described above, not when UltiTools loads your module as a standard JAR. Standard modules should register beans with @Service or @Bean instead.

@ContextEntry(MyBean.class)
public class UltiToolsConnector extends UltiToolsPlugin {

    // If you need to connect to UltiTools-API, you need to override this constructor with parameters,
    // the other one without parameters is for module development.
    public UltiToolsConnector(String pluginName, String version, List<String> authors, List<String> loadAfter, int minUltiToolsVersion, String mainClass, String resourceFolderPath) {
        super(pluginName, version, authors, loadAfter, minUltiToolsVersion, mainClass, resourceFolderPath);
    }

    @Override
    public boolean registerSelf() throws IOException {
        return true;
    }
    
    ...
}

@CmdExecutor

A command executor class with this annotation is registered when automatic command scanning is enabled.

For details please see Command Executor

@EventListener

Class that implements Listener with this annotation will be automatically registered when the listener is automatically scanned and registered.

For details please see Event Listener

Contributors

No contributors