com.sk89q.worldedit.bukkit

Class WorldEditPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.sk89q.worldedit.bukkit.WorldEditPlugin

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class WorldEditPlugin
extends org.bukkit.plugin.java.JavaPlugin
implements org.bukkit.command.TabCompleter

Plugin for Bukkit.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUI_PLUGIN_CHANNEL

Constructor Summary

Constructors

Constructor and Description
WorldEditPlugin()

Method Summary

Modifier and Type	Method and Description
protected void	createDefaultConfiguration(String name) Create a default configuration file from the .jar.
EditSession	createEditSession(org.bukkit.entity.Player player) Gets the session for the player.
WorldEditAPI	getAPI() Deprecated. use the regular API
BukkitConfiguration	getLocalConfiguration() Returns the configuration used by WorldEdit.
PermissionsResolverManager	getPermissionsResolver() Get the permissions resolver in use.
Selection	getSelection(org.bukkit.entity.Player player) Gets the region selection for the player.
ServerInterface	getServerInterface() Get the server interface.
LocalSession	getSession(org.bukkit.entity.Player player) Gets the session for the player.
WorldEdit	getWorldEdit() Get WorldEdit.
protected void	loadConfiguration() Loads and reloads all configuration.
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command cmd, String commandLabel, String[] args)
void	onDisable() Called on plugin disable.
void	onEnable() Called on plugin enable.
List<String>	onTabComplete(org.bukkit.command.CommandSender sender, org.bukkit.command.Command cmd, String commandLabel, String[] args)
void	perform(org.bukkit.entity.Player player, WorldEditOperation op) Deprecated. use the regular API
void	remember(org.bukkit.entity.Player player, EditSession editSession) Remember an edit session.
void	setSelection(org.bukkit.entity.Player player, Selection selection) Sets the region selection for a player.
Actor	wrapCommandSender(org.bukkit.command.CommandSender sender)
BukkitPlayer	wrapPlayer(org.bukkit.entity.Player player) Used to wrap a Bukkit Player as a LocalPlayer.

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, initialize, installDDL, isEnabled, isInitialized, isNaggable, onLoad, reloadConfig, removeDDL, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CUI_PLUGIN_CHANNEL

public static final String CUI_PLUGIN_CHANNEL

See Also:

Constant Field Values

Constructor Detail

WorldEditPlugin

public WorldEditPlugin()

Method Detail

onEnable

public void onEnable()

Called on plugin enable.

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Called on plugin disable.

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

loadConfiguration

protected void loadConfiguration()

Loads and reloads all configuration.

createDefaultConfiguration

protected void createDefaultConfiguration(String name)

Create a default configuration file from the .jar.

Parameters:

name - the filename

onCommand

public boolean onCommand(org.bukkit.command.CommandSender sender,
                         org.bukkit.command.Command cmd,
                         String commandLabel,
                         String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

Overrides:

onCommand in class org.bukkit.plugin.java.JavaPlugin

onTabComplete

public List<String> onTabComplete(org.bukkit.command.CommandSender sender,
                                  org.bukkit.command.Command cmd,
                                  String commandLabel,
                                  String[] args)

Specified by:

onTabComplete in interface org.bukkit.command.TabCompleter

Overrides:

onTabComplete in class org.bukkit.plugin.java.JavaPlugin

getSession

public LocalSession getSession(org.bukkit.entity.Player player)

Gets the session for the player.

Parameters:

player - a player

Returns:

a session

createEditSession

public EditSession createEditSession(org.bukkit.entity.Player player)

Gets the session for the player.

Parameters:

player - a player

Returns:

a session

remember

public void remember(org.bukkit.entity.Player player,
                     EditSession editSession)

Remember an edit session.

Parameters:

player - a player

editSession - an edit session

perform

@Deprecated
public void perform(org.bukkit.entity.Player player,
                                WorldEditOperation op)
                         throws Throwable

Deprecated. use the regular API

Wrap an operation into an EditSession.

Parameters:

player - a player

op - the operation

Throws:

Throwable - on any error

getAPI

@Deprecated
public WorldEditAPI getAPI()

Deprecated. use the regular API

Get the API.

Returns:

the API

getLocalConfiguration

public BukkitConfiguration getLocalConfiguration()

Returns the configuration used by WorldEdit.

Returns:

the configuration

getPermissionsResolver

public PermissionsResolverManager getPermissionsResolver()

Get the permissions resolver in use.

Returns:

the permissions resolver

wrapPlayer

public BukkitPlayer wrapPlayer(org.bukkit.entity.Player player)

Used to wrap a Bukkit Player as a LocalPlayer.

Parameters:

player - a player

Returns:

a wrapped player

wrapCommandSender

public Actor wrapCommandSender(org.bukkit.command.CommandSender sender)

getServerInterface

public ServerInterface getServerInterface()

Get the server interface.

Returns:

the server interface

getWorldEdit

public WorldEdit getWorldEdit()

Get WorldEdit.

Returns:

an instance

getSelection

public Selection getSelection(org.bukkit.entity.Player player)

Gets the region selection for the player.

Parameters:

player - aplayer

Returns:

the selection or null if there was none

setSelection

public void setSelection(org.bukkit.entity.Player player,
                         Selection selection)

Sets the region selection for a player.

Parameters:

player - the player

selection - a selection