Package com.sk89q.worldedit.command

Class BrushCommands

java.lang.Object

com.sk89q.worldedit.command.BrushCommands

public class BrushCommands
extends Object

Commands to set brush shape.

Constructor Summary

Constructors

Constructor	Description
BrushCommands(WorldEdit worldEdit)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	blendBallBrush(InjectedValueAccess context, Expression radius)
void	blobBrush(InjectedValueAccess context, Pattern fill, Vector3 radius, double sphericity, double frequency, double amplitude)
void	butcherBrush(Player player, LocalSession session, Expression radius, boolean killPets, boolean killNpcs, boolean killGolems, boolean killAnimals, boolean killAmbient, boolean killWithName, boolean killFriendly, boolean killArmorStands, boolean killWater, InjectedValueAccess context)
void	catenaryBrush(InjectedValueAccess context, Pattern fill, @org.jetbrains.annotations.Range(from=1L, to=2147483647L) double lengthFactor, Expression radius, boolean shell, boolean select, boolean facingDirection)
void	circleBrush(InjectedValueAccess context, Pattern fill, Expression radius, boolean filled)
void	cliffBrush(Player player, LocalSession session, Expression radius, String image, @org.jetbrains.annotations.Range(from=0L, to=360L) int rotation, double yscale, boolean randomRotate, boolean layers, boolean dontSmooth, InjectedValueAccess context)
void	clipboardBrush(Player player, LocalSession session, boolean ignoreAir, boolean usingOrigin, boolean pasteEntities, boolean pasteBiomes, Mask sourceMask, InjectedValueAccess context)	Deprecated.
void	command(InjectedValueAccess context, Expression radius, List<String> input)
void	copy(Player player, LocalSession session, InjectedValueAccess context, Expression radius, boolean randomRotate, boolean autoRotate)
void	cylinderBrush(InjectedValueAccess context, Pattern pattern, Expression radius, int height, double thickness, boolean hollow)
void	deform(Player player, LocalSession localSession, RegionFactory shape, double radius, String expression, boolean useRawCoords, boolean usePlacement)
void	erodeBrush(InjectedValueAccess context, Expression radius, int erodefaces, int erodeRec, int fillFaces, int fillRec)
void	extinguishBrush(InjectedValueAccess context, EditSession editSession, Expression radius)
void	flattenBrush(Player player, LocalSession session, Expression radius, String image, @org.jetbrains.annotations.Range(from=0L, to=360L) int rotation, double yscale, boolean randomRotate, boolean layers, boolean dontSmooth, InjectedValueAccess context)
void	forest(Player player, LocalSession localSession, RegionFactory shape, Expression radius, double density, TreeGenerator.TreeType type)
void	gravityBrush(InjectedValueAccess context, Expression radius, boolean fromMaxY)
void	heightBrush(Player player, LocalSession session, Expression radius, double yscale, String image, @org.jetbrains.annotations.Range(from=0L, to=360L) int rotation, boolean randomRotate, boolean layers, boolean dontSmooth, InjectedValueAccess context)
void	imageBrush(LocalSession session, InjectedValueAccess context, String imageURL, Expression radius, double yscale, boolean alpha, boolean fadeOut)
void	lineBrush(InjectedValueAccess context, Pattern fill, Expression radius, boolean shell, boolean select, boolean flat)
void	list(Actor actor, InjectedValueAccess args, int page)
void	lower(Player player, LocalSession localSession, RegionFactory shape, Expression radius)
BrushSettings	process(Player player, Arguments arguments, BrushSettings settings)
void	pullBrush(InjectedValueAccess context, Expression radius, int erodefaces, int erodeRec, int fillFaces, int fillRec)
void	raise(Player player, LocalSession localSession, RegionFactory shape, Expression radius)
void	recursiveBrush(InjectedValueAccess context, EditSession editSession, Pattern fill, Expression radius, boolean depthFirst)
void	saveBrush(Player player, LocalSession session, String name, boolean root)
void	scatterBrush(InjectedValueAccess context, Pattern fill, Expression radius, double points, double distance, boolean overlay)
void	scatterCommandBrush(Player player, InjectedValueAccess context, Expression radius, double points, double distance, List<String> commandStr, boolean print)
void	scatterSchemBrush(Player player, InjectedValueAccess context, Mask mask, String clipboardStr, Expression radius, double density, boolean rotate)
void	set(Player player, LocalSession localSession, RegionFactory shape, Expression radius, Pattern pattern)
BrushSettings	set(InjectedValueAccess context, Brush brush, String permission)
void	shatterBrush(EditSession editSession, InjectedValueAccess context, Pattern fill, Expression radius, int count)
void	smoothBrush(Player player, LocalSession session, Expression radius, int iterations, Mask mask, InjectedValueAccess context)
void	snow(Player player, LocalSession localSession, RegionFactory shape, double radius, boolean stack)
void	snowSmoothBrush(Player player, LocalSession session, Expression radius, int iterations, int snowBlockCount, Mask mask, InjectedValueAccess context)
void	sphereBrush(Player player, InjectedValueAccess context, Pattern pattern, Expression radius, boolean hollow, boolean falling)
void	splatterBrush(InjectedValueAccess context, Pattern fill, Expression radius, double points, double recursion, boolean solid)
void	splineBrush(Player player, InjectedValueAccess context, Pattern fill, Expression radius)
void	stencilBrush(Player player, LocalSession session, InjectedValueAccess context, Pattern fill, Expression radius, String image, @org.jetbrains.annotations.Range(from=0L, to=360L) int rotation, double yscale, boolean onlyWhite, boolean randomRotate)
void	surfaceBrush(InjectedValueAccess context, Pattern fill, Expression radius)
void	surfaceLayer(InjectedValueAccess context, Expression radius, List<Pattern> patternLayers)
void	surfaceSpline(Player player, InjectedValueAccess context, Pattern fill, Expression radius, double tension, double bias, double continuity, double quality)
void	sweepBrush(Player player, InjectedValueAccess context, int copies)

