Skip to main content

ℹ️ Properties

Types​

tip

The default option is optional.

boolean​

A property of type boolean can only have two possible values: true or false.

properties:
  happy:
    type: boolean
    default: false

int​

A property of type int can take any integer value within the specified range.

properties:
  mode:
    type: int
    default: 1
    range: 1~3

string​

A property of type string can only take values from a predefined set of options.

properties:
  color:
    type: string
    default: red
    values:
      - red
      - green
      - blue

direction​

east, south, west, north, up, down

properties:
  facing:
    type: direction
    default: north
    values: # Optional
      - north
      - east
      - south
      - west
      - up
      - down

horizontal_direction​

east, south, west, north

properties:
  facing:
    type: horizontal_direction
    default: north
    values: # Optional
      - north
      - south
      - west
      - east

axis​

x, y, z

properties:
  axis:
    type: axis
    default: y
    values: # Optional
      - x
      - y
      - z

single_block_half​

top, bottom

properties:
  half:
    type: single_block_half
    default: bottom
    values: # Optional
      - top
      - bottom

double_block_half​

upper, lower

properties:
  half:
    type: double_block_half
    default: lower
    values: # Optional
      - upper
      - lower

hinge​

left, right

properties:
  hinge:
    type: hinge
    default: left
    values: # Optional
      - left
      - right

slab_type​

top, bottom, double

properties:
  type:
    type: slab_type
    default: bottom
    values: # Optional
      - top
      - bottom
      - double

stairs_shape​

straight, inner_left, inner_right, outer_left, outer_right

properties:
  shape:
    type: stairs_shape
    default: straight
    values: # Optional
      - straight
      - inner_left
      - inner_right
      - outer_left
      - outer_right

sofa_shape​

straight, inner_left, inner_right

properties:
  shape:
    type: sofa_shape
    default: straight
    values: # Optional
      - straight
      - inner_left
      - inner_right

anchor_type​

floor, wall, ceiling

properties:
  face:
    type: anchor_type
    default: floor
    values: # Optional
      - floor
      - wall
      - ceiling

Hard-coded Names​

info

In addition to the names mentioned below, some names are determined by the behavior of the block. For example, the sapling behavior requires a property named stage.

axis​

Based on the face clicked during placement to determine the block's axis.

properties:
  axis:
    type: axis
    default: y
    values: # Optional
      - x
      - y
      - z

waterlogged​

waterlogged determines whether this block can contain water.

warning

Note: When using waterlogged state, ensure that the corresponding visual block also contains water; otherwise, the client will fail to render the water properly.

properties:
  waterlogged:
    type: boolean
    default: false

facing​

When a block has this hardcoded property name, its placement orientation will automatically adapt.

properties:
  facing:
    type: direction
    default: north
    values: # Optional
      - north
      - east
      - south
      - west
      - up
      - down

facing_clockwise​

Unlike the above, it will be rotated 90 degrees when placed

properties:
  facing_clockwise:
    type: horizontal_direction
    default: north
    values: # Optional
      - north
      - south
      - west
      - east

rotation​

Provide higher precision rotation

properties:
  rotation:
    type: int
    default: 0~7
properties:
  rotation:
    type: int
    default: 0~15