Package com.sk89q.worldedit.command

Class RegionCommands

java.lang.Object

com.sk89q.worldedit.command.RegionCommands

public class RegionCommands
extends Object

Commands that operate on regions.

Constructor Summary

Constructors

Constructor	Description
RegionCommands()	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	air(Actor actor, EditSession editSession, Region region)
int	center(Actor actor, EditSession editSession, Region region, Pattern pattern)
int	curve(Actor actor, EditSession editSession, Region region, Pattern pattern, int thickness, boolean shell)
int	deform(Actor actor, LocalSession session, EditSession editSession, Region region, List<String> expression, boolean useRawCoords, boolean offset, boolean offsetCenter)
int	faces(Actor actor, EditSession editSession, Region region, Pattern pattern)
void	fall(Actor actor, EditSession editSession, Region region, BlockStateHolder replace, boolean notFullHeight)
void	fixLighting(Actor actor, LocalSession session, Region selection)
int	flora(Actor actor, EditSession editSession, Region region, double density)
int	forest(Actor actor, EditSession editSession, Region region, TreeGenerator.TreeType type, double density)
int	hollow(Actor actor, EditSession editSession, Region region, int thickness, Pattern pattern, Mask mask)
void	lay(Actor actor, EditSession editSession, Region region, Pattern patternArg)
int	line(Actor actor, EditSession editSession, Region region, Pattern pattern, int thickness, boolean shell)
int	move(Actor actor, World world, EditSession editSession, LocalSession session, Region region, int count, BlockVector3 direction, Pattern replace, boolean moveSelection, boolean ignoreAirBlocks, boolean copyEntities, boolean copyBiomes, Mask mask)
int	naturalize(Actor actor, EditSession editSession, Region region)
void	nbtinfo(Player player, EditSession editSession)
int	overlay(Actor actor, EditSession editSession, Region region, Pattern pattern)
void	removeLighting(Actor actor, LocalSession session, Region selection)
int	replace(Actor actor, EditSession editSession, Region region, Mask from, Pattern to)
int	set(Actor actor, EditSession editSession, Region region, Pattern pattern)
void	setlighting(Actor actor, EditSession editSession, Region region)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setskylighting(Actor actor, Region region)	Deprecated, for removal: This API element is subject to removal in a future version.
int	smooth(Actor actor, EditSession editSession, Region region, int iterations, Mask mask)
int	snowSmooth(Actor actor, EditSession editSession, Region region, int iterations, int snowBlockCount, Mask mask)
int	stack(Actor actor, World world, EditSession editSession, LocalSession session, Region region, int count, BlockVector3 direction, boolean moveSelection, boolean ignoreAirBlocks, boolean copyEntities, boolean copyBiomes, Mask mask)
void	test(Actor actor, EditSession editSession, double testValue)
int	walls(Actor actor, EditSession editSession, Region region, Pattern pattern)
void	wea(Actor actor)
void	wer(Player player)

Methods inherited from class java.lang.Object

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

Constructor Details

RegionCommands

public RegionCommands()

Create a new instance.

Method Details

set

public int set(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern)

air

public void air(Actor actor,
 EditSession editSession,
 Region region)
         throws WorldEditException

Throws:

WorldEditException

test

public void test(Actor actor,
 EditSession editSession,
 @Arg(desc="test")
 double testValue)
          throws WorldEditException

Throws:

WorldEditException

fixLighting

public void fixLighting(Actor actor,
 LocalSession session,
 Region selection)
                 throws WorldEditException

Throws:

WorldEditException

removeLighting

public void removeLighting(Actor actor,
 LocalSession session,
 Region selection)

nbtinfo

public void nbtinfo(Player player,
 EditSession editSession)

setlighting

@Deprecated(since="2.4.2",
            forRemoval=true)
public void setlighting(Actor actor,
 EditSession editSession,
 Region region)

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

setskylighting

@Deprecated(since="2.4.2",
            forRemoval=true)
public void setskylighting(Actor actor,
 Region region)

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

line

public int line(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The pattern of blocks to place")
 Pattern pattern,
 @Arg(desc="The thickness of the line",def="0")
 int thickness,
 @Switch(name='h',desc="Generate only a shell")
 boolean shell)
         throws WorldEditException

Throws:

WorldEditException

curve

public int curve(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The pattern of blocks to place")
 Pattern pattern,
 @Arg(desc="The thickness of the curve",def="0")
 int thickness,
 @Switch(name='h',desc="Generate only a shell")
 boolean shell)
          throws WorldEditException

Throws:

WorldEditException

replace

public int replace(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The mask representing blocks to replace",def="")
 Mask from,
 @Arg(desc="The pattern of blocks to replace with")
 Pattern to)
            throws WorldEditException

