Fix level-data spawn format and remove concept of spawn-location from a World (=> Dimension)

Author: TBlueF

common/src/main/java/de/bluecolored/bluemap/common/commands/commands/DebugCommand.java

@@ -26,7 +26,6 @@
 
 import com.flowpowered.math.vector.Vector2i;
 import com.flowpowered.math.vector.Vector3d;
-import com.flowpowered.math.vector.Vector3i;
 import de.bluecolored.bluecommands.annotations.Argument;
 import de.bluecolored.bluecommands.annotations.Command;
 import de.bluecolored.bluemap.common.BlueMapService;
@@ -103,7 +102,6 @@ public Component block(CommandSource source, World world, @Argument("x") int x,
 
         Chunk chunk = world.getChunkAtBlock(x, z);
         LightData lightData = chunk.getLightData(x, y, z, new LightData(0, 0));
-        Vector3i spawnPoint = world.getSpawnPoint();
 
         return paragraph("World-Info (debug)", lines(
                 item("position", format("( x: % | y: % | z: % )",
@@ -138,12 +136,7 @@ public Component block(CommandSource source, World world, @Argument("x") int x,
                         .append(details(BASE_COLOR,
                                 item("name", world.getName()),
                                 item("min-y", world.getDimensionType().getMinY()),
-                                item("height", world.getDimensionType().getHeight()),
-                                item("spawn", format("( x: % | y: % | z: % )",
-                                        text(spawnPoint.getX()).color(HIGHLIGHT_COLOR),
-                                        text(spawnPoint.getY()).color(HIGHLIGHT_COLOR),
-                                        text(spawnPoint.getZ()).color(HIGHLIGHT_COLOR)
-                                ))
+                                item("height", world.getDimensionType().getHeight())
                         ))
                 )
         ));

common/src/main/java/de/bluecolored/bluemap/common/config/MapConfig.java

@@ -60,7 +60,7 @@ public class MapConfig implements MapSettings {
 
     private int sorting = 0;
 
-    @Nullable private Vector2i startPos = null;
+    private Vector2i startPos = Vector2i.ZERO;
 
     private String skyColor = "#7dabff";
     private String voidColor = "#000000";

common/src/main/java/de/bluecolored/bluemap/common/rendermanager/MapUpdatePreparationTask.java

@@ -112,14 +112,8 @@ private Collection<RenderTask> createTasks(Collection<Vector2i> regions) {
         ArrayList<WorldRegionRenderTask> regionTasks = new ArrayList<>(regions.size());
         regions.forEach(region -> regionTasks.add(new WorldRegionRenderTask(map, region, force)));
 
-        // get spawn region
-        World world = map.getWorld();
-        Vector2i spawnPoint = world.getSpawnPoint().toVector2(true);
-        Grid regionGrid = world.getRegionGrid();
-        Vector2i spawnRegion = regionGrid.getCell(spawnPoint);
-
-        // sort tasks by distance to the spawn region
-        regionTasks.sort(WorldRegionRenderTask.defaultComparator(spawnRegion));
+        // sort tasks by distance to 0/0
+        regionTasks.sort(WorldRegionRenderTask.defaultComparator(Vector2i.ZERO));
 
         // save map before and after the whole update
         ArrayList<RenderTask> tasks = new ArrayList<>(regionTasks.size() + 2);

core/src/main/java/de/bluecolored/bluemap/core/map/MapSettings.java

@@ -32,7 +32,7 @@ public interface MapSettings extends RenderSettings {
 
     int getSorting();
 
-    @Nullable Vector2i getStartPos();
+    Vector2i getStartPos();
 
     String getSkyColor();
 

core/src/main/java/de/bluecolored/bluemap/core/map/MapSettingsSerializer.java

@@ -33,7 +33,6 @@
 import de.bluecolored.bluemap.core.util.math.Color;
 
 import java.lang.reflect.Type;
-import java.util.Optional;
 
 public class MapSettingsSerializer implements JsonSerializer<BmMap> {
 
@@ -67,9 +66,7 @@ public JsonElement serialize(BmMap map, Type typeOfSrc, JsonSerializationContext
         root.add("lowres", lowres);
 
         // startPos
-        Vector2i startPos = Optional.ofNullable(map.getMapSettings().getStartPos())
-                .orElse(map.getWorld().getSpawnPoint().toVector2(true));
-        root.add("startPos", context.serialize(startPos));
+        root.add("startPos", context.serialize(map.getMapSettings().getStartPos()));
 
         // skyColor
         Color skyColor = new Color().parse(map.getMapSettings().getSkyColor());

core/src/main/java/de/bluecolored/bluemap/core/world/World.java

@@ -49,8 +49,6 @@ public interface World {
 
     String getName();
 
-    Vector3i getSpawnPoint();
-
     DimensionType getDimensionType();
 
     Grid getChunkGrid();

core/src/main/java/de/bluecolored/bluemap/core/world/mca/MCAUtil.java

@@ -27,6 +27,7 @@
 import com.flowpowered.math.vector.Vector2f;
 import com.flowpowered.math.vector.Vector2i;
 import com.flowpowered.math.vector.Vector3d;
+import com.flowpowered.math.vector.Vector3i;
 import de.bluecolored.bluemap.core.util.Key;
 import de.bluecolored.bluemap.core.world.BlockEntity;
 import de.bluecolored.bluemap.core.world.BlockState;
@@ -53,6 +54,7 @@ public static BlueNBT addCommonNbtSettings(BlueNBT nbt) {
         nbt.register(TypeToken.of(Key.class), new KeyDeserializer());
         nbt.register(TypeToken.of(UUID.class), new UUIDDeserializer());
         nbt.register(TypeToken.of(Vector3d.class), new Vector3dDeserializer());
+        nbt.register(TypeToken.of(Vector3i.class), new Vector3iDeserializer());
         nbt.register(TypeToken.of(Vector2i.class), new Vector2iDeserializer());
         nbt.register(TypeToken.of(Vector2f.class), new Vector2fDeserializer());
 

core/src/main/java/de/bluecolored/bluemap/core/world/mca/MCAWorld.java

@@ -63,7 +63,6 @@ public class MCAWorld implements World {
     private final LevelData levelData;
 
     private final DimensionType dimensionType;
-    private final Vector3i spawnPoint;
     private final Path dimensionFolder;
 
     private final ChunkGrid<Chunk> blockChunkGrid;
@@ -89,11 +88,6 @@ private MCAWorld(Path worldFolder, Key dimension, DataPack dataPack, LevelData l
         }
 
         this.dimensionType = dimensionData.getType();
-        this.spawnPoint = new Vector3i(
-                levelData.getData().getSpawnX(),
-                levelData.getData().getSpawnY(),
-                levelData.getData().getSpawnZ()
-        );
         this.dimensionFolder = resolveDimensionFolder(worldFolder, dimension);
 
         this.blockChunkGrid = new ChunkGrid<>(new MCAChunkLoader(this), dimensionFolder.resolve("region"));

core/src/main/java/de/bluecolored/bluemap/core/world/mca/data/LevelData.java

@@ -24,8 +24,12 @@
  */
 package de.bluecolored.bluemap.core.world.mca.data;
 
+import com.flowpowered.math.vector.Vector3i;
+import de.bluecolored.bluemap.core.resources.pack.datapack.DataPack;
+import de.bluecolored.bluemap.core.util.Key;
 import de.bluecolored.bluemap.core.world.DimensionType;
 import de.bluecolored.bluenbt.NBTName;
+import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -46,17 +50,30 @@ public static class Data {
         @NBTName("LevelName")
         private String levelName = "world";
 
+        private Spawn spawn = null;
+
+        @NBTName("WorldGenSettings")
+        private WGSettings worldGenSettings = new WGSettings();
+
+        // legacy-spawn notation
         @NBTName("SpawnX")
+        @Getter(AccessLevel.NONE)
         private int spawnX = 0;
 
         @NBTName("SpawnY")
+        @Getter(AccessLevel.NONE)
         private int spawnY = 0;
 
         @NBTName("SpawnZ")
+        @Getter(AccessLevel.NONE)
         private int spawnZ = 0;
 
-        @NBTName("WorldGenSettings")
-        private WGSettings worldGenSettings = new WGSettings();
+        public Spawn getSpawn() {
+            if (spawn == null) {
+                spawn = new Spawn(new Vector3i(spawnX, spawnY, spawnZ));
+            }
+            return spawn;
+        }
 
     }
 
@@ -72,4 +89,20 @@ public static class Dimension {
         private DimensionType type = DimensionType.OVERWORLD;
     }
 
+    @Getter
+    @NoArgsConstructor
+    @AllArgsConstructor
+    public static class Spawn {
+
+        private Key dimension = DataPack.DIMENSION_OVERWORLD;
+        private Vector3i position = Vector3i.ZERO;
+        private float yaw = 0;
+        private float pitch = 0;
+
+        public Spawn(Vector3i position) {
+            this.position = position;
+        }
+
+    }
+
 }

core/src/main/java/de/bluecolored/bluemap/core/world/mca/data/Vector3iDeserializer.java

@@ -0,0 +1,83 @@
+/*
+ * This file is part of BlueMap, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) Blue (Lukas Rieger) <https://bluecolored.de>
+ * 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 de.bluecolored.bluemap.core.world.mca.data;
+
+import com.flowpowered.math.vector.Vector3i;
+import de.bluecolored.bluenbt.NBTReader;
+import de.bluecolored.bluenbt.TagType;
+import de.bluecolored.bluenbt.TypeDeserializer;
+
+import java.io.IOException;
+
+public class Vector3iDeserializer implements TypeDeserializer<Vector3i> {
+
+    @Override
+    public Vector3i read(NBTReader reader) throws IOException {
+        TagType tag = reader.peek();
+
+        return switch (tag) {
+
+            case INT_ARRAY, LONG_ARRAY, BYTE_ARRAY -> {
+                long[] values = reader.nextArrayAsLongArray();
+                if (values.length != 3) throw new IllegalStateException("Unexpected array length: " + values.length);
+                yield new Vector3i(
+                        values[0],
+                        values[1],
+                        values[2]
+                );
+            }
+
+            case LIST -> {
+                reader.beginList();
+                Vector3i value = new Vector3i(
+                        reader.nextInt(),
+                        reader.nextInt(),
+                        reader.nextInt()
+                );
+                reader.endList();
+                yield value;
+            }
+
+            case COMPOUND -> {
+                int x = 0, y = 0, z = 0;
+                reader.beginCompound();
+                while (reader.peek() != TagType.END) {
+                    switch (reader.name()) {
+                        case "x" -> x = reader.nextInt();
+                        case "y" -> y = reader.nextInt();
+                        case "z" -> z = reader.nextInt();
+                        default -> reader.skip();
+                    }
+                }
+                reader.endCompound();
+                yield new Vector3i(x, y, z);
+            }
+
+            case null, default -> throw new IllegalStateException("Unexpected tag-type: " + tag);
+
+        };
+    }
+
+}