Change dimension ids into strings (eg: minecraft:overworld)

Author: NotStirred

chunky/src/java/se/llbit/chunky/map/WorldMapLoader.java

@@ -46,7 +46,7 @@ public class WorldMapLoader implements ChunkTopographyListener, ChunkViewListene
   private final ChunkTopographyUpdater topographyUpdater = new ChunkTopographyUpdater();
 
   /** The dimension to load in the current world. */
-  private int currentDimensionId = PersistentSettings.getDimension();
+  private String currentDimensionId = PersistentSettings.getDimension();
 
   private List<BiConsumer<World, Boolean>> worldLoadListeners = new ArrayList<>();
 
@@ -174,10 +174,11 @@ private void updateRegionChangeWatcher(Dimension dimension) {
   /**
    * Set the current dimension.
    *
-   * @param value Must be a valid dimension index (0, -1, 1)
+   * @param value Must be a valid dimension see {@link World#listDimensions()}
    */
-  public void setDimension(int value) {
-    if (value != currentDimensionId) {
+  // TODO: change this to show the available dimensions in the UI.
+  public void setDimension(String value) {
+    if (!value.equals(currentDimensionId)) {
       currentDimensionId = value;
       PersistentSettings.setDimension(currentDimensionId);
 
@@ -187,7 +188,7 @@ public void setDimension(int value) {
   }
 
   /** Get the currently loaded dimension. */
-  public int getDimension() {
+  public String getDimension() {
     return currentDimensionId;
   }
 }

chunky/src/java/se/llbit/chunky/renderer/scene/Scene.java

@@ -190,7 +190,7 @@ public class Scene implements JsonSerializable, Refreshable {
    */
   protected int rayDepth = PersistentSettings.getRayDepthDefault();
   protected String worldPath = "";
-  protected int worldDimension = 0;
+  protected String worldDimension = PersistentSettings.DEFAULT_DIMENSION;
   protected RenderMode mode = RenderMode.PREVIEW;
   protected int dumpFrequency = DEFAULT_DUMP_FREQUENCY;
   protected boolean saveSnapshots = false;
@@ -761,7 +761,7 @@ public synchronized void reloadChunks(TaskTracker taskTracker) {
       Log.warn("Can not reload chunks for scene - world directory not found!");
       return;
     }
-    loadedWorld = World.loadWorld(loadedWorld.getWorldDirectory(), worldDimension, World.LoggedWarnings.NORMAL);
+    loadedWorld.loadDimension(worldDimension);
     loadChunks(taskTracker, loadedWorld, chunks);
     refresh();
   }
@@ -794,7 +794,7 @@ public synchronized void loadChunks(TaskTracker taskTracker, World world, Collec
 
       loadedWorld = world;
       worldPath = loadedWorld.getWorldDirectory().getAbsolutePath();
-      worldDimension = world.currentDimensionId();
+      worldDimension = world.currentDimension().id();
 
       if (chunksToLoad.isEmpty()) {
         return;
@@ -2908,7 +2908,14 @@ else if(waterShader.equals("SIMPLEX"))
     if (json.get("world").isObject()) {
       JsonObject world = json.get("world").object();
       worldPath = world.get("path").stringValue(worldPath);
-      worldDimension = world.get("dimension").intValue(worldDimension);
+
+      String dimensionString = world.get("dimension").stringValue("");
+      if (dimensionString.isEmpty()) {
+        // legacy int-based dimension indices
+        worldDimension = JavaWorld.VANILLA_DIMENSION_IDX_TO_ID.get(world.get("dimension").intValue(0));
+      } else {
+        worldDimension = dimensionString;
+      }
     }
 
     if (json.get("camera").isObject()) {

chunky/src/java/se/llbit/chunky/ui/ChunkMap.java

@@ -585,7 +585,7 @@ private void drawPlayers(GraphicsContext gc) {
     World world = mapLoader.getWorld();
     double blockScale = mapView.scale / 16.;
     for (PlayerEntityData player : world.currentDimension().getPlayerPositions()) {
-      if (player.dimension == world.currentDimensionId()) {
+      if (player.dimension.equals(world.currentDimension().id())) {
         int px = (int) QuickMath.floor(player.x * blockScale);
         int py = (int) QuickMath.floor(player.y);
         int pz = (int) QuickMath.floor(player.z * blockScale);

chunky/src/java/se/llbit/chunky/world/CubicDimension.java

@@ -23,7 +23,7 @@ public class CubicDimension extends JavaDimension {
    * @param dimensionDirectory Minecraft world directory.
    * @param timestamp
    */
-  protected CubicDimension(JavaWorld world, int dimensionId, File dimensionDirectory, Set<PlayerEntityData> playerEntities, long timestamp) {
+  protected CubicDimension(JavaWorld world, String dimensionId, File dimensionDirectory, Set<PlayerEntityData> playerEntities, long timestamp) {
     super(world, dimensionId, dimensionDirectory, playerEntities, timestamp);
   }
 

chunky/src/java/se/llbit/chunky/world/Dimension.java

@@ -27,7 +27,7 @@ public abstract class Dimension {
 
   private final Heightmap heightmap = new Heightmap();
 
-  private final int dimensionId;
+  private final String dimensionId;
 
   private final Collection<ChunkDeletionListener> chunkDeletionListeners = new LinkedList<>();
   private final Collection<ChunkTopographyListener> chunkTopographyListeners = new LinkedList<>();
@@ -41,14 +41,14 @@ public abstract class Dimension {
   /**
    * @param timestamp
    */
-  protected Dimension(World world, int dimensionId, Set<PlayerEntityData> playerEntities, long timestamp) {
+  protected Dimension(World world, String dimensionId, Set<PlayerEntityData> playerEntities, long timestamp) {
     this.world = world;
     this.dimensionId = dimensionId;
     this.playerEntities = playerEntities;
     this.timestamp = timestamp;
   }
 
-  public int getDimensionId() {
+  public String id() {
     return dimensionId;
   }
 

chunky/src/java/se/llbit/chunky/world/EmptyDimension.java

@@ -15,7 +15,7 @@ public class EmptyDimension extends Dimension {
   public static final EmptyDimension INSTANCE = new EmptyDimension();
 
   private EmptyDimension() {
-    super(EmptyWorld.INSTANCE, 0, Collections.emptySet(), -1);
+    super(EmptyWorld.INSTANCE, World.OVERWORLD_DIMENSION_ID, Collections.emptySet(), -1);
   }
 
   @Override

chunky/src/java/se/llbit/chunky/world/EmptyWorld.java

@@ -21,6 +21,7 @@
 import java.io.File;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Optional;
 import java.util.Set;
 
 /**
@@ -39,12 +40,13 @@ private EmptyWorld() {
   }
 
   @Override
-  public Set<Integer> listDimensions() {
+  public Set<String> listDimensions() {
     return Collections.emptySet();
   }
 
   @Override
-  public Dimension loadDimension(int dimensionId) {
+  @Override
+  public EmptyDimension loadDimension(String dimension) {
     return EmptyDimension.INSTANCE;
   }
 

chunky/src/java/se/llbit/chunky/world/ImposterCubicChunk.java

@@ -113,7 +113,7 @@ private void loadSurfaceCubic(Map<Integer, Map<String, Tag>> data, ChunkData chu
 
     int[] heightmapData = extractHeightmapDataCubic(null, chunkData);
     updateHeightmap(heightmap, position, chunkData, heightmapData, palette, yMax);
-    surface = new SurfaceLayer(dimension.getDimensionId(), chunkData, palette, biomePalette, yMin, yMax, heightmapData);
+    surface = new SurfaceLayer(JavaWorld.VANILLA_DIMENSION_ID_TO_IDX.get(dimension.id()), chunkData, palette, biomePalette, yMin, yMax, heightmapData);
   }
 
   private int[] extractHeightmapDataCubic(Map<String, Tag> cubeData, ChunkData chunkData) {

chunky/src/java/se/llbit/chunky/world/JavaChunk.java

@@ -133,7 +133,7 @@ private void loadSurface(@NotNull Tag data, ChunkData chunkData, int yMin, int y
         int[] heightmapData = extractHeightmapData(data, chunkData);
         updateHeightmap(heightmap, position, chunkData, heightmapData, palette, yMax);
 
-        surface = new SurfaceLayer(dimension.getDimensionId(), chunkData, palette, biomePalette, yMin, yMax, heightmapData);
+        surface = new SurfaceLayer(JavaWorld.VANILLA_DIMENSION_ID_TO_IDX.get(dimension.id()), chunkData, palette, biomePalette, yMin, yMax, heightmapData);
         queueTopography();
       }
     } else {

chunky/src/java/se/llbit/chunky/world/JavaDimension.java

@@ -19,7 +19,7 @@ public class JavaDimension extends Dimension {
    * @param dimensionDirectory Minecraft world directory.
    * @param timestamp
    */
-  protected JavaDimension(JavaWorld world, int dimensionId, File dimensionDirectory, Set<PlayerEntityData> playerEntities, long timestamp) {
+  protected JavaDimension(JavaWorld world, String dimensionId, File dimensionDirectory, Set<PlayerEntityData> playerEntities, long timestamp) {
     super(world, dimensionId, playerEntities, timestamp);
     this.dimensionDirectory = dimensionDirectory;
   }