Skip to content

File dimension.h

File List > endstone > level > dimension.h

Go to the documentation of this file

// Copyright (c) 2024, The Endstone Project. (https://endstone.dev) All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include "endstone/block/block.h"
#include "endstone/util/result.h"

namespace endstone {

class Dimension {
public:
    enum class Type {
        Overworld = 0,
        Nether = 1,
        TheEnd = 2,
        Custom = 999
    };

    virtual ~Dimension() = default;

    [[nodiscard]] virtual std::string getName() const = 0;

    [[nodiscard]] virtual Type getType() const = 0;

    [[nodiscard]] virtual Level &getLevel() const = 0;

    virtual Result<std::unique_ptr<Block>> getBlockAt(int x, int y, int z) = 0;

    virtual Result<std::unique_ptr<Block>> getBlockAt(Location location) = 0;
};
}  // namespace endstone