org.openrune

Interface Plugin

public interface Plugin

An OpenRune plugin. All plugins must implement this interface in order to provides servers to the OpenRune server.

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	ALL_CLIENT_VERSIONS This constant defines an int array that allows a plugin to work with any client version by default.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getAuthor() Get the authors of the plugin.
int	getBuild() Get the build number of the plugin.
int[]	getClientVersions() Get the array of client versions that the plugin can be used with.
java.lang.String	getName() Get the name of the plugin.
java.lang.String	getNamespace() Get the namespace that the plugin resides in.
void	init(Sandbox sandbox) Initialize the plugin.

Field Detail

ALL_CLIENT_VERSIONS

static final int[] ALL_CLIENT_VERSIONS

This constant defines an int array that allows a plugin to work with any client version by default.

Method Detail

getNamespace

java.lang.String getNamespace()

Get the namespace that the plugin resides in. The namespace of the plugin should be in reverse-domain format, much like a Java package.

You should use a domain name that you control, and use of the OpenRune name along with the a name for the plugin is suggested.

An example namespace: org.allgofree.openrune.smithing

Returns:

The namespace of the plugin.

getName

java.lang.String getName()

Get the name of the plugin. The name of the plugin should be a simple, properly capitalized, human readable name.

An example name would be "Smithing" (no quotes).

Returns:

The name of the plugin.

getAuthor

java.lang.String[] getAuthor()

Get the authors of the plugin. An array of String objects should be returned from this method, with each entry in the array containing the name of an author.

Returns:

The array containing the authors of the plugin.

getBuild

int getBuild()

Get the build number of the plugin. The build number of the plugin should increase with each release of the plugin. Build numbers will be used in tracking bugs, so two versions of a plugin should not have the same build number.

Returns:

The build number of the plugin.

getClientVersions

int[] getClientVersions()

Get the array of client versions that the plugin can be used with. This method should return an array of ints, with each int specifying a client version. Plugins can also return constants to work by default with any client version. These constants are defined in this interface; the most common being ALL_CLIENT_VERSIONS.

Returns:

The versions that the plugin can be used with.

init

void init(Sandbox sandbox)

Initialize the plugin. This is where the plugin should register all of it's listeners, loaders, components, and so on. This method may be called more then once if the plugin is unloaded and then reloaded.

Parameters:

sandbox - The sandbox environment.