Methods inherited from class java.lang.Object

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

Constructor Details

BrushCommands

public BrushCommands(WorldEdit worldEdit)

Create a new instance.

Parameters:

worldEdit - reference to WorldEdit

Method Details

blendBallBrush

public void blendBallBrush(InjectedValueAccess context,
 @Arg(desc="The radius to sample for blending",def="5")
 Expression radius)
                    throws WorldEditException

Throws:

WorldEditException

erodeBrush

public void erodeBrush(InjectedValueAccess context,
 @Arg(desc="The radius for eroding",def="5")
 Expression radius,
 @Arg(desc="erodeFaces",def="2")
 int erodefaces,
 @Arg(desc="erodeRec",def="1")
 int erodeRec,
 @Arg(desc="fillFaces",def="5")
 int fillFaces,
 @Arg(desc="fillRec",def="1")
 int fillRec)
                throws WorldEditException

Throws:

WorldEditException

pullBrush

public void pullBrush(InjectedValueAccess context,
 @Arg(desc="The radius to sample for blending",def="5")
 Expression radius,
 @Arg(desc="erodeFaces",def="6")
 int erodefaces,
 @Arg(desc="erodeRec",def="0")
 int erodeRec,
 @Arg(desc="fillFaces",def="1")
 int fillFaces,
 @Arg(desc="fillRec",def="1")
 int fillRec)
               throws WorldEditException

Throws:

WorldEditException

circleBrush

public void circleBrush(InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="The radius to sample for blending",def="5")
 Expression radius,
 @Arg(name="filled",desc="Whether the circle should be filled",def="false")
 boolean filled)
                 throws WorldEditException

Throws:

WorldEditException

recursiveBrush

public void recursiveBrush(InjectedValueAccess context,
 EditSession editSession,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="The radius to sample for blending",def="5")
 Expression radius,
 @Switch(name='d',desc="Apply in depth first order")
 boolean depthFirst)
                    throws WorldEditException

