Block Behaviours

Block behaviours can be customized to add unique properties to blocks. All behaviours are optional and can be applied to both, blocks and decorations.

Blocks also work with most item-behaviours to give the blocks' item special features.

Some block behaviours provide blockstate properties you will have to provide models for, like axis, repeater, crop, directional, etc.

Example of a blockResource entry for the repeater behaviour (can be found as relay block in the example datapack):

blockResource:
  models:
    facing=up,powered=false: minecraft:custom/block/arcanery/relay/relay_up_off
    facing=down,powered=false: minecraft:custom/block/arcanery/relay/relay_down_off
    facing=north,powered=false: minecraft:custom/block/arcanery/relay/relay_north_off
    facing=south,powered=false: minecraft:custom/block/arcanery/relay/relay_south_off
    facing=east,powered=false: minecraft:custom/block/arcanery/relay/relay_east_off
    facing=west,powered=false: minecraft:custom/block/arcanery/relay/relay_west_off
    facing=up,powered=true: minecraft:custom/block/arcanery/relay/relay_up_on
    facing=down,powered=true: minecraft:custom/block/arcanery/relay/relay_down_on
    facing=north,powered=true: minecraft:custom/block/arcanery/relay/relay_north_on
    facing=south,powered=true: minecraft:custom/block/arcanery/relay/relay_south_on
    facing=east,powered=true: minecraft:custom/block/arcanery/relay/relay_east_on
    facing=west,powered=true: minecraft:custom/block/arcanery/relay/relay_west_on

{
  "blockResource": {
    "models": {
      "facing=up,powered=false": "minecraft:custom/block/arcanery/relay/relay_up_off",
      "facing=down,powered=false": "minecraft:custom/block/arcanery/relay/relay_down_off",
      "facing=north,powered=false": "minecraft:custom/block/arcanery/relay/relay_north_off",
      "facing=south,powered=false": "minecraft:custom/block/arcanery/relay/relay_south_off",
      "facing=east,powered=false": "minecraft:custom/block/arcanery/relay/relay_east_off",
      "facing=west,powered=false": "minecraft:custom/block/arcanery/relay/relay_west_off",
      "facing=up,powered=true": "minecraft:custom/block/arcanery/relay/relay_up_on",
      "facing=down,powered=true": "minecraft:custom/block/arcanery/relay/relay_down_on",
      "facing=north,powered=true": "minecraft:custom/block/arcanery/relay/relay_north_on",
      "facing=south,powered=true": "minecraft:custom/block/arcanery/relay/relay_south_on",
      "facing=east,powered=true": "minecraft:custom/block/arcanery/relay/relay_east_on",
      "facing=west,powered=true": "minecraft:custom/block/arcanery/relay/relay_west_on"
    }
  }
}

blockResource:
  models:
    lit=false,facing=north:
      model: minecraft:block/furnace
      y: 0
    lit=false,facing=south:
      model: minecraft:block/furnace
      y: 180
    lit=false,facing=east:
      model: minecraft:block/furnace
      y: 90
    lit=false,facing=west:
      model: minecraft:block/furnace
      y: 270
    lit=true,facing=north:
      model: minecraft:block/furnace_on
      y: 0
    lit=true,facing=south:
      model: minecraft:block/furnace_on
      y: 180
    lit=true,facing=east:
      model: minecraft:block/furnace_on
      y: 90
    lit=true,facing=west:
      model: minecraft:block/furnace_on
      y: 270

{
  "blockResource": {
    "models": {
      "lit=false,facing=north": { "model": "minecraft:block/furnace", "y": 0 },
      "lit=false,facing=south": { "model": "minecraft:block/furnace", "y": 180 },
      "lit=false,facing=east": { "model": "minecraft:block/furnace", "y": 90 },
      "lit=false,facing=west": { "model": "minecraft:block/furnace", "y": 270 },
      "lit=true,facing=north": { "model": "minecraft:block/furnace_on", "y": 0 },
      "lit=true,facing=south": { "model": "minecraft:block/furnace_on", "y": 180 },
      "lit=true,facing=east": { "model": "minecraft:block/furnace_on", "y": 90 },
      "lit=true,facing=west": { "model": "minecraft:block/furnace_on", "y": 270 }
    }
  }
}

