com.sk89q.worldedit.bukkit

Class BukkitServerInterface

java.lang.Object

com.sk89q.worldedit.extension.platform.AbstractPlatform

com.sk89q.worldedit.ServerInterface

com.sk89q.worldedit.bukkit.BukkitServerInterface

All Implemented Interfaces:

MultiUserPlatform, Platform

public class BukkitServerInterface
extends ServerInterface
implements MultiUserPlatform

Field Summary

Fields

Modifier and Type	Field and Description
WorldEditPlugin	plugin
org.bukkit.Server	server

Constructor Summary

Constructors

Constructor and Description
BukkitServerInterface(WorldEditPlugin plugin, org.bukkit.Server server)

Method Summary

Modifier and Type	Method and Description
Map<Capability,Preference>	getCapabilities() Get a map of advertised capabilities of this platform, where each key in the given map is a supported capability and the respective value indicates the preference for this platform for that given capability.
LocalConfiguration	getConfiguration() Get the configuration from this platform.
Collection<Actor>	getConnectedUsers() Get a list of connected users.
String	getPlatformName() Get a friendly name of the platform.
String	getPlatformVersion() Get the version of the platform, which can be anything.
String	getVersion() Get the version of WorldEdit that this platform provides.
List<LocalWorld>	getWorlds() Get a list of available or loaded worlds.
boolean	isValidMobType(String type) Checks if a mob type is valid.
Player	matchPlayer(Player player) Create a duplicate of the given player.
BukkitWorld	matchWorld(World world) Create a duplicate of the given world.
void	registerCommands(Dispatcher dispatcher) Register the commands contained within the given command dispatcher.
void	registerGameHooks() Register game hooks.
void	reload() Reload WorldEdit configuration.
int	resolveItem(String name) Resolves an item name to its ID.
int	schedule(long delay, long period, Runnable task) Schedules the given task to be invoked once every period ticks after an initial delay of delay ticks.
void	unregisterCommands()

Methods inherited from class java.lang.Object

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

Field Detail

server

public org.bukkit.Server server

plugin

public WorldEditPlugin plugin

Constructor Detail

BukkitServerInterface

public BukkitServerInterface(WorldEditPlugin plugin,
                             org.bukkit.Server server)

Method Detail

resolveItem

public int resolveItem(String name)

Description copied from interface: Platform

Resolves an item name to its ID.

Specified by:

resolveItem in interface Platform

Parameters:

name - The name to look up

Returns:

The id that corresponds to the name, or -1 if no such ID exists

isValidMobType

public boolean isValidMobType(String type)

Description copied from interface: Platform

Checks if a mob type is valid.

Specified by:

isValidMobType in interface Platform

Parameters:

type - The mob type name to check

Returns:

Whether the name is a valid mod bype

reload

public void reload()

Description copied from interface: Platform

Reload WorldEdit configuration.

Specified by:

reload in interface Platform

schedule

public int schedule(long delay,
                    long period,
                    Runnable task)

Description copied from interface: Platform

Schedules the given task to be invoked once every period ticks after an initial delay of delay ticks.

Specified by:

schedule in interface Platform

Overrides:

schedule in class AbstractPlatform

Parameters:

delay - Delay in server ticks before executing first repeat

period - Period in server ticks of the task

task - Task to be executed

Returns:

Task id number (-1 if scheduling failed)

getWorlds

public List<LocalWorld> getWorlds()

Description copied from interface: Platform

Get a list of available or loaded worlds.

Specified by:

getWorlds in interface Platform

Overrides:

getWorlds in class AbstractPlatform

Returns:

a list of worlds

matchPlayer

@Nullable
public Player matchPlayer(Player player)

Description copied from interface: Platform

Create a duplicate of the given player.

The given player may have been provided by a different platform.

Specified by:

matchPlayer in interface Platform

Parameters:

player - the player to match

Returns:

a matched player, otherwise null

matchWorld

@Nullable
public BukkitWorld matchWorld(World world)

Description copied from interface: Platform

Create a duplicate of the given world.

The given world may have been provided by a different platform.

Specified by:

matchWorld in interface Platform

Parameters:

world - the world to match

Returns:

a matched world, otherwise null

registerCommands

public void registerCommands(Dispatcher dispatcher)

Description copied from interface: Platform

Register the commands contained within the given command dispatcher.

Specified by:

registerCommands in interface Platform

Parameters:

dispatcher - the dispatcher

registerGameHooks

public void registerGameHooks()

Description copied from interface: Platform

Register game hooks.

Specified by:

registerGameHooks in interface Platform

getConfiguration

public LocalConfiguration getConfiguration()

Description copied from interface: Platform

Get the configuration from this platform.

Specified by:

getConfiguration in interface Platform

Returns:

the configuration

getVersion

public String getVersion()

Description copied from interface: Platform

Get the version of WorldEdit that this platform provides.

This version should match WorldEdit releases because it may be checked to match.

Specified by:

getVersion in interface Platform

Returns:

the version

getPlatformName

public String getPlatformName()

Description copied from interface: Platform

Get a friendly name of the platform.

The name can be anything (reasonable). An example name may be "Bukkit" or "Forge".

Specified by:

getPlatformName in interface Platform

Returns:

the platform name

getPlatformVersion

public String getPlatformVersion()

Description copied from interface: Platform

Get the version of the platform, which can be anything.

Specified by:

getPlatformVersion in interface Platform

Returns:

the platform version

getCapabilities

public Map<Capability,Preference> getCapabilities()

Description copied from interface: Platform

Get a map of advertised capabilities of this platform, where each key in the given map is a supported capability and the respective value indicates the preference for this platform for that given capability.

Specified by:

getCapabilities in interface Platform

Returns:

a map of capabilities

unregisterCommands

public void unregisterCommands()

getConnectedUsers

public Collection<Actor> getConnectedUsers()

Description copied from interface: MultiUserPlatform

Get a list of connected users.

Specified by:

getConnectedUsers in interface MultiUserPlatform

Returns:

a list of connected users