Private constructorReadonly dimensionReturns the dimension that the block is within.
Readonly isReturns true if this block is an air block (i.e., empty space).
This property can throw when used.
Readonly isReturns true if this block is a liquid block - (e.g., a water block and a lava block are liquid, while an air block and a stone block are not. Water logged blocks are not liquid blocks).
This property can throw when used.
Readonly Beta isReturns true if this block is solid and impassible - (e.g., a cobblestone block and a diamond block are solid, while a ladder block and a fence block are not).
This property can throw when used.
Readonly Beta isReturns true if this reference to a block is still valid (for example, if the block is unloaded, references to that block will no longer be valid.)
Readonly isReturns or sets whether this block has water on it.
This property can throw when used.
Readonly locationCoordinates of the specified block.
This property can throw when used.
Readonly permutationAdditional block configuration data that describes the block.
This property can throw when used.
Readonly typeGets the type of block.
This property can throw when used.
Readonly typeIdentifier of the type of block for this block. Warning: Vanilla block names can be changed in future releases, try using 'Block.matches' instead for block comparison.
This property can throw when used.
Readonly xX coordinate of the block.
Readonly yY coordinate of the block.
Readonly zZ coordinate of the block.
Beta
The type of liquid this function should be called for.
Whether this block is removed when touched by liquid.
Returns whether this block is removed when touched by liquid.
This function can throw errors.
Error
Beta
The type of liquid this function should be called for.
Whether this block can have a liquid placed over it.
Returns whether this block can have a liquid placed over it, i.e. be waterlogged.
This function can throw errors.
Error
Beta
Block type or block permutation to check placement for.
Optional faceToPlaceOn: DirectionOptional specific face of this block to check placement against.
Returns true if the block type or permutation can be
placed on this block, else false.
Checks to see whether it is valid to place the specified block type or block permutation, on a specified face on this block
This function can throw errors.
Error
The identifier of the component (e.g., 'minecraft:inventory'). If no namespace prefix is specified, 'minecraft:' is assumed. Available component IDs can be found as part of the BlockComponentTypes enum.
Returns the component if it exists on the block, otherwise undefined.
Gets a component (that represents additional capabilities) for a block - for example, an inventory component of a chest block.
This function can throw errors.
Optional amount: numberNumber of instances of this block to place in the item stack.
Optional withData: booleanWhether additional data facets of the item stack are included.
An itemStack with the specified amount of items and data. Returns undefined if block type is incompatible.
Creates a prototype item stack based on this block that can be used with Container/ContainerSlot APIs.
This function can throw errors.
Tag to check for.
Returns true if the permutation of this block has the tag,
else false.
Checks to see if the permutation of this block has a specific tag.
This function can throw errors.
LocationOutOfWorldBoundariesError
checkBlockTags.ts
import { DimensionLocation } from "@minecraft/server";
function checkBlockTags(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
// Fetch the block
const block = targetLocation.dimension.getBlock(targetLocation);
// check that the block is loaded
if (block) {
log(`Block is dirt: ${block.hasTag("dirt")}`);
log(`Block is wood: ${block.hasTag("wood")}`);
log(`Block is stone: ${block.hasTag("stone")}`);
}
}
Beta
The type of liquid this function should be called for.
Whether this block stops liquid from flowing.
Returns whether this block stops liquid from flowing.
This function can throw errors.
Error
Beta
The type of liquid this function should be called for.
Whether this block is removed and spawns its item when touched by liquid.
Returns whether this block is removed and spawns its item when touched by liquid.
This function can throw errors.
Error
Block type identifier to match this API against.
Optional states: Record<string, string | number | boolean>Optional set of block states to test this block against.
Returns true if the block matches the specified criteria.
Tests whether this block matches a specific criteria.
This function can throw errors.
The offset vector. For example, an offset of 0, 1, 0 will return the block above the current block.
Block at the specified offset, or undefined if that block could not be retrieved (for example, the block and its relative chunk is not loaded yet.)
Returns a block at an offset relative vector to this block.
This function can throw errors.
Permutation that contains a set of property states for the Block.
Sets the block in the dimension to the state of the permutation.
This function can't be called in read-only mode.
This function can throw errors.
Identifier of the type of block to apply - for example, minecraft:powered_repeater.
Sets the type of block.
This function can't be called in read-only mode.
This function can throw errors.
Error
true if the block should have water within it.
Sets whether this block has a water logged state - for example, whether stairs are submerged within water.
This function can't be called in read-only mode.
This function can throw errors.
Error
Beta
Permutation that contains a set of property states for the Block.
Returns true if the block permutation data was
successfully set, else false.
Tries to set the block in the dimension to the state of the permutation by first checking if the placement is valid.
This function can't be called in read-only mode.
This function can throw errors.
Represents a block in a dimension. A block represents a unique X, Y, and Z within a dimension and get/sets the state of the block at that location. This type was significantly updated in version 1.17.10.21.