Skip to content

Level

endstone.level

Classes:

Name Description
Dimension

Represents a dimension within a Level.

Level
Location

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

Position

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

Dimension

Represents a dimension within a Level.

Classes:

Name Description
Type

Represents various dimension types.

Methods:

Name Description
get_block_at

Attributes:

Name Type Description
CUSTOM Type
NETHER Type
OVERWORLD Type
THE_END Type
level Level

Gets the level to which this dimension belongs

name str

Gets the name of this dimension

type Type

Gets the type of this dimension

CUSTOM class-attribute

CUSTOM: Type

NETHER class-attribute

NETHER: Type

OVERWORLD class-attribute

OVERWORLD: Type

THE_END class-attribute

THE_END: Type

level property

level: Level

Gets the level to which this dimension belongs

name property

name: str

Gets the name of this dimension

type property

type: Type

Gets the type of this dimension

Type

Type(value: int)

Represents various dimension types.

Attributes:

Name Type Description
CUSTOM Type
NETHER Type
OVERWORLD Type
THE_END Type
name str
value int
CUSTOM class-attribute
CUSTOM: Type
NETHER class-attribute
NETHER: Type
OVERWORLD class-attribute
OVERWORLD: Type
THE_END class-attribute
THE_END: Type
name property
name: str
value property
value: int

get_block_at

get_block_at(location: Location) -> Block

Gets the Block at the given Location

get_block_at(x: int, y: int, z: int) -> Block

Gets the Block at the given coordinates

Level

Methods:

Name Description
get_dimension

Gets the dimension with the given name.

Attributes:

Name Type Description
actors list[Actor]

Get a list of all actors in this level

dimensions list[Dimension]

Gets a list of all dimensions within this level.

name str

Gets the unique name of this level

time int

Gets and sets the relative in-game time on the server

actors property

actors: list[Actor]

Get a list of all actors in this level

dimensions property

dimensions: list[Dimension]

Gets a list of all dimensions within this level.

name property

name: str

Gets the unique name of this level

time property writable

time: int

Gets and sets the relative in-game time on the server

get_dimension

get_dimension(name: str) -> Dimension

Gets the dimension with the given name.

Location

Location(
    dimension: Dimension,
    x: float,
    y: float,
    z: float,
    pitch: float = 0.0,
    yaw: float = 0.0,
)

Bases: Position

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

Attributes:

Name Type Description
pitch float

The pitch of this location, measured in degrees.

yaw float

The yaw of this location, measured in degrees.

pitch property writable

pitch: float

The pitch of this location, measured in degrees.

yaw property writable

yaw: float

The yaw of this location, measured in degrees.

Position

Position(
    dimension: Dimension, x: float, y: float, z: float
)

Bases: Vector

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

Attributes:

Name Type Description
block_x int

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

block_y int

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

block_z int

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

dimension Dimension

The Dimension that contains this position

block_x property

block_x: int

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

block_y property

block_y: int

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

block_z property

block_z: int

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

dimension property writable

dimension: Dimension

The Dimension that contains this position