Throws:

WorldEditException

lineBrush

public void lineBrush(InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="The radius to sample for blending",def="0")
 Expression radius,
 @Switch(name='h',desc="Create only a shell")
 boolean shell,
 @Switch(name='s',desc="Selects the clicked point after drawing")
 boolean select,
 @Switch(name='f',desc="Create a flat line")
 boolean flat)
               throws WorldEditException

Throws:

WorldEditException

splineBrush

public void splineBrush(Player player,
 InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="The radius to sample for blending",def="25")
 Expression radius)
                 throws WorldEditException

Throws:

WorldEditException

sweepBrush

public void sweepBrush(Player player,
 InjectedValueAccess context,
 @Arg(desc="int",def="-1")
 int copies)
                throws WorldEditException

Throws:

WorldEditException

catenaryBrush

public void catenaryBrush(InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(def="1.2",desc="Length of wire compared to distance between points")
 @org.jetbrains.annotations.Range(from=1L, to=2147483647L) double lengthFactor,
 @Arg(desc="The radius to sample for blending",def="0")
 Expression radius,
 @Switch(name='h',desc="Create only a shell")
 boolean shell,
 @Switch(name='s',desc="Select the clicked point after drawing")
 boolean select,
 @Switch(name='d',desc="sags the catenary toward the facing direction")
 boolean facingDirection)
                   throws WorldEditException

Throws:

WorldEditException

surfaceSpline

public void surfaceSpline(Player player,
 InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="The radius to sample for blending",def="0")
 Expression radius,
 @Arg(desc="double",def="0")
 double tension,
 @Arg(desc="double",def="0")
 double bias,
 @Arg(desc="double",def="0")
 double continuity,
 @Arg(desc="double",def="10")
 double quality)
                   throws WorldEditException

Throws:

WorldEditException

blobBrush

public void blobBrush(InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="radii to multiply x,y,z by",def="10")
 Vector3 radius,
 @Arg(name="roundness",desc="roundness",def="100")
 double sphericity,
 @Arg(desc="double",def="30")
 double frequency,
 @Arg(desc="double",def="50")
 double amplitude)
               throws WorldEditException

Throws:

WorldEditException

shatterBrush

public void shatterBrush(EditSession editSession,
 InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="The radius to sample for blending",def="10")
 Expression radius,
 @Arg(desc="Lines",def="10")
 int count)
                  throws WorldEditException

Throws:

WorldEditException

stencilBrush

public void stencilBrush(Player player,
 LocalSession session,
 InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="Expression",def="5")
 Expression radius,
 @Arg(desc="String",def="")
 String image,
 @Arg(def="0",desc="rotation")
 @org.jetbrains.annotations.Range(from=0L, to=360L) int rotation,
 @Arg(desc="double",def="1")
 double yscale,
 @Switch(name='w',desc="Apply at maximum saturation")
 boolean onlyWhite,
 @Switch(name='r',desc="Apply random rotation")
 boolean randomRotate)
                  throws WorldEditException,
FileNotFoundException

Throws:

WorldEditException

FileNotFoundException

imageBrush

public void imageBrush(LocalSession session,
 InjectedValueAccess context,
 @Arg(desc="Image URL (imgur only)")
 String imageURL,
 @Arg(desc="The size of the brush",def="5")
 Expression radius,
 @Arg(def="1",desc="scale height")
 double yscale,
 @Switch(name='a',desc="Use image Alpha")
 boolean alpha,
 @Switch(name='f',desc="Blend the image with existing terrain")
 boolean fadeOut)
                throws WorldEditException,
IOException

Throws:

WorldEditException

IOException

surfaceBrush

public void surfaceBrush(InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="Expression",def="5")
 Expression radius)
                  throws WorldEditException

Throws:

WorldEditException

scatterBrush

