Record Class EnvironmentAttributes

java.lang.Object

java.lang.Record

fr.fidorial.world.environment.EnvironmentAttributes

Record Components:

fogColor - distance fog color, packed RGB — minecraft:visual/fog_color

fogStartDistance - distance in blocks at which fog begins — minecraft:visual/fog_start_distance

fogEndDistance - distance in blocks at which fog reaches full density — minecraft:visual/fog_end_distance

skyColor - sky color, packed RGB — minecraft:visual/sky_color

cloudColor - cloud color, packed ARGB — minecraft:visual/cloud_color

cloudHeight - height, in blocks, at which clouds render — minecraft:visual/cloud_height

skyLightColor - sky light color, packed RGB — minecraft:visual/sky_light_color

skyLightFactor - multiplier applied to sky light, within [0, 1] — minecraft:visual/sky_light_factor

ambientLightColor - ambient light color, packed RGB — minecraft:visual/ambient_light_color

defaultDripstoneParticle - particle used by dripping dripstone — minecraft:visual/default_dripstone_particle

waterFogColor - underwater fog color, packed RGB — minecraft:visual/water_fog_color

waterFogEndDistance - distance in blocks at which underwater fog reaches full density — minecraft:visual/water_fog_end_distance

musicVolume - volume music fades to, within [0, 1] — minecraft:audio/music_volume

canStartRaid - whether a raid can begin here — minecraft:gameplay/can_start_raid

canPillagerPatrolSpawn - whether pillager patrols spawn here — minecraft:gameplay/can_pillager_patrol_spawn

waterEvaporates - whether placed water evaporates — minecraft:gameplay/water_evaporates

bedRule - when beds are usable to sleep/set spawn — minecraft:gameplay/bed_rule

respawnAnchorWorks - whether respawn anchors set spawn instead of exploding — minecraft:gameplay/respawn_anchor_works

netherPortalSpawnsPiglin - whether entering a nether portal can spawn a piglin — minecraft:gameplay/nether_portal_spawns_piglin

fastLava - whether lava flows and spreads at Nether speed — minecraft:gameplay/fast_lava

increasedFireBurnout - whether fire burns out faster — minecraft:gameplay/increased_fire_burnout

piglinsZombify - whether piglins and hoglins zombify — minecraft:gameplay/piglins_zombify

snowGolemMelts - whether snow golems take damage — minecraft:gameplay/snow_golem_melts

skyLightLevel - sky light level, within [0, 15] — minecraft:gameplay/sky_light_level

ambientParticles - particles randomly spawned around the camera, possibly empty — minecraft:visual/ambient_particles

ambientSounds - looping, mood and additions sounds — minecraft:audio/ambient_sounds

backgroundMusic - music tracks — minecraft:audio/background_music

public record EnvironmentAttributes(@Nullable Attribute<Integer> fogColor, @Nullable Attribute<Float> fogStartDistance, @Nullable Attribute<Float> fogEndDistance, @Nullable Attribute<Integer> skyColor, @Nullable Attribute<Integer> cloudColor, @Nullable Attribute<Float> cloudHeight, @Nullable Attribute<Integer> skyLightColor, @Nullable Attribute<Float> skyLightFactor, @Nullable Attribute<Integer> ambientLightColor, @Nullable Attribute<Key> defaultDripstoneParticle, @Nullable Attribute<Integer> waterFogColor, @Nullable Attribute<Float> waterFogEndDistance, @Nullable Attribute<Float> musicVolume, @Nullable Attribute<Boolean> canStartRaid, @Nullable Attribute<Boolean> canPillagerPatrolSpawn, @Nullable Attribute<Boolean> waterEvaporates, @Nullable Attribute<BedRule> bedRule, @Nullable Attribute<Boolean> respawnAnchorWorks, @Nullable Attribute<Boolean> netherPortalSpawnsPiglin, @Nullable Attribute<Boolean> fastLava, @Nullable Attribute<Boolean> increasedFireBurnout, @Nullable Attribute<Boolean> piglinsZombify, @Nullable Attribute<Boolean> snowGolemMelts, @Nullable Attribute<Float> skyLightLevel, List<AmbientParticle> ambientParticles, @Nullable AmbientSounds ambientSounds, @Nullable BackgroundMusic backgroundMusic)
extends Record

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EnvironmentAttributes.Builder	Mutable builder for EnvironmentAttributes.

Field Summary

Fields

Modifier and Type	Field	Description
static final EnvironmentAttributes	EMPTY	Sets nothing, letting the dimension and the vanilla defaults decide everything.

Constructor Summary

Constructors

Constructor

Description

