endstone/level

Classes

Name	Description
`Chunk`	Represents a chunk of blocks.
`Dimension`	Represents a dimension within a Level.
`Level`	Represents a level, which may contain actors, chunks and blocks.
`Location`	Represents a 3-dimensional location in a dimension within a level.

`class`Chunk

Defined in <endstone/level/chunk.h>

Represents a chunk of blocks.

Methods

Name	Description
`~Chunk`
`getX`	Gets the X-coordinate of this chunk.
`getZ`	Gets the Z-coordinate of this chunk.
`getLevel`	Gets the level containing this chunk.
`getDimension`	Gets the dimension containing this chunk.

`meth`~Chunkvirtual

~Chunk() =default

`meth`getXabstractconst

int getX() const =0

Gets the X-coordinate of this chunk.

Returns

Type	Description
`int`	X-coordinate

`meth`getZabstractconst

int getZ() const =0

Gets the Z-coordinate of this chunk.

Returns

Type	Description
`int`	Z-coordinate

`meth`getLevelabstractconst

Level& getLevel() const =0

Gets the level containing this chunk.

Returns

Type	Description
`Level&`	Parent Level

`meth`getDimensionabstractconst

Dimension& getDimension() const =0

Gets the dimension containing this chunk.

Returns

Type	Description
`Dimension&`	Parent Dimension

`class`Dimension

Defined in <endstone/level/dimension.h>

Represents a dimension within a Level.

Enums

Name	Description
`Type`	Represents various dimension types.

Methods

Name	Description
`~Dimension`
`getName`	Gets the name of this dimension.
`getType`	Gets the type of this dimension.
`getLevel`	Gets the level to which this dimension belongs.
`getBlockAt`	Gets the Block at the given coordinates.
`getBlockAt`	Gets the Block at the given Location.
`getHighestBlockYAt`	Gets the highest non-empty (impassable) coordinate at the given coordinates.
`getHighestBlockAt`	Gets the highest non-empty (impassable) block at the given coordinates.
`getHighestBlockAt`	Gets the highest non-empty (impassable) block at the given Location.
`getLoadedChunks`	Gets a list of all loaded Chunks.
`dropItem`	Drops an item at the specified Location.
`spawnActor`	Creates an actor at the given Location.
`getActors`	Get a list of all actors in this dimension.

`enum`Type

Type

Represents various dimension types.

Values

Name	Value	Description
`Overworld`	`0`
`Nether`	`1`
`TheEnd`	`2`
`Custom`	`999`

`meth`~Dimensionvirtual

~Dimension() =default

`meth`getNameabstractconst

std::string getName() const =0

Gets the name of this dimension.

Returns

Type	Description
`std::string`	Name of this dimension

`meth`getTypeabstractconst

Type getType() const =0

Gets the type of this dimension.

Returns

Type	Description
`Type`	Type of this dimension

`meth`getLevelabstractconst

Level& getLevel() const =0

Gets the level to which this dimension belongs.

Returns

Type	Description
`Level&`	Level containing this dimension.

`meth`getBlockAtabstractconst

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

Gets the Block at the given coordinates.

Parameters

Name	Type	Description
`x`	`int`	X-coordinate of the block
`y`	`int`	Y-coordinate of the block
`z`	`int`	Z-coordinate of the block

Returns

Type	Description
`std::unique_ptr<Block>`	Block at the given coordinates

`meth`getBlockAtabstractconst

std::unique_ptr<Block> getBlockAt(Location location) const =0

Gets the Block at the given Location.

Parameters

Name	Type	Description
`location`	`Location`	Location of the block

Returns

Type	Description
`std::unique_ptr<Block>`	Block at the given coordinates

`meth`getHighestBlockYAtabstractconst

int getHighestBlockYAt(int x, int z) const =0

Gets the highest non-empty (impassable) coordinate at the given coordinates.

Parameters

