com.sk89q.worldedit

Class WorldEdit

java.lang.Object

com.sk89q.worldedit.WorldEdit

public class WorldEdit
extends Object

This class is the main entry point for WorldEdit. All events are routed to an instance of this controller for processing by WorldEdit. For integrating WorldEdit in other platforms, an instance of this class should be created and events should be redirected to it.

Author:

sk89q

Field Summary

Fields

Modifier and Type	Field and Description
Logger	commandLogger
static Logger	logger Logger for debugging.

Constructor Summary

Constructors

Constructor and Description
WorldEdit(ServerInterface server, LocalConfiguration config) Construct an instance of the plugin

Method Summary

Methods

Modifier and Type	Method and Description
void	checkMaxBrushRadius(double radius) Checks to see if the specified brush radius is within bounds.
void	checkMaxRadius(double radius) Checks to see if the specified radius is within bounds.
void	clearSessions() Remove all sessions.
String[]	commandDetection(String[] split)
static int	divisorMod(int a, int n) Modulus, divisor-style.
void	flushBlockBag(LocalPlayer player, EditSession editSession) Flush a block bag's changes to a player.
void	flushExpiredSessions(SessionCheck checker)
void	forgetPlayer(LocalPlayer player) Forget a player.
BaseBlock	getBlock(LocalPlayer player, String id) Get a block.
BaseBlock	getBlock(LocalPlayer player, String arg, boolean allAllowed)
BaseBlock	getBlock(LocalPlayer player, String arg, boolean allAllowed, boolean allowNoData) Get an item ID from an item name or an item ID number.
Set<Integer>	getBlockIDs(LocalPlayer player, String list, boolean allBlocksAllowed) Get a list of blocks as a set.
Mask	getBlockMask(LocalPlayer player, LocalSession session, String maskString) Get a block mask.
Pattern	getBlockPattern(LocalPlayer player, String patternString) Returns a Pattern corresponding to the specified pattern string, as given by the player on the command line.
Set<BaseBlock>	getBlocks(LocalPlayer player, String list)
Set<BaseBlock>	getBlocks(LocalPlayer player, String list, boolean allAllowed)
Set<BaseBlock>	getBlocks(LocalPlayer player, String list, boolean allAllowed, boolean allowNoData)
Map<String,String>	getCommands()
CommandsManager<LocalPlayer>	getCommandsManager()
LocalConfiguration	getConfiguration() Get Worldedit's configuration.
Vector	getDiagonalDirection(LocalPlayer player, String dirStr) Get diagonal direction vector for a player's direction.
Vector	getDirection(LocalPlayer player, String dirStr) Get the direction vector for a player's direction.
EditSessionFactory	getEditSessionFactory() Get the edit session factory
CuboidClipboard.FlipDirection	getFlipDirection(LocalPlayer player, String dirStr) Get the flip direction for a player's direction.
static WorldEdit	getInstance() Gets the current instance of this class
int	getMaximumPolygonalPoints(LocalPlayer player)
int	getMaximumPolyhedronPoints(LocalPlayer player)
File	getSafeOpenFile(LocalPlayer player, File dir, String filename, String defaultExt, String... extensions) Gets the path to a file.
File	getSafeSaveFile(LocalPlayer player, File dir, String filename, String defaultExt, String... extensions) Gets the path to a file.
ServerInterface	getServer() Get the server interface.
LocalSession	getSession(LocalPlayer player) Gets the WorldEdit session for a player.
LocalSession	getSession(String player) Gets the LocalSession for a player name if it exists
static String	getVersion() Get the version.
File	getWorkingDirectoryFile(String path) Get a file relative to the defined working directory.
boolean	handleArmSwing(LocalPlayer player) Called on arm swing.
boolean	handleBlockLeftClick(LocalPlayer player, WorldVector clicked) Called on left click.
boolean	handleBlockRightClick(LocalPlayer player, WorldVector clicked) Called on right click.
boolean	handleCommand(LocalPlayer player, String[] split)
void	handleDisconnect(LocalPlayer player) Deprecated.
boolean	handleRightClick(LocalPlayer player) Called on right click (not on a block).
boolean	hasSession(LocalPlayer player) Returns true if the player has a session.
void	markExpire(LocalPlayer player)
void	removeSession(LocalPlayer player) Remove a session.
void	runScript(LocalPlayer player, File f, String[] args) Executes a WorldEdit script.
void	setEditSessionFactory(EditSessionFactory factory) Set the edit session factory
static void	setVersion(String version)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final Logger logger