public void scatterBrush(InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="radius",def="5")
 Expression radius,
 @Arg(desc="points",def="5")
 double points,
 @Arg(desc="distance",def="1")
 double distance,
 @Switch(name='o',desc="Overlay the block")
 boolean overlay)
                  throws WorldEditException

Throws:

WorldEditException

scatterSchemBrush

public void scatterSchemBrush(Player player,
 InjectedValueAccess context,
 @Arg(desc="Mask")
 Mask mask,
 @Arg(name="clipboard",desc="Clipboard uri")
 String clipboardStr,
 @Arg(desc="Expression",def="30")
 Expression radius,
 @Arg(desc="double",def="50")
 double density,
 @Switch(name='r',desc="Apply random rotation")
 boolean rotate)
                       throws WorldEditException

Throws:

WorldEditException

surfaceLayer

public void surfaceLayer(InjectedValueAccess context,
 @Arg(desc="Expression")
 Expression radius,
 @Arg(desc="List of comma-separated patterns")
 List<Pattern> patternLayers)
                  throws WorldEditException

Throws:

WorldEditException

splatterBrush

public void splatterBrush(InjectedValueAccess context,
 @Arg(desc="Pattern")
 Pattern fill,
 @Arg(desc="Expression",def="5")
 Expression radius,
 @Arg(desc="double",def="1")
 double points,
 @Arg(desc="double",def="5")
 double recursion,
 @Arg(desc="boolean",def="true")
 boolean solid)
                   throws WorldEditException

Throws:

WorldEditException

scatterCommandBrush

public void scatterCommandBrush(Player player,
 InjectedValueAccess context,
 @Arg(desc="The minimum distance between each point")
 Expression radius,
 @Arg(desc="double",def="1")
 double points,
 @Arg(desc="double",def="1")
 double distance,
 @Arg(desc="List of comma-separated commands")
 List<String> commandStr,
 @Switch(name='p',desc="Show any printed output")
 boolean print)
                         throws WorldEditException

Throws:

WorldEditException

heightBrush

public void heightBrush(Player player,
 LocalSession session,
 @Arg(desc="Expression",def="5")
 Expression radius,
 @Arg(desc="double",def="1")
 double yscale,
 @Arg(desc="String",def="")
 String image,
 @Arg(def="0",desc="rotation")
 @org.jetbrains.annotations.Range(from=0L, to=360L) int rotation,
 @Switch(name='r',desc="Random off-axis rotation")
 boolean randomRotate,
 @Switch(name='l',desc="Work on snow layers")
 boolean layers,
 @Switch(name='s',desc="Disable smoothing")
 boolean dontSmooth,
 InjectedValueAccess context)
                 throws WorldEditException,
FileNotFoundException

Throws:

WorldEditException

FileNotFoundException

cliffBrush

public void cliffBrush(Player player,
 LocalSession session,
 @Arg(desc="Expression",def="5")
 Expression radius,
 @Arg(desc="String",def="")
 String image,
 @Arg(def="0",desc="rotation")
 @org.jetbrains.annotations.Range(from=0L, to=360L) int rotation,
 @Arg(desc="double",def="1")
 double yscale,
 @Switch(name='r',desc="Enables random off-axis rotation")
 boolean randomRotate,
 @Switch(name='l',desc="Will work on snow layers")
 boolean layers,
 @Switch(name='s',desc="Disables smoothing")
 boolean dontSmooth,
 InjectedValueAccess context)
                throws WorldEditException,
FileNotFoundException

Throws:

WorldEditException

FileNotFoundException

flattenBrush

public void flattenBrush(Player player,
 LocalSession session,
 @Arg(desc="Expression",def="5")
 Expression radius,
 @Arg(desc="String",def="")
 String image,
 @Arg(def="0",desc="rotation")
 @org.jetbrains.annotations.Range(from=0L, to=360L) int rotation,
 @Arg(desc="double",def="1")
 double yscale,
 @Switch(name='r',desc="Enables random off-axis rotation")
 boolean randomRotate,
 @Switch(name='l',desc="Will work on snow layers")
 boolean layers,
 @Switch(name='s',desc="Disables smoothing")
 boolean dontSmooth,
 InjectedValueAccess context)
                  throws WorldEditException,
