Основной класс плагина

Примечание

The instructions within the Sponge Documentation assume that you have prior knowledge of Java. SpongeAPI provides the foundation for you to begin creating plugins for Minecraft servers powered by Sponge; however, it is up to you to be creative and make your code work! There are several free Java courses online if you have had little experience with Java.

Начинаем создание главного класса плагина

The next step after adding SpongeAPI as a dependency is creating a new class. The class can be named however you like, and can be in any package that does not begin with org.spongepowered. By convention, class names should be in title case.

Oracle рекомендует использовать ваш домен как имя пакета, если у вас есть домен. В противном случае, часто используется email адрес (например com.gmail.username.project) или репозиторий с открытым исходным кодом (например io.github.username.project).

После создания главного класса, необходимо добавить к нему аннотацию Plugin. Эта аннотация позволяет Sponge легко находить главный класс вашего плагина при загрузке. Пример использования показан ниже, более подробное использование объясняется на Метаданные плагина.

package io.github.username.project;

import org.spongepowered.plugin.builtin.jvm.Plugin;

@Plugin("exampleplugin")
public class ExamplePlugin {

}

Примечание

Если Вы ещё не выбрали ID плагина, посмотрите статью Идентификаторы плагина.

Инициализация плагина

Your plugin can listen for particular events, called lifecycle events, to be notified about changes in the state of the game or be to prompted to peform a specific task, such as registering a command. In the example below, onServerStart(StartedEngineEvent<Server>) is called when the StartedEngineEvent occurs for the Server. Note that the method is annotated with the Listener annotation.

The example below will log a message upon starting the server. If your plugin is correctly loaded, you should see this message as part of the server’s initialization output.

import org.spongepowered.api.event.Listener;
import org.spongepowered.api.event.lifecycle.StartedEngineEvent;
import org.spongepowered.plugin.builtin.jvm.Plugin;

// Imports for logger
import com.google.inject.Inject;
import org.apache.logging.log4j.Logger;

@Plugin("exampleplugin")
public class ExamplePlugin {

    @Inject
    private Logger logger;

    @Listener
    public void onServerStart(final StartedEngineEvent<Server> event) {
        logger.info("Successfully running ExamplePlugin!!!");
    }

}

Совет

The Sponge documentation provides a guide with more information on events (see События). Normally, in addition to prefixing event-handler methods with @Listener, you must also register your object with Sponge’s event bus, which can be done at any time. However, your main plugin class is registered automatically.

Lifecycle Events

It may also be desirable to listen for other lifecycle events in your plugin, such that you can react to re-registration requests or engine/game state changes. See the plugin lifecycle documentation for more information on the lifecycle events available for plugins to listen to.