Logger for debugging.

commandLogger

public final Logger commandLogger

Constructor Detail

WorldEdit

public WorldEdit(ServerInterface server,
         LocalConfiguration config)

Construct an instance of the plugin

Parameters:

server -

config -

Method Detail

getInstance

public static WorldEdit getInstance()

Gets the current instance of this class

Returns:

getSession

public LocalSession getSession(String player)

Gets the LocalSession for a player name if it exists

Parameters:

player -

Returns:

The session for the player, if it exists

getSession

public LocalSession getSession(LocalPlayer player)

Gets the WorldEdit session for a player.

Parameters:

player -

Returns:

hasSession

public boolean hasSession(LocalPlayer player)

Returns true if the player has a session.

Parameters:

player -

Returns:

getBlock

public BaseBlock getBlock(LocalPlayer player,
                 String arg,
                 boolean allAllowed)
                   throws WorldEditException

Throws:

WorldEditException

getBlock

public BaseBlock getBlock(LocalPlayer player,
                 String arg,
                 boolean allAllowed,
                 boolean allowNoData)
                   throws WorldEditException

Get an item ID from an item name or an item ID number.

Parameters:

player -

arg -

allAllowed - true to ignore blacklists

allowNoData - return -1 for data if no data was given.

Returns:

Throws:

UnknownItemException

DisallowedItemException

WorldEditException

getBlock

public BaseBlock getBlock(LocalPlayer player,
                 String id)
                   throws WorldEditException

Get a block.

Parameters:

player -

id -

Returns:

Throws:

UnknownItemException

DisallowedItemException

WorldEditException

getBlocks

public Set<BaseBlock> getBlocks(LocalPlayer player,
                       String list,
                       boolean allAllowed,
                       boolean allowNoData)
                         throws WorldEditException

Throws:

WorldEditException

getBlocks

public Set<BaseBlock> getBlocks(LocalPlayer player,
                       String list,
                       boolean allAllowed)
                         throws WorldEditException

Throws:

WorldEditException

getBlocks

public Set<BaseBlock> getBlocks(LocalPlayer player,
                       String list)
                         throws WorldEditException

Throws:

WorldEditException

getBlockPattern

public Pattern getBlockPattern(LocalPlayer player,
                      String patternString)
                        throws WorldEditException

Returns a Pattern corresponding to the specified pattern string, as given by the player on the command line.

Parameters:

player -

patternString -

Returns:

pattern

Throws:

UnknownItemException

DisallowedItemException

WorldEditException

getBlockMask

public Mask getBlockMask(LocalPlayer player,
                LocalSession session,
                String maskString)
                  throws WorldEditException

Get a block mask. Block masks are used to determine which blocks to include when replacing.

Parameters:

player -

session -

maskString -

Returns:

Throws:

WorldEditException

getBlockIDs

public Set<Integer> getBlockIDs(LocalPlayer player,
                       String list,
                       boolean allBlocksAllowed)
                         throws WorldEditException

Get a list of blocks as a set.

Parameters:

player -

list -

allBlocksAllowed -

Returns:

set

Throws:

UnknownItemException

DisallowedItemException

WorldEditException

getSafeSaveFile

public File getSafeSaveFile(LocalPlayer player,
                   File dir,
                   String filename,
                   String defaultExt,
                   String... extensions)
                     throws FilenameException

Gets the path to a file. This method will check to see if the filename has valid characters and has an extension. It also prevents directory traversal exploits by checking the root directory and the file directory. On success, a java.io.File object will be returned.

Parameters:

player -

dir - sub-directory to look in

filename - filename (user-submitted)

defaultExt - append an extension if missing one, null to not use

extensions - list of extensions, null for any

Returns:

Throws:

FilenameException

getSafeOpenFile

public File getSafeOpenFile(LocalPlayer player,
                   File dir,
                   String filename,
                   String defaultExt,
                   String... extensions)
                     throws FilenameException

Gets the path to a file. This method will check to see if the filename has valid characters and has an extension. It also prevents directory traversal exploits by checking the root directory and the file directory. On success, a java.io.File object will be returned.

Parameters:

player -

dir - sub-directory to look in

filename - filename (user-submitted)

defaultExt - append an extension if missing one, null to not use

extensions - list of extensions, null for any

Returns:

Throws:

