Class endstone::Dimension

ClassList > endstone > Dimension

Represents a dimension within a Level .

• #include <endstone/level/dimension.h>

Public Types

Type	Name
enum	Type Represents various dimension types.

Public Functions

Type	Name
virtual Result< std::unique_ptr< Block > >	getBlockAt (int x, int y, int z) = 0 Gets the Block at the given coordinates.
virtual Result< std::unique_ptr< Block > >	getBlockAt (Location location) = 0 Gets the Block at the givenLocation .
virtual Level &	getLevel () const = 0 Gets the level to which this dimension belongs.
virtual std::string	getName () const = 0 Gets the name of this dimension.
virtual Type	getType () const = 0 Gets the type of this dimension.
virtual	~Dimension () = default

Public Types Documentation

enum Type

Represents various dimension types.

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

---

Public Functions Documentation

function getBlockAt [½]

Gets the Block at the given coordinates.

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

Parameters:

• x X-coordinate of the block
• y Y-coordinate of the block
• z Z-coordinate of the block

Returns:

Block at the given coordinates

---

function getBlockAt [2/2]

Gets the Block at the givenLocation .

virtual Result< std::unique_ptr< Block > > endstone::Dimension::getBlockAt (
    Location location
) = 0

Parameters:

• location Location of the block

Returns:

Block at the given coordinates

---

function getLevel

Gets the level to which this dimension belongs.

virtual Level & endstone::Dimension::getLevel () const = 0

Returns:

Level containing this dimension.

---

function getName

Gets the name of this dimension.

virtual std::string endstone::Dimension::getName () const = 0

Returns:

Name of this dimension

---

function getType

Gets the type of this dimension.

virtual Type endstone::Dimension::getType () const = 0

Returns:

Type of this dimension

---

function ~Dimension

virtual endstone::Dimension::~Dimension () = default

---

---

The documentation for this class was generated from the following file include/endstone/level/dimension.h