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

Interface Feature

All Superinterfaces:

DataPackSerializable, DefaultedRegistryValue

@CatalogedBy(Features.class)
public interface Feature
extends DefaultedRegistryValue, DataPackSerializable

Features include smaller objects placed in the world like trees, flowers, ore etc.

Features are used in world generation as a part of placed features

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Feature.Builder	A builder to create Features.

Method Summary

Modifier and Type	Method	Description
static Feature.Builder	builder()	Creates a new Feature.Builder to create a 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
DataView	toContainer()	Returns the serialized feature configuration.
FeatureType	type()	Returns the feature type.

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 Feature.Builder builder()

Creates a new Feature.Builder to create a Feature.

Returns:

The new builder

type

FeatureType type()

Returns the feature type.

Returns:

The feature type

toContainer

DataView toContainer()

Returns the serialized feature configuration.

Reconfigure a feature using FeatureType.configure(DataView)

Returns:

The serialized feature configuration

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