FilenameException

getMaximumPolygonalPoints

public int getMaximumPolygonalPoints(LocalPlayer player)

getMaximumPolyhedronPoints

public int getMaximumPolyhedronPoints(LocalPlayer player)

checkMaxRadius

public void checkMaxRadius(double radius)
                    throws MaxRadiusException

Checks to see if the specified radius is within bounds.

Parameters:

radius -

Throws:

MaxRadiusException

checkMaxBrushRadius

public void checkMaxBrushRadius(double radius)
                         throws MaxBrushRadiusException

Checks to see if the specified brush radius is within bounds.

Parameters:

radius -

Throws:

MaxBrushRadiusException

getWorkingDirectoryFile

public File getWorkingDirectoryFile(String path)

Get a file relative to the defined working directory. If the specified path is absolute, then the working directory is not used.

Parameters:

path -

Returns:

divisorMod

public static int divisorMod(int a,
             int n)

Modulus, divisor-style.

Parameters:

a -

n -

Returns:

getDirection

public Vector getDirection(LocalPlayer player,
                  String dirStr)
                    throws UnknownDirectionException

Get the direction vector for a player's direction. May return null if a direction could not be found.

Parameters:

player -

dirStr -

Returns:

Throws:

UnknownDirectionException

getDiagonalDirection

public Vector getDiagonalDirection(LocalPlayer player,
                          String dirStr)
                            throws UnknownDirectionException

Get diagonal direction vector for a player's direction. May return null if a direction could not be found.

Parameters:

player -

dirStr -

Returns:

Throws:

UnknownDirectionException

getFlipDirection

public CuboidClipboard.FlipDirection getFlipDirection(LocalPlayer player,
                                             String dirStr)
                                               throws UnknownDirectionException

Get the flip direction for a player's direction.

Parameters:

player -

dirStr -

Returns:

Throws:

UnknownDirectionException

removeSession

public void removeSession(LocalPlayer player)

Remove a session.

Parameters:

player -

clearSessions

public void clearSessions()

Remove all sessions.

flushBlockBag

public void flushBlockBag(LocalPlayer player,
                 EditSession editSession)

Flush a block bag's changes to a player.

Parameters:

player -

editSession -

getCommands

public Map<String,String> getCommands()

Returns:

the commands

getCommandsManager

public CommandsManager<LocalPlayer> getCommandsManager()

Returns:

the commands

handleDisconnect

@Deprecated
public void handleDisconnect(LocalPlayer player)

Deprecated.

Parameters:

player -

markExpire

public void markExpire(LocalPlayer player)

Parameters:

player -

forgetPlayer

public void forgetPlayer(LocalPlayer player)

Forget a player.

Parameters:

player -

flushExpiredSessions

public void flushExpiredSessions(SessionCheck checker)

handleArmSwing

public boolean handleArmSwing(LocalPlayer player)

Called on arm swing.

Parameters:

player -

Returns:

handleRightClick

public boolean handleRightClick(LocalPlayer player)

Called on right click (not on a block).

Parameters:

player -

Returns:

handleBlockRightClick

public boolean handleBlockRightClick(LocalPlayer player,
                            WorldVector clicked)

Called on right click.

Parameters:

player -

clicked -

Returns:

false if you want the action to go through

handleBlockLeftClick

public boolean handleBlockLeftClick(LocalPlayer player,
                           WorldVector clicked)

Called on left click.

Parameters:

player -

clicked -

Returns:

false if you want the action to go through

handleCommand

public boolean handleCommand(LocalPlayer player,
                    String[] split)

Parameters:

player -

split -

Returns:

whether the command was processed

commandDetection

public String[] commandDetection(String[] split)

runScript

public void runScript(LocalPlayer player,
             File f,
             String[] args)
               throws WorldEditException

Executes a WorldEdit script.

Parameters:

player -

f -

args -

Throws:

WorldEditException

getConfiguration

public LocalConfiguration getConfiguration()

Get Worldedit's configuration.

Returns:

getServer

public ServerInterface getServer()

Get the server interface.

Returns:

getEditSessionFactory

public EditSessionFactory getEditSessionFactory()

Get the edit session factory

Returns:

setEditSessionFactory

public void setEditSessionFactory(EditSessionFactory factory)

Set the edit session factory

Parameters:

factory -

getVersion

public static String getVersion()

Get the version.

Returns:

setVersion

public static void setVersion(String version)