com.sk89q.worldedit

Class WorldEdit

java.lang.Object

com.sk89q.worldedit.WorldEdit

public class WorldEdit
extends Object

The entry point and container for a working implementation of WorldEdit.

An instance handles event handling; block, mask, pattern, etc. registration; the management of sessions; the creation of EditSessions; and more. In order to use WorldEdit, at least one Platform must be registered with WorldEdit using PlatformManager.register(Platform) on the manager retrieved using getPlatformManager().

An instance of WorldEdit can be retrieved using the static method getInstance(), which is shared among all platforms within the same classloader hierarchy.

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	logger

Method Summary

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() Deprecated. use getSessionManager()
void	flushBlockBag(Actor actor, EditSession editSession) Flush a block bag's changes to a player.
BaseBlock	getBlock(Player player, String id) Deprecated. Use getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)
BaseBlock	getBlock(Player player, String arg, boolean allAllowed) Deprecated. Use getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)
BaseBlock	getBlock(Player player, String arg, boolean allAllowed, boolean allowNoData) Deprecated. Use getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)
BlockFactory	getBlockFactory() Get the block factory from which new BaseBlocks can be constructed.
Set<Integer>	getBlockIDs(Player player, String list, boolean allBlocksAllowed) Deprecated. Use getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)
Mask	getBlockMask(Player player, LocalSession session, String input) Deprecated. Use getMaskFactory() ()} and AbstractFactory.parseFromInput(String, ParserContext)
Pattern	getBlockPattern(Player player, String input) Deprecated. Use getPatternFactory() and AbstractFactory.parseFromInput(String, ParserContext)
Set<BaseBlock>	getBlocks(Player player, String list) Deprecated. Use getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)
Set<BaseBlock>	getBlocks(Player player, String list, boolean allAllowed) Deprecated. Use getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)
Set<BaseBlock>	getBlocks(Player player, String list, boolean allAllowed, boolean allowNoData) Deprecated. Use getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)
LocalConfiguration	getConfiguration() Get Worldedit's configuration.
Vector	getDiagonalDirection(Player player, String dirStr) Get diagonal direction vector for a player's direction.
Vector	getDirection(Player player, String dirStr) Get the direction vector for a player's direction.
EditSessionFactory	getEditSessionFactory() Get a factory for EditSessions.
EventBus	getEventBus() Get the event bus for WorldEdit.
CuboidClipboard.FlipDirection	getFlipDirection(Player player, String dirStr) Get the flip direction for a player's direction.
static WorldEdit	getInstance() Gets the current instance of this class.
MaskFactory	getMaskFactory() Get the mask factory from which new Masks can be constructed.
PatternFactory	getPatternFactory() Get the pattern factory from which new Patterns can be constructed.
PlatformManager	getPlatformManager() Get the platform manager, where platforms (that implement WorldEdit) can be registered and information about registered platforms can be queried.
File	getSafeOpenFile(Player player, File dir, String filename, String defaultExt, String... extensions) Gets the path to a file.
File	getSafeSaveFile(Player player, File dir, String filename, String defaultExt, String... extensions) Gets the path to a file.
ServerInterface	getServer() Get the server interface.
LocalSession	getSession(Player player) Deprecated. use getSessionManager()
LocalSession	getSession(String player) Deprecated. Use getSessionManager()
SessionManager	getSessionManager() Return the session manager.
static String	getVersion() Get the version.
File	getWorkingDirectoryFile(String path) Get a file relative to the defined working directory.
boolean	handleArmSwing(Player player) Called on arm swing.
boolean	handleBlockLeftClick(Player player, WorldVector clicked) Called on left click.
boolean	handleBlockRightClick(Player player, WorldVector clicked) Called on right click.
boolean	handleRightClick(Player player) Called on right click (not on a block).
boolean	hasSession(Player player) Deprecated. use getSessionManager()
void	removeSession(Player player) Deprecated. use getSessionManager()
void	runScript(Player player, File f, String[] args) Executes a WorldEdit script.
void	setEditSessionFactory(EditSessionFactory factory) Deprecated. EditSessionFactories are no longer used. Please register an EditSessionEvent event with the event bus in order to override or catch changes to the world
static void	setVersion(String version) Deprecated. Declare your platform version with Platform.getPlatformVersion()

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

Method Detail

getInstance

public static WorldEdit getInstance()

Gets the current instance of this class.

An instance will always be available, but no platform may yet be registered with WorldEdit, meaning that a number of operations may fail. However, event handlers can be registered.

Returns:

an instance of WorldEdit.

getPlatformManager

public PlatformManager getPlatformManager()

Get the platform manager, where platforms (that implement WorldEdit) can be registered and information about registered platforms can be queried.

Returns:

the platform manager

getEventBus

public EventBus getEventBus()

Get the event bus for WorldEdit.

Event handlers can be registered on the event bus.

Returns:

the event bus

getBlockFactory

public BlockFactory getBlockFactory()

Get the block factory from which new BaseBlocks can be constructed.

Returns:

the block factory

getMaskFactory

public MaskFactory getMaskFactory()

Get the mask factory from which new Masks can be constructed.

Returns:

the mask factory

getPatternFactory

public PatternFactory getPatternFactory()

Get the pattern factory from which new Patterns can be constructed.

Returns:

the pattern factory

getSessionManager