Name	Type	Description
`x`	`int`	X-coordinate of the blocks
`z`	`int`	Z-coordinate of the blocks

Returns

Type	Description
`int`	Y-coordinate of the highest non-empty block

`meth`getHighestBlockAtabstractconst

std::unique_ptr<Block> getHighestBlockAt(int x, int z) const =0

Gets the highest non-empty (impassable) block at the given coordinates.

Parameters

Name	Type	Description
`x`	`int`	X-coordinate of the block
`z`	`int`	Z-coordinate of the block

Returns

Type	Description
`std::unique_ptr<Block>`	Highest non-empty block

`meth`getHighestBlockAtabstractconst

std::unique_ptr<Block> getHighestBlockAt(Location location) const =0

Gets the highest non-empty (impassable) block at the given Location.

Parameters

Name	Type	Description
`location`	`Location`	Coordinates to get the highest block

Returns

Type	Description
`std::unique_ptr<Block>`	Highest non-empty block

`meth`getLoadedChunksabstract

std::vector<std::unique_ptr<Chunk>> getLoadedChunks() =0

Gets a list of all loaded Chunks.

Returns

Type	Description
`std::vector<std::unique_ptr<Chunk>>`	All loaded chunks

`meth`dropItemabstract

Item& dropItem(Location location, const ItemStack& item) =0

Drops an item at the specified Location.

Parameters

Name	Type	Description
`location`	`Location`	Location to drop the item
`item`	`const ItemStack&`	ItemStack to drop

Returns

Type	Description
`Item&`	Item entity created as a result of this method

`meth`spawnActorabstract

Actor* spawnActor(Location location, std::string type) =0

Creates an actor at the given Location.

Parameters

Name	Type	Description
`location`	`Location`	The location to spawn the actor
`type`	`std::string`	The actor to spawn

Returns

Type	Description
`Actor*`	Resulting Actor of this method

`meth`getActorsabstractconst

std::vector<Actor*> getActors() const =0

Get a list of all actors in this dimension.

Returns

Type	Description
`std::vector<Actor*>`	A List of all actors currently residing in this dimension

`class`Level

Defined in <endstone/level/level.h>

Represents a level, which may contain actors, chunks and blocks.

Methods

Name	Description
`~Level`
`getName`	Gets the unique name of this level.
`getActors`	Get a list of all actors in this level.
`getTime`	Gets the relative in-game time of this level.
`setTime`	Sets the relative in-game time on the server.
`getDimensions`	Gets a list of all dimensions within this level.
`getDimension`	Gets the dimension with the given name.
`getSeed`	Gets the Seed for this level.

`meth`~Levelvirtual

~Level() =default

`meth`getNameabstractconst

std::string getName() const =0

Gets the unique name of this level.

Returns

Type	Description
`std::string`	Name of this level

`meth`getActorsabstractconst

std::vector<Actor*> getActors() const =0

Get a list of all actors in this level.

Returns

Type	Description
`std::vector<Actor*>`	A List of all actors currently residing in this level

`meth`getTimeabstractconst

int getTime() const =0

Gets the relative in-game time of this level.

Returns

Type	Description
`int`	The current relative time

`meth`setTimeabstract

void setTime(int time) =0

Sets the relative in-game time on the server.

Parameters

Name	Type	Description
`time`	`int`	The new relative time to set the in-game time to

`meth`getDimensionsabstractconst

std::vector<Dimension*> getDimensions() const =0

Gets a list of all dimensions within this level.

Returns

Type	Description
`std::vector<Dimension*>`	a list of dimensions

`meth`getDimensionabstractconst

Dimension* getDimension(std::string name) const =0

Gets the dimension with the given name.

Parameters

Name	Type	Description
`name`	`std::string`	the name of the dimension to retrieve. For example, "overworld", "nether" or "the_end".

Returns

Type	Description
`Dimension*`	The Dimension with the given name, or nullptr if none exists

`meth`getSeedabstractconst

