Package com.sk89q.worldedit.command

Class GenerationCommands

java.lang.Object

com.sk89q.worldedit.command.GenerationCommands

public class GenerationCommands
extends Object

Commands for the generation of shapes and other objects.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	blobBrush(Actor actor, LocalSession session, EditSession editSession, Pattern pattern, double size, Vector3 radius, double sphericity, double frequency, double amplitude)
void	caves(Actor actor, LocalSession session, EditSession editSession, Region region, int sizeOpt, int frequencyOpt, int rarityOpt, int minYOpt, int maxYOpt, int systemFrequencyOpt, int individualRarityOpt, int pocketChanceOpt, int pocketMinOpt, int pocketMaxOpt)
int	cyl(Actor actor, LocalSession session, EditSession editSession, Pattern pattern, List<Double> radii, int height, boolean hollow)
int	forestGen(Actor actor, LocalSession session, EditSession editSession, int size, TreeGenerator.TreeType type, double density)
int	generate(Actor actor, LocalSession session, EditSession editSession, Region region, Pattern pattern, List<String> expression, boolean hollow, boolean useRawCoords, boolean offset, boolean offsetCenter)
int	generateBiome(Actor actor, LocalSession session, EditSession editSession, Region region, BiomeType target, List<String> expression, boolean hollow, boolean useRawCoords, boolean offset, boolean offsetCenter)
int	hcyl(Actor actor, LocalSession session, EditSession editSession, Pattern pattern, List<Double> radii, int height, double thickness)
int	hollowPyramid(Actor actor, LocalSession session, EditSession editSession, Pattern pattern, int size)
int	hsphere(Actor actor, LocalSession session, EditSession editSession, Pattern pattern, List<Double> radii, boolean raised)
void	image(Actor actor, LocalSession session, EditSession editSession, String imageURL, boolean randomize, int threshold, BlockVector2 dimensions)
void	ore(Actor actor, LocalSession session, EditSession editSession, Region region, Mask mask, Pattern material, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int size, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int freq, @org.jetbrains.annotations.Range(from=0L, to=100L) int rarity, int minY, int maxY)
void	ores(Actor actor, LocalSession session, EditSession editSession, Region region, Mask mask)
int	pumpkins(Actor actor, LocalSession session, EditSession editSession, int size, double density)
int	pyramid(Actor actor, LocalSession session, EditSession editSession, Pattern pattern, int size, boolean hollow)
int	sphere(Actor actor, LocalSession session, EditSession editSession, Pattern pattern, List<Double> radii, boolean raised, boolean hollow)

Methods inherited from class java.lang.Object

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

Constructor Details

GenerationCommands

public GenerationCommands(WorldEdit worldEdit)

Create a new instance.

Parameters:

worldEdit - reference to WorldEdit

Method Details

hcyl

public int hcyl(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="The pattern of blocks to generate")
 Pattern pattern,
 @Arg(desc="The radii of the cylinder. 1st is N/S, 2nd is E/W")
 List<Double> radii,
 @Arg(desc="The height of the cylinder",def="1")
 int height,
 @Arg(desc="Thickness of the cyclinder. 0 creates a normal //hcyl.",def="0")
 double thickness)
         throws WorldEditException

Throws:

WorldEditException

cyl

public int cyl(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="The pattern of blocks to generate")
 Pattern pattern,
 @Arg(desc="The radii of the cylinder. 1st is N/S, 2nd is E/W")
 List<Double> radii,
 @Arg(desc="The height of the cylinder",def="1")
 int height,
 @Switch(name='h',desc="Make a hollow cylinder")
 boolean hollow)
        throws WorldEditException

Throws:

WorldEditException

hsphere

public int hsphere(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="The pattern of blocks to generate")
 Pattern pattern,
 @Arg(desc="The radii of the sphere. Order is N/S, U/D, E/W")
 List<Double> radii,
 @Switch(name='r',desc="Raise the bottom of the sphere to the placement position")
 boolean raised)
            throws WorldEditException

Throws:

WorldEditException

sphere

public int sphere(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="The pattern of blocks to generate")
 Pattern pattern,
 @Arg(desc="The radii of the sphere. Order is N/S, U/D, E/W")
 List<Double> radii,
 @Switch(name='r',desc="Raise the bottom of the sphere to the placement position")
 boolean raised,
 @Switch(name='h',desc="Make a hollow sphere")
 boolean hollow)
           throws WorldEditException

