Record Class ModifyEvents.BiomeEnvironments

java.lang.Object

java.lang.Record

com.hypixel.hytale.builtin.worldgen.modifier.event.ModifyEvents.BiomeEnvironments

All Implemented Interfaces:

ModifyEvent<EnvironmentContainer.EnvironmentContainerEntry>, IBaseEvent<Content.Type>, IEvent<Content.Type>

Enclosing interface:

ModifyEvents

public static record ModifyEvents.BiomeEnvironments(@Nonnull SeedString<SeedStringResource> seed, @Nonnull BiomeFileContext file, @Nonnull List<EnvironmentContainer.EnvironmentContainerEntry> entries, @Nonnull ModifyEvent.ContentLoader<EnvironmentContainer.EnvironmentContainerEntry> loader)
extends Record
implements ModifyEvent<EnvironmentContainer.EnvironmentContainerEntry>

The biome environment loading event can be used to modify the environment container entries for a biome.

Nested Class Summary

Nested classes/interfaces inherited from interface ModifyEvent

ModifyEvent.ContentLoader<T>, ModifyEvent.SeedGenerator<K>

Constructor Summary

Constructors

Constructor	Description
BiomeEnvironments(SeedString<SeedStringResource> seed, BiomeFileContext file, List<EnvironmentContainer.EnvironmentContainerEntry> entries, ModifyEvent.ContentLoader<EnvironmentContainer.EnvironmentContainerEntry> loader)	Creates an instance of a BiomeEnvironments record class.

Method Summary

Modifier and Type	Method	Description
List<EnvironmentContainer.EnvironmentContainerEntry>	entries()	Returns the value of the entries record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
BiomeFileContext	file()	Returns the value of the file record component.
final int	hashCode()	Returns a hash code value for this object.
ModifyEvent.ContentLoader<EnvironmentContainer.EnvironmentContainerEntry>	loader()	Returns the value of the loader record component.
SeedString<SeedStringResource>	seed()	Returns the value of the seed record component.
final String	toString()	Returns a string representation of this record class.
Content.Type	type()	Get the type of event.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BiomeEnvironments

public BiomeEnvironments(@Nonnull
 SeedString<SeedStringResource> seed,
 @Nonnull
 BiomeFileContext file,
 @Nonnull
 List<EnvironmentContainer.EnvironmentContainerEntry> entries,
 @Nonnull
 ModifyEvent.ContentLoader<EnvironmentContainer.EnvironmentContainerEntry> loader)

Creates an instance of a BiomeEnvironments record class.

Parameters:

seed - the value for the seed record component

file - the value for the file record component

entries - the value for the entries record component

loader - the value for the loader record component

Method Details

type

@Nonnull
public Content.Type type()

Description copied from interface: ModifyEvent

Get the type of event.

Specified by:

type in interface ModifyEvent<EnvironmentContainer.EnvironmentContainerEntry>

Returns:

the type of event.

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.

seed

@Nonnull
public SeedString<SeedStringResource> seed()

Returns the value of the seed record component.

Specified by:

seed in interface ModifyEvent<EnvironmentContainer.EnvironmentContainerEntry>

Returns:

the value of the seed record component

file

@Nonnull
public BiomeFileContext file()

Returns the value of the file record component.

Specified by:

file in interface ModifyEvent<EnvironmentContainer.EnvironmentContainerEntry>

Returns:

the value of the file record component

entries

@Nonnull
public List<EnvironmentContainer.EnvironmentContainerEntry> entries()

Returns the value of the entries record component.

Specified by:

entries in interface ModifyEvent<EnvironmentContainer.EnvironmentContainerEntry>

Returns:

the value of the entries record component

loader

@Nonnull
public ModifyEvent.ContentLoader<EnvironmentContainer.EnvironmentContainerEntry> loader()

Returns the value of the loader record component.

Specified by:

loader in interface ModifyEvent<EnvironmentContainer.EnvironmentContainerEntry>

Returns:

the value of the loader record component