id: mynamespace:myblock
blockResource:
  models:
    lit=false,facing=north:
      model: minecraft:block/furnace
      y: 0
    lit=false,facing=south:
      model: minecraft:block/furnace
      y: 180
    lit=false,facing=east:
      model: minecraft:block/furnace
      y: 90
    lit=false,facing=west:
      model: minecraft:block/furnace
      y: 270
    lit=true,facing=north:
      model: minecraft:block/furnace_on
      y: 0
    lit=true,facing=south:
      model: minecraft:block/furnace_on
      y: 180
    lit=true,facing=east:
      model: minecraft:block/furnace_on
      y: 90
    lit=true,facing=west:
      model: minecraft:block/furnace_on
      y: 270
blockModelType: full_block
properties:
  destroyTime: 0
  blockBase: minecraft:stone
behaviour:
  powersource:
    value: 15
  repeater:
    delay: 1
    loss: 1
  fuel:
    value: 10
  cosmetic:
    slot: chest
    model: mynamespace:custom/models/clown_backpack_animated
    autoplay: idle
    scale: [1.5, 1.5, 1.5]
    translation: [0.0, 0.5, 0.0]
  strippable:
    replacement: minecraft:stone

{
  "id": "mynamespace:myblock",
    "blockResource": {
    "models": {
      "lit=false,facing=north": { "model": "minecraft:block/furnace", "y": 0 },
      "lit=false,facing=south": { "model": "minecraft:block/furnace", "y": 180 },
      "lit=false,facing=east": { "model": "minecraft:block/furnace", "y": 90 },
      "lit=false,facing=west": { "model": "minecraft:block/furnace", "y": 270 },
      "lit=true,facing=north": { "model": "minecraft:block/furnace_on", "y": 0 },
      "lit=true,facing=south": { "model": "minecraft:block/furnace_on", "y": 180 },
      "lit=true,facing=east": { "model": "minecraft:block/furnace_on", "y": 90 },
      "lit=true,facing=west": { "model": "minecraft:block/furnace_on", "y": 270 }
    }
  },
  "blockModelType": "full_block",
  "properties": {
    "destroyTime": 0,
    "blockBase": "minecraft:stone"
  },
  "behaviour": {
    "powersource": {
      "value": 15
    },
    "repeater": {
      "delay": 1,
      "loss": 1
    },
    "fuel": {
      "value": 10
    },
    "cosmetic": {
      "slot": "chest",
      "model": "mynamespace:custom/models/clown_backpack_animated",
      "autoplay": "idle",
      "scale": [1.5, 1.5, 1.5],
      "translation": [0.0, 0.5, 0.0]
    },
    "strippable": {
      "replacement": "minecraft:stone"
    }
  }
}

This creates a block + item that can be worn and when worn shows an animated blockbench model on the player. The item is also a food and can be used as fuel source in furnaces.

The block acts as a redstone powersource of level 15 and a repeater/relay and is strippable (turns to stone when stripped with an axe or an item with the stripper item behaviour)

While possible, you probably don't want to combine powersource with repeater for actual blocks/items for obvious reasons.

Behaviours

axis behaviour

Gives the block an axis property/block-state similar to wooden logs/pillars and handles placement.

connectable behaviour

This behaviour allows the block to connect to other blocks, similar to stairs, but requiring a block on both sides of a corner to be present in order to the corner shape. Optionally without the corner states.

This behaviour is best used with decorations, as you will only have to define 6 models:

itemResource:
  models:
    default: minecraft:custom/furniture/benches/middle_connectable
    inner: minecraft:custom/furniture/benches/inner_connectable
    outer: minecraft:custom/furniture/benches/outer_connectable
    middle: minecraft:custom/furniture/benches/middle_connectable
    left: minecraft:custom/furniture/benches/left_connectable
    right: minecraft:custom/furniture/benches/right_connectable
    single: minecraft:custom/furniture/benches/single_connectable

