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 Details

    • BrushCommands

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

  • Method Details

    • 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='h',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='h',desc="Create hollow cylinders instead") boolean hollow) throws WorldEditException
      Throws:
      WorldEditException

    • splatterBrush

      public void splatterBrush(Player player, LocalSession session, @Arg(desc="The pattern of blocks to set") Pattern pattern, @Arg(desc="The radius of the splatter",def="2") double radius, @Arg(desc="The decay of the splatter between 0 and 10",def="1") int decay) throws WorldEditException
      Throws:
      WorldEditException

    • clipboardBrush

      public void clipboardBrush(Player player, LocalSession session, @Switch(name='a',desc="Don\'t paste air from the clipboard") boolean ignoreAir, @Switch(name='v',desc="Include structure void blocks") boolean pasteStructureVoid, @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) 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

    • snowSmoothBrush

      public void snowSmoothBrush(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, @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) 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='h',desc="Affect blocks between the given height, upwards and downwards, rather than the target location Y + radius",def="default-vertical-height") 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='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) 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") 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

    • feature

      public void feature(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="5") double density, @Arg(desc="The type of feature to use") ConfiguredFeatureType 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='s',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, @Switch(name='c',desc="Whether to set the full column") boolean column) throws WorldEditException
      Throws:
      WorldEditException

    • morph

      public void morph(Player player, LocalSession session, @Arg(desc="The size of the brush",def="5") double brushSize, @Arg(desc="Minimum number of faces for erosion",def="3") int minErodeFaces, @Arg(desc="Erode iterations",def="1") int numErodeIterations, @Arg(desc="Minimum number of faces for dilation",def="3") int minDilateFaces, @Arg(desc="Dilate iterations",def="1") int numDilateIterations) throws WorldEditException
      Throws:
      WorldEditException

    • erode

      public void erode(Player player, LocalSession session, @Arg(desc="The size of the brush",def="5") double brushSize) throws WorldEditException
      Throws:
      WorldEditException

    • dilate

      public void dilate(Player player, LocalSession session, @Arg(desc="The size of the brush",def="5") double brushSize) throws WorldEditException
      Throws:
      WorldEditException