FileNotFoundException

Throws:

WorldEditException

FileNotFoundException

copy

public void copy(Player player,
 LocalSession session,
 InjectedValueAccess context,
 @Arg(desc="Expression",def="5")
 Expression radius,
 @Switch(name='r',desc="Apply random rotation on paste")
 boolean randomRotate,
 @Switch(name='a',desc="Apply auto view based rotation on paste")
 boolean autoRotate)
          throws WorldEditException

Throws:

WorldEditException

command

public void command(InjectedValueAccess context,
 @Arg(desc="Expression")
 Expression radius,
 @Arg(desc="Command to run")
 List<String> input)
             throws WorldEditException

Throws:

WorldEditException

saveBrush

public void saveBrush(Player player,
 LocalSession session,
 @Arg(desc="String name")
 String name,
 @Switch(name='g',desc="Save the brush globally")
 boolean root)
               throws WorldEditException,
IOException

Throws:

WorldEditException

IOException

list

public void list(Actor actor,
 InjectedValueAccess args,
 @ArgFlag(name='p',desc="Prints the requested page",def="0")
 int page)
          throws WorldEditException

Throws:

WorldEditException

deform

public void deform(Player player,
 LocalSession localSession,
 @Arg(desc="The shape of the region")
 RegionFactory shape,
 @Arg(desc="The size of the brush",def="5")
 double radius,
 @Arg(desc="Expression to apply",def="y-=0.2")
 String expression,
 @Switch(name='r',desc="Use the game\'s coordinate origin")
 boolean useRawCoords,
 @Switch(name='o',desc="Use the placement position as the origin")
 boolean usePlacement)
            throws WorldEditException

Throws:

WorldEditException

set

public void set(Player player,
 LocalSession localSession,
 @Arg(desc="The shape of the region")
 RegionFactory shape,
 @Arg(desc="The size of the brush",def="5")
 Expression radius,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern)
         throws WorldEditException

Throws:

WorldEditException

forest

public void forest(Player player,
 LocalSession localSession,
 @Arg(desc="The shape of the region")
 RegionFactory shape,
 @Arg(desc="The size of the brush",def="5")
 Expression radius,
 @Arg(desc="The density of the brush",def="20")
 double density,
 @Arg(desc="The type of tree to use")
 TreeGenerator.TreeType type)
            throws WorldEditException

Throws:

WorldEditException

raise

public void raise(Player player,
 LocalSession localSession,
 @Arg(desc="The shape of the region")
 RegionFactory shape,
 @Arg(desc="The size of the brush",def="5")
 Expression radius)
           throws WorldEditException

Throws:

WorldEditException

lower

public void lower(Player player,
 LocalSession localSession,
 @Arg(desc="The shape of the region")
 RegionFactory shape,
 @Arg(desc="The size of the brush",def="5")
 Expression radius)
           throws WorldEditException

Throws:

WorldEditException

snow

public void snow(Player player,
 LocalSession localSession,
 @Arg(desc="The shape of the region")
 RegionFactory shape,
 @Arg(desc="The size of the brush",def="5")
 double radius,
 @Switch(name='s',desc="Whether to stack snow")
 boolean stack)
          throws WorldEditException

Throws:

WorldEditException

sphereBrush

public void sphereBrush(Player player,
 InjectedValueAccess context,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern,
 @Arg(desc="The radius of the sphere",def="2")
 Expression radius,
 @Switch(name='h',desc="Create hollow spheres instead")
 boolean hollow,
 @Switch(name='f',desc="Create falling spheres instead")
 boolean falling)
                 throws WorldEditException

Throws:

WorldEditException

cylinderBrush