{
  "itemResource": {
    "models": {
      "default": "minecraft:custom/furniture/benches/middle_connectable",
      "inner": "minecraft:custom/furniture/benches/inner_connectable",
      "outer": "minecraft:custom/furniture/benches/outer_connectable",
      "middle": "minecraft:custom/furniture/benches/middle_connectable",
      "left": "minecraft:custom/furniture/benches/left_connectable",
      "right": "minecraft:custom/furniture/benches/right_connectable",
      "single": "minecraft:custom/furniture/benches/single_connectable"
    }
  }
}

count behaviour

Gives the block a count property/block-state.

Works similar to turtle eggs or candles, allows you to place "multiple blocks/items" into one block.

facing behaviour

Gives the block a facing property/block-state similar to wooden logs/pillars and handles placement.

horizontal_facing behaviour

Gives the block a facing property/block-state similar to furnaces and handles placement. Does not support up and down facing directions.

crop behaviour

Makes the block behave like a crop, bonemeable, growing, minimum light requirement, etc. Also gives a growth bonus similar to vanilla crops, which check for farmland blocks in a 3x3 area centered below the crop block. The bonus block and radius can be configured.

You probably want to use this behaviour together with the can_survive behaviour.

If you want your custom crop block to not turn farmland into dirt without moisture, like vanilla crops do, add your block to the block tag maintains_farmland.

In order for the farmland to not turn into dirt when placing the crop on top of it, make sure the solid property is set to false

For bee pollination, use the block tag bee_growables.

You can make farmer villagers able to plant the seeds using the item tag villager_plantable_seeds. Villagers will only work on crops that are on top of farmland blocks (vanilla limitation).

sapling behaviour

Makes your block behave like vanilla saplings, growing based on random ticks and bonemealable.

All identifiers for the configured_placements are optional, they will only get used when configured.

You add your own configured placement for trees using vanilla datapack mechanics.

can_survive behaviour

Checks for the block below with one of the configured block tags or blocks list. The block will break off, similar to flowers or crops, when the block below them is not supported.

The behaviour will automatically check for and apply any facing or axis block-state properties.

Useful for bushes/plants/crops/flowers and more

powersource behaviour

Defines the block as a redstone power source.

behaviour:
  powersource:
    value:
      age=0: 0
      age=1: 15

{
  "behaviour": {
    "powersource": {
      "value": {
        "age=0": 0,
        "age=1": 15
      }
    }
  }
}

behaviour:
  powersource:
    value: 5

{
  "behaviour": {
    "powersource": {
      "value": 5
    }
  }
}

repeater behaviour

Defines the block as a redstone repeater with configurable delay and loss.

powerlevel behaviour

Supplies a powerlevel blockstate and changes to it depending on the input redstone signal.

strippable behaviour

Defines the block as strippable, replacing it with another block when interacted with an axe.

slab behaviour

Defines the block as slab, top, bottom, double, with placements, waterloggable.

trapdoor behaviour

Trapdoor like block.

door behaviour

Door-like "block" that is 2 blocks high. Comes with all door block state properties (hinge, open, powered, etc.)

waterloggable behaviour

Simple waterloggable block with a waterlogged property.

There is an alias called simple_waterloggable for backwards compatibility with older filament data packs

drop_xp behaviour

Makes the block drop xp when being mined without the silk-touch enchantment.

behaviour:
  drop_xp:
    min:
      age=0: 0
      age=1: 0
      age=2: 4
    max:
      age=0: 0
      age=1: 0
      age=2: 6

{
  "behaviour": {
    "drop_xp": {
      "min": {
        "age=0": 0,
        "age=1": 0,
        "age=2": 4
      },
      "max": {
        "age=0": 0,
        "age=1": 0,
        "age=2": 6
      }
    }
  }
}

behaviour:
  drop_xp: 6

