Class BlockBeta

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.

Hierarchy

  • Block

Constructors

constructor

Properties

dimension isAir isLiquid location permutation x y z

Methods

getComponent isValid setPermutation

Constructors

Private constructor

  • Returns Block

Properties

Readonly dimension

dimension: Dimension

Remarks

Returns the dimension that the block is within.

Readonly Beta isAir

isAir: boolean

Remarks

Returns true if this block is an air block (i.e., empty space).

Throws

This property can throw when used.

LocationInUnloadedChunkError

LocationOutOfWorldBoundariesError

Readonly Beta isLiquid

isLiquid: boolean

Remarks

Returns 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).

Throws

This property can throw when used.

LocationInUnloadedChunkError

LocationOutOfWorldBoundariesError

Readonly location

location: Vector3

Remarks

Coordinates of the specified block.

Throws

This property can throw when used.

Readonly permutation

permutation: BlockPermutation

Remarks

Additional block configuration data that describes the block.

Throws

This property can throw when used.

LocationInUnloadedChunkError

LocationOutOfWorldBoundariesError

Readonly x

x: number

Remarks

X coordinate of the block.

Readonly y

y: number

Remarks

Y coordinate of the block.

Readonly z

z: number

Remarks

Z coordinate of the block.

Methods

getComponent

  • Beta

    Parameters

    • componentName: string

      Identifier of the component. If a namespace is not specified, minecraft: is assumed.

    Returns undefined | BlockComponent

    Returns the component object if it is present on the particular block.

    Remarks

    Gets additional configuration properties (a component) for specific capabilities of particular blocks - for example, an inventory component of a chest block.

    Throws

    This function can throw errors.

    LocationInUnloadedChunkError

    LocationOutOfWorldBoundariesError

isValid

  • Beta

    Returns boolean

    True if this block object is still working and valid.

    Remarks

    Returns 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.)

setPermutation

  • Parameters

    • permutation: BlockPermutation

      Permutation that contains a set of property states for the Block.

    Returns void

    Remarks

    Sets the block in the dimension to the state of the permutation.

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

    LocationInUnloadedChunkError

    LocationOutOfWorldBoundariesError

Settings

Member Visibility

Theme

On This Page