api/org.kryptonmc.api.world.biome/AmbientParticleSettings

AmbientParticleSettings

interface AmbientParticleSettings

Settings for ambient particles in biomes.

Types

Link copied to clipboard
interface Builder : AbstractBuilder<AmbientParticleSettings>

A builder for ambient particle settings.

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

Properties

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

The data for the particle. This may be null, in which case either the particle type has no associated particle data, or there is no data for the particle in these settings.

Link copied to clipboard
@get:JvmName(name = "probability")
abstract val probability: Float

The chance that particles of the above type will appear naturally in the biome.

Link copied to clipboard
@get:JvmName(name = "type")
abstract val type: ParticleType

The type of the particle for these settings.