{
  "behaviour": {
    "drop_xp": 6
  }
}

block_interact_execute behaviour

Executes a command on block interaction from console, as player (@s).

block_attack_execute behaviour

Executes a command when the block is "attacked", from console, as player (@s).

oxidizable behaviour

Defines the block as oxidizing block, similar to the vanilla copper blocks, randomly replacing it with another block when it "ages". Can be reverted/scraped by axes and resets with lightning bolts like vanilla copper blocks.

budding behaviour

With this behaviour the blocks grows other blocks, similar to budding amethyst blocks. The sides, blocks and chance can be configured.

If the blocks in grows have directional/facing block state properties, they direction of the side the block is growing from will be set.

grass_spread behaviour

Allows the block to spread like mycelium or grass blocks do, based on random ticks.

falling_block behaviour

Makes the block a gravity affected/falling block like sand or anvils.

falling_block:
  delayAfterPlace: 2 # delay in ticks before the block falls
  heavy: true # to cause anvil-like damage
  damagePerDistance: 2.0 # accumulated damage per block fallen
  maxDamage: 40 # maximum damage
  disableDrops: false # prevent the block from being placed
  silent: false # no sounds
  landSound: minecraft:block.anvil.land
  breakSound: minecraft:block.anvil.destroy
  canBeDamaged: true # flag whether the block should be placed as the block in "damagedBlock"
  damagedBlock: minecraft:diamond_block # new block to use, will copy applicable block state property
  baseBreakChance: 0.05 # chance for the block to "break" to the block in "damagedBlock"
  breakChancePerDistance: 0.05 # chance increase per block fallen

{
  "falling_block": {
    "delayAfterPlace": 2, // delay in ticks before the block falls
    "heavy": true, // to cause anvil-like damage
    "damagePerDistance": 2.0, // accumulated damage per block fallen
    "maxDamage": 40, // maximum damage
    "disableDrops": false, // prevent the block from being placed
    "silent": false, // no sounds
    "landSound": "minecraft:block.anvil.land",
    "breakSound": "minecraft:block.anvil.destroy",
    "canBeDamaged": true, // flag whether the block should be placed as the block in "damagedBlock"
    "damagedBlock": "minecraft:diamond_block", // new block to use, will copy applicable block state property
    "baseBreakChance": 0.05, // chance for the block to "break" to the block in "damagedBlock"
    "breakChancePerDistance": 0.05 // chance increase per block fallen
  }
}

tnt behaviour

With this behaviour the block can be lit with flint and steel or redstone to spawn a TNT entity with the blockstate of this block.

Block behaviours with block entity

The following block-behaviours require a block entity. They can not be pushed, so make sure the pushReaction in your block properties is set to destroy, block or ignore.

furnace behaviour

Furnace behaviour with menu.

hopper behaviour

Hopper behaviour with menu.

flammable behaviour

Makes the block flammable.

leaf_decay behaviour

Makes the block decay like leaf blocks when no log is attached to it and wasn't placed by a player. Adds distance and persistent block state properties to the block.

lamp behaviour

Allows you to create lamps that either switch on/off or cycle through a list of light levels on player interaction.

lamp:
  on: 15
  off: 0

{
  "lamp": {
    "on": 15,
    "off": 0
  }
}

lamp:
  cycle: [0, 2, 4, 6, 8, 10, 12, 14]

{
  "lamp": {
    "cycle": [0, 2, 4, 6, 8, 10, 12, 14]
  }
}

waxable behaviour

Allows the block to be 'waxed' using honeycomb or with filament items that have the "wax" behaviour.

place_on_water behaviour

Allows the block to be placed on water. Use this behaviour together with the can_survive behaviour to recreate lily-pads!

No fields to configure.

bouncy behaviour

Allows to make the block bouncy, similar to slime but extra bounciness when the player presses space on landing.

particle_emitter behaviour

Adds particle emitters to the block.

