Class OreFeature

java.lang.Object

com.github.darksoulq.abyssallib.world.gen.feature.Feature<OreFeature.Config>

com.github.darksoulq.abyssallib.world.gen.feature.impl.OreFeature

public class OreFeature
extends Feature<OreFeature.Config>

A world generation feature that generates clusters of ore veins.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OreFeature.Config	Configuration record for the ore feature.
static final record	OreFeature.Target	A record representing a specific replacement rule for the ore feature.

Constructor Summary

Constructors

Constructor	Description
OreFeature()	Constructs a new OreFeature with the associated configuration codec.

Method Summary

Modifier and Type	Method	Description
GenerationPhase	getPhase(OreFeature.Config config)	Specifies the procedural generation phase in which this feature executes.
boolean	place(FeaturePlaceContext<OreFeature.Config> context)	Executes the placement logic for the ore cluster.

Methods inherited from class Feature

getCodec

Methods inherited from class Object

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

Constructor Details

OreFeature

public OreFeature()

Constructs a new OreFeature with the associated configuration codec.

Method Details

place

public boolean place(FeaturePlaceContext<OreFeature.Config> context)

Executes the placement logic for the ore cluster.

Specified by:

place in class Feature<OreFeature.Config>

Parameters:

context - The feature place context providing world access, origin, random source, and configuration.

Returns:

True if the feature was successfully triggered.

getPhase

public GenerationPhase getPhase(OreFeature.Config config)

Specifies the procedural generation phase in which this feature executes.

Overrides:

getPhase in class Feature<OreFeature.Config>

Returns:

The UNDERGROUND_ORES generation phase.