Throws:

WorldEditException

forestGen

public int forestGen(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="The size of the forest, in blocks",def="10")
 int size,
 @Arg(desc="The type of forest",def="tree")
 TreeGenerator.TreeType type,
 @Arg(desc="The density of the forest, between 0 and 100",def="5")
 double density)
              throws WorldEditException

Throws:

WorldEditException

pumpkins

public int pumpkins(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="The size of the patch",def="10")
 int size,
 @Arg(desc="//TODO ",def="0.02")
 double density)
             throws WorldEditException

Throws:

WorldEditException

hollowPyramid

public int hollowPyramid(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern,
 @Arg(desc="The size of the pyramid")
 int size)
                  throws WorldEditException

Throws:

WorldEditException

pyramid

public int pyramid(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern,
 @Arg(desc="The size of the pyramid")
 int size,
 @Switch(name='h',desc="Make a hollow pyramid")
 boolean hollow)
            throws WorldEditException

Throws:

WorldEditException

generate

public int generate(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Arg(desc="The pattern of blocks to set")
 Pattern pattern,
 @Arg(desc="Expression to test block placement locations and set block type",variable=true)
 List<String> expression,
 @Switch(name='h',desc="Generate a hollow shape")
 boolean hollow,
 @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

generateBiome

public int generateBiome(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Arg(desc="The biome type to set")
 BiomeType target,
 @Arg(desc="Expression to test block placement locations and set biome type. Requires x,y,z variables be present",variable=true)
 List<String> expression,
 @Switch(name='h',desc="Generate a hollow shape")
 boolean hollow,
 @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

caves

public void caves(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Arg(name="size",desc="TODO",def="8")
 int sizeOpt,
 @Arg(name="frequency",desc="TODO",def="40")
 int frequencyOpt,
 @Arg(name="rarity",desc="TODO",def="7")
 int rarityOpt,
 @Arg(name="minY",desc="TODO",def="8")
 int minYOpt,
 @Arg(name="maxY",desc="TODO",def="127")
 int maxYOpt,
 @Arg(name="systemFrequency",desc="TODO",def="1")
 int systemFrequencyOpt,
 @Arg(name="individualRarity",desc="TODO",def="25")
 int individualRarityOpt,
 @Arg(name="pocketChance",desc="TODO",def="0")
 int pocketChanceOpt,
 @Arg(name="pocketMin",desc="TODO",def="0")
 int pocketMinOpt,
 @Arg(name="pocketMax",desc="TODO",def="3")
 int pocketMaxOpt)
           throws WorldEditException

Throws:

WorldEditException

ores

public void ores(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Arg(desc="Mask")
 Mask mask)
          throws WorldEditException

Throws:

WorldEditException

image

public void image(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="Image URL (imgur only)")
 String imageURL,
 @Arg(desc="boolean",def="true")
 boolean randomize,
 @Arg(desc="TODO",def="100")
 int threshold,
 @Arg(desc="BlockVector2",def="")
 BlockVector2 dimensions)
           throws WorldEditException,
IOException

Throws:

WorldEditException

IOException

ore

public void ore(Actor actor,
 LocalSession session,
 EditSession editSession,
 Region region,
 @Arg(desc="Mask")
 Mask mask,
 @Arg(desc="Pattern")
 Pattern material,
 @Arg(desc="Ore vein size")
 @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int size,
 @Arg(desc="Ore vein frequency (number of times to attempt to place ore)",def="10")
 @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int freq,
 @Arg(desc="Ore vein rarity (% chance each attempt is placed)",def="100")
 @org.jetbrains.annotations.Range(from=0L, to=100L) int rarity,
 @Arg(desc="Ore vein min y",def="0")
 int minY,
 @Arg(desc="Ore vein max y",def="63")
 int maxY)
         throws WorldEditException

Throws:

WorldEditException

blobBrush

public int blobBrush(Actor actor,
 LocalSession session,
 EditSession editSession,
 @Arg(desc="Pattern")
 Pattern pattern,
 @Arg(desc="size",def="5")
 double size,
 @Arg(desc="radius",def="5")
 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