Class ChanceModifier

java.lang.Object

com.github.darksoulq.abyssallib.world.gen.placement.PlacementModifier

com.github.darksoulq.abyssallib.world.gen.placement.modifier.ChanceModifier

public class ChanceModifier
extends PlacementModifier

A placement modifier that filters positions based on a random probability.

This modifier passes the incoming vector only if a random integer bounded by the configured chance equals zero (e.g., a chance of 10 means a 1-in-10 or 10% probability of placement).

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<ChanceModifier>	CODEC	The codec used for serializing and deserializing the chance modifier.
static final PlacementModifierType<ChanceModifier>	TYPE	The registered type definition for the chance placement modifier.

Constructor Summary

Constructors

Constructor	Description
ChanceModifier(int chance)	Constructs a new ChanceModifier.

Method Summary

Modifier and Type	Method	Description
Stream<org.bukkit.util.Vector>	getPositions(PlacementContext context, Stream<org.bukkit.util.Vector> positions)	Randomly drops incoming vectors based on the configured chance.
PlacementModifierType<?>	getType()	Retrieves the specific type definition for this modifier.

Methods inherited from class Object

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

Field Details

CODEC

public static final Codec<ChanceModifier> CODEC

The codec used for serializing and deserializing the chance modifier.

TYPE

public static final PlacementModifierType<ChanceModifier> TYPE

The registered type definition for the chance placement modifier.

Constructor Details

ChanceModifier

public ChanceModifier(int chance)

Constructs a new ChanceModifier.

Parameters:

chance - The probability fraction denominator (e.g., 5 means 20% chance).

Method Details

getPositions

public Stream<org.bukkit.util.Vector> getPositions(PlacementContext context,
 Stream<org.bukkit.util.Vector> positions)

Randomly drops incoming vectors based on the configured chance.

Specified by:

getPositions in class PlacementModifier

Parameters:

context - The current placement context providing the seeded random instance.

positions - The incoming stream of potential placement vectors.

Returns:

A filtered stream containing only the positions that passed the probability check.

getType

public PlacementModifierType<?> getType()

Retrieves the specific type definition for this modifier.

Specified by:

getType in class PlacementModifier

Returns:

The placement modifier type associated with this chance modifier.