com.sk89q.worldedit.extension.platform

Class PlatformManager

java.lang.Object

com.sk89q.worldedit.extension.platform.PlatformManager

public class PlatformManager
extends Object

Manages registered Platforms for WorldEdit. Platforms are implementations of WorldEdit.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
PlatformManager(WorldEdit worldEdit) Create a new platform manager.

Method Summary

Modifier and Type	Method and Description
<T extends Actor> T	createProxyActor(T base) Given an actor, return a new one that may use a different platform for permissions and world editing.
CommandManager	getCommandManager() Get the command manager.
LocalConfiguration	getConfiguration() Get the current configuration.
List<Platform>	getPlatforms() Get a list of loaded platforms.
ServerInterface	getServerInterface() Return a legacy ServerInterface.
World	getWorldForEditing(World base) Given a world, possibly return the same world but using a different platform preferred for world editing operations.
void	handleBlockInteract(BlockInteractEvent event)
void	handlePlatformReady(PlatformReadyEvent event)
void	handlePlayerInput(PlayerInputEvent event)
Platform	queryCapability(Capability capability) Get the preferred platform for handling a certain capability.
void	register(Platform platform) Register a platform with WorldEdit.
boolean	unregister(Platform platform) Unregister a platform from WorldEdit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlatformManager

public PlatformManager(WorldEdit worldEdit)

Create a new platform manager.

Parameters:

worldEdit - the WorldEdit instance

Method Detail

register

public void register(Platform platform)

Register a platform with WorldEdit.

Parameters:

platform - the platform

unregister

public boolean unregister(Platform platform)

Unregister a platform from WorldEdit.

If the platform has been chosen for any capabilities, then a new platform will be found.

Parameters:

platform - the platform

queryCapability

public Platform queryCapability(Capability capability)
                         throws NoCapablePlatformException

Get the preferred platform for handling a certain capability. Returns null if none is available.

Parameters:

capability - the capability

Returns:

the platform

Throws:

NoCapablePlatformException - thrown if no platform is capable

getPlatforms

public List<Platform> getPlatforms()

Get a list of loaded platforms.

The returned list is a copy of the original and is mutable.

Returns:

a list of platforms

getWorldForEditing

public World getWorldForEditing(World base)

Given a world, possibly return the same world but using a different platform preferred for world editing operations.

Parameters:

base - the world to match

Returns:

the preferred world, if one was found, otherwise the given world

createProxyActor

public <T extends Actor> T createProxyActor(T base)

Given an actor, return a new one that may use a different platform for permissions and world editing.

Parameters:

base - the base actor to match

Returns:

a new delegate actor

getCommandManager

public CommandManager getCommandManager()

Get the command manager.

Returns:

the command manager

getConfiguration

public LocalConfiguration getConfiguration()

Get the current configuration.

If no platform has been registered yet, then a default configuration will be returned.

Returns:

the configuration

getServerInterface

public ServerInterface getServerInterface()
                                   throws IllegalStateException

Return a legacy ServerInterface.

Returns:

a ServerInterface

Throws:

IllegalStateException - if no platform has been registered

handlePlatformReady

public void handlePlatformReady(PlatformReadyEvent event)

handleBlockInteract

public void handleBlockInteract(BlockInteractEvent event)

handlePlayerInput

public void handlePlayerInput(PlayerInputEvent event)