Minecraft:Block definition

A block definition is a Minecraft:JSON file used to define a custom Minecraft:block and its behavior. Block definition files are located in the Template:File folder of a Minecraft:behavior pack.

Structure

Block definitions are structured as follows:

• Template:Nbt/sprite
  • Template:Nbt/sprite format_version: The format version of the file. This is a string representing a Bedrock Edition version. It is recommended to use the latest version. For 26.0 and later, add a leading 1. For example:

1. REDIRECT Template:Code

Template:Redr for 26.0. Preview versions should use the version that it is a preview for (Example: Preview 26.0.27 would be

1. REDIRECT Template:Code

Template:Redr).

• • Template:Nbt/sprite use_beta_features: Whether or not this block is using beta features.
  • Template:Nbt/sprite minecraft:block: The block definition.
    • Template:Nbt/sprite description: The technical definition of the block.
      • Template:Nbt/sprite identifier: A namespaced Minecraft:identifier for the block. This defines the technical name of the block for Minecraft:commands, scripts, and other Minecraft:add-on files.
      • Template:Nbt/sprite menu_category: Defines where the block is located in the Minecraft:creative inventory and recipe book.
        • Template:Nbt/sprite category: The inventory tab to put the block under. Can be

1. REDIRECT Template:Code

Template:Redr. If omitted or

1. REDIRECT Template:Code

Template:Redr, the block will not appear in the creative inventory or recipe book.

• • • • • Template:Nbt/sprite group: The creative inventory group to add the block to. Custom groups can be added via the Template:File. Vanilla groups are:

1. REDIRECT Template:Code

Template:Redr

