Class UtilityCommands

java.lang.Object
com.sk89q.worldedit.command.UtilityCommands

public class UtilityCommands extends Object
Utility commands.
  • Constructor Details

    • UtilityCommands

      public UtilityCommands(WorldEdit we)
  • Method Details

    • fill

      public int fill(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The blocks to fill with") Pattern pattern, @Arg(desc="The radius to fill in") double radius, @Arg(desc="The depth to fill",def="1") int depth) throws WorldEditException
      Throws:
      WorldEditException
    • fillr

      public int fillr(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The blocks to fill with") Pattern pattern, @Arg(desc="The radius to fill in") double radius, @Arg(desc="The depth to fill",def="") Integer depth) throws WorldEditException
      Throws:
      WorldEditException
    • drain

      public int drain(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The radius to drain") double radius, @Switch(name='w',desc="Also un-waterlog blocks") boolean waterlogged) throws WorldEditException
      Throws:
      WorldEditException
    • fixLava

      public int fixLava(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The radius to fix in") double radius) throws WorldEditException
      Throws:
      WorldEditException
    • fixWater

      public int fixWater(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The radius to fix in") double radius) throws WorldEditException
      Throws:
      WorldEditException
    • removeAbove

      public int removeAbove(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The apothem of the square to remove from",def="1") int size, @Arg(desc="The maximum height above you to remove from",def="default-vertical-height") int height) throws WorldEditException
      Throws:
      WorldEditException
    • removeBelow

      public int removeBelow(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The apothem of the square to remove from",def="1") int size, @Arg(desc="The maximum height below you to remove from",def="default-vertical-height") int height) throws WorldEditException
      Throws:
      WorldEditException
    • removeNear

      public int removeNear(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The mask of blocks to remove") Mask mask, @Arg(desc="The radius of the square to remove from",def="50") int radius) throws WorldEditException
      Throws:
      WorldEditException
    • replaceNear

      public int replaceNear(Actor actor, World world, LocalSession session, EditSession editSession, @Arg(desc="The radius of the square to remove in") int radius, @Arg(desc="The mask matching blocks to remove",def="") Mask from, @Arg(desc="The pattern of blocks to replace with") Pattern to) throws WorldEditException
      Throws:
      WorldEditException
    • snow

      public int snow(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The radius of the cylinder to snow in",def="10") double size, @Arg(desc="The height of the cylinder to snow in",def="default-vertical-height") int height, @Switch(name='s',desc="Stack snow layers") boolean stack) throws WorldEditException
      Throws:
      WorldEditException
    • thaw

      public int thaw(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The radius of the cylinder to thaw in",def="10") double size, @Arg(desc="The height of the cylinder to thaw in",def="default-vertical-height") int height) throws WorldEditException
      Throws:
      WorldEditException
    • green

      public int green(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The radius of the cylinder to convert in",def="10") double size, @Arg(desc="The height of the cylinder to convert in",def="default-vertical-height") int height, @Switch(name='f',desc="Also convert coarse dirt") boolean convertCoarse) throws WorldEditException
      Throws:
      WorldEditException
    • extinguish

      public int extinguish(Actor actor, LocalSession session, EditSession editSession, @Arg(desc="The radius of the square to remove in",def="") Integer radius) throws WorldEditException
      Throws:
      WorldEditException
    • butcher

      public int butcher(Actor actor, @Arg(desc="Radius to kill mobs in",def="") Integer 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
    • remove

      public int remove(Actor actor, @Arg(desc="The type of entity to remove") EntityRemover remover, @Arg(desc="The radius of the cuboid to remove from") int radius) throws WorldEditException
      Throws:
      WorldEditException
    • calc

      public void calc(Actor actor, @Arg(desc="Expression to evaluate",variable=true) List<String> input)
    • help

      public void help(Actor actor, @Switch(name='s',desc="List sub-commands of the given command, if applicable") boolean listSubCommands, @ArgFlag(name='p',desc="The page to retrieve",def="1") int page, @Arg(desc="The command to retrieve help for",def="",variable=true) List<String> command) throws WorldEditException
      Throws:
      WorldEditException