api/org.kryptonmc.api.world.biome/BiomeEffects/Builder

Builder

interface Builder : AbstractBuilder<BiomeEffects>

A builder for biome effects.

Functions

additions

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

abstract fun additions(settings: AmbientAdditionsSettings?): BiomeEffects.Builder

Sets the ambient additions settings of the biome effects to the given settings.

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

open fun additions(sound: SoundEvent, builder: Consumer<AmbientAdditionsSettings.Builder>): 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.

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.

backgroundMusic

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

abstract fun backgroundMusic(music: Music?): BiomeEffects.Builder

Sets the background music of the biome effects to the given music.

build

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

@NotNull

abstract fun build(): @NotNull BiomeEffects

fogColor

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

abstract fun fogColor(color: Color): BiomeEffects.Builder

Sets the fog colour of the biome effects to the given color.

foliageColor

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

abstract fun foliageColor(color: Color?): BiomeEffects.Builder

Sets the foliage colour of the biome effects to the given color.

grassColor

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

abstract fun grassColor(color: Color?): BiomeEffects.Builder

Sets the grass colour of the biome effects to the given color.

grassColorModifier

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

abstract fun grassColorModifier(modifier: GrassColorModifier): BiomeEffects.Builder

Sets the grass colour modifier of the biome effects to the given modifier.

loopSound

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

abstract fun loopSound(sound: SoundEvent?): BiomeEffects.Builder

Sets the ambient loop sound of the biome effects to the given sound.

mood

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

abstract fun mood(settings: AmbientMoodSettings?): BiomeEffects.Builder

Sets the ambient mood settings of the biome effects to the given settings.

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

open fun mood(sound: SoundEvent, builder: Consumer<AmbientMoodSettings.Builder>): 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.

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")

abstract fun particles(settings: AmbientParticleSettings?): BiomeEffects.Builder

Sets the ambient particle settings of the biome effects to the given settings.

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

open fun particles(type: ParticleType, builder: Consumer<AmbientParticleSettings.Builder>): 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.

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.

skyColor

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

abstract fun skyColor(color: Color): BiomeEffects.Builder

Sets the sky colour of the biome effects to the given color.

waterColor

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

abstract fun waterColor(color: Color): BiomeEffects.Builder

Sets the water colour of the biome effects to the given color.

waterFogColor

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

abstract fun waterFogColor(color: Color): BiomeEffects.Builder

Sets the water fog colour of the biome effects to the given color.