BrushCommands (worldedit-core 7.2.0 API)

java.lang.Object
- com.sk89q.worldedit.command.BrushCommands

public class BrushCommands
extends java.lang.Object

Commands to set brush shape.

Constructor Summary

Constructors
Constructor and Description

BrushCommands(WorldEdit worldEdit)
Create a new instance.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`biome(Player player, LocalSession localSession, RegionFactory shape, double radius, BiomeType biomeType)`
`void`	`butcherBrush(Player player, LocalSession session, double radius, boolean killPets, boolean killNpcs, boolean killGolems, boolean killAnimals, boolean killAmbient, boolean killWithName, boolean killFriendly, boolean killArmorStands, boolean killWater)`
`void`	`clipboardBrush(Player player, LocalSession session, boolean ignoreAir, boolean usingOrigin, boolean pasteEntities, boolean pasteBiomes, Mask sourceMask)`
`void`	`cylinderBrush(Player player, LocalSession session, Pattern pattern, double radius, int height, boolean hollow)`
`void`	`deform(Player player, LocalSession localSession, RegionFactory shape, double radius, java.lang.String expression, boolean useRawCoords, boolean usePlacement)`
`void`	`extinguishBrush(Player player, LocalSession session, double radius)`
`void`	`forest(Player player, LocalSession localSession, RegionFactory shape, double radius, double density, TreeGenerator.TreeType type)`
`void`	`gravityBrush(Player player, LocalSession session, double radius, java.lang.Integer height)`
`void`	`lower(Player player, LocalSession localSession, RegionFactory shape, double radius)`
`void`	`raise(Player player, LocalSession localSession, RegionFactory shape, double radius)`
`void`	`set(Player player, LocalSession localSession, RegionFactory shape, double radius, Pattern pattern)`
`void`	`smoothBrush(Player player, LocalSession session, double radius, int iterations, Mask mask)`
`void`	`snow(Player player, LocalSession localSession, RegionFactory shape, double radius, boolean stack)`
`void`	`sphereBrush(Player player, LocalSession session, Pattern pattern, double radius, boolean hollow)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- BrushCommands
```
public BrushCommands(WorldEdit worldEdit)
```
  Create a new instance.
  
  Parameters:
  
  worldEdit - reference to WorldEdit

Method Detail

sphereBrush

public void sphereBrush(Player player,
                        LocalSession session,
                        @Arg(desc="The pattern of blocks to set")
                        Pattern pattern,
                        @Arg(desc="The radius of the sphere",def="2")
                        double radius,
                        @Switch(name=104,desc="Create hollow spheres instead")
                        boolean hollow)
                 throws WorldEditException

Throws:: WorldEditException

cylinderBrush

public void cylinderBrush(Player player,
                          LocalSession session,
                          @Arg(desc="The pattern of blocks to set")
                          Pattern pattern,
                          @Arg(desc="The radius of the cylinder",def="2")
                          double radius,
                          @Arg(desc="The height of the cylinder",def="1")
                          int height,
                          @Switch(name=104,desc="Create hollow cylinders instead")
                          boolean hollow)
                   throws WorldEditException

Throws:: WorldEditException

clipboardBrush

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

Throws:: WorldEditException

smoothBrush

public void smoothBrush(Player player,
                        LocalSession session,
                        @Arg(desc="The radius to sample for softening",def="2")
                        double 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)
                 throws WorldEditException

Throws:: WorldEditException

extinguishBrush

public void extinguishBrush(Player player,
                            LocalSession session,
                            @Arg(desc="The radius to extinguish",def="5")
                            double radius)
                     throws WorldEditException

Throws:: WorldEditException

gravityBrush

public void gravityBrush(Player player,
                         LocalSession session,
                         @Arg(desc="The radius to apply gravity in",def="5")
                         double radius,
                         @ArgFlag(name=104,desc="Affect blocks between the given height, upwards and downwards, rather than the target location Y + radius",def="default-vertical-height")
                         java.lang.Integer height)
                  throws WorldEditException

Throws:: WorldEditException

butcherBrush

public void butcherBrush(Player player,
                         LocalSession session,
                         @Arg(desc="Radius to kill mobs in",def="5")
                         double radius,
                         @Switch(name=112,desc="Also kill pets")
                         boolean killPets,
                         @Switch(name=110,desc="Also kill NPCs")
                         boolean killNpcs,
                         @Switch(name=103,desc="Also kill golems")
                         boolean killGolems,
                         @Switch(name=97,desc="Also kill animals")
                         boolean killAnimals,
                         @Switch(name=98,desc="Also kill ambient mobs")
                         boolean killAmbient,
                         @Switch(name=116,desc="Also kill mobs with name tags")
                         boolean killWithName,
                         @Switch(name=102,desc="Also kill all friendly mobs (Applies the flags `-abgnpt`)")
                         boolean killFriendly,
                         @Switch(name=114,desc="Also destroy armor stands")
                         boolean killArmorStands,
                         @Switch(name=119,desc="Also kill water mobs")
                         boolean killWater)
                  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")
                   java.lang.String expression,
                   @Switch(name=114,desc="Use the game\'s coordinate origin")
                   boolean useRawCoords,
                   @Switch(name=111,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")
                double 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")
                   double 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")
                  double 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")
                  double 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=115,desc="Whether to stack snow")
                 boolean stack)
          throws WorldEditException

Throws:: WorldEditException

biome

public void biome(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="The biome type")
                  BiomeType biomeType)
           throws WorldEditException

Throws:: WorldEditException

Class BrushCommands

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BrushCommands

Method Detail

sphereBrush

cylinderBrush

clipboardBrush

smoothBrush

extinguishBrush

gravityBrush

butcherBrush

deform

set

forest

raise

lower

snow

biome