std::int64_t getSeed() const =0

Gets the Seed for this level.

Returns

Type	Description
`std::int64_t`	This level's Seed

`class`Location

Defined in <endstone/level/location.h>

Represents a 3-dimensional location in a dimension within a level.

Methods

Name	Description
`Location`
`setDimension`	Sets the dimension that this position resides in.
`getDimension`	Gets the dimension that this location resides in.
`getBlock`	Gets the block at the represented location.
`setX`	Sets the x-coordinate of this location.
`getX`	Gets the x-coordinate of this location.
`getBlockX`	Gets the floored value of the X component, indicating the block that this location is contained with.
`setY`	Sets the y-coordinate of this location.
`getY`	Gets the y-coordinate of this location.
`getBlockY`	Gets the floored value of the Y component, indicating the block that this location is contained with.
`setZ`	Sets the z-coordinate of this location.
`getZ`	Gets the z-coordinate of this location.
`getBlockZ`	Gets the floored value of the Z component, indicating the block that this location is contained with.
`getPitch`	Gets the pitch of this location, measured in degrees.
`setPitch`	Sets the pitch of this location, measured in degrees.
`getYaw`	Gets the yaw of this location, measured in degrees.
`setYaw`	Sets the yaw of this location, measured in degrees.
`getDirection`	Gets a unit-vector pointing in the direction that this Location is facing.
`setDirection`	Sets the yaw and pitch to point in the direction of the vector.
`length`	Gets the magnitude of the location, defined as sqrt(x^2+y^2+z^2).
`lengthSquared`	Gets the magnitude of the location squared.
`distance`	Get the distance between this location and another.
`distanceSquared`	Get the squared distance between this location and another.
`operator+=`
`operator+=`
`operator-=`
`operator-=`
`operator*=`
`zero`	Zero this vector's components. Not world-aware.
`operator==`
`operator!=`
`operator Vector`
`normalizeYaw`	Normalizes the given yaw angle to a value between +/-180 degrees.
`normalizePitch`	Normalizes the given pitch angle to a value between +/-90 degrees.

`meth`Location

Location(Dimension& dimension, T x, T y, T z, const float pitch = 0.0, const float yaw = 0.0)

`meth`setDimension

void setDimension(Dimension& dimension)

Sets the dimension that this position resides in.

Parameters

Name	Type	Description
`dimension`	`Dimension&`	New dimension that this position resides in

`meth`getDimensionconst

Dimension& getDimension() const

Gets the dimension that this location resides in.

Returns

Type	Description
`Dimension&`	Dimension that contains this location

`meth`getBlockconst

std::unique_ptr<Block> getBlock() const

Gets the block at the represented location.

Returns

Type	Description
`std::unique_ptr<Block>`	Block at the represented location

`meth`setXconstexpr

void setX(T x)

Sets the x-coordinate of this location.

Parameters

Name	Type	Description
`x`	`T`	X-coordinate

`meth`getXconstconstexpr

float getX() const

Gets the x-coordinate of this location.

Returns

Type	Description
`float`	x-coordinate

`meth`getBlockXconst

int getBlockX() const

Gets the floored value of the X component, indicating the block that this location is contained with.

Returns

Type	Description
`int`	block X

`meth`setYconstexpr

void setY(T y)

Sets the y-coordinate of this location.

Parameters

Name	Type	Description
`y`	`T`	y-coordinate

`meth`getYconstconstexpr

float getY() const

Gets the y-coordinate of this location.

Returns

Type	Description
`float`	y-coordinate

`meth`getBlockYconst

int getBlockY() const

Gets the floored value of the Y component, indicating the block that this location is contained with.

Returns

Type	Description
`int`	block Y

`meth`setZconstexpr

void setZ(T z)

Sets the z-coordinate of this location.

Parameters

Name	Type	Description
`z`	`T`	z-coordinate

`meth`getZconstconstexpr

float getZ() const

