Package com.sk89q.worldedit.command

Class ClipboardCommands

java.lang.Object

com.sk89q.worldedit.command.ClipboardCommands

public class ClipboardCommands
extends Object

Clipboard commands.

Constructor Summary

Constructors

Constructor	Description
ClipboardCommands()

Method Summary

Modifier and Type	Method	Description
void	clearClipboard(Actor actor, LocalSession session)
void	copy(Actor actor, LocalSession session, EditSession editSession, Region region, boolean copyEntities, boolean copyBiomes, boolean centerClipboard, Mask mask)
void	cut(Actor actor, LocalSession session, EditSession editSession, Region region, Pattern leavePattern, boolean copyEntities, boolean copyBiomes, Mask mask)
void	download(Actor actor, LocalSession session, String formatName)	Deprecated, for removal: This API element is subject to removal in a future version.
void	flip(Actor actor, LocalSession session, BlockVector3 direction)
void	lazyCopy(Actor actor, LocalSession session, EditSession editSession, Region region, boolean skipEntities, boolean copyBiomes)
void	paste(Actor actor, World world, LocalSession session, EditSession editSession, boolean ignoreAirBlocks, boolean atOrigin, boolean selectPasted, boolean onlySelect, boolean pasteEntities, boolean pasteBiomes, Mask sourceMask, boolean removeEntities)
void	place(Actor actor, World world, LocalSession session, EditSession editSession, boolean ignoreAirBlocks, boolean atOrigin, boolean selectPasted, boolean onlySelect, boolean pasteEntities, boolean pasteBiomes, boolean removeEntities)
void	rotate(Actor actor, LocalSession session, double rotateY, double rotateX, double rotateZ)

Methods inherited from class java.lang.Object

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

Constructor Details

ClipboardCommands

public ClipboardCommands()

Method Details

copy

public void copy(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Switch(name='e',desc="Also copy entities")
 boolean copyEntities,
 @Switch(name='b',desc="Also copy biomes")
 boolean copyBiomes,
 @Switch(name='c',desc="Set the origin of the clipboard to the center of the region, at the region\'s lowest y-level.")
 boolean centerClipboard,
 @ArgFlag(name='m',desc="Set the include mask, non-matching blocks become air",def="")
 Mask mask)
          throws WorldEditException

Throws:

WorldEditException

lazyCopy

public void lazyCopy(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Switch(name='e',desc="Skip copy entities")
 boolean skipEntities,
 @Switch(name='b',desc="Also copy biomes")
 boolean copyBiomes)
              throws WorldEditException

Throws:

WorldEditException

cut

public void cut(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Arg(desc="Pattern to leave in place of the selection",def="air")
 Pattern leavePattern,
 @Switch(name='e',desc="Also cut entities")
 boolean copyEntities,
 @Switch(name='b',desc="Also copy biomes, source biomes are unaffected")
 boolean copyBiomes,
 @ArgFlag(name='m',desc="Set the exclude mask, non-matching blocks become air")
 Mask mask)
         throws WorldEditException

Throws:

WorldEditException

download

@Deprecated(forRemoval=true,
            since="2.11.0")
public void download(Actor actor,
 LocalSession session,
 @Arg(name="format",desc="String",def="fast")
 String formatName)
              throws WorldEditException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

WorldEditException

place

public void place(Actor actor,
 World world,
 LocalSession session,
 EditSession editSession,
 @Switch(name='a',desc="Skip air blocks")
 boolean ignoreAirBlocks,
 @Switch(name='o',desc="Paste at the original position")
 boolean atOrigin,
 @Switch(name='s',desc="Select the region after pasting")
 boolean selectPasted,
 @Switch(name='n',desc="No paste, select only. (Implies -s)")
 boolean onlySelect,
 @Switch(name='e',desc="Paste entities if available")
 boolean pasteEntities,
 @Switch(name='b',desc="Paste biomes if available")
 boolean pasteBiomes,
 @Switch(name='x',desc="Remove existing entities in the affected region")
 boolean removeEntities)
           throws WorldEditException

Throws:

WorldEditException

paste

public void paste(Actor actor,
 World world,
 LocalSession session,
 EditSession editSession,
 @Switch(name='a',desc="Skip air blocks")
 boolean ignoreAirBlocks,
 @Switch(name='o',desc="Paste at the original position")
 boolean atOrigin,
 @Switch(name='s',desc="Select the region after pasting")
 boolean selectPasted,
 @Switch(name='n',desc="No paste, select only. (Implies -s)")
 boolean onlySelect,
 @Switch(name='e',desc="Paste entities if available")
 boolean pasteEntities,
 @Switch(name='b',desc="Paste biomes if available")
 boolean pasteBiomes,
 @ArgFlag(name='m',desc="Only paste blocks matching this mask")
 Mask sourceMask,
 @Switch(name='x',desc="Remove existing entities in the affected region")
 boolean removeEntities)
           throws WorldEditException

Throws:

WorldEditException

rotate

public void rotate(Actor actor,
 LocalSession session,
 @Arg(desc="Amount to rotate on the y-axis")
 double rotateY,
 @Arg(desc="Amount to rotate on the x-axis",def="0")
 double rotateX,
 @Arg(desc="Amount to rotate on the z-axis",def="0")
 double rotateZ)
            throws WorldEditException

Throws:

WorldEditException

flip

public void flip(Actor actor,
 LocalSession session,
 @Arg(desc="The direction to flip, defaults to look direction.",def="me")
 BlockVector3 direction)
          throws WorldEditException

Throws:

WorldEditException

clearClipboard

public void clearClipboard(Actor actor,
 LocalSession session)
                    throws WorldEditException

Throws:

WorldEditException