EnvironmentAttributes(@Nullable Attribute<Integer> fogColor, @Nullable Attribute<Float> fogStartDistance, @Nullable Attribute<Float> fogEndDistance, @Nullable Attribute<Integer> skyColor, @Nullable Attribute<Integer> cloudColor, @Nullable Attribute<Float> cloudHeight, @Nullable Attribute<Integer> skyLightColor, @Nullable Attribute<Float> skyLightFactor, @Nullable Attribute<Integer> ambientLightColor, @Nullable Attribute<Key> defaultDripstoneParticle, @Nullable Attribute<Integer> waterFogColor, @Nullable Attribute<Float> waterFogEndDistance, @Nullable Attribute<Float> musicVolume, @Nullable Attribute<Boolean> canStartRaid, @Nullable Attribute<Boolean> canPillagerPatrolSpawn, @Nullable Attribute<Boolean> waterEvaporates, @Nullable Attribute<BedRule> bedRule, @Nullable Attribute<Boolean> respawnAnchorWorks, @Nullable Attribute<Boolean> netherPortalSpawnsPiglin, @Nullable Attribute<Boolean> fastLava, @Nullable Attribute<Boolean> increasedFireBurnout, @Nullable Attribute<Boolean> piglinsZombify, @Nullable Attribute<Boolean> snowGolemMelts, @Nullable Attribute<Float> skyLightLevel, List<AmbientParticle> ambientParticles, @Nullable AmbientSounds ambientSounds, @Nullable BackgroundMusic backgroundMusic)

Creates an instance of a EnvironmentAttributes record class.

Method Summary

Modifier and Type	Method	Description
@Nullable Attribute<Integer>	ambientLightColor()	Returns the value of the ambientLightColor record component.
List<AmbientParticle>	ambientParticles()	Returns the value of the ambientParticles record component.
@Nullable AmbientSounds	ambientSounds()	Returns the value of the ambientSounds record component.
@Nullable BackgroundMusic	backgroundMusic()	Returns the value of the backgroundMusic record component.
@Nullable Attribute<BedRule>	bedRule()	Returns the value of the bedRule record component.
static EnvironmentAttributes.Builder	builder()	Returns a new, empty builder.
static EnvironmentAttributes.Builder	builder(EnvironmentAttributes attributes)	Returns a new builder pre-filled with the values of attributes.
@Nullable Attribute<Boolean>	canPillagerPatrolSpawn()	Returns the value of the canPillagerPatrolSpawn record component.
@Nullable Attribute<Boolean>	canStartRaid()	Returns the value of the canStartRaid record component.
@Nullable Attribute<Integer>	cloudColor()	Returns the value of the cloudColor record component.
@Nullable Attribute<Float>	cloudHeight()	Returns the value of the cloudHeight record component.
@Nullable Attribute<Key>	defaultDripstoneParticle()	Returns the value of the defaultDripstoneParticle record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable Attribute<Boolean>	fastLava()	Returns the value of the fastLava record component.
@Nullable Attribute<Integer>	fogColor()	Returns the value of the fogColor record component.
@Nullable Attribute<Float>	fogEndDistance()	Returns the value of the fogEndDistance record component.
@Nullable Attribute<Float>	fogStartDistance()	Returns the value of the fogStartDistance record component.
final int	hashCode()	Returns a hash code value for this object.
@Nullable Attribute<Boolean>	increasedFireBurnout()	Returns the value of the increasedFireBurnout record component.
boolean	isEmpty()	Returns whether this sets no attribute at all.
@Nullable Attribute<Float>	musicVolume()	Returns the value of the musicVolume record component.
@Nullable Attribute<Boolean>	netherPortalSpawnsPiglin()	Returns the value of the netherPortalSpawnsPiglin record component.
@Nullable Attribute<Boolean>	piglinsZombify()	Returns the value of the piglinsZombify record component.
@Nullable Attribute<Boolean>	respawnAnchorWorks()	Returns the value of the respawnAnchorWorks record component.
@Nullable Attribute<Integer>	skyColor()	Returns the value of the skyColor record component.
static int	skyColorFor(float temperature)	Computes the sky color the vanilla generator derives from a given temperature.
@Nullable Attribute<Integer>	skyLightColor()	Returns the value of the skyLightColor record component.
@Nullable Attribute<Float>	skyLightFactor()	Returns the value of the skyLightFactor record component.
@Nullable Attribute<Float>	skyLightLevel()	Returns the value of the skyLightLevel record component.
@Nullable Attribute<Boolean>	snowGolemMelts()	Returns the value of the snowGolemMelts record component.
final String	toString()	Returns a string representation of this record class.
@Nullable Attribute<Boolean>	waterEvaporates()	Returns the value of the waterEvaporates record component.
@Nullable Attribute<Integer>	waterFogColor()	Returns the value of the waterFogColor record component.
@Nullable Attribute<Float>	waterFogEndDistance()	Returns the value of the waterFogEndDistance record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static final EnvironmentAttributes EMPTY