Gets the z-coordinate of this location.

Returns

Type	Description
`float`	z-coordinate

`meth`getBlockZconst

int getBlockZ() const

Gets the floored value of the Z component, indicating the block that this location is contained with.

Returns

Type	Description
`int`	block Z

`meth`getPitchconst

float getPitch() const

Gets the pitch of this location, measured in degrees.

Returns

Type	Description
`float`	the incline's pitch

`meth`setPitch

void setPitch(float pitch)

Sets the pitch of this location, measured in degrees.

A pitch of 0 represents level forward facing.
A pitch of 90 represents downward facing, or negative y direction.
A pitch of -90 represents upward facing, or positive y direction.

Increasing pitch values the equivalent of looking down.

Parameters

Name	Type	Description
`pitch`	`float`	new incline's pitch

`meth`getYawconst

float getYaw() const

Gets the yaw of this location, measured in degrees.

Returns

Type	Description
`float`	the rotation's yaw

`meth`setYaw

void setYaw(float yaw)

Sets the yaw of this location, measured in degrees.

A yaw of 0 or 360 represents the positive z direction.
A yaw of 180 represents the negative z direction.
A yaw of 90 represents the negative x direction.
A yaw of 270 represents the positive x direction.

Increasing yaw values are the equivalent of turning to your right-facing, increasing the scale of the next respective axis, and decreasing the scale of the previous axis.

Parameters

Name	Type	Description
`yaw`	`float`	new rotation's yaw

`meth`getDirectionconst

Vector getDirection() const

Gets a unit-vector pointing in the direction that this Location is facing.

Returns

Type	Description
`Vector`	a vector pointing the direction of this location's pitch and yaw

`meth`setDirection

Location& setDirection(const Vector& vector)

Sets the yaw and pitch to point in the direction of the vector.

Parameters

Name	Type	Description
`vector`	`const Vector&`	the direction vector

Returns

Type	Description
`Location&`	the same location

`meth`lengthconst

float length() const

Gets the magnitude of the location, defined as sqrt(x^2+y^2+z^2).

Not world-aware and orientation independent.

Returns

Type	Description
`float`	the magnitude

`meth`lengthSquaredconstconstexpr

float lengthSquared() const

Gets the magnitude of the location squared.

Not world-aware and orientation independent.

Returns

Type	Description
`float`	the magnitude

`meth`distanceconst

float distance(const Location& other) const

Get the distance between this location and another.

Parameters

Name	Type	Description
`other`	`const Location&`	The other location

Returns

Type	Description
`float`	the distance

`meth`distanceSquaredconst

float distanceSquared(const Location& other) const

Get the squared distance between this location and another.

Parameters

Name	Type	Description
`other`	`const Location&`	The other location

Returns

Type	Description
`float`	the distance

`meth`operator+=

Location& operator+=(const Location& other)

`meth`operator+=

Location& operator+=(const Vector& other)

`meth`operator-=

Location& operator-=(const Location& other)

`meth`operator-=

Location& operator-=(const Vector& other)

`meth`operator*=

Location& operator*=(T scalar)

`meth`zeroconstexpr

Location& zero()

Zero this vector's components. Not world-aware.

Returns

Type	Description
`Location&`	the same location

`meth`operator==constnoexcept

bool operator==(const Location& other) const noexcept

`meth`operator!=constnoexcept

bool operator!=(const Location& other) const noexcept

`meth`operator Vectorconstnoexcept

operator Vector() const noexcept

`meth`normalizeYawstatic

float normalizeYaw(float yaw)

Normalizes the given yaw angle to a value between +/-180 degrees.

Parameters

Name	Type	Description
`yaw`	`float`	the yaw in degrees

Returns

Type	Description
`float`	the normalized yaw in degrees

`meth`normalizePitchstatic

float normalizePitch(float pitch)

Normalizes the given pitch angle to a value between +/-90 degrees.

Parameters

