Package org.spongepowered.api.world.generation.feature

Interface PlacedFeature

All Superinterfaces:

DataPackSerializable, DefaultedRegistryValue<PlacedFeature>

@CatalogedBy(PlacedFeatures.class)
public interface PlacedFeature
extends DefaultedRegistryValue<PlacedFeature>, DataPackSerializable

Placed Features are a combination of a Feature with a list of placement modifiers.

Modifiers can impact position, rarity, count and more.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PlacedFeature.Builder	A builder to create PlacedFeatures.

Method Summary

Modifier and Type	Method	Description
static PlacedFeature.Builder	builder()	Creates a new PlacedFeature.Builder to create a PlacedFeature.
<F extends FeatureType> Feature	feature()	Returns the feature.
boolean	place(ServerLocation location)	Places the feature at given location
boolean	place(ServerWorld world, Vector3i pos)	Places the feature at given position and world
List<PlacementModifier>	placementModifiers()	Returns the list of placement modifiers

Methods inherited from interface org.spongepowered.api.datapack.DataPackSerializable

toDataPack

Methods inherited from interface org.spongepowered.api.registry.DefaultedRegistryValue

asDefaultedReference, findKey, key

Method Details

builder

static PlacedFeature.Builder builder()

Creates a new PlacedFeature.Builder to create a PlacedFeature.

Returns:

The new builder

feature

<F extends FeatureType> Feature feature()

Returns the feature.

Type Parameters:

F - The feature type

Returns:

The feature configuration

placementModifiers

List<PlacementModifier> placementModifiers()

Returns the list of placement modifiers

Returns:

The list of placement modifiers

place

boolean place(ServerWorld world,
 Vector3i pos)

Places the feature at given position and world

Parameters:

world - The world

pos - The position

Returns:

true when the feature was successfully placed

place

boolean place(ServerLocation location)

Places the feature at given location

Parameters:

location - The location

Returns:

true when the feature was successfully placed