API

Linking

NOTE: The java package name changed as of v8.0beta5!

1. Add the Transporter.jar file to compile time libraries of your plugin.
2. Make sure to add depend: [Transporter] to your plugin.yml.
3. Use something like the following code in your plugin's onEnable method:

Plugin p = getServer().getPluginManager().getPlugin("Transporter");
if ((p != null) && p.isEnabled()) {
    com.frdfsnlght.transporter.api.API api = ((com.frdfsnlght.transporter.Transporter)p).getAPI();
    // ... do something with the API ...
}

All API classes are under the com.frdfsnlght.transporter.api package.

Options

The API has some options which can be set using the trp api set ... command. Use the trp api get ... command to see the current option values. Each option is described below.

Option	Type	Default	Version	Description
debug	boolean	false	v8.0+	Should debug messages from the API be displayed on the console. The API issues it's own debug messages independent of the global "debug" option.
timeout	integer	5000	v8.0+	The time, in milliseconds, before a remote API call times out with an exception.

Documentation

API documentation is in JavaDoc format and part of the code repository. You must checkout a copy of the code (from the Repository) and look in the "apidocs" folder.