particle_emitter:
  enabled:
    powerlevel=1: true
    powerlevel=0: false
  elements:
    - enabled: true
      particle:
        type: scrape
      interval: 5
      offset: [0.5, "0..0.5", 0.5]
      count: 5
      delta: [0, 0, 0]
      speed: 0.1
      force: false

{
  "particle_emitter": {
    "enabled": {
      "powerlevel=1": true,
      "powerlevel=0": false
    },
    "elements": [
      {
        "enabled": true,
        "particle": {
          "type": "scrape"
        },
        "interval": 5,
        "offset": [0.5, "0..0.5", 0.5],
        "count": 5,
        "delta": [0, 0, 0],
        "speed": 0.1,
        "force": false
      }
    ]
  }
}

The offset, count, delta and speed can have ranged values like "0..1" - this will pick a random number between 0 and 1.

Some particle types have additional options like color.

status_effect_emitter behaviour

Adds status effect emitters to the block.

Allows for ranged values and enabling based on block-state.

status_effect_emitter:
  enabled:
    powerlevel=1: true
    powerlevel=0: false
  elements:
    - enabled: true
      interval: 100
      onlyPlayer: true
      ignoreHeight: false
      radius: 16
      effect: speed
      duration: 200
      amplifier: 0
      ambient: true
      visible: true
      showIcon: true

{
  "status_effect_emitter": {
    "enabled": {
      "powerlevel=1": true,
      "powerlevel=0": false
    },
    "elements": [
      {
        "enabled": true,
        "interval": 100,
        "onlyPlayer": true,
        "ignoreHeight": false,
        "radius": 16,
        "effect": "speed",
        "duration": 200,
        "amplifier": 0,
        "ambient": true,
        "visible": true,
        "showIcon": true
      }
    ]
  }
}

area_execute behaviour

Executes commands when a players enter/leaves or stays in an area. Optionally based on luckperms permission.

area_execute:
  radius: 16
  enabled: true
  interval: 40
  enterCommands:
    - "title %player% actionbar {\"text\":\"Hello, %player%!\"}"
  repeatCommands:
    - "playsound minecraft:entity.cat.purr master %player%"
  exitCommands:
    - "title %player% actionbar {\"text\":\"Goodbye, %player%!\"}"
  atBlock: true
  ignoreHeight: false
  permission: "mything.area.affected" # optional, luckperms based

{
  "area_execute": {
    "radius": 16,
    "enabled": true,
    "interval": 40,
    "enterCommands": ["title %player% actionbar {\"text\":\"Hello, %player%!\"}"],
    "repeatCommands": ["playsound minecraft:entity.cat.purr master %player%"],
    "exitCommands": ["title %player% actionbar {\"text\":\"Goodbye, %player%!\"}"],
    "atBlock": true,
    "ignoreHeight": false,
    "permission": "mything.area.affected"
  }
}

ignite_entity behaviour

Sets an entity on fire when it is inside the block

lever behaviour

Defines the block as an interactive lever that can emit redstone power and play sounds when toggled.

behaviour:
  lever:
    powerlevel: 15
    sound: minecraft:block.lever.click
    volume:
      powered=true: 0.2
      powered=false: 0.3

{
  "behaviour": {
    "lever": {
      "powerlevel": 15,
      "sound": "minecraft:block.lever.click",
      "volume": {
        "powered=true": 0.2,
        "powered=false": 0.3
      }
    }
  }
}

button behaviour

Defines the block as an interactive button that can emit redstone power for a limited duration when pressed.

behaviour:
  button:
    powerlevel:
      powered=false: 0
      powered=true: 15
    ticksToStayPressed:
      material=stone: 20
      material=wood: 100
    canBeActivatedByArrows:
      material=stone: false
      material=wood: true

{
  "behaviour": {
    "button": {
      "powerlevel": {
        "powered=false": 0,
        "powered=true": 15
      },
      "ticksToStayPressed": {
        "material=stone": 20,
        "material=wood": 100
      },
      "canBeActivatedByArrows": {
        "material=stone": false,
        "material=wood": true
      }
    }
  }
}