• • • • • • Template:Nbt/sprite is_hidden_in_commands: Whether or not the block is hidden from commands.
        • [[#States|Template:Nbt/sprite states]]: Definitions of custom block state names and their possible values.
        • [[#Traits|Template:Nbt/sprite traits]]: The block traits to enable, which provide access to specific vanilla states.
      • Template:Nbt/sprite components: The block's components. This defines the block's behavior and visuals.
      • Template:Nbt/sprite permutations: The block's permutations, which allow for components to be added only under certain conditions.
        • Template:Nbt/sprite: A permutation
          • Template:Nbt/sprite condition: The condition when this permutation's components should be active. This should be a Minecraft:molang expression resulting in a boolean.
          • Template:Nbt/sprite components: The components that should be active when the

1. REDIRECT Template:Code

Template:Redr is true.

States

The Template:Nbt/sprite states object is used to define custom block states. Only custom states are allowed, using a vanilla state or the "minecraft" namespace will cause an error and fail. The object consists of state names as properties, and an array of possible values for each state. Integer states can also be defined as a range using an object. Block state values can be queried in permutations using the Minecraft:molang query "query.block_state('<state_name>')".

Examples:

<syntaxhighlight lang=json copy> "states": {

 "example:string_state": ["a", "b", "c"],
 "example:int_state": [1,2,3],
 "example:bool_state": [true,false],
 "example:int_state_2": {
   "min": 0,
   "max": 10
 }

} </syntaxhighlight>

Traits

The Template:Nbt/sprite traits object is used to add vanilla block traits, which allow for custom blocks to have access to some vanilla block states. This object only gives access to the states, other functionality usually has to be added using permutations. The object consists of traits and their enabled states:

minecraft:connection

Gives blocks the boolean states

1. REDIRECT Template:Code

Template:Redr, allowing for the block to connect to blocks next to it.

• Template:Nbt/sprite minecraft:connection
  • Template:Nbt/sprite enabled_states: Which states to enable. The only valid value is minecraft:cardinal_connections.

Example:

<syntaxhighlight lang=json copy> "traits": {

 "minecraft:connection": {
   "enabled_states": ["minecraft:cardinal_connections"]
 }

} </syntaxhighlight>

minecraft:multi_block

Allows a block to be made up of multiple block parts like a Minecraft:door. This adds the

1. REDIRECT Template:Code

Template:Redr state, which is an integer representing which part this block is in the multi block.

• Template:Nbt/sprite minecraft:multi_block
  • Template:Nbt/sprite enabled_states: Which states to enable. The only valid value is

1. REDIRECT Template:Code

Template:Redr.

• • Template:Nbt/sprite parts: The number of parts that this multi block should have. The value must be between 2 and 4, inclusive.
  • Template:Nbt/sprite direction: The direction to place the parts of the multi block in. Can be either

1. REDIRECT Template:Code

Template:Redr.

Example:

<syntaxhighlight lang=json copy> "traits": {

 "minecraft:multi_block": {
   "enabled_states": [
     "minecraft:multi_block_part"
   ],
   "parts": 3,
   "direction": "up"
 }

} </syntaxhighlight>

minecraft:placement_position

Gives blocks states related to where the player places the block. Two states are available:

• minecraft:vertical_half: The half of the block space that the block was placed in, allowing for stair and slab functionality. Possible values are

1. REDIRECT Template:Code

Template:Redr.

• minecraft:block_face: The block face that the player placed the block on, allowing for log and pillar functionality. Possible values are

1. REDIRECT Template:Code

Template:Redr.

• Template:Nbt/sprite minecraft:placement_position
  • Template:Nbt/sprite enabled_states: Which states to enable. Valid values are

1. REDIRECT Template:Code

Template:Redr.

Example:

<syntaxhighlight lang=json copy> "traits": {

 "minecraft:placement_position": {
   "enabled_states": ["minecraft:vertical_half"]
 }

} </syntaxhighlight>

minecraft:placement_direction

Gives blocks states related to the direction in which the player places the block. Three states are available:

• minecraft:cardinal_direction: The direction the player was facing when the block was placed. Possible values are

1. REDIRECT Template:Code

Template:Redr.

• minecraft:facing_direction: Same as minecraft:cardinal_direction, but allows up and down as well. Possible values are

1. REDIRECT Template:Code

Template:Redr.

• minecraft:corner: Allows the block to form corners with other blocks like stairs. Possible values are

1. REDIRECT Template:Code

Template:Redr.

• Template:Nbt/sprite minecraft:placement_direction
  • Template:Nbt/sprite enabled_states: Which states to enable. Valid values are

1. REDIRECT Template:Code

Template:Redr. minecraft:corner_and_cardinal_direction enables both the minecraft:cardinal_direction and minecraft:corner states.

• • Template:Nbt/sprite y_rotation_offset: The offset to apply to the y rotation of the block. Can be

1. REDIRECT Template:Code

Template:Redr.

• • Template:Nbt/sprite blocks_to_corner_with: A list of blocks (or block tags) to consider for minecraft:corner.
    • Template:Nbt/spriteTemplate:Nbt/sprite: Either a block identifier or an object.
      • Template:Nbt/sprite tags: A molang expression representing the tags of the target blocks.

Example:

<syntaxhighlight lang=json copy> "traits": {

 "minecraft:placement_direction": {
   "enabled_states": ["minecraft:corner_and_cardinal_direction"],
   "blocks_to_corner_with": [{"tags": "q.any_tag('minecraft:cornerable_stairs')"}]
 }

} </syntaxhighlight>

Navigation

Editions	Merged Template:Edition Template:Edition Ports to consoles Template:Wikipedia Template:Wikipedia Template:Wikipedia Template:Wikipedia Template:Wikipedia Discontinued Template:Edition Template:Edition Template:Edition
Development	Version history Template:LegacyBlockLink Template:EntityLink Template:FileLink Template:FileLink Template:EnvLink Template:ItemLink Template:BlockLink Template:InvLink Template:EntityLink Template:FileLink Template:EntityLink
Technical	Template:EffectLink Template:FileLink Template:FileLink Template:File com.mojang Template:FileLink Template:File Installation files Template:FileLink Template:FileLink Template:FileLink Template:FileLink Template:BlockLink Template:File Identifier Template:FileLink Template:ItemLink Template:EnvLink Template:EnvLink Anomalous Template:ItemLink Template:EnvLink § Formatting codes Simulation distance Template:BlockLink Template:FileLink Template:FileLink Template:EnvLink Template:FileLink Template:EntityLink Template:BlockLink Development resources Template:Nbt NBT format Template:Nbt Level format Template:EnvLink Protocol Template:EnvLink RakNet Creator Template:File Official documentation Template:FileLink Template:EntityLink Template:File File extensions Template:FileLink Add-ons Template:ItemLink Template:EnvLink Template:EnvLink Template:EnvLink Template:EnvLink Template:FileLink Template:EnvLink Template:EnvLink Template:BiomeLink Template:EnvLink Family Spawn event Template:ItemLink Template:BlockLink Template:EnvLink Template:BiomeLink Template:EnvLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink manifest.json Template:EnvLink Template:Nbt Molang Template:BlockLink
Multiplayer	Template:FileLink Featured servers Event servers Server list Template:FileLink Template:FileLink Template:FileLink Template:FileLink
Exclusive features	Template:FileLink Template:FileLink Template:FileLink Template:FileLink Template:FileLink Template:EnvLink Template:EnvLink Template:ItemLink Template:FileLink Template:FileLink Template:EnvLink Template:EnvLink Template:EnvLink Template:PersonaLink Template:EnvLink Loading tips Template:FileLink Ray Tracing Template:BiomeLink Template:EnvLink Blocks Template:BlockLink Template:BlockLink Mobs Template:EntityLink Template:EntityLink Effects Template:EffectLink Unused Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:EntityLink Template:EntityLink Template:BiomeLink Template:EnvLink
Removed	Template:BlockLink Template:EnvLink Template:EnvLink Template:FileLink Pocket Edition protocol Legacy

pt:Definição de bloco