public SessionManager getSessionManager()

Return the session manager.

Returns:

the session manager

getSession

@Deprecated
public LocalSession getSession(String player)

Deprecated. Use getSessionManager()

getSession

@Deprecated
public LocalSession getSession(Player player)

Deprecated. use getSessionManager()

removeSession

@Deprecated
public void removeSession(Player player)

Deprecated. use getSessionManager()

clearSessions

@Deprecated
public void clearSessions()

Deprecated. use getSessionManager()

hasSession

@Deprecated
public boolean hasSession(Player player)

Deprecated. use getSessionManager()

getBlock

@Deprecated
public BaseBlock getBlock(Player player,
                                      String arg,
                                      boolean allAllowed)
                               throws WorldEditException

Deprecated. Use getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)

Throws:

WorldEditException

getBlock

@Deprecated
public BaseBlock getBlock(Player player,
                                      String arg,
                                      boolean allAllowed,
                                      boolean allowNoData)
                               throws WorldEditException

Deprecated. Use getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)

Throws:

WorldEditException

getBlock

@Deprecated
public BaseBlock getBlock(Player player,
                                      String id)
                               throws WorldEditException

Deprecated. Use getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)

Throws:

WorldEditException

getBlocks

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

Deprecated. Use getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)

Throws:

WorldEditException

getBlocks

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

Deprecated. Use getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)

Throws:

WorldEditException

getBlocks

@Deprecated
public Set<BaseBlock> getBlocks(Player player,
                                            String list)
                                     throws WorldEditException

Deprecated. Use getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)

Throws:

WorldEditException

getBlockIDs

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

Deprecated. Use getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)

Throws:

WorldEditException

getBlockPattern

@Deprecated
public Pattern getBlockPattern(Player player,
                                           String input)
                                    throws WorldEditException

Deprecated. Use getPatternFactory() and AbstractFactory.parseFromInput(String, ParserContext)

Throws:

WorldEditException

getBlockMask

@Deprecated
public Mask getBlockMask(Player player,
                                     LocalSession session,
                                     String input)
                              throws WorldEditException

Deprecated. Use getMaskFactory() ()} and AbstractFactory.parseFromInput(String, ParserContext)

Throws:

WorldEditException

getSafeSaveFile

public File getSafeSaveFile(Player 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 - the 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:

a file

Throws:

FilenameException - thrown if the filename is invalid

getSafeOpenFile

public File getSafeOpenFile(Player 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 - the 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:

a file

Throws:

FilenameException - thrown if the filename is invalid

checkMaxRadius

public void checkMaxRadius(double radius)
                    throws MaxRadiusException

Checks to see if the specified radius is within bounds.

Parameters:

radius - the radius

Throws:

MaxRadiusException

checkMaxBrushRadius

public void checkMaxBrushRadius(double radius)
                         throws MaxBrushRadiusException

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

Parameters:

radius - the 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 - the subpath under the working directory

Returns:

a working directory

getDirection

public Vector getDirection(Player 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 - the player

dirStr - the direction string

Returns:

a direction vector

Throws:

UnknownDirectionException - thrown if the direction is not known

getDiagonalDirection

public Vector getDiagonalDirection(Player 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 - the player

dirStr - the direction string

Returns:

a direction vector

Throws:

UnknownDirectionException - thrown if the direction is not known

getFlipDirection

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

Get the flip direction for a player's direction.

Parameters:

player - the player

dirStr - the direction string

Returns:

a direction vector

Throws:

UnknownDirectionException - thrown if the direction is not known

flushBlockBag

public void flushBlockBag(Actor actor,
                          EditSession editSession)

Flush a block bag's changes to a player.

Parameters:

actor - the actor

editSession - the edit session

handleArmSwing

public boolean handleArmSwing(Player player)

Called on arm swing.

Parameters:

player - the player

Returns:

true if the swing was handled

handleRightClick

public boolean handleRightClick(Player player)

Called on right click (not on a block).

Parameters:

player - the player

Returns:

true if the right click was handled

handleBlockRightClick

public boolean handleBlockRightClick(Player player,
                                     WorldVector clicked)

Called on right click.

Parameters:

player - the player

clicked - the clicked block

Returns:

false if you want the action to go through

handleBlockLeftClick

public boolean handleBlockLeftClick(Player player,
                                    WorldVector clicked)

Called on left click.

Parameters:

player - the player

clicked - the clicked block

Returns:

false if you want the action to go through

runScript

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

Executes a WorldEdit script.

Parameters:

player - the player

f - the script file to execute

args - arguments for the script

Throws:

WorldEditException

getConfiguration

public LocalConfiguration getConfiguration()

Get Worldedit's configuration.

Returns:

a configuration

getServer

public ServerInterface getServer()

Get the server interface.

Returns:

the server interface

getEditSessionFactory

public EditSessionFactory getEditSessionFactory()

Get a factory for EditSessions.

setEditSessionFactory

@Deprecated
public void setEditSessionFactory(EditSessionFactory factory)

Deprecated. EditSessionFactories are no longer used. Please register an EditSessionEvent event with the event bus in order to override or catch changes to the world

getVersion

public static String getVersion()

Get the version.

Returns:

the version of WorldEdit

setVersion

@Deprecated
public static void setVersion(String version)

Deprecated. Declare your platform version with Platform.getPlatformVersion()