Interface BiomeSpecialEffects

All Superinterfaces:

Wrapper

@NullMarked
@AsOf("3.0.0")
public interface BiomeSpecialEffects
extends Wrapper

Various biome-specific visuals as they appear in vanilla.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BiomeSpecialEffects.Builder	A builder for creating BiomeSpecialEffects instances.

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields

Modifier and Type	Field	Description
static final BiomeSpecialEffects	DEFAULT
static final ConstructWireProvider<BiomeSpecialEffects>	WIRE

Method Summary

Modifier and Type	Method	Description
static BiomeSpecialEffects.Builder	builder()	Creates a new BiomeSpecialEffects builder.
Optional<Integer>	dryFoliageColorOverride()	The color of dry foliage such as leaf litter in a biome.
Optional<Integer>	foliageColorOverride()	The color of leaves in a biome.
GrassColorModifier	grassColorModifier()	The tint modifier for grass colors in a biome.
Optional<Integer>	grassColorOverride()	The color of grass in a biome.
static BiomeSpecialEffects	of(int waterColor, Integer foliageColorOverride, Integer dryFoliageColorOverride, Integer grassColorOverride, @NonNull GrassColorModifier grassColorModifier)	Creates a new BiomeSpecialEffects instance.
static BiomeSpecialEffects	of(String waterColor, @Nullable String foliageColorOverride, @Nullable String dryFoliageColorOverride, @Nullable String grassColorOverride, GrassColorModifier grassColorModifier)	Creates a new BiomeSpecialEffects instance.
default BiomeSpecialEffects.Builder	toBuilder()	Converts this object back to a builder.
int	waterColor()	The color of water in a biome.

Methods inherited from interface Wrapper

asHandle, toMinecraft

Field Details

WIRE

@Internal
static final ConstructWireProvider<BiomeSpecialEffects> WIRE

DEFAULT

static final BiomeSpecialEffects DEFAULT

Method Details

waterColor

@AsOf("3.0.0")
int waterColor()

The color of water in a biome.

Returns:

the water color of the biome

Since:

3.0.0

foliageColorOverride

@AsOf("3.0.0")
Optional<Integer> foliageColorOverride()

The color of leaves in a biome.

Returns:

the foliage color override of the biome, if present

Since:

3.0.0

dryFoliageColorOverride

@AsOf("3.0.0")
Optional<Integer> dryFoliageColorOverride()

The color of dry foliage such as leaf litter in a biome.

Returns:

the dry foliage color override of the biome, if present

Since:

3.0.0

grassColorOverride

@AsOf("3.0.0")
Optional<Integer> grassColorOverride()

The color of grass in a biome.

Returns:

the grass color override of the biome, if present

Since:

3.0.0

grassColorModifier

@AsOf("3.0.0")
GrassColorModifier grassColorModifier()

The tint modifier for grass colors in a biome.

Returns:

the grass color modifier of the biome

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default BiomeSpecialEffects.Builder toBuilder()

Converts this object back to a builder.

Returns:

a new BiomeSpecialEffects builder from this instance

Since:

3.0.0

of

@AsOf("3.0.0")
@NullUnmarked
static BiomeSpecialEffects of(int waterColor,
 Integer foliageColorOverride,
 Integer dryFoliageColorOverride,
 Integer grassColorOverride,
 @NonNull GrassColorModifier grassColorModifier)

Creates a new BiomeSpecialEffects instance.

Parameters:

waterColor - the water color of the biome

foliageColorOverride - the foliage color override of the biome, or null for none

dryFoliageColorOverride - the dry foliage color override of the biome, or null for none

grassColorOverride - the grass color override of the biome, or null for none

grassColorModifier - the grass color modifier of the biome

Returns:

a new BiomeSpecialEffects instance

Since:

3.0.0

of

@AsOf("3.0.0")
static BiomeSpecialEffects of(String waterColor,
 @Nullable String foliageColorOverride,
 @Nullable String dryFoliageColorOverride,
 @Nullable String grassColorOverride,
 GrassColorModifier grassColorModifier)

Creates a new BiomeSpecialEffects instance.

Parameters:

waterColor - the water color of the biome, as a hex string

foliageColorOverride - the foliage color override of the biome, or null for none, as a hex string

dryFoliageColorOverride - the dry foliage color override of the biome, or null for none, as a hex string

grassColorOverride - the grass color override of the biome, or null for none, as a hex string

grassColorModifier - the grass color modifier of the biome

Returns:

a new BiomeSpecialEffects instance

Since:

3.0.0

builder

@AsOf("3.0.0")
static BiomeSpecialEffects.Builder builder()

Creates a new BiomeSpecialEffects builder.

Returns:

a new BiomeSpecialEffects builder

Since:

3.0.0