Sets nothing, letting the dimension and the vanilla defaults decide everything.

Constructor Details

EnvironmentAttributes

public EnvironmentAttributes(@Nullable Attribute<Integer> fogColor,
 @Nullable Attribute<Float> fogStartDistance,
 @Nullable Attribute<Float> fogEndDistance,
 @Nullable Attribute<Integer> skyColor,
 @Nullable Attribute<Integer> cloudColor,
 @Nullable Attribute<Float> cloudHeight,
 @Nullable Attribute<Integer> skyLightColor,
 @Nullable Attribute<Float> skyLightFactor,
 @Nullable Attribute<Integer> ambientLightColor,
 @Nullable Attribute<Key> defaultDripstoneParticle,
 @Nullable Attribute<Integer> waterFogColor,
 @Nullable Attribute<Float> waterFogEndDistance,
 @Nullable Attribute<Float> musicVolume,
 @Nullable Attribute<Boolean> canStartRaid,
 @Nullable Attribute<Boolean> canPillagerPatrolSpawn,
 @Nullable Attribute<Boolean> waterEvaporates,
 @Nullable Attribute<BedRule> bedRule,
 @Nullable Attribute<Boolean> respawnAnchorWorks,
 @Nullable Attribute<Boolean> netherPortalSpawnsPiglin,
 @Nullable Attribute<Boolean> fastLava,
 @Nullable Attribute<Boolean> increasedFireBurnout,
 @Nullable Attribute<Boolean> piglinsZombify,
 @Nullable Attribute<Boolean> snowGolemMelts,
 @Nullable Attribute<Float> skyLightLevel,
 List<AmbientParticle> ambientParticles,
 @Nullable AmbientSounds ambientSounds,
 @Nullable BackgroundMusic backgroundMusic)

Creates an instance of a EnvironmentAttributes record class.

Parameters:

fogColor - the value for the fogColor record component

fogStartDistance - the value for the fogStartDistance record component

fogEndDistance - the value for the fogEndDistance record component

skyColor - the value for the skyColor record component

cloudColor - the value for the cloudColor record component

cloudHeight - the value for the cloudHeight record component

skyLightColor - the value for the skyLightColor record component

skyLightFactor - the value for the skyLightFactor record component

ambientLightColor - the value for the ambientLightColor record component

defaultDripstoneParticle - the value for the defaultDripstoneParticle record component

waterFogColor - the value for the waterFogColor record component

waterFogEndDistance - the value for the waterFogEndDistance record component

musicVolume - the value for the musicVolume record component

canStartRaid - the value for the canStartRaid record component

canPillagerPatrolSpawn - the value for the canPillagerPatrolSpawn record component

waterEvaporates - the value for the waterEvaporates record component

bedRule - the value for the bedRule record component

respawnAnchorWorks - the value for the respawnAnchorWorks record component

netherPortalSpawnsPiglin - the value for the netherPortalSpawnsPiglin record component

fastLava - the value for the fastLava record component

increasedFireBurnout - the value for the increasedFireBurnout record component

piglinsZombify - the value for the piglinsZombify record component

snowGolemMelts - the value for the snowGolemMelts record component

skyLightLevel - the value for the skyLightLevel record component

ambientParticles - the value for the ambientParticles record component

ambientSounds - the value for the ambientSounds record component

backgroundMusic - the value for the backgroundMusic record component

Method Details

builder

@Contract(value="-> new",
          pure=true)
public static EnvironmentAttributes.Builder builder()

Returns a new, empty builder.

Returns:

a new, empty builder

builder

@Contract(value="_ -> new",
          pure=true)
public static EnvironmentAttributes.Builder builder(EnvironmentAttributes attributes)

Returns a new builder pre-filled with the values of attributes.

Parameters:

attributes - the attributes to copy

Returns:

a new builder pre-filled with the values of attributes

skyColorFor

public static int skyColorFor(float temperature)

Computes the sky color the vanilla generator derives from a given temperature.

Parameters:

temperature - the biome temperature

Returns:

the packed RGB sky color

isEmpty

public boolean isEmpty()

Returns whether this sets no attribute at all.

Returns:

whether this sets no attribute at all

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

fogColor

public @Nullable Attribute<Integer> fogColor()

Returns the value of the fogColor record component.