Name	Type	Description
`pitch`	`float`	the pitch in degrees

Returns

Type	Description
`float`	the normalized pitch in degrees

classChunk

meth~Chunkvirtual

methgetXabstractconst

methgetZabstractconst

methgetLevelabstractconst

methgetDimensionabstractconst

classDimension

enumType

meth~Dimensionvirtual

methgetNameabstractconst

methgetTypeabstractconst

methgetLevelabstractconst

methgetBlockAtabstractconst

methgetBlockAtabstractconst

methgetHighestBlockYAtabstractconst

methgetHighestBlockAtabstractconst

methgetHighestBlockAtabstractconst

methgetLoadedChunksabstract

methdropItemabstract

methspawnActorabstract

methgetActorsabstractconst

classLevel

meth~Levelvirtual

methgetNameabstractconst

methgetActorsabstractconst

methgetTimeabstractconst

methsetTimeabstract

methgetDimensionsabstractconst

methgetDimensionabstractconst

methgetSeedabstractconst

classLocation

methLocation

methsetDimension

methgetDimensionconst

methgetBlockconst

methsetXconstexpr

methgetXconstconstexpr

methgetBlockXconst

methsetYconstexpr

methgetYconstconstexpr

methgetBlockYconst

methsetZconstexpr

methgetZconstconstexpr

methgetBlockZconst

methgetPitchconst

methsetPitch

methgetYawconst

methsetYaw

methgetDirectionconst

methsetDirection

methlengthconst

methlengthSquaredconstconstexpr

methdistanceconst

methdistanceSquaredconst

methoperator+=

methoperator+=

methoperator-=

methoperator-=

methoperator*=

methzeroconstexpr

methoperator==constnoexcept

methoperator!=constnoexcept

methoperator Vectorconstnoexcept

methnormalizeYawstatic

methnormalizePitchstatic

On this page

`class`Chunk

`meth`~Chunkvirtual

`meth`getXabstractconst

`meth`getZabstractconst

`meth`getLevelabstractconst

`meth`getDimensionabstractconst

`class`Dimension

`enum`Type

`meth`~Dimensionvirtual

`meth`getNameabstractconst

`meth`getTypeabstractconst

`meth`getLevelabstractconst

`meth`getBlockAtabstractconst

`meth`getBlockAtabstractconst

`meth`getHighestBlockYAtabstractconst

`meth`getHighestBlockAtabstractconst

`meth`getHighestBlockAtabstractconst

`meth`getLoadedChunksabstract

`meth`dropItemabstract

`meth`spawnActorabstract

`meth`getActorsabstractconst

`class`Level

`meth`~Levelvirtual

`meth`getNameabstractconst

`meth`getActorsabstractconst

`meth`getTimeabstractconst

`meth`setTimeabstract

`meth`getDimensionsabstractconst

`meth`getDimensionabstractconst

`meth`getSeedabstractconst

`class`Location

`meth`Location

`meth`setDimension

`meth`getDimensionconst

`meth`getBlockconst

`meth`setXconstexpr

`meth`getXconstconstexpr

`meth`getBlockXconst

`meth`setYconstexpr

`meth`getYconstconstexpr

`meth`getBlockYconst

`meth`setZconstexpr

`meth`getZconstconstexpr

`meth`getBlockZconst

`meth`getPitchconst

`meth`setPitch

`meth`getYawconst

`meth`setYaw

`meth`getDirectionconst

`meth`setDirection

`meth`lengthconst

`meth`lengthSquaredconstconstexpr

`meth`distanceconst

`meth`distanceSquaredconst

`meth`operator+=

`meth`operator+=

`meth`operator-=

`meth`operator-=

`meth`operator*=

`meth`zeroconstexpr

`meth`operator==constnoexcept

`meth`operator!=constnoexcept

`meth`operator Vectorconstnoexcept

`meth`normalizeYawstatic

`meth`normalizePitchstatic