Throws:

WorldEditException

overlay

public int overlay(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The pattern of blocks to overlay")
 Pattern pattern)
            throws WorldEditException

Throws:

WorldEditException

lay

public void lay(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(name="pattern",desc="The pattern of blocks to lay")
 Pattern patternArg)
         throws WorldEditException

Throws:

WorldEditException

center

public int center(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern)
           throws WorldEditException

Throws:

WorldEditException

naturalize

public int naturalize(Actor actor,
 EditSession editSession,
 Region region)
               throws WorldEditException

Throws:

WorldEditException

walls

public int walls(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern)
          throws WorldEditException

Throws:

WorldEditException

faces

public int faces(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern)
          throws WorldEditException

Throws:

WorldEditException

smooth

public int smooth(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="# of iterations to perform",def="1")
 int iterations,
 @Arg(desc="The mask of blocks to use as the height map",def="")
 Mask mask)
           throws WorldEditException

Throws:

WorldEditException

wea

public void wea(Actor actor)
         throws WorldEditException

Throws:

WorldEditException

wer

public void wer(Player player)
         throws WorldEditException

Throws:

WorldEditException

snowSmooth

public int snowSmooth(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="# of iterations to perform",def="1")
 int iterations,
 @ArgFlag(name='l',desc="Set the amount of snow blocks under the snow",def="1")
 int snowBlockCount,
 @ArgFlag(name='m',desc="The mask of blocks to use as the height map")
 Mask mask)
               throws WorldEditException

Throws:

WorldEditException

move

public int move(Actor actor,
 World world,
 EditSession editSession,
 LocalSession session,
 Region region,
 @Arg(desc="# of blocks to move",def="1")
 int count,
 @Arg(desc="The direction to move",def="me")
 BlockVector3 direction,
 @Arg(desc="The pattern of blocks to leave",def="air")
 Pattern replace,
 @Switch(name='s',desc="Shift the selection to the target location")
 boolean moveSelection,
 @Switch(name='a',desc="Ignore air blocks")
 boolean ignoreAirBlocks,
 @Switch(name='e',desc="Also copy entities")
 boolean copyEntities,
 @Switch(name='b',desc="Also copy biomes")
 boolean copyBiomes,
 @ArgFlag(name='m',desc="Set the include mask, non-matching blocks become air")
 Mask mask)
         throws WorldEditException

Throws:

WorldEditException

fall

public void fall(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="BlockStateHolder",def="air")
 BlockStateHolder replace,
 @Switch(name='m',desc="Only fall within the vertical selection")
 boolean notFullHeight)
          throws WorldEditException

Throws:

WorldEditException

stack

public int stack(Actor actor,
 World world,
 EditSession editSession,
 LocalSession session,
 Region region,
 @Arg(desc="# of copies to stack",def="1")
 int count,
 @Arg(desc="How far to move the contents each stack",def="forward")
 BlockVector3 direction,
 @Switch(name='s',desc="Shift the selection to the last stacked copy")
 boolean moveSelection,
 @Switch(name='a',desc="Ignore air blocks")
 boolean ignoreAirBlocks,
 @Switch(name='e',desc="Also copy entities")
 boolean copyEntities,
 @Switch(name='b',desc="Also copy biomes")
 boolean copyBiomes,
 @ArgFlag(name='m',desc="Set the include mask, non-matching blocks become air")
 Mask mask)
          throws WorldEditException

Throws:

WorldEditException

deform

public int deform(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Arg(desc="The expression to use",variable=true)
 List<String> expression,
 @Switch(name='r',desc="Use the game\'s coordinate origin")
 boolean useRawCoords,
 @Switch(name='o',desc="Use the placement\'s coordinate origin")
 boolean offset,
 @Switch(name='c',desc="Use the selection\'s center as origin")
 boolean offsetCenter)
           throws WorldEditException

Throws:

WorldEditException

hollow

public int hollow(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="Thickness of the shell to leave",def="0")
 int thickness,
 @Arg(desc="The pattern of blocks to replace the hollowed area with",def="air")
 Pattern pattern,
 @ArgFlag(name='m',desc="Mask to hollow with")
 Mask mask)
           throws WorldEditException

Throws:

WorldEditException

forest

public int forest(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The type of tree to place",def="tree")
 TreeGenerator.TreeType type,
 @Arg(desc="The density of the forest",def="5")
 double density)
           throws WorldEditException

Throws:

WorldEditException

flora

public int flora(Actor actor,
 EditSession editSession,
 Region region,
 @Arg(desc="The density of the forest",def="5")
 double density)
          throws WorldEditException

Throws:

WorldEditException