121 lines
4.0 KiB
Java
121 lines
4.0 KiB
Java
/*
|
|
* PlotSquared, a land and world management plugin for Minecraft.
|
|
* Copyright (C) IntellectualSites <https://intellectualsites.com>
|
|
* Copyright (C) IntellectualSites team and contributors
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
package com.plotsquared.core.generator;
|
|
|
|
import com.plotsquared.core.PlotSquared;
|
|
import com.plotsquared.core.plot.PlotArea;
|
|
import com.plotsquared.core.plot.PlotId;
|
|
import com.plotsquared.core.queue.ZeroedDelegateScopedQueueCoordinator;
|
|
import com.plotsquared.core.setup.PlotAreaBuilder;
|
|
import com.sk89q.worldedit.world.biome.BiomeType;
|
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
|
|
|
/**
|
|
* This class allows for implementation independent world generation.
|
|
* - Sponge/Bukkit API
|
|
* Use the specify method to get the generator for that platform.
|
|
*/
|
|
public abstract class IndependentPlotGenerator {
|
|
|
|
/**
|
|
* Get the name of this generator.
|
|
*
|
|
* @return generator name
|
|
*/
|
|
public abstract String getName();
|
|
|
|
/**
|
|
* Generate chunk block data
|
|
*
|
|
* @param result Queue to write to
|
|
* @param settings PlotArea (settings)
|
|
* @param biomes If biomes should be generated
|
|
* @since TODO
|
|
*/
|
|
public abstract void generateChunk(ZeroedDelegateScopedQueueCoordinator result, PlotArea settings, boolean biomes);
|
|
|
|
/**
|
|
* Populate a chunk-queue with tile entities, entities, etc.
|
|
*
|
|
* @param result Queue to write to
|
|
* @param setting PlotArea (settings)
|
|
* @since TODO
|
|
*/
|
|
public void populateChunk(ZeroedDelegateScopedQueueCoordinator result, PlotArea setting) {
|
|
}
|
|
|
|
/**
|
|
* Return a new PlotArea object.
|
|
*
|
|
* @param world world name
|
|
* @param id (May be null) Area name
|
|
* @param min Min plot id (may be null)
|
|
* @param max Max plot id (may be null)
|
|
* @return new plot area
|
|
*/
|
|
public abstract PlotArea getNewPlotArea(String world, String id, PlotId min, PlotId max);
|
|
|
|
/**
|
|
* If any additional setup options need to be changed before world creation.
|
|
* - e.g. If setup doesn't support some standard options
|
|
*
|
|
* @param builder the area builder to modify
|
|
*/
|
|
public void processAreaSetup(PlotAreaBuilder builder) {
|
|
}
|
|
|
|
/**
|
|
* It is preferred for the PlotArea object to do most of the initialization necessary.
|
|
*
|
|
* @param area area
|
|
*/
|
|
public abstract void initialize(PlotArea area);
|
|
|
|
/**
|
|
* Get the generator for your specific implementation (bukkit/sponge).<br>
|
|
* - e.g. YourIndependentGenerator.<ChunkGenerator>specify() - Would return a ChunkGenerator object<br>
|
|
*
|
|
* @param <T> world
|
|
* @param world ChunkGenerator Implementation
|
|
* @return Chunk generator
|
|
*/
|
|
@SuppressWarnings("unchecked")
|
|
public <T> GeneratorWrapper<T> specify(final @NonNull String world) {
|
|
return (GeneratorWrapper<T>) PlotSquared.platform().wrapPlotGenerator(world, this);
|
|
}
|
|
|
|
/**
|
|
* Get the biome to be generated at a specific point
|
|
*
|
|
* @param settings PlotArea settings to provide biome
|
|
* @param x World x position
|
|
* @param y World y position
|
|
* @param z World z position
|
|
* @return Biome type to be generated
|
|
* @since TODO
|
|
*/
|
|
public abstract BiomeType getBiome(PlotArea settings, int x, int y, int z);
|
|
|
|
@Override
|
|
public String toString() {
|
|
return getName();
|
|
}
|
|
|
|
}
|