org.spongepowered.api.world.gen

Interface PopulatorObject

All Superinterfaces:

CatalogType

@CatalogedBy(value=PopulatorObjects.class)
public interface PopulatorObject
extends CatalogType

Represents an object placed in the world during terrain population. Populator objects typically fit in a single chunk.

Method Summary

Modifier and Type	Method and Description
boolean	canPlaceAt(World world, int x, int y, int z) Returns whether this object can be placed into the world at the given position.
void	placeObject(World world, Random random, int x, int y, int z) Places the object into the world at the given location.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

canPlaceAt

boolean canPlaceAt(World world,
                   int x,
                   int y,
                   int z)

Returns whether this object can be placed into the world at the given position.

Parameters:

world - The world

x - The X position

y - The Y position

z - The Z position

Returns:

Whether the placement is valid

placeObject

void placeObject(World world,
                 Random random,
                 int x,
                 int y,
                 int z)

Places the object into the world at the given location.

Parameters:

world - The world

random - Random number generator based on the world seed and position.

x - The X position

y - The Y position

z - The Z position