refactor: replace Dimension::Type enum with DimensionId identifier (#371)

* refactor: replace Dimension::Type enum with DimensionId identifier

Replace the fixed Dimension::Type enum (Overworld/Nether/TheEnd/Custom) with
DimensionId (Identifier<Dimension>) to support custom dimensions with namespaced
identifiers. Dimension no longer inherits from Registry — dimensions are accessed
via Level::getDimension(DimensionId) instead of a global registry lookup.

* fix: update type annotations for Dimension constants in __init__.pyi

* test: add dimension tests and update existing tests for DimensionId

Add test_dimension.py covering DimensionId constants, lookup, properties,
and level back-reference. Update test_server.py and test_object.py to use
Dimension.OVERWORLD/NETHER/THE_END instead of raw name strings.

* refactor: remove Dimension::getName() in favor of getId()

With DimensionId available via getId(), the separate getName() is redundant.
All usages now use getId() which returns the namespaced identifier.

Author: wu-vincent

endstone/level/__init__.pyi

@@ -1,4 +1,3 @@
-import enum
 import typing
 
 from endstone.actor import Actor, Item
@@ -35,9 +34,9 @@ class Level:
         Gets a list of all dimensions within this level.
         """
         ...
-    def get_dimension(self, name: str) -> Dimension:
+    def get_dimension(self, id: str) -> Dimension:
         """
-        Gets the dimension with the given name.
+        Gets the dimension with the given id.
         """
         ...
     @property
@@ -51,30 +50,20 @@ class Dimension:
     """
     Represents a dimension within a Level.
     """
-    class Type(enum.Enum):
-        """
-        Represents various dimension types.
-        """
 
-        OVERWORLD = 0
-        NETHER = 1
-        THE_END = 2
-        CUSTOM = 999
-
-    OVERWORLD = Type.OVERWORLD
-    NETHER = Type.NETHER
-    THE_END = Type.THE_END
-    CUSTOM = Type.CUSTOM
+    OVERWORLD = "minecraft:overworld"
+    NETHER = "minecraft:nether"
+    THE_END = "minecraft:the_end"
     @property
-    def name(self) -> str:
+    def id(self) -> str:
         """
-        Gets the name of this dimension
+        Gets the identifier of this dimension
         """
         ...
     @property
-    def type(self) -> Type:
+    def translation_key(self) -> str:
         """
-        Gets the type of this dimension
+        Gets the translation key for this dimension
         """
         ...
     @property

include/endstone/level/dimension.h

@@ -21,41 +21,39 @@
 #include "endstone/actor/actor.h"
 #include "endstone/actor/item.h"
 #include "endstone/block/block.h"
+#include "endstone/identifier.h"
 #include "endstone/inventory/item_stack.h"
 #include "endstone/level/chunk.h"
 
 namespace endstone {
 
+class Dimension;
+using DimensionId = Identifier<Dimension>;
+
 /**
  * @brief Represents a dimension within a Level.
  */
 class Dimension {
 public:
-    /**
-     * @brief Represents various dimension types.
-     */
-    enum class Type {
-        Overworld = 0,
-        Nether = 1,
-        TheEnd = 2,
-        Custom = 999
-    };
+    static constexpr auto Overworld = DimensionId::minecraft("overworld");
+    static constexpr auto Nether = DimensionId::minecraft("nether");
+    static constexpr auto TheEnd = DimensionId::minecraft("the_end");
 
     virtual ~Dimension() = default;
 
     /**
-     * @brief Gets the name of this dimension
+     * @brief Return the identifier of this dimension.
      *
-     * @return Name of this dimension
+     * @return this dimension's identifier
      */
-    [[nodiscard]] virtual std::string getName() const = 0;
+    [[nodiscard]] virtual DimensionId getId() const = 0;
 
     /**
-     * @brief Gets the type of this dimension
+     * @brief Get the translation key, suitable for use in a translation component.
      *
-     * @return Type of this dimension
+     * @return the translation key
      */
-    [[nodiscard]] virtual Type getType() const = 0;
+    [[nodiscard]] virtual std::string getTranslationKey() const = 0;
 
     /**
      * @brief Gets the level to which this dimension belongs
@@ -150,7 +148,7 @@ inline std::unique_ptr<Block> Location::getBlock() const
 inline float Location::distanceSquared(const Location &other) const
 {
     Preconditions::checkArgument(dimension_ == other.dimension_, "Cannot measure distance between {} and {}.",
-                                 dimension_->getName(), other.dimension_->getName());
+                                 dimension_->getId(), other.dimension_->getId());
     return ((x_ - other.x_) * (x_ - other.x_)) + ((y_ - other.y_) * (y_ - other.y_)) +
            ((z_ - other.z_) * (z_ - other.z_));
 }
@@ -161,6 +159,6 @@ struct fmt::formatter<endstone::Dimension> : formatter<string_view> {
     template <typename FormatContext>
     auto format(const endstone::Dimension &self, FormatContext &ctx) const -> format_context::iterator
     {
-        return fmt::format_to(ctx.out(), "Dimension(name={})", self.getName());
+        return fmt::format_to(ctx.out(), "Dimension(id={})", self.getId());
     }
 };

include/endstone/level/level.h

@@ -20,6 +20,7 @@
 #include <vector>
 
 #include "endstone/actor/actor.h"
+#include "endstone/level/dimension.h"
 
 namespace endstone {
 
@@ -66,13 +67,13 @@ class Level {
     [[nodiscard]] virtual std::vector<Dimension *> getDimensions() const = 0;
 
     /**
-     * @brief Gets the dimension with the given name.
+     * @brief Gets the dimension with the given id.
      *
-     * @param name the name of the dimension to retrieve. For example, "overworld", "nether" or "the_end".
+     * @param id the id of the dimension to retrieve.
      *
-     * @return The Dimension with the given name, or nullptr if none exists
+     * @return The Dimension with the given id, or nullptr if none exists
      */
-    [[nodiscard]] virtual Dimension *getDimension(std::string name) const = 0;
+    [[nodiscard]] virtual Dimension *getDimension(DimensionId id) const = 0;
 
     /**
      * @brief Gets the Seed for this level.

src/bedrock/world/level/dimension/dimension.cpp

@@ -19,6 +19,11 @@ bool Dimension::isBrightOutside() const
     return isNaturalDimension() && sky_darken_.value < 4;
 }
 
+std::string Dimension::getLocalizationKey() const
+{
+    return fmt::format("dimension.dimensionName{}", id_.runtime_id);
+}
+
 Level &Dimension::getLevel() const
 {
     return *level_;

src/endstone/core/actor/actor.h

@@ -92,21 +92,15 @@ class EndstoneActorBase : public Interface {
         return ActorPermissibleBase::get().removeAttachment(attachment);
     }
 
-    void recalculatePermissions() override
-    {
-        ActorPermissibleBase::get().recalculatePermissions();
-    }
+    void recalculatePermissions() override { ActorPermissibleBase::get().recalculatePermissions(); }
 
     [[nodiscard]] std::unordered_set<PermissionAttachmentInfo *> getEffectivePermissions() const override
     {
         return ActorPermissibleBase::get().getEffectivePermissions();
     }
 
     // Object
-    [[nodiscard]] const std::type_info &getClassTypeId() const override
-    {
-        return typeid(Interface);
-    }
+    [[nodiscard]] const std::type_info &getClassTypeId() const override { return typeid(Interface); }
 
     [[nodiscard]] bool isInstanceOf(const std::type_info &target) const override
     {
@@ -118,15 +112,9 @@ class EndstoneActorBase : public Interface {
 
     void sendErrorMessage(const Message &message) const override {}
 
-    [[nodiscard]] Server &getServer() const override
-    {
-        return server_;
-    }
+    [[nodiscard]] Server &getServer() const override { return server_; }
 
-    [[nodiscard]] std::string getName() const override
-    {
-        return CommandUtils::getActorName(getHandle());
-    }
+    [[nodiscard]] std::string getName() const override { return CommandUtils::getActorName(getHandle()); }
 
     // Actor
     [[nodiscard]] const ActorType &getType() const override
@@ -135,10 +123,7 @@ class EndstoneActorBase : public Interface {
         return server_.getRegistry<ActorType>().getOrThrow(ActorTypeId{canonical});
     }
 
-    [[nodiscard]] std::uint64_t getRuntimeId() const override
-    {
-        return getHandle().getRuntimeID().raw_id;
-    }
+    [[nodiscard]] std::uint64_t getRuntimeId() const override { return getHandle().getRuntimeID().raw_id; }
 
     [[nodiscard]] Location getLocation() const override
     {
@@ -164,20 +149,11 @@ class EndstoneActorBase : public Interface {
         return {delta.x, delta.y, delta.z};
     }
 
-    [[nodiscard]] bool isOnGround() const override
-    {
-        return getHandle().isOnGround();
-    }
+    [[nodiscard]] bool isOnGround() const override { return getHandle().isOnGround(); }
 
-    [[nodiscard]] bool isInWater() const override
-    {
-        return getHandle().isInWater();
-    }
+    [[nodiscard]] bool isInWater() const override { return getHandle().isInWater(); }
 
-    [[nodiscard]] bool isInLava() const override
-    {
-        return getHandle().isInLava();
-    }
+    [[nodiscard]] bool isInLava() const override { return getHandle().isInLava(); }
 
     [[nodiscard]] Level &getLevel() const override
     {
@@ -188,13 +164,10 @@ class EndstoneActorBase : public Interface {
 
     [[nodiscard]] Dimension &getDimension() const override
     {
-        return *getLevel().getDimension(getHandle().getDimension().getName());
+        return *server_.getEndstoneLevel()->getDimension(getHandle().getDimension().getDimensionId());
     }
 
-    void setRotation(float yaw, float pitch) override
-    {
-        getHandle().setRotationWrapped({pitch, yaw});
-    }
+    void setRotation(float yaw, float pitch) override { getHandle().setRotationWrapped({pitch, yaw}); }
 
     bool teleport(const Location &location) override
     {
@@ -215,25 +188,13 @@ class EndstoneActorBase : public Interface {
         return true;
     }
 
-    bool teleport(const Actor &target) override
-    {
-        return teleport(target.getLocation());
-    }
+    bool teleport(const Actor &target) override { return teleport(target.getLocation()); }
 
-    [[nodiscard]] std::int64_t getId() const override
-    {
-        return getHandle().getOrCreateUniqueID().raw_id;
-    }
+    [[nodiscard]] std::int64_t getId() const override { return getHandle().getOrCreateUniqueID().raw_id; }
 
-    void remove() override
-    {
-        getHandle().remove();
-    }
+    void remove() override { getHandle().remove(); }
 
-    [[nodiscard]] bool isDead() const override
-    {
-        return !getHandle().isAlive();
-    }
+    [[nodiscard]] bool isDead() const override { return !getHandle().isAlive(); }
 
     [[nodiscard]] bool isValid() const override
     {
@@ -244,30 +205,15 @@ class EndstoneActorBase : public Interface {
         return handle->isAlive();
     }
 
-    [[nodiscard]] std::vector<std::string> getScoreboardTags() const override
-    {
-        return getHandle().getTags();
-    }
+    [[nodiscard]] std::vector<std::string> getScoreboardTags() const override { return getHandle().getTags(); }
 
-    [[nodiscard]] bool addScoreboardTag(std::string tag) const override
-    {
-        return getHandle().addTag(tag);
-    }
+    [[nodiscard]] bool addScoreboardTag(std::string tag) const override { return getHandle().addTag(tag); }
 
-    [[nodiscard]] bool removeScoreboardTag(std::string tag) const override
-    {
-        return getHandle().removeTag(tag);
-    }
+    [[nodiscard]] bool removeScoreboardTag(std::string tag) const override { return getHandle().removeTag(tag); }
 
-    [[nodiscard]] bool isNameTagVisible() const override
-    {
-        return getHandle().canShowNameTag();
-    }
+    [[nodiscard]] bool isNameTagVisible() const override { return getHandle().canShowNameTag(); }
 
-    void setNameTagVisible(bool visible) override
-    {
-        getHandle().setNameTagVisible(visible);
-    }
+    void setNameTagVisible(bool visible) override { getHandle().setNameTagVisible(visible); }
 
     [[nodiscard]] bool isNameTagAlwaysVisible() const override
     {
@@ -281,25 +227,13 @@ class EndstoneActorBase : public Interface {
             static_cast<SynchedActorData::ID>(ActorDataIDs::NAMETAG_ALWAYS_SHOW), visible);
     }
 
-    [[nodiscard]] std::string getNameTag() const override
-    {
-        return getHandle().getNameTag();
-    }
+    [[nodiscard]] std::string getNameTag() const override { return getHandle().getNameTag(); }
 
-    void setNameTag(std::string name) override
-    {
-        getHandle().setNameTag(name);
-    }
+    void setNameTag(std::string name) override { getHandle().setNameTag(name); }
 
-    [[nodiscard]] std::string getScoreTag() const override
-    {
-        return getHandle().getScoreTag();
-    }
+    [[nodiscard]] std::string getScoreTag() const override { return getHandle().getScoreTag(); }
 
-    void setScoreTag(std::string score) override
-    {
-        getHandle().setScoreTag(score);
-    }
+    void setScoreTag(std::string score) override { getHandle().setScoreTag(score); }
 
     Handle &getHandle() const
     {

src/endstone/core/command/defaults/status_command.cpp

@@ -102,7 +102,7 @@ bool StatusCommand::execute(CommandSender &sender, const std::vector<std::string
             }
         }
         sender.sendMessage("- {}Dimension \"{}\": {}{}{} loaded chunks, {}{}{} entities",              //
-                           ColorFormat::Gold, dimension->getName(),                                    //
+                           ColorFormat::Gold, dimension->getId(),                                    //
                            ColorFormat::Red, dimension->getLoadedChunks().size(), ColorFormat::Green,  //
                            ColorFormat::Red, actor_count, ColorFormat::Green);
     }