com.legacy.structure_gel.worldgen.structure

Class GelStructure<C extends net.minecraft.world.gen.feature.IFeatureConfig>

java.lang.Object

net.minecraftforge.registries.ForgeRegistryEntry<net.minecraft.world.gen.feature.structure.Structure<?>>

net.minecraft.world.gen.feature.structure.Structure<C>

com.legacy.structure_gel.worldgen.structure.GelStructure<C>

Type Parameters:

C -

All Implemented Interfaces:

net.minecraftforge.common.extensions.IForgeStructure, net.minecraftforge.registries.IForgeRegistryEntry<net.minecraft.world.gen.feature.structure.Structure<?>>

Direct Known Subclasses:

GelConfigStructure, GelJigsawStructure

public abstract class GelStructure<C extends net.minecraft.world.gen.feature.IFeatureConfig>
extends net.minecraft.world.gen.feature.structure.Structure<C>

An extension of Structure that allows for more precise tweaking and handles structure spacing. For jigsaw related structures, use GelJigsawStructure or it's children.

Author:

David

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.world.gen.feature.structure.Structure

net.minecraft.world.gen.feature.structure.Structure.IStartFactory<C extends net.minecraft.world.gen.feature.IFeatureConfig>

Field Summary

Fields

Modifier and Type	Field and Description
boolean	insideSpawnsOnly When true, mobs can only spawn inside of the structure's pieces.
java.lang.Integer	seed The seed used for generation.
java.util.Map<net.minecraft.entity.EntityClassification,java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners>>	spawns A map of mobs that spawn within the structure's bounds.

Fields inherited from class net.minecraft.world.gen.feature.structure.Structure

BASTION_REMNANT, BURIED_TREASURE, DESERT_PYRAMID, END_CITY, field_236384_t_, FORTRESS, IGLOO, JUNGLE_PYRAMID, MINESHAFT, MONUMENT, NAME_STRUCTURE_BIMAP, NETHER_FOSSIL, OCEAN_RUIN, PILLAGER_OUTPOST, RUINED_PORTAL, SHIPWRECK, STRONGHOLD, STRUCTURE_DECORATION_STAGE_MAP, SWAMP_HUT, VILLAGE, WOODLAND_MANSION

Fields inherited from class net.minecraftforge.registries.ForgeRegistryEntry

delegate

Constructor Summary

Constructors

Constructor and Description
GelStructure(com.mojang.serialization.Codec<C> codec)

Method Summary

Modifier and Type	Method and Description
net.minecraft.util.math.BlockPos	func_236388_a_(net.minecraft.world.IWorldReader worldIn, net.minecraft.world.gen.feature.structure.StructureManager structureManager, net.minecraft.util.math.BlockPos startPos, int searchRadius, boolean skipExistingChunks, long seed, net.minecraft.world.gen.settings.StructureSeparationSettings settings)
net.minecraft.util.math.ChunkPos	getChunkPosForStructure(net.minecraft.world.gen.settings.StructureSeparationSettings settings, long seed, net.minecraft.util.SharedSeedRandom sharedSeedRand, int x, int z) Checks to see if this structure can generate in the given chunk using a grid with custom spacing and offsets.
java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners>	getCreatureSpawnList() Deprecated. Use getSpawns(EntityClassification) and setSpawnList(EntityClassification, List).
net.minecraft.world.gen.GenerationStage.Decoration	getDecorationStage() What stage of generation your structure should be generated during.
java.util.List<net.minecraft.world.gen.DimensionSettings>	getNoiseSettingsToGenerateIn() Gets a list of DimensionSettings to tell your structure where to generate.
abstract int	getOffset() When checking if a structure can be placed in a given chunk, this value is used along with getSpacing() to give the structure an offset as to not make the grid apparent.
abstract double	getProbability() This is the probability of the structure generating in a given chunk, expressed as a percent.
int	getSeed() Every structure should have a different seed to prevent them from overlapping as best as possible, especially when the same chances are used.
net.minecraft.world.gen.settings.StructureSeparationSettings	getSeparationSettings() Gets a StructureSeparationSettings based on the API values.
abstract int	getSpacing() When checking if a structure can be placed in a given chunk, this is called to determine how far apart each structure should be from eachother.
java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners>	getSpawnList() Deprecated. Use getSpawns(EntityClassification) and setSpawnList(EntityClassification, List).
java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners>	getSpawns(net.minecraft.entity.EntityClassification classification) Returns a list of mobs to spawn based on the classification put in.
java.lang.String	getStructureName() Gets the registry name of the structure.
void	potentialSpawnsEvent(net.minecraftforge.event.world.StructureSpawnListGatherEvent event) Automatically registered to the event bus.
GelStructure<C>	setLakeProof(boolean lakeProof) Determines if lakes shuold generate inside of this structure or not.
GelStructure<C>	setSpawnList(net.minecraft.entity.EntityClassification classification, java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners> spawns) Sets the spawns that can exist in this structure for the passed mob classification.

Methods inherited from class net.minecraft.world.gen.feature.structure.Structure

deserializeStructureStart, func_242785_a, getFeatureCodec, getSpawnList, getStartFactory, init, withConfiguration

Methods inherited from class net.minecraftforge.registries.ForgeRegistryEntry

getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.minecraftforge.common.extensions.IForgeStructure

getDefaultCreatureSpawnList, getDefaultRestrictsSpawnsToInside, getDefaultSpawnList, getStructure

Field Detail

spawns

public final java.util.Map<net.minecraft.entity.EntityClassification,java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners>> spawns

A map of mobs that spawn within the structure's bounds. Use setSpawnList(EntityClassification, List) to add to it.

insideSpawnsOnly

public boolean insideSpawnsOnly

When true, mobs can only spawn inside of the structure's pieces. When false, mobs can spawn within area around the structure.

seed

public java.lang.Integer seed

The seed used for generation. This is automatically assigned when getSeed() is called, but you can assign it in your constructor.

Constructor Detail

GelStructure

public GelStructure(com.mojang.serialization.Codec<C> codec)

Method Detail

setLakeProof

public GelStructure<C> setLakeProof(boolean lakeProof)

Determines if lakes shuold generate inside of this structure or not. This is automatically set to true when you create the structure.

Parameters:

lakeProof -

Returns:

GelStructure

setSpawnList

public GelStructure<C> setSpawnList(net.minecraft.entity.EntityClassification classification,
                                    java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners> spawns)

Sets the spawns that can exist in this structure for the passed mob classification. Set to an empty list to prevent spawns, and leave as null to change nothing.

Parameters:

classification -

spawns -

Returns:

GelStructure

getNoiseSettingsToGenerateIn

public java.util.List<net.minecraft.world.gen.DimensionSettings> getNoiseSettingsToGenerateIn()

Gets a list of DimensionSettings to tell your structure where to generate. Can be set using configs. Defaults to every setting.

Returns:

List

getDecorationStage

public net.minecraft.world.gen.GenerationStage.Decoration getDecorationStage()

What stage of generation your structure should be generated during. Surface structures by default.

Overrides:

getDecorationStage in class net.minecraft.world.gen.feature.structure.Structure<C extends net.minecraft.world.gen.feature.IFeatureConfig>

Returns:

GenerationStage.Decoration

getChunkPosForStructure

public net.minecraft.util.math.ChunkPos getChunkPosForStructure(net.minecraft.world.gen.settings.StructureSeparationSettings settings,
                                                                long seed,
                                                                net.minecraft.util.SharedSeedRandom sharedSeedRand,
                                                                int x,
                                                                int z)

Checks to see if this structure can generate in the given chunk using a grid with custom spacing and offsets.

Overrides:

getChunkPosForStructure in class net.minecraft.world.gen.feature.structure.Structure<C extends net.minecraft.world.gen.feature.IFeatureConfig>

Returns:

ChunkPos

See Also:

getSpacing(), getOffset()

func_236388_a_

public net.minecraft.util.math.BlockPos func_236388_a_(net.minecraft.world.IWorldReader worldIn,
                                                       net.minecraft.world.gen.feature.structure.StructureManager structureManager,
                                                       net.minecraft.util.math.BlockPos startPos,
                                                       int searchRadius,
                                                       boolean skipExistingChunks,
                                                       long seed,
                                                       net.minecraft.world.gen.settings.StructureSeparationSettings settings)

Overrides:

func_236388_a_ in class net.minecraft.world.gen.feature.structure.Structure<C extends net.minecraft.world.gen.feature.IFeatureConfig>

getSeed

public int getSeed()

Every structure should have a different seed to prevent them from overlapping as best as possible, especially when the same chances are used. This seed should be constant.

Returns the hash code of this instance's registry name by default.

Returns:

Integer

getProbability

public abstract double getProbability()

This is the probability of the structure generating in a given chunk, expressed as a percent.

Returns:

Double

getSpacing

public abstract int getSpacing()

When checking if a structure can be placed in a given chunk, this is called to determine how far apart each structure should be from eachother. A value of 4 will space structures out 4 chunks apart.

This number should not be negative or 0. 0 will crash. Don't do it.

Returns:

Integer

getOffset

public abstract int getOffset()

When checking if a structure can be placed in a given chunk, this value is used along with getSpacing() to give the structure an offset as to not make the grid apparent. It's recommended that this value is no larger than half of what getSpacing() returns to prevent structure overlap.

This number should not be negative.

Returns:

Integer

getStructureName

public java.lang.String getStructureName()

Gets the registry name of the structure.

Overrides:

getStructureName in class net.minecraft.world.gen.feature.structure.Structure<C extends net.minecraft.world.gen.feature.IFeatureConfig>

Returns:

String

getSpawnList

@Nullable
 @Deprecated
public java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners> getSpawnList()

Deprecated. Use getSpawns(EntityClassification) and setSpawnList(EntityClassification, List).

Return a list of hostile mobs to change spawn behavior. Return null to do nothing.

Overrides:

getSpawnList in class net.minecraft.world.gen.feature.structure.Structure<C extends net.minecraft.world.gen.feature.IFeatureConfig>

Returns:

List

getCreatureSpawnList

@Nullable
 @Deprecated
public java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners> getCreatureSpawnList()

Deprecated. Use getSpawns(EntityClassification) and setSpawnList(EntityClassification, List).

Return a list of passive mobs to change spawn behavior. Return null to do nothing.

Overrides:

getCreatureSpawnList in class net.minecraft.world.gen.feature.structure.Structure<C extends net.minecraft.world.gen.feature.IFeatureConfig>

Returns:

List

getSpawns

@Nullable
public java.util.List<net.minecraft.world.biome.MobSpawnInfo.Spawners> getSpawns(net.minecraft.entity.EntityClassification classification)

Returns a list of mobs to spawn based on the classification put in. Any classification not set in spawns will return null, and be ignored.

Parameters:

classification -

Returns:

List

potentialSpawnsEvent

public void potentialSpawnsEvent(net.minecraftforge.event.world.StructureSpawnListGatherEvent event)

Automatically registered to the event bus. Uses getSpawns(EntityClassification) to get what mobs should spawn.

Parameters:

event -

getSeparationSettings

public net.minecraft.world.gen.settings.StructureSeparationSettings getSeparationSettings()

Gets a StructureSeparationSettings based on the API values.

Returns:

StructureSeparationSettings