endstone.block

Classes relating to the blocks in a world, including special states.

Classes

Name	Description
`Block`	Represents a block.
`BlockData`	Represents the data related to a live block
`BlockFace`
`BlockState`	Represents a captured state of a block, which will not update automatically.
`BlockType`	Represents a block type.

`class`Block

Block()

Represents a block.

Methods

Name	Description
`capture_state`	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.
`set_data`	Sets the complete data for this block
`set_type`	Sets the type of this block

Attributes

Name	Type	Description
`data`	`BlockData`	Gets the complete data for this block
`dimension`	`Dimension`	Gets the dimension which contains this Block
`location`	`Location`	Gets the Location of the block
`type`	`str`	Gets or sets the type of the block.
`x`	`int`	Gets the x-coordinate of this block
`y`	`int`	Gets the y-coordinate of this block
`z`	`int`	Gets the z-coordinate of this block

`attr`dataproperty

data: BlockData

Gets the complete data for this block

`attr`dimensionproperty

dimension: Dimension

Gets the dimension which contains this Block

`attr`locationproperty

location: Location

Gets the Location of the block

`attr`typeproperty

type: str

Gets or sets the type of the block.

`attr`xproperty

x: int

Gets the x-coordinate of this block

`attr`yproperty

y: int

Gets the y-coordinate of this block

`attr`zproperty

z: int

Gets the z-coordinate of this block

`meth`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.

`meth`set_data

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

Sets the complete data for this block

`meth`set_type

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

Sets the type of this block

`class`BlockData

BlockData()

Represents the data related to a live block

Attributes

Name	Type	Description
`block_states`	`dict[str, bool \| str \| int]`	Gets the block states for this block.
`runtime_id`	`int`	Gets the runtime id for this block.
`type`	`str`	Get the block type represented by this block data.

`attr`block_statesproperty

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

Gets the block states for this block.

`attr`runtime_idproperty

runtime_id: int

Gets the runtime id for this block.

`attr`typeproperty

type: str

Get the block type represented by this block data.

`class`BlockFace

Bases: Enum

BlockFace()

Attributes

Name	Type	Description
`DOWN`
`EAST`
`NORTH`
`SOUTH`
`UP`
`WEST`

`attr`DOWN

DOWN = 0

`attr`EAST

EAST = 5

`attr`NORTH

NORTH = 2

`attr`SOUTH

SOUTH = 3

`attr`UP

UP = 1

`attr`WEST

WEST = 4

`class`BlockState

BlockState()

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

Methods

Name	Description
`update`	Attempts to update the block represented by this state.

Attributes

Name	Type	Description
`block`	`Block`	Gets the block represented by this block state.
`data`	`BlockData`	Gets or sets the data for this block state.
`dimension`	`Dimension`	Gets the dimension which contains the block represented by this block state.
`location`	`Location`	Gets the location of this block state.
`type`	`str`	Gets or sets the type of this block state.
`x`	`int`	Gets the x-coordinate of this block state.
`y`	`int`	Gets the y-coordinate of this block state.
`z`	`int`	Gets the z-coordinate of this block state.

`attr`blockproperty

block: Block

Gets the block represented by this block state.

`attr`dataproperty

data: BlockData

Gets or sets the data for this block state.

`attr`dimensionproperty

dimension: Dimension

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

`attr`locationproperty

location: Location

Gets the location of this block state.

`attr`typeproperty

type: str

Gets or sets the type of this block state.

`attr`xproperty

x: int

Gets the x-coordinate of this block state.

`attr`yproperty

y: int

Gets the y-coordinate of this block state.

`attr`zproperty

z: int

Gets the z-coordinate of this block state.

`meth`update

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

Attempts to update the block represented by this state.

`class`BlockType

BlockType()

Represents a block type.

Methods

Name	Description
`create_block_data`	Creates a new BlockData instance for this block type, with all properties initialized to defaults.
`get`	Attempts to get the BlockType with the given name.

Attributes

Name	Type	Description
`has_item_type`	`bool`	Returns true if this BlockType has a corresponding ItemType.
`id`	`str`	Return the identifier of this block type.
`translation_key`	`str`	Get the translation key, suitable for use in a translation component.

`attr`has_item_typeproperty

has_item_type: bool

Returns true if this BlockType has a corresponding ItemType.

`attr`idproperty

id: str

Return the identifier of this block type.

`attr`translation_keyproperty

translation_key: str

Get the translation key, suitable for use in a translation component.

`meth`create_block_data

create_block_data() -> BlockData

Creates a new BlockData instance for this block type, with all properties initialized to defaults.

`meth`getstaticmethod

get(name: str) -> BlockType

Attempts to get the BlockType with the given name.

classBlock

attrdataproperty

attrdimensionproperty

attrlocationproperty

attrtypeproperty

attrxproperty

attryproperty

attrzproperty

methcapture_state

methset_data

methset_type

classBlockData

attrblock_statesproperty

attrruntime_idproperty

attrtypeproperty

classBlockFace

attrDOWN

attrEAST

attrNORTH

attrSOUTH

attrUP

attrWEST

classBlockState

attrblockproperty

attrdataproperty

attrdimensionproperty

attrlocationproperty

attrtypeproperty

attrxproperty

attryproperty

attrzproperty

methupdate

classBlockType

attrhas_item_typeproperty

attridproperty

attrtranslation_keyproperty

methcreate_block_data

methgetstaticmethod

On this page

`class`Block

`attr`dataproperty

`attr`dimensionproperty

`attr`locationproperty

`attr`typeproperty

`attr`xproperty

`attr`yproperty

`attr`zproperty

`meth`capture_state

`meth`set_data

`meth`set_type

`class`BlockData

`attr`block_statesproperty

`attr`runtime_idproperty

`attr`typeproperty

`class`BlockFace

`attr`DOWN

`attr`EAST

`attr`NORTH

`attr`SOUTH

`attr`UP

`attr`WEST

`class`BlockState

`attr`blockproperty

`attr`dataproperty

`attr`dimensionproperty

`attr`locationproperty

`attr`typeproperty

`attr`xproperty

`attr`yproperty

`attr`zproperty

`meth`update

`class`BlockType

`attr`has_item_typeproperty

`attr`idproperty

`attr`translation_keyproperty

`meth`create_block_data

`meth`getstaticmethod