Returns:

the value of the fogColor record component

fogStartDistance

public @Nullable Attribute<Float> fogStartDistance()

Returns the value of the fogStartDistance record component.

Returns:

the value of the fogStartDistance record component

fogEndDistance

public @Nullable Attribute<Float> fogEndDistance()

Returns the value of the fogEndDistance record component.

Returns:

the value of the fogEndDistance record component

skyColor

public @Nullable Attribute<Integer> skyColor()

Returns the value of the skyColor record component.

Returns:

the value of the skyColor record component

cloudColor

public @Nullable Attribute<Integer> cloudColor()

Returns the value of the cloudColor record component.

Returns:

the value of the cloudColor record component

cloudHeight

public @Nullable Attribute<Float> cloudHeight()

Returns the value of the cloudHeight record component.

Returns:

the value of the cloudHeight record component

skyLightColor

public @Nullable Attribute<Integer> skyLightColor()

Returns the value of the skyLightColor record component.

Returns:

the value of the skyLightColor record component

skyLightFactor

public @Nullable Attribute<Float> skyLightFactor()

Returns the value of the skyLightFactor record component.

Returns:

the value of the skyLightFactor record component

ambientLightColor

public @Nullable Attribute<Integer> ambientLightColor()

Returns the value of the ambientLightColor record component.

Returns:

the value of the ambientLightColor record component

defaultDripstoneParticle

public @Nullable Attribute<Key> defaultDripstoneParticle()

Returns the value of the defaultDripstoneParticle record component.

Returns:

the value of the defaultDripstoneParticle record component

waterFogColor

public @Nullable Attribute<Integer> waterFogColor()

Returns the value of the waterFogColor record component.

Returns:

the value of the waterFogColor record component

waterFogEndDistance

public @Nullable Attribute<Float> waterFogEndDistance()

Returns the value of the waterFogEndDistance record component.

Returns:

the value of the waterFogEndDistance record component

musicVolume

public @Nullable Attribute<Float> musicVolume()

Returns the value of the musicVolume record component.

Returns:

the value of the musicVolume record component

canStartRaid

public @Nullable Attribute<Boolean> canStartRaid()

Returns the value of the canStartRaid record component.

Returns:

the value of the canStartRaid record component

canPillagerPatrolSpawn

public @Nullable Attribute<Boolean> canPillagerPatrolSpawn()

Returns the value of the canPillagerPatrolSpawn record component.

Returns:

the value of the canPillagerPatrolSpawn record component

waterEvaporates

public @Nullable Attribute<Boolean> waterEvaporates()

Returns the value of the waterEvaporates record component.

Returns:

the value of the waterEvaporates record component

bedRule

public @Nullable Attribute<BedRule> bedRule()

Returns the value of the bedRule record component.

Returns:

the value of the bedRule record component

respawnAnchorWorks

public @Nullable Attribute<Boolean> respawnAnchorWorks()

Returns the value of the respawnAnchorWorks record component.

Returns:

the value of the respawnAnchorWorks record component

netherPortalSpawnsPiglin

public @Nullable Attribute<Boolean> netherPortalSpawnsPiglin()

Returns the value of the netherPortalSpawnsPiglin record component.

Returns:

the value of the netherPortalSpawnsPiglin record component

fastLava

public @Nullable Attribute<Boolean> fastLava()

Returns the value of the fastLava record component.

Returns:

the value of the fastLava record component

increasedFireBurnout

public @Nullable Attribute<Boolean> increasedFireBurnout()

Returns the value of the increasedFireBurnout record component.

Returns:

the value of the increasedFireBurnout record component

piglinsZombify

public @Nullable Attribute<Boolean> piglinsZombify()

Returns the value of the piglinsZombify record component.

Returns:

the value of the piglinsZombify record component

snowGolemMelts

public @Nullable Attribute<Boolean> snowGolemMelts()

Returns the value of the snowGolemMelts record component.

Returns:

the value of the snowGolemMelts record component

skyLightLevel

public @Nullable Attribute<Float> skyLightLevel()

Returns the value of the skyLightLevel record component.

Returns:

the value of the skyLightLevel record component

ambientParticles

public List<AmbientParticle> ambientParticles()

Returns the value of the ambientParticles record component.

Returns:

the value of the ambientParticles record component

ambientSounds

public @Nullable AmbientSounds ambientSounds()

Returns the value of the ambientSounds record component.

Returns:

the value of the ambientSounds record component

backgroundMusic

public @Nullable BackgroundMusic backgroundMusic()

Returns the value of the backgroundMusic record component.

Returns:

the value of the backgroundMusic record component