public void cylinderBrush(InjectedValueAccess context,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern,
 @Arg(desc="The radius of the cylinder",def="2")
 Expression radius,
 @Arg(desc="The height of the cylinder",def="1")
 int height,
 @Arg(desc="The thickness of the cylinder. Requires -h switch be given. 0 creates a standard hollow cylinder.",def="0")
 double thickness,
 @Switch(name='h',desc="Create hollow cylinders instead")
 boolean hollow)
                   throws WorldEditException

Throws:

WorldEditException

clipboardBrush

@Deprecated
public void clipboardBrush(Player player,
 LocalSession session,
 @Switch(name='a',desc="Don\'t paste air from the clipboard")
 boolean ignoreAir,
 @Switch(name='o',desc="Paste starting at the target location, instead of centering on it")
 boolean usingOrigin,
 @Switch(name='e',desc="Paste entities if available")
 boolean pasteEntities,
 @Switch(name='b',desc="Paste biomes if available")
 boolean pasteBiomes,
 @ArgFlag(name='m',desc="Skip blocks matching this mask in the clipboard")
 Mask sourceMask,
 InjectedValueAccess context)
                    throws WorldEditException

Deprecated.

Throws:

WorldEditException

smoothBrush

public void smoothBrush(Player player,
 LocalSession session,
 @Arg(desc="The radius to sample for softening",def="2")
 Expression radius,
 @Arg(desc="The number of iterations to perform",def="4")
 int iterations,
 @Arg(desc="The mask of blocks to use for the heightmap",def="")
 Mask mask,
 InjectedValueAccess context)
                 throws WorldEditException

Throws:

WorldEditException

snowSmoothBrush

public void snowSmoothBrush(Player player,
 LocalSession session,
 @Arg(desc="The radius to sample for softening",def="2")
 Expression radius,
 @Arg(desc="The number of iterations to perform",def="1")
 int iterations,
 @ArgFlag(name='l',desc="The number of snow blocks under snow",def="1")
 int snowBlockCount,
 @ArgFlag(name='m',desc="The mask of blocks to use for the heightmap")
 Mask mask,
 InjectedValueAccess context)
                     throws WorldEditException

Throws:

WorldEditException

extinguishBrush

public void extinguishBrush(InjectedValueAccess context,
 EditSession editSession,
 @Arg(desc="The radius to extinguish",def="5")
 Expression radius)
                     throws WorldEditException

Throws:

WorldEditException

gravityBrush

public void gravityBrush(InjectedValueAccess context,
 @Arg(desc="The radius to apply gravity in",def="5")
 Expression radius,
 @Switch(name='h',desc="Affect blocks starting at max Y, rather than the target location Y + radius")
 boolean fromMaxY)
                  throws WorldEditException

Throws:

WorldEditException

butcherBrush

public void butcherBrush(Player player,
 LocalSession session,
 @Arg(desc="Radius to kill mobs in",def="5")
 Expression radius,
 @Switch(name='p',desc="Also kill pets")
 boolean killPets,
 @Switch(name='n',desc="Also kill NPCs")
 boolean killNpcs,
 @Switch(name='g',desc="Also kill golems")
 boolean killGolems,
 @Switch(name='a',desc="Also kill animals")
 boolean killAnimals,
 @Switch(name='b',desc="Also kill ambient mobs")
 boolean killAmbient,
 @Switch(name='t',desc="Also kill mobs with name tags")
 boolean killWithName,
 @Switch(name='f',desc="Also kill all friendly mobs (Applies the flags `-abgnpt`)")
 boolean killFriendly,
 @Switch(name='r',desc="Also destroy armor stands")
 boolean killArmorStands,
 @Switch(name='w',desc="Also kill water mobs")
 boolean killWater,
 InjectedValueAccess context)
                  throws WorldEditException

Throws:

WorldEditException

process

public BrushSettings process(Player player,
 Arguments arguments,
 BrushSettings settings)
                      throws WorldEditException

Throws:

WorldEditException

set

public BrushSettings set(InjectedValueAccess context,
 Brush brush,
 String permission)
                  throws InvalidToolBindException

Throws:

InvalidToolBindException