Block

endstone.block

Block

Represents a block.

data property writable

data: BlockData

Gets or sets the complete data for this block

dimension property

dimension: Dimension

Gets the dimension which contains this Block

location property

location: Location

Gets the Location of the block

type property writable

type: str

Gets or sets the type of the block.

x property

x: int

Gets the x-coordinate of this block

y property

y: int

Gets the y-coordinate of this block

z property

z: int

Gets the z-coordinate of this block

capture_state

capture_state() -> BlockState

Captures the current state of this block. The returned object will never be updated, and you are not guaranteed that (for example) a sign is still a sign after you capture its state.

get_relative

get_relative(
    offset_x: int, offset_y: int, offset_z: int
) -> Block

Gets the block at the given offsets

get_relative(face: BlockFace, distance: int = 1) -> Block

Gets the block at the given distance of the given face

set_data

set_data(
    data: BlockData, apply_physics: bool = True
) -> None

Sets the complete data for this block

set_type

set_type(type: str, apply_physics: bool = True) -> None

Sets the type of this block

BlockData

Represents the data related to a live block

block_states property

block_states: dict[str, bool | str | int]

Gets the block states for this block.

type property

type: str

Get the block type represented by this block data.

BlockFace

BlockFace(value: int)

DOWN class-attribute

DOWN: BlockFace

EAST class-attribute

EAST: BlockFace

NORTH class-attribute

NORTH: BlockFace

SOUTH class-attribute

SOUTH: BlockFace

UP class-attribute

UP: BlockFace

WEST class-attribute

WEST: BlockFace

name property

name: str

value property

value: int

BlockState

Represents a captured state of a block, which will not update automatically.

block property

block: Block

Gets the block represented by this block state.

data property writable

data: BlockData

Gets or sets the data for this block state.

dimension property

dimension: Dimension

Gets the dimension which contains the block represented by this block state.

location property

location: Location

Gets the location of this block state.

type property writable

type: str

Gets or sets the type of this block state.

x property

x: int

Gets the x-coordinate of this block state.

y property

y: int

Gets the y-coordinate of this block state.

z property

z: int

Gets the z-coordinate of this block state.

update

update(
    force: bool = False, apply_physics: bool = True
) -> bool

Attempts to update the block represented by this state.