New BiomeLoadingEvent that allows modders to edit biomes as they are being deserialized.

This commit is contained in:
LexManos committed 2020-09-14 17:43:01 -07:00
1 parent ce6c664acd
commit 11e3281b3f
10 files changed
+386 -1

No files matched your search

@@ -0,0 +1,131 @@
/*
* Minecraft Forge
* Copyright (c) 2016-2020.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation version 2.1
* of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package net.minecraftforge.event.world;
import net.minecraft.util.ResourceLocation;
import net.minecraft.world.biome.Biome;
import net.minecraft.world.biome.BiomeAmbience;
import net.minecraftforge.common.world.BiomeGenerationSettingsBuilder;
import net.minecraftforge.common.world.MobSpawnInfoBuilder;
import net.minecraftforge.eventbus.api.Event;
import net.minecraftforge.eventbus.api.EventPriority;
/**
* This event fires when a Biome is created from json or when a registered biome is re-created for worldgen.
* It allows mods to edit a biome (like add a mob spawn) before it gets used for worldgen.
*
* In order to maintain the most compatibility possible with other mods' modifications to a biome,
* the event should be assigned a {@link net.minecraftforge.eventbus.api.EventPriority} as follows:
*
* - Additions to any list/map contained in a biome : {@link EventPriority#HIGH}
* - Removals to any list/map contained in a biome : {@link EventPriority#NORMAL}
* - Any other modification : {@link EventPriority#LOW}
*
* Be aware that another mod could have done an operation beforehand, so an expected value out of a vanilla biome might not
* always be the same, depending on other mods.
*/
public class BiomeLoadingEvent extends Event
{
private final ResourceLocation name;
private Biome.Climate climate;
private Biome.Category category;
private float depth;
private float scale;
private BiomeAmbience effects;
private final BiomeGenerationSettingsBuilder gen;
private final MobSpawnInfoBuilder spawns;
public BiomeLoadingEvent(final ResourceLocation name, final Biome.Climate climate, final Biome.Category category, final float depth, final float scale, final BiomeAmbience effects, final BiomeGenerationSettingsBuilder gen, final MobSpawnInfoBuilder spawns)
{
this.name = name;
this.climate = climate;
this.category = category;
this.depth = depth;
this.scale = scale;
this.effects = effects;
this.gen = gen;
this.spawns = spawns;
}
public ResourceLocation getName()
{
return name;
}
public Biome.Climate getClimate()
{
return climate;
}
public void setClimate(final Biome.Climate value)
{
this.climate = value;
}
public Biome.Category getCategory()
{
return category;
}
public void setCategory(final Biome.Category value)
{
this.category = value;
}
public float getDepth()
{
return depth;
}
public void setDepth(final float value)
{
this.depth = value;
}
public float getScale()
{
return scale;
}
public void setScale(final float value)
{
this.scale = value;
}
public BiomeAmbience getEffects()
{
return effects;
}
public void setEffects(final BiomeAmbience value)
{
this.effects = value;
}
public BiomeGenerationSettingsBuilder getGeneration()
{
return gen;
}
public MobSpawnInfoBuilder getSpawns()
{
return spawns;
}
}