Deprecated Server.createWorld() methods, use "WorldCreator.name(x).seed(1234).createWorld()" now

By: Dinnerbone <dinnerbone@dinnerbone.com>

paper-api/src/main/java/org/bukkit/Bukkit.java

@@ -130,22 +130,30 @@ public final class Bukkit {
         return server.getWorlds();
     }
 
+    @Deprecated
     public static World createWorld(String name, Environment environment) {
         return server.createWorld(name, environment);
     }
 
+    @Deprecated
     public static World createWorld(String name, Environment environment, long seed) {
         return server.createWorld(name, environment, seed);
     }
 
+    @Deprecated
     public static World createWorld(String name, Environment environment, ChunkGenerator generator) {
         return server.createWorld(name, environment, generator);
     }
 
+    @Deprecated
     public static World createWorld(String name, Environment environment, long seed, ChunkGenerator generator) {
         return server.createWorld(name, environment, seed, generator);
     }
 
+    public static World createWorld(WorldCreator options) {
+        return server.createWorld(options);
+    }
+
     public static boolean unloadWorld(String name, boolean save) {
         return server.unloadWorld(name, save);
     }

paper-api/src/main/java/org/bukkit/Server.java

@@ -218,7 +218,9 @@ public interface Server {
      * @param name Name of the world to load
      * @param environment Environment type of the world
      * @return Newly created or loaded World
+     * @deprecated Use {@link #createWorld(org.bukkit.WorldCreator)}
      */
+    @Deprecated
     public World createWorld(String name, World.Environment environment);
 
     /**
@@ -230,7 +232,9 @@ public interface Server {
      * @param environment Environment type of the world
      * @param seed Seed value to create the world with
      * @return Newly created or loaded World
+     * @deprecated Use {@link #createWorld(org.bukkit.WorldCreator)}
      */
+    @Deprecated
     public World createWorld(String name, World.Environment environment, long seed);
 
     /**
@@ -242,7 +246,9 @@ public interface Server {
      * @param environment Environment type of the world
      * @param generator ChunkGenerator to use in the construction of the new world
      * @return Newly created or loaded World
+     * @deprecated Use {@link #createWorld(org.bukkit.WorldCreator)}
      */
+    @Deprecated
     public World createWorld(String name, World.Environment environment, ChunkGenerator generator);
 
     /**
@@ -255,9 +261,22 @@ public interface Server {
      * @param seed Seed value to create the world with
      * @param generator ChunkGenerator to use in the construction of the new world
      * @return Newly created or loaded World
+     * @deprecated Use {@link #createWorld(org.bukkit.WorldCreator)}
      */
+    @Deprecated
     public World createWorld(String name, World.Environment environment, long seed, ChunkGenerator generator);
 
+    /**
+     * Creates or loads a world with the given name using the specified options.
+     * <p>
+     * If the world is already loaded, it will just return the equivalent of
+     * getWorld(creator.name()).
+     *
+     * @param options Options to use when creating the world
+     * @return Newly created or loaded world
+     */
+    public World createWorld(WorldCreator creator);
+
      /**
      * Unloads a world with the given name.
      *

paper-api/src/main/java/org/bukkit/WorldCreator.java

@@ -0,0 +1,246 @@
+package org.bukkit;
+
+import java.util.Random;
+import org.bukkit.command.CommandSender;
+import org.bukkit.generator.ChunkGenerator;
+import org.bukkit.plugin.Plugin;
+
+/**
+ * Represents various types of options that may be used to create a world.
+ */
+public class WorldCreator {
+    private final String name;
+    private long seed;
+    private World.Environment environment = World.Environment.NORMAL;
+    private ChunkGenerator generator = null;
+
+    /**
+     * Creates an empty WorldCreationOptions for the given world name
+     *
+     * @param name Name of the world that will be created
+     */
+    public WorldCreator(String name) {
+        if (name == null) {
+            throw new IllegalArgumentException("World name cannot be null");
+        }
+
+        this.name = name;
+        this.seed = (new Random()).nextLong();
+    }
+
+    /**
+     * Copies the options from the specified world
+     *
+     * @param world World to copy options from
+     * @return This object, for chaining
+     */
+    public WorldCreator copy(World world) {
+        if (world == null) {
+            throw new IllegalArgumentException("World cannot be null");
+        }
+
+        seed = world.getSeed();
+        environment = world.getEnvironment();
+        generator = world.getGenerator();
+
+        return this;
+    }
+
+    /**
+     * Copies the options from the specified {@link WorldCreator}
+     *
+     * @param creator World creator to copy options from
+     * @return This object, for chaining
+     */
+    public WorldCreator copy(WorldCreator creator) {
+        if (creator == null) {
+            throw new IllegalArgumentException("Creator cannot be null");
+        }
+
+        seed = creator.seed();
+        environment = creator.environment();
+        generator = creator.generator();
+
+        return this;
+    }
+
+    /**
+     * Gets the name of the world that is to be loaded or created.
+     *
+     * @return World name
+     */
+    public String name() {
+        return name;
+    }
+
+    /**
+     * Gets the seed that will be used to create this world
+     *
+     * @return World seed
+     */
+    public long seed() {
+        return seed;
+    }
+
+    /**
+     * Sets the seed that will be used to create this world
+     *
+     * @param seed World seed
+     * @return This object, for chaining
+     */
+    public WorldCreator seed(long seed) {
+        this.seed = seed;
+
+        return this;
+    }
+
+    /**
+     * Gets the environment that will be used to create or load the world
+     *
+     * @return World environment
+     */
+    public World.Environment environment() {
+        return environment;
+    }
+
+    /**
+     * Sets the environment that will be used to create or load the world
+     *
+     * @param env World environment
+     * @return This object, for chaining
+     */
+    public WorldCreator environment(World.Environment env) {
+        this.environment = env;
+
+        return this;
+    }
+
+    /**
+     * Gets the generator that will be used to create or load the world.
+     * <p>
+     * This may be null, in which case the "natural" generator for this environment
+     * will be used.
+     *
+     * @return Chunk generator
+     */
+    public ChunkGenerator generator() {
+        return generator;
+    }
+
+    /**
+     * Sets the generator that will be used to create or load the world.
+     * <p>
+     * This may be null, in which case the "natural" generator for this environment
+     * will be used.
+     *
+     * @param env Chunk generator
+     * @return This object, for chaining
+     */
+    public WorldCreator generator(ChunkGenerator generator) {
+        this.generator = generator;
+
+        return this;
+    }
+
+    /**
+     * Sets the generator that will be used to create or load the world.
+     * <p>
+     * This may be null, in which case the "natural" generator for this environment
+     * will be used.
+     * <p>
+     * If the generator cannot be found for the given name, the natural environment generator
+     * will be used instead and a warning will be printed to the console.
+     *
+     * @param generator Name of the generator to use, in "plugin:id" notation
+     * @return This object, for chaining
+     */
+    public WorldCreator generator(String generator) {
+        this.generator = getGeneratorForName(name, generator, Bukkit.getConsoleSender());
+
+        return this;
+    }
+
+    /**
+     * Sets the generator that will be used to create or load the world.
+     * <p>
+     * This may be null, in which case the "natural" generator for this environment
+     * will be used.
+     * <p>
+     * If the generator cannot be found for the given name, the natural environment generator
+     * will be used instead and a warning will be printed to the specified output
+     *
+     * @param generator Name of the generator to use, in "plugin:id" notation
+     * @param output {@link CommandSender} that will receive any error messages
+     * @return This object, for chaining
+     */
+    public WorldCreator generator(String generator, CommandSender output) {
+        this.generator = getGeneratorForName(name, generator, output);
+
+        return this;
+    }
+
+    /**
+     * Creates a world with the specified options.
+     * <p>
+     * If the world already exists, it will be loaded from disk and some options
+     * may be ignored.
+     *
+     * @return Newly created or loaded world
+     */
+    public World createWorld() {
+        return Bukkit.createWorld(this);
+    }
+
+    /**
+     * Creates a new {@link WorldCreator} for the given world name
+     *
+     * @param name Name of the world to load or create
+     * @return Resulting WorldCreator
+     */
+    public static WorldCreator name(String name) {
+        return new WorldCreator(name);
+    }
+
+    /**
+     * Attempts to get the {@link ChunkGenerator} with the given name.
+     * <p>
+     * If the generator is not found, null will be returned and a message will be
+     * printed to the specified {@link CommandSender} explaining why.
+     * <p>
+     * The name must be in the "plugin:id" notation, or optionally just "plugin",
+     * where "plugin" is the safe-name of a plugin and "id" is an optional unique
+     * identifier for the generator you wish to request from the plugin.
+     *
+     * @param world Name of the world this will be used for
+     * @param name Name of the generator to retrieve
+     * @param output Where to output if errors are present
+     * @return Resulting generator, or null
+     */
+    public static ChunkGenerator getGeneratorForName(String world, String name, CommandSender output) {
+        ChunkGenerator result = null;
+
+        if (world == null) {
+            throw new IllegalArgumentException("World name must be specified");
+        }
+
+        if (output == null) {
+            output = Bukkit.getConsoleSender();
+        }
+        
+        if (name != null) {
+            String[] split = name.split(":", 2);
+            String id = (split.length > 1) ? split[1] : null;
+            Plugin plugin = Bukkit.getPluginManager().getPlugin(split[0]);
+
+            if (plugin == null) {
+                output.sendMessage("Could not set generator for world '" + world + "': Plugin '" + split[0] + "' does not exist");
+            } else if (!plugin.isEnabled()) {
+                output.sendMessage("Could not set generator for world '" + world + "': Plugin '" + plugin.getDescription().getFullName() + "' is not enabled");
+            } else {
+                result = plugin.getDefaultWorldGenerator(world, id);
+            }
+        }
+
+        return result;
+    }
+}