FabricMC/fabric
1
0
Fork 1
mirror of https://github.com/FabricMC/fabric.git synced 2025-03-13 16:53:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add FabricChunkGeneratorType (#305)

Browse source 
* added dimensions-v1 & FabricChunkGeneratorType

* documentation & fixed supplier type

* fix issues; move to fabric-world-v1

* Fix build and add register

* change string param to identifier

* Factory to inner class of Type; move to object builders module.

* reformat type class

* clean up javadocs

* delete world package

* fix settings.gradle accidental change

* Merge branch '1.14' + checkstyle fixes

* remove trailing whitespace in settings.gradle

* change package to pass checkstyle

* v1 -> v1.gen

* Update fabric-object-builders-v0/src/main/java/net/fabricmc/fabric/api/world/v1/gen/FabricChunkGeneratorType.java

Co-Authored-By: liach <7806504+liach@users.noreply.github.com>

* make factory field final

* update javadocs

Co-authored-by: Dinolek <18579460+Dinolek@users.noreply.github.com>
Co-authored-by: liach <7806504+liach@users.noreply.github.com>
This commit is contained in:
Draylar 2020-10-05 13:14:35 -05:00 committed by modmuss50
parent b125eefdec
commit e6e5d8150e
1 changed files with 79 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
fabric-object-builders-v0/src/main/java/net/fabricmc/fabric/api/world/v1/gen/FabricChunkGeneratorType.java Normal file
View file

@ -0,0 +1,79 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.fabricmc.fabric.api.world.v1.gen;
import java.util.function.Supplier;
import net.minecraft.util.Identifier;
import net.minecraft.util.registry.Registry;
import net.minecraft.world.World;
import net.minecraft.world.biome.source.BiomeSource;
import net.minecraft.world.gen.chunk.ChunkGenerator;
import net.minecraft.world.gen.chunk.ChunkGeneratorConfig;
import net.minecraft.world.gen.chunk.ChunkGeneratorType;
/**
* Wrapper class that allows for {@link ChunkGeneratorType} creation.
* The standard {@link ChunkGeneratorType} class constructor requires a {@link net.minecraft.world.gen.chunk.ChunkGeneratorFactory}, which is protected.
*
* @param <C> config of the {@link ChunkGenerator} stored by this type
* @param <T> {@link ChunkGenerator} stored by this type
*/
public final class FabricChunkGeneratorType<C extends ChunkGeneratorConfig, T extends ChunkGenerator<C>> extends ChunkGeneratorType<C, T> {
private final FabricChunkGeneratorFactory<C, T> factory;
private FabricChunkGeneratorType(FabricChunkGeneratorFactory<C, T> factory, boolean buffetScreenOption, Supplier<C> settingsSupplier) {
super(null, buffetScreenOption, settingsSupplier);
this.factory = factory;
}
/**
* Registers and returns a new instance of {@link ChunkGeneratorType}.
*
* @param id registry ID of the ChunkGeneratorType
* @param factory factory instance to provide a ChunkGenerator
* @param settingsSupplier config supplier
* @param buffetScreenOption whether or not the ChunkGeneratorType should appear in the buffet screen options page
*/
public static <C extends ChunkGeneratorConfig, T extends ChunkGenerator<C>> FabricChunkGeneratorType<C, T> register(Identifier id, FabricChunkGeneratorFactory<C, T> factory, Supplier<C> settingsSupplier, boolean buffetScreenOption) {
return Registry.register(Registry.CHUNK_GENERATOR_TYPE, id, new FabricChunkGeneratorType<>(factory, buffetScreenOption, settingsSupplier));
}
/**
* Creates and returns an instance of the ChunkGeneratorType's ChunkGenerator.
*
* @param world DimensionType's world instance
* @param biomeSource BiomeSource to use while generating the world
* @param config ChunkGenerator config instance
*/
@Override
public T create(World world, BiomeSource biomeSource, C config) {
return factory.create(world, biomeSource, config);
}
/**
* Responsible for creating the FabricChunkGeneratorType's ChunkGenerator instance.
* Called when a new instance of a ChunkGenerator is requested in {@link FabricChunkGeneratorType#create(World, BiomeSource, ChunkGeneratorConfig)}.
*
* @param <C> ChunkGeneratorConfig
* @param <T> ChunkGenerator
*/
@FunctionalInterface
public interface FabricChunkGeneratorFactory<C extends ChunkGeneratorConfig, T extends ChunkGenerator<C>> {
T create(World world, BiomeSource source, C config);
}
}