cn.nukkit.level.format.LevelProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powernukkitx Show documentation
Make Nukkit great again!
There is a newer version: 1.20.40-r1
package cn.nukkit.level.format;

import cn.nukkit.api.PowerNukkitOnly;
import cn.nukkit.api.PowerNukkitXOnly;
import cn.nukkit.api.Since;
import cn.nukkit.level.DimensionEnum;
import cn.nukkit.level.GameRules;
import cn.nukkit.level.Level;
import cn.nukkit.level.format.generic.BaseFullChunk;
import cn.nukkit.level.generator.Generator;
import cn.nukkit.math.Vector3;
import cn.nukkit.scheduler.AsyncTask;

import java.util.Map;

/**
 * @author MagicDroidX (Nukkit Project)
 */
public interface LevelProvider {
    byte ORDER_YZX = 0;
    byte ORDER_ZXY = 1;

    AsyncTask requestChunkTask(int X, int Z);

    String getPath();

    String getGenerator();

    Map getGeneratorOptions();

    BaseFullChunk getLoadedChunk(int X, int Z);

    BaseFullChunk getLoadedChunk(long hash);

    BaseFullChunk getChunk(int X, int Z);

    BaseFullChunk getChunk(int X, int Z, boolean create);

    BaseFullChunk getEmptyChunk(int x, int z);

    void saveChunks();

    void saveChunk(int X, int Z);

    void saveChunk(int X, int Z, FullChunk chunk);

    void unloadChunks();

    boolean loadChunk(int X, int Z);

    boolean loadChunk(int X, int Z, boolean create);

    boolean unloadChunk(int X, int Z);

    boolean unloadChunk(int X, int Z, boolean safe);

    boolean isChunkGenerated(int X, int Z);

    boolean isChunkPopulated(int X, int Z);

    boolean isChunkLoaded(int X, int Z);

    boolean isChunkLoaded(long hash);

    void setChunk(int chunkX, int chunkZ, FullChunk chunk);

    String getName();

    boolean isRaining();

    void setRaining(boolean raining);

    int getRainTime();

    void setRainTime(int rainTime);

    boolean isThundering();

    void setThundering(boolean thundering);

    int getThunderTime();

    void setThunderTime(int thunderTime);

    long getCurrentTick();

    void setCurrentTick(long currentTick);

    long getTime();

    void setTime(long value);

    long getSeed();

    void setSeed(long value);

    Vector3 getSpawn();

    void setSpawn(Vector3 pos);

    Map getLoadedChunks();

    void doGarbageCollection();

    default void doGarbageCollection(long time) {

    }

    Level getLevel();

    void close();

    void saveLevelData();

    void updateLevelName(String name);

    GameRules getGamerules();

    void setGameRules(GameRules rules);

    @PowerNukkitOnly
    default int getMaximumLayer() {
        return 0;
    }

    @PowerNukkitXOnly
    @Since("1.6.0.0-PNX")
    default int getDimension() {
        if (this instanceof DimensionDataProvider dimensionDataProvider) {
            var dimData = dimensionDataProvider.getDimensionData();
            if (dimData != null) {
                return dimData.getDimensionId();
            }
        }
        final var level = getLevel();
        if (level != null) {
            return getLevel().getDimension();
        } else {
            switch (getGenerator()) {
                case "normal":
                case "terra": {
                    if (getGeneratorOptions().containsKey("preset")) {
                        var opts = getGeneratorOptions().get("preset").toString().split(":");
                        if (opts.length == 2) {
                            return DimensionEnum.valueOf(opts[1].toUpperCase()).ordinal();
                        }
                    }
                    return Level.DIMENSION_OVERWORLD;
                }
                case "nether":
                    return Level.DIMENSION_NETHER;
                case "the_end":
                    return Level.DIMENSION_THE_END;
            }
            final var type = Generator.getGeneratorType(Generator.getGenerator(getGenerator()));
            return switch (type) {
                case Generator.TYPE_NETHER -> Level.DIMENSION_NETHER;
                case Generator.TYPE_THE_END -> Level.DIMENSION_THE_END;
                default -> Level.DIMENSION_OVERWORLD;
            };
        }
    }

    @PowerNukkitXOnly
    @Since("1.6.0.0-PNX")//todo: have problem in async environment (nullpointer)
    default boolean isOverWorld() {
        return getDimension() == 0;
    }

    @PowerNukkitXOnly
    @Since("1.6.0.0-PNX")//todo: have problem in async environment (nullpointer)
    default boolean isNether() {
        return getDimension() == 1;
    }

    @PowerNukkitXOnly
    @Since("1.6.0.0-PNX")//todo: have problem in async environment (nullpointer)
    default boolean isTheEnd() {
        return getDimension() == 2;
    }
}