ServerWorldProperties.LoadOptions

Author: aromaa

src/main/java/org/spongepowered/api/world/server/WorldArchetypeType.java

@@ -0,0 +1,42 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.api.world.server;
+
+import org.spongepowered.api.world.WorldType;
+import org.spongepowered.api.world.generation.ChunkGenerator;
+
+public interface WorldArchetypeType {
+
+    WorldType worldType();
+
+    ChunkGenerator chunkGenerator();
+
+    interface Builder extends org.spongepowered.api.util.Builder<WorldArchetypeType, Builder> {
+
+        Builder worldType(WorldType worldType);
+
+        Builder chunkGenerator(ChunkGenerator chunkGenerator);
+    }
+}

src/main/java/org/spongepowered/api/world/server/WorldManager.java

@@ -123,9 +123,20 @@ default List<ResourceKey> offlineWorldKeys() {
      * <p>If a world with the given name is already loaded then it is returned instead.</p>
      *
      * @param key The key
-     * @return The world
+     * @return The world, if found.
      */
-    CompletableFuture<ServerWorld> loadWorld(ResourceKey key);
+    CompletableFuture<Optional<ServerWorld>> loadWorld(ResourceKey key);
+
+    /**
+     * Loads a {@link ServerWorld world} by a {@link ResourceKey key}.
+     *
+     * <p>If a world with the given name is already loaded then it is returned instead.</p>
+     *
+     * @param key The key
+     * @param propertiesLoadOptions The options used to load the {@link ServerWorldProperties properties}.
+     * @return The world, if found.
+     */
+    CompletableFuture<Optional<ServerWorld>> loadWorld(ResourceKey key, ServerWorldProperties.LoadOptions propertiesLoadOptions);
 
     /**
      * Unloads a {@link ServerWorld world} by a {@link ResourceKey key}.
@@ -159,6 +170,17 @@ default List<ResourceKey> offlineWorldKeys() {
      */
     CompletableFuture<Optional<ServerWorldProperties>> loadProperties(ResourceKey key);
 
+    /**
+     * Loads an offline {@link ServerWorldProperties properties}.
+     *
+     * <p>It is left up to the implementation on what conditions cause a failure of loading properties.</p>
+     *
+     * @param key The key
+     * @param propertiesLoadOptions The options used to load the {@link ServerWorldProperties properties}.
+     * @return The properties
+     */
+    CompletableFuture<Optional<ServerWorldProperties>> loadProperties(ResourceKey key, ServerWorldProperties.LoadOptions propertiesLoadOptions);
+
     /**
      * Saves a {@link ServerWorldProperties properties}.
      *

src/main/java/org/spongepowered/api/world/server/storage/ServerWorldProperties.java

@@ -43,13 +43,15 @@
 import org.spongepowered.api.world.gamerule.GameRuleHolder;
 import org.spongepowered.api.world.generation.config.WorldGenerationConfig;
 import org.spongepowered.api.world.server.ServerWorld;
+import org.spongepowered.api.world.server.WorldArchetypeType;
 import org.spongepowered.api.world.storage.WorldProperties;
 import org.spongepowered.api.world.weather.Weather;
 import org.spongepowered.api.world.weather.WeatherUniverse;
 
 import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
+import java.util.function.Consumer;
 
 public interface ServerWorldProperties extends WorldProperties, GameRuleHolder, Nameable, Identifiable, ResourceKeyed, WeatherUniverse.Mutable {
 
@@ -373,4 +375,40 @@ default WorldBorder worldBorder() {
     default Weather weather() {
         return this.require(Keys.WEATHER);
     }
+
+    interface LoadOptions {
+
+        FoundOptions foundOptions();
+
+        Optional<CreateOptions> createOptions();
+
+        interface FoundOptions {
+
+            Optional<Consumer<ServerWorldProperties>> loadCallback();
+        }
+
+        interface CreateOptions {
+
+            WorldArchetypeType worldArchetype();
+
+            Optional<Consumer<ServerWorldProperties>> initializeCallback();
+        }
+
+        interface Builder extends org.spongepowered.api.util.Builder<LoadOptions, Builder> {
+
+            Builder.LoadStep load();
+
+            Builder.CreateStep create(WorldArchetypeType worldArchetype);
+
+            interface LoadStep extends Builder {
+
+                LoadStep loadCallback(Consumer<ServerWorldProperties> loadCallback);
+            }
+
+            interface CreateStep extends Builder {
+
+                CreateStep initializeCallback(Consumer<ServerWorldProperties> initializeCallback);
+            }
+        }
+    }
 }