Class Plugin utama

Catatan

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.

Memulai Class anda

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 menyarankan <https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html>`_ untuk menggunakan domain anda sebagai nama paket, jika anda memiliki domain. Akan tetapi, dalam event yang anda tidak memiliki domain, sebuah latihan umum adalah dengan menggunakan sebuah alamat email (seperti com.gmail.username.project) atau sebuah gudang penyimpanan open-source (seperti io.github.username.project).

After creating your main class, the Plugin annotation must be affixed to it. This annotation allows Sponge to easily find your main plugin class when your plugin is loaded. An example usage is illustrated below, more detailed usage is explained on Plugin Metadata.

package io.github.username.project;

import org.spongepowered.plugin.Plugin;

@Plugin(id = "exampleplugin")
public class ExamplePlugin {

}

Catatan

Mengacu pada Pengenal Plugin jika anda belum memilih ID plugin.

Memeriksa Plugin Anda

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(id = "exampleplugin")
public class ExamplePlugin {

    @Inject
    private Logger logger;

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

}

Tip

The Sponge documentation provides a guide with more information on events (see Acara). 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.