BiomeEffects

interface BiomeEffects

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

Types

Link copied to clipboard

A builder for biome effects.

Link copied to clipboard
object Companion
Link copied to clipboard
@ApiStatus.Internal
interface Factory

Properties

Link copied to clipboard
@get:JvmName(name = "ambientAdditionsSettings")
abstract val ambientAdditionsSettings: AmbientAdditionsSettings?

Settings for the ambient additions sound that may play randomly when in the biome.

Link copied to clipboard
@get:JvmName(name = "ambientLoopSound")
abstract val ambientLoopSound: SoundEvent?

The ambient sound that should be played and put on loop until the biome is left.

Link copied to clipboard
@get:JvmName(name = "ambientMoodSettings")
abstract val ambientMoodSettings: AmbientMoodSettings?

Settings for the ambient mood sound that will start playing after a fixed delay and in a specific range.

Link copied to clipboard
@get:JvmName(name = "ambientParticleSettings")
abstract val ambientParticleSettings: AmbientParticleSettings?

Settings for ambient particle effects that may appear randomly when in the biome.

Link copied to clipboard
@get:JvmName(name = "backgroundMusic")
abstract val backgroundMusic: Music?

The music that will be played in the background when in the biome.

Link copied to clipboard
@get:JvmName(name = "fogColor")
abstract val fogColor: Color

The colour that fog will appear when in the biome.

Link copied to clipboard
@get:JvmName(name = "foliageColor")
abstract val foliageColor: Color?

The colour that foliage, such as tree leaves and vines, will appear when in the biome.

Link copied to clipboard
@get:JvmName(name = "grassColor")
abstract val grassColor: Color?

The colour that grass, such as grass blocks and tall grass, will appear when in the biome.

Link copied to clipboard
@get:JvmName(name = "grassColorModifier")
abstract val grassColorModifier: GrassColorModifier

The modifier for the colour of grass in the biome.

Link copied to clipboard
@get:JvmName(name = "skyColor")
abstract val skyColor: Color

The colour that the sky will appear when in the biome.

Link copied to clipboard
@get:JvmName(name = "waterColor")
abstract val waterColor: Color

The colour that water will appear when in the biome.

Link copied to clipboard
@get:JvmName(name = "waterFogColor")
abstract val waterFogColor: Color

The colour that water will appear when viewed through fog in the biome.