Block

Class in @minecraft/server

A block at a place in the world.

import { Block } from '@minecraft/server';

Example

import { world, type Block } from '@minecraft/server';

function describe(block: Block): string {
    const { x, y, z } = block.location;
    return `${block.typeId} at ${x}, ${y}, ${z}`;
}

world.afterEvents.playerBreakBlock.subscribe((event) => {
    event.player.sendMessage(`You broke the block where ${describe(event.block)} now is.`);
});

import { world } from '@minecraft/server';

function describe(block) {
    const { x, y, z } = block.location;
    return `${block.typeId} at ${x}, ${y}, ${z}`;
}

world.afterEvents.playerBreakBlock.subscribe((event) => {
    event.player.sendMessage(`You broke the block where ${describe(event.block)} now is.`);
});

Properties

typeId

read-only

readonly typeId: string;

Its identifier, as minecraft:stone.

type

read-only

readonly type: { readonly id: string };

permutation

read-only

readonly permutation: BlockPermutation;

Its type and states, read from the world when first wanted.

Types

BlockPermutation

location

read-only

readonly location: Vector3;

Types

Vector3

x

read-only

readonly x: number;

y

read-only

readonly y: number;

z

read-only

readonly z: number;

dimension

read-only

readonly dimension: Dimension;

Types

Dimension

isAir

read-only

readonly isAir: boolean;

isLiquid

read-only

readonly isLiquid: boolean;

Whether it’s water or lava.

localizationKey

read-only

readonly localizationKey: string;

The block’s name key in the language files, as tile.stone.name.

isValid

read-only

readonly isValid: boolean;

False once its chunk isn’t loaded.

isWaterlogged

read-only

readonly isWaterlogged: boolean;

Whether it’s waterlogged.

Methods

setType

setType(blockType: string | { id: string }): void;

Sets the block to a type’s default state.

Parameters

blockType: string | { id: string }

setPermutation

setPermutation(permutation: BlockPermutation): void;

Parameters

permutation: BlockPermutation

Types

BlockPermutation

matches

matches(blockName: string, states?: Record<string, boolean | number | string>): boolean;

Whether it’s this block, with these states if given.

Parameters

blockName: string
statesoptional: Record<string, boolean | number | string>

Returns

boolean

offset

offset(offset: Vector3): Block | undefined;

The block this far away, or undefined if its chunk isn’t loaded.

Parameters

offset: Vector3

Returns

Block | undefined

Types

Vector3

above

above(steps?: number): Block | undefined;

The block steps up, 1 by default.

Parameters

stepsoptional: number

Returns

Block | undefined

below

below(steps?: number): Block | undefined;

Parameters

stepsoptional: number

Returns

Block | undefined

north

north(steps?: number): Block | undefined;

Towards -z.

Parameters

stepsoptional: number

Returns

Block | undefined

south

south(steps?: number): Block | undefined;

Towards +z.

Parameters

stepsoptional: number

Returns

Block | undefined

east

east(steps?: number): Block | undefined;

Towards +x.

Parameters

stepsoptional: number

Returns

Block | undefined

west

west(steps?: number): Block | undefined;

Towards -x.

Parameters

stepsoptional: number

Returns

Block | undefined

center

center(): Vector3;

The middle of the block.

Returns

Vector3

Types

Vector3

bottomCenter

bottomCenter(): Vector3;

The middle of the block’s bottom face.

Returns

Vector3

Types

Vector3

setWaterlogged

setWaterlogged(isWaterlogged: boolean): void;

Waterlogs the block, or drains it.

Parameters

isWaterlogged: boolean

getComponent

getComponent<T extends string>(componentId: T): BlockComponentReturnType<T> | undefined;

A block component by name; undefined if absent (Basalt backs none yet).

Parameters

componentId: T

Returns

BlockComponentReturnType<T> | undefined

Types

BlockComponentReturnType

getComponents

getComponents(): BlockComponent[];

Every component on the block.

Returns

BlockComponent[]

Types

BlockComponent

hasComponent

hasComponent(componentId: string): boolean;

Whether it has the component.

Parameters

componentId: string

Returns

boolean

getTags

getTags(): string[];

The block type’s tags, as minecraft:dirt.

Returns

string[]

hasTag

hasTag(tag: string): boolean;

Whether it has this block tag.

Parameters

tag: string

Returns

boolean

getItemStack

getItemStack(amount?: number, withData?: boolean): ItemStack | undefined;

An item stack of the block, if it has one.

Parameters

amountoptional: number
withDataoptional: boolean

Returns

ItemStack | undefined

Types

ItemStack

getRedstonePower

getRedstonePower(): number | undefined;

Its redstone power, or undefined if it isn’t a redstone component.

Returns

number | undefined

getDynamicProperty

getDynamicProperty(identifier: string): boolean | number | string | Vector3 | undefined;

A dynamic property kept in the block’s NBT. It’s saved with the world, moves with a piston, and goes when the block is broken or replaced. Air keeps nothing.

Parameters

identifier: string

Returns

boolean | number | string | Vector3 | undefined

Types

Vector3

setDynamicProperty

setDynamicProperty(identifier: string, value?: boolean | number | string | Vector3): void;

Sets a property on the block, or removes it with undefined.

Parameters

identifier: string
valueoptional: boolean | number | string | Vector3

Types

Vector3

setDynamicProperties

setDynamicProperties(values: Record<string, boolean | number | string | Vector3>): void;

Parameters

values: Record<string, boolean | number | string | Vector3>

Types

Vector3

getDynamicPropertyIds

getDynamicPropertyIds(): string[];

Returns

string[]

getDynamicPropertyTotalByteCount

getDynamicPropertyTotalByteCount(): number;

Returns

number

clearDynamicProperties

clearDynamicProperties(): void;

getLightLevel

getLightLevel(): number;

The light reaching it.

Returns

number

getSkyLightLevel

getSkyLightLevel(): number;

The skylight reaching it.

Returns

number

getParts

getParts(): Block[] | undefined;

The sub-blocks of a multi-block, or undefined.

Returns

Block[] | undefined

canContainLiquid

canContainLiquid(liquidType: LiquidType): boolean;

Whether the block can hold this liquid.

Parameters

liquidType: LiquidType

Returns

boolean

Types

LiquidType

canBeDestroyedByLiquidSpread

canBeDestroyedByLiquidSpread(liquidType: LiquidType): boolean;

Whether spreading liquid would break it.

Parameters

liquidType: LiquidType

Returns

boolean

Types

LiquidType

isLiquidBlocking

isLiquidBlocking(liquidType: LiquidType): boolean;

Whether it stops this liquid.

Parameters

liquidType: LiquidType

Returns

boolean

Types

LiquidType

liquidCanFlowFromDirection

liquidCanFlowFromDirection(liquidType: LiquidType, flowDirection: Direction): boolean;

Whether liquid may flow in from a direction.

Parameters

liquidType: LiquidType
flowDirection: Direction

Returns

boolean

Types

LiquidTypeDirection

liquidSpreadCausesSpawn

liquidSpreadCausesSpawn(liquidType: LiquidType): boolean;

Whether liquid spreading onto it spawns the block’s drop.

Parameters

liquidType: LiquidType

Returns

boolean

Types

LiquidType

Used by