org.openrune

Interface Sandbox

public interface Sandbox

The Sandbox defines the way that the plugin interacts with the engine of the server. Each plugin is given it's own Sandbox to operate within.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Component component) Add a Component to the Sandbox.
int	getVersion() Get the version of the Sandbox.

Method Detail

getVersion

int getVersion()

Get the version of the Sandbox.

The version number of the Sandbox can be used to determine what features are supported, or if a bug in a specific version has been fixed. Generally plugins should work on a specified version of the Sandbox and up.

Returns:

The version of the Sandbox.

add

void add(Component component)

Add a Component to the Sandbox.

A plugin can add as many Component objects as it would like to the Sandbox, and the engine will load all of them. However, plugins must NEVER have a component add itself or a parent component to the Sandbox, as this will result in an infinite loop.

Parameters:

component - The Component that should be added.