api/org.kryptonmc.api.world.biome

Package-level declarations

Types

AmbientAdditionsSettings

interface AmbientAdditionsSettings

Settings for ambient sounds that may play randomly when in the biome, with a fixed chance.

AmbientMoodSettings

interface AmbientMoodSettings

Settings for ambient mood sounds that will play whilst in certain biomes.

AmbientParticleSettings

interface AmbientParticleSettings

Settings for ambient particles in biomes.

Biome

@CataloguedBy(catalogue = Biomes::class)

interface Biome : Keyed

A biome is a region in a world with distinct geographical features.

BiomeContainer

interface BiomeContainer

Something that contains biomes.

BiomeEffects

interface BiomeEffects

The effects for a biome. These control various things, including colouring, ambient particles, sounds, and music.

Biomes

@Catalogue(type = Biome::class)

object Biomes

All the built-in vanilla biomes.

Climate

interface Climate

The climate for a biome.

GrassColorModifier

enum GrassColorModifier : Enum<GrassColorModifier>

A modifier for the colouring of grass within a biome.

Precipitation

enum Precipitation : Enum<Precipitation>

A form of precipitation that applies in a climate.

TemperatureModifier

enum TemperatureModifier : Enum<TemperatureModifier>

A modifier for temperature in a climate.

Functions

additions

@Contract(value = "_, _ -> this", mutates = "this")

inline fun BiomeEffects.Builder.additions(sound: SoundEvent, builder: AmbientAdditionsSettings.Builder.() -> Unit): BiomeEffects.Builder

Applies the given builder to an ambient additions settings builder, builds the result, and sets the ambient additions settings to the built result.

biome

@Contract(value = "_ -> new", pure = true)

inline fun biome(builder: Biome.Builder.() -> Unit): Biome

Creates a new biome by applying the given builder to a new builder, then building the result.

climate

@Contract(value = "_ -> this", mutates = "this")

inline fun Biome.Builder.climate(builder: Climate.Builder.() -> Unit): Biome.Builder

Applies the given builder to a new climate builder and sets the climate to the built instance.

effects

@Contract(value = "_ -> this", mutates = "this")

inline fun Biome.Builder.effects(builder: BiomeEffects.Builder.() -> Unit): Biome.Builder

Applies the given builder to a new effects settings builder and sets the effects settings to the built instance.

mood

@Contract(value = "_, _ -> this", mutates = "this")

inline fun BiomeEffects.Builder.mood(sound: SoundEvent, builder: AmbientMoodSettings.Builder.() -> Unit): BiomeEffects.Builder

Applies the given builder to an ambient mood settings builder, builds the result, and sets the ambient mood settings to the built result.

particles

@Contract(value = "_, _ -> this", mutates = "this")

inline fun BiomeEffects.Builder.particles(type: ParticleType, builder: AmbientParticleSettings.Builder.() -> Unit): BiomeEffects.Builder

Applies the given builder to an ambient particle settings builder, builds the result, and sets the ambient particle settings to the built result.