📦 Block Object API

In LSE, use "block objects" to manipulate and obtain information about a certain type of block.

Get a Block Object

Get From Event or API

By registering the event listener function, or calling some returning a block object function, you can get the block object related to the related event given by the BDS For details, see Event listener documentation - EventAPI

Obtained by Block Coordinates

Use this function to manually generate objects. Note that the block you want to get must be in the range that has been loaded, otherwise there will be problems.

mc.getBlock(pos)
mc.getBlock(x,y,z,dimid)

• Parameters:
• pos : IntPos
  The coordinates of the block (or use x, y, z, dimid to determine the block position)
• Return value: The generated Block object.
• Return value type: Block
• If the return value is Null, it means that the block acquisition failed.

Note: Do not save a block object long-term. When the block corresponding to the block object is destroyed, the corresponding block object will become invalid. Therefore, if there is a need to operate a certain block for a long time, please obtain the real-time block object through the above method.

Block Object - Properties

Every block object contains some fixed object properties. for a specific block object bl, has the following properties:

These object properties are read-only and cannot be modified.

Destroy The Block

bl.destroy(drop)

• Parameters：
• drop : Boolean
  Whether to generate drops
• Return value: Whether the destroy was successful or not.
• Return value type: Boolean

Block Object - Function

Each block object contains some member functions (member methods) that can be executed. for a specific block object bl, you can perform some operations on this block through the following functions.

Get the Block's NBT Object

bl.getNbt()

• Return value: NBT object of the block
• Return value type: NbtCompound

Write to the Block's NBT Object

bl.setNbt(nbt)

• Parameters:
• nbt : NbtCompound
  NBT objects
• Return value: Whether the write was successful or not.
• Return value type: Boolean

For more usage of NBT objects, please refer to NBT Interface Documentation Note: Use this api with caution, consider using mc.setBlock() instead.

Get the BlockState of the Block

bl.getBlockState()

• Return value: The BlockState of the Block.
• Return value type: Object

Convenience function to help parse block BlockState and convert it to Object for easy reading and parsing Equivalent to script executing block.getNbt().getTag("states").toObject()

Determine if a Block Has a Container

bl.hasContainer()

• Return value: whether this block has a container
• Return value type: Boolean

Such as boxes, buckets and other containers; they each have a container object of their own.

Get the Container Object Owned by the Block

bl.getContainer()

• Return value: The container object owned by this block
• Return value type: Container

For more usage of container objects, please refer to Container Object API Documentation

Determine if a Block Has a Block Entity

bl.hasBlockEntity()

• Return value: Whether the block has a block entity
• Return value type: Boolean

Get the Block Entity Owned by the Block

bl.getBlockEntity()

• Return value: The block entity owned by this block
• Return value type: BlockEntity

Remove the Block Entity Owned by the Block

bl.removeBlockEntity()

• Return value: Whether the deletion was successful
• Return value type: Boolean

For more usage of block entity object, please refer to Block entity object API documentation

Other Block Function API

The following APIs provide APIs for interacting with blocks at specified locations in the game:

Set the Block at the Specified Location

mc.setBlock(pos, blockObject)
mc.setBlock(pos, blockString, tileData)
mc.setBlock(x, y, z, dimId, blockObject)
mc.setBlock(x, y, z, dimId, blockString, tileData)

• Parameters:

• pos : IntPos or FloatPos
  Target block position (or use x, y, z, dimId to determine block position)

• blockObject : Block or NbtCompound
  Either the target block object or NBT data representing the block

• blockString: String
  The block standard type name (e.g. minecraft:stone)

• tileData : Integer
  Block state value, same as tileData of vanilla /setBlock command, default is 0, only valid when placing blocks by block type name

• Return value: Whether the setting is successful or not

• Return value type: Boolean

Through this function, set the block corresponding to one coordinate to another, similar to the command /setblock

Generate Particle Effects at Specified Locations

mc.spawnParticle(pos,type)
mc.spawnParticle(x,y,z,dimid,type)

• Parameters:
• pos : IntPos/ FloatPos
  Target spawn position (or use x, y, z, dimid to determine block position)
• type : String
  The name of the particle effect to generate (check the wiki for details)
• Return value: Whether it was successfully generated
• Return value type: Boolean

Particle effect names can be found in the Minecraft Wiki, don't forget the namespace prefix when passing in parameters. similar to minecraft:heart_particle