Index
-| BlockStates |
|---|
| Blocks |
| Entities |
| Entity Damage Source |
| Geometry |
| Blocks |
| Items |
| manifest.json |
BlockStates
- -| Type | Block State Name | Valid Values | Description |
|---|---|---|---|
| Boolean | -age_bit | -True, False | -Determines if saplings should grow | -
| Integer | -age | -0 - 15 | -Represents the age of the block | -
| String | -portal_axis | -unknown, x, z | -Determines the orientation of portal blocks | -
Blocks
- -| Name |
|---|
| minecraft:acacia_button | -
| minecraft:acacia_door | -
| minecraft:acacia_fence_gate | -
| minecraft:acacia_pressure_plate | -
| minecraft:acacia_stairs | -
| minecraft:acacia_standing_sign | -
| minecraft:acacia_trapdoor | -
| minecraft:acacia_wall_sign | -
| minecraft:activator_rail | -
| minecraft:air | -
| minecraft:allow | -
| minecraft:amethyst_block | -
| minecraft:amethyst_cluster | -
| minecraft:ancient_debris | -
| minecraft:andesite_stairs | -
| minecraft:anvil | -
| minecraft:azalea | -
| minecraft:azalea_leaves | -
| minecraft:azalea_leaves_flowered | -
| minecraft:bamboo | -
| minecraft:bamboo_sapling | -
| minecraft:barrel | -
| minecraft:barrier | -
| minecraft:basalt | -
| minecraft:beacon | -
| minecraft:bed | -
| minecraft:bedrock | -
| minecraft:bee_nest | -
| minecraft:beehive | -
| minecraft:beetroot | -
| minecraft:bell | -
| minecraft:big_dripleaf | -
| minecraft:birch_button | -
| minecraft:birch_door | -
| minecraft:birch_fence_gate | -
| minecraft:birch_pressure_plate | -
| minecraft:birch_stairs | -
| minecraft:birch_standing_sign | -
| minecraft:birch_trapdoor | -
| minecraft:birch_wall_sign | -
| minecraft:black_candle | -
| minecraft:black_candle_cake | -
| minecraft:black_glazed_terracotta | -
| minecraft:blackstone | -
| minecraft:blackstone_double_slab | -
| minecraft:blackstone_slab | -
| minecraft:blackstone_stairs | -
| minecraft:blackstone_wall | -
| minecraft:blast_furnace | -
| minecraft:blue_candle | -
| minecraft:blue_candle_cake | -
| minecraft:blue_glazed_terracotta | -
| minecraft:blue_ice | -
| minecraft:bone_block | -
| minecraft:bookshelf | -
| minecraft:border_block | -
| minecraft:brewing_stand | -
| minecraft:brick_block | -
| minecraft:brick_stairs | -
| minecraft:brown_candle | -
| minecraft:brown_candle_cake | -
| minecraft:brown_glazed_terracotta | -
| minecraft:brown_mushroom | -
| minecraft:brown_mushroom_block | -
| minecraft:bubble_column | -
| minecraft:budding_amethyst | -
| minecraft:cactus | -
| minecraft:cake | -
| minecraft:calcite | -
| minecraft:camera | -
| minecraft:campfire | -
| minecraft:candle | -
| minecraft:candle_cake | -
| minecraft:carpet | -
| minecraft:carrots | -
| minecraft:cartography_table | -
| minecraft:carved_pumpkin | -
| minecraft:cauldron | -
| minecraft:cave_vines | -
| minecraft:cave_vines_body_with_berries | -
| minecraft:cave_vines_head_with_berries | -
| minecraft:chain | -
| minecraft:chain_command_block | -
| minecraft:chemical_heat | -
| minecraft:chemistry_table | -
| minecraft:chest | -
| minecraft:chiseled_deepslate | -
| minecraft:chiseled_nether_bricks | -
| minecraft:chiseled_polished_blackstone | -
| minecraft:chorus_flower | -
| minecraft:chorus_plant | -
| minecraft:clay | -
| minecraft:client_request_placeholder_block | -
| minecraft:coal_block | -
| minecraft:coal_ore | -
| minecraft:cobbled_deepslate | -
| minecraft:cobbled_deepslate_double_slab | -
| minecraft:cobbled_deepslate_slab | -
| minecraft:cobbled_deepslate_stairs | -
| minecraft:cobbled_deepslate_wall | -
| minecraft:cobblestone | -
| minecraft:cobblestone_wall | -
| minecraft:cocoa | -
| minecraft:colored_torch_bp | -
| minecraft:colored_torch_rg | -
| minecraft:command_block | -
| minecraft:composter | -
| minecraft:concrete | -
| minecraft:concretePowder | -
| minecraft:conduit | -
| minecraft:copper_block | -
| minecraft:copper_ore | -
| minecraft:coral | -
| minecraft:coral_block | -
| minecraft:coral_fan | -
| minecraft:coral_fan_dead | -
| minecraft:coral_fan_hang | -
| minecraft:coral_fan_hang2 | -
| minecraft:coral_fan_hang3 | -
| minecraft:cracked_deepslate_bricks | -
| minecraft:cracked_deepslate_tiles | -
| minecraft:cracked_nether_bricks | -
| minecraft:cracked_polished_blackstone_bricks | -
| minecraft:crafting_table | -
| minecraft:crimson_button | -
| minecraft:crimson_door | -
| minecraft:crimson_double_slab | -
| minecraft:crimson_fence | -
| minecraft:crimson_fence_gate | -
| minecraft:crimson_fungus | -
| minecraft:crimson_hyphae | -
| minecraft:crimson_nylium | -
| minecraft:crimson_planks | -
| minecraft:crimson_pressure_plate | -
| minecraft:crimson_roots | -
| minecraft:crimson_slab | -
| minecraft:crimson_stairs | -
| minecraft:crimson_standing_sign | -
| minecraft:crimson_stem | -
| minecraft:crimson_trapdoor | -
| minecraft:crimson_wall_sign | -
| minecraft:crying_obsidian | -
| minecraft:cut_copper | -
| minecraft:cut_copper_slab | -
| minecraft:cut_copper_stairs | -
| minecraft:cyan_candle | -
| minecraft:cyan_candle_cake | -
| minecraft:cyan_glazed_terracotta | -
| minecraft:dark_oak_button | -
| minecraft:dark_oak_door | -
| minecraft:dark_oak_fence_gate | -
| minecraft:dark_oak_pressure_plate | -
| minecraft:dark_oak_stairs | -
| minecraft:dark_oak_trapdoor | -
| minecraft:dark_prismarine_stairs | -
| minecraft:darkoak_standing_sign | -
| minecraft:darkoak_wall_sign | -
| minecraft:daylight_detector | -
| minecraft:daylight_detector_inverted | -
| minecraft:deadbush | -
| minecraft:deepslate | -
| minecraft:deepslate_brick_double_slab | -
| minecraft:deepslate_brick_slab | -
| minecraft:deepslate_brick_stairs | -
| minecraft:deepslate_brick_wall | -
| minecraft:deepslate_bricks | -
| minecraft:deepslate_coal_ore | -
| minecraft:deepslate_copper_ore | -
| minecraft:deepslate_diamond_ore | -
| minecraft:deepslate_emerald_ore | -
| minecraft:deepslate_gold_ore | -
| minecraft:deepslate_iron_ore | -
| minecraft:deepslate_lapis_ore | -
| minecraft:deepslate_redstone_ore | -
| minecraft:deepslate_tile_double_slab | -
| minecraft:deepslate_tile_slab | -
| minecraft:deepslate_tile_stairs | -
| minecraft:deepslate_tile_wall | -
| minecraft:deepslate_tiles | -
| minecraft:deny | -
| minecraft:detector_rail | -
| minecraft:diamond_block | -
| minecraft:diamond_ore | -
| minecraft:diorite_stairs | -
| minecraft:dirt | -
| minecraft:dirt_with_roots | -
| minecraft:dispenser | -
| minecraft:double_cut_copper_slab | -
| minecraft:double_plant | -
| minecraft:double_stone_slab | -
| minecraft:double_stone_slab2 | -
| minecraft:double_stone_slab3 | -
| minecraft:double_stone_slab4 | -
| minecraft:double_wooden_slab | -
| minecraft:dragon_egg | -
| minecraft:dried_kelp_block | -
| minecraft:dripstone_block | -
| minecraft:dropper | -
| minecraft:element_0 | -
| minecraft:element_1 | -
| minecraft:element_10 | -
| minecraft:element_100 | -
| minecraft:element_101 | -
| minecraft:element_102 | -
| minecraft:element_103 | -
| minecraft:element_104 | -
| minecraft:element_105 | -
| minecraft:element_106 | -
| minecraft:element_107 | -
| minecraft:element_108 | -
| minecraft:element_109 | -
| minecraft:element_11 | -
| minecraft:element_110 | -
| minecraft:element_111 | -
| minecraft:element_112 | -
| minecraft:element_113 | -
| minecraft:element_114 | -
| minecraft:element_115 | -
| minecraft:element_116 | -
| minecraft:element_117 | -
| minecraft:element_118 | -
| minecraft:element_12 | -
| minecraft:element_13 | -
| minecraft:element_14 | -
| minecraft:element_15 | -
| minecraft:element_16 | -
| minecraft:element_17 | -
| minecraft:element_18 | -
| minecraft:element_19 | -
| minecraft:element_2 | -
| minecraft:element_20 | -
| minecraft:element_21 | -
| minecraft:element_22 | -
| minecraft:element_23 | -
| minecraft:element_24 | -
| minecraft:element_25 | -
| minecraft:element_26 | -
| minecraft:element_27 | -
| minecraft:element_28 | -
| minecraft:element_29 | -
| minecraft:element_3 | -
| minecraft:element_30 | -
| minecraft:element_31 | -
| minecraft:element_32 | -
| minecraft:element_33 | -
| minecraft:element_34 | -
| minecraft:element_35 | -
| minecraft:element_36 | -
| minecraft:element_37 | -
| minecraft:element_38 | -
| minecraft:element_39 | -
| minecraft:element_4 | -
| minecraft:element_40 | -
| minecraft:element_41 | -
| minecraft:element_42 | -
| minecraft:element_43 | -
| minecraft:element_44 | -
| minecraft:element_45 | -
| minecraft:element_46 | -
| minecraft:element_47 | -
| minecraft:element_48 | -
| minecraft:element_49 | -
| minecraft:element_5 | -
| minecraft:element_50 | -
| minecraft:element_51 | -
| minecraft:element_52 | -
| minecraft:element_53 | -
| minecraft:element_54 | -
| minecraft:element_55 | -
| minecraft:element_56 | -
| minecraft:element_57 | -
| minecraft:element_58 | -
| minecraft:element_59 | -
| minecraft:element_6 | -
| minecraft:element_60 | -
| minecraft:element_61 | -
| minecraft:element_62 | -
| minecraft:element_63 | -
| minecraft:element_64 | -
| minecraft:element_65 | -
| minecraft:element_66 | -
| minecraft:element_67 | -
| minecraft:element_68 | -
| minecraft:element_69 | -
| minecraft:element_7 | -
| minecraft:element_70 | -
| minecraft:element_71 | -
| minecraft:element_72 | -
| minecraft:element_73 | -
| minecraft:element_74 | -
| minecraft:element_75 | -
| minecraft:element_76 | -
| minecraft:element_77 | -
| minecraft:element_78 | -
| minecraft:element_79 | -
| minecraft:element_8 | -
| minecraft:element_80 | -
| minecraft:element_81 | -
| minecraft:element_82 | -
| minecraft:element_83 | -
| minecraft:element_84 | -
| minecraft:element_85 | -
| minecraft:element_86 | -
| minecraft:element_87 | -
| minecraft:element_88 | -
| minecraft:element_89 | -
| minecraft:element_9 | -
| minecraft:element_90 | -
| minecraft:element_91 | -
| minecraft:element_92 | -
| minecraft:element_93 | -
| minecraft:element_94 | -
| minecraft:element_95 | -
| minecraft:element_96 | -
| minecraft:element_97 | -
| minecraft:element_98 | -
| minecraft:element_99 | -
| minecraft:emerald_block | -
| minecraft:emerald_ore | -
| minecraft:enchanting_table | -
| minecraft:end_brick_stairs | -
| minecraft:end_bricks | -
| minecraft:end_gateway | -
| minecraft:end_portal | -
| minecraft:end_portal_frame | -
| minecraft:end_rod | -
| minecraft:end_stone | -
| minecraft:ender_chest | -
| minecraft:exposed_copper | -
| minecraft:exposed_cut_copper | -
| minecraft:exposed_cut_copper_slab | -
| minecraft:exposed_cut_copper_stairs | -
| minecraft:exposed_double_cut_copper_slab | -
| minecraft:farmland | -
| minecraft:fence | -
| minecraft:fence_gate | -
| minecraft:fire | -
| minecraft:fletching_table | -
| minecraft:flower_pot | -
| minecraft:flowering_azalea | -
| minecraft:flowing_lava | -
| minecraft:flowing_water | -
| minecraft:frame | -
| minecraft:frosted_ice | -
| minecraft:furnace | -
| minecraft:gilded_blackstone | -
| minecraft:glass | -
| minecraft:glass_pane | -
| minecraft:glow_frame | -
| minecraft:glow_lichen | -
| minecraft:glowingobsidian | -
| minecraft:glowstone | -
| minecraft:gold_block | -
| minecraft:gold_ore | -
| minecraft:golden_rail | -
| minecraft:granite_stairs | -
| minecraft:grass | -
| minecraft:grass_path | -
| minecraft:gravel | -
| minecraft:gray_candle | -
| minecraft:gray_candle_cake | -
| minecraft:gray_glazed_terracotta | -
| minecraft:green_candle | -
| minecraft:green_candle_cake | -
| minecraft:green_glazed_terracotta | -
| minecraft:grindstone | -
| minecraft:hanging_roots | -
| minecraft:hard_glass | -
| minecraft:hard_glass_pane | -
| minecraft:hard_stained_glass | -
| minecraft:hard_stained_glass_pane | -
| minecraft:hardened_clay | -
| minecraft:hay_block | -
| minecraft:heavy_weighted_pressure_plate | -
| minecraft:honey_block | -
| minecraft:honeycomb_block | -
| minecraft:hopper | -
| minecraft:ice | -
| minecraft:infested_deepslate | -
| minecraft:info_update | -
| minecraft:info_update2 | -
| minecraft:invisibleBedrock | -
| minecraft:iron_bars | -
| minecraft:iron_block | -
| minecraft:iron_door | -
| minecraft:iron_ore | -
| minecraft:iron_trapdoor | -
| minecraft:jigsaw | -
| minecraft:jukebox | -
| minecraft:jungle_button | -
| minecraft:jungle_door | -
| minecraft:jungle_fence_gate | -
| minecraft:jungle_pressure_plate | -
| minecraft:jungle_stairs | -
| minecraft:jungle_standing_sign | -
| minecraft:jungle_trapdoor | -
| minecraft:jungle_wall_sign | -
| minecraft:kelp | -
| minecraft:ladder | -
| minecraft:lantern | -
| minecraft:lapis_block | -
| minecraft:lapis_ore | -
| minecraft:large_amethyst_bud | -
| minecraft:lava | -
| minecraft:lava_cauldron | -
| minecraft:leaves | -
| minecraft:leaves2 | -
| minecraft:lectern | -
| minecraft:lever | -
| minecraft:light_block | -
| minecraft:light_blue_candle | -
| minecraft:light_blue_candle_cake | -
| minecraft:light_blue_glazed_terracotta | -
| minecraft:light_gray_candle | -
| minecraft:light_gray_candle_cake | -
| minecraft:light_weighted_pressure_plate | -
| minecraft:lightning_rod | -
| minecraft:lime_candle | -
| minecraft:lime_candle_cake | -
| minecraft:lime_glazed_terracotta | -
| minecraft:lit_blast_furnace | -
| minecraft:lit_deepslate_redstone_ore | -
| minecraft:lit_furnace | -
| minecraft:lit_pumpkin | -
| minecraft:lit_redstone_lamp | -
| minecraft:lit_redstone_ore | -
| minecraft:lit_smoker | -
| minecraft:lodestone | -
| minecraft:log | -
| minecraft:log2 | -
| minecraft:loom | -
| minecraft:magenta_candle | -
| minecraft:magenta_candle_cake | -
| minecraft:magenta_glazed_terracotta | -
| minecraft:magma | -
| minecraft:medium_amethyst_bud | -
| minecraft:melon_block | -
| minecraft:melon_stem | -
| minecraft:mob_spawner | -
| minecraft:monster_egg | -
| minecraft:moss_block | -
| minecraft:moss_carpet | -
| minecraft:mossy_cobblestone | -
| minecraft:mossy_cobblestone_stairs | -
| minecraft:mossy_stone_brick_stairs | -
| minecraft:movingBlock | -
| minecraft:mycelium | -
| minecraft:mysterious_frame | -
| minecraft:mysterious_frame_slot | -
| minecraft:nether_brick | -
| minecraft:nether_brick_fence | -
| minecraft:nether_brick_stairs | -
| minecraft:nether_gold_ore | -
| minecraft:nether_sprouts | -
| minecraft:nether_wart | -
| minecraft:nether_wart_block | -
| minecraft:netherite_block | -
| minecraft:netherrack | -
| minecraft:netherreactor | -
| minecraft:normal_stone_stairs | -
| minecraft:noteblock | -
| minecraft:oak_stairs | -
| minecraft:observer | -
| minecraft:obsidian | -
| minecraft:orange_candle | -
| minecraft:orange_candle_cake | -
| minecraft:orange_glazed_terracotta | -
| minecraft:oxidized_copper | -
| minecraft:oxidized_cut_copper | -
| minecraft:oxidized_cut_copper_slab | -
| minecraft:oxidized_cut_copper_stairs | -
| minecraft:oxidized_double_cut_copper_slab | -
| minecraft:packed_ice | -
| minecraft:pink_candle | -
| minecraft:pink_candle_cake | -
| minecraft:pink_glazed_terracotta | -
| minecraft:piston | -
| minecraft:pistonArmCollision | -
| minecraft:planks | -
| minecraft:podzol | -
| minecraft:pointed_dripstone | -
| minecraft:polished_andesite_stairs | -
| minecraft:polished_basalt | -
| minecraft:polished_blackstone | -
| minecraft:polished_blackstone_brick_double_slab | -
| minecraft:polished_blackstone_brick_slab | -
| minecraft:polished_blackstone_brick_stairs | -
| minecraft:polished_blackstone_brick_wall | -
| minecraft:polished_blackstone_bricks | -
| minecraft:polished_blackstone_button | -
| minecraft:polished_blackstone_double_slab | -
| minecraft:polished_blackstone_pressure_plate | -
| minecraft:polished_blackstone_slab | -
| minecraft:polished_blackstone_stairs | -
| minecraft:polished_blackstone_wall | -
| minecraft:polished_deepslate | -
| minecraft:polished_deepslate_double_slab | -
| minecraft:polished_deepslate_slab | -
| minecraft:polished_deepslate_stairs | -
| minecraft:polished_deepslate_wall | -
| minecraft:polished_diorite_stairs | -
| minecraft:polished_granite_stairs | -
| minecraft:portal | -
| minecraft:potatoes | -
| minecraft:powder_snow | -
| minecraft:powered_comparator | -
| minecraft:powered_repeater | -
| minecraft:prismarine | -
| minecraft:prismarine_bricks_stairs | -
| minecraft:prismarine_stairs | -
| minecraft:pumpkin | -
| minecraft:pumpkin_stem | -
| minecraft:purple_candle | -
| minecraft:purple_candle_cake | -
| minecraft:purple_glazed_terracotta | -
| minecraft:purpur_block | -
| minecraft:purpur_stairs | -
| minecraft:quartz_block | -
| minecraft:quartz_bricks | -
| minecraft:quartz_ore | -
| minecraft:quartz_stairs | -
| minecraft:rail | -
| minecraft:raw_copper_block | -
| minecraft:raw_gold_block | -
| minecraft:raw_iron_block | -
| minecraft:red_candle | -
| minecraft:red_candle_cake | -
| minecraft:red_flower | -
| minecraft:red_glazed_terracotta | -
| minecraft:red_mushroom | -
| minecraft:red_mushroom_block | -
| minecraft:red_nether_brick | -
| minecraft:red_nether_brick_stairs | -
| minecraft:red_sandstone | -
| minecraft:red_sandstone_stairs | -
| minecraft:redstone_block | -
| minecraft:redstone_lamp | -
| minecraft:redstone_ore | -
| minecraft:redstone_torch | -
| minecraft:redstone_wire | -
| minecraft:reeds | -
| minecraft:repeating_command_block | -
| minecraft:reserved6 | -
| minecraft:respawn_anchor | -
| minecraft:sand | -
| minecraft:sandstone | -
| minecraft:sandstone_stairs | -
| minecraft:sapling | -
| minecraft:scaffolding | -
| minecraft:sculk | -
| minecraft:sculk_catalyst | -
| minecraft:sculk_sensor | -
| minecraft:sculk_shrieker | -
| minecraft:sculk_vein | -
| minecraft:seaLantern | -
| minecraft:sea_pickle | -
| minecraft:seagrass | -
| minecraft:shroomlight | -
| minecraft:shulker_box | -
| minecraft:silver_glazed_terracotta | -
| minecraft:skull | -
| minecraft:slime | -
| minecraft:small_amethyst_bud | -
| minecraft:small_dripleaf_block | -
| minecraft:smithing_table | -
| minecraft:smoker | -
| minecraft:smooth_basalt | -
| minecraft:smooth_quartz_stairs | -
| minecraft:smooth_red_sandstone_stairs | -
| minecraft:smooth_sandstone_stairs | -
| minecraft:smooth_stone | -
| minecraft:snow | -
| minecraft:snow_layer | -
| minecraft:soul_campfire | -
| minecraft:soul_fire | -
| minecraft:soul_lantern | -
| minecraft:soul_sand | -
| minecraft:soul_soil | -
| minecraft:soul_torch | -
| minecraft:sponge | -
| minecraft:spore_blossom | -
| minecraft:spruce_button | -
| minecraft:spruce_door | -
| minecraft:spruce_fence_gate | -
| minecraft:spruce_pressure_plate | -
| minecraft:spruce_stairs | -
| minecraft:spruce_standing_sign | -
| minecraft:spruce_trapdoor | -
| minecraft:spruce_wall_sign | -
| minecraft:stained_glass | -
| minecraft:stained_glass_pane | -
| minecraft:stained_hardened_clay | -
| minecraft:standing_banner | -
| minecraft:standing_sign | -
| minecraft:stickyPistonArmCollision | -
| minecraft:sticky_piston | -
| minecraft:stone | -
| minecraft:stone_brick_stairs | -
| minecraft:stone_button | -
| minecraft:stone_pressure_plate | -
| minecraft:stone_slab | -
| minecraft:stone_slab2 | -
| minecraft:stone_slab3 | -
| minecraft:stone_slab4 | -
| minecraft:stone_stairs | -
| minecraft:stonebrick | -
| minecraft:stonecutter | -
| minecraft:stonecutter_block | -
| minecraft:stripped_acacia_log | -
| minecraft:stripped_birch_log | -
| minecraft:stripped_crimson_hyphae | -
| minecraft:stripped_crimson_stem | -
| minecraft:stripped_dark_oak_log | -
| minecraft:stripped_jungle_log | -
| minecraft:stripped_oak_log | -
| minecraft:stripped_spruce_log | -
| minecraft:stripped_warped_hyphae | -
| minecraft:stripped_warped_stem | -
| minecraft:structure_block | -
| minecraft:structure_void | -
| minecraft:sweet_berry_bush | -
| minecraft:tallgrass | -
| minecraft:target | -
| minecraft:tinted_glass | -
| minecraft:tnt | -
| minecraft:torch | -
| minecraft:trapdoor | -
| minecraft:trapped_chest | -
| minecraft:tripWire | -
| minecraft:tripwire_hook | -
| minecraft:tuff | -
| minecraft:turtle_egg | -
| minecraft:twisting_vines | -
| minecraft:underwater_torch | -
| minecraft:undyed_shulker_box | -
| minecraft:unknown | -
| minecraft:unlit_redstone_torch | -
| minecraft:unpowered_comparator | -
| minecraft:unpowered_repeater | -
| minecraft:vine | -
| minecraft:wall_banner | -
| minecraft:wall_sign | -
| minecraft:warped_button | -
| minecraft:warped_door | -
| minecraft:warped_double_slab | -
| minecraft:warped_fence | -
| minecraft:warped_fence_gate | -
| minecraft:warped_fungus | -
| minecraft:warped_hyphae | -
| minecraft:warped_nylium | -
| minecraft:warped_planks | -
| minecraft:warped_pressure_plate | -
| minecraft:warped_roots | -
| minecraft:warped_slab | -
| minecraft:warped_stairs | -
| minecraft:warped_standing_sign | -
| minecraft:warped_stem | -
| minecraft:warped_trapdoor | -
| minecraft:warped_wall_sign | -
| minecraft:warped_wart_block | -
| minecraft:water | -
| minecraft:waterlily | -
| minecraft:waxed_copper | -
| minecraft:waxed_cut_copper | -
| minecraft:waxed_cut_copper_slab | -
| minecraft:waxed_cut_copper_stairs | -
| minecraft:waxed_double_cut_copper_slab | -
| minecraft:waxed_exposed_copper | -
| minecraft:waxed_exposed_cut_copper | -
| minecraft:waxed_exposed_cut_copper_slab | -
| minecraft:waxed_exposed_cut_copper_stairs | -
| minecraft:waxed_exposed_double_cut_copper_slab | -
| minecraft:waxed_oxidized_copper | -
| minecraft:waxed_oxidized_cut_copper | -
| minecraft:waxed_oxidized_cut_copper_slab | -
| minecraft:waxed_oxidized_cut_copper_stairs | -
| minecraft:waxed_oxidized_double_cut_copper_slab | -
| minecraft:waxed_weathered_copper | -
| minecraft:waxed_weathered_cut_copper | -
| minecraft:waxed_weathered_cut_copper_slab | -
| minecraft:waxed_weathered_cut_copper_stairs | -
| minecraft:waxed_weathered_double_cut_copper_slab | -
| minecraft:weathered_copper | -
| minecraft:weathered_cut_copper | -
| minecraft:weathered_cut_copper_slab | -
| minecraft:weathered_cut_copper_stairs | -
| minecraft:weathered_double_cut_copper_slab | -
| minecraft:web | -
| minecraft:weeping_vines | -
| minecraft:wheat | -
| minecraft:white_candle | -
| minecraft:white_candle_cake | -
| minecraft:white_glazed_terracotta | -
| minecraft:wither_rose | -
| minecraft:wood | -
| minecraft:wooden_button | -
| minecraft:wooden_door | -
| minecraft:wooden_pressure_plate | -
| minecraft:wooden_slab | -
| minecraft:wool | -
| minecraft:yellow_candle | -
| minecraft:yellow_candle_cake | -
| minecraft:yellow_flower | -
| minecraft:yellow_glazed_terracotta | -
Entities
- -| Identifier | Full ID | Short ID |
|---|---|---|
| agent | -312 | -56 | -
| area_effect_cloud | -95 | -95 | -
| armor_stand | -317 | -61 | -
| arrow | -12582992 | -80 | -
| axolotl | -4994 | -130 | -
| balloon | -107 | -107 | -
| bat | -33043 | -19 | -
| bee | -378 | -122 | -
| blaze | -2859 | -43 | -
| boat | -90 | -90 | -
| cat | -21323 | -75 | -
| cave_spider | -265000 | -40 | -
| chalkboard | -78 | -78 | -
| chest_minecart | -524386 | -98 | -
| chicken | -4874 | -10 | -
| cod | -9072 | -112 | -
| command_block_minecart | -524388 | -100 | -
| cow | -4875 | -11 | -
| creeper | -2849 | -33 | -
| dolphin | -8991 | -31 | -
| donkey | -2118424 | -24 | -
| dragon_fireball | -4194383 | -79 | -
| drowned | -199534 | -110 | -
| egg | -4194386 | -82 | -
| elder_guardian | -2866 | -50 | -
| elder_guardian_ghost | -2936 | -120 | -
| ender_crystal | -71 | -71 | -
| ender_dragon | -2869 | -53 | -
| ender_pearl | -4194391 | -87 | -
| enderman | -2854 | -38 | -
| endermite | -265015 | -55 | -
| evocation_fang | -4194407 | -103 | -
| evocation_illager | -2920 | -104 | -
| eye_of_ender_signal | -70 | -70 | -
| falling_block | -66 | -66 | -
| fireball | -4194389 | -85 | -
| fireworks_rocket | -72 | -72 | -
| fishing_hook | -77 | -77 | -
| fox | -4985 | -121 | -
| ghast | -2857 | -41 | -
| glow_squid | -9089 | -129 | -
| goat | -4992 | -128 | -
| guardian | -2865 | -49 | -
| hoglin | -4988 | -124 | -
| hopper_minecart | -524384 | -96 | -
| horse | -2118423 | -23 | -
| husk | -199471 | -47 | -
| ice_bomb | -4194410 | -106 | -
| iron_golem | -788 | -20 | -
| item | -64 | -64 | -
| leash_knot | -88 | -88 | -
| lightning_bolt | -93 | -93 | -
| lingering_potion | -4194405 | -101 | -
| llama | -4893 | -29 | -
| llama_spit | -4194406 | -102 | -
| magma_cube | -2858 | -42 | -
| minecart | -524372 | -84 | -
| mooshroom | -4880 | -16 | -
| moving_block | -67 | -67 | -
| mule | -2118425 | -25 | -
| npc | -307 | -51 | -
| ocelot | -21270 | -22 | -
| painting | -83 | -83 | -
| panda | -4977 | -113 | -
| parrot | -21278 | -30 | -
| phantom | -68410 | -58 | -
| pig | -4876 | -12 | -
| piglin | -379 | -123 | -
| piglin_brute | -383 | -127 | -
| pillager | -2930 | -114 | -
| player | -319 | -63 | -
| polar_bear | -4892 | -28 | -
| pufferfish | -9068 | -108 | -
| rabbit | -4882 | -18 | -
| ravager | -2875 | -59 | -
| salmon | -9069 | -109 | -
| sheep | -4877 | -13 | -
| shield | -117 | -117 | -
| shulker | -2870 | -54 | -
| shulker_bullet | -4194380 | -76 | -
| silverfish | -264999 | -39 | -
| skeleton | -1116962 | -34 | -
| skeleton_horse | -2186010 | -26 | -
| slime | -2853 | -37 | -
| small_fireball | -4194398 | -94 | -
| snow_golem | -789 | -21 | -
| snowball | -4194385 | -81 | -
| spider | -264995 | -35 | -
| splash_potion | -4194390 | -86 | -
| squid | -8977 | -17 | -
| stray | -1116974 | -46 | -
| strider | -4989 | -125 | -
| thrown_trident | -12582985 | -73 | -
| tnt | -65 | -65 | -
| tnt_minecart | -524385 | -97 | -
| tripod_camera | -318 | -62 | -
| tropicalfish | -9071 | -111 | -
| turtle | -4938 | -74 | -
| vex | -2921 | -105 | -
| villager | -16777999 | -15 | -
| villager_v2 | -16778099 | -115 | -
| vindicator | -2873 | -57 | -
| wandering_trader | -886 | -118 | -
| witch | -2861 | -45 | -
| wither | -68404 | -52 | -
| wither_skeleton | -1116976 | -48 | -
| wither_skull | -4194393 | -89 | -
| wither_skull_dangerous | -4194395 | -91 | -
| wolf | -21262 | -14 | -
| xp_bottle | -4194372 | -68 | -
| xp_orb | -69 | -69 | -
| zoglin | -68478 | -126 | -
| zombie | -199456 | -32 | -
| zombie_horse | -2186011 | -27 | -
| zombie_pigman | -68388 | -36 | -
| zombie_villager | -199468 | -44 | -
| zombie_villager_v2 | -199540 | -116 | -
Entity Damage Source
- -| Damage Source | ID |
|---|---|
| all | -- |
| anvil | -- |
| block_explosion | -- |
| charging | -- |
| contact | -- |
| drowning | -- |
| entity_attack | -- |
| entity_explosion | -- |
| fall | -- |
| falling_block | -- |
| fire | -- |
| fire_tick | -- |
| fireworks | -- |
| fly_into_wall | -- |
| freezing | -- |
| lava | -- |
| lightning | -- |
| magic | -- |
| magma | -- |
| none | -- |
| override | -- |
| piston | -- |
| projectile | -- |
| stalactite | -- |
| stalagmite | -- |
| starve | -- |
| suffocation | -- |
| suicide | -- |
| temperature | -- |
| thorns | -- |
| void | -- |
| wither | -- |
Geometry
- -Blocks
- - - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| elements | -List | -- | List of elements that make up the geometry of this block
|
-||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| format_version | -String | -0.0.0.0 | -Version of the block geometry being used. This is used to determine if backwards compatibility is needed | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| materials | -List | -#0 | -List of materials used by this model | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parent | -String | -- | Parent model of this model | -
Items
- -| Name | ID | Aux Values |
|---|---|---|
| acacia_boat | -379 | -- |
| acacia_button | --140 | -- |
| acacia_door | -556 | -- |
| acacia_fence_gate | -187 | -- |
| acacia_pressure_plate | --150 | -- |
| acacia_sign | -579 | -- |
| acacia_stairs | -163 | -- |
| acacia_standing_sign | --190 | -- |
| acacia_trapdoor | --145 | -- |
| acacia_wall_sign | --191 | -- |
| activator_rail | -126 | -- |
| agent_spawn_egg | -487 | -- |
| air | --158 | -- |
| allow | -210 | -- |
| amethyst_block | --327 | -- |
| amethyst_cluster | --329 | -- |
| amethyst_shard | -625 | -- |
| ancient_debris | --271 | -- |
| andesite_stairs | --171 | -- |
| anvil | -145 | -- |
| apple | -257 | -- |
| armor_stand | -552 | -- |
| arrow | -301 | -- |
| axolotl_bucket | -369 | -- |
| axolotl_spawn_egg | -500 | -- |
| azalea | --337 | -- |
| azalea_leaves | --324 | -- |
| azalea_leaves_flowered | --325 | -- |
| baked_potato | -281 | -- |
| balloon | -598 | -- |
| bamboo | --163 | -- |
| bamboo_sapling | --164 | -- |
| banner | -567 | -- |
| banner_pattern | -630 | -- |
| barrel | --203 | -- |
| barrier | --161 | -- |
| basalt | --234 | -- |
| bat_spawn_egg | -453 | -- |
| beacon | -138 | -- |
| bed | -418 | -- |
| bedrock | -7 | -- |
| bee_nest | --218 | -- |
| bee_spawn_egg | -494 | -- |
| beef | -273 | -- |
| beehive | --219 | -- |
| beetroot | -285 | -- |
| beetroot_seeds | -295 | -- |
| beetroot_soup | -286 | -- |
| bell | --206 | -- |
| big_dripleaf | --323 | -- |
| birch_boat | -376 | -- |
| birch_button | --141 | -- |
| birch_door | -554 | -- |
| birch_fence_gate | -184 | -- |
| birch_pressure_plate | --151 | -- |
| birch_sign | -577 | -- |
| birch_stairs | -135 | -- |
| birch_standing_sign | --186 | -- |
| birch_trapdoor | --146 | -- |
| birch_wall_sign | --187 | -- |
| black_candle | --428 | -- |
| black_candle_cake | --445 | -- |
| black_dye | -395 | -- |
| black_glazed_terracotta | -235 | -- |
| blackstone | --273 | -- |
| blackstone_double_slab | --283 | -- |
| blackstone_slab | --282 | -- |
| blackstone_stairs | --276 | -- |
| blackstone_wall | --277 | -- |
| blast_furnace | --196 | -- |
| blaze_powder | -429 | -- |
| blaze_rod | -423 | -- |
| blaze_spawn_egg | -456 | -- |
| bleach | -596 | -- |
| blue_candle | --424 | -- |
| blue_candle_cake | --441 | -- |
| blue_dye | -399 | -- |
| blue_glazed_terracotta | -231 | -- |
| blue_ice | --11 | -- |
| boat | -628 | -- |
| bone | -415 | -- |
| bone_block | -216 | -- |
| bone_meal | -411 | -- |
| book | -387 | -- |
| bookshelf | -47 | -- |
| border_block | -212 | -- |
| bordure_indented_banner_pattern | -586 | -- |
| bow | -300 | -- |
| bowl | -321 | -- |
| bread | -261 | -- |
| brewing_stand | -431 | -- |
| brewingstandblock | -117 | -- |
| brick | -383 | -- |
| brick_block | -45 | -- |
| brick_stairs | -108 | -- |
| brown_candle | --425 | -- |
| brown_candle_cake | --442 | -- |
| brown_dye | -398 | -- |
| brown_glazed_terracotta | -232 | -- |
| brown_mushroom | -39 | -- |
| brown_mushroom_block | -99 | -- |
| bubble_column | --160 | -- |
| bucket | -360 | -- |
| budding_amethyst | --328 | -- |
| cactus | -81 | -- |
| cake | -417 | -- |
| calcite | --326 | -- |
| camera | -593 | -- |
| campfire | -588 | -- |
| candle | --412 | -- |
| candle_cake | --429 | -- |
| carpet | -171 | -- |
| carrot | -279 | -- |
| carrot_on_a_stick | -517 | -- |
| carrots | -141 | -- |
| cartography_table | --200 | -- |
| carved_pumpkin | --155 | -- |
| cat_spawn_egg | -488 | -- |
| cauldron | -432 | -- |
| cave_spider_spawn_egg | -457 | -- |
| cave_vines | --322 | -- |
| cave_vines_body_with_berries | --375 | -- |
| cave_vines_head_with_berries | --376 | -- |
| chain | -619 | -- |
| chain_command_block | -189 | -- |
| chainmail_boots | -342 | -- |
| chainmail_chestplate | -340 | -- |
| chainmail_helmet | -339 | -- |
| chainmail_leggings | -341 | -- |
| charcoal | -303 | -- |
| chemical_heat | -192 | -- |
| chemistry_table | -238 | -- |
| chest | -54 | -- |
| chest_minecart | -389 | -- |
| chicken | -275 | -- |
| chicken_spawn_egg | -435 | -- |
| chiseled_deepslate | --395 | -- |
| chiseled_nether_bricks | --302 | -- |
| chiseled_polished_blackstone | --279 | -- |
| chorus_flower | -200 | -- |
| chorus_fruit | -558 | -- |
| chorus_plant | -240 | -- |
| clay | -82 | -- |
| clay_ball | -384 | -- |
| client_request_placeholder_block | --465 | -- |
| clock | -393 | -- |
| coal | -302 | -- |
| coal_block | -173 | -- |
| coal_ore | -16 | -- |
| cobbled_deepslate | --379 | -- |
| cobbled_deepslate_double_slab | --396 | -- |
| cobbled_deepslate_slab | --380 | -- |
| cobbled_deepslate_stairs | --381 | -- |
| cobbled_deepslate_wall | --382 | -- |
| cobblestone | -4 | -- |
| cobblestone_wall | -139 | -- |
| cocoa | -127 | -- |
| cocoa_beans | -412 | -- |
| cod | -264 | -- |
| cod_bucket | -364 | -- |
| cod_spawn_egg | -480 | -- |
| colored_torch_bp | -204 | -- |
| colored_torch_rg | -202 | -- |
| command_block | -137 | -- |
| command_block_minecart | -563 | -- |
| comparator | -522 | -- |
| compass | -391 | -- |
| composter | --213 | -- |
| compound | -594 | -- |
| concrete | -236 | -- |
| concrete_powder | -237 | -- |
| conduit | --157 | -- |
| cooked_beef | -274 | -- |
| cooked_chicken | -276 | -- |
| cooked_cod | -268 | -- |
| cooked_mutton | -551 | -- |
| cooked_porkchop | -263 | -- |
| cooked_rabbit | -289 | -- |
| cooked_salmon | -269 | -- |
| cookie | -271 | -- |
| copper_block | --340 | -- |
| copper_ingot | -504 | -- |
| copper_ore | --311 | -- |
| coral | --131 | -- |
| coral_block | --132 | -- |
| coral_fan | --133 | -- |
| coral_fan_dead | --134 | -- |
| coral_fan_hang | --135 | -- |
| coral_fan_hang2 | --136 | -- |
| coral_fan_hang3 | --137 | -- |
| cow_spawn_egg | -436 | -- |
| cracked_deepslate_bricks | --410 | -- |
| cracked_deepslate_tiles | --409 | -- |
| cracked_nether_bricks | --303 | -- |
| cracked_polished_blackstone_bricks | --280 | -- |
| crafting_table | -58 | -- |
| creeper_banner_pattern | -582 | -- |
| creeper_spawn_egg | -441 | -- |
| crimson_button | --260 | -- |
| crimson_door | -616 | -- |
| crimson_double_slab | --266 | -- |
| crimson_fence | --256 | -- |
| crimson_fence_gate | --258 | -- |
| crimson_fungus | --228 | -- |
| crimson_hyphae | --299 | -- |
| crimson_nylium | --232 | -- |
| crimson_planks | --242 | -- |
| crimson_pressure_plate | --262 | -- |
| crimson_roots | --223 | -- |
| crimson_sign | -614 | -- |
| crimson_slab | --264 | -- |
| crimson_stairs | --254 | -- |
| crimson_standing_sign | --250 | -- |
| crimson_stem | --225 | -- |
| crimson_trapdoor | --246 | -- |
| crimson_wall_sign | --252 | -- |
| crossbow | -575 | -- |
| crying_obsidian | --289 | -- |
| cut_copper | --347 | -- |
| cut_copper_slab | --361 | -- |
| cut_copper_stairs | --354 | -- |
| cyan_candle | --422 | -- |
| cyan_candle_cake | --439 | -- |
| cyan_dye | -401 | -- |
| cyan_glazed_terracotta | -229 | -- |
| dark_oak_boat | -380 | -- |
| dark_oak_button | --142 | -- |
| dark_oak_door | -557 | -- |
| dark_oak_fence_gate | -186 | -- |
| dark_oak_pressure_plate | --152 | -- |
| dark_oak_sign | -580 | -- |
| dark_oak_stairs | -164 | -- |
| dark_oak_trapdoor | --147 | -- |
| dark_prismarine_stairs | --3 | -- |
| darkoak_standing_sign | --192 | -- |
| darkoak_wall_sign | --193 | -- |
| daylight_detector | -151 | -- |
| daylight_detector_inverted | -178 | -- |
| deadbush | -32 | -- |
| debug_stick | -590 | -- |
| deepslate | --378 | -- |
| deepslate_brick_double_slab | --399 | -- |
| deepslate_brick_slab | --392 | -- |
| deepslate_brick_stairs | --393 | -- |
| deepslate_brick_wall | --394 | -- |
| deepslate_bricks | --391 | -- |
| deepslate_coal_ore | --406 | -- |
| deepslate_copper_ore | --408 | -- |
| deepslate_diamond_ore | --405 | -- |
| deepslate_emerald_ore | --407 | -- |
| deepslate_gold_ore | --402 | -- |
| deepslate_iron_ore | --401 | -- |
| deepslate_lapis_ore | --400 | -- |
| deepslate_redstone_ore | --403 | -- |
| deepslate_tile_double_slab | --398 | -- |
| deepslate_tile_slab | --388 | -- |
| deepslate_tile_stairs | --389 | -- |
| deepslate_tile_wall | --390 | -- |
| deepslate_tiles | --387 | -- |
| deny | -211 | -- |
| detector_rail | -28 | -- |
| diamond | -304 | -- |
| diamond_axe | -319 | -- |
| diamond_block | -57 | -- |
| diamond_boots | -350 | -- |
| diamond_chestplate | -348 | -- |
| diamond_helmet | -347 | -- |
| diamond_hoe | -332 | -- |
| diamond_horse_armor | -533 | -- |
| diamond_leggings | -349 | -- |
| diamond_ore | -56 | -- |
| diamond_pickaxe | -318 | -- |
| diamond_shovel | -317 | -- |
| diamond_sword | -316 | -- |
| diorite_stairs | --170 | -- |
| dirt | -3 | -- |
| dirt_with_roots | --318 | -- |
| dispenser | -23 | -- |
| dolphin_spawn_egg | -484 | -- |
| donkey_spawn_egg | -465 | -- |
| double_cut_copper_slab | --368 | -- |
| double_plant | -175 | -- |
| double_stone_slab | -44 | -- |
| double_stone_slab2 | -182 | -- |
| double_stone_slab3 | --162 | -- |
| double_stone_slab4 | --166 | -- |
| double_wooden_slab | -157 | -- |
| dragon_breath | -560 | -- |
| dragon_egg | -122 | -- |
| dried_kelp | -270 | -- |
| dried_kelp_block | --139 | -- |
| dripstone_block | --317 | -- |
| dropper | -125 | -- |
| drowned_spawn_egg | -483 | -- |
| dye | -629 | -- |
| egg | -390 | -- |
| elder_guardian_spawn_egg | -471 | -- |
| element_0 | -36 | -- |
| element_1 | --12 | -- |
| element_10 | --21 | -- |
| element_100 | --111 | -- |
| element_101 | --112 | -- |
| element_102 | --113 | -- |
| element_103 | --114 | -- |
| element_104 | --115 | -- |
| element_105 | --116 | -- |
| element_106 | --117 | -- |
| element_107 | --118 | -- |
| element_108 | --119 | -- |
| element_109 | --120 | -- |
| element_11 | --22 | -- |
| element_110 | --121 | -- |
| element_111 | --122 | -- |
| element_112 | --123 | -- |
| element_113 | --124 | -- |
| element_114 | --125 | -- |
| element_115 | --126 | -- |
| element_116 | --127 | -- |
| element_117 | --128 | -- |
| element_118 | --129 | -- |
| element_12 | --23 | -- |
| element_13 | --24 | -- |
| element_14 | --25 | -- |
| element_15 | --26 | -- |
| element_16 | --27 | -- |
| element_17 | --28 | -- |
| element_18 | --29 | -- |
| element_19 | --30 | -- |
| element_2 | --13 | -- |
| element_20 | --31 | -- |
| element_21 | --32 | -- |
| element_22 | --33 | -- |
| element_23 | --34 | -- |
| element_24 | --35 | -- |
| element_25 | --36 | -- |
| element_26 | --37 | -- |
| element_27 | --38 | -- |
| element_28 | --39 | -- |
| element_29 | --40 | -- |
| element_3 | --14 | -- |
| element_30 | --41 | -- |
| element_31 | --42 | -- |
| element_32 | --43 | -- |
| element_33 | --44 | -- |
| element_34 | --45 | -- |
| element_35 | --46 | -- |
| element_36 | --47 | -- |
| element_37 | --48 | -- |
| element_38 | --49 | -- |
| element_39 | --50 | -- |
| element_4 | --15 | -- |
| element_40 | --51 | -- |
| element_41 | --52 | -- |
| element_42 | --53 | -- |
| element_43 | --54 | -- |
| element_44 | --55 | -- |
| element_45 | --56 | -- |
| element_46 | --57 | -- |
| element_47 | --58 | -- |
| element_48 | --59 | -- |
| element_49 | --60 | -- |
| element_5 | --16 | -- |
| element_50 | --61 | -- |
| element_51 | --62 | -- |
| element_52 | --63 | -- |
| element_53 | --64 | -- |
| element_54 | --65 | -- |
| element_55 | --66 | -- |
| element_56 | --67 | -- |
| element_57 | --68 | -- |
| element_58 | --69 | -- |
| element_59 | --70 | -- |
| element_6 | --17 | -- |
| element_60 | --71 | -- |
| element_61 | --72 | -- |
| element_62 | --73 | -- |
| element_63 | --74 | -- |
| element_64 | --75 | -- |
| element_65 | --76 | -- |
| element_66 | --77 | -- |
| element_67 | --78 | -- |
| element_68 | --79 | -- |
| element_69 | --80 | -- |
| element_7 | --18 | -- |
| element_70 | --81 | -- |
| element_71 | --82 | -- |
| element_72 | --83 | -- |
| element_73 | --84 | -- |
| element_74 | --85 | -- |
| element_75 | --86 | -- |
| element_76 | --87 | -- |
| element_77 | --88 | -- |
| element_78 | --89 | -- |
| element_79 | --90 | -- |
| element_8 | --19 | -- |
| element_80 | --91 | -- |
| element_81 | --92 | -- |
| element_82 | --93 | -- |
| element_83 | --94 | -- |
| element_84 | --95 | -- |
| element_85 | --96 | -- |
| element_86 | --97 | -- |
| element_87 | --98 | -- |
| element_88 | --99 | -- |
| element_89 | --100 | -- |
| element_9 | --20 | -- |
| element_90 | --101 | -- |
| element_91 | --102 | -- |
| element_92 | --103 | -- |
| element_93 | --104 | -- |
| element_94 | --105 | -- |
| element_95 | --106 | -- |
| element_96 | --107 | -- |
| element_97 | --108 | -- |
| element_98 | --109 | -- |
| element_99 | --110 | -- |
| elytra | -564 | -- |
| emerald | -512 | -- |
| emerald_block | -133 | -- |
| emerald_ore | -129 | -- |
| empty_map | -515 | -- |
| enchanted_book | -521 | -- |
| enchanted_golden_apple | -259 | -- |
| enchanting_table | -116 | -- |
| end_brick_stairs | --178 | -- |
| end_bricks | -206 | -- |
| end_crystal | -632 | -- |
| end_gateway | -209 | -- |
| end_portal | -119 | -- |
| end_portal_frame | -120 | -- |
| end_rod | -208 | -- |
| end_stone | -121 | -- |
| ender_chest | -130 | -- |
| ender_eye | -433 | -- |
| ender_pearl | -422 | -- |
| enderman_spawn_egg | -442 | -- |
| endermite_spawn_egg | -460 | -- |
| evoker_spawn_egg | -475 | -- |
| experience_bottle | -508 | -- |
| exposed_copper | --341 | -- |
| exposed_cut_copper | --348 | -- |
| exposed_cut_copper_slab | --362 | -- |
| exposed_cut_copper_stairs | --355 | -- |
| exposed_double_cut_copper_slab | --369 | -- |
| farmland | -60 | -- |
| feather | -327 | -- |
| fence | -85 | -- |
| fence_gate | -107 | -- |
| fermented_spider_eye | -428 | -- |
| field_masoned_banner_pattern | -585 | -- |
| filled_map | -420 | -- |
| fire | -51 | -- |
| fire_charge | -509 | -- |
| firework_rocket | -519 | -- |
| firework_star | -520 | -- |
| fishing_rod | -392 | -- |
| fletching_table | --201 | -- |
| flint | -356 | -- |
| flint_and_steel | -299 | -- |
| flower_banner_pattern | -581 | -- |
| flower_pot | -514 | -- |
| flowering_azalea | --338 | -- |
| flowing_lava | -10 | -- |
| flowing_water | -8 | -- |
| fox_spawn_egg | -490 | -- |
| frame | -513 | -- |
| frosted_ice | -207 | -- |
| furnace | -61 | -- |
| ghast_spawn_egg | -454 | -- |
| ghast_tear | -424 | -- |
| gilded_blackstone | --281 | -- |
| glass | -20 | -- |
| glass_bottle | -427 | -- |
| glass_pane | -102 | -- |
| glistering_melon_slice | -434 | -- |
| glow_frame | -623 | -- |
| glow_ink_sac | -503 | -- |
| glow_lichen | --411 | -- |
| glow_squid_spawn_egg | -502 | -- |
| glow_stick | -601 | -- |
| glowingobsidian | -246 | -- |
| glowstone | -89 | -- |
| glowstone_dust | -394 | -- |
| goat_horn | -624 | -- |
| goat_spawn_egg | -501 | -- |
| gold_block | -41 | -- |
| gold_ingot | -306 | -- |
| gold_nugget | -425 | -- |
| gold_ore | -14 | -- |
| golden_apple | -258 | -- |
| golden_axe | -325 | -- |
| golden_boots | -354 | -- |
| golden_carrot | -283 | -- |
| golden_chestplate | -352 | -- |
| golden_helmet | -351 | -- |
| golden_hoe | -333 | -- |
| golden_horse_armor | -532 | -- |
| golden_leggings | -353 | -- |
| golden_pickaxe | -324 | -- |
| golden_rail | -27 | -- |
| golden_shovel | -323 | -- |
| golden_sword | -322 | -- |
| granite_stairs | --169 | -- |
| grass | -2 | -- |
| grass_path | -198 | -- |
| gravel | -13 | -- |
| gray_candle | --420 | -- |
| gray_candle_cake | --437 | -- |
| gray_dye | -403 | -- |
| gray_glazed_terracotta | -227 | -- |
| green_candle | --426 | -- |
| green_candle_cake | --443 | -- |
| green_dye | -397 | -- |
| green_glazed_terracotta | -233 | -- |
| grindstone | --195 | -- |
| guardian_spawn_egg | -461 | -- |
| gunpowder | -328 | -- |
| hanging_roots | --319 | -- |
| hard_glass | -253 | -- |
| hard_glass_pane | -190 | -- |
| hard_stained_glass | -254 | -- |
| hard_stained_glass_pane | -191 | -- |
| hardened_clay | -172 | -- |
| hay_block | -170 | -- |
| heart_of_the_sea | -571 | -- |
| heavy_weighted_pressure_plate | -148 | -- |
| hoglin_spawn_egg | -496 | -- |
| honey_block | --220 | -- |
| honey_bottle | -592 | -- |
| honeycomb | -591 | -- |
| honeycomb_block | --221 | -- |
| hopper | -527 | -- |
| hopper_minecart | -526 | -- |
| horse_spawn_egg | -458 | -- |
| husk_spawn_egg | -463 | -- |
| ice | -79 | -- |
| ice_bomb | -595 | -- |
| infested_deepslate | --454 | -- |
| info_update | -248 | -- |
| info_update2 | -249 | -- |
| ink_sac | -413 | -- |
| invisiblebedrock | -95 | -- |
| iron_axe | -298 | -- |
| iron_bars | -101 | -- |
| iron_block | -42 | -- |
| iron_boots | -346 | -- |
| iron_chestplate | -344 | -- |
| iron_door | -372 | -- |
| iron_helmet | -343 | -- |
| iron_hoe | -331 | -- |
| iron_horse_armor | -531 | -- |
| iron_ingot | -305 | -- |
| iron_leggings | -345 | -- |
| iron_nugget | -569 | -- |
| iron_ore | -15 | -- |
| iron_pickaxe | -297 | -- |
| iron_shovel | -296 | -- |
| iron_sword | -307 | -- |
| iron_trapdoor | -167 | -- |
| item.acacia_door | -196 | -- |
| item.bed | -26 | -- |
| item.beetroot | -244 | -- |
| item.birch_door | -194 | -- |
| item.cake | -92 | -- |
| item.camera | -242 | -- |
| item.campfire | --209 | -- |
| item.cauldron | -118 | -- |
| item.chain | --286 | -- |
| item.crimson_door | --244 | -- |
| item.dark_oak_door | -197 | -- |
| item.flower_pot | -140 | -- |
| item.frame | -199 | -- |
| item.glow_frame | --339 | -- |
| item.hopper | -154 | -- |
| item.iron_door | -71 | -- |
| item.jungle_door | -195 | -- |
| item.kelp | --138 | -- |
| item.nether_sprouts | --238 | -- |
| item.nether_wart | -115 | -- |
| item.reeds | -83 | -- |
| item.skull | -144 | -- |
| item.soul_campfire | --290 | -- |
| item.spruce_door | -193 | -- |
| item.warped_door | --245 | -- |
| item.wheat | -59 | -- |
| item.wooden_door | -64 | -- |
| jigsaw | --211 | -- |
| jukebox | -84 | -- |
| jungle_boat | -377 | -- |
| jungle_button | --143 | -- |
| jungle_door | -555 | -- |
| jungle_fence_gate | -185 | -- |
| jungle_pressure_plate | --153 | -- |
| jungle_sign | -578 | -- |
| jungle_stairs | -136 | -- |
| jungle_standing_sign | --188 | -- |
| jungle_trapdoor | --148 | -- |
| jungle_wall_sign | --189 | -- |
| kelp | -382 | -- |
| ladder | -65 | -- |
| lantern | --208 | -- |
| lapis_block | -22 | -- |
| lapis_lazuli | -414 | -- |
| lapis_ore | -21 | -- |
| large_amethyst_bud | --330 | -- |
| lava | -11 | -- |
| lava_bucket | -363 | -- |
| lava_cauldron | --210 | -- |
| lead | -547 | -- |
| leather | -381 | -- |
| leather_boots | -338 | -- |
| leather_chestplate | -336 | -- |
| leather_helmet | -335 | -- |
| leather_horse_armor | -530 | -- |
| leather_leggings | -337 | -- |
| leaves | -18 | -- |
| leaves2 | -161 | -- |
| lectern | --194 | -- |
| lever | -69 | -- |
| light_block | --215 | -- |
| light_blue_candle | --416 | -- |
| light_blue_candle_cake | --433 | -- |
| light_blue_dye | -407 | -- |
| light_blue_glazed_terracotta | -223 | -- |
| light_gray_candle | --421 | -- |
| light_gray_candle_cake | --438 | -- |
| light_gray_dye | -402 | -- |
| light_weighted_pressure_plate | -147 | -- |
| lightning_rod | --312 | -- |
| lime_candle | --418 | -- |
| lime_candle_cake | --435 | -- |
| lime_dye | -405 | -- |
| lime_glazed_terracotta | -225 | -- |
| lingering_potion | -562 | -- |
| lit_blast_furnace | --214 | -- |
| lit_deepslate_redstone_ore | --404 | -- |
| lit_furnace | -62 | -- |
| lit_pumpkin | -91 | -- |
| lit_redstone_lamp | -124 | -- |
| lit_redstone_ore | -74 | -- |
| lit_smoker | --199 | -- |
| llama_spawn_egg | -473 | -- |
| lodestone | --222 | -- |
| lodestone_compass | -602 | -- |
| log | -17 | -- |
| log2 | -162 | -- |
| loom | --204 | -- |
| magenta_candle | --415 | -- |
| magenta_candle_cake | --432 | -- |
| magenta_dye | -408 | -- |
| magenta_glazed_terracotta | -222 | -- |
| magma | -213 | -- |
| magma_cream | -430 | -- |
| magma_cube_spawn_egg | -455 | -- |
| medicine | -599 | -- |
| medium_amethyst_bud | --331 | -- |
| melon_block | -103 | -- |
| melon_seeds | -293 | -- |
| melon_slice | -272 | -- |
| melon_stem | -105 | -- |
| milk_bucket | -361 | -- |
| minecart | -370 | -- |
| mob_spawner | -52 | -- |
| mojang_banner_pattern | -584 | -- |
| monster_egg | -97 | -- |
| mooshroom_spawn_egg | -440 | -- |
| moss_block | --320 | -- |
| moss_carpet | --335 | -- |
| mossy_cobblestone | -48 | -- |
| mossy_cobblestone_stairs | --179 | -- |
| mossy_stone_brick_stairs | --175 | -- |
| movingblock | -250 | -- |
| mule_spawn_egg | -466 | -- |
| mushroom_stew | -260 | -- |
| music_disc_11 | -544 | -- |
| music_disc_13 | -534 | -- |
| music_disc_blocks | -536 | -- |
| music_disc_cat | -535 | -- |
| music_disc_chirp | -537 | -- |
| music_disc_far | -538 | -- |
| music_disc_mall | -539 | -- |
| music_disc_mellohi | -540 | -- |
| music_disc_otherside | -627 | -- |
| music_disc_pigstep | -620 | -- |
| music_disc_stal | -541 | -- |
| music_disc_strad | -542 | -- |
| music_disc_wait | -545 | -- |
| music_disc_ward | -543 | -- |
| mutton | -550 | -- |
| mycelium | -110 | -- |
| mysterious_frame | --466 | -- |
| mysterious_frame_slot | --467 | -- |
| name_tag | -548 | -- |
| nautilus_shell | -570 | -- |
| nether_brick | -112 | -- |
| nether_brick_fence | -113 | -- |
| nether_brick_stairs | -114 | -- |
| nether_gold_ore | --288 | -- |
| nether_sprouts | -621 | -- |
| nether_star | -518 | -- |
| nether_wart | -294 | -- |
| nether_wart_block | -214 | -- |
| netherbrick | -523 | -- |
| netherite_axe | -607 | -- |
| netherite_block | --270 | -- |
| netherite_boots | -612 | -- |
| netherite_chestplate | -610 | -- |
| netherite_helmet | -609 | -- |
| netherite_hoe | -608 | -- |
| netherite_ingot | -603 | -- |
| netherite_leggings | -611 | -- |
| netherite_pickaxe | -606 | -- |
| netherite_scrap | -613 | -- |
| netherite_shovel | -605 | -- |
| netherite_sword | -604 | -- |
| netherrack | -87 | -- |
| netherreactor | -247 | -- |
| normal_stone_stairs | --180 | -- |
| noteblock | -25 | -- |
| npc_spawn_egg | -470 | -- |
| oak_boat | -375 | -- |
| oak_sign | -358 | -- |
| oak_stairs | -53 | -- |
| observer | -251 | -- |
| obsidian | -49 | -- |
| ocelot_spawn_egg | -451 | -- |
| orange_candle | --414 | -- |
| orange_candle_cake | --431 | -- |
| orange_dye | -409 | -- |
| orange_glazed_terracotta | -221 | -- |
| oxidized_copper | --343 | -- |
| oxidized_cut_copper | --350 | -- |
| oxidized_cut_copper_slab | --364 | -- |
| oxidized_cut_copper_stairs | --357 | -- |
| oxidized_double_cut_copper_slab | --371 | -- |
| packed_ice | -174 | -- |
| painting | -357 | -- |
| panda_spawn_egg | -489 | -- |
| paper | -386 | -- |
| parrot_spawn_egg | -478 | -- |
| phantom_membrane | -574 | -- |
| phantom_spawn_egg | -486 | -- |
| pig_spawn_egg | -437 | -- |
| piglin_banner_pattern | -587 | -- |
| piglin_brute_spawn_egg | -499 | -- |
| piglin_spawn_egg | -497 | -- |
| pillager_spawn_egg | -491 | -- |
| pink_candle | --419 | -- |
| pink_candle_cake | --436 | -- |
| pink_dye | -404 | -- |
| pink_glazed_terracotta | -226 | -- |
| piston | -33 | -- |
| pistonarmcollision | -34 | -- |
| planks | -5 | -- |
| podzol | -243 | -- |
| pointed_dripstone | --308 | -- |
| poisonous_potato | -282 | -- |
| polar_bear_spawn_egg | -472 | -- |
| polished_andesite_stairs | --174 | -- |
| polished_basalt | --235 | -- |
| polished_blackstone | --291 | -- |
| polished_blackstone_brick_double_slab | --285 | -- |
| polished_blackstone_brick_slab | --284 | -- |
| polished_blackstone_brick_stairs | --275 | -- |
| polished_blackstone_brick_wall | --278 | -- |
| polished_blackstone_bricks | --274 | -- |
| polished_blackstone_button | --296 | -- |
| polished_blackstone_double_slab | --294 | -- |
| polished_blackstone_pressure_plate | --295 | -- |
| polished_blackstone_slab | --293 | -- |
| polished_blackstone_stairs | --292 | -- |
| polished_blackstone_wall | --297 | -- |
| polished_deepslate | --383 | -- |
| polished_deepslate_double_slab | --397 | -- |
| polished_deepslate_slab | --384 | -- |
| polished_deepslate_stairs | --385 | -- |
| polished_deepslate_wall | --386 | -- |
| polished_diorite_stairs | --173 | -- |
| polished_granite_stairs | --172 | -- |
| popped_chorus_fruit | -559 | -- |
| porkchop | -262 | -- |
| portal | -90 | -- |
| potato | -280 | -- |
| potatoes | -142 | -- |
| potion | -426 | -- |
| powder_snow | --306 | -- |
| powder_snow_bucket | -368 | -- |
| powered_comparator | -150 | -- |
| powered_repeater | -94 | -- |
| prismarine | -168 | -- |
| prismarine_bricks_stairs | --4 | -- |
| prismarine_crystals | -549 | -- |
| prismarine_shard | -565 | -- |
| prismarine_stairs | --2 | -- |
| pufferfish | -267 | -- |
| pufferfish_bucket | -367 | -- |
| pufferfish_spawn_egg | -481 | -- |
| pumpkin | -86 | -- |
| pumpkin_pie | -284 | -- |
| pumpkin_seeds | -292 | -- |
| pumpkin_stem | -104 | -- |
| purple_candle | --423 | -- |
| purple_candle_cake | --440 | -- |
| purple_dye | -400 | -- |
| purple_glazed_terracotta | -219 | -- |
| purpur_block | -201 | -- |
| purpur_stairs | -203 | -- |
| quartz | -524 | -- |
| quartz_block | -155 | -- |
| quartz_bricks | --304 | -- |
| quartz_ore | -153 | -- |
| quartz_stairs | -156 | -- |
| rabbit | -288 | -- |
| rabbit_foot | -528 | -- |
| rabbit_hide | -529 | -- |
| rabbit_spawn_egg | -459 | -- |
| rabbit_stew | -290 | -- |
| rail | -66 | -- |
| rapid_fertilizer | -597 | -- |
| ravager_spawn_egg | -493 | -- |
| raw_copper | -507 | -- |
| raw_copper_block | --452 | -- |
| raw_gold | -506 | -- |
| raw_gold_block | --453 | -- |
| raw_iron | -505 | -- |
| raw_iron_block | --451 | -- |
| real_double_stone_slab | -43 | -- |
| real_double_stone_slab2 | -181 | -- |
| real_double_stone_slab3 | --167 | -- |
| real_double_stone_slab4 | --168 | -- |
| red_candle | --427 | -- |
| red_candle_cake | --444 | -- |
| red_dye | -396 | -- |
| red_flower | -38 | -- |
| red_glazed_terracotta | -234 | -- |
| red_mushroom | -40 | -- |
| red_mushroom_block | -100 | -- |
| red_nether_brick | -215 | -- |
| red_nether_brick_stairs | --184 | -- |
| red_sandstone | -179 | -- |
| red_sandstone_stairs | -180 | -- |
| redstone | -373 | -- |
| redstone_block | -152 | -- |
| redstone_lamp | -123 | -- |
| redstone_ore | -73 | -- |
| redstone_torch | -76 | -- |
| redstone_wire | -55 | -- |
| repeater | -419 | -- |
| repeating_command_block | -188 | -- |
| reserved6 | -255 | -- |
| respawn_anchor | --272 | -- |
| rotten_flesh | -277 | -- |
| saddle | -371 | -- |
| salmon | -265 | -- |
| salmon_bucket | -365 | -- |
| salmon_spawn_egg | -482 | -- |
| sand | -12 | -- |
| sandstone | -24 | -- |
| sandstone_stairs | -128 | -- |
| sapling | -6 | -- |
| scaffolding | --165 | -- |
| sculk | --458 | -- |
| sculk_catalyst | --460 | -- |
| sculk_sensor | --307 | -- |
| sculk_shrieker | --461 | -- |
| sculk_vein | --459 | -- |
| scute | -572 | -- |
| sea_pickle | --156 | -- |
| seagrass | --130 | -- |
| sealantern | -169 | -- |
| shears | -421 | -- |
| sheep_spawn_egg | -438 | -- |
| shield | -355 | -- |
| shroomlight | --230 | -- |
| shulker_box | -218 | -- |
| shulker_shell | -566 | -- |
| shulker_spawn_egg | -469 | -- |
| silver_glazed_terracotta | -228 | -- |
| silverfish_spawn_egg | -443 | -- |
| skeleton_horse_spawn_egg | -467 | -- |
| skeleton_spawn_egg | -444 | -- |
| skull | -516 | -0 = Skeleton1 = Wither2 = Zombie3 = Steve4 = Creeper5 = Dragon | -
| skull_banner_pattern | -583 | -- |
| slime | -165 | -- |
| slime_ball | -388 | -- |
| slime_spawn_egg | -445 | -- |
| small_amethyst_bud | --332 | -- |
| small_dripleaf_block | --336 | -- |
| smithing_table | --202 | -- |
| smoker | --198 | -- |
| smooth_basalt | --377 | -- |
| smooth_quartz_stairs | --185 | -- |
| smooth_red_sandstone_stairs | --176 | -- |
| smooth_sandstone_stairs | --177 | -- |
| smooth_stone | --183 | -- |
| snow | -80 | -- |
| snow_layer | -78 | -- |
| snowball | -374 | -- |
| soul_campfire | -622 | -- |
| soul_fire | --237 | -- |
| soul_lantern | --269 | -- |
| soul_sand | -88 | -- |
| soul_soil | --236 | -- |
| soul_torch | --268 | -- |
| sparkler | -600 | -- |
| spawn_egg | -631 | -- |
| spider_eye | -278 | -- |
| spider_spawn_egg | -446 | -- |
| splash_potion | -561 | -- |
| sponge | -19 | -- |
| spore_blossom | --321 | -- |
| spruce_boat | -378 | -- |
| spruce_button | --144 | -- |
| spruce_door | -553 | -- |
| spruce_fence_gate | -183 | -- |
| spruce_pressure_plate | --154 | -- |
| spruce_sign | -576 | -- |
| spruce_stairs | -134 | -- |
| spruce_standing_sign | --181 | -- |
| spruce_trapdoor | --149 | -- |
| spruce_wall_sign | --182 | -- |
| spyglass | -626 | -- |
| squid_spawn_egg | -450 | -- |
| stained_glass | -241 | -- |
| stained_glass_pane | -160 | -- |
| stained_hardened_clay | -159 | -- |
| standing_banner | -176 | -- |
| standing_sign | -63 | -- |
| stick | -320 | -- |
| sticky_piston | -29 | -- |
| stickypistonarmcollision | --217 | -- |
| stone | -1 | -- |
| stone_axe | -315 | -- |
| stone_brick_stairs | -109 | -- |
| stone_button | -77 | -- |
| stone_hoe | -330 | -- |
| stone_pickaxe | -314 | -- |
| stone_pressure_plate | -70 | -- |
| stone_shovel | -313 | -- |
| stone_stairs | -67 | -- |
| stone_sword | -312 | -- |
| stonebrick | -98 | -- |
| stonecutter | -245 | -- |
| stonecutter_block | --197 | -- |
| stray_spawn_egg | -462 | -- |
| strider_spawn_egg | -495 | -- |
| string | -326 | -- |
| stripped_acacia_log | --8 | -- |
| stripped_birch_log | --6 | -- |
| stripped_crimson_hyphae | --300 | -- |
| stripped_crimson_stem | --240 | -- |
| stripped_dark_oak_log | --9 | -- |
| stripped_jungle_log | --7 | -- |
| stripped_oak_log | --10 | -- |
| stripped_spruce_log | --5 | -- |
| stripped_warped_hyphae | --301 | -- |
| stripped_warped_stem | --241 | -- |
| structure_block | -252 | -- |
| structure_void | -217 | -- |
| sugar | -416 | -- |
| sugar_cane | -385 | -- |
| suspicious_stew | -589 | -- |
| sweet_berries | -287 | -- |
| sweet_berry_bush | --207 | -- |
| tallgrass | -31 | -- |
| target | --239 | -- |
| tinted_glass | --334 | -- |
| tnt | -46 | -- |
| tnt_minecart | -525 | -- |
| torch | -50 | -- |
| totem_of_undying | -568 | -- |
| trapdoor | -96 | -- |
| trapped_chest | -146 | -- |
| trident | -546 | -- |
| tripwire | -132 | -- |
| tripwire_hook | -131 | -- |
| tropical_fish | -266 | -- |
| tropical_fish_bucket | -366 | -- |
| tropical_fish_spawn_egg | -479 | -- |
| tuff | --333 | -- |
| turtle_egg | --159 | -- |
| turtle_helmet | -573 | -- |
| turtle_spawn_egg | -485 | -- |
| twisting_vines | --287 | -- |
| underwater_torch | -239 | -- |
| undyed_shulker_box | -205 | -- |
| unknown | --305 | -- |
| unlit_redstone_torch | -75 | -- |
| unpowered_comparator | -149 | -- |
| unpowered_repeater | -93 | -- |
| vex_spawn_egg | -476 | -- |
| villager_spawn_egg | -449 | -- |
| vindicator_spawn_egg | -474 | -- |
| vine | -106 | -- |
| wall_banner | -177 | -- |
| wall_sign | -68 | -- |
| wandering_trader_spawn_egg | -492 | -- |
| warped_button | --261 | -- |
| warped_door | -617 | -- |
| warped_double_slab | --267 | -- |
| warped_fence | --257 | -- |
| warped_fence_gate | --259 | -- |
| warped_fungus | --229 | -- |
| warped_fungus_on_a_stick | -618 | -- |
| warped_hyphae | --298 | -- |
| warped_nylium | --233 | -- |
| warped_planks | --243 | -- |
| warped_pressure_plate | --263 | -- |
| warped_roots | --224 | -- |
| warped_sign | -615 | -- |
| warped_slab | --265 | -- |
| warped_stairs | --255 | -- |
| warped_standing_sign | --251 | -- |
| warped_stem | --226 | -- |
| warped_trapdoor | --247 | -- |
| warped_wall_sign | --253 | -- |
| warped_wart_block | --227 | -- |
| water | -9 | -- |
| water_bucket | -362 | -- |
| waterlily | -111 | -- |
| waxed_copper | --344 | -- |
| waxed_cut_copper | --351 | -- |
| waxed_cut_copper_slab | --365 | -- |
| waxed_cut_copper_stairs | --358 | -- |
| waxed_double_cut_copper_slab | --372 | -- |
| waxed_exposed_copper | --345 | -- |
| waxed_exposed_cut_copper | --352 | -- |
| waxed_exposed_cut_copper_slab | --366 | -- |
| waxed_exposed_cut_copper_stairs | --359 | -- |
| waxed_exposed_double_cut_copper_slab | --373 | -- |
| waxed_oxidized_copper | --446 | -- |
| waxed_oxidized_cut_copper | --447 | -- |
| waxed_oxidized_cut_copper_slab | --449 | -- |
| waxed_oxidized_cut_copper_stairs | --448 | -- |
| waxed_oxidized_double_cut_copper_slab | --450 | -- |
| waxed_weathered_copper | --346 | -- |
| waxed_weathered_cut_copper | --353 | -- |
| waxed_weathered_cut_copper_slab | --367 | -- |
| waxed_weathered_cut_copper_stairs | --360 | -- |
| waxed_weathered_double_cut_copper_slab | --374 | -- |
| weathered_copper | --342 | -- |
| weathered_cut_copper | --349 | -- |
| weathered_cut_copper_slab | --363 | -- |
| weathered_cut_copper_stairs | --356 | -- |
| weathered_double_cut_copper_slab | --370 | -- |
| web | -30 | -- |
| weeping_vines | --231 | -- |
| wheat | -334 | -- |
| wheat_seeds | -291 | -- |
| white_candle | --413 | -- |
| white_candle_cake | --430 | -- |
| white_dye | -410 | -- |
| white_glazed_terracotta | -220 | -- |
| witch_spawn_egg | -452 | -- |
| wither_rose | --216 | -- |
| wither_skeleton_spawn_egg | -464 | -- |
| wolf_spawn_egg | -439 | -- |
| wood | --212 | -- |
| wooden_axe | -311 | -- |
| wooden_button | -143 | -- |
| wooden_door | -359 | -- |
| wooden_hoe | -329 | -- |
| wooden_pickaxe | -310 | -- |
| wooden_pressure_plate | -72 | -- |
| wooden_shovel | -309 | -- |
| wooden_slab | -158 | -- |
| wooden_sword | -308 | -- |
| wool | -35 | -- |
| writable_book | -510 | -- |
| written_book | -511 | -- |
| yellow_candle | --417 | -- |
| yellow_candle_cake | --434 | -- |
| yellow_dye | -406 | -- |
| yellow_flower | -37 | -- |
| yellow_glazed_terracotta | -224 | -- |
| zoglin_spawn_egg | -498 | -- |
| zombie_horse_spawn_egg | -468 | -- |
| zombie_pigman_spawn_egg | -448 | -- |
| zombie_spawn_egg | -447 | -- |
| zombie_villager_spawn_egg | -477 | -- |
manifest.json
- -The manifest file contains all the basic information about the pack that Minecraft needs to identify it. The tables below contain all the components of the manifest, their individual properties, and what they mean.| Name | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | -These are the different features that the pack makes use of that aren't necessarily enabled by default.
|
-||||||||||||||||||||||||
| dependencies | -This section describes the packs that this pack depends on in order to work. Any packs defined here will be automatically added to the world when this one is added if they are present, or an error will be shown if they aren't. Each entry has the following parameters:
|
-||||||||||||||||||||||||
| format_version | -This defines the current version of the manifest. Don't change this unless you have a good reason to | -||||||||||||||||||||||||
| header | -This is the heading of the manifest and is required for the manifest to be valid.
|
-||||||||||||||||||||||||
| metadata | -This section contains additional data about your pack and is otherwise optional.
|
-||||||||||||||||||||||||
| modules | -This section describes the modules that comprise the pack. Each entry here defines one of the kinds of contents of the pack.
|
-
Index
-Back to top -Animation Controllers
- -Animation controllers decide which animations to play when. Each controller contains a list of states that play one or more animations, each of which can be blended by a Molang expression if so desired. Controller files are stored as JSON in the animation_controllers folder -Animation Controller Format:State Blending
- -If you would like there to be a cross-fade between states when transitioning, simply set "blend_transition" to the time you would like the system to take in blending between the two states. This is done as a simple lerp between the two states over the time specified. -For example:State Transitions
- -A state can specify any number of transition scripts, listed in order. Each transition has a target state to switch to, and a script for whether it should switch or not. For each transition in order, evaluate the script, and if it returns non-zero, switch to the specified state immediately. NOTE: Only one transition will be processed per frame. -States
- -A state defines a group of animations to process (each of which can have it's own blend value). Each state has an optional variables section, listing any number of variables that referenced animations can use. Each state also has one or more animations, using the name given in the entity's definition json. - -State Variables
- -Variables are either set by the game or by a user defined script that can be found in the entity definition json found in definitions/entity/For Example:
- -This defines a controller with a single state. It will create a variable `variable.ground_speed_curve` that lives on the entity only while processing the animation controller for that frame. It will take the value of `query.ground_speed`, then remap it to between 0.2 and 0.7 based on the value of `query.ground_speed` going from 0.0 to 1.0It will play one animation walk that will blend from 0.0 to 1.0 as the ground speed increases from stopped to 2.3 m/s. The remap curve can have any number of entries. The animation controller will then play the entity-referenced `wiggle_nose` animations, followed by the `walk` animation, scaling the latter by the value of `variable.ground_speed_curve` -User-Defined Script Example
- -This script will set foo to the result of the sine of query.life_time to later be used in the animation or animation controller.Note: "pre_animation" tells the script to figure out the values of those variables once a frame, before animation occurs, so that the animation can use those values in their own formulas. If a variable didn't exist, it will create a new variable and its default value will be 0.0 - -Note in this example that because foo is equal to a sin wave, that its values will range from -1 to 1. This means that you will have a period from 0 to -1 to 0 where only "base_pose" will play and then an equal amount of time where Walk will play on top of base_pose as foo goes from 0 to 1 back to 0. Base_pose will have a blend value of 1.0. -In definitions\entity\tiger.json:
- - -Channels (Rotation, Position, Scale)
- -The engine tracks the animation of rotation, position, and scale separately. Within a channel, one or more key frames are specified at arbitrary times, in seconds, from the start of the animation. If no key frames are specified, a single key frame is created at t=0.0 and all channel data is stored within that key frame.Back to topEntity Animation Format Examples
- -The json format for an animation is as follows. Note Matching the geometry format, units are in 1/16ths of meters. -Getting Started
- -Adding Animations
- - - -Animation Controller
- -One needs to be able to control how animations are played, when, and how they interact with other animations. to group animations While a lot of this can be managed in the entity definition `scripts/animate` section, animation controllers give you the functionality of a state machine into states and control them as a block. Animations in an animation controller state can be animation controllers themselves, allowing for arbitrarily complex animation hierarchies. -Here's a sample animation controllerAnimations
- -At the beginning of each frame, the skeleton is reset to its default pose from its geometry definition and then animations are applied per-channel-additively in order. Note that the channels (x, y, and z) are added separately across animations first, then converted to a transform once all animations have been cumulatively applied. - -Animation data can be either raw data:
- - -By default, rotations are in degrees, in euler X-then-Y-then-Z formator a run-time interpreted script:
- - -Entity Definition
- -In order to define what animations an entity has, you must add both an `animations` and a `scripts/animate` section to an entity's entity definition file. - -Here you can see the entity definition for pig.json:This means you will not see the move animation in the pig.json animation file either. If you would like to make a custom pig walk you can change this line to point to your custom animation.Animations are specified as a short name, followed by their full resource name. The short name is used in animation controllers and the `scripts/animate` list, while the long name is used in the animations file.In the `scripts/animate` section, you list the animations to play and in which order. You can either specify an animation directly, or specify a blend expression. -Animation Hierarchy
- -Animations are channel based (rotation, position, or scale), and within that, they are key-framed:EntityAnimation: animation name__BoneAnimation[]: bone name to animation for this animation____AnimationChannel[]: rotation, scale, or translation to animate______KeyFrame[]: the value for the channel to be at, at a specific timeAll of the above concepts are described in a detailed, bottom-up approach belowBack to topUpgrade from v1.10 to v1.17.30
- -The major change with 1.17.30 is:- Molang expressions inside transitions that contain capital letters are properly evaluated now. Strings inside such expressions are not forced to lowercase anymore and work as expected.Back to topUpgrade from v1.7 Beta to v1.8
- -There have been few changes as we clean things up based on feedback and as we push the tech along the road map.To upgrade previous scripts, you'll want to do the following steps to all of your Molang scripts in the order listed:1) entity.flags.foo --> query.foo2) entity.member.foo --> query.foo3) entity.foo --> variable.foo4) params.foo --> global.foo5) The general rule is that 'query' represents read-only values from the entity the script is running on, and 'variable' represents read-write data created by the user.6) We've adopted snake_case for all names of things. You are welcome to use upper-case letters if you wish as we are case-insensitive, however we recommend snake_case in general.7) Several variables previously set on mobs have been changed to use the query.foo format. Look through the updated list below to see what has been added and changed.Back to topUpgrade from v1.8 Beta to v1.10
- -The three major changes with 1.10 are- the ability to have animations reference other animations in an arbitrarily deep hierarchy.- the parameters section of animation controllers has been replaced with the `variables` section.- in the entity definition file, animation controllers are now listed in the `animations` section, and a `scriptsnimate` section has been added to define which root animations to play.The v1.8 file format is backwards-compatible with v1.10 so you don't _need_ to change anything (although we recommend refactoring your files in the spirit of v1.10 as there is a slight performance win with the new format, as well as it being simpler to understand.Back to topKey Frames
- -A key frame defines two values for a channel-specific transform to a specific bone at a specified time, one as time approaches the key frame time, and the second from that key frame time onwards.As such, when interpolating between two key frames, one can define the slope of the animation curve in either a continuous or discontinuous manner.Interpolation
- -Currently only linear interpolation is supported. Key frame "pre" and "post" settings allow control of the interpolation curve at any key frame. - -Continuous Example
- -This example spins the bone "head" around the y axis 1 rotation in 1 second.Note that because interpolation is linear, at .25 seconds the head will be rotated to 90 degrees. -Discontinuous Example
- -Discontinuous just means that there won't be a smooth transition between key frames. It is useful if you want something to happen immediately.This example scales the bone "head":1. From 0 to 0.5 seconds (in the "pre" tag), the head bone is set to its normal scale of 1 in all dimensions [X, Y, Z]2. At 0.5 seconds, the bone will instantly scale up to 2 times its normal size3. From 0.5 to 1 second ("post"), the bone will re-scale back to its normal size of scale of 1 in all dimensionsNote In the larger example above of the file format, "pre" and "post" can also be defined by a Molang expression that calculates that value at runtime, allowing you to have a mathematically defined curve instead of being purely linear. -Names
- -All names: animations, bones, states, etc, must all start with a letter and contain only alphanumerics, underscore, or period. It is recommended to use names in all lower-caseBack to topOverview
- -The follows the current Minecraft JSON paradigms:- Fields should be lower-case and use underscores (no spaces)- All JSON files in the definitions directory and subtree will be read into and interpreted by the animation systemBack to topRender Controllers
- -The Render Controller needs an identifier and needs to follow the format of "controller.render.Examples
- - - - -Example Array for geometry from the sheep JSONGetting Started
- -To begin create a new folder named "render_controllers" in the root of the Resource Pack you want to add the new Render Controller JSON inside. -Example render controllers JSON for the ocelotTransforms
- -- Order of operations: vertices are translated, rotated, then scaled.- Animation data is assumed to be hierarchical, and is applied to a bone by name matching the bone name in the animation data to the targeted geometry's skeleton.- Not every bone needs to be animated- You can animate bones that don't exist in the targeted geometry (missing bones are ignored).- For each of scale, rotation, position, one can set the fields individually or uniformly with a single value. For example, these are equivalent. -Index
-| Overview |
|---|
| JSON format |
| Adding biomes |
| Schema |
Overview
- -Biomes describe how a local patch of the world should look and behave. By writing custom biome data you could:1) Change the general shape of terrain for a biome.2) Change the ratio of frequency of biome types.3) Change the blocks that make up the biome, both at the surface and below.4) Change the distribution of decorative features (e.g. trees, grass, etc.) for a biome.5) Change the mobs that spawn for a biome.6) Change the climate for a biome.7) ...and more!Back to topJSON format
- -All biomes should specify the version that they target via the "format_version" field. The remainder of the biome data is divided up into independent JSON sub-objects, or components. In general you can think of the presence of a component as defining what game behaviors a biome participates in with the component fields defining how it participates. Broadly there are two categories of components:1) Namespaced components (i.e. those with a 'name:' prefix) map to specific behaviors in-game; they may have member fields that parameterize that behavior; only names that have a valid mapping are supported.2) Components with no namespace are treated as 'tags': any name consisting of alphanumeric characters, '.' and '_' is permitted; the tag is attached to the biome so that either code or data may check for its existence; tag components may not have member fields.See the full biome schema below for additional details and the full list of namespaced components. -Here is a sample biomeAdding biomes
- -Biomes are read from JSON files in the biomes subfolders of behavior packs. Loading enforces one biome per file; the file name and the actual biome name must match. Adding a file with a new name to the biome data location will make it available for the game to use, while existing biomes can be overriden via files that match their existing name. Note that if you add a new biome you'll need to write component data that allows it to participate in world generation (see full schema below), or else it won't show up in your worlds!Back to topSchema
- - -Index
-| Blocks |
|---|
| Block Components |
| Block Definition Properties |
| Block Description Properties |
| Block Event Responses |
| Block Trigger Components |
Blocks
- -Block Components
- - - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| minecraft:block_light_absorption | -Integer | -0 | -The amount of light this block will absorb. | -||||||||||||||||||||||||||||||||||||
| minecraft:block_light_emission | -Decimal | -0.0 | -The amount of light this block will emit in a range [0.0, 1.0]. | -||||||||||||||||||||||||||||||||||||
| minecraft:breakonpush | -Boolean | -- | When pushed by a piston the block breaks | -||||||||||||||||||||||||||||||||||||
| minecraft:breathability | -Enumerator | -solid | -Property describing the breathability of this block and whether it is treated as a solid or as air. | -||||||||||||||||||||||||||||||||||||
| minecraft:creative_category | -String | -- | Specifies the creative group for the block. | -||||||||||||||||||||||||||||||||||||
| minecraft:destroy_time | -Decimal | -0.0 | -Sets the destroy time property for the block. Greater numbers result in greater mining times. Time is measured in seconds with base equipment. | -||||||||||||||||||||||||||||||||||||
| minecraft:display_name | -String | -- | Specifies the language file key that maps to what text will be displayed when you hover over the block.Experimental toggles required: Holiday Creator Features | -||||||||||||||||||||||||||||||||||||
| minecraft:entity_collision | -Boolean | -false | -Can only be set to false, it disables the collision of the block with entities
|
-||||||||||||||||||||||||||||||||||||
| minecraft:explosion_resistance | -Decimal | -0.0 | -Sets the explosion resistance for this block. | -||||||||||||||||||||||||||||||||||||
| minecraft:flammable | -JSON Object | -- | Describes the flammable properties for this block.
|
-||||||||||||||||||||||||||||||||||||
| minecraft:friction | -Decimal | -0.1 | -Property describing the friction for this block. Friction effects an entities movements when it walks on the block. | -||||||||||||||||||||||||||||||||||||
| minecraft:geometry | -String | -- | The geometry description identifier to use, this identifier must match an existing geometry identifier in any of the currently loaded resource packs.Experimental toggles required: Holiday Creator Features | -||||||||||||||||||||||||||||||||||||
| minecraft:immovable | -Boolean | -- | An Immovable block cannot be pushed by pistons | -||||||||||||||||||||||||||||||||||||
| minecraft:loot | -String | -- | The path to the loot table, relative to the behavior pack. | -||||||||||||||||||||||||||||||||||||
| minecraft:map_color | -String | -- | A color represented as a hex value. This will be the color rendered to a map. | -||||||||||||||||||||||||||||||||||||
| minecraft:material_instances | -JSON Object | -- | Maps face or material_instance names in a geometry file to an actual material instance. Material instance can either be a full material instance or a name to another already defined instance | -||||||||||||||||||||||||||||||||||||
| minecraft:onlypistonpush | -Boolean | -- | Blocks with those components won't stick to stickyPistons | -||||||||||||||||||||||||||||||||||||
| minecraft:part_visibility | -JSON Object | -- | Maps bone names in a geometry file to a condition that turns their rendering on/off. The condition should be a Molang query that uses block properties to determine true/falseSupported queries include 'has_block_property', 'block_property', and other queries that can evaluate without knowledge of the block's in-game positional or player affected data.Experimental toggles required: Upcoming Creator Features | -||||||||||||||||||||||||||||||||||||
| minecraft:pick_collision | -Boolean | -false | -Can only be set to false, it disables the collision of the block with entities
|
-||||||||||||||||||||||||||||||||||||
| minecraft:placement_filter | -JSON Object | -- | Sets rules for under what conditions the block can be placed/survive conditions - -List of conditions where the block can be placed/survive - -
- - |
-||||||||||||||||||||||||||||||||||||
| minecraft:preventsjumping | -Boolean | -- | this component makes it so actors can't jump when walking on this block | -||||||||||||||||||||||||||||||||||||
| minecraft:random_ticking | -JSON Object | -- | Describes the component that will trigger an even at a regular interval between two values
|
-||||||||||||||||||||||||||||||||||||
| minecraft:rotation | -Vector [a, b, c] | -rotation[0, 0, 0] | -This is the block's rotation around the center of the cube in degrees. The rotation order is x-y-z. | -||||||||||||||||||||||||||||||||||||
| minecraft:ticking | -JSON Object | -- | Describes the component that will trigger an even at a regular interval between two values
|
-||||||||||||||||||||||||||||||||||||
| minecraft:unit_cube | -JSON Object | -- | Specifies that a unit cube is to be used with tessellation.Experimental toggles required: Holiday Creator Features | -||||||||||||||||||||||||||||||||||||
| minecraft:unwalkable | -Boolean | -false | -Sets the block as unwalkable. Mobs would not attempt to path over top of it when the value is set to true. | -
Block Definition Properties
- -These properties are part of the Block Definition. This helps the system determine how to parse and initialize this block. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| format_version | -String | -- | Specifies the version of the game this entity was made in. If the version is lower than the current version, any changes made to the entity in the vanilla version will be applied to it. | -
Block Description Properties
- - - -| Name | Type | Default Value | Description |
|---|---|---|---|
| identifier | -String | -- | The identifier for this block. The name must include a namespace and must not use the Minecraft namespace unless overriding a Vanilla block. | -
Block Event Responses
- -Event responses for block trigger components. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| add_mob_effect | -JSON Object | -- | Apply mob effect to target.
|
-||||||||||||||||||||||||
| damage | -JSON Object | -- | Deals damage to the target.
|
-||||||||||||||||||||||||
| decrement_stack | -JSON Object | -- | Decrement item stack. | -||||||||||||||||||||||||
| die | -JSON Object | -- | Kill target. If target is self and this is run from a block then destroy the block.
|
-||||||||||||||||||||||||
| play_effect | -JSON Object | -- | Spawns a particle effect relative to target position.
|
-||||||||||||||||||||||||
| play_sound | -JSON Object | -- | Play a sound relative to target position.
|
-||||||||||||||||||||||||
| remove_mob_effect | -JSON Object | -- | Removes mob effect from target.
|
-||||||||||||||||||||||||
| run_command | -JSON Object | -- | Triggers a slash command or a list of slash commands.
|
-||||||||||||||||||||||||
| set_block | -JSON Object | -- | Sets this block to another block type.
|
-||||||||||||||||||||||||
| set_block_at_pos | -JSON Object | -- | Sets a block relative to this block to another block type.
|
-||||||||||||||||||||||||
| set_block_property | -JSON Object | -- | Sets a block property on this block.
|
-||||||||||||||||||||||||
| spawn_loot | -JSON Object | -- | Spawn loot from block.
|
-||||||||||||||||||||||||
| swing | -JSON Object | -- | Event causes the actor to swing. | -||||||||||||||||||||||||
| teleport | -JSON Object | -- | Teleport target randomly around destination point.
|
-||||||||||||||||||||||||
| transform_item | -JSON Object | -- | Transforms item into another item.
|
-
Block Trigger Components
- - - -| Name | Type | Default Value | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| minecraft:on_fall_on | -JSON Object | -- | Describes event for this block.
|
-||||||||||||||||||||
| minecraft:on_interact | -JSON Object | -- | Describes event for this block.
|
-||||||||||||||||||||
| minecraft:on_placed | -JSON Object | -- | Describes event for this block.
|
-||||||||||||||||||||
| minecraft:on_player_destroyed | -JSON Object | -- | Describes event for this block.
|
-||||||||||||||||||||
| minecraft:on_player_placing | -JSON Object | -- | Describes event for this block.
|
-||||||||||||||||||||
| minecraft:on_step_off | -JSON Object | -- | Describes event for this block.
|
-||||||||||||||||||||
| minecraft:on_step_on | -JSON Object | -- | Describes event for this block.
|
-
Index
-Back to top -Client Entity Documentation
- -Client entity definitions are contained within a Resource Pack. To start, create a new folder and name it "entity" inside the root of the Resource Pack. In the entity folder create a JSON file and give it a name.The JSON file needs a format version and minecraft:client_entity information.The minecraft:client_entity section contains the description for the entity. Under description there are a number of things that you can set about an entity. Generally, this file is defining what resources a mob requires and gives a friendly name to each, that the other definition files can use. -Example client entity definitions JSON for the pigSpawn Egg
- -This sets the color or texture used for the entity Spawn Egg. There are 2 ways to do this. The first is to use the hex value for the base color and the overlay color. - -When there are more than one texture associated with a texture name you can use an index to pick the one that you want. If no index is specified than it is assumed to be 0 and the first texture in the list is used. -Example Spawn Egg specifying a textureanimation_controllers
- -Animation controllers decide which animations to play when. Each Controller contains a list of states that play one or more animations. Allows the player to assign names to reference the long names for animation controllers. Names are required and need to be unique from all other names in the animation controllers for that mob. Players can reference animation controllers from the vanilla Minecraft Resource Pack or create their own. Custom animation controllers should be in the animation_controllers folder at the root of the Resource Pack.Back to topanimations
- -Allows the player to assign names to reference the long name for animations. These names are used by the animation controller JSON. Players can reference animations from the vanilla Minecraft Resource Pack or create their own. Custom animations should be in the animation folder at the root of the Resource Pack.Back to topenable_attachables
- -This determines if the entity can equip attachables when this is set to true. This allows the entity to render armor and weapons. -hide_armor
- -This determines if the armor attached to an entity should be hidden when set to true. This overrides the rendering settings specified by 'enable_attachables' -identifier
- -The identifier is used to register the entity with the server. In the Client Entity Definitions JSON the identifier sets the appearance of the entity(materials, textures, geometry, etc.) The matching identifier in the Entity Behavior JSON in the Behavior Pack is what gives the entity its behaviors.Back to toplocators
- -Locator offsets are specified in model space. An example of a locator is the "lead" locator used to specify where the lead will attach to graphically. -materials, textures, animations
- -Players can set the materials, texture and geometry used for the entity in this section. Players can set one or more materials, textures, and geometries that can be used by the mob. Players must set user defined names for them. These names are used in the Render Controllers JSON. Players can reference materials, textures, and geometry from the vanilla Minecraft Resource Pack or create their own. Custom materials, textures, and geometry should be in the corresponding folder at the root of the Resource Pack.Back to topmin_engine_version
- -When present, players can set the min version needed to allow the JSON to be parsed. The version in the definition is compared to the engine version for which the top resource pack was built.If a definition's min_engine_version is newer than that pack's engine version then the definition is not parsed.Multiple definition files may use the same identifier, in which case only one of those definitions will be loaded. The definition with the same or closest and not greater min_engine_version, as compared to the top resource pack's engine version, will be parsed; all other definitions with the same identifier will not be parsed.This can be useful for continuing to support an older version of an entity, when an older resource pack is used at the top of the resource pack stack, while also supporting a newer version of the entity in all other cases.Back to topparticle
- -Allows the player to assign a key to reference the long name for particles. When these are present, the particle is created when the entity is spawned. Keys are required and need to be unique from all other keys in the animation controllers. Players can reference particles from the vanilla Minecraft Resource Pack or create their own. Custom particles should be in the particle folder at the root of the Resource Pack.Back to toprender_controllers
- -Specifies the names of render controllers. This name needs to match the name of a corresponding JSON located in the Render Controllers folder. Players can reference Render Controllers from the vanilla Minecraft Resource Pack or create their own. Custom Render Controllers should be in the textures folder at the root of the Resource Pack.Back to topscripts
- -Scripts allow players to use Molang to compute calculations once and store that value. This value than can be used over and over again without the need to constantly recompute the calculations. Scripts currently support pre - animation and scale.More script types will be added later.-Pre-animation scripts are evaluated immediately before animations are processed.-Scale sets the scale of the mob's geometry. -Example pre-animation script for codData-Driven Spawning
- -Data-Driven spawning allows you to adjust the spawn conditions of mobs, including new mobs added to the game to spawn naturally in biomes, add / remove a mob's spawn egg to the creative inventory and set the mob's spawn egg, and add / remove a to the / summon commandSpawn Rules
- - - -Biome Tags
- -Each biome in the game has one or more tags. These are used to determine what biomes mobs spawn in. Here is the list of Biome tags that can be used: - -| Tag |
|---|
| animal | -
| beach | -
| birch | -
| cold | -
| dark_oak | -
| deep | -
| desert | -
| edge | -
| extreme_hills | -
| flower_forest | -
| forest | -
| frozen | -
| hills | -
| ice | -
| ice_plains | -
| jungle | -
| lakes | -
| lukewarm | -
| mega | -
| mesa | -
| monster | -
| mooshroom_island | -
| mountain | -
| mutated | -
| nether | -
| ocean | -
| plains | -
| plateau | -
| river | -
| roofed | -
| savanna | -
| shore | -
| stone | -
| swamp | -
| taiga | -
| the_end | -
| warm | -
Conditions
- -Conditions contain different components that players can use to customize natural biome spawning. - -Components
- - - -| Name | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| minecraft:biome_filter | -This component allows the players to specify which biomes the mob spawns in. Check below to see which Biome Tags exist, and what each biome is tagged as. | -||||||||||||||||||||
| minecraft:brightness_filter | -This component allows players to set the light level range that causes the mob to spawn.
|
-||||||||||||||||||||
| minecraft:density_limit | -This component allows players to determine the density cap limits for the specified mob type.
|
-||||||||||||||||||||
| minecraft:difficulty_filter | -This component allows players determine what mobs spawn when certain difficulty levels are set.
|
-||||||||||||||||||||
| minecraft:herd | -This component allows players to determine the herd size of animals.
|
-||||||||||||||||||||
| minecraft:spawns_on_surface | -This component allows the mob to spawn on the ground. Adding the component causes it to be true, removing it causes the mob to stop spawning on the surface. | -||||||||||||||||||||
| minecraft:spawns_underwater | -This component allows the mob to spawn underwater. Adding the component causes it to be true, removing it causes the mob to stop spawning underwater. | -||||||||||||||||||||
| minecraft:weight | -This component allows players to give a priority to how often that mob should spawn. Mobs with lower weight values have a higher chance to spawn than mobs with higher weight values.
|
-
Getting Started
- -New Spawn Rules are contained within a Behavior Pack. To begin, create a new folder named "spawn_rules" in the root of the Behavior Pack that you want to add the new biome spawn rules in. In the spawn_rules folder, create a JSON file and give it a name. The JSON file needs a format, description and conditions.Spawn rules contain description and conditionsAll Spawn Rules JSON need to have an ID (located under the description section). Similar to other identifiers, it follows the convention "namespace:name". The minecraft namespace is reserved for the vanilla Minecraft rules.When changing an existing mob use the ID that appears in the entity JSON for that entity. When creating your own mob, make sure the mobs have the same ID in all the entity's JSON files.Spawn Rules also needs to define the pool that is used for population control.Each pool has their own spawn limit, By setting an entity to a pool it will spawn as long as that pool hasn't reached the spawn limit.There are 3 pools that entities can be assigned to :-animal-water_animal-monsterBack to topTagged Biomes
- - - -| Biome | Tags |
|---|---|
| Beach | -monster, beach, warm | -
| Birch Forest | -animal, monster, birch, forest | -
| Birch Forest Hills | -animal, monster, birch, forest, hills | -
| Birch Forest Hills M | -animal, monster, forest, birch, mutated, hills | -
| Birch Forest M | -animal, monster, forest, birch, mutated | -
| Cold Ocean | -ocean, cold, monster | -
| Cold Taiga M | -animal, monster, taiga, cold, mutated | -
| Dark Forest | -animal, monster, forest, roofed | -
| Dark Forest M | -animal, monster, roofed, forest, mutated | -
| Deep Cold Ocean | -ocean, cold, monster, deep | -
| Deep Frozen Ocean | -ocean, frozen, monster, deep | -
| Deep Lukewarm Ocean | -ocean, lukewarm, monster, deep | -
| Deep Ocean | -ocean, monster, deep | -
| Deep Warm Ocean | -ocean, warm, monster, deep | -
| Desert | -monster, desert | -
| Desert Hills | -monster, desert, hills | -
| Desert M | -monster, desert, mutated | -
| Forest | -animal, monster, forest | -
| Forest Hills | -animal, monster, hills | -
| Forest M | -monster, flower_forest, forest, mutated | -
| Frozen Ocean | -ocean, frozen | -
| Frozen River | -river, frozen | -
| Giant Tree Taiga | -animal, monster, taiga, mega | -
| Giant Tree Taiga Hills | -animal, monster, taiga, mega, hills | -
| Giant Tree Taiga Hills M | -animal, monster, taiga, mega, hills, mutated | -
| Giant Trees Taiga M | -animal, monster, mutated, mega | -
| Jungle | -animal, monster, jungle | -
| Jungle Edge | -animal, monster, jungle, edge | -
| Jungle Edge M | -animal, monster, jungle, edge, mutated | -
| Jungle Hills | -animal, monster, jungle, hills | -
| Jungle M | -animal, monster, jungle, mutated | -
| Lukewarm Ocean | -ocean, lukewarm, monster | -
| Mesa | -monster | -
| Mesa M | -animal, monster, mesa, mutated | -
| Mesa Plateau | -monster, mesa | -
| Mesa Plateau M | -monster, mesa, plateau, mutated | -
| Mesa Plateau Stone | -monster, plataeu | -
| Mesa Plateau Stone M | -monster, mesa, plateau, mutated, stone | -
| Mountain | -animal, monster, extreme_hills | -
| Mountain + M | -animal, monster, extreme_hills, mutated, forest | -
| Mountain Edge | -animal, monster, extreme_hills, edge, mountain | -
| Mountain M | -animal, monster, extreme_hills, mutated | -
| Mushroom Fields | -mooshroom_island | -
| Mushroom Fields Shore | -mooshroom_island, shore | -
| Nether | -nether | -
| Ocean | -ocean, monster | -
| Plains | -animal, monster, plains | -
| Plains M | -animal, monster, plains, mutated | -
| River | -river | -
| Savanna | -animal, monster, savanna | -
| Savanna M | -animal, monster, savanna, mutated | -
| Savanna Plateau | -animal, monster, savanna | -
| Savanna Plateau M | -animal, monster, savanna, plateau, mutated | -
| Snowy Beach | -monster, beach, cold | -
| Snowy Mountains | -frozen, ice, mountain | -
| Snowy Taiga | -animal, monster, taiga, cold | -
| Snowy Taiga Hills | -animal, monster, taiga, cold, hills | -
| Snowy Tundra | -frozen, ice_plain, ice | -
| Snowy Tundra M | -monster, frozen, ice_plains, mutated | -
| Stone Shore | -monster, beach, stone | -
| Swamp | -animal, monster, swamp | -
| Swamp M | -animal, monster, swamp, mutated | -
| Taiga | -animal, monster, taiga | -
| Taiga Hills | -animal, monster, taiga, hills | -
| Taiga M | -animal, monster, taiga, mutated | -
| The End | -the_end | -
| Warm Ocean | -ocean, warm, monster | -
| Wooded Mountain | -animal, monster, extreme_hills, forest, mountain | -
Filters
- -Filters allow data objects to specify test criteria which allows their use.For example, a model that includes a filter will only be used when the filter criteria is true.A typical filter consists of four parameters: name: the name of the test to apply. domain: the domain the test should be performed in. An armor slot, for example. This parameter is only used by a few tests. operator: the comparison to apply with the value, such as 'equal' or 'greater'. value: the value being compared with the test.A typical filter looks like the following: { "test" : "moon_intensity", "subject" : "self", "operator" : "greater", "value" : "0.5" } Which results in the calling entity (self) calculating the moon_intensity at its location and returning true if the result is greater than 0.5.Tests can be combined into groups using the collections 'all_of', 'any_of', or 'none_of'. All tests in an 'all_of' group must pass in order for the group to pass. One or more tests in an 'any_of' group must pass in order for the group to pass. All tests in a 'none_of' group must fail in order for the group to pass.clock_time
- -Compares the current time with a float value in the range (0.0, 1.0). 0.0= Noon 0.25= Sunset 0.5= Midnight 0.75= Sunrise - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Decimal | -- | (Required) A floating point value. | -
distance_to_nearest_player
- -Compares the distance to the nearest Player with a float value. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Decimal | -- | (Required) A floating point value. | -
has_ability
- -Returns true when the subject entity has the named ability. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The Ability type to test
|
-
has_biome_tag
- -Tests whether the biome the subject is in has the specified tag. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The tag to look for | -
has_component
- -Returns true when the subject entity contains the named component. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The component name to look for | -
has_container_open
- -Returns true when the subject Player entity has opened a container. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
has_damage
- -Returns true when the subject entity receives the named damage type. - -| Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value | -String | -- | (Required) The Damage type to test
|
-
has_equipment
- -Tests for the presence of a named item in the designated slot of the subject entity. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| domain | -String | -any | -(Optional) The equipment location to test
|
-||||||||||||||||||||||
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The item name to look for | -
has_mob_effect
- -Tests whether the Subject has the specified mob effect. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Optional) A string value. | -
has_nametag
- -Tests if the subject has been given a custom name. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
has_ranged_weapon
- -Returns true when the subject entity is holding a ranged weapon like a bow or crossbow. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
has_tag
- -Returns true if the subject entity has the tag provided. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Optional) A string value. | -
has_target
- -Returns true if the subject entity has a valid target. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
has_trade_supply
- -Tests whether the target has any trade supply left. Will return false if the target cannot be traded with. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
hourly_clock_time
- -Compares the current 24 hour time with an int value in the range[0, 24000] - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
in_block
- -Returns true when the subject entity is inside a specified Block type. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Optional) A string value. | -
in_caravan
- -Returns true if the subject entity is in a caravan. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
in_clouds
- -Returns true when the subject entity is in the clouds. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
in_contact_with_water
- -Returns true when the subject entity in contact with any water: water, rain, splash water bottle. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
in_lava
- -Returns true when the subject entity is in lava. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
in_nether
- -Returns true when the subject entity is in Nether. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
in_water
- -Returns true when the subject entity is in water. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
in_water_or_rain
- -Returns true when the subject entity is in water or rain. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
inactivity_timer
- -Tests if the specified duration in seconds of inactivity for despawning has been reached. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
is_altitude
- -Tests the current altitude against a provided value. 0= bedrock elevation. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) The altitude value to compare with | -
is_avoiding_mobs
- -Returns true if the subject entity is fleeing from other mobs. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_biome
- -Tests whether the Subject is currently in the named biome. - -| Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||||||||||||||||||
| value | -String | -- | (Required) The Biome type to test
|
-
is_block
- -Returns true when the block has the given name. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The Family name to look for | -
is_brightness
- -Tests the current brightness against a provided value in the range (0.0f, 1.0f). - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Decimal | -- | (Required) The brightness value to compare with. | -
is_climbing
- -Returns true if the subject entity is climbing. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_color
- -Returns true if the subject entity is the named color. - -| Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||||||||||||||
| value | -String | -- | (Required) The Palette Color to test
|
-
is_daytime
- -Returns true during the daylight hours. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_difficulty
- -Tests the current difficulty level of the game. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The game's difficulty level to test
|
-
is_family
- -Returns true when the subject entity is a member of the named family. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The Family name to look for | -
is_game_rule
- -Tests whether a named game rule is active. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| domain | -String | -- | (Required) The Game Rule to test. | -||||||||||||||||||||||
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_humid
- -Tests whether the Subject is in an area with humidity - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_immobile
- -Returns true if the subject entity is immobile. An entity is immobile if it lacks AI goals, has just changed dimensions or if it is a mob and has no health. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_in_village
- -Tests whether the Subject is inside the bounds of a village. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_leashed
- -Returns true if the subject entity is leashed. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_leashed_to
- -Returns true if the subject entity leashed to the calling entity. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_mark_variant
- -Returns true if the subject entity is the mark variant number provided. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
is_moving
- -Returns true if the subject entity is moving. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_owner
- -Returns true if the subject entity is the owner of the calling entity. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_persistent
- -Tests if the subject's persistence matches the bool value passed in. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_riding
- -Returns true if the subject entity is riding on another entity. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_skin_id
- -Returns true if the subject entity is the skin id number provided. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
is_sleeping
- -Tests whether the Subject is sleeping. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_sneaking
- -Returns true if the subject entity is sneaking. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_snow_covered
- -Tests whether the Subject is in an area with snow cover - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_target
- -Returns true if the subject entity is the target of the calling entity. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_temperature_type
- -Tests whether the current temperature is a given type. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The Biome temperature catagory to test
|
-
is_temperature_value
- -Tests the current temperature against a provided value in the range (0.0, 1.0) where 0.0f is the coldest temp and 1.0f is the hottest. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Decimal | -- | (Required) The Biome temperature value to compare with. | -
is_underground
- -Returns true when the subject entity is underground. An entity is considered underground if there are non-solid blocks above it. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_underwater
- -Returns true when the subject entity is under water. An entity is considered underwater if it is completely submerged in water blocks. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_variant
- -Returns true if the subject entity is the variant number provided. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
is_visible
- -Returns true if the subject entity is visible. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
is_weather
- -DEPRECATED - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The Family name to look for | -
light_level
- -Tests is the mob is outside of the specified light level range (0, 16). - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
moon_intensity
- -Compares the current moon intensity with a float value in the range (0.0, 1.0) - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Decimal | -- | (Required) A floating point value. | -
moon_phase
- -Compares the current moon phase with an integer value in the range (0, 7). - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
on_ground
- -Returns true when the subject entity is on ground. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
on_ladder
- -Returns true when the subject entity is on a ladder. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
random_chance
- -Returns true if the random chance rolls 0 out of a specified max range. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
rider_count
- -Returns the number of riders on this entity. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Integer | -- | (Required) An integer value. | -
surface_mob
- -Tests if the subject is a surface mob. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
trusts
- -Returns true if the subject is trusted by entity. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -Boolean | -true | -(Optional) true or false. | -
weather
- -Tests the current weather in the dimension against a provided weather value. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The Family name to look for | -
weather_at_position
- -Tests the current weather, at the actor's position, against a provided weather value. - -| Name | Type | Default | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| operator | -String | -equals | -(Optional) The comparison to apply with 'value'.
|
-||||||||||||||||||||||
| subject | -String | -self | -(Optional) The subject of this filter test.
|
-||||||||||||||||||||||
| value | -String | -- | (Required) The Family name to look for | -
Server Entity Documentation
- -AI Goals
- - - -minecraft.behavior.hide
- -Allows a mob with the hide component to attempt to move to - and hide at - an owned or nearby POI. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| duration | -Decimal | -1.0 | -Amount of time in seconds that the mob reacts. | -
| poi_type | -String | -- | Defines what POI type to hide at. | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| timeout_cooldown | -Decimal | -8.0 | -The cooldown time in seconds before the goal can be reused after a internal failure or timeout condition. | -
minecraft.behavior.move_to_poi
- -Allows the mob to move to a POI if able to - -| Name | Type | Default Value | Description |
|---|---|---|---|
| poi_type | -String | -- | Tells the goal what POI type it should be looking for | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft.behavior.scared
- -Allows the a mob to become scared when the weather outside is thundering - -| Name | Type | Default Value | Description |
|---|---|---|---|
| sound_interval | -Integer | -0 | -The interval in which a sound will play when active in a 1/delay chance to kick off | -
minecraft.behavior.work
- -allows the NPC to use their jobsite POI - -| Name | Type | Default Value | Description |
|---|---|---|---|
| active_time | -Integer | -0 | -The amount of ticks the NPC will stay in their the work location | -
| can_work_in_rain | -Boolean | -false | -If true, this entity can work when their jobsite POI is being rained on. | -
| goal_cooldown | -Integer | -0 | -The amount of ticks the goal will be on cooldown before it can be used again | -
| on_arrival | -String | -- | Event to run when the mob reaches their jobsite and finishes working. | -
| sound_delay_max | -Integer | -0 | -The max interval in which a sound will play | -
| sound_delay_min | -Integer | -0 | -The min interval in which a sound will play | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| work_in_rain_tolerance | -Integer | --1 | -If "can_work_in_rain" is false, this is the maximum number of ticks left in the goal where rain will not interrupt the goal | -
minecraft:behavior.admire_item
- -Enables the mob to admire items that have been configured as admirable. Must be used in combination with the admire_item component - -| Name | Type | Default Value | Description |
|---|---|---|---|
| admire_item_sound | -String | -- | The sound event to play when admiring the item | -
| sound_interval | -Range [a, b] | -0 | -The range of time in seconds to randomly wait before playing the sound again. | -
minecraft:behavior.barter
- -Enables the mob to barter for items that have been configured as barter currency. Must be used in combination with the barter componentBack to topminecraft:behavior.beg
- -Allows this mob to look at and follow the player that holds food they like. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| items | -List | -- | List of items that this mob likes | -
| look_distance | -Decimal | -8.0 | -Distance in blocks the mob will beg from | -
| look_time | -Range [a, b] | -[2, 4] | -The range of time in seconds this mob will stare at the player holding a food they like, begging for it | -
minecraft:behavior.break_door
- -Allows this mob to break doors.Back to topminecraft:behavior.breed
- -Allows this mob to breed with other mobs. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.celebrate
- -This allows the mob celebrate by jumping up and playing a sound periodically. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| celebration_sound | -String | -- | The sound to occasionally play. | -
| duration | -Decimal | -1.0 | -The duration of the celebration (in seconds). | -
| jump_interval | -Range [a, b] | -0 | -The range of time in seconds to randomly wait before jumping again. | -
| on_celebration_end_event | -Trigger | -- | The event to trigger when the goal's duration expires. | -
| sound_interval | -Range [a, b] | -0 | -The range of time in seconds to randomly wait before playing the sound again. | -
minecraft:behavior.defend_trusted_target
- -Allows the mob to target another mob that hurts an entity it trusts. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| aggro_sound | -String | -- | Sound to occasionally play while defending. | -||||||||||||||||||||||||||||
| attack_interval | -Integer | -0 | -Time in seconds between attacks | -||||||||||||||||||||||||||||
| entity_types | -JSON Object | -- | List of entity types that this mob considers valid targets
|
-||||||||||||||||||||||||||||
| must_see | -Boolean | -false | -If true, only entities in this mob's viewing range can be selected as targets | -||||||||||||||||||||||||||||
| must_see_forget_duration | -Decimal | -3.0 | -Determines the amount of time in seconds that this mob will look for a target before forgetting about it and looking for a new one when the target isn't visible any more | -||||||||||||||||||||||||||||
| within_radius | -Decimal | -0.0 | -Distance in blocks that the target can be within to launch an attack | -
minecraft:behavior.door_interact
- -Allows the mob to open and close doors.Back to topminecraft:behavior.dragondeath
- -Allows the dragon to go out with glory. This controls the Ender Dragon's death animation and can't be used by other mobs.Back to topminecraft:behavior.dragonholdingpattern
- -Allows the Dragon to fly around in a circle around the center podium. Can only be used by the Ender Dragon.Back to topminecraft:behavior.dragonlanding
- -Allows the Dragon to stop flying and transition into perching mode. Can only be used by the Ender Dragon.Back to topminecraft:behavior.dragonscanning
- -Allows the dragon to look around for a player to attack while in perch mode. Can only be used by the Ender Dragon.Back to topminecraft:behavior.dragontakeoff
- -Allows the dragon to leave perch mode and go back to flying around. Can only be used by the Ender Dragon.Back to topminecraft:behavior.drink_potion
- -Allows the mob to drink potions based on specified environment conditions. - -| Name | Type | Default Value | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| speed_modifier | -- | - | 0.0 | -||||||||||||||||
| potions | -List | -- | A list of potions that this entity can drink. Each potion entry has the following parameters:
|
-
minecraft:behavior.eat_carried_item
- -If the mob is carrying a food item, the mob will eat it and the effects will be applied to the mob. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| delay_before_eating | -Decimal | -- | Time in seconds the mob should wait before eating the item. | -
minecraft:behavior.enderman_leave_block
- -Allows the enderman to drop a block they are carrying. Can only be used by Endermen.Back to topminecraft:behavior.enderman_take_block
- -Allows the enderman to take a block and carry it around. Can only be used by Endermen.Back to topminecraft:behavior.explore_outskirts
- -allows a mob to explore the outskirts of a village - -| Name | Type | Default Value | Description |
|---|---|---|---|
| explore_dist | -Decimal | -5.0 | -The distance in which the mob will proceed past the village bounds | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| wait_time | -Integer | -0 | -The time the mob will stand around 'searching' for POIs | -
minecraft:behavior.find_cover
- -Allows the mob to seek shade. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.find_mount
- -Allows the mob to look around for another mob to ride atop it. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_water | -Boolean | -false | -If true, the mob will not go into water blocks when going towards a mount | -
| mount_distance | -Decimal | --1.0 | -This is the distance the mob needs to be, in blocks, from the desired mount to mount it. If the value is below 0, the mob will use its default attack distance | -
| start_delay | -Integer | -0 | -Time the mob will wait before starting to move towards the mount | -
| target_needed | -Boolean | -false | -If true, the mob will only look for a mount if it has a target | -
| within_radius | -Decimal | -0.0 | -Distance in blocks within which the mob will look for a mount | -
minecraft:behavior.find_underwater_treasure
- -Allows the mob to move towards the nearest underwater ruin or shipwreck. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| search_range | -Integer | -0 | -The range that the mob will search for a treasure chest within a ruin or shipwreck to move towards. | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| stop_distance | -Decimal | -2.0 | -The distance the mob will move before stopping. | -
minecraft:behavior.flee_sun
- -Allows the mob to run away from direct sunlight and seek shade. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.float
- -Allows the mob to stay afloat while swimming.Back to topminecraft:behavior.float_wander
- -Allows the mob to float around like the Ghast. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| float_duration | -Range [a, b] | -[0.0, 0.0] | -Range of time in seconds the mob will float around before landing and choosing to do something else | -
| must_reach | -Boolean | -false | -If true, the point has to be reachable to be a valid target | -
| random_reselect | -Boolean | -false | -If true, the mob will randomly pick a new point while moving to the previously selected one | -
| xz_dist | -Integer | -10 | -Distance in blocks on ground that the mob will look for a new spot to move to. Must be at least 1 | -
| y_dist | -Integer | -7 | -Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1 | -
| y_offset | -Decimal | -0.0 | -Height in blocks to add to the selected target position | -
minecraft:behavior.follow_caravan
- -Allows the mob to follow mobs that are in a caravan. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entity_count | -Integer | -1 | -Number of entities that can be in the caravan | -||||||||||||||||||||||||||||
| entity_types | -JSON Object | -- | List of entity types that this mob can follow in a caravan
|
-||||||||||||||||||||||||||||
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.follow_mob
- -Allows the mob to follow other mobs. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| search_range | -Integer | -0 | -The distance in blocks it will look for a mob to follow | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| stop_distance | -Decimal | -2.0 | -The distance in blocks this mob stops from the mob it is following | -
minecraft:behavior.follow_owner
- -Allows the mob to follow the player that owns them. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| start_distance | -Decimal | -10.0 | -The distance in blocks that the owner can be away from this mob before it starts following it | -
| stop_distance | -Decimal | -2.0 | -The distance in blocks this mob will stop from its owner while following it | -
minecraft:behavior.follow_parent
- -Allows the mob to follow their parent around. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.follow_target_captain
- -Allows mob to move towards its current target captain. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| follow_distance | -Decimal | -0.0 | -Defines the distance in blocks the mob will stay from its target while following. | -
| within_radius | -Decimal | -0.0 | -Defines the maximum distance in blocks a mob can get from its target captain before giving up trying to follow it. | -
minecraft:behavior.go_home
- -Allows the mob to move back to the position they were spawned. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| interval | -Integer | -120 | -A random value to determine when to randomly move somewhere. This has a 1/interval chance to choose this goal | -
| on_home | -String | -- | Event to run when this mob gets home. | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.hold_ground
- -The mob freezes and looks at the mob they are targeting. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| broadcast | -Boolean | -false | -Whether to broadcast out the mob's target to other mobs of the same type. | -
| broadcast_range | -Decimal | -0.0f | -Range in blocks for how far to broadcast. | -
| min_radius | -Decimal | -10.0f | -Minimum distance the target must be for the mob to run this goal. | -
| within_radius_event | -String | -- | Event to run when target is within the radius. This event is broadcasted if broadcast is true. | -
minecraft:behavior.hurt_by_target
- -Allows the mob to target another mob that hurts them. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| alert_same_type | -Boolean | -false | -If true, nearby mobs of the same type will be alerted about the damage | -||||||||||||||||||||||||||||
| entity_types | -JSON Object | -- | List of entity types that this mob can target when hurt by them
|
-||||||||||||||||||||||||||||
| hurt_owner | -Boolean | -false | -If true, the mob will hurt its owner and other mobs with the same owner as itself | -
minecraft:behavior.inspect_bookshelf
- -Allows the mob to inspect bookshelves. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| search_count | -Integer | -10 | -The number of blocks each tick that the mob will check within it's search range and height for a valid block to move to. A value of 0 will have the mob check every block within range in one tick | -
| search_height | -Integer | -1 | -The height that the mob will search for bookshelves | -
| search_range | -Integer | -0 | -Distance in blocks the mob will look for books to inspect | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.knockback_roar
- -Allows the mob to perform a damaging knockback that affects all nearby entities. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| Trigger | -- | - | on_roar_end | -
| attack_time | -Decimal | -0.5 | -The delay after which the knockback occurs (in seconds). | -
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -
| duration | -Decimal | -1.0 | -The duration of the roar (in seconds). | -
| knockback_damage | -Integer | -6 | -The damage dealt by the knockback roar. | -
| knockback_horizontal_strength | -Integer | -4 | -The strength of the horizontal knockback. | -
| knockback_range | -Integer | -4 | -The radius (in blocks) of the knockback effect. | -
| knockback_vertical_strength | -Integer | -4 | -The strength of the vertical knockback. | -
minecraft:behavior.lay_down
- -Allows mobs to lay down at times - -| Name | Type | Default Value | Description |
|---|---|---|---|
| interval | -Integer | -120 | -A random value to determine at what intervals something can occur. This has a 1/interval chance to choose this goal | -
| random_stop_interval | -Integer | -120 | -a random value in which the goal can use to pull out of the behavior. This is a 1/interval chance to play the sound | -
minecraft:behavior.lay_egg
- -Allows the mob to lay an egg block on a sand block if the mob is pregnant. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| on_lay | -String | -- | Event to run when this mob lays the egg. | -
| search_height | -Integer | -1 | -Height in blocks the mob will look for sand block to move towards | -
| search_range | -Integer | -0 | -The distance in blocks it will look for a sand block to move towards | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.leap_at_target
- -Allows monsters to jump at and attack their target. Can only be used by hostile mobs. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| must_be_on_ground | -Boolean | -true | -If true, the mob will only jump at its target if its on the ground. Setting it to false will allow it to jump even if its already in the air | -
| set_persistent | -Boolean | -false | -Allows the actor to be set to persist upon targeting a player | -
| yd | -Decimal | -0.0 | -The height in blocks the mob jumps when leaping at its target | -
minecraft:behavior.look_at_entity
- -Allows the mob to look at nearby entities. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| angle_of_view_horizontal | -Integer | -360 | -The angle in degrees that the mob can see in the Y-axis (up-down) | -
| angle_of_view_vertical | -Integer | -360 | -The angle in degrees that the mob can see in the X-axis (left-right) | -
| filters | -Minecraft Filter | -- | Filter to determine the conditions for this mob to look at the entity | -
| look_distance | -Decimal | -8.0 | -The distance in blocks from which the entity will look at | -
| look_time | -Range [a, b] | -[2, 4] | -Time range to look at the entity | -
| probability | -Decimal | -0.02 | -The probability of looking at the target. A value of 1.00 is 100% | -
minecraft:behavior.look_at_player
- -Allows the mob to look at the player when the player is nearby. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| angle_of_view_horizontal | -Integer | -360 | -The angle in degrees that the mob can see in the Y-axis (up-down) | -
| angle_of_view_vertical | -Integer | -360 | -The angle in degrees that the mob can see in the X-axis (left-right) | -
| look_distance | -Decimal | -8.0 | -The distance in blocks from which the entity will look at | -
| look_time | -Range [a, b] | -[2, 4] | -Time range to look at the entity | -
| probability | -Decimal | -0.02 | -The probability of looking at the target. A value of 1.00 is 100% | -
minecraft:behavior.look_at_target
- -Allows the mob to look at the entity they are targetting. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| angle_of_view_horizontal | -Integer | -360 | -The angle in degrees that the mob can see in the Y-axis (up-down) | -
| angle_of_view_vertical | -Integer | -360 | -The angle in degrees that the mob can see in the X-axis (left-right) | -
| look_distance | -Decimal | -8.0 | -The distance in blocks from which the entity will look at | -
| look_time | -Range [a, b] | -[2, 4] | -Time range to look at the entity | -
| probability | -Decimal | -0.02 | -The probability of looking at the target. A value of 1.00 is 100% | -
minecraft:behavior.look_at_trading_player
- -Allows the mob to look at the player they are trading with. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| angle_of_view_horizontal | -Integer | -360 | -The angle in degrees that the mob can see in the Y-axis (up-down) | -
| angle_of_view_vertical | -Integer | -360 | -The angle in degrees that the mob can see in the X-axis (left-right) | -
| look_distance | -Decimal | -8.0 | -The distance in blocks from which the entity will look at | -
| look_time | -Range [a, b] | -[2, 4] | -Time range to look at the entity | -
| probability | -Decimal | -0.02 | -The probability of looking at the target. A value of 1.00 is 100% | -
minecraft:behavior.make_love
- -Allows the villager to look for a mate to spawn other villagers with. Can only be used by Villagers.Back to topminecraft:behavior.mingle
- -Allows an entity to go to the village bell and mingle with other entities - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -
| duration | -Decimal | -1.0 | -Amount of time in seconds that the entity will chat with another entity | -
| mingle_distance | -Decimal | -2.0f | -The distance from its partner that this entity will mingle. If the entity type is not the same as the entity, this value needs to be identical on both entities. | -
| mingle_partner_type | -List | -empty | -The entity type that this entity is allowed to mingle with | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.mount_pathing
- -Allows the mob to move around on its own while mounted seeking a target to attack. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| target_dist | -Decimal | -0.0 | -The distance at which this mob wants to be away from its target | -
| track_target | -Boolean | -false | -If true, this mob will chase after the target as long as it's a valid target | -
minecraft:behavior.move_indoors
- -Can only be used by Villagers. Allows them to seek shelter indoors. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| timeout_cooldown | -Decimal | -8.0 | -The cooldown time in seconds before the goal can be reused after a internal failure or timeout condition | -
minecraft:behavior.move_through_village
- -Can only be used by Villagers. Allows the villagers to create paths around the village. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| only_at_night | -Boolean | -false | -If true, the mob will only move through the village during night time | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.move_to_land
- -Allows the mob to move back onto land when in water. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| search_count | -Integer | -10 | -The number of blocks each tick that the mob will check within it's search range and height for a valid block to move to. A value of 0 will have the mob check every block within range in one tick | -
| search_height | -Integer | -1 | -Height in blocks the mob will look for land to move towards | -
| search_range | -Integer | -0 | -The distance in blocks it will look for land to move towards | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.move_to_lava
- -Allows the mob to move back into lava when on land. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| search_count | -Integer | -10 | -The number of blocks each tick that the mob will check within it's search range and height for a valid block to move to. A value of 0 will have the mob check every block within range in one tick | -
| search_height | -Integer | -1 | -Height in blocks the mob will look for lava to move towards | -
| search_range | -Integer | -0 | -The distance in blocks it will look for lava to move towards | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.move_to_random_block
- -Allows mob to move towards a random block. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| block_distance | -Decimal | -16.0 | -Defines the distance from the mob, in blocks, that the block to move to will be chosen. | -
| within_radius | -Decimal | -0.0 | -Defines the distance in blocks the mob has to be from the block for the movement to be finished. | -
minecraft:behavior.move_to_village
- -Allows the mob to move into a random location within a village. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| search_range | -Integer | -0 | -The distance in blocks to search for villages. If <= 0, find the closest village regardless of distance. | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.move_to_water
- -Allows the mob to move back into water when on land. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| search_count | -Integer | -10 | -The number of blocks each tick that the mob will check within it's search range and height for a valid block to move to. A value of 0 will have the mob check every block within range in one tick | -
| search_height | -Integer | -1 | -Height in blocks the mob will look for water to move towards | -
| search_range | -Integer | -0 | -The distance in blocks it will look for water to move towards | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.move_towards_target
- -Allows mob to move towards its current target. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| within_radius | -Decimal | -0.0 | -Defines the radius in blocks that the mob tries to be from the target. A value of 0 means it tries to occupy the same block as the target | -
minecraft:behavior.nap
- -Allows mobs to occassionally stop and take a nap under certain conditions. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_max | -Decimal | -0.0 | -Maximum time in seconds the mob has to wait before using the goal again | -
| cooldown_min | -Decimal | -0.0 | -Minimum time in seconds the mob has to wait before using the goal again | -
| mob_detect_dist | -Decimal | -6.0 | -The block distance in x and z that will be checked for mobs that this mob detects | -
| mob_detect_height | -Decimal | -6.0 | -The block distance in y that will be checked for mobs that this mob detects | -
minecraft:behavior.nearest_attackable_target
- -Allows an entity to attack the closest target within a given subset of specific target types. - -| Name | Type | Default Value | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| attack_interval | -Integer | -0 | -Time range (in seconds) between searching for an attack target, range is in (0, "attack_interval"]. Only used if "attack_interval" is greater than 0, otherwise "scan_interval" is used. | -||||||||||||||||||||
| attack_interval_min | -Integer | -0 | -Alias for "attack_interval"; provides the same functionality as "attack_interval". | -||||||||||||||||||||
| attack_owner | -Boolean | -false | -If true, this entity can attack its owner. | -||||||||||||||||||||
| entity_types | -JSON Object | -- | Filters which types of targets are valid for this entity.
|
-||||||||||||||||||||
| must_reach | -Boolean | -false | -If true, this entity requires a path to the target. | -||||||||||||||||||||
| must_see | -Boolean | -false | -Determines if target-validity requires this entity to be in range only, or both in range and in sight. | -||||||||||||||||||||
| must_see_forget_duration | -Decimal | -3.0 | -Time (in seconds) the target must not be seen by this entity to become invalid. Used only if "must_see" is true. | -||||||||||||||||||||
| persist_time | -Decimal | -0.0 | -Time (in seconds) this entity can continue attacking the target after the target is no longer valid. | -||||||||||||||||||||
| reselect_targets | -Boolean | -false | -Allows the attacking entity to update the nearest target, otherwise a target is only reselected after each "scan_interval" or "attack_interval". | -||||||||||||||||||||
| scan_interval | -Integer | -10 | -If "attack_interval" is 0 or isn't declared, then between attacks: scanning for a new target occurs every amount of ticks equal to "scan_interval", minimum value is 1. Values under 10 can affect performance. | -||||||||||||||||||||
| set_persistent | -Boolean | -false | -Allows the actor to be set to persist upon targeting a player | -||||||||||||||||||||
| target_invisible_multiplier | -Decimal | -0.7 | -Multiplied with the target's armor coverage percentage to modify "max_dist" when detecting an invisible target. | -||||||||||||||||||||
| target_search_height | -Decimal | --1.0 | -Maximum vertical target-search distance, if it's greater than the target type's "max_dist". A negative value defaults to "entity_types" greatest "max_dist". | -||||||||||||||||||||
| target_sneak_visibility_multiplier | -Decimal | -0.8 | -Multiplied with the target type's "max_dist" when trying to detect a sneaking target. | -||||||||||||||||||||
| within_radius | -Decimal | -0.0 | -Maximum distance this entity can be from the target when following it, otherwise the target becomes invalid. This value is only used if the entity doesn't declare "minecraft:follow_range". | -
minecraft:behavior.nearest_prioritized_attackable_target
- -Allows the mob to check for and pursue the nearest valid target. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| attack_interval | -Integer | -0 | -Time in seconds before selecting a target | -||||||||||||||||||||||||||||
| entity_types | -JSON Object | -- | List of entity types that this mob considers valid targets
|
-||||||||||||||||||||||||||||
| must_reach | -Boolean | -false | -If true, only entities that this mob can path to can be selected as targets | -||||||||||||||||||||||||||||
| must_see | -Boolean | -false | -If true, only entities in this mob's viewing range can be selected as targets | -||||||||||||||||||||||||||||
| must_see_forget_duration | -Decimal | -3.0 | -Determines the amount of time in seconds that this mob will look for a target before forgetting about it and looking for a new one when the target isn't visible any more | -||||||||||||||||||||||||||||
| persist_time | -Decimal | -0.0f | -Time in seconds for a valid target to stay targeted when it becomes and invalid target. | -||||||||||||||||||||||||||||
| priority | -Integer | -0 | -Specifies the priority in which filtered enemy types should be attacked. Lower number means higher priority. | -||||||||||||||||||||||||||||
| reselect_targets | -Boolean | -false | -If true, the target will change to the current closest entity whenever a different entity is closer | -||||||||||||||||||||||||||||
| scan_interval | -Integer | -10 | -How many ticks to wait between scanning for a target. | -||||||||||||||||||||||||||||
| set_persistent | -Boolean | -false | -Allows the actor to be set to persist upon targeting a player | -||||||||||||||||||||||||||||
| target_search_height | -Decimal | --1.0f | -Height in blocks to search for a target mob. -1.0f means the height does not matter. | -||||||||||||||||||||||||||||
| within_radius | -Decimal | -0.0 | -Distance in blocks that the target can be within to launch an attack | -
minecraft:behavior.ocelot_sit_on_block
- -Allows to mob to be able to sit in place like the ocelot. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.offer_flower
- -Allows the mob to offer the player a flower like the Iron Golem does.Back to topminecraft:behavior.open_door
- -Allows the mob to open doors. Requires the mob to be able to path through doors, otherwise the mob won't even want to try opening them. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| close_door_after | -Boolean | -true | -If true, the mob will close the door after opening it and going through it | -
minecraft:behavior.owner_hurt_by_target
- -Allows the mob to target another mob that hurts their owner. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entity_types | -JSON Object | -- | List of entity types that this mob can target if they hurt their owner
|
-
minecraft:behavior.owner_hurt_target
- -Allows the mob to target a mob that is hurt by their owner. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entity_types | -JSON Object | -- | List of entity types that this entity can target if the potential target is hurt by this mob's owner
|
-
minecraft:behavior.panic
- -Allows the mob to enter the panic state, which makes it run around and away from the damage source that made it enter this state. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| damage_sources | -List | -all | -The list of Entity Damage Sources that will cause this mob to panic | -
| force | -Boolean | -false | -If true, this mob will not stop panicking until it can't move anymore or the goal is removed from it | -
| ignore_mob_damage | -Boolean | -false | -If true, the mob will not panic in response to damage from other mobs. This overrides the damage types in "damage_sources" | -
| prefer_water | -Boolean | -false | -If true, the mob will prefer water over land | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.peek
- -Allows the mob to peek out. This is what the shulker uses to look out of its shell.Back to topminecraft:behavior.pet_sleep_with_owner
- -Allows the pet mob to move onto a bed with it's owner while sleeping. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| search_height | -Integer | -1 | -Height in blocks from the owner the pet can be to sleep with owner. | -
| search_range | -Integer | -0 | -The distance in blocks from the owner the pet can be to sleep with owner. | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.pickup_items
- -Allows the mob to pick up items on the ground. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| can_pickup_any_item | -Boolean | -false | -If true, the mob can pickup any item | -
| can_pickup_to_hand_or_equipment | -Boolean | -true | -If true, the mob can pickup items to its hand or armor slots | -
| excluded_items | -List | -- | List of items this mob will not pick up | -
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| max_dist | -Decimal | -0.0 | -Maximum distance this mob will look for items to pick up | -
| pickup_based_on_chance | -Boolean | -false | -If true, depending on the difficulty, there is a random chance that the mob may not be able to pickup items | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| track_target | -Boolean | -false | -If true, this mob will chase after the target as long as it's a valid target | -
minecraft:behavior.play
- -Allows the mob to play with other baby villagers. This can only be used by Villagers. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.player_ride_tamed
- -Allows the mob to be ridden by the player after being tamed.Back to topminecraft:behavior.raid_garden
- -Allows the mob to eat/raid crops out of farms until they are full. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| blocks | -List | -- | Blocks that the mob is looking for to eat/raid | -
| eat_delay | -Integer | -2 | -Time in seconds between each time it eats/raids | -
| full_delay | -Integer | -100 | -Amount of time in seconds before this mob wants to eat/raid again after eating its maximum | -
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| initial_eat_delay | -Integer | -0 | -Time in seconds before starting to eat/raid once it arrives at it | -
| max_to_eat | -Integer | -6 | -Maximum number of crops this entity wants to eat/raid. If set to zero or less then it doesn't have a maximum | -
| search_range | -Integer | -0 | -Distance in blocks the mob will look for crops to eat | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.random_breach
- -Allows the mob to randomly break surface of the water. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -
| interval | -Integer | -120 | -A random value to determine when to randomly move somewhere. This has a 1/interval chance to choose this goal | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| xz_dist | -Integer | -10 | -Distance in blocks on ground that the mob will look for a new spot to move to. Must be at least 1 | -
| y_dist | -Integer | -7 | -Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1 | -
minecraft:behavior.random_fly
- -Allows a mob to randomly fly around. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| can_land_on_trees | -Boolean | -true | -If true, the mob can stop flying and land on a tree instead of the ground | -
| xz_dist | -Integer | -10 | -Distance in blocks on ground that the mob will look for a new spot to move to. Must be at least 1 | -
| y_dist | -Integer | -7 | -Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1 | -
minecraft:behavior.random_hover
- -Allows the mob to hover around randomly, close to the surface - -| Name | Type | Default Value | Description |
|---|---|---|---|
| - | - | - | hover_height | -
| interval | -Integer | -120 | -A random value to determine when to randomly move somewhere. This has a 1/interval chance to choose this goal | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| xz_dist | -Integer | -10 | -Distance in blocks on ground that the mob will look for a new spot to move to. Must be at least 1 | -
| y_dist | -Integer | -7 | -Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1 | -
| y_offset | -Decimal | -0.0 | -Height in blocks to add to the selected target position | -
minecraft:behavior.random_look_around
- -Allows the mob to randomly look around. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| look_time | -Range [a, b] | -[2, 4] | -The range of time in seconds the mob will stay looking in a random direction before looking elsewhere | -
minecraft:behavior.random_look_around_and_sit
- -Allows the mob to randomly sit and look around for a duration. Note: Must have a sitting animation set up to use this. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_look_count | -Integer | -2 | -The max amount of unique looks a mob will have while looking around. | -
| max_look_time | -Integer | -40 | -The max amount of time (in ticks) a mob will stay looking at a direction while looking around. | -
| min_look_count | -Integer | -1 | -The min amount of unique looks a mob will have while looking around. | -
| min_look_time | -Integer | -20 | -The min amount of time (in ticks) a mob will stay looking at a direction while looking around. | -
| probability | -Integer | -0.02 | -The probability of randomly looking around/sitting. | -
minecraft:behavior.random_sitting
- -Allows the mob to randomly sit for a duration. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -
| min_sit_time | -Decimal | -10 | -The minimum amount of time in seconds before the mob can stand back up | -
| start_chance | -Decimal | -0.1 | -This is the chance that the mob will start this goal, from 0 to 1 | -
| stop_chance | -Decimal | -0.3 | -This is the chance that the mob will stop this goal, from 0 to 1 | -
minecraft:behavior.random_stroll
- -Allows a mob to randomly stroll around. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| interval | -Integer | -120 | -A random value to determine when to randomly move somewhere. This has a 1/interval chance to choose this goal | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| xz_dist | -Integer | -10 | -Distance in blocks on ground that the mob will look for a new spot to move to. Must be at least 1 | -
| y_dist | -Integer | -7 | -Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1 | -
minecraft:behavior.random_swim
- -Allows an entity to randomly move through water - -| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_surface | -Boolean | -true | -If true, the mob will avoid surface water blocks by swimming below them | -
| interval | -Integer | -120 | -A random value to determine when to randomly move somewhere. This has a 1/interval chance to choose this goal | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| xz_dist | -Integer | -10 | -Distance in blocks on ground that the mob will look for a new spot to move to. Must be at least 1 | -
| y_dist | -Integer | -7 | -Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1 | -
minecraft:behavior.receive_love
- -Allows the villager to stop so another villager can breed with it. Can only be used by a Villager.Back to topminecraft:behavior.restrict_open_door
- -Allows the mob to stay indoors during night time.Back to topminecraft:behavior.restrict_sun
- -Allows the mob to automatically start avoiding the sun when its a clear day out.Back to topminecraft:behavior.rise_to_liquid_level
- -Allows the mob to stay at a certain level when in liquid.Back to topminecraft:behavior.roll
- -This allows the mob to roll forward. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| probability | -Decimal | -[1.0] | -The probability that the mob will use the goal. | -
minecraft:behavior.run_around_like_crazy
- -Allows the mob to run around aimlessly. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.send_event
- -Allows the mob to send an event to another mob. - -| Name | Type | Default Value | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| cast_duration | -Decimal | -Total delay of the steps | -Time in seconds for the entire event sending process | -||||||||||||||||
| look_at_target | -Boolean | -true | -If true, the mob will face the entity it sends an event to | -||||||||||||||||
| sequence | -List | -- | List of events to send
|
-
| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entity_types | -JSON Object | -- | List of entities this mob will share items with
|
-||||||||||||||||||||||||||||
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -||||||||||||||||||||||||||||
| max_dist | -Decimal | -0.0 | -Maximum distance in blocks this mob will look for entities to share items with | -||||||||||||||||||||||||||||
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.silverfish_merge_with_stone
- -Allows the mob to go into stone blocks like Silverfish do. Currently it can only be used by Silverfish.Back to topminecraft:behavior.silverfish_wake_up_friends
- -Allows the mob to alert mobs in nearby blocks to come out. Currently it can only be used by Silverfish.Back to topminecraft:behavior.skeleton_horse_trap
- -Allows Equine mobs to be Horse Traps and be triggered like them, spawning a lightning bolt and a bunch of horses when a player is nearby. Can only be used by Horses, Mules, Donkeys and Skeleton Horses. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| duration | -Decimal | -1.0 | -Amount of time in seconds the trap exists. After this amount of time is elapsed, the trap is removed from the world if it hasn't been activated | -
| within_radius | -Decimal | -0.0 | -Distance in blocks that the player has to be within to trigger the horse trap | -
minecraft:behavior.sleep
- -Allows mobs that own a bed to in a village to move to and sleep in it. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -
| sleep_collider_height | -Decimal | -1.0 | -The height of the mob's collider while sleeping | -
| sleep_collider_width | -Decimal | -1.0 | -The width of the mob's collider while sleeping | -
| sleep_y_offset | -Decimal | -1.0 | -The y offset of the mob's collider while sleeping | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| timeout_cooldown | -Decimal | -8.0 | -The cooldown time in seconds before the goal can be reused after a internal failure or timeout condition | -
minecraft:behavior.slime_attack
- -Can only be used by Slimes and Magma Cubes. Allows the mob to use a melee attack like the slime's. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| set_persistent | -Boolean | -false | -Allows the actor to be set to persist upon targeting a player | -
minecraft:behavior.snacking
- -Allows the mob to take a load off and snack on food that it found nearby. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| items | -List | -- | Items that we are interested in snacking on | -
| snacking_cooldown | -Decimal | -7.5 | -The cooldown time in seconds before the mob is able to snack again | -
| snacking_cooldown_min | -Decimal | -0.5f | -The minimum time in seconds before the mob is able to snack again | -
| snacking_stop_chance | -Decimal | -0.0017 | -This is the chance that the mob will stop snacking, from 0 to 1 | -
minecraft:behavior.sneeze
- -Allows the mob to stop and sneeze possibly startling nearby mobs and dropping an item. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -||||||||||||||||||||||||||||
| drop_item_chance | -Decimal | -1.0 | -The probability that the mob will drop an item when it sneezes. | -||||||||||||||||||||||||||||
| entity_types | -JSON Object | -- | List of entity types this mob will startle (cause to jump) when it sneezes.
|
-||||||||||||||||||||||||||||
| loot_table | -String | -- | Loot table to select dropped items from. | -||||||||||||||||||||||||||||
| prepare_sound | -String | -- | Sound to play when the sneeze is about to happen. | -||||||||||||||||||||||||||||
| prepare_time | -Decimal | -1.0 | -The time in seconds that the mob takes to prepare to sneeze (while the prepare_sound is playing). | -||||||||||||||||||||||||||||
| probability | -Decimal | -0.02 | -The probability of sneezing. A value of 1.00 is 100% | -||||||||||||||||||||||||||||
| sound | -String | -- | Sound to play when the sneeze occurs. | -||||||||||||||||||||||||||||
| within_radius | -Decimal | -0.0 | -Distance in blocks that mobs will be startled. | -
minecraft:behavior.squid_dive
- -Allows the squid to dive down in water. Can only be used by the Squid.Back to topminecraft:behavior.squid_flee
- -Allows the squid to swim away. Can only be used by the Squid.Back to topminecraft:behavior.squid_idle
- -Allows the squid to swim in place idly. Can only be used by the Squid.Back to topminecraft:behavior.squid_move_away_from_ground
- -Allows the squid to move away from ground blocks and back to water. Can only be used by the Squid.Back to topminecraft:behavior.squid_out_of_water
- -Allows the squid to stick to the ground when outside water. Can only be used by the Squid.Back to topminecraft:behavior.stalk_and_pounce_on_target
- -Allows a mob to stalk a target, then once within range pounce onto a target, on success the target will be attacked dealing damage defined by the attack component. On failure, the mob will risk getting stuck - -| Name | Type | Default Value | Description |
|---|---|---|---|
| interest_time | -Decimal | -2.0 | -The amount of time the mob will be interested before pouncing. This happens when the mob is within range of pouncing | -
| leap_distance | -Decimal | -0.8 | -The distance in blocks the mob jumps in the direction of its target | -
| leap_height | -Decimal | -0.9 | -The height in blocks the mob jumps when leaping at its target | -
| max_stalk_dist | -Decimal | -10.0 | -The maximum distance away a target can be before the mob gives up on stalking | -
| pounce_max_dist | -Decimal | -5.0 | -The maximum distance away from the target in blocks to begin pouncing at the target | -
| set_persistent | -Boolean | -false | -Allows the actor to be set to persist upon targeting a player | -
| stalk_speed | -Decimal | -1.2 | -The movement speed in which you stalk your target | -
| strike_dist | -Decimal | -2.0 | -The max distance away from the target when landing from the pounce that will still result in damaging the target | -
| stuck_time | -Decimal | -2.0 | -The amount of time the mob will be stuck if they fail and land on a block they can be stuck on | -
minecraft:behavior.stay_while_sitting
- -Allows the mob to stay put while it is in a sitting state instead of doing something else.Back to topminecraft:behavior.stomp_turtle_egg
- -Allows this mob to stomp turtle eggs - -| Name | Type | Default Value | Description |
|---|---|---|---|
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| interval | -Integer | -120 | -A random value to determine when to randomly move somewhere. This has a 1/interval chance to choose this goal | -
| search_height | -Integer | -1 | -Height in blocks the mob will look for turtle eggs to move towards | -
| search_range | -Integer | -0 | -The distance in blocks it will look for turtle eggs to move towards | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
minecraft:behavior.stroll_towards_village
- -Allows the mob to move into a random location within a village within the search range. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_time | -Decimal | -0.0 | -Time in seconds the mob has to wait before using the goal again | -
| goal_radius | -Decimal | -0.5 | -Distance in blocks within the mob considers it has reached the goal. This is the "wiggle room" to stop the AI from bouncing back and forth trying to reach a specific spot | -
| search_range | -Integer | -0 | -The distance in blocks to search for points inside villages. If <= 0, find the closest village regardless of distance. | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| start_chance | -Decimal | -0.1 | -This is the chance that the mob will start this goal, from 0 to 1 | -
minecraft:behavior.summon_entity
- -Allows the mob to attack the player by summoning other entities. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| summon_choices | -List | -- | List of spells for the mob to use to summon entities. Each spell has the following parameters:
|
-
minecraft:behavior.swell
- -Allows the creeper to swell up when a player is nearby. It can only be used by Creepers. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| start_distance | -Decimal | -10.0 | -This mob starts swelling when a target is at least this many blocks away | -
| stop_distance | -Decimal | -2.0 | -This mob stops swelling when a target has moved away at least this many blocks | -
minecraft:behavior.take_flower
- -Can only be used by Villagers. Allows the mob to accept flowers from Iron Golems.Back to topminecraft:behavior.tempt
- -Allows the mob to be tempted by food they like. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| can_get_scared | -Boolean | -false | -If true, the mob can stop being tempted if the player moves too fast while close to this mob | -
| items | -List | -- | List of items this mob is tempted by | -
| speed_multiplier | -Decimal | -1.0 | -Movement speed multiplier of the mob when using this AI Goal | -
| within_radius | -Decimal | -0.0 | -Distance in blocks this mob can get tempted by a player holding an item they like | -
minecraft:behavior.trade_interest
- -Allows the mob to look at a player that is holding a tradable item. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| carried_item_switch_time | -Decimal | -2.0 | -The max time in seconds that the trader will hold an item before attempting to switch for a different item that takes the same trade | -
| cooldown | -Decimal | -2.0 | -The time in seconds before the trader can use this goal again | -
| interest_time | -Decimal | -45.0 | -The max time in seconds that the trader will be interested with showing it's trade items | -
| remove_item_time | -Decimal | -1.0 | -The max time in seconds that the trader will wait when you no longer have items to trade | -
| within_radius | -Decimal | -0.0 | -Distance in blocks this mob can be interested by a player holding an item they like | -
minecraft:behavior.trade_with_player
- -Allows the player to trade with this mob.Back to topminecraft:behavior.vex_copy_owner_target
- -Allows the mob to target the same entity its owner is targeting. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entity_types | -JSON Object | -- | List of entities this mob can copy the owner from
|
-
minecraft:behavior.vex_random_move
- -Allows the mob to move around randomly like the Vex.Back to topminecraft:behavior.wither_random_attack_pos_goal
- -Allows the wither to launch random attacks. Can only be used by the Wither Boss.Back to topminecraft:behavior.wither_target_highest_damage
- -Allows the wither to focus its attacks on whichever mob has dealt the most damage to it. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entity_types | -JSON Object | -- | List of entity types the wither takes into account to find who dealt the most damage to it
|
-
Attributes
- - - -minecraft:attack
- -Defines an entity's melee attack and any additional effects on it. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| damage | -Range [a, b] | -- | Range of the random amount of damage the melee attack deals. A negative value can heal the entity instead of hurting it | -
| effect_duration | -Decimal | -0.0 | -Duration in seconds of the status ailment applied to the damaged entity | -
| effect_name | -String | -- | Identifier of the status ailment to apply to an entity attacked by this entity's melee attack | -
minecraft:spell_effects
- -Defines what mob effects to add and remove to the entity when adding this component. - -| Name | Type | Default Value | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| add_effects | -List | -- | List of effects to add to this entity after adding this component
|
-||||||||
| remove_effects | -String | -- | List of identifiers of effects to be removed from this entity after adding this component | -
minecraft:strength
- -Defines the entity's strength to carry items. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max | -Integer | -5 | -The maximum strength of this entity | -
| value | -Integer | -1 | -The initial value of the strength | -
Built-in Events
- - - -| Name | Description |
|---|---|
| minecraft:entity_born | -Event called on an entity that is spawned through two entities breeding. | -
| minecraft:entity_spawned | -Event called on an entity that is placed in the level. | -
| minecraft:entity_transformed | -Event called on an entity that transforms into another entity. | -
| minecraft:on_prime | -Event called on an entity whose fuse is lit and is ready to explode. | -
Components
- - - -minecraft:addrider
- -Adds a rider to the entity. Requires minecraft:rideable. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| entity_type | -String | -- | The entity type that will be riding this entity. | -
| spawn_event | -String | -- | The spawn event that will be used when the riding entity is created. | -
minecraft:admire_item
- -Causes the mob to ignore attackable targets for a given duration. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown_after_being_attacked | -Integer | -0 | -Duration, in seconds, for which mob won't admire items if it was hurt | -
| duration | -Integer | -10 | -Duration, in seconds, that the mob is pacified. | -
minecraft:ageable
- -Adds a timer for the entity to grow up. It can be accelerated by giving the entity the items it likes as defined by feedItems. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| drop_items | -List | -- | List of items that the entity drops when it grows up. | -
| duration | -Decimal | -1200.0 | -Amount of time before the entity grows up, -1 for always a baby. | -
| feed_items | -List | -- | List of items that can be fed to the entity. Includes 'item' for the item name and 'growth' to define how much time it grows up by | -
| grow_up | -String | -- | Event to run when this entity grows up. | -
| transform_to_item | -Item Description Properties | -- | The feed item used will transform to this item upon successful interaction. Format: itemName:auxValue | -
minecraft:angry
- -Defines the entity's 'angry' state using a timer. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| angry_sound | -String | -- | The sound event to play when the mob is angry | -
| broadcast_anger | -Boolean | -false | -If true, other entities of the same entity definition within the broadcastRange will also become angry | -
| broadcast_anger_on_attack | -Boolean | -false | -If true, other entities of the same entity definition within the broadcastRange will also become angry whenever this mob attacks | -
| broadcast_anger_on_being_attacked | -Boolean | -false | -If true, other entities of the same entity definition within the broadcastRange will also become angry whenever this mob is attacked | -
| broadcast_filters | -Minecraft Filter | -- | Conditions that make this entry in the list valid | -
| broadcast_range | -Integer | -20 | -Distance in blocks within which other entities of the same entity definition will become angry | -
| broadcast_targets | -List | -- | A list of entity families to broadcast anger to | -
| calm_event | -String | -- | Event to run after the number of seconds specified in duration expires (when the entity stops being 'angry') | -
| duration | -Integer | -25 | -The amount of time in seconds that the entity will be angry | -
| duration_delta | -Integer | -0 | -Variance in seconds added to the duration [-delta, delta] | -
| filters | -Minecraft Filter | -- | Filter out mob types that it should not attack while angry (other Piglins) | -
| sound_interval | -Range [a, b] | -0 | -The range of time in seconds to randomly wait before playing the sound again | -
minecraft:annotation.break_door
- -Allows the actor to break doors assuming that that flags set up for the component to use in navigation - -| Name | Type | Default Value | Description |
|---|---|---|---|
| break_time | -Decimal | -12.0 | -The time in seconds required to break through doors. | -
| min_difficulty | -String | -hard | -The minimum difficulty that the world must be on for this entity to break doors. | -
minecraft:annotation.open_door
- -Allows the actor to open doors assuming that that flags set up for the component to use in navigationBack to topminecraft:area_attack
- -A component that does damage to entities that get within range. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| String | -- | - | cause | -
| Minecraft Filter | -- | - | entity_filter | -
| damage_per_tick | -Integer | -2 | -How much damage per tick is applied to entities that enter the damage range. | -
| damage_range | -Decimal | -0.2 | -How close a hostile entity must be to have the damage applied. | -
minecraft:attack_cooldown
- -Adds a cooldown to a mob. The intention of this cooldown is to be used to prevent the mob from attempting to aquire new attack targets. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| attack_cooldown_complete_event | -Trigger | -- | Event to be runned when the cooldown is complete. | -
| attack_cooldown_time | -Range [a, b] | -[0.0, 1.0] | -Amount of time in seconds for the cooldown. Can be specified as a number or a pair of numbers (min and max). | -
minecraft:barter
- -Enables the component to drop an item as a barter exchange. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| barter_table | -String | -- | Loot table that's used to drop a random item. | -
| cooldown_after_being_attacked | -Integer | -0 | -Duration, in seconds, for which mob won't barter items if it was hurt | -
minecraft:block_climber
- -Allows the player to detect and maneuver on the scaffolding block.Back to topminecraft:block_sensor
- -Fires off a specified event when a block in the block list is broken within the sensor range. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| Decimal | -- | - | sensor_radius | -
| List | -- | - | on_break | -
minecraft:boostable
- -Defines the conditions and behavior of a rideable entity's boost. - -| Name | Type | Default Value | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| boost_items | -List | -- | List of items that can be used to boost while riding this entity. Each item has the following properties:
|
-||||||||||||||||
| duration | -Decimal | -3.0 | -Time in seconds for the boost. | -||||||||||||||||
| speed_multiplier | -Decimal | -1.0 | -Factor by which the entity's normal speed increases. E.g. 2.0 means go twice as fast. | -
minecraft:boss
- -The current state of the boss for updating the boss HUD. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| hud_range | -Integer | -55 | -The max distance from the boss at which the boss's health bar is present on the players screen. | -
| name | -String | -- | The name that will be displayed above the boss's health bar. | -
| should_darken_sky | -Boolean | -false | -Whether the sky should darken in the presence of the boss. | -
minecraft:break_blocks
- -Specifies the blocks that this entity can break as it moves around. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| breakable_blocks | -List | -- | A list of the blocks that can be broken as this entity moves around | -
minecraft:breathable
- -Defines what blocks this entity can breathe in and gives them the ability to suffocate. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| breathe_blocks | -List | -- | List of blocks this entity can breathe in, in addition to the above. | -
| breathes_air | -Boolean | -true | -If true, this entity can breathe in air. | -
| breathes_lava | -Boolean | -true | -If true, this entity can breathe in lava. | -
| breathes_solids | -Boolean | -false | -If true, this entity can breathe in solid blocks. | -
| breathes_water | -Boolean | -false | -If true, this entity can breathe in water. | -
| generates_bubbles | -Boolean | -true | -If true, this entity will have visible bubbles while in water. | -
| inhale_time | -Decimal | -0 | -Time in seconds to recover breath to maximum. | -
| non_breathe_blocks | -List | -- | List of blocks this entity can't breathe in, in addition to the above. | -
| suffocate_time | -Integer | --20 | -Time in seconds between suffocation damage. | -
| total_supply | -Integer | -15 | -Time in seconds the entity can hold its breath. | -
minecraft:breedable
- -Defines the way an entity can get into the 'love' state. - -| Name | Type | Default Value | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| allow_sitting | -Boolean | -false | -If true, entities can breed while sitting | -||||||||||||||||
| blend_attributes | -Boolean | -true | -If true, the entities will blend their attributes in the offspring after they breed. For example, horses blend their health, movement, and jump_strength in their offspring. | -||||||||||||||||
| breed_cooldown | -Decimal | -60 | -Time in seconds before the Entity can breed again. | -||||||||||||||||
| breed_items | -List | -- | The list of items that can be used to get the entity into the 'love' state | -||||||||||||||||
| breeds_with | -List | -- | The list of entity definitions that this entity can breed with.
|
-||||||||||||||||
| causes_pregnancy | -Boolean | -false | -If true, the entity will become pregnant instead of spawning a baby. | -||||||||||||||||
| deny_parents_variant | -JSON Object | -- | Determines how likely the baby of parents with the same variant will deny that variant and take a random variant within the given range instead.
|
-||||||||||||||||
| environment_requirements | -List | -- | The list of nearby block requirements to get the entity into the 'love' state. blocks - -The block types required nearby for the entity to breed.Back to top- - count - -The number of the required block types nearby for the entity to breed.Back to top- - radius - -How many blocks radius from the mob's center to search in for the required blocks. Bounded between 0 and 16.Back to top- - |
-||||||||||||||||
| extra_baby_chance | -Decimal | -0 | -Chance that up to 16 babies will spawn between 0.0 and 1.0, where 1.0 is 100%. | -||||||||||||||||
| inherit_tamed | -Boolean | -true | -If true, the babies will be automatically tamed if its parents are | -||||||||||||||||
| love_filters | -Minecraft Filter | -- | The filters to run when attempting to fall in love. | -||||||||||||||||
| mutation_factor | -JSON Object | -- | Determines how likely the babies are to NOT inherit one of their parent's variances. Values are between 0.0 and 1.0, with a higher number meaning more likely to mutate.
|
-||||||||||||||||
| require_full_health | -Boolean | -false | -If true, the entity needs to be at full health before it can breed. | -||||||||||||||||
| require_tame | -Boolean | -true | -If true, the entities need to be tamed first before they can breed. | -||||||||||||||||
| transform_to_item | -String | -- | The breed item used will transform to this item upon successful interaction. Format: itemName:auxValue | -
minecraft:bribeable
- -Defines the way an entity can get into the 'bribed' state. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| bribe_cooldown | -Decimal | -2.0 | -Time in seconds before the Entity can be bribed again. | -
| bribe_items | -List | -- | The list of items that can be used to bribe the entity. | -
minecraft:buoyant
- -Enables an entity to float on the specified liquid blocks. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| apply_gravity | -Boolean | -true | -Applies gravity each tick. Causes more of a wave simulation, but will cause more gravity to be applied outside liquids. | -
| base_buoyancy | -Decimal | -1.0 | -Base buoyancy used to calculate how much will a mob float. | -
| big_wave_probability | -Decimal | -0.03 | -Probability for a big wave hitting the entity. Only used if `simulate_waves` is true. | -
| big_wave_speed | -Decimal | -10.0 | -Multiplier for the speed to make a big wave. Triggered depending on 'big_wave_probability'. | -
| drag_down_on_buoyancy_removed | -Decimal | -0.0 | -How much an actor will be dragged down when the Buoyancy Component is removed. | -
| liquid_blocks | -List | -- | List of blocks this entity can float on. Must be a liquid block. | -
| simulate_waves | -Boolean | -true | -Should the movement simulate waves going through. | -
minecraft:burns_in_daylight
- -Specifies if/how a mob burns in daylight.Back to topminecraft:celebrate_hunt
- -Specifies hunt celebration behaviour. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| broadcast | -Boolean | -true | -If true, celebration will be broadcasted to other entities in the radius. | -
| celeberation_targets | -Minecraft Filter | -- | The list of conditions that target of hunt must satisfy to initiate celebration. | -
| celebrate_sound | -String | -- | The sound event to play when the mob is celebrating | -
| duration | -Integer | -4 | -Duration, in seconds, of celebration | -
| radius | -Decimal | -16 | -If broadcast is enabled, specifies the radius in which it will notify other entities for celebration. | -
| sound_interval | -Range [a, b] | -0 | -The range of time in seconds to randomly wait before playing the sound again | -
minecraft:combat_regeneration
- -Gives Regeneration I and removes Mining Fatigue from the mob that kills the Actor's attack target. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| apply_to_family | -Boolean | -false | -Determines if the mob will grant mobs of the same type combat buffs if they kill the target. | -
| apply_to_self | -Boolean | -false | -Determines if the mob will grant itself the combat buffs if it kills the target. | -
| regeneration_duration | -Integer | -5 | -The duration in seconds of Regeneration I added to the mob. | -
minecraft:conditional_bandwidth_optimization
- -Defines the Conditional Spatial Update Bandwidth Optimizations of this entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| conditional_values | -List | -- | The object containing the conditional bandwidth optimization values. conditional_values - -Conditions that must be met for these optimization values to be used.Back to top- - max_dropped_ticks - -In relation to the optimization value, determines the maximum ticks spatial update packets can be not sent.Back to top- - max_optimized_distance - -The maximum distance considered during bandwidth optimizations. Any value below the max is interpolated to find optimization, and any value greater than or equal to this max results in max optimization.Back to top- - use_motion_prediction_hints - -When set to true, smaller motion packets will be sent during drop packet intervals, resulting in the same amount of packets being sent as without optimizations but with much less data being sent. This should be used when actors are travelling very quickly or teleporting to prevent visual oddities.Back to top- - |
-
| default_values | -JSON Object | -- | The object containing the default bandwidth optimization values. max_dropped_ticks - -In relation to the optimization value, determines the maximum ticks spatial update packets can be not sent.Back to top- - max_optimized_distance - -The maximum distance considered during bandwidth optimizations. Any value below the max is interpolated to find optimization, and any value greater than or equal to this max results in max optimization.Back to top- - use_motion_prediction_hints - -When set to true, smaller motion packets will be sent during drop packet intervals, resulting in the same amount of packets being sent as without optimizations but with much less data being sent. This should be used when actors are travelling very quickly or teleporting to prevent visual oddities.Back to top- - |
-
minecraft:custom_hit_test
- -List of hitboxes for melee and ranged hits against the entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| Array | -- | - | hitboxes | -
minecraft:damage_over_time
- -Applies defined amount of damage to the entity at specified intervals. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| damage_per_hurt | -Integer | -1 | -Amount of damage caused each hurt. | -
| time_between_hurt | -Decimal | -0.0 | -Time in seconds between damage. | -
minecraft:damage_sensor
- -Defines what events to call when this entity is damaged by specific entities or items. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggers | -List | -- | List of triggers with the events to call when taking specific kinds of damage.
|
-
minecraft:despawn
- -Despawns the Actor when the despawn rules or optional filters evaluate to true. - -| Name | Type | Default Value | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| JSON Object | -- | - | despawn_from_distance
|
-||||||||||||
| despawn_from_chance | -Boolean | -true | -Determines if "min_range_random_chance" is used in the standard despawn rules | -||||||||||||
| despawn_from_inactivity | -Boolean | -true | -Determines if the "min_range_inactivity_timer" is used in the standard despawn rules. | -||||||||||||
| despawn_from_simulation_edge | -Boolean | -true | -Determines if the mob is instantly despawned at the edge of simulation distance in the standard despawn rules. | -||||||||||||
| filters | -Minecraft Filter | -- | The list of conditions that must be satisfied before the Actor is despawned. If a filter is defined then standard despawn rules are ignored. | -||||||||||||
| min_range_inactivity_timer | -Integer | -30 | -The amount of time in seconds that the mob must be inactive. | -||||||||||||
| min_range_random_chance | -Integer | -800 | -A random chance between 1 and the given value. | -||||||||||||
| remove_child_entities | -Boolean | -false | -If true, all entities linked to this entity in a child relationship (eg. leashed) will also be despawned. | -
minecraft:drying_out_timer
- -Adds a timer for drying out that will count down and fire 'dried_out_event' or will stop as soon as the entity will get under rain or water and fire 'stopped_drying_out_event' - -| Name | Type | Default Value | Description |
|---|---|---|---|
| dried_out_event | -String | -- | Event to fire when the drying out time runs out. | -
| recover_after_dried_out_event | -String | -- | Event to fire when entity was already dried out but received increase in water supply. | -
| stopped_drying_out_event | -String | -- | Event to fire when entity stopped drying out, for example got into water or under rain. | -
| total_time | -Decimal | -0.0 | -Amount of time in seconds to dry out fully. | -
| water_bottle_refill_time | -Decimal | -0.0 | -Optional amount of additional time in seconds given by using splash water bottle on entity. | -
minecraft:economy_trade_table
- -Defines this entity's ability to trade with players. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| convert_trades_economy | -Boolean | -false | -Determines when the mob transforms, if the trades should be converted when the new mob has a economy_trade_table. When the trades are converted, the mob will generate a new trade list with their new trade table, but then it will try to convert any of the same trades over to have the same enchantments and user data. For example, if the original has a Emerald to Enchanted Iron Sword (Sharpness 1), and the new trade also has an Emerald for Enchanted Iron Sword, then the enchantment will be Sharpness 1. | -
| cured_discount | -Range [a, b] | -[-5, -20] | -How much should the discount be modified by when the player has cured the Zombie Villager. Can be specified as a pair of numbers (low-tier trade discount and high-tier trade discount) | -
| display_name | -String | -- | Name to be displayed while trading with this entity | -
| hero_demand_discount | -Integer | --4 | -Used in legacy prices to determine how much should Demand be modified by when the player has the Hero of the Village mob effect | -
| max_cured_discount | -Range [a, b] | -[-25, -63] | -The max the discount can be modified by when the player has cured the Zombie Villager. Can be specified as a pair of numbers (low-tier trade discount and high-tier trade discount) | -
| max_nearby_cured_discount | -Integer | --200 | -The max the discount can be modified by when the player has cured a nearby Zombie Villager | -
| nearby_cured_discount | -Integer | --25 | -How much should the discount be modified by when the player has cured a nearby Zombie Villager | -
| new_screen | -Boolean | -false | -Used to determine if trading with entity opens the new trade screen | -
| persist_trades | -Boolean | -false | -Determines if the trades should persist when the mob transforms. This makes it so that the next time the mob is transformed to something with a trade_table or economy_trade_table, then it keeps their trades. | -
| show_trade_screen | -Boolean | -true | -Show an in game trade screen when interacting with the mob. | -
| table | -String | -- | File path relative to the resource pack root for this entity's trades | -
| use_legacy_price_formula | -Boolean | -false | -Determines whether the legacy formula is used to determines the trade prices. | -
minecraft:entity_sensor
- -A component that fires an event when a set of conditions are met by other entities within the defined range. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| Minecraft Filter | -- | - | event_filters | -
| String | -- | - | event | -
| maximum_count | -Integer | --1 | -The maximum number of entities that must pass the filter conditions for the event to send. | -
| minimum_count | -Integer | -1 | -The minimum number of entities that must pass the filter conditions for the event to send. | -
| relative_range | -Boolean | -true | -If true the sensor range is additive on top of the entity's size. | -
| require_all | -Boolean | -false | -If true requires all nearby entities to pass the filter conditions for the event to send. | -
| sensor_range | -Decimal | -10 | -The maximum distance another entity can be from this and have the filters checked against it. | -
minecraft:environment_sensor
- -Creates a trigger based on environment conditions. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| triggers | -List | -- | The list of triggers that fire when the environment conditions match the given filter criteria. | -
minecraft:equip_item
- -The entity puts on the desired equipment.Back to topminecraft:equippable
- -Defines an entity's behavior for having items equipped to it. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| slots | -List | -- | List of slots and the item that can be equipped.
|
-
minecraft:experience_reward
- -. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| on_bred | -Molang | -0 | -A Molang expression defining the amount of experience rewarded when this entity is successfully bred. An array of expressions adds each expression's result together for a final total. | -
| on_death | -Molang | -0 | -A Molang expression defining the amount of experience rewarded when this entity dies. An array of expressions adds each expression's result together for a final total. | -
minecraft:explode
- -Defines how the entity explodes. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| breaks_blocks | -Boolean | -true | -If true, the explosion will destroy blocks in the explosion radius. | -
| causes_fire | -Boolean | -false | -If true, blocks in the explosion radius will be set on fire. | -
| destroy_affected_by_griefing | -Boolean | -false | -If true, whether the explosion breaks blocks is affected by the mob griefing game rule. | -
| fire_affected_by_griefing | -Boolean | -false | -If true, whether the explosion causes fire is affected by the mob griefing game rule. | -
| fuse_length | -Range [a, b] | -[0.0, 0.0] | -The range for the random amount of time the fuse will be lit before exploding, a negative value means the explosion will be immediate. | -
| fuse_lit | -Boolean | -false | -If true, the fuse is already lit when this component is added to the entity. | -
| max_resistance | -Decimal | -3.40282e+38 | -A blocks explosion resistance will be capped at this value when an explosion occurs. | -
| power | -Decimal | -3 | -The radius of the explosion in blocks and the amount of damage the explosion deals. | -
minecraft:flocking
- -Allows entities to flock in groups in water or not. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| block_distance | -Decimal | -0 | -The amount of blocks away the entity will look at to push away from. | -
| block_weight | -Decimal | -0 | -The weight of the push back away from blocks. | -
| breach_influence | -Decimal | -0 | -The amount of push back given to a flocker that breaches out of the water. | -
| cohesion_threshold | -Decimal | -1 | -The threshold in which to start applying cohesion. | -
| cohesion_weight | -Decimal | -1 | -The weight applied for the cohesion steering of the flock. | -
| goal_weight | -Decimal | -0 | -The weight on which to apply on the goal output. | -
| high_flock_limit | -Integer | -0 | -Determines the high bound amount of entities that can be allowed in the flock. | -
| in_water | -Boolean | -false | -Tells the Flocking Component if the entity exists in water. | -
| influence_radius | -Decimal | -0 | -The area around the entity that allows others to be added to the flock. | -
| innner_cohesion_threshold | -Decimal | -0 | -The distance in which the flocker will stop applying cohesion. | -
| loner_chance | -Decimal | -0 | -The percentage chance between 0-1 that a fish will spawn and not want to join flocks. Invalid values will be capped at the end points. | -
| low_flock_limit | -Integer | -0 | -Determines the low bound amount of entities that can be allowed in the flock. | -
| match_variants | -Boolean | -false | -Tells the flockers that they can only match similar entities that also match the variant, mark variants, and color data of the other potential flockers. | -
| max_height | -Decimal | -0 | -The max height allowable in the air or water. | -
| min_height | -Decimal | -0 | -The min height allowable in the air or water. | -
| separation_threshold | -Decimal | -2 | -The distance that is determined to be to close to another flocking and to start applying separation. | -
| separation_weight | -Decimal | -1 | -The weight applied to the separation of the flock. | -
| use_center_of_mass | -Boolean | -false | -Tells the flockers that they will follow flocks based on the center of mass. | -
minecraft:genetics
- -Defines the way a mob's genes and alleles are passed on to it's offspring, and how those traits manifest in the child. Compatible parent genes are crossed together, the alleles are handed down from the parents to the child, and any matching genetic variants fire off JSON events to modify the child and express the traits. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| genes | -List | -- | The list of genes that this entity has and will cross with a partner during breeding.
|
-||||||||||||||||||||||||||||||||||||||||||||||||||||
| mutation_rate | -Decimal | -0.03125 | -Chance that an allele will be replaced with a random one instead of the parent's allele during birth. | -
minecraft:giveable
- -Defines sets of items that can be used to trigger events when used on this entity. The item will also be taken and placed in the entity's inventory. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| cooldown | -Decimal | -0.0 | -An optional cool down in seconds to prevent spamming interactions. | -
| items | -List | -- | The list of items that can be given to the entity to place in their inventory. | -
| on_give | -String | -- | Event to fire when the correct item is given. | -
minecraft:group_size
- -Keeps track of entity group size in the given radius. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| filters | -Minecraft Filter | -- | The list of conditions that must be satisfied for other entities to be counted towards group size. | -
| radius | -Decimal | -16 | -Radius from center of entity. | -
minecraft:grows_crop
- -Could increase crop growth when entity walks over crop - -| Name | Type | Default Value | Description |
|---|---|---|---|
| chance | -Decimal | -0 | -Value between 0-1. Chance of success per tick. | -
| charges | -Integer | -10 | -Number of charges | -
minecraft:healable
- -Defines the interactions with this entity for healing it. - -| Name | Type | Default Value | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| filters | -Minecraft Filter | -- | The filter group that defines the conditions for using this item to heal the entity. | -||||||||||||
| force_use | -Boolean | -false | -Determines if item can be used regardless of entity being at full health. | -||||||||||||
| items | -Array | -- | The array of items that can be used to heal this entity.
|
-
minecraft:home
- -Saves a home pos for when the the entity is spawned. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| home_block_list | -List | -- | Optional block list that the home position will be associated with. If any of the blocks no longer exist at that position, the home restriction is removed. Example syntax: minecraft:sand. Not supported: minecraft:sand:1 | -
| restriction_radius | -Integer | --1 | -The radius that the entity will be restricted to in relation to its home | -
minecraft:hurt_on_condition
- -Defines a set of conditions under which an entity should take damage. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| Array | -- | - | damage_conditions Minecraft Filter - -filtersBack to top- - String - -cause --Back to top - - damage_per_tick - -The amount of damage done each tick that the conditions are met.Back to top- - |
-
minecraft:inside_block_notifier
- -Verifies whether the entity is inside any of the listed blocks. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| block_list | -List | -- | List of blocks, with certain block states, that we are monitoring to see if the entity is inside. | -
minecraft:insomnia
- -Adds a timer since last rested to see if phantoms should spawn. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| days_until_insomnia | -Decimal | -3.0 | -Number of days the mob has to stay up until the insomnia effect begins. | -
minecraft:instant_despawn
- -Despawns the Actor immediately. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| remove_child_entities | -Boolean | -false | -If true, all entities linked to this entity in a child relationship (eg. leashed) will also be despawned. | -
minecraft:interact
- -Defines interactions with this entity. - -| Name | Type | Default Value | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| add_items | -JSON Object | -- | Loot table with items to add to the player's inventory upon successful interaction.
|
-||||||||
| cooldown | -Decimal | -0 | -Time in seconds before this entity can be interacted with again. | -||||||||
| cooldown_after_being_attacked | -Decimal | -0 | -Time in seconds before this entity can be interacted with after being attacked. | -||||||||
| hurt_item | -Integer | -0 | -The amount of damage the item will take when used to interact with this entity. A value of 0 means the item won't lose durability. | -||||||||
| interact_text | -String | -- | Text to show when the player is able to interact in this way with this entity when playing with Touch-screen controls. | -||||||||
| on_interact | -String | -- | Event to fire when the interaction occurs. | -||||||||
| particle_on_start | -JSON Object | -- | Particle effect that will be triggered at the start of the interaction. particle_offset_towards_interactor - -Whether or not the particle will appear closer to who performed the interaction.Back to top- - particle_type - -The type of particle that will be spawned.Back to top- - particle_y_offset - -Will offset the particle this amount in the y direction.Back to top- - |
-||||||||
| play_sounds | -String | -- | List of sounds to play when the interaction occurs. | -||||||||
| spawn_entities | -String | -- | List of entities to spawn when the interaction occurs. | -||||||||
| spawn_items | -JSON Object | -- | Loot table with items to drop on the ground upon successful interaction.
|
-||||||||
| swing | -Boolean | -false | -If true, the player will do the 'swing' animation when interacting with this entity. | -||||||||
| transform_to_item | -String | -- | The item used will transform to this item upon successful interaction. Format: itemName:auxValue | -||||||||
| use_item | -Boolean | -false | -If true, the interaction will use an item. | -
minecraft:inventory
- -Defines this entity's inventory properties. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| additional_slots_per_strength | -Integer | -0 | -Number of slots that this entity can gain per extra strength | -
| can_be_siphoned_from | -Boolean | -false | -If true, the contents of this inventory can be removed by a hopper | -
| container_type | -String | -none | -Type of container this entity has. Can be horse, minecart_chest, minecart_hopper, inventory, container or hopper | -
| inventory_size | -Integer | -5 | -Number of slots the container has | -
| private | -Boolean | -false | -If true, the entity will not drop it's inventory on death | -
| restrict_to_owner | -Boolean | -false | -If true, the entity's inventory can only be accessed by its owner or itself | -
minecraft:item_hopper
- -Determines that this entity is an item hopper.Back to topminecraft:jump.dynamic
- -Defines a dynamic type jump control that will change jump properties based on the speed modifier of the mob.Back to topminecraft:jump.static
- -Gives the entity the ability to jump. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| jump_power | -Decimal | -0.42 | -The initial vertical velocity for the jump | -
minecraft:leashable
- -Allows this entity to be leashed and defines the conditions and events for this entity when is leashed. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| can_be_stolen | -Boolean | -false | -If true, players can leash this entity even if it is already leashed to another mob. | -
| hard_distance | -Decimal | -6 | -Distance in blocks at which the leash stiffens, restricting movement. | -
| max_distance | -Decimal | -10 | -Distance in blocks at which the leash breaks. | -
| on_leash | -String | -- | Event to call when this entity is leashed. | -
| on_unleash | -String | -- | Event to call when this entity is unleashed. | -
| soft_distance | -Decimal | -4 | -Distance in blocks at which the 'spring' effect starts acting to keep this entity close to the entity that leashed it. | -
minecraft:lookat
- -Defines the behavior when another entity looks at this entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| allow_invulnerable | -Boolean | -false | -If true, invulnerable entities (e.g. Players in creative mode) are considered valid targets. | -
| filters | -Minecraft Filter | -- | Defines the entities that can trigger this component. | -
| look_cooldown | -Range [a, b] | -[0, 0] | -The range for the random amount of time during which the entity is 'cooling down' and won't get angered or look for a target. | -
| look_event | -String | -- | The event identifier to run when the entities specified in filters look at this entity. | -
| search_radius | -Decimal | -10 | -Maximum distance this entity will look for another entity looking at it. | -
| set_target | -Boolean | -true | -If true, this entity will set the attack target as the entity that looked at it. | -
minecraft:managed_wandering_trader
- -This component is used to implement part of the Wandering Trader behaviorBack to topminecraft:mob_effect
- -A component that applies a mob effect to entities that get within range. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| Minecraft Filter | -- | - | entity_filter | -
| effect_range | -Decimal | -0.2 | -How close a hostile entity must be to have the mob effect applied. | -
| effect_time | -Integer | -10 | -How long the applied mob effect lasts in seconds. | -
| mob_effect | -String | -- | The mob effect that is applied to entities that enter this entities effect range. | -
minecraft:movement.amphibious
- -This move control allows the mob to swim in water and walk on land. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_turn | -Decimal | -30.0 | -The maximum number in degrees the mob can turn per tick. | -
minecraft:movement.basic
- -This component accents the movement of an entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_turn | -Decimal | -30.0 | -The maximum number in degrees the mob can turn per tick. | -
minecraft:movement.fly
- -This move control causes the mob to fly. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_turn | -Decimal | -30.0 | -The maximum number in degrees the mob can turn per tick. | -
minecraft:movement.generic
- -This move control allows a mob to fly, swim, climb, etc. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_turn | -Decimal | -30.0 | -The maximum number in degrees the mob can turn per tick. | -
minecraft:movement.hover
- -This move control causes the mob to hover. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_turn | -Decimal | -30.0 | -The maximum number in degrees the mob can turn per tick. | -
minecraft:movement.jump
- -Move control that causes the mob to jump as it moves with a specified delay between jumps. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| jump_delay | -Range [a, b] | -[0.0, 0.0] | -Delay after landing when using the slime move control. | -
| max_turn | -Decimal | -30.0 | -The maximum number in degrees the mob can turn per tick. | -
minecraft:movement.skip
- -This move control causes the mob to hop as it moves. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_turn | -Decimal | -30.0 | -The maximum number in degrees the mob can turn per tick. | -
minecraft:movement.sway
- -This move control causes the mob to sway side to side giving the impression it is swimming. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_turn | -Decimal | -30.0 | -The maximum number in degrees the mob can turn per tick. | -
minecraft:nameable
- -Allows this entity to be named (e.g. using a name tag). - -| Name | Type | Default Value | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| allow_name_tag_renaming | -Boolean | -true | -If true, this entity can be renamed with name tags | -||||||||||||
| always_show | -Boolean | -false | -If true, the name will always be shown | -||||||||||||
| default_trigger | -String | -- | Trigger to run when the entity gets named | -||||||||||||
| name_actions | -JSON Object | -- | Describes the special names for this entity and the events to call when the entity acquires those names
|
-
| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_damage_blocks | -Boolean | -false | -Tells the pathfinder to avoid blocks that cause damage when finding a path | -
| avoid_portals | -Boolean | -false | -Tells the pathfinder to avoid portals (like nether portals) when finding a path | -
| avoid_sun | -Boolean | -false | -Whether or not the pathfinder should avoid tiles that are exposed to the sun when creating paths | -
| avoid_water | -Boolean | -false | -Tells the pathfinder to avoid water when creating a path | -
| blocks_to_avoid | -List | -- | Tells the pathfinder which blocks to avoid when creating a path | -
| can_breach | -Boolean | -false | -Tells the pathfinder whether or not it can jump out of water (like a dolphin) | -
| can_break_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door and break it | -
| can_jump | -Boolean | -true | -Tells the pathfinder whether or not it can jump up blocks | -
| can_open_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door assuming the AI will open the door | -
| can_open_iron_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed iron door assuming the AI will open the door | -
| can_pass_doors | -Boolean | -true | -Whether a path can be created through a door | -
| can_path_from_air | -Boolean | -false | -Tells the pathfinder that it can start pathing when in the air | -
| can_path_over_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the lava | -
| can_path_over_water | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the water | -
| can_sink | -Boolean | -true | -Tells the pathfinder whether or not it will be pulled down by gravity while in water | -
| can_swim | -Boolean | -false | -Tells the pathfinder whether or not it can path anywhere through water and plays swimming animation along that path | -
| can_walk | -Boolean | -true | -Tells the pathfinder whether or not it can walk on the ground outside water | -
| can_walk_in_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel in lava like walking on ground | -
| is_amphibious | -Boolean | -false | -Tells the pathfinder whether or not it can walk on the ground underwater | -
| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_damage_blocks | -Boolean | -false | -Tells the pathfinder to avoid blocks that cause damage when finding a path | -
| avoid_portals | -Boolean | -false | -Tells the pathfinder to avoid portals (like nether portals) when finding a path | -
| avoid_sun | -Boolean | -false | -Whether or not the pathfinder should avoid tiles that are exposed to the sun when creating paths | -
| avoid_water | -Boolean | -false | -Tells the pathfinder to avoid water when creating a path | -
| blocks_to_avoid | -List | -- | Tells the pathfinder which blocks to avoid when creating a path | -
| can_breach | -Boolean | -false | -Tells the pathfinder whether or not it can jump out of water (like a dolphin) | -
| can_break_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door and break it | -
| can_jump | -Boolean | -true | -Tells the pathfinder whether or not it can jump up blocks | -
| can_open_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door assuming the AI will open the door | -
| can_open_iron_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed iron door assuming the AI will open the door | -
| can_pass_doors | -Boolean | -true | -Whether a path can be created through a door | -
| can_path_from_air | -Boolean | -false | -Tells the pathfinder that it can start pathing when in the air | -
| can_path_over_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the lava | -
| can_path_over_water | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the water | -
| can_sink | -Boolean | -true | -Tells the pathfinder whether or not it will be pulled down by gravity while in water | -
| can_swim | -Boolean | -false | -Tells the pathfinder whether or not it can path anywhere through water and plays swimming animation along that path | -
| can_walk | -Boolean | -true | -Tells the pathfinder whether or not it can walk on the ground outside water | -
| can_walk_in_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel in lava like walking on ground | -
| is_amphibious | -Boolean | -false | -Tells the pathfinder whether or not it can walk on the ground underwater | -
| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_damage_blocks | -Boolean | -false | -Tells the pathfinder to avoid blocks that cause damage when finding a path | -
| avoid_portals | -Boolean | -false | -Tells the pathfinder to avoid portals (like nether portals) when finding a path | -
| avoid_sun | -Boolean | -false | -Whether or not the pathfinder should avoid tiles that are exposed to the sun when creating paths | -
| avoid_water | -Boolean | -false | -Tells the pathfinder to avoid water when creating a path | -
| blocks_to_avoid | -List | -- | Tells the pathfinder which blocks to avoid when creating a path | -
| can_breach | -Boolean | -false | -Tells the pathfinder whether or not it can jump out of water (like a dolphin) | -
| can_break_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door and break it | -
| can_jump | -Boolean | -true | -Tells the pathfinder whether or not it can jump up blocks | -
| can_open_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door assuming the AI will open the door | -
| can_open_iron_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed iron door assuming the AI will open the door | -
| can_pass_doors | -Boolean | -true | -Whether a path can be created through a door | -
| can_path_from_air | -Boolean | -false | -Tells the pathfinder that it can start pathing when in the air | -
| can_path_over_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the lava | -
| can_path_over_water | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the water | -
| can_sink | -Boolean | -true | -Tells the pathfinder whether or not it will be pulled down by gravity while in water | -
| can_swim | -Boolean | -false | -Tells the pathfinder whether or not it can path anywhere through water and plays swimming animation along that path | -
| can_walk | -Boolean | -true | -Tells the pathfinder whether or not it can walk on the ground outside water | -
| can_walk_in_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel in lava like walking on ground | -
| is_amphibious | -Boolean | -false | -Tells the pathfinder whether or not it can walk on the ground underwater | -
| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_damage_blocks | -Boolean | -false | -Tells the pathfinder to avoid blocks that cause damage when finding a path | -
| avoid_portals | -Boolean | -false | -Tells the pathfinder to avoid portals (like nether portals) when finding a path | -
| avoid_sun | -Boolean | -false | -Whether or not the pathfinder should avoid tiles that are exposed to the sun when creating paths | -
| avoid_water | -Boolean | -false | -Tells the pathfinder to avoid water when creating a path | -
| blocks_to_avoid | -List | -- | Tells the pathfinder which blocks to avoid when creating a path | -
| can_breach | -Boolean | -false | -Tells the pathfinder whether or not it can jump out of water (like a dolphin) | -
| can_break_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door and break it | -
| can_jump | -Boolean | -true | -Tells the pathfinder whether or not it can jump up blocks | -
| can_open_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door assuming the AI will open the door | -
| can_open_iron_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed iron door assuming the AI will open the door | -
| can_pass_doors | -Boolean | -true | -Whether a path can be created through a door | -
| can_path_from_air | -Boolean | -false | -Tells the pathfinder that it can start pathing when in the air | -
| can_path_over_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the lava | -
| can_path_over_water | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the water | -
| can_sink | -Boolean | -true | -Tells the pathfinder whether or not it will be pulled down by gravity while in water | -
| can_swim | -Boolean | -false | -Tells the pathfinder whether or not it can path anywhere through water and plays swimming animation along that path | -
| can_walk | -Boolean | -true | -Tells the pathfinder whether or not it can walk on the ground outside water | -
| can_walk_in_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel in lava like walking on ground | -
| is_amphibious | -Boolean | -false | -Tells the pathfinder whether or not it can walk on the ground underwater | -
| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_damage_blocks | -Boolean | -false | -Tells the pathfinder to avoid blocks that cause damage when finding a path | -
| avoid_portals | -Boolean | -false | -Tells the pathfinder to avoid portals (like nether portals) when finding a path | -
| avoid_sun | -Boolean | -false | -Whether or not the pathfinder should avoid tiles that are exposed to the sun when creating paths | -
| avoid_water | -Boolean | -false | -Tells the pathfinder to avoid water when creating a path | -
| blocks_to_avoid | -List | -- | Tells the pathfinder which blocks to avoid when creating a path | -
| can_breach | -Boolean | -false | -Tells the pathfinder whether or not it can jump out of water (like a dolphin) | -
| can_break_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door and break it | -
| can_jump | -Boolean | -true | -Tells the pathfinder whether or not it can jump up blocks | -
| can_open_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door assuming the AI will open the door | -
| can_open_iron_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed iron door assuming the AI will open the door | -
| can_pass_doors | -Boolean | -true | -Whether a path can be created through a door | -
| can_path_from_air | -Boolean | -false | -Tells the pathfinder that it can start pathing when in the air | -
| can_path_over_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the lava | -
| can_path_over_water | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the water | -
| can_sink | -Boolean | -true | -Tells the pathfinder whether or not it will be pulled down by gravity while in water | -
| can_swim | -Boolean | -false | -Tells the pathfinder whether or not it can path anywhere through water and plays swimming animation along that path | -
| can_walk | -Boolean | -true | -Tells the pathfinder whether or not it can walk on the ground outside water | -
| can_walk_in_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel in lava like walking on ground | -
| is_amphibious | -Boolean | -false | -Tells the pathfinder whether or not it can walk on the ground underwater | -
| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_damage_blocks | -Boolean | -false | -Tells the pathfinder to avoid blocks that cause damage when finding a path | -
| avoid_portals | -Boolean | -false | -Tells the pathfinder to avoid portals (like nether portals) when finding a path | -
| avoid_sun | -Boolean | -false | -Whether or not the pathfinder should avoid tiles that are exposed to the sun when creating paths | -
| avoid_water | -Boolean | -false | -Tells the pathfinder to avoid water when creating a path | -
| blocks_to_avoid | -List | -- | Tells the pathfinder which blocks to avoid when creating a path | -
| can_breach | -Boolean | -false | -Tells the pathfinder whether or not it can jump out of water (like a dolphin) | -
| can_break_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door and break it | -
| can_jump | -Boolean | -true | -Tells the pathfinder whether or not it can jump up blocks | -
| can_open_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door assuming the AI will open the door | -
| can_open_iron_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed iron door assuming the AI will open the door | -
| can_pass_doors | -Boolean | -true | -Whether a path can be created through a door | -
| can_path_from_air | -Boolean | -false | -Tells the pathfinder that it can start pathing when in the air | -
| can_path_over_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the lava | -
| can_path_over_water | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the water | -
| can_sink | -Boolean | -true | -Tells the pathfinder whether or not it will be pulled down by gravity while in water | -
| can_swim | -Boolean | -false | -Tells the pathfinder whether or not it can path anywhere through water and plays swimming animation along that path | -
| can_walk | -Boolean | -true | -Tells the pathfinder whether or not it can walk on the ground outside water | -
| can_walk_in_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel in lava like walking on ground | -
| is_amphibious | -Boolean | -false | -Tells the pathfinder whether or not it can walk on the ground underwater | -
| Name | Type | Default Value | Description |
|---|---|---|---|
| avoid_damage_blocks | -Boolean | -false | -Tells the pathfinder to avoid blocks that cause damage when finding a path | -
| avoid_portals | -Boolean | -false | -Tells the pathfinder to avoid portals (like nether portals) when finding a path | -
| avoid_sun | -Boolean | -false | -Whether or not the pathfinder should avoid tiles that are exposed to the sun when creating paths | -
| avoid_water | -Boolean | -false | -Tells the pathfinder to avoid water when creating a path | -
| blocks_to_avoid | -List | -- | Tells the pathfinder which blocks to avoid when creating a path | -
| can_breach | -Boolean | -false | -Tells the pathfinder whether or not it can jump out of water (like a dolphin) | -
| can_break_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door and break it | -
| can_jump | -Boolean | -true | -Tells the pathfinder whether or not it can jump up blocks | -
| can_open_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed door assuming the AI will open the door | -
| can_open_iron_doors | -Boolean | -false | -Tells the pathfinder that it can path through a closed iron door assuming the AI will open the door | -
| can_pass_doors | -Boolean | -true | -Whether a path can be created through a door | -
| can_path_from_air | -Boolean | -false | -Tells the pathfinder that it can start pathing when in the air | -
| can_path_over_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the lava | -
| can_path_over_water | -Boolean | -false | -Tells the pathfinder whether or not it can travel on the surface of the water | -
| can_sink | -Boolean | -true | -Tells the pathfinder whether or not it will be pulled down by gravity while in water | -
| can_swim | -Boolean | -false | -Tells the pathfinder whether or not it can path anywhere through water and plays swimming animation along that path | -
| can_walk | -Boolean | -true | -Tells the pathfinder whether or not it can walk on the ground outside water | -
| can_walk_in_lava | -Boolean | -false | -Tells the pathfinder whether or not it can travel in lava like walking on ground | -
| is_amphibious | -Boolean | -false | -Tells the pathfinder whether or not it can walk on the ground underwater | -
minecraft:out_of_control
- -Defines the entity's 'out of control' state.Back to topminecraft:peek
- -Defines the entity's 'peek' behavior, defining the events that should be called during it. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| on_close | -String | -- | Event to call when the entity is done peeking. | -
| on_open | -String | -- | Event to call when the entity starts peeking. | -
| on_target_open | -String | -- | Event to call when the entity's target entity starts peeking. | -
minecraft:persistent
- -Defines whether an entity should be persistent in the game world.Back to topminecraft:physics
- -Defines physics properties of an actor, including if it is affected by gravity or if it collides with objects. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| has_collision | -Boolean | -true | -Whether or not the object collides with things. | -
| has_gravity | -Boolean | -true | -Whether or not the entity is affected by gravity. | -
minecraft:preferred_path
- -Specifies costing information for mobs that prefer to walk on preferred paths. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| default_block_cost | -Decimal | -0 | -Cost for non-preferred blocks | -
| jump_cost | -Integer | -0 | -Added cost for jumping up a node | -
| max_fall_blocks | -Integer | -3 | -Distance mob can fall without taking damage | -
| preferred_path_blocks | -List | -- | A list of blocks with their associated cost | -
minecraft:projectile
- -Allows the entity to be a thrown entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| angle_offset | -Decimal | -0 | -Determines the angle at which the projectile is thrown | -
| catch_fire | -Boolean | -false | -If true, the entity hit will be set on fire | -
| crit_particle_on_hurt | -Boolean | -false | -If true, the projectile will produce additional particles when a critical hit happens | -
| destroy_on_hurt | -Boolean | -false | -If true, this entity will be destroyed when hit | -
| filter | -String | -- | Entity Definitions defined here can't be hurt by the projectile | -
| fire_affected_by_griefing | -Boolean | -false | -If true, whether the projectile causes fire is affected by the mob griefing game rule | -
| gravity | -Decimal | -0.05 | -The gravity applied to this entity when thrown. The higher the value, the faster the entity falls | -
| hit_sound | -String | -- | The sound that plays when the projectile hits something | -
| homing | -Boolean | -false | -If true, the projectile homes in to the nearest entity | -
| inertia | -Decimal | -0.99 | -The fraction of the projectile's speed maintained every frame while traveling in air | -
| is_dangerous | -Boolean | -false | -If true, the projectile will be treated as dangerous to the players | -
| knockback | -Boolean | -true | -If true, the projectile will knock back the entity it hits | -
| lightning | -Boolean | -false | -If true, the entity hit will be struck by lightning | -
| liquid_inertia | -Decimal | -0.6 | -The fraction of the projectile's speed maintained every frame while traveling in water | -
| multiple_targets | -Boolean | -true | -If true, the projectile can hit multiple entities per flight | -
| offset | -Vector [a, b, c] | -[0, 0, 0] | -The offset from the entity's anchor where the projectile will spawn | -
| on_fire_time | -Decimal | -5 | -Time in seconds that the entity hit will be on fire for | -
| particle | -String | -iconcrack | -Particle to use upon collision | -
| potion_effect | -Integer | --1 | -Defines the effect the arrow will apply to the entity it hits | -
| power | -Decimal | -1.3 | -Determines the velocity of the projectile | -
| reflect_on_hurt | -Boolean | -false | -If true, this entity will be reflected back when hit | -
| semi_random_diff_damage | -Boolean | -false | -If true, damage will be randomized based on damage and speed | -
| shoot_sound | -String | -- | The sound that plays when the projectile is shot | -
| shoot_target | -Boolean | -true | -If true, the projectile will be shot towards the target of the entity firing it | -
| should_bounce | -Boolean | -false | -If true, the projectile will bounce upon hit | -
| splash_potion | -Boolean | -false | -If true, the projectile will be treated like a splash potion | -
| splash_range | -Decimal | -4 | -Radius in blocks of the 'splash' effect | -
| uncertainty_base | -Decimal | -0 | -The base accuracy. Accuracy is determined by the formula uncertaintyBase - difficultyLevel * uncertaintyMultiplier | -
| uncertainty_multiplier | -Decimal | -0 | -Determines how much difficulty affects accuracy. Accuracy is determined by the formula uncertaintyBase - difficultyLevel * uncertaintyMultiplier | -
minecraft:pushable
- -Defines what can push an entity between other entities and pistons. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| is_pushable | -Boolean | -true | -Whether the entity can be pushed by other entities. | -
| is_pushable_by_piston | -Boolean | -true | -Whether the entity can be pushed by pistons safely. | -
minecraft:raid_trigger
- -Attempts to trigger a raid at the entity's location. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| triggered_event | -String | -- | Event to run we attempt to trigger a raid on the village. | -
minecraft:rail_movement
- -Defines the entity's movement on the rails. An entity with this component is only allowed to move on the rail. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max_speed | -Decimal | -0.4 | -Maximum speed that this entity will move at when on the rail. | -
minecraft:rail_sensor
- - - -| Name | Type | Default Value | Description |
|---|---|---|---|
| check_block_types | -Boolean | -false | -If true, on tick this entity will trigger its on_deactivate behavior | -
| eject_on_activate | -Boolean | -true | -If true, this entity will eject all of its riders when it passes over an activated rail | -
| eject_on_deactivate | -Boolean | -false | -If true, this entity will eject all of its riders when it passes over a deactivated rail | -
| on_activate | -String | -- | Event to call when the rail is activated | -
| on_deactivate | -String | -- | Event to call when the rail is deactivated | -
| tick_command_block_on_activate | -Boolean | -true | -If true, command blocks will start ticking when passing over an activated rail | -
| tick_command_block_on_deactivate | -Boolean | -false | -If false, command blocks will stop ticking when passing over a deactivated rail | -
minecraft:ravager_blocked
- -Defines the ravager's response to their melee attack being blocked. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| knockback_strength | -Decimal | -3.0 | -The strength with which blocking entities should be knocked back | -
| reaction_choices | -List | -[ ] | -A list of weighted responses to the melee attack being blocked | -
minecraft:rideable
- -Determines whether this entity can be ridden. Allows specifying the different seat positions and quantity. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| controlling_seat | -Integer | -0 | -The seat that designates the driver of the entity | -||||||||||||||||||||||||
| crouching_skip_interact | -Boolean | -true | -If true, this entity can't be interacted with if the entity interacting with it is crouching | -||||||||||||||||||||||||
| family_types | -List | -- | List of entities that can ride this entity | -||||||||||||||||||||||||
| interact_text | -String | -- | The text to display when the player can interact with the entity when playing with Touch-screen controls | -||||||||||||||||||||||||
| priority | -Integer | -0 | -This field may exist in old data but isn't used by minecraft:rideable. | -||||||||||||||||||||||||
| pull_in_entities | -Boolean | -false | -If true, this entity will pull in entities that are in the correct family_types into any available seats | -||||||||||||||||||||||||
| rider_can_interact | -Boolean | -false | -If true, this entity will be picked when looked at by the rider | -||||||||||||||||||||||||
| seat_count | -Integer | -1 | -The number of entities that can ride this entity at the same time | -||||||||||||||||||||||||
| seats | -List | -- | The list of positions and number of riders for each position for entities riding this entity
|
-
minecraft:scale_by_age
- -Defines the entity's size interpolation based on the entity's age. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| end_scale | -Decimal | -1 | -Ending scale of the entity when it's fully grown. | -
| start_scale | -Decimal | -1 | -Initial scale of the newborn entity. | -
minecraft:scheduler
- -Fires off scheduled mob events at time of day events. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| scheduled_events | -List | -- | The list of triggers that fire when the conditions match the given filter criteria. If any filter criteria overlap the first defined event will be picked. | -
| Name | Type | Default Value | Description |
|---|---|---|---|
| all_items | -Boolean | -false | -A bucket for all other items in the game. Note this category is always least priority items. | -
| all_items_max_amount | -Integer | --1 | -Maximum number of this item the mob will hold. | -
| all_items_surplus_amount | -Integer | --1 | -Number of this item considered extra that the entity wants to share. | -
| all_items_want_amount | -Integer | --1 | -Number of this item this entity wants to share. | -
| items | -List | -- | List of items that the entity wants to share. admire - -Mob will admire the item after picking up by looking at it. For this to happen the mob needs to have an Admire component and an Admire goal.Back to top- - barter - -Mob will barter for the item after picking it up. For this to work the mob needs to have a Barter component and a Barter goal.Back to top- - consume_item - -Determines whether the mob will consume the item or not.Back to top- - craft_into - -Defines the item this entity wants to craft with the item defined above. Should be an item name.Back to top- - item - -The name of the item. Aux value can be specified, for instance 'minecraft:skull:1'.Back to top- - max_amount - -Maximum number of this item the mob will hold.Back to top- - pickup_limit - -Maximum number of this item the mob will pick up during a single goal tick.Back to top- - priority - -Prioritizes which items the entity prefers. 0 is the highest priority.Back to top- - stored_in_inventory - -Determines whether the mob will try to put the item in its inventory if it has the inventory component and if it can't be equipped.Back to top- - surplus_amount - -Number of this item considered extra that the entity wants to share.Back to top- - want_amount - -Number of this item this entity wants to have.Back to top- - |
-
minecraft:shooter
- -Defines the entity's ranged attack behavior. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| aux_val | -Integer | --1 | -ID of the Potion effect to be applied on hit | -
| def | -String | -- | Actor definition to use as projectile for the ranged attack. The actor definition must have the projectile component to be able to be shot as a projectile | -
minecraft:sittable
- -Defines the entity's 'sit' state. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| sit_event | -String | -- | Event to run when the entity enters the 'sit' state | -
| stand_event | -String | -- | Event to run when the entity exits the 'sit' state | -
minecraft:spawn_entity
- -Adds a timer after which this entity will spawn another entity or item (similar to vanilla's chicken's egg-laying behavior). - -| Name | Type | Default Value | Description |
|---|---|---|---|
| filters | -Minecraft Filter | -- | If present, the specified entity will only spawn if the filter evaluates to true. | -
| max_wait_time | -Integer | -600 | -Maximum amount of time to randomly wait in seconds before another entity is spawned. | -
| min_wait_time | -Integer | -300 | -Minimum amount of time to randomly wait in seconds before another entity is spawned. | -
| num_to_spawn | -Integer | -1 | -The number of entities of this type to spawn each time that this triggers. | -
| should_leash | -Boolean | -false | -If true, this the spawned entity will be leashed to the parent. | -
| single_use | -Boolean | -false | -If true, this component will only ever spawn the specified entity once. | -
| spawn_entity | -String | -- | Identifier of the entity to spawn, leave empty to spawn the item defined above instead. | -
| spawn_event | -String | -minecraft:entity_born | -Event to call when the entity is spawned. | -
| spawn_item | -String | -egg | -Item identifier of the item to spawn. | -
| spawn_method | -String | -born | -Method to use to spawn the entity. | -
| spawn_sound | -String | -plop | -Identifier of the sound effect to play when the entity is spawned. | -
minecraft:strength
- -Defines the entity's strength to carry items. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max | -Integer | -5 | -The maximum strength of this entity | -
| value | -Integer | -1 | -The initial value of the strength | -
minecraft:tameable
- -Defines the rules for a mob to be tamed by the player. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| probability | -Decimal | -1 | -The chance of taming the entity with each item use between 0.0 and 1.0, where 1.0 is 100% | -
| tame_event | -String | -- | Event to run when this entity becomes tamed | -
| tame_items | -List | -- | The list of items that can be used to tame this entity | -
minecraft:tamemount
- -Allows the Entity to be tamed by mounting it. - -| Name | Type | Default Value | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| attempt_temper_mod | -Integer | -5 | -The amount the entity's temper will increase when mounted. | -||||||||||||
| autoRejectItems | -JSON Object | -- | The list of items that, if carried while interacting with the entity, will anger it.
|
-||||||||||||
| feed_items | -JSON Object | -- | The list of items that can be used to increase the entity's temper and speed up the taming process.
|
-||||||||||||
| feed_text | -String | -- | The text that shows in the feeding interact button. | -||||||||||||
| max_temper | -Integer | -100 | -The maximum value for the entity's random starting temper. | -||||||||||||
| min_temper | -Integer | -0 | -The minimum value for the entity's random starting temper. | -||||||||||||
| ride_text | -String | -- | The text that shows in the riding interact button. | -||||||||||||
| tame_event | -String | -- | Event that triggers when the entity becomes tamed. | -
minecraft:target_nearby_sensor
- -Defines the entity's range within which it can see or sense other entities to target them. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| inside_range | -Decimal | -1 | -Maximum distance in blocks that another entity will be considered in the 'inside' range | -
| must_see | -Boolean | -false | -Whether the other entity needs to be visible to trigger 'inside' events | -
| on_inside_range | -String | -- | Event to call when an entity gets in the inside range. Can specify 'event' for the name of the event and 'target' for the target of the event | -
| on_outside_range | -String | -- | Event to call when an entity gets in the outside range. Can specify 'event' for the name of the event and 'target' for the target of the event | -
| on_vision_lost_inside_range | -String | -- | Event to call when an entity exits visual range. Can specify 'event' for the name of the event and 'target' for the target of the event | -
| outside_range | -Decimal | -5 | -Maximum distance in blocks that another entity will be considered in the 'outside' range | -
minecraft:teleport
- -Defines an entity's teleporting behavior. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| dark_teleport_chance | -Decimal | -0.01 | -Modifies the chance that the entity will teleport if the entity is in darkness | -
| light_teleport_chance | -Decimal | -0.01 | -Modifies the chance that the entity will teleport if the entity is in daylight | -
| max_random_teleport_time | -Decimal | -20 | -Maximum amount of time in seconds between random teleports | -
| min_random_teleport_time | -Decimal | -0 | -Minimum amount of time in seconds between random teleports | -
| random_teleport_cube | -Vector [a, b, c] | -[32, 16, 32] | -Entity will teleport to a random position within the area defined by this cube | -
| random_teleports | -Boolean | -true | -If true, the entity will teleport randomly | -
| target_distance | -Decimal | -16 | -Maximum distance the entity will teleport when chasing a target | -
| target_teleport_chance | -Decimal | -1 | -The chance that the entity will teleport between 0.0 and 1.0. 1.0 means 100% | -
minecraft:tick_world
- -Defines if the entity ticks the world and the radius around it to tick. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| distance_to_players | -Decimal | -128 | -The distance at which the closest player has to be before this entity despawns. This option will be ignored if never_despawn is true. Min: 128 blocks. | -
| never_despawn | -Boolean | -true | -If true, this entity will not despawn even if players are far away. If false, distance_to_players will be used to determine when to despawn. | -
| radius | -Positive Integer | -2 | -The area around the entity to tick. Default: 2. Allowed range: 2-6. | -
minecraft:timer
- -Adds a timer after which an event will fire. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| looping | -Boolean | -true | -If true, the timer will restart every time after it fires. | -
| randomInterval | -Boolean | -true | -If true, the amount of time on the timer will be random between the min and max values specified in time. | -
| random_time_choices | -List | -[ ] | -This is a list of objects, representing one value in seconds that can be picked before firing the event and an optional weight. Incompatible with time. | -
| time | -Range [a, b] | -[0.0, 0.0] | -Amount of time in seconds for the timer. Can be specified as a number or a pair of numbers (min and max). Incompatible with random_time_choices. | -
| time_down_event | -String | -- | Event to fire when the time on the timer runs out. | -
minecraft:trade_table
- -Defines this entity's ability to trade with players. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| convert_trades_economy | -Boolean | -false | -Determines when the mob transforms, if the trades should be converted when the new mob has a economy_trade_table. When the trades are converted, the mob will generate a new trade list with their new trade table, but then it will try to convert any of the same trades over to have the same enchantments and user data. For example, if the original has a Emerald to Enchanted Iron Sword (Sharpness 1), and the new trade also has an Emerald for Enchanted Iron Sword, then the enchantment will be Sharpness 1. | -
| display_name | -String | -- | Name to be displayed while trading with this entity. | -
| new_screen | -Boolean | -false | -Used to determine if trading with entity opens the new trade screen. | -
| persist_trades | -Boolean | -false | -Determines if the trades should persist when the mob transforms. This makes it so that the next time the mob is transformed to something with a trade_table or economy_trade_table, then it keeps their trades. | -
| table | -String | -- | File path relative to the behavior pack root for this entity's trades. | -
minecraft:trail
- -Causes an entity to leave a trail of blocks as it moves about the world. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| block_type | -String | -air | -The type of block you wish to be spawned by the entity as it move about the world. Solid blocks may not be spawned at an offset of (0,0,0). | -
| spawn_filter | -Minecraft Filter | -- | One or more conditions that must be met in order to cause the chosen block type to spawn. | -
| spawn_offset | -Vector [a, b, c] | -[0, 0, 0] | -The distance from the entities current position to spawn the block. Capped at up to 16 blocks away. The X value is left/right(-/+), the Z value is backward/forward(-/+), the Y value is below/above(-/+). | -
minecraft:transformation
- -Defines an entity's transformation from the current definition into another - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| add | -JSON Object | -- | List of components to add to the entity after the transformation
|
-||||||||||||||||||||||||||||
| begin_transform_sound | -String | -- | Sound to play when the transformation starts | -||||||||||||||||||||||||||||
| delay | -JSON Object | -- | Defines the properties of the delay for the transformation
|
-||||||||||||||||||||||||||||
| drop_equipment | -Boolean | -false | -Cause the entity to drop all equipment upon transformation | -||||||||||||||||||||||||||||
| drop_inventory | -Boolean | -false | -Cause the entity to drop all items in inventory upon transformation | -||||||||||||||||||||||||||||
| into | -String | -- | Entity Definition that this entity will transform into | -||||||||||||||||||||||||||||
| keep_level | -Boolean | -false | -If this entity has trades and has leveled up, it should maintain that level after transformation. | -||||||||||||||||||||||||||||
| keep_owner | -Boolean | -false | -If this entity is owned by another entity, it should remain owned after transformation. | -||||||||||||||||||||||||||||
| preserve_equipment | -Boolean | -false | -Cause the entity to keep equipment after going through transformation | -||||||||||||||||||||||||||||
| transformation_sound | -String | -- | Sound to play when the entity is done transforming | -
minecraft:trusting
- -Defines the rules for a mob to trust players. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| probability | -Decimal | -1.00 | -The chance of the entity trusting with each item use between 0.0 and 1.0, where 1.0 is 100%. | -
| trust_event | -String | -- | Event to run when this entity becomes trusting. | -
| trust_items | -List | -- | The list of items that can be used to get the entity to trust players. | -
minecraft:water_movement
- - - -| Name | Type | Default Value | Description |
|---|---|---|---|
| drag_factor | -Decimal | -0.8 | -Drag factor to determine movement speed when in water. | -
Entity Definition Properties
- -These properties are part of the Entity Definition as a whole and go before the Component or Component Groups. Make sure to place them before any Components, Component Groups or Events sections or they will be ignored. - -format_version
- -Specifies the version of the game this entity was made in. If the version is lower than the current version, any changes made to the entity in the vanilla version will be applied to it.Back to topEntity Description Properties
- -This section defines properties required to identify and construct the entity - -Entity Description Properties
- - - -identifier
- -Sets the name for this entity's description. - -| Type | Default Value | Description |
|---|---|---|
| String | -- | The identifier for this entity | -
is_spawnable
- -Sets whether or not this entity has a spawn egg in the creative ui. - -| Type | Default Value | Description |
|---|---|---|
| Boolean | -false | -Set to determine if this entity has a spawn egg. | -
is_summonable
- -Sets whether or not we can summon this entity using commands such as /summon. - -| Type | Default Value | Description |
|---|---|---|
| Boolean | -false | -Flag to mark this entity as being summonable or not. | -
runtime_identifier
- -Sets the name for the Vanilla Minecraft identifier this entity will use to build itself from. - -| Type | Default Value | Description |
|---|---|---|
| String | -- | The identifier for the class to construct this entity with | -
animations
- -Sets the mapping of internal animation references to actual animations. This is a JSON Object of name/animation pairs - -| Name | Type | Default Value | Description |
|---|---|---|---|
| animation | -String | -none | -Actual animation to use | -
| name | -String | -none | -Internal (to the entity) name of this animation entry | -
scripts
- -Sets the mapping of internal animation controller references to actual animation controller. This is a JSON Array of name/animation-controller pairs - -| Name | Type | Default Value | Description |
|---|---|---|---|
| animation controller | -String | -none | -Actual animation to use | -
| name | -String | -none | -Internal (to the entity) name of this animation entry | -
ID Lists
- - - -AI Goals
- - - -| JSON Name | ID |
|---|---|
| minecraft.behavior.hide | -233394190 | -
| minecraft.behavior.move_to_poi | -1721669938 | -
| minecraft.behavior.scared | -1812936510 | -
| minecraft.behavior.work | --1700601421 | -
| minecraft:behavior.admire_item | -1024844406 | -
| minecraft:behavior.barter | -536670686 | -
| minecraft:behavior.beg | -1346418048 | -
| minecraft:behavior.break_door | --1798237626 | -
| minecraft:behavior.breed | -51166360 | -
| minecraft:behavior.celebrate | -995178519 | -
| minecraft:behavior.defend_trusted_target | -2070046390 | -
| minecraft:behavior.door_interact | --286762735 | -
| minecraft:behavior.dragondeath | --1541162059 | -
| minecraft:behavior.dragonholdingpattern | -1066617362 | -
| minecraft:behavior.dragonlanding | --152352492 | -
| minecraft:behavior.dragonscanning | --1003941066 | -
| minecraft:behavior.dragontakeoff | --1912535317 | -
| minecraft:behavior.drink_potion | -277029334 | -
| minecraft:behavior.eat_carried_item | --184757575 | -
| minecraft:behavior.enderman_leave_block | --717580550 | -
| minecraft:behavior.enderman_take_block | --537294220 | -
| minecraft:behavior.explore_outskirts | --1955198366 | -
| minecraft:behavior.find_cover | --1231227755 | -
| minecraft:behavior.find_mount | -731306871 | -
| minecraft:behavior.find_underwater_treasure | --1602192311 | -
| minecraft:behavior.flee_sun | --617664229 | -
| minecraft:behavior.float | -1758503000 | -
| minecraft:behavior.float_wander | --1122048364 | -
| minecraft:behavior.follow_caravan | -9936402 | -
| minecraft:behavior.follow_mob | --1524701626 | -
| minecraft:behavior.follow_owner | -1213259599 | -
| minecraft:behavior.follow_parent | -2127040136 | -
| minecraft:behavior.follow_target_captain | --135480526 | -
| minecraft:behavior.go_home | --1579225026 | -
| minecraft:behavior.hold_ground | -1804286487 | -
| minecraft:behavior.hurt_by_target | --1710404297 | -
| minecraft:behavior.inspect_bookshelf | -40191182 | -
| minecraft:behavior.knockback_roar | --1304117826 | -
| minecraft:behavior.lay_down | --2074934675 | -
| minecraft:behavior.lay_egg | --1207740530 | -
| minecraft:behavior.leap_at_target | -256926956 | -
| minecraft:behavior.look_at_entity | --1735428573 | -
| minecraft:behavior.look_at_player | --1892159379 | -
| minecraft:behavior.look_at_target | --885375871 | -
| minecraft:behavior.look_at_trading_player | --2094605693 | -
| minecraft:behavior.make_love | --1551283431 | -
| minecraft:behavior.mingle | -385775952 | -
| minecraft:behavior.mount_pathing | -1112137677 | -
| minecraft:behavior.move_indoors | -2107078532 | -
| minecraft:behavior.move_through_village | -779377630 | -
| minecraft:behavior.move_to_land | --943551837 | -
| minecraft:behavior.move_to_lava | --945036492 | -
| minecraft:behavior.move_to_random_block | -395022171 | -
| minecraft:behavior.move_to_village | --805189394 | -
| minecraft:behavior.move_to_water | -1886139445 | -
| minecraft:behavior.move_towards_target | --166537884 | -
| minecraft:behavior.nap | -992184933 | -
| minecraft:behavior.nearest_attackable_target | -5824270165841165755 | -
| minecraft:behavior.nearest_prioritized_attackable_target | -335414683 | -
| minecraft:behavior.ocelot_sit_on_block | --1327999383 | -
| minecraft:behavior.offer_flower | --885387854 | -
| minecraft:behavior.open_door | --906200433 | -
| minecraft:behavior.owner_hurt_by_target | -530667419 | -
| minecraft:behavior.owner_hurt_target | -995655261 | -
| minecraft:behavior.panic | --169886247 | -
| minecraft:behavior.peek | -211304085 | -
| minecraft:behavior.pet_sleep_with_owner | -1379392240 | -
| minecraft:behavior.pickup_items | -644287189 | -
| minecraft:behavior.play | --505601580 | -
| minecraft:behavior.player_ride_tamed | -603869698 | -
| minecraft:behavior.raid_garden | --1145687602 | -
| minecraft:behavior.random_breach | -928528911 | -
| minecraft:behavior.random_fly | --446385505 | -
| minecraft:behavior.random_hover | --1797323808 | -
| minecraft:behavior.random_look_around | -1177762851 | -
| minecraft:behavior.random_look_around_and_sit | --1368070166 | -
| minecraft:behavior.random_sitting | -1722716662 | -
| minecraft:behavior.random_stroll | --1643504294 | -
| minecraft:behavior.random_swim | --1465281278 | -
| minecraft:behavior.receive_love | -1156694272 | -
| minecraft:behavior.restrict_open_door | -715583988 | -
| minecraft:behavior.restrict_sun | --382716017 | -
| minecraft:behavior.rise_to_liquid_level | --950950337 | -
| minecraft:behavior.roll | -817471653 | -
| minecraft:behavior.run_around_like_crazy | --1390363669 | -
| minecraft:behavior.send_event | --823429137 | -
| minecraft:behavior.share_items | -2045906118 | -
| minecraft:behavior.silverfish_merge_with_stone | -321908121 | -
| minecraft:behavior.silverfish_wake_up_friends | -484391748 | -
| minecraft:behavior.skeleton_horse_trap | -530952387 | -
| minecraft:behavior.sleep | --1811763 | -
| minecraft:behavior.slime_attack | --1315951081 | -
| minecraft:behavior.snacking | -875141064 | -
| minecraft:behavior.sneeze | -1528584076 | -
| minecraft:behavior.squid_dive | -1626998843 | -
| minecraft:behavior.squid_flee | -1304043261 | -
| minecraft:behavior.squid_idle | -1741234679 | -
| minecraft:behavior.squid_move_away_from_ground | -892387674 | -
| minecraft:behavior.squid_out_of_water | --1347598607 | -
| minecraft:behavior.stalk_and_pounce_on_target | --1248479202 | -
| minecraft:behavior.stay_while_sitting | -1346980478 | -
| minecraft:behavior.stomp_turtle_egg | -851839416 | -
| minecraft:behavior.stroll_towards_village | --1563831906 | -
| minecraft:behavior.summon_entity | --2005850647 | -
| minecraft:behavior.swell | --1473132493 | -
| minecraft:behavior.take_flower | -1218648257 | -
| minecraft:behavior.tempt | -422904556 | -
| minecraft:behavior.trade_interest | --574851053 | -
| minecraft:behavior.trade_with_player | --2048563493 | -
| minecraft:behavior.vex_copy_owner_target | --643459543 | -
| minecraft:behavior.vex_random_move | --1117822165 | -
| minecraft:behavior.wither_random_attack_pos_goal | --528895885 | -
| minecraft:behavior.wither_target_highest_damage | --1065562072 | -
Attributes
- - - -| JSON Name | ID |
|---|---|
| minecraft:attack | -1651346034 | -
| minecraft:spell_effects | -523264365 | -
| minecraft:strength | -648564399 | -
Components
- - - -| JSON Name | ID |
|---|---|
| - | -2078137563 | -
| minecraft:addrider | --1014528905 | -
| minecraft:admire_item | --1838165406 | -
| minecraft:ageable | -1092934985 | -
| minecraft:angry | -725411499 | -
| minecraft:annotation.break_door | -2116838963 | -
| minecraft:annotation.open_door | -1004733768 | -
| minecraft:area_attack | -1169114880 | -
| minecraft:attack_cooldown | --1439360398 | -
| minecraft:barter | --1660828566 | -
| minecraft:block_climber | --505801518 | -
| minecraft:block_sensor | -1944169706 | -
| minecraft:boostable | --8316315 | -
| minecraft:boss | --1309638025 | -
| minecraft:break_blocks | --944056304 | -
| minecraft:breathable | --707187232 | -
| minecraft:breedable | --1616430100 | -
| minecraft:bribeable | --2125526908 | -
| minecraft:buoyant | --467213736 | -
| minecraft:burns_in_daylight | -1256874605 | -
| minecraft:celebrate_hunt | --789611239 | -
| minecraft:combat_regeneration | --315365016 | -
| minecraft:conditional_bandwidth_optimization | -1333085468 | -
| minecraft:custom_hit_test | -2035968892 | -
| minecraft:damage_over_time | --656420526 | -
| minecraft:damage_sensor | --82616534 | -
| minecraft:despawn | -1674909940 | -
| minecraft:drying_out_timer | -2113510784 | -
| minecraft:economy_trade_table | -1705466896 | -
| minecraft:entity_sensor | --406052184 | -
| minecraft:environment_sensor | -687748970 | -
| minecraft:equip_item | --1774220620 | -
| minecraft:equippable | --1164142226 | -
| minecraft:experience_reward | --1992597900 | -
| minecraft:explode | --1683058581 | -
| minecraft:flocking | -1967597361 | -
| minecraft:genetics | --82484670 | -
| minecraft:giveable | -1739199795 | -
| minecraft:group_size | --1997375941 | -
| minecraft:grows_crop | -43636353 | -
| minecraft:healable | --54247424 | -
| minecraft:home | -610829097 | -
| minecraft:hurt_on_condition | -163715083 | -
| minecraft:inside_block_notifier | --377593253 | -
| minecraft:insomnia | --300455606 | -
| minecraft:instant_despawn | --634288138 | -
| minecraft:interact | --1996861528 | -
| minecraft:inventory | -1941951218 | -
| minecraft:item_hopper | --447601772 | -
| minecraft:jump.dynamic | -945664737 | -
| minecraft:jump.static | -1064987526 | -
| minecraft:leashable | -893445039 | -
| minecraft:lookat | --1329707008 | -
| minecraft:managed_wandering_trader | -846609640 | -
| minecraft:mob_effect | -490430596 | -
| minecraft:movement.amphibious | --500784850 | -
| minecraft:movement.basic | -3354475 | -
| minecraft:movement.fly | --1487316136 | -
| minecraft:movement.generic | --1363369868 | -
| minecraft:movement.hover | -1743805051 | -
| minecraft:movement.jump | -1256268727 | -
| minecraft:movement.skip | --1828832272 | -
| minecraft:movement.sway | -2126249079 | -
| minecraft:nameable | --595398763 | -
| minecraft:navigation.climb | --1075360945 | -
| minecraft:navigation.float | --842998036 | -
| minecraft:navigation.fly | --1997823129 | -
| minecraft:navigation.generic | -1768002583 | -
| minecraft:navigation.hover | --769247640 | -
| minecraft:navigation.swim | -1908076634 | -
| minecraft:navigation.walk | -1909033775 | -
| minecraft:npc | -1140005505 | -
| minecraft:out_of_control | --639930856 | -
| minecraft:peek | --863721039 | -
| minecraft:persistent | -1435858387 | -
| minecraft:physics | -1021552959 | -
| minecraft:preferred_path | -1431188951 | -
| minecraft:projectile | -1922456869 | -
| minecraft:pushable | --1784639134 | -
| minecraft:raid_trigger | -2093209329 | -
| minecraft:rail_movement | --78235634 | -
| minecraft:rail_sensor | -1273161273 | -
| minecraft:ravager_blocked | --1417579541 | -
| minecraft:rideable | -1656173828 | -
| minecraft:scale_by_age | -64881972 | -
| minecraft:scheduler | --684492525 | -
| minecraft:shareables | -1301057082 | -
| minecraft:shooter | -184150118 | -
| minecraft:sittable | --1376274106 | -
| minecraft:spawn_entity | -1991964333 | -
| minecraft:tameable | -932870003 | -
| minecraft:tamemount | -1615660288 | -
| minecraft:target_nearby_sensor | -1309819882 | -
| minecraft:teleport | --1900891127 | -
| minecraft:tick_world | --381759296 | -
| minecraft:timer | -1862095863 | -
| minecraft:trade_table | -50480315 | -
| minecraft:trail | -1632590434 | -
| minecraft:transformation | --457894577 | -
| minecraft:trusting | -936499892 | -
| minecraft:water_movement | --128701925 | -
Entity Description Properties
- - - -| JSON Name | ID |
|---|---|
| animations | -1232311658 | -
| scripts | --76244517 | -
Properties
- - - -| JSON Name | ID |
|---|---|
| minecraft:ambient_sound_interval | --1314051310 | -
| minecraft:can_climb | --550459594 | -
| minecraft:can_fly | -985724318 | -
| minecraft:can_power_jump | --763124853 | -
| minecraft:collision_box | --1277663508 | -
| minecraft:color | -1069623177 | -
| minecraft:color2 | -1429635777 | -
| minecraft:default_look_angle | --815556357 | -
| minecraft:equipment | -714661022 | -
| minecraft:fire_immune | --1071767182 | -
| minecraft:floats_in_liquid | -179778474 | -
| minecraft:flying_speed | --570508595 | -
| minecraft:friction_modifier | --714364556 | -
| minecraft:ground_offset | --1816881803 | -
| minecraft:input_ground_controlled | --646415617 | -
| minecraft:is_baby | -1853172763 | -
| minecraft:is_charged | -125340337 | -
| minecraft:is_chested | --817599379 | -
| minecraft:is_dyeable | -1381448355 | -
| minecraft:is_hidden_when_invisible | --1553744 | -
| minecraft:is_ignited | -905710223 | -
| minecraft:is_illager_captain | -921912694 | -
| minecraft:is_saddled | -1037901616 | -
| minecraft:is_shaking | -523951884 | -
| minecraft:is_sheared | -1154836813 | -
| minecraft:is_stackable | -1184456737 | -
| minecraft:is_stunned | -1818977510 | -
| minecraft:is_tamed | -1646421078 | -
| minecraft:item_controllable | -1868311069 | -
| minecraft:loot | -1775814032 | -
| minecraft:mark_variant | -663621689 | -
| minecraft:push_through | --138030768 | -
| minecraft:scale | -77854436 | -
| minecraft:skin_id | -1838729593 | -
| minecraft:sound_volume | -937951776 | -
| minecraft:type_family | --255011285 | -
| minecraft:variant | --1789583977 | -
| minecraft:walk_animation_speed | -972393614 | -
| minecraft:wants_jockey | -1832515141 | -
Triggers
- - - -| JSON Name | ID |
|---|---|
| minecraft:on_death | --49357854 | -
| minecraft:on_friendly_anger | --1009986313 | -
| minecraft:on_hurt | --1028603471 | -
| minecraft:on_hurt_by_player | --599009831 | -
| minecraft:on_ignite | --1911489054 | -
| minecraft:on_start_landing | --555648368 | -
| minecraft:on_start_takeoff | -426083399 | -
| minecraft:on_target_acquired | -1063277906 | -
| minecraft:on_target_escape | --1373130027 | -
| minecraft:on_wake_with_owner | --1543219003 | -
Properties
- - - -minecraft:ambient_sound_interval
- -Sets the entity's delay between playing its ambient sound. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event_name | -String | -ambient | -Level sound event to be played as the ambient sound. | -
| range | -Decimal | -16.000000 | -Maximum time in seconds to randomly add to the ambient sound delay time. | -
| value | -Decimal | -8.000000 | -Minimum time in seconds before the entity plays its ambient sound again. | -
minecraft:can_climb
- -Allows this entity to climb up ladders.Back to topminecraft:can_fly
- -Marks the entity as being able to fly, the pathfinder won't be restricted to paths where a solid block is required underneath it.Back to topminecraft:can_power_jump
- -Allows the entity to power jump like the horse does in vanilla.Back to topminecraft:collision_box
- -Sets the width and height of the Entity's collision box. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| height | -Decimal | -1.0 | -Height of the collision box in blocks. A negative value will be assumed to be 0. | -
| width | -Decimal | -1.0 | -Width and Depth of the collision box in blocks. A negative value will be assumed to be 0. | -
minecraft:color
- -Defines the entity's color. Only works on vanilla entities that have predefined color values (sheep, llama, shulker). - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Integer | -0 | -The Palette Color value of the entity. | -
minecraft:color2
- -Defines the entity's second texture color. Only works on vanilla entities that have a second predefined color values (tropical fish). - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Integer | -0 | -The second Palette Color value of the entity. | -
minecraft:default_look_angle
- -Sets this entity's default head rotation angle. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Decimal | -0.0f | -Angle in degrees. | -
minecraft:equipment
- -Sets the Equipment table to use for this Entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| slot_drop_chance | -List | -- | A list of slots with the chance to drop an equipped item from that slot. | -
| table | -String | -- | The file path to the equipment table, relative to the behavior pack's root. | -
minecraft:fire_immune
- -Sets that this entity doesn't take damage from fire.Back to topminecraft:floats_in_liquid
- -Sets that this entity can float in liquid blocks.Back to topminecraft:flying_speed
- -Speed in Blocks that this entity flies at. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Decimal | -0.02 | -Flying speed in blocks per tick. | -
minecraft:friction_modifier
- -Defines how much friction affects this entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Decimal | -1.0 | -The higher the number, the more the friction affects this entity. A value of 1.0 means regular friction, while 2.0 means twice as much. | -
minecraft:ground_offset
- -Sets the offset from the ground that the entity is actually at. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Decimal | -0.0 | -The value of the entity's offset from the terrain, in blocks. | -
minecraft:input_ground_controlled
- -When configured as a rideable entity, the entity will be controlled using WASD controls.Back to topminecraft:is_baby
- -Sets that this entity is a baby.Back to topminecraft:is_charged
- -Sets that this entity is charged.Back to topminecraft:is_chested
- -Sets that this entity is currently carrying a chest.Back to topminecraft:is_dyeable
- -Allows dyes to be used on this entity to change its color. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| interact_text | -String | -- | The text that will display when interacting with this entity with a dye when playing with Touch-screen controls. | -
minecraft:is_ignited
- -Sets that this entity is currently on fire.Back to topminecraft:is_illager_captain
- -Sets that this entity is an illager captain.Back to topminecraft:is_saddled
- -Sets that this entity is currently saddled.Back to topminecraft:is_shaking
- -Sets that this entity is currently shaking.Back to topminecraft:is_sheared
- -Sets that this entity is currently sheared.Back to topminecraft:is_stackable
- -Sets that this entity can be stacked.Back to topminecraft:is_stunned
- -Sets that this entity is currently stunned.Back to topminecraft:is_tamed
- -Sets that this entity is currently tamed.Back to topminecraft:item_controllable
- -Defines what items can be used to control this entity while ridden. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| control_items | -List | -- | List of items that can be used to control this entity. | -
minecraft:loot
- -Sets the loot table for what items this entity drops upon death. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| table | -String | -- | The path to the loot table, relative to the Behavior Pack's root. | -
minecraft:mark_variant
- -Additional variant value. Can be used to further differentiate variants. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Integer | -0 | -The ID of the variant. By convention, 0 is the ID of the base entity. | -
minecraft:push_through
- -Sets the distance through which the entity can push through. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Decimal | -0.0 | -The value of the entity's push-through, in blocks. | -
minecraft:scale
- -Sets the entity's visual size. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Decimal | -1.0 | -The value of the scale. 1.0 means the entity will appear at the scale they are defined in their model. Higher numbers make the entity bigger. | -
minecraft:skin_id
- -Skin ID value. Can be used to differentiate skins, such as base skins for villagers. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Integer | -0 | -The ID of the skin. By convention, 0 is the ID of the base skin. | -
minecraft:sound_volume
- -Sets the entity's base volume for sound effects. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Decimal | -1.0 | -The value of the volume the entity uses for sound effects. | -
minecraft:type_family
- -Defines the families this entity belongs to. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| family | -List | -- | List of family names. | -
minecraft:variant
- -Used to differentiate the component group of a variant of an entity from others. (e.g. ocelot, villager) - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Integer | -0 | -The ID of the variant. By convention, 0 is the ID of the base entity. | -
minecraft:walk_animation_speed
- -Sets the speed multiplier for this entity's walk animation speed. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| value | -Decimal | -1.0 | -The higher the number, the faster the animation for walking plays. A value of 1.0 means normal speed, while 2.0 means twice as fast. | -
minecraft:wants_jockey
- -Sets that this entity wants to become a jockey.Back to topTriggers
- - - -minecraft:on_death
- -Only usable by the Ender Dragon. Adds a trigger to call on this entity's death. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_friendly_anger
- -Adds a trigger that will run when a nearby entity of the same type as this entity becomes Angry. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_hurt
- -Adds a trigger to call when this entity takes damage. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_hurt_by_player
- -Adds a trigger to call when this entity is attacked by the player. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_ignite
- -Adds a trigger to call when this entity is set on fire. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_start_landing
- -Only usable by the Ender Dragon. Adds a trigger to call when this entity lands. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_start_takeoff
- -Only usable by the Ender Dragon. Adds a trigger to call when this entity starts flying. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_target_acquired
- -Adds a trigger to call when this entity finds a target. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_target_escape
- -Adds a trigger to call when this entity loses the target it currently has. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
minecraft:on_wake_with_owner
- -Adds a trigger to call when this pet's owner awakes after sleeping with the pet. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| event | -String | -- | The event to run when the conditions for this trigger are met. | -
| filters | -Minecraft Filter | -- | The list of conditions for this trigger to execute. | -
| target | -String | -self | -The target of the event. | -
Index
-| Animation Controller Events |
|---|
| Animation Events |
| Animation Notes |
| Events |
| General Notes |
Animation Controller Events
- -Animation controllers can trigger events on entry or exit of a state. Events to trigger on state entry go in the "on_entry" section, those on exit go in the "on_exit" section. -Animation Events
- -Animations can have a timeline dedicated to events. The "timeline" section contains the event timeline list. Below there are various examples where particular times can trigger a single event, or an array of events: -Animation Notes
- -Entity events occur in animations, which normally occur on the client (via resource packs), but can also occur on the server (via behavior packs). As the server side of the game has no visual aspects to it, obviously no bone-based animations can occur. However, a traditional animation is basically a timeline of events, with the events being bone positions for an animated visual rig that moves the entity's visual shape around. The mechanisms for the Bedrock animation system are state machines (Animation Controllers), and timelines (Animations). These concepts apply directly to the triggering of events, thus the animation system can execute on the server (minus the visual aspects), with the intent of driving entity events. To use entity events on the server (in a behavior pack), add animation controllers and animations to a behavior pack just as you would to a resource pack. Add animation and animation controllers to an "animations" section in the description field of an entity. These animations and animation controllers will run on the server just as if they were on the client in a resource pack. Add the "scripts" section with an "animate" subsection to specify which animations/animation-controllers to have run.Client side (resource pack) events do not require special setup as the client side entities usually already have animations and animation controllers in place. Just add your events where you need them in animations or animation controllers. -Events
- -Events consist of three categories, all represented by a string:- Entity events- Slash Commands- Molang ExpressionsIn detail:Entity Events: Server side (behavior packs) only. Currently, we only support entity events to self, and these take the form "@s event". These are events declared in the events section of the entity definition file. For example, in the cat.json, "minecraft:ageable_grow_up" event causes the kitten to grow up. This would take the form of "@s minecraft:ageable_grow_up"Slash commands: Server side (behavior packs) only. Any slash command can be invoked, such as "/particle minecraft:example_smoke_puff ~ ~ ~". The assumed entity for the slash command is the invoking entity, so this particular slash command will spawn a smoke puff effect at the entity's location.Molang Expressions: This executes a Molang expression. The primary usage is to set Molang variables that can be used later. For example, a state transition might be looking at a particluar Molang variable, and this expression could change that variable. A particle effect on the entity might change color due to Molang variables that the effect uses for color tints. An animation to move an arm might use a Molang variable that was set by an animation event. -General Notes
- -This document contains details for driving various events via entity .json data. Entity events can go in both behavior and resource packs. Behavior packs use the same animations and animation controllers setup that are used in resource packs, albeit with a different method in the entity .json itself to activate the animations.Entity events are a way to drive gameplay and entity state changes in the Bedrock engine. These events can typically include slash commands (behavior packs only), entity events (e.g. become an adult), and Molang expressions (e.g. set the Molang variable "variable.foo" to 3 on a particular entity). Animations and Animation controllers provide a method for driving state machines and timelines for an entity. For example, a particular animation controller could be in a particular state, and running a particular animation, and we want events triggered when entering/exiting that state. Alternately, an "animation" could be running, and we wish to fire off events during that animation. The entity event timeline mechanic makes this possible.Back to topIndex
-Back to top -Overview
- -Features are decorations scattered throughout the world. Things such as trees, plants, flowers, springs, ore, and coral are all features. Basically, if it isn't the terrain or a mob, it's probably a feature!Features can be standalone or composed of multiple sub-features. In practice, most features in Minecraft are defined as a chain of two or more features. These chains typically end with features that place blocks in the world. Other feature types control flow such as conditional, sequential, or random distribution.Back to topJSON format
- -All features must specify the version that they target via the "format_version" field. The remainder of the data is contained in independet JSON sub-objects for each supported feature type. These feature types define the behavior of the feature and include properties specific to that behavior. To be valid, a definition must include exactly one of these type objects. See the full feature schema below for additional details and the full list of supported feature types. -Here is a sample featureAdding features
- -Features are read from JSON files in the "features" subfolder of behavior packs. Loading enforces one feature per file; the file name and the name of the feature must match. Feature names can include a namespace of the form "namespace:feature_name" to help distinguish them from features that may be in other behavior packs. This namespace is not considered when matching the filename to the feature name. For example, in a file called "my_tree_feature.json" both "my_tree_feature" and "my_pack_name:my_tree_feature" would be valid identifiers. If two behavior packs define the same feature name (including namespace), then the feature from the highest pack in the stack will be used. This allows users to override base features if desired.Back to topSupported features
- -minecraft:aggregate_feature
- -'minecraft:aggregate_feature' places a collection of features in an arbitary order. All features in the collection use the same input position. Features should not depend on each other, as there is no guarantee on the order the features will be placed.Succeeds if: At lease one feature is placed successfully.Fails if: All features fail to be placed. -Example use: scattering multiple different plants around a monument.minecraft:sequence_feature
- -'minecraft:sequence_feature' places a collection of features sequentially, in the order they appear in data. The output position of the previous feature is used as the input position for the next. For example, a tree feature is placed at (0, 0, 0) and places blocks up to (0, 10, 0). The next feature in the sequence begins at (0, 10, 0).Succeeds if: All features in the sequence are successfully placed.Fails if: Any feature in the sequence fails to be placed. Features that have not yet been placed at the time of failure are skipped. -Example use: Scattering fruit throughout the canopy of a tree.minecraft:beards_and_shavers
- -'minecraft:beards_and_shavers' will build a 'beard' or 'shave' out space so as to provide a clear space for a feature to place.Succeeds if: a beard/shave is made (this should always happen).Fails if: will always return placement pos, but interior feature placement not guaranteed. -Example use: provides an area for interior structure placementminecraft:cave_carver_feature
- -'minecraft:cave_carver_feature' carves a cave through the world in the current chunk, and in every chunk around the current chunk in an 8 radial pattern.This feature will also only work when placed specifically in the pass "pregeneration_pass". -Example use: Carve caves normally.minecraft:conditional_list
- -'minecraft:conditional_list' Places the first suitable feature within a collection.These conditional features will be evaluated in order.Succeeds if: A condition is successfully resolved.Fails if: No condition is successfully resolved. -Example use: assigning a feature to an expressionminecraft:growing_plant_feature
- -'minecraft:growing_plant_feature' places a growing plant in the world. A growing plant is a column that is anchored either to the ceiling or the floor, based on its growth direction.The growing plant has a body and a head, where the head is the tip of the plant, and the body consists of the remainder blocks.This feature can be used to define growing plants with variable body and head blocks, e.g. Cave Vines. -Example use: Defining a growing plant feature with variable body and head blocks and height distribution.minecraft:hell_cave_carver_feature
- -'minecraft:hell_cave_carver_feature' carves a cave through the Nether in the current chunk, and in every chunk around the current chunk in an 8 radial pattern.This feature will also only work when placed specifically in the pass "pregeneration_pass". -Example use: Carve nether caves normally.minecraft:multiface_feature
- -'minecraft:multiface_feature' places one or a few multiface blocks on floors/walls/ceilings. Despite the name, any block can be placed by this feature. During placement, existing world blocks are checked to see if this feature can be placed on them based on the list provided in the 'can_place_on' field. If no 'can_replace_on' field is specified, the 'place_block' block can be placed on any existing block.This feature will also try to spread the 'place_block' block around the location in world the feature is placed.Succeeds if: At least one block is successfully placed.Fails if: All block placements fail. -Example use: Blue vines in caves.minecraft:geode_feature
- -'minecraft:geode_feature' generates a rock formation to simulate a geode. Each layer of, and block within, the geode can be replaced. Succeeds if: At least one block within the geode is placed.Fails if: All blocks within the geode fail to be placed. -Example use: Diamond geodes with emerald blocks inside and obsidian on the outside.minecraft:ore_feature
- -'minecraft:ore_feature' places a vein of blocks to simulate ore deposits. Despite the name, any block can be placed by this feature. During placement, existing world blocks are checked to see if they can be replaced by the new ore block based on the list provided in the 'may_replace' field of a 'replace_rules' entry. If no 'may_replace' field is specified in a 'replace_rule' entry, the ore block can replace any existing block.Succeeds if: At least one ore block is successfully placed.Fails if: All ore block placements fail. -Example use: Malachite ore in different materials.minecraft:rect_layout
- -'minecraft:rect_layout' scans the surface of a Chunk, calling place() on the surface of each block column.Succeeds if: A Feature is successfully placed within a Chunk.Fails if: No Feature could be placed within a Chunk. -Example use: Scans the surface of a chunk and places a feature if ableminecraft:scan_surface
- -'minecraft:scan_surface' scans the surface of a Chunk, calling place() on the surface of each block column.Succeeds if: A Feature was successfully placed during the scan.Fails if: No Feature was placed during the course of the scan. -Example use: Scans the surface of a chunk and places a feature if ableminecraft:scatter_feature
- -'minecraft:scatter_feature' scatters a feature throughout a chunk. The 'x', 'y', and 'z' fields are per-coordinate parameters. Note that coordinates represent an offset from the input position, not an absolute position. Coordinates may be a single value, a random distribution, or Molang expression that resolves to a numeric value. The 'coordinate_eval_order' field is provided for finer control of coordinate resolution (particularly when using the 'grid' distribution). 'iterations' controls how many individual placements should occur if the 'scatter_chance' check succeeds. The 'scatter_chance' check happens once, so either all placements will run or none will.Succeeds if: At least one feature placement succeeds.Fails if: All feature placements fail. -Example use: Scattering flowers at sea level across half the chunks in a biome.minecraft:search_feature
- -'minecraft:search_feature' sweeps a volume searching for a valid placement location for its referenced feature. The 'search_volume' field specifies the axis-aligned bounding box that defines the boundaries of the search. The search sweeps along the axis defined by the 'search_axis' field, layer by layer. For example, if 'search_axis' = '-x', blocks with greater x values will be checked before blocks with lower x values. Each layer is searched from the bottom-left to the top-right before moving to the next layer along the axis. By default, only one valid position must be found, but this can be altered by specifying the 'required_successes' field. If fewer than the required successes are found, no placement will occur.Succeeds if: The number of valid positions is equal to the value specified by 'required_successes'.Fails if: The number of valid positions is less than the value specified by 'required_successes'. -Example use: Attaching apples to a tree canopyminecraft:single_block_feature
- -'minecraft:single_block_feature' places a single block in the world. The 'may_place_on' and 'may_replace' fields are allowlists which specify where the block can be placed. If these fields are omitted, the block can be placed anywhere. The block's internal survivability and placement rules can optionally be enforced with the 'enforce_survivability_rules' and 'enforce_placement_rules' fields. These rules are specified per-block and are typically designed to produce high quality gameplay or natural behavior. However, enabling this enforcement may make it harder to debug placement failures.Succeeds if: The block is successfully placed in the world.Fails if: The block fails to be placed. -Example use: Placing a single pumpkin block.minecraft:snap_to_surface_feature
- -'minecraft:snap_to_surface_feature' snaps the y-value of a feature placement pos to the floor or the ceiling within the provided 'vertical_search_range'. The placement biome is preserved. If the snap position goes outside of the placement biome, placement will fail. -Example use: Define a feature that snaps the 'cave_vine_feature' to the ceiling.minecraft:structure_template_feature
- -'minecraft:structure_template_feature' places a structure in the world. The structure must be stored as a .mcstructure file in the "structures" subdirectory of a behavior pack. It is possible to reference structures that are part of other behavior packs, they do not need to come from the same behavior pack as this feature. Constraints can be defined to specify where the structure is allowed to be placed. During placement, the feature will search for a position within the 'adjustment_radius' that satisfies all constraints. If none are found, the structure will not be placed.Succeeds if: The structure is placed in the world.Fails if: The structure fails to be placed within the world. -Example use: Place a hot air balloon structure that "floats" in the air.minecraft:underwater_cave_carver_feature
- -'minecraft:underwater_cave_carver_feature' carves a cave through the world in the current chunk, and in every chunk around the current chunk in an 8 radial pattern.This feature will specifically target creating caves only below sea level.This feature will also only work when placed specifically in the pass "pregeneration_pass". -Example use: Carve caves normally.minecraft:tree_feature
- -Feature type 'minecraft:tree_feature' has not yet been documented.Back to topminecraft:vegetation_patch_feature
- -Feature type 'minecraft:vegetation_patch_feature' has not yet been documented.Back to topminecraft:weighted_random_feature
- -'minecraft:weighted_random_feature' randomly selects and places a feature based on a weight value. Weights are relative, with higher values making selection more likely.Succeeds if: The selected feature is placed.Fails if: The selected feature fails to be placed. -Example use: Selecting and placing a variant of a flower.minecraft:sculk_patch_feature
- -Feature type 'minecraft:sculk_patch_feature' has not yet been documented.Back to topminecraft:catalyst_feature
- -Feature type 'minecraft:catalyst_feature' has not yet been documented.Back to topminecraft:partially_exposed_blob_feature
- -'minecraft:partially_exposed_blob_feature' generates a blob of the specified block with the specified dimensions For the most part the blob is embedded in the specified surface, however a single side is allowed to be exposed. -Example use: Blobs of Magma blocks partially embedded in the floors of flooded caves.minecraft:surface_relative_threshold_feature
- -'minecraft:surface_relative_threshold_feature' determines whether the provided position is below the estimated surface level of the world, and places a feature if so.If the provided position is above configured surface or the surface is not available, placement will fail. This feature only works for Overworld generators using world generation 1.18 or later. -Example use: Define a feature that places the 'underwater_magma_snap_to_surface_feature', if the given position is at least two blocks below estimated surface level.Attaching features
- -Features must be attached to at least one biome in order to show up in the world. During world generation, biomes attempt to place their attached features chunk-by-chunk. Features can be attached in two ways:1) Via a feature rule definition2) Via the "minecraft:forced_features" biome componentBack to topFeature rules
- -Feature rules are separate JSON definition files found in the "feature_rules" subfolder of behavior packs. Feature rules follow the same filename rules as features. Each feature rule controls exactly one feature and serves as the root of a chain of feature data. To attach a feature to a biome with a feature rule, the "conditions" object must include the "minecraft:biome_filter" field. This is a list of filter tests that are performed on each biome to determine if the feature should be attached. Most relevant is the "has_biome_tag" test. -Here is a sample feature ruleFeature rule schema
- - -Forced features
- -Features attached with the second method are called "forced" or "explicit" features. Unlike feature rules, forced features are not defined in separate JSON files. Instead, they are specified in the existing biome JSON definitions via the "minecraft:forced_features" component. Like feature rules, this component includes fields that define when features should be placed ("placement_pass") and how they should be scattered ("distribution"). For more information about biome components (including the complete JSON schema), consult the biome documentation.Back to topIndex
-| Fog Definitions |
|---|
| Fog Schema |
| Active Fog Stack |
| Biomes |
| Command |
| Data Default |
| Engine Default |
| Biomes |
| Fog Command |
| Pop |
| Push |
| Remove |
Fog Definitions
- -Fogs are setup in Json files under the resource_packs, /'name of pack'/, fogs directory.Fog Schema
- -Active Fog Stack
- -Biomes
- -Command
- -Data Default
- -Engine Default
- -Biomes
- -Fog Command
- -Pop
- -Push
- -Remove
- -Index
-| Items |
|---|
| Item Components |
| Item Definition Properties |
| Item Description Properties |
Items
- -To define an item, the item definition must be defined in the behavior pack in a JSON file.All attributes, including item names, must be defined using item components.Item Components
- -Below are the various components for item functionality. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| minecraft:armor | -JSON Object | -- | The armor item component determines the amount of protection you have in your armor item.Experimental toggles required: Holiday Creator Features protection - -How much protection does the armor item have.Minimum value: 0Type: integerBack to top- - texture_type - -Texture Type to apply for the armor. Note that Horse armor is restricted to leather, iron, gold, or diamond.Accepted values: "gold", "none", "leather", "chain", "iron", "diamond", "elytra", "turtle", "netherite"Back to top- - |
-
| minecraft:block_placer | -JSON Object | -- | Planter item component. planter items are items that can be planted.Experimental toggles required: Holiday Creator Features block - -block: Set the placement block name for the planter item.Type: blockBack to top- - use_on - -List of block descriptors that contain blocks that this item can be used on. If left empty, all blocks will be allowed.Type: array of use_onBack to top- - |
-
| minecraft:cooldown | -JSON Object | -- | Cool down time for a component. After you use an item it becomes unusable for the duration specified by the 'cool down time' setting in this component.Experimental toggles required: Holiday Creator Features category - -The type of cool down for this item.Type: categoryBack to top- - duration - -The duration of time this item will spend cooling down before becoming usable again.Type: floatBack to top- - |
-
| minecraft:digger | -JSON Object | -- | Digger item. Component put on items that dig.Experimental toggles required: Holiday Creator Features destroy_speeds - -Destroy speed per block.Type: array of destroy_speedsBack to top- - on_dig - -Trigger for when you dig a block that isn't listed in destroy_speedsType: on_digBack to top- - use_efficiency - -Use efficiency? Default is set to false.Type: booleanBack to top- - |
-
| minecraft:display_name | -JSON Object | -- | Display Name item component. Display Names set the name to display when an item is in use or hovered over.Experimental toggles required: Holiday Creator Features value - -The display name for an item.Type: valueBack to top- - |
-
| minecraft:durability | -JSON Object | -- | A property that determines when an item will break from use. The durability of an item is potentially depleted upon use based on the damage chance.Experimental toggles required: Holiday Creator Features damage_chance - -Damage chance is the chance of this item losing durability. Could be an int or an int range with min and max value.Type: damage_chanceBack to top- - max_durability - -Max durability is the amount of damage that this item can take before breaking.Type: integerBack to top- - |
-
| minecraft:dye_powder | -JSON Object | -- | Dye powder, there are 16 kinds of dye.Experimental toggles required: Holiday Creator Features color - -Defines what color the dye is.Accepted values: "black", "red", "green", "brown", "blue", "purple", "cyan", "silver", "gray", "pink", "lime", "yellow", "lightblue", "magenta", "orange", "white"Back to top- - |
-
| minecraft:entity_placer | -JSON Object | -- | Entity placer item component. You can specifiy allowed blocks that the item is restricted to.Experimental toggles required: Holiday Creator Features dispense_on - -List of block descriptors that contain blocks that this item can be dispensed on. If left empty, all blocks will be allowed.Type: array of dispense_onBack to top- - entity - -The entity to be placed in the world.Type: entityBack to top- - use_on - -List of block descriptors that contain blocks that this item can be used on. If left empty, all blocks will be allowed.Type: array of use_onBack to top- - |
-
| minecraft:food | -JSON Object | -- | When an item has a food component, it becomes edible to the player.Experimental toggles required: Holiday Creator Features can_always_eat - -If true you can always eat this item (even when not hungry), defaults to false.Type: booleanBack to top- - nutrition - -How much nutrition does this food item give the player when eaten.Type: integerBack to top- - on_consume - -Type: on_consumeBack to top- - saturation_modifier - -Saturation Modifier is used in this formula: (nutrition * saturation_modifier * 2) when appling the saturation buff. Which happens when you eat the item.Type: saturation_modifierBack to top- - using_converts_to - -When used, convert the *this* item to the one specified by 'using_converts_to'.Type: using_converts_toBack to top- - |
-
| minecraft:fuel | -JSON Object | -- | Fuel component. Allows this item to be used as fuel in a furnace to 'cook' other items.Experimental toggles required: Holiday Creator Features duration - -How long in seconds will this fuel cook items for.Type: floatBack to top- - |
-
| minecraft:icon | -JSON Object | -- | The icon item component determines the icon to represent the item.Experimental toggles required: Holiday Creator Features frame - -An index or MoLang expression for which frame of the icon to display. Default resolves to 0.Type: frameBack to top- - legacy_id - -Legacy texture string id for older item icons. Legacy ID list can be found here under 'Namespaced ID': https://minecraft.fandom.com/wiki/Bedrock_Edition_data_valuesType: stringBack to top- - texture - -The key for the object contain the expected textures, from file 'resource_pack/textures/item_texture.json'.Type: stringBack to top- - |
-
| minecraft:knockback_resistance | -JSON Object | -- | Knockback Resistance Item. Component put on items that provide knockback resistance.Experimental toggles required: Holiday Creator Features protection - -Amount of knockback resistance provided with the total maximum protection being 1.0Type: floatBack to top- - |
-
| minecraft:on_use | -JSON Object | -- | The on_use item component allows you to receive an event when the item is used.Experimental toggles required: Holiday Creator Features on_use - -Event trigger for when the item is used.Type: on_useBack to top- - |
-
| minecraft:on_use_on | -JSON Object | -- | The on_use_on item component allows you to receive an event when the item is used on a block in the world.Experimental toggles required: Holiday Creator Features on_use_on - -Event trigger for when the item is used.Type: on_use_onBack to top- - |
-
| minecraft:projectile | -JSON Object | -- | Projectile item component. projectile items shoot out, like an arrow.Experimental toggles required: Holiday Creator Features minimum_critical_power - -How long you must charge a projectile for it to critically hit.Type: floatBack to top- - projectile_entity - -The entity to be fired as a projectile.Type: projectile_entityBack to top- - |
-
| minecraft:render_offsets | -JSON Object | -- | Render offsets component: optional values can be given to offset the way the item is rendered.Experimental toggles required: Holiday Creator Features main_hand - -Main hand transform data.Type: main_handBack to top- - off_hand - -Offhand hand transform data.Type: off_handBack to top- - |
-
| minecraft:repairable | -JSON Object | -- | Repairable item component: how much damage can this item repair, what items can repair it.Experimental toggles required: Holiday Creator Features on_repaired - -Event that is called when this item has been repaired.Type: on_repairedBack to top- - repair_items - -Repair item entries.Type: array of repair_itemsBack to top- - |
-
| minecraft:shooter | -JSON Object | -- | Shooter Item Component.Experimental toggles required: Holiday Creator Features ammunition - -Ammunition.Type: array of ammunitionBack to top- - charge_on_draw - -Charge on draw? Default is set to false.Type: booleanBack to top- - launch_power_scale - -Launch power scale. Default is set to 1.0.Type: floatBack to top- - max_draw_duration - -Draw Duration. Default is set to 0.Type: max_draw_durationBack to top- - max_launch_power - -Launch power. Default is set to 1.0.Type: floatBack to top- - scale_power_by_draw_duration - -Scale power by draw duration? Default is set to false.Type: booleanBack to top- - |
-
| minecraft:throwable | -JSON Object | -- | Throwable item component. Throwable items, such as a snowball.Experimental toggles required: Holiday Creator Features do_swing_animation - -Whether the item should use the swing animation when thrown. Default is set to false.Type: booleanBack to top- - launch_power_scale - -The scale at which the power of the throw increases. Default is set to 1.0.Type: floatBack to top- - max_draw_duration - -The maximum duration to draw a throwable item. Default is set to 0.0.Type: floatBack to top- - max_launch_power - -The maximum power to launch the throwable item. Default is set to 1.0.Type: floatBack to top- - min_draw_duration - -The minimum duration to draw a throwable item. Default is set to 0.0.Type: floatBack to top- - scale_power_by_draw_duration - -Whether or not the power of the throw increases with duration charged. Default is set to false.Type: booleanBack to top- - |
-
| minecraft:weapon | -JSON Object | -- | Weapon Item Component. Added to every weapon item such as axe, sword, trident, bow, crossbow.Experimental toggles required: Holiday Creator Features on_hit_block - -Trigger for letting you know when this item is used to hit a blockType: on_hit_blockBack to top- - on_hurt_entity - -Trigger for letting you know when this item is used to hurt another mobType: on_hurt_entityBack to top- - on_not_hurt_entity - -Trigger for letting you know when this item hit another actor, but didn't do damageType: on_not_hurt_entityBack to top- - |
-
| minecraft:wearable | -JSON Object | -- | Wearable item component.Experimental toggles required: Holiday Creator Features slot - -equipment_slot: slot.weapon.mainhand, slot.weapon.offhand, slot.armor.head, slot.armor.chest, slot.armor.legs, slot.armor.feet, slot.hotbar, slot.inventory, slot.enderchest, slot.saddle, slot.armor, slot.chestAccepted values: "slot.armor.legs", "none", "slot.weapon.mainhand", "slot.weapon.offhand", "slot.armor.head", "slot.armor.chest", "slot.armor.feet", "slot.hotbar", "slot.inventory", "slot.enderchest", "slot.saddle", "slot.armor", "slot.chest"Back to top- - |
-
Item Definition Properties
- -The properties are part of the Item Definition. This helps the system determine how to parse and initialize this item. - -format_version
- -Specifies the version of the game this entity was made in. If the version is lower than the current version, any changes made to the entity in the vanilla version will be applied to it.Back to topItem Description Properties
- - - -| Name | Type | Default Value | Description |
|---|---|---|---|
| category | -String | -- | The category for this item. Categories are used to control high level properties of how the item is integrated into the bedrock engine, such as whether it can be used in slash commands. | -
| identifier | -String | -- | The identifier for this item. The name must include a namespace and must not use the Minecraft namespace unless overriding a Vanilla item. | -
| is_experimental | -Boolean | -false | -If this item is experimental, it will only be registered if the world is marked as experimental. | -
Index
-Back to top -Why Does Molang Exist?
- -Molang is a simple expression-based language designed for fast, data-driven calculation of values at run-time, and with a direct connection to in-game values and systems. Its focus is to enable low-level systems like animation to support flexible data-driven behavior for both internal and external creators, while staying highly performant.Back to topLexical Structure
- -The language structure is largely based on simple 'C' language family style syntax. An expression can be made of either one simple value or math calculation, or can be made of several sub-expressions where more complicated code is required. In simple cases, the terminating `;` is omitted and the expression result is returned. In complex cases, multiple sub-expressions are each terminated with a semicolon `;`. Complex expressions evaluate to `0.0` unless there is a `return` statement, in which case the evaluated value of the `return`'s sub-expression will be returned out of the current scope.Case Sensitivity
- -All things in Molang are case-INsensitive, with the exception of strings, which maintain the case provided.Back to topKeywords
- -All identifiers not in a scope listed below are reserved for future use - -| Keyword | Description |
|---|---|
| `1.23` | -Numerical constant value | -
| `! && || < <= >= > == !=` | -Logical operators | -
| `* / + -` | -Basic math operators | -
| `(` `)` | -Parentheses for expression term evaluation control | -
| `{` `}` | -Braces for execution scope | -
| `??` | -Null coalescing operator, for handling missing variables or stale actor references | -
| `geometry.texture_name` | -A reference to a geometry named in the entity definition | -
| `material.texture_name` | -A reference to a material named in the entity definition | -
| `texture.texture_name` | -A reference to a texture named in the entity definition | -
| `math.function_name` | -Various math functions | -
| `query.function_name` | -Access to an entity's properties | -
| `variable.variable_name` | -Read/write storage on an actor | -
| `temp.variable_name` | -Read/write temporary storage | -
| `context.variable_name` | -Read-only storage provided by the game in certain scenarios | -
| ` |
-Binary conditional operator | -
| ` |
-Ternary conditional operator | -
| `this` | -The current value that this expression will ultimately write to (context specific) | -
| `return` | -For complex expressions, this evaluates the following statement and stops execution of the expression, returns the value computed | -
| `->` | -Arrow operator, for accessing data from a different entity | -
| `loop` | -For repeating one or more commands 'n' times | -
| `for_each` | -For iterating over an array of entities | -
| `break` | -For early exiting a loop/for_each scope | -
| `continue` | -For skipping the rest of the set of statements of a loop/for_each iteration and moving to the next iteration | -
| `[` `]` | -Brackets for array access | -
Variables
- -There are three variable lifetimes a variable may belong to: Temporary, Entity, and Context:- Temporary variables (eg: `temp.moo = 1;`) are read/write and valid for the scope they are defined in, as per C rules. For performance reasons their lifetime is global to the current expression execution and may return a valid value outside of the outermost scope they are defined in for an expression. Be careful in complex expressions. We will be adding content errors for invalid accesses as soon as possible.- Entity variables (eg: `variable.moo = 1;`) are read/write and store their value on the entity for the lifetime of that entity. Note that these are currently not saved, so quitting and reloading the world will re-initialize these. In the same way, if the entity is despawned, any variables on the entity will be lost.- Context variables (eg: `context.moo`) are read-only and specified by the game in certain situations. Details on what variables are specified and when will be available in the documentation of the area where that Molang expression is used (such as behaviours defining what context variables they expose).Back to topValues
- - - -- All numerical values are floats.- Boolean values such as actor flags are converted and stored as a float value of either 0.0 or 1.0 for values of false or true respectively.- For boolean tests, a float value equivalent to 0.0 is false, and anything not equal to 0.0 is true.- For array indices, floats are C-style-cast to ints, and clamped at zero for negative values or wrapped by the array size for large values.- Other supported types are:Back to topQuery Functions
- -Query functions (eg: `query.is_baby` or `query.is_item_equipped('main_hand')`) allow expressions to read game data. If a query function takes no arguments, do not use parentheses. Otherwise, use parentheses and separate arguments with commas. For a full list of query functions, see below.Back to topAliases
- -To reduce typing burden and increase clarity when reading and writing Molang, the following keyword aliases can make life a bit easier. Note that left and right sides function identically. - -Alias Mapping
- - - -| Full Name | Aliased Name |
|---|---|
| `context.moo` | -`c.moo` | -
| `query.moo` | -`q.moo` | -
| `temp.moo` | -`t.moo` | -
| `variable.moo` | -`v.moo` | -
Structs
- -Structures of data, unlike C, are implicitly defined by usage. Their purpose is to more efficiently pass data around, such as passing `v.location` rather than `v.x`, `v.y`, and `v.z`. eg: - - -Strings
- -Strings in Molang are surrounded by single quotes.Eg: `'minecraft:pig'` or `'hello world!'`. An empty string is defined as two consecutive single quotes. String operations only support `==` and `!=` at this time.Note: strings don't support the ' character as there is no support for escape characters at this time.Back to topMath Functions
- - - -| Function | Description |
|---|---|
| `math.abs(value)` | -Absolute value of value | -
| `math.acos(value)` | -arccos of value | -
| `math.asin(value)` | -arcsin of value | -
| `math.atan(value)` | -arctan of value | -
| `math.atan2(y, x)` | -arctan of y/x. NOTE: the order of arguments! | -
| `math.ceil(value)` | -Round value up to nearest integral number | -
| `math.clamp(value, min, max)` | -Clamp value to between min and max inclusive | -
| `math.cos(value)` | -Cosine (in degrees) of value | -
| `math.die_roll(num, low, high)` | -returns the sum of 'num' random numbers, each with a value from low to high`. Note: the generated random numbers are not integers like normal dice. For that, use `math.die_roll_integer`. | -
| `math.die_roll_integer(num, low, high)` | -returns the sum of 'num' random integer numbers, each with a value from low to high`. Note: the generated random numbers are integers like normal dice. | -
| `math.exp(value)` | -Calculates e to the value'th power | -
| `math.floor(value)` | -Round value down to nearest integral number | -
| `math.hermite_blend(value)` | -Useful for simple smooth curve interpolation using one of the Hermite Basis functions: `3t^2 - 2t^3`. Note that while any valid float is a valid input, this function works best in the range [0,1]. | -
| `math.lerp(start, end, 0_to_1)` | -Lerp from start to end via 0_to_1 | -
| `math.lerprotate(start, end, 0_to_1)` | -Lerp the shortest direction around a circle from start degrees to end degrees via 0_to_1 | -
| `math.ln(value)` | -Natural logarithm of value | -
| `math.max(A, B)` | -Return highest value of A or B | -
| `math.min(A, B)` | -Return lowest value of A or B | -
| `math.min_angle(value)` | -Minimize angle magnitude (in degrees) into the range [-180, 180) | -
| `math.mod(value, denominator)` | -Return the remainder of value / denominator | -
| `math.pi` | -Returns the float representation of the constant pi. | -
| `math.pow(base, exponent)` | -Elevates `base` to the `exponent`'th power | -
| `math.random(low, high)` | -Random value between low and high inclusive | -
| `math.random_integer(low, high)` | -Random integer value between low and high inclusive | -
| `math.round(value)` | -Round value to nearest integral number | -
| `math.sin(value)` | -Sine (in degrees) of value | -
| `math.sqrt(value)` | -Square root of value | -
| `math.trunc(value)` | -Round value towards zero | -
-> Arrow Operator
- - - -Some return values of query function, or values stored in temp/entity/context variables can be a reference to another entity. The `->` operator allows an expression to access variables or run queries on that entity. For example, the example below will find all pigs within four metres of the current entity(including itself if it's a pig), and increment a variable `v.x` on itself if the block immediately above each pig is flammable(such as an oak button) :Note that in the case where the left-hand side of the `->` operator has an error (value is null, the entity was killed previously, or some other issue), the expression will not evaluate the right-hand side and will return 0. This implementation style was a choice between performance and not requiring content creators to overly worry about checking for potentially bad values everywhere. -Public Variables
- - - -In general, variables of a mob are considered private to that mob and cannot be accessed by another. To expose read-only access of a variable to other mobs, you need to set the 'public' setting on that variable in the owning entity's resource definition. It is also recommended to default-initialize the variable. -{ } Brace Scope Delimiters
- -One can group a series of statements into a single group by wrapping them in `{` and `}` symbols. This is used primarily in loops and conditional statements: -Conditionals
- -The conditional '?' operator allows for two convenient ways to implement simple branching logic. The first way is to use '?' by itself to conditionally execute part of an expression, for example `A ? B`. The part after the '?' is only run if the part before it evaluates to a true boolean. The second way is to use '?' with a ':' as a 'conditional ternary', for example `A ? B : C`. If the part before the '?' is evaluated as true, the part before the ':' is returned. Otherwise the part after is returned. -Conditional Examplesloop
- -Sometimes you want to execute an expression multiple times. Rather than copy-pasting it a bunch, you can use `loop(for_each
- -`query.get_nearby_entities` (see below) returns an array of entities. In order to iterate through them, you can use the following new built-in function `for_each`. It takes three parameters: `for_each(break
- - - -This will exit out of a `loop` or `for_each` early. Eg:Back to topcontinue
- -`continue` functions as per C-style language rules. Currently only supported in `loop` and `for_each`, this will skip to the next iteration of the current loop. See `break` above for more details on inner/outer loops. The following example will result in v.x becoming 6.0, as the increment will be skipped once it reaches that value. Note that it is better to break out of the loop in this contrived example, as it would be more performant than continuing to perform all 10 iterations. - - -?? Null Coalescing Operator
- -Similar to how the null-coalescing operator works in C#, one can now reference a variable that may or may not exist without seeing a content error. If it doesn't, you can now provide a default value to use. Previously, if a variable didn't exist you would get a content error. This was to make sure variables were always initialized correctly to avoid uninitialized variable bugs. Unfortunately this then required initialize scripts, or in some cases some complex work-arounds to make sure variables were initialized. Now, if you know a variable won't be initialized in the first run of a script, you can use the following: - - -Simple vs Complex Expressions
- - - -A simple expression is a single statement, the value of which is returned to the system that evaluated the expression. eg: -Domain Examples
- -Entity Definition Scripts
- -In the definition file there is a section for pre-computing values. These are executed immediately before animation and render controllers are processed, and stored in the entity. The purpose is to pre-compute any expensive and complex values you may want to reuse in your scripts, long-living index variable updates, or generally any one-off computation per render tick. -Animation and Animation Controller Files
- -These are numerical operations to control which animations are playing and how to animate bones. "variable.variable_name" and "query.function_name" refer to the entity currently being rendered. They have access to everything in the language except material, texture, and geometry types.Back to topRender Controllers
- -There are a few different kinds of expressions here, where context implies what is allowed. As with animations, the entity accessors refer to the current entity, however depending on the context one also has access to materials, textures, and geometries. There are two sections in a render controller:-Array definitions (optional)-Resource usage (required)The array definition section allows you to create arrays of resources by resource type if you so desire. These can then be referenced in the resource usage section. - -Array Expressions
- -For each of the three resource types (materials, textures, and geometry), you can define an array of resources. The name of the resource is the nice-name from the definition file. Using materials as an example: - - -Resource Expression
- -A resource expression must return a single resource of a specific type depending on the context.For example, in the "geometry" section, you must produce an expression that will result in a single geometry. Some examples: -Cycle through an array of geometries at a rate of one per secondResource Sections
- - - -Geometry
- -The geometry section specifies which geometry to use when rendering. As you can specify as many render controllers as you like in the definition file, a single render controller is only concerned with how to render a single geometry. Note that a geometry can be arbitrarily complex using any number of bones and polygons.Back to topMaterials
- -The materials section specifies how to map what material to what bone of the geometry. A single material is mapped to a whole bone. Material expressions are evaluated in the order listed. The first part of each statement is the name of the model part to apply the material to, and the second part is the material to use. The model part name can use * for wild - card matching of characters. For example : - - -Query Functions
- -Query Functions are operators that access a wide variety of information. They can return simple true or false values (1.0 or 0.0) or more complex data. See the list of functions below for per-query documentation. Query Functions might not take any parameters. In that case, just `query.function_name` is used. Otherwise parentheses with commas separating arguments should be used, ie `query.function_name(1, 2, 'three')`. For example: -List of Entity Queries
- - - -| Name | Description |
|---|---|
| query.above_top_solid | -Returns the height of the block immediately above the highest solid block at the input (x,z) position | -
| query.actor_count | -Returns the number of actors rendered in the last frame | -
| query.all_animations_finished | -Only valid in an animation controller. Returns 1.0 if all animations in the current animation controller state have played through at least once, else it returns 0.0 | -
| query.all_tags | -Returns if the item or block has all of the tags specified | -
| query.anim_time | -Returns the time in seconds since the current animation started, else 0.0 if not called within an animation | -
| query.any_animation_finished | -Only valid in an animation controller. Returns 1.0 if any animation in the current animation controller state has played through at least once, else it returns 0.0 | -
| query.any_tag | -Returns if the item or block has any of the tags specified | -
| query.approx_eq | -Returns 1.0 if all of the arguments are within 0.000000 of each other, else 0.0 | -
| query.armor_color_slot | -Takes the armor slot index as a parameter, and returns the color of the armor in the requested slot | -
| query.armor_material_slot | -Takes the armor slot index as a parameter, and returns the armor material type in the requested armor slot | -
| query.armor_texture_slot | -Takes the armor slot index as a parameter, and returns the texture type of the requested slot | -
| query.average_frame_time | -Returns the time in *seconds* of the average frame time over the last 'n' frames. If an argument is passed, it is assumed to be the number of frames in the past that you wish to query. 'query.average_frame_time' (or the equivalent 'query.average_frame_time(0)') will return the frame time of the frame before the current one. 'query.average_frame_time(1)' will return the average frame time of the previous two frames. Currently we store the history of the last 30 frames, although note that this may change in the future. Asking for more frames will result in only sampling the number of frames stored. | -
| query.block_face | -Returns the block face for this (only valid for certain triggers such as placing blocks, or interacting with block) (Down=0.0, Up=1.0, North=2.0, South=3.0, West=4.0, East=5.0, Undefined=6.0). | -
| query.block_property | -Returns the value of the associated Blocks Block State | -
| query.blocking | -Returns 1.0 if the entity is blocking, else it returns 0.0 | -
| query.body_x_rotation | -Returns the body pitch rotation if called on an actor, else it returns 0.0 | -
| query.body_y_rotation | -Returns the body yaw rotation if called on an actor, else it returns 0.0 | -
| query.bone_aabb | -Returns the axis aligned bounding box of a bone as a struct with members '.min', '.max', along with '.x', '.y', and '.z' values for each. | -
| query.bone_origin | -Returns the initial (from the .geo) pivot of a bone as a struct with members '.x', '.y', and '.z'. | -
| query.bone_rotation | -Returns the initial (from the .geo) rotation of a bone as a struct with members '.x', '.y', and '.z' in degrees. | -
| query.camera_distance_range_lerp | -Takes two distances (any order) and return a number from 0 to 1 based on the camera distance between the two ranges clamped to that range. For example, 'query.camera_distance_range_lerp(10, 20)' will return 0 for any distance less than or equal to 10, 0.2 for a distance of 12, 0.5 for 15, and 1 for 20 or greater. If you pass in (20, 10), a distance of 20 will return 0.0 | -
| query.camera_rotation | -Returns the rotation of the camera. Requires one argument representing the rotation axis you would like (0 for x, 1 for y) | -
| query.can_climb | -Returns 1.0 if the entity can climb, else it returns 0.0 | -
| query.can_damage_nearby_mobs | -Returns 1.0 if the entity can damage nearby mobs, else it returns 0.0 | -
| query.can_fly | -Returns 1.0 if the entity can fly, else it returns 0.0 | -
| query.can_power_jump | -Returns 1.0 if the entity can power jump, else it returns 0.0 | -
| query.can_swim | -Returns 1.0 if the entity can swim, else it returns 0.0 | -
| query.can_walk | -Returns 1.0 if the entity can walk, else it returns 0.0 | -
| query.cape_flap_amount | -returns value between 0.0 and 1.0 with 0.0 meaning cape is fully down and 1.0 is cape is fully up | -
| query.cardinal_block_face_placed_on | -DEPRECATED (please use query.block_face instead) Returns the block face for this (only valid for on_placed_by_player trigger) (Down=0.0, Up=1.0, North=2.0, South=3.0, West=4.0, East=5.0, Undefined=6.0). | -
| query.cardinal_facing | -Returns the current facing of the player (Down=0.0, Up=1.0, North=2.0, South=3.0, West=4.0, East=5.0, Undefined=6.0). | -
| query.cardinal_facing_2d | -Returns the current facing of the player ignoring up/down part of the direction (North=2.0, South=3.0, West=4.0, East=5.0, Undefined=6.0). | -
| query.cardinal_player_facing | -Returns the current facing of the player (Down=0.0, Up=1.0, North=2.0, South=3.0, West=4.0, East=5.0, Undefined=6.0). | -
| query.combine_entities | -Combines any valid entity references from all arguments into a single array. Note that order is not preserved, and duplicates and invalid values are removed. | -
| query.count | -Counts the number of things passed to it (arrays are counted as the number of elements they contain; non-arrays count as 1). | -
| query.current_squish_value | -Returns the squish value for the current entity, or 0.0 if this doesn't make sense | -
| query.day | -Returns the day of the current level. | -
| query.death_ticks | -Returns the elapsed ticks since the mob started dying. | -
| query.debug_output | -debug log a value to the output debug window for builds that have one | -
| query.delta_time | -Returns the time in seconds since the previous frame | -
| query.distance_from_camera | -Returns the distance of the root of this actor or particle emitter from the camera | -
| query.effect_emitter_count | -Returns the total number of active emitters of the callee's particle effect type | -
| query.effect_particle_count | -Returns the total number of active particles of the callee's particle effect type | -
| query.equipment_count | -returns the equipment count for an actor | -
| query.equipped_item_all_tags | -takes a slot name followed by any tag you want to check for in the form of 'tag_name' and returns 1 if all of the tags are on that equipped item, 0 otherwise | -
| query.equipped_item_any_tag | -takes a slot name followed by any tag you want to check for in the form of 'tag_name' and returns 0 if none of the tags are on that equipped item or 1 if at least 1 tag exists | -
| query.equipped_item_is_attachable | -Takes the desired hand slot as a parameter (0 or 'main_hand' for main hand, 1 or 'off_hand' for off hand), and returns whether the item is an attachable or not. | -
| query.eye_target_x_rotation | -returns the X eye rotation of the entity if it makes sense, else it returns 0.0 | -
| query.eye_target_y_rotation | -returns the Y eye rotation of the entity if it makes sense, else it returns 0.0 | -
| query.facing_target_to_range_attack | -Returns 1.0 if the entity is attacking from range (i.e. minecraft:behavior.ranged_attack), else it returns 0.0 | -
| query.frame_alpha | -Returns the ratio (from 0 to 1) of how much between AI ticks this frame is being rendered | -
| query.get_actor_info_id | -Returns the integer id of an actor by its string name | -
| query.get_animation_frame | -Returns the current texture of the item | -
| query.get_default_bone_pivot | -Gets specified axis of the specified bone orientation pivot | -
| query.get_equipped_item_name | -takes one optional hand slot as a parameter (0 or 'main_hand' for main hand, 1 or 'off_hand' for off hand), and a second parameter (0=default) if you would like the equipped item or any non-zero number for the currently rendered item, and returns the name of the item in the requested slot (defaulting to the main hand if no parameter is supplied) if there is one, otherwise returns ''. | -
| query.get_locator_offset | -Gets specified axis of the specified locator offset | -
| query.get_name | -get the name of the mob if there is one, otherwise return '' | -
| query.get_root_locator_offset | -Gets specified axis of the specified locator offset of the root model | -
| query.ground_speed | -Returns the ground speed of the entity in metres/second | -
| query.has_any_family | -Returns 1 if the entity has any of the specified families, else 0. | -
| query.has_armor_slot | -Takes the armor slot index as a parameter, and returns 1.0 if the entity has armor in the requested slot, else it returns 0.0 | -
| query.has_biome_tag | -Returns whether or not a Block Placement Target has a specific biome tag | -
| query.has_block_property | -Returns 1.0 if the associated block has the given block property or 0.0 if not | -
| query.has_cape | -Returns 1.0 if the player has a cape, else it returns 0.0 | -
| query.has_collision | -Returns 1.0 if the entity has collisions enabled, else it returns 0.0 | -
| query.has_gravity | -Returns 1.0 if the entity is affected by gravity, else it returns 0.0 | -
| query.has_owner | -Returns true if the entity has an owner ID else it returns false | -
| query.has_rider | -Returns 1.0 if the entity has a rider, else it returns 0.0 | -
| query.has_target | -Returns 1.0 if the entity has a target, else it returns 0.0 | -
| query.head_roll_angle | -returns the roll angle of the head of the entity if it makes sense, else it returns 0.0 | -
| query.head_x_rotation | -Takes one argument as a parameter. Returns the nth head x rotation of the entity if it makes sense, else it returns 0.0 | -
| query.head_y_rotation | -Takes one argument as a parameter. Returns the nth head y rotation of the entity if it makes sense, else it returns 0.0 | -
| query.health | -Returns the health of the entity, or 0.0 if it doesn't make sense to call on this entity. | -
| query.heightmap | -Queries Height Map | -
| query.hurt_direction | -returns the hurt direction for the actor, otherwise returns 0 | -
| query.hurt_time | -returns the hurt time for the actor, otherwise returns 0 | -
| query.invulnerable_ticks | -Returns the number of ticks of invulnerability the entity has left if it makes sense, else it returns 0.0 | -
| query.is_admiring | -Returns 1.0 if the entity is admiring, else it returns 0.0 | -
| query.is_alive | -returns 1.0 if the entity is alive, and 0.0 if it's dead | -
| query.is_angry | -Returns 1.0 if the entity is angry, else it returns 0.0 | -
| query.is_attached_to_entity | -Returns 1.0 if the actor is attached to an entity, else it will return 0.0 | -
| query.is_avoiding_block | -Returns 1.0 if the entity is fleeing from a block, else it returns 0.0 | -
| query.is_avoiding_mobs | -Returns 1.0 if the entity is fleeing from mobs, else it returns 0.0 | -
| query.is_baby | -Returns 1.0 if the entity is a baby, else it returns 0.0 | -
| query.is_breathing | -Returns 1.0 if the entity is breathing, else it returns 0.0 | -
| query.is_bribed | -Returns 1.0 if the entity has been bribed, else it returns 0.0 | -
| query.is_carrying_block | -Returns 1.0 if the entity is carrying a block, else it returns 0.0 | -
| query.is_casting | -Returns 1.0 if the entity is casting, else it returns 0.0 | -
| query.is_celebrating | -Returns 1.0 if the entity is celebrating, else it returns 0.0 | -
| query.is_celebrating_special | -Returns 1.0 if the entity is doing a special celebration, else it returns 0.0 | -
| query.is_charged | -Returns 1.0 if the entity is charged, else it returns 0.0 | -
| query.is_charging | -Returns 1.0 if the entity is charging, else it returns 0.0 | -
| query.is_chested | -Returns 1.0 if the entity has chests attached to it, else it returns 0.0 | -
| query.is_critical | -Returns 1.0 if the entity is critical, else it returns 0.0 | -
| query.is_dancing | -Returns 1.0 if the entity is dancing, else it returns 0.0 | -
| query.is_delayed_attacking | -returns 1.0 if the entity is attacking using the delayed attack, else it returns 0.0 | -
| query.is_eating | -Returns 1.0 if the entity is eating, else it returns 0.0 | -
| query.is_elder | -Returns 1.0 if the entity is an elder version of it, else it returns 0.0 | -
| query.is_emoting | -Returns 1.0 if the entity is emoting, else it returns 0.0 | -
| query.is_enchanted | -Returns 1.0 if the entity is enchanted, else it returns 0.0 | -
| query.is_fire_immune | -Returns 1.0 if the entity is immune to fire, else it returns 0.0 | -
| query.is_first_person | -Returns 1.0 if the entity is being rendered in first person mode, else it returns 0.0 | -
| query.is_ghost | -returns 1.0 if an entity is a ghost, else it returns 0.0 | -
| query.is_gliding | -Returns 1.0 if the entity is gliding, else it returns 0.0 | -
| query.is_grazing | -Returns 1.0 if the entity is grazing, or 0.0 if not | -
| query.is_idling | -Returns 1.0 if the entity is idling, else it returns 0.0 | -
| query.is_ignited | -Returns 1.0 if the entity is ignited, else it returns 0.0 | -
| query.is_illager_captain | -Returns 1.0 if the entity is an illager captain, else it returns 0.0 | -
| query.is_in_contact_with_water | -Returns 1.0 if the entity is in contact with any water (water, rain, splash water bottle), else it returns 0.0 | -
| query.is_in_love | -Returns 1.0 if the entity is in love, else it returns 0.0 | -
| query.is_in_ui | -Returns 1.0 if the entity is rendered as part of the UI, else it returns 0.0 | -
| query.is_in_water | -Returns 1.0 if the entity is in water, else it returns 0.0 | -
| query.is_in_water_or_rain | -Returns 1.0 if the entity is in water or rain, else it returns 0.0 | -
| query.is_interested | -Returns 1.0 if the entity is interested, else it returns 0.0 | -
| query.is_invisible | -Returns 1.0 if the entity is invisible, else it returns 0.0 | -
| query.is_item_equipped | -takes one optional hand slot as a parameter (0 or 'main_hand' for main hand, 1 or 'off_hand' for off hand), and returns 1.0 if there is an item in the requested slot (defaulting to the main hand if no parameter is supplied), otherwise returns 0.0. | -
| query.is_jumping | -Returns 1.0 if the entity is in water or rain, else it returns 0.0 | -
| query.is_laying_down | -Returns 1.0 if the entity is laying down, else it returns 0.0 | -
| query.is_laying_egg | -Returns 1.0 if the entity is laying an egg, else it returns 0.0 | -
| query.is_leashed | -Returns 1.0 if the entity is leashed to something, else it returns 0.0 | -
| query.is_levitating | -Returns 1.0 if the entity is levitating, else it returns 0.0 | -
| query.is_lingering | -Returns 1.0 if the entity is lingering, else it returns 0.0 | -
| query.is_moving | -Returns 1.0 if the entity is moving, else it returns 0.0 | -
| query.is_on_fire | -returns 1.0 if the entity is on fire, else it returns 0.0 | -
| query.is_on_ground | -Returns 1.0 if the entity is on the ground, else it returns 0.0 | -
| query.is_on_screen | -returns 1.0 if this is called on an entity at a time when it is known if it is on screen, else it returns 0.0 | -
| query.is_onfire | -Returns 1.0 if the entity is on fire, else it returns 0.0 | -
| query.is_orphaned | -Returns 1.0 if the entity is orphaned, else it returns 0.0 | -
| query.is_persona_or_premium_skin | -Returns 1.0 if the player has a persona or permium skin, else it returns 0.0 | -
| query.is_playing_dead | -Returns 1.0 if the entity is playing dead, else it returns 0.0 | -
| query.is_powered | -Returns 1.0 if the entity is powered, else it returns 0.0 | -
| query.is_pregnant | -Returns 1.0 if the entity is pregnant, else it returns 0.0 | -
| query.is_ram_attacking | -Returns 1.0 if the entity is using a ram attack, else it returns 0.0 | -
| query.is_resting | -Returns 1.0 if the entity is resting, else it returns 0.0 | -
| query.is_riding | -Returns 1.0 if the entity is riding, else it returns 0.0 | -
| query.is_roaring | -returns 1.0 if the entity is currently roaring, else it returns 0.0 | -
| query.is_rolling | -Returns 1.0 if the entity is rolling, else it returns 0.0 | -
| query.is_saddled | -Returns 1.0 if the entity has a saddle, else it returns 0.0 | -
| query.is_scared | -Returns 1.0 if the entity is scared, else it returns 0.0 | -
| query.is_selected_item | -returns true if the player has selected an item in the inventory, else it returns 0.0 | -
| query.is_shaking | -Returns 1.0 if the entity is casting, else it returns 0.0 | -
| query.is_shaking_wetness | -returns 1.0 if the entity is shaking water off, else it returns 0.0 | -
| query.is_sheared | -Returns 1.0 if the entity is able to be sheared and is sheared, else it returns 0.0 | -
| query.is_shield_powered | -Returns 1.0f if the entity has an active powered shield if it makes sense, else it returns 0.0 | -
| query.is_silent | -Returns 1.0 if the entity is silent, else it returns 0.0 | -
| query.is_sitting | -Returns 1.0 if the entity is sitting, else it returns 0.0 | -
| query.is_sleeping | -Returns 1.0 if the entity is sleeping, else it returns 0.0 | -
| query.is_sneaking | -Returns 1.0 if the entity is sneaking, else it returns 0.0 | -
| query.is_sneezing | -Returns 1.0 if the entity is sneezing, else it returns 0.0 | -
| query.is_sprinting | -Returns 1.0 if the entity is sprinting, else it returns 0.0 | -
| query.is_stackable | -Returns 1.0 if the entity is stackable, else it returns 0.0 | -
| query.is_stalking | -Returns 1.0 if the entity is stalking, else it returns 0.0 | -
| query.is_standing | -Returns 1.0 if the entity is standing, else it returns 0.0 | -
| query.is_stunned | -returns 1.0 if the entity is currently stunned, else it returns 0.0 | -
| query.is_swimming | -Returns 1.0 if the entity is swimming, else it returns 0.0 | -
| query.is_tamed | -Returns 1.0 if the entity is tamed, else it returns 0.0 | -
| query.is_transforming | -Returns 1.0 if the entity is transforming, else it returns 0.0 | -
| query.is_using_item | -Returns 1.0 if the entity is using an item, else it returns 0.0 | -
| query.is_wall_climbing | -Returns 1.0 if the entity is climbing a wall, else it returns 0.0 | -
| query.item_in_use_duration | -Returns the amount of time an item has been in use in seconds up to the maximum duration, else 0.0 if it doesn't make sense | -
| query.item_is_charged | -takes one optional hand slot as a parameter (0 or 'main_hand' for main hand, 1 or 'off_hand' for off hand), and returns 1.0 if the item is charged in the requested slot (defaulting to the main hand if no parameter is supplied), otherwise returns 0.0. | -
| query.item_max_use_duration | -Returns the maximum amount of time the item can be used, else 0.0 if it doesn't make sense | -
| query.item_remaining_use_duration | -Returns the amount of time an item has left to use, else 0.0 if it doesn't make sense. Item queried is specified by the slot name 'main_hand' or 'off_hand'. Time remaining is normalized using the normalization value, only if one is given, else it is returned in seconds. | -
| query.item_slot_to_bone_name | -query.item_slot_to_bone_name requires one parameter: the name of the equipment slot. This function returns the name of the bone this entity has mapped to that slot. | -
| query.key_frame_lerp_time | -Returns the ratio between the previous and next key frames | -
| query.last_frame_time | -Returns the time in *seconds* of the last frame. If an argument is passed, it is assumed to be the number of frames in the past that you wish to query. 'query.last_frame_time' (or the equivalent 'query.last_frame_time(0)') will return the frame time of the frame before the current one. 'query.last_frame_time(1)' will return the frame time of two frames ago. Currently we store the history of the last 30 frames, although note that this may change in the future. Passing an index more than the available data will return the oldest frame stored. | -
| query.last_hit_by_player | -Returns 1.0 if the entity was last hit by the player, else it returns 0.0. If called by the client always returns 0.0 | -
| query.lie_amount | -Returns the lie down amount for the entity | -
| query.life_span | -returns the limited life span of an entity, or 0.0 if it lives forever | -
| query.life_time | -Returns the time in seconds since the current animation started, else 0.0 if not called within an animation | -
| query.lod_index | -Takes an array of distances and returns the zero - based index of which range the actor is in based on distance from the camera.For example, 'query.lod_index(10, 20, 30)' will return 0, 1, or 2 based on whether the mob is less than 10, 20, or 30 units away from the camera, or it will return 3 if it is greater than 30. | -
| query.log | -debug log a value to the content log | -
| query.main_hand_item_max_duration | -Returns the use time maximum duration for the main hand item if it makes sense, else it returns 0.0 | -
| query.main_hand_item_use_duration | -Returns the use time for the main hand item. | -
| query.mark_variant | -Returns the entity's mark variant | -
| query.max_durability | -Returns the max durability an item can take | -
| query.max_health | -Returns the maximum health of the entity, or 0.0 if it doesn't make sense to call on this entity. | -
| query.max_trade_tier | -Returns the maximum trade tier of the entity if it makes sense, else it returns 0.0 | -
| query.maximum_frame_time | -Returns the time in *seconds* of the most expensive frame over the last 'n' frames. If an argument is passed, it is assumed to be the number of frames in the past that you wish to query. 'query.maximum_frame_time' (or the equivalent 'query.maximum_frame_time(0)') will return the frame time of the frame before the current one. 'query.maximum_frame_time(1)' will return the maximum frame time of the previous two frames. Currently we store the history of the last 30 frames, although note that this may change in the future. Asking for more frames will result in only sampling the number of frames stored. | -
| query.minimum_frame_time | -Returns the time in *seconds* of the least expensive frame over the last 'n' frames. If an argument is passed, it is assumed to be the number of frames in the past that you wish to query. 'query.minimum_frame_time' (or the equivalent 'query.minimum_frame_time(0)') will return the frame time of the frame before the current one. 'query.minimum_frame_time(1)' will return the minimum frame time of the previous two frames. Currently we store the history of the last 30 frames, although note that this may change in the future. Asking for more frames will result in only sampling the number of frames stored. | -
| query.model_scale | -Returns the scale of the current entity | -
| query.modified_distance_moved | -Returns the total distance the entity has moved horizontally in meters (since the entity was last loaded, not necessarily since it was originally created) modified along the way by status flags such as is_baby or on_fire | -
| query.modified_move_speed | -Returns the current walk speed of the entity modified by status flags such as is_baby or on_fire | -
| query.moon_brightness | -Returns the brightness of the moon (FULL_MOON=1.0, WANING_GIBBOUS=0.75, FIRST_QUARTER=0.5, WANING_CRESCENT=0.25, NEW_MOON=0.0, WAXING_CRESCENT=0.25, LAST_QUARTER=0.5, WAXING_GIBBOUS=0.75). | -
| query.moon_phase | -Returns the phase of the moon (FULL_MOON=0, WANING_GIBBOUS=1, FIRST_QUARTER=2, WANING_CRESCENT=3, NEW_MOON=4, WAXING_CRESCENT=5, LAST_QUARTER=6, WAXING_GIBBOUS=7). | -
| query.movement_direction | -returns the specified axis of the normalized position delta of the entity | -
| query.noise | -Queries Perlin Noise Map | -
| query.on_fire_time | -returns the time that the entity is on fire, else it returns 0.0 | -
| query.out_of_control | -Returns 1.0 if the entity is out of control, else it returns 0.0 | -
| query.overlay_alpha | -Do not use - this function is deprecated and will be removed | -
| query.owner_identifier | -Returns the root actor identifier | -
| query.player_level | -returns the players level if the actor is a player, otherwise returns 0 | -
| query.position | -Returns the absolute position of an actor. Takes one argument that represents the desired axis (0 == x-axis, 1 == y-axis, 2 == z-axis). | -
| query.position_delta | -Returns the position delta for an actor. Takes one argument that represents the desired axis (0 == x-axis, 1 == y-axis, 2 == z-axis). | -
| query.previous_squish_value | -Returns the previous squish value for the current entity, or 0.0 if this doesn't make sense | -
| query.remaining_durability | -Returns the how much durability an item has remaining | -
| query.roll_counter | -Returns the roll counter of the entity | -
| query.rotation_to_camera | -Returns the rotation required to aim at the camera. Requires one argument representing the rotation axis you would like (0 for x, 1 for y) | -
| query.shake_angle | -returns the shaking angle of the entity if it makes sense, else it returns 0.0 | -
| query.shake_time | -Returns the shake time of the entity. | -
| query.shield_blocking_bob | -Returns the how much the offhand shield should translate down when blocking and being hit. | -
| query.show_bottom | -Returns 1.0 if we render the entity's bottom, else it returns 0.0 | -
| query.sit_amount | -Returns the current sit amount of the entity | -
| query.skin_id | -Returns the entity's skin ID | -
| query.sleep_rotation | -returns the rotation of the bed the player is sleeping on. | -
| query.sneeze_counter | -Returns the sneeze counter of the entity | -
| query.spellcolor | -Returns a struct representing the entity spell colour for the specified entity. The struct contains '.r' '.g' '.b' and '.a' members, each 0.0 to 1.0. If no actor is specified, each member value will be 0.0 | -
| query.standing_scale | -Returns the scale of how standing up the entity is | -
| query.structural_integrity | -returns the structural integrity for the actor, otherwise returns 0 | -
| query.swell_amount | -Returns how swollen the entity is | -
| query.swelling_dir | -Returns the swelling direction of the entity if it makes sense, else it returns 0.0 | -
| query.swim_amount | -Returns the amount the current entity is swimming | -
| query.tail_angle | -returns the angle of the tail of the entity if it makes sense, else it returns 0.0 | -
| query.target_x_rotation | -Returns the x rotation required to aim at the entity's current target if it has one, else it returns 0.0 | -
| query.target_y_rotation | -Returns the y rotation required to aim at the entity's current target if it has one, else it returns 0.0 | -
| query.texture_frame_index | -Returns the icon index of the experience orb | -
| query.time_of_day | -Returns the time of day (midnight=0.0, sunrise=0.25, noon=0.5, sunset=0.75) of the dimension the entity is in. | -
| query.time_stamp | -Returns the current time stamp of the level | -
| query.total_emitter_count | -Returns the total number of active emitters in the world | -
| query.total_particle_count | -Returns the total number of active particles in the world | -
| query.trade_tier | -Returns the trade tier of the entity if it makes sense, else it returns 0.0 | -
| query.unhappy_counter | -Returns how unhappy the entity is | -
| query.variant | -Returns the entity's variant index | -
| query.vertical_speed | -Returns the speed of the entity up or down in metres/second, where positive is up | -
| query.walk_distance | -Returns the walk distance of the entity. | -
| query.wing_flap_position | -Returns the wing flap position of the entity, or 0.0 if this doesn't make sense | -
| query.wing_flap_speed | -Returns the wing flap speed of the entity, or 0.0 if this doesn't make sense | -
| query.yaw_speed | -Returns the entity's yaw speed | -
List of Experimental Entity Queries
- - - -| Name | Description |
|---|---|
| query.actor_property | -(EXPERIMENTAL. Enable 'Holiday Creator Features' AND 'Upcoming Creator Features' to use.) Takes one argument: the name of the property on the entity. Returns the value of that property if it exists, else 0.0 if not. | -
| query.biome_has_all_tags | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes either no position (assumes the current entity position) or three parameters: x, y, z (representing the world-origin-relative position), followed by whatever tags you want to query for, and returns 1 if all of them exist in the biome, else it returns 0. Eg: query.biome_has_all_tags('is_cold', 'has_trees') | -
| query.biome_has_any_tag | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes either no position (assumes the current entity position) or three parameters: x, y, z (representing the world-origin-relative position), followed by whatever tags you want to query for, and returns 1 if any of them exist in the biome, else it returns 0. Eg: query.biome_has_any_tag('is_cold', 'has_trees') | -
| query.block_has_all_tags | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes an world-origin-relative position and one or more tag names, and returns either 0 or 1 based on if the block at that position has all of the tags provided | -
| query.block_has_any_tag | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes a world-origin-relative position and one or more tag names, and returns either 0 or 1 based on if the block at that position has any of the tags provided | -
| query.block_neighbor_has_all_tags | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes a block-relative position and one or more tag names, and returns either 0 or 1 based on if the block at that position has all of the tags provided | -
| query.block_neighbor_has_any_tag | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes a block-relative position and one or more tag names, and returns either 0 or 1 based on if the block at that position has any of the tags provided | -
| query.bone_orientation_matrix | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes the name of the bone as an argument. Returns the bone orientation (as a matrix) of the desired bone provided it exists in the queryable geometry of the mob, else this returns the identity matrix and throws a content error. | -
| query.bone_orientation_trs | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) TRS stands for Translate/Rotate/Scale. Takes the name of the bone as an argument. Returns the bone orientation matrix decomposed into the component translation/rotation/scale parts of the desired bone provided it exists in the queryable geometry of the mob, else this returns the identity matrix and throws a content error. The returned value is returned as a variable of type 'struct' with members '.t', '.r', and '.s', each with members '.x', '.y', and '.z', and can be accessed as per the following example: v.my_variable = q.bone_orientation_trs('rightarm'); return v.my_variable.r.x; | -
| query.client_input_type | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns either 'mouse', 'touch', 'gamepad', or 'motion_controller' depending on the type of input used by the current client. | -
| query.cooldown_time | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns the total cooldown time in seconds for the item held or worn by the specified equipment slot name (and optional second numerical slot id), otherwise returns 0. Uses the same name and id that the replaceitem command takes when querying entities. | -
| query.cooldown_time_remaining | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns the cooldown time remaining in seconds for specified cooldown type or the item held or worn by the specified equipment slot name (and optional second numerical slot id), otherwise returns 0. Uses the same name and id that the replaceitem command takes when querying entities. Returns highest cooldown if no parameters are supplied. | -
| query.get_nearby_entities | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns the list of entities within the specified distance, taking an optional second argument as a filter for which mob types to accept (eg: 'minecraft:pig'). | -
| query.get_nearby_entities_except_self | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns the list of entities within the specified distance, taking an optional second argument as a filter for which mob types to accept (eg: 'minecraft:pig'). | -
| query.get_ride | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns the entity this entity is riding if it is riding something, else it returns 0 | -
| query.get_riders | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns the array of entities that are riding this entity | -
| query.has_actor_property | -(EXPERIMENTAL. Enable 'Holiday Creator Features' AND 'Upcoming Creator Features' to use.) Takes one argument: the name of the property on the Actor. Returns 1.0 if a property with the given name exists, 0 otherwise. | -
| query.has_player_rider | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns 1 if the entity has a player riding it, else it returns 0 | -
| query.is_attached | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns 1.0 if the actor is attached to another actor (such as being held or worn), else it will return 0.0 | -
| query.is_cooldown_type | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns 1.0 if the specified held or worn item has the specified cooldown type name, otherwise returns 0.0. First argument is the cooldown name to check for, second argument is the equipment slot name, and optional third argument is the numerical slot id. For second and third arguments, uses the same name and id that the replaceitem command takes when querying entities. | -
| query.relative_block_has_all_tags | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes an entity-relative position and one or more tag names, and returns either 0 or 1 based on if the block at that position has all of the tags provided | -
| query.relative_block_has_any_tag | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes an entity-relative position and one or more tag names, and returns either 0 or 1 based on if the block at that position has any of the tags provided | -
| query.scoreboard | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Takes one argument - the name of the scoreboard entry for this entity. Returns the specified scoreboard value for this entity. | -
| query.self | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns the current entity | -
| query.target | -(EXPERIMENTAL. Enable 'Experimental Molang Features' to use.) Returns the target of the current entity if one exists | -
Experimental Operators
- -Some operators may be behind experimental gameplay toggles (see list below). After getting feedback, we can adjust them further or move them into general availability.- (There are currently no Experimental Operators)Back to topVersioned Changes
- -Molang uses the `"min_engine_version"` from the `manifest.json` of the resource or behavior pack that contains each Molang expression to determine which version of the rules to apply. This allows for changes to how Molang works without breaking existing content. Molang Versioned Change versions apply to each expression separately, so it's possible to have different versions active if multiple packs are loaded. This is a list of the Versioned Changes that have been added, along with the corresponding game version. To know which Versioned Changes are in effect, look at the `"min_engine_version"` of the `manifest.json` of the resource or behavior pack that contains your Molang expression. Any Versioned Change with a version less than or equal to that version number will be in effect.Versioned Change Versions
- - - -| Pack min_engine_version | Description |
|---|---|
| 1.17.0 | -Initial support for Versioned Changes added. (Not actually a Versioned Change) | -
| 1.17.30 | -Fixed query.item_remaining_use_duration conversion from ticks to seconds (multiplied by 20 instead of dividing). Also fixed normalization logic in that query to go from 1 down to 0 instead of 0 up to 1. | -
| 1.17.40 | -Added some new error messages for invalid expressions which previously ran with probably unexpected results. For example "'text' + 1" will now cause a content error. | -
Index
-Back to top -Basic Structure Overview
- -Particle effects consist of basic render parameters, and a set of components. Components can be placed in any order. -Outline:Component Concept
- -The particle system is component based. What this means is that particle effects are composed via a set of components. In order for an effect to do something, you add a component that handles that aspect of the effect. For example, an emitter usually needs to have rules for its lifetime, thus the effect should have one or more lifetime components that handle lifetime duties for the emitter and emitted particles.The idea is that new components can be added later, and one can combine components (where it makes sense) to get different behaviors. A particle might have a Dynamic component for moving around, and a Collision component for handling interaction with the terrain, for example.Think of components as telling the particle system what you want the emitter or particle to do, rather than exposing a list of particle parameters and having to wrangle those parameters to get the desired behavior.Back to topCurrent Component List
- - -For fields in these components, the following shorthand is used:Emitter Components
- - - -Emitter Lifetime Components
- - - -Emitter Lifetime Events component
- -Allows for lifetime events on the emitter to trigger certain events. -Emitter Lifetime Expression component
- -Emitter will turn 'on' when the activation expression is non-zero, and will turn 'off' when it's zero. This is useful for situations like driving an entity-attached emitter from an entity variable. -Emitter Lifetime Looping component
- -Emitter will loop until it is removed. -Emitter Lifetime Once component
- -Emitter will execute once, and once the lifetime ends or the number of particles allowed to emit have emitted, the emitter expires. -Emitter Rate Components
- - - -Emitter Rate Instant component
- -All particles come out at once, then no more unless the emitter loops. -Emitter Rate Manual component
- -Particle emission will occur only when the emitter is told to emit via the game itself. This is mostly used by legacy particle effects. -Emitter Rate Steady component
- -Particles come out at a steady or Molang rate over time. -Emitter Shape Components
- -Shape controls both where the particles are emitted from and the initial direction of the particles. - -Emitter Disc component
- -This component spawns particles using a disc shape, particles can be spawned inside the shape or on its outer perimeter. -Emitter Shape Box component
- -All particles come out of a box of the specified size from the emitter. -Emitter Shape Custom component
- -All particles are emitted based on a specified set of Molang expressions. -Emitter Shape Entity-AABB component
- -All particles come out of the axis-aligned bounding box (AABB) for the entity the emitter is attached to, or the emitter point if no entity. -Emitter Shape Point component
- -All particles come out of a point offset from the emitter. -Emitter Shape Sphere component
- -All particles come out of a sphere offset from the emitter. -Initial State Components
- - - -Emitter Initialization component
- -This component allows the emitter to run some Molang at creation, primarily to populate any Molang variables that get used later. -Emitter Local Space component
- -This component specifies the frame of reference of the emitter. Applies only when the emitter is attached to an entity. When 'position' is true, the particles will simulate in entity space, otherwise they will simulate in world space. Rotation works the same way for rotation. Default is false for both, which makes the particles emit relative to the emitter, then simulate independently from the emitter. Note that rotation = true and position = false is an invalid option. Velocity will add the emitter's velocity to the initial particle velocity. -Particle Components
- - - -Particle Appearance Components
- - - -Particle Appearance Billboard component
- -This component tells the particle system to render the particle as a billboard, a rectangle in the world facing a particluar direction. -Particle Appearance Lighting
- -When this component exists, particle will be tinted by local lighting conditions in-game. -Particle Appearance Tinting component
- -Color tinting of the particle is controlled by this component: -Particle Initial State Components
- - - -Particle Initial Speed component
- -Starts the particle with a specified speed, using the direction specified by the emitter shape. -Particle Initial State component
- -Starts the particle with a specified orientation and rotation rate. -Particle Lifetime Components
- - - -Particle Expire If In Blocks component
- -Particles expire when in a block of the type in the list. Note: this component can exist alongside particle_lifetime_expression. -Particle Expire If Not In Blocks component
- -Particles expire when in a block of the type not in the list. Note: this component can exist alongside particle_lifetime_expression. -Particle Lifetime Events component
- -This component allows for triggering events based on various lifetime events. -Particle Lifetime Expression component
- -Standard lifetime component. These expressions control the lifetime of the particle. -Particle Lifetime Kill-Plane component
- -Particles that cross this plane expire. The plane is relative to the emitter, but oriented in world space. The four parameters are the usual 4 elements of a plane equation. -Particle Motion Components
- - - -Particle Motion Collision component
- -This component enables collisions between the terrain and the particle. Collision detection in Minecraft consists of detecting an intersection, moving to a nearby non-intersecting point for the particle (if possible), and setting its direction to not be aimed towards the collision (usually perpendicular to the collision surface). Note that if this component doesn't exist, there will be no collision. -Particle Motion Dynamic component
- -This component specifies the dynamic properties of the particle, from a simulation standpoint what forces act upon the particle? These dynamics alter the velocity of the particle, which is a combination of the direction of the particle and the speed. Particle direction will always be in the direction of the velocity of the particle. -Particle Motion Parametric component
- -This component directly controls the particle. Note that this component won't work for either manually-emitted particles, or entity-based particle emitters that aren't in local space. -Curves
- -Curves are interpolation values, with inputs from 0 to 1, and outputs based on the curve. The result of the curve is a Molang variable of the same name that can be referenced in Molang in components. For each rendering frame for each particle, the curves are evaluated and the result is placed in a Molang variable of the name of the curve. -Events
- -Events can be triggered elsewhere in the .json and fire off new particle and sound effects.Particle effects have different types. If the type is "emitter", this will create an emitter of "effect" type at the event's world position, in a fire-and-forget way. "emitter_bound" works similarly, except if the spawning emitter is bound to an actor/locator, the new emitter will be bound to the same actor/locator. If the type is "particle", then the event will manually emit a particle on an emitter of "effect" type at the event location, creating the emitter if it doesn't already exist (be sure to use "minecraft:emitter_rate_manual" for the spawned emitter effect). "particle_with_velocity" will do the same as "particle" except the new particle will inherit the spawning particle's velocity.Sound effects specify the specific "level sound event" to be played when the event fires.The events themselves consist of an optional node tree and/or an actual event. When "sequence" is specified, that array will execute in order, with every element executing when that event fires. When using "random", one element will be picked from the array based on the weight. -Examples
- -Bouncing Bubbles
- -This particle effect generates a bunch of bubbles that bounce around. -Flame particle
- -This particle is the little flame that appears on torches and furnaces to indicate fire. It is a simple particle, consisting of a non-moving flame, with some variations. Note the use of Molang to create variations in the particle behavior.In addition, the use of texturewidth/height in the UV section of the billboard component allows referencing of UVs via texels: -Mob Flame effect
- -The mob flame effect is used by the Blaze when it's charging up to hurl fireballs. This is a flipbook flame effect that rises over time.Unlike the earlier particles, this is a regular emitter. It is tied to an entity, thus uses the entity_aabb shape, as we want the flames to appear all over the blaze. As the effect is tied to the charged state, the activation expression is used, tied to the EntityFlag::CHARGED entity variable. This causes the flames to appear when the Blaze is charging, then to disappear when it isn't.In this case, we use the texturewidth/height to make the texel "resolution" be one frame of animation, thus allowing advancement of the frames to be just 1: -Smoke particle
- -This particle is the general-purpose smoke puff. It appears on torches, furnaces, Blazes, etc. It is a simple particle with an upward motion consisting of an upwards acceleration tempered by drag. The main feature of this particle different from the flame particle is the flipbook texture animation. See the details in the particle below, but the effect uses a flipbook subpart of the billboard appearance component to drive uv coordinates from frame to frame over time.In addition, the use of texturewidth/height in the UV section of the billboard component allows referencing of UVs via texels for the flipbook: -Molang integration
- -Where it makes sense, any field can use a Molang expression. Molang expressions are strings, and are defined in the Molang documentation. The particle system uses some special Molang variables that particle Molang expressions can use. Additionally, custom Molang paramaters can be set in various ways and used in Molang expressions in effects. - -| Name | Description |
|---|---|
| variable.emitter_age | -Age since the current loop started for the emitter | -
| variable.emitter_lifetime | -How long the current loop lasts for the emitter | -
| variable.emitter_random_1 | -A random from 0.0 to 1.0 that is constant for the current loop of the emitter | -
| variable.emitter_random_2 | -Another random from 0.0 to 1.0 that is constant for the current loop of the emitter | -
| variable.emitter_random_3 | -A third random from 0.0 to 1.0 that is constant for the current loop of the emitter | -
| variable.emitter_random_4 | -A fourth random from 0.0 to 1.0 that is constant for the current loop of the emitter | -
| variable.entity_scale | -When the effect is attached to an entity, this value is the scale of the entity | -
| variable.particle_age | -How long the particle has lived | -
| variable.particle_lifetime | -How long the particle lives for | -
| variable.particle_random_1 | -A random from 0.0 to 1.0 that is constant for the lifetime of the particle | -
| variable.particle_random_2 | -Another random from 0.0 to 1.0 that is constant for the lifetime of the particle | -
| variable.particle_random_3 | -A third random from 0.0 to 1.0 that is constant for the lifetime of the particle | -
| variable.particle_random_4 | -A fourth random from 0.0 to 1.0 that is constant for the lifetime of the particle | -
Namespacing
- -All particle effects should be namespaced (in their name).Namespacing involves adding a 'name:' prefix on the effect tag.Regular Minecraft will use the 'minecraft: prefix. See the examples for example names.Back to topParticles Entity Integration
- -One of the primary uses for emitting particles in the Bedrock engine is particles associated with entities, such as mobs. Examples can be when the Blaze flames-up during it's attack sequence, or the Evoker's spell effect while summoning Vexes. The goal is to allow binding and management of particle effects attached to entities.The following concepts are important for managing particles with entities via .json:- Effect lists. These live in the resource definition of the entity's .json, along with textures, etc. These list the effects available to the entity, with an internal entity name for the effect, and the associated effect to play.- Locators. These live in the geometry files, and specify a location in the geometry. These locators can be associated with bones, and thus follow the bone as it animates.- Animation controller-based particle management. Using the Animation Controller state machine concept, one can trigger both fire-and-forget and sustained particle effects- Animation timeline particle management. As part of an animation .json for the entity, one can set up a timeline that triggers particle effects at specified times while the animation is playing. Note that an actual physical animation is not needed, just the animation .json structure.Particles that are attached to entities are intrinsically tied to those entities. If the entity ceases to exist, the particle effects cease as well. Emitters follow either the entity, or a locator on the entity.time1/time2/etc are numerical time points, e.g. "0.0". In this example, when the cat sits down, after 3 seconds a smoke puff is generated: -Animation Controller effects
- -Animation controllers can specify effect events for their states. This allows for a list of particle effects to be started upon state entry, and for those particle effects to be automatically ended when leaving the state. For particles that don't terminate (or don't terminate prior to state transition), they will be terminated at state exit.The schema is:"particle_effects": [ // array of effect events]The array syntax allows for more than one effect to be triggered on state entry.An example is the Blaze's flame-up effect in it's animation controller. This animation controller has two states, "default" and "flaming". It transitions between the two via the "query.is_charged" entity flag check. When in the "flaming" state, the "charged_flames" effect is started (with no locator or initialization Molang expression), and is terminated when the state exits. -Animation Timeline effects
- -Animations can also trigger particle effects. These are fire-and-forget effects that are tied to a timeline, when the animation hits that time point, the effect(s) are fired. -Effect Event
- -Particle events in the entity have the following properties:- "effect" is the effect name specified in the entity's resource definition .json (the particle effect list), this specifies what particle effect to start/play- "locator" is an optional parameter that maps to a locator of the same name in the resource definition. By specifying a locator, the emitter will follow that locator around as the entity animates, including orientation. If this is not specified, the effect will occur at the origin of the entity.- "pre_effect_script" is an optional parameter that is a Molang expression run at emitter startup time. This can set up Molang variables, (for example 'particle color'), which can be then referred to inside the particle effect .json itself. -Effect List
- -The effect list is a list of internal effect names to actual particle effects bindings. This is the general form for adding particle effects to an entity. The effect list consists of a list of shorthand names to actual effects. All references to effects will use the shorthand name in animations and animation controllers. Note that this by itself will not cause the particle effect to appear. -Particles Examples Pack
- -https://aka.ms/MCParticlesPackExamples of various particles can be found in the link above. These are examples of various stand-alone particle effects. The particle effects provided as part of the Minecraft installation are tuned to be used with the Minecraft game, and thus do not serve as good examples. Please refer to the examples in the pack to see various ways to utilize the particle system. To invoke an example particle with the examples particles pack enabled, bring up the console, type "/particle name x y z" where "name" is the name of the particle effect, and x/y/z are the coordinates the particle appears at.For example, "/particle minecraft:example_smoke_puff 0 5 0" will spawn a smoke puff at the origin of the world, 5 blocks up from the bottom of the world. "/particle minecraft:example_smoke_puff ~ ~1 ~5" will create that smoke puff about 5 blocks away from the player.| Name | Description |
|---|---|
| minecraft:example_bezier_chaincurve | -Demonstrates the use of a bezier chain curve in an effect | -
| minecraft:example_beziercurve | -Demonstrates the use of a bezier curve in an effect | -
| minecraft:example_bounce | -Demonstrates collision detection and bouncing for particles | -
| minecraft:example_catmullromcurve | -Demonstrates the use of a catmull-rom curve in an effect | -
| minecraft:example_colorcurve | -Demonstrates the use of a color-gradient approach to color variation in an effect | -
| minecraft:example_colorcurve2 | -Demonstrates the use of a color-gradient approach with variable spacing in an effect | -
| minecraft:example_combocurve | -Demonstrates the use of a variety of curves in an effect | -
| minecraft:example_directional_sphere | -Demonstrates the use of directional billboard facing in an effect | -
| minecraft:example_entity_sparkle_aabb | -When attached to an entity, this effect creates a sparkle effect with the rough axis-aligned bounding box around the entity | -
| minecraft:example_entity_sparkle_box | -When attached to an entity, this effect creates a sparkle effect in a box around the entity | -
| minecraft:example_expire_on_contact | -Demonstrates particles disappearing when colliding with the terrain | -
| minecraft:example_flipbook | -Demonstrates texture uv flipbook technique, of applying successive frames of a texture for visual animation | -
| minecraft:example_highrestitution | -Demonstrates particle collision with particles gaining energy on each bounce | -
| minecraft:example_linearcurve | -Demonstrates a piecewise linear curve in an effect | -
| minecraft:example_particle_event_system | -Demonstrates various particle events executing | -
| minecraft:example_smoke_puff | -Demonstrates a general smoke puff effect | -
| minecraft:example_spiral | -Demonstrates a parametric motion spiral effect | -
| minecraft:example_watertest | -Demonstrates excluding particles from various block types, in this case, particles only survive in water | -
| minecraft:fireworks_events_demo | -Demonstrates sequencing various particle effects together via events to create a fireworks effect | -
Structure In Detail
- - -Outline:Index
-| Recipes |
|---|
| Furnace Recipe |
| Potion Brewing Container Recipe |
| Potion Brewing Mix |
| Shaped Recipe |
| Shapeless Recipe |
Recipes
- -Recipes are setup in Json files under the behavior_packs /'name of pack'/ recipes directory.Recipe JSON files have different structures dependent on their type.There are 3 types of recipes, Furnace, Shaped and Shapeless.Furnace Recipe
- -Represents a furnace recipe for a furnace.'Input' items will burn and transform into items specified in 'output'.. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| input | -item names | -Items used as input for the furnace recipe. | -
| output | -item names | -Items used as output for the furnace recipe. | -
Potion Brewing Container Recipe
- -Represents a Potion Brewing Container Recipe.. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| input | -potion | -input potion used in the brewing container recipe. | -
| output | -potion | -output potion from the brewing container recipe. | -
| reagent | -item | -item used in the brewing container recipe with the input potion. | -
| tags | -array of strings | -Item used in a Brewing Container Recipe. | -
Potion Brewing Mix
- -Represents a Potion Brewing Mix.. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| input | -potion | -input potion used on the brewing stand. | -
| output | -potion | -output potion from mixing the input potion with the reagent on the brewing stand. | -
| reagent | -item | -item used to mix with the input potion. | -
| tags | -array of strings | -Item used to make a brewing mix. | -
Shaped Recipe
- -Represents a shaped crafting recipe for a crafting table.The key used in the pattern may be any single character except the 'space' character, which is reserved for empty slots in a recipe.. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| key | -array of key and item pairs | -patten key character mapped to item names. | -
| pattern | -array of strings | -characters that represent a pattern to be defined by keys. | -
| priority | -integer | -Item used as output for the furnace recipe. | -
| result | -array of item names | -when input items match the pattern then these items are the result. | -
| tags | -array of strings | -Item used as input for the furnace recipe. | -
Shapeless Recipe
- -Represents a shapeless crafting recipe.. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| ingredients | -array of item names | -items used as input (without a shape) for the recipe. | -
| priority | -integer | -Item used as output for the furnace recipe. | -
| result | -array of item names | -these items are the result. | -
| tags | -array of strings | -Item used as input for the furnace recipe. | -
Index
-| Overview |
|---|
| Schemas |
Overview
- -These are the data format schemas for content creators to reference when editing or creating new content.Back to topSchemas
- -```--------item_event_responses:1.16.100:----------actor_animation:1.8.0:{ version "format_version" object "animations" { object "animation.Index
-Back to top -Script API Objects
- -Here you can find the definition of some objects returned by the script API.Block JS API Object
- - - -| Name | Type | Block JS API Object | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| __identifier__ | -String | -- | READ ONLY. This is the identifier for the object in the format namespace:name. For example, if the type is block and the object is representing a block of bedrock, the identifier would be minecraft:bedrock | -||||||||||||
| __type__ | -String | -- | READ ONLY. This defines the type of object. Will be: "block". | -||||||||||||
| block_position | -JavaScript Object | -- | READ ONLY. This is the position of the block and it functions as part of its unique identifier. Parameters - - - -
- - |
-||||||||||||
| ticking_area | -JavaScript Object | -- | READ ONLY. This is the ticking area object that was used to get this block. | -
Component JS API Object
- - - -| Name | Type | Component JS API Object | Description |
|---|---|---|---|
| __type__ | -String | -- | READ ONLY. This defines the type of object. Will be: "component". | -
| data | -JavaScript Object | -- | This is the content of the component. | -
Entity JS API Object
- - - -| Name | Type | Entity JS API Object | Description |
|---|---|---|---|
| __identifier__ | -String | -- | READ ONLY. This is the identifier for the object in the format namespace:name. For example, if the type is entity and the object is representing a vanilla cow, the identifier would be minecraft:cow | -
| __type__ | -String | -- | READ ONLY. This defines the type of object. Can be: "entity" or "item_entity". | -
| id | -Positive Integer | -- | READ ONLY. This is the unique identifier of the entity. | -
Entity Ticking Area JS API Object
- - - -| Name | Type | Entity Ticking Area JS API Object | Description |
|---|---|---|---|
| __type__ | -String | -- | READ ONLY. This defines the type of object. Will be: "entity_ticking_area". | -
| entity_ticking_area_id | -Positive Integer | -- | READ ONLY. This is the unique identifier of the ticking area. | -
ItemStack JS API Object
- - - -| Name | Type | ItemStack JS API Object | Description |
|---|---|---|---|
| __identifier__ | -String | -- | READ ONLY. This is the identifier for the object in the format namespace:name. For example, if the type is entity and the object is representing a vanilla cow, the identifier would be minecraft:cow | -
| __type__ | -String | -- | READ ONLY. This defines the type of object. Will be: "item_stack". | -
| count | -String | -- | READ ONLY. This is the number of items in the stack. | -
| item | -String | -- | READ ONLY. This is the identifier of the item. | -
Level JS API Object
- - - -| Name | Type | Level JS API Object | Description |
|---|---|---|---|
| __type__ | -String | -- | READ ONLY. This defines the type of object. Will be: "level". | -
| level_id | -Positive Integer | -- | READ ONLY. This is the unique identifier of the level. | -
Level Ticking Area JS API Object
- - - -| Name | Type | Level Ticking Area JS API Object | Description |
|---|---|---|---|
| __type__ | -String | -- | READ ONLY. This defines the type of object. Will be: "level_ticking_area". | -
| level_ticking_area_id | -String | -- | READ ONLY. This is the unique identifier of the ticking area. | -
Query JS API Object
- - - -| Name | Type | Query JS API Object | Description |
|---|---|---|---|
| __type__ | -String | -- | READ ONLY. This defines the type of object. Will be: "query". | -
| query_id | -Positive Integer | -- | READ ONLY. This is the unique identifier of the query. | -
Ticking Area JS API Object
- -There are two types of ticking area objects. Entity and Level. When a function calls for a ticking area it can take either type as an argument.Back to topScript Bindings
- -Bindings are the capabilities of the Minecraft Script Engine to change or modify things in the game.Block Bindings
- -These functions define how you interact with blocks. - -getBlock(Ticking Area, PositionObject)
- -Allows you to get a block from the world when provided a JavaScript object containing a position. The block must be within a ticking area. - -Parameters
- - - -| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PositionObject | -JavaScript Object | -A JavaScript object with the x, y, and z position of the block you want Parameters - - - -
- - |
-||||||||||||
| Ticking Area | -Ticking Area JS API Object | -The ticking area the block is in | -
Return Value
- - - -| Type | Value |
|---|---|
| Block JS API Object | -An object containing the block | -
getBlock(Ticking Area, x, y, z)
- -Allows you to get a block from the world when provided an x, y, and z position. The block must be within a ticking area. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| Ticking Area | -Ticking Area JS API Object | -The ticking area the block is in | -
| x | -Integer | -The x position of the block you want | -
| y | -Integer | -The y position of the block you want | -
| z | -Integer | -The z position of the block you want | -
Return Value
- - - -| Type | Value |
|---|---|
| - | object | -
| - | null | -
getBlocks(Ticking Area, Minimum PositionObject, Maximum PositionObject)
- -Allows you to get an array of blocks from the world when provided a minimum and maximum position. The blocks must be within a ticking area. This call can be slow if given a lot of blocks, and should be used infrequently. - -Parameters
- - - -| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Maximum PositionObject | -JavaScript Object | -A JavaScript object with the maximum x, y, and z position of the blocks you want Parameters - - - -
- - |
-||||||||||||
| Minimum PositionObject | -JavaScript Object | -A JavaScript object with the minimum x, y, and z position of the blocks you want Parameters - - - -
- - |
-||||||||||||
| Ticking Area | -Ticking Area JS API Object | -The ticking area the blocks are in | -
Return Value
- - - -| Type | Value |
|---|---|
| Array | -A 3D array of block objects. Indexs are the blocks positions relative to the min position given | -
| - | null | -
getBlocks(Ticking Area, x min, y min, z min, x max, y max, z max)
- -Allows you to get an array of blocks from the world when provided a minimum and maximum x, y, and z position. The blocks must be within a ticking area. This call can be slow if given a lot of blocks, and should be used infrequently. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| Ticking Area | -Ticking Area JS API Object | -The ticking area the blocks are in | -
| x max | -Integer | -The maximum x position of the blocks you want | -
| x min | -Integer | -The minimum x position of the blocks you want | -
| y max | -Integer | -The maximum y position of the blocks you want | -
| y min | -Integer | -The minimum y position of the blocks you want | -
| z max | -Integer | -The maximum z position of the blocks you want | -
| z min | -Integer | -The minimum z position of the blocks you want | -
Return Value
- - - -| Type | Value |
|---|---|
| - | array | -
| - | null | -
Component Bindings
- - - -applyComponentChanges(EntityObject, ComponentObject)
- -Applies the component and any changes made to it in script back to the entity. What this means for each component can be slightly different: it makes the component reload on the entity with the new data as if it had just been added to the entity. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| ComponentObject | -Component JS API Object | -The component object retrieved from the entity that was returned by either createComponent() or getComponent() | -
| EntityObject | -Entity JS API Object | -The entity object that we are applying the component changes to | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -The component was successfully updated | -
createComponent(EntityObject, ComponentIdentifier)
- -Creates the specified component and adds it to the entity. This should only be used with custom components which need to be registered first. If the entity already has the component, this will retrieve the component already there instead. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| ComponentIdentifier | -String | -The identifier of the component to add to the entity. This is either the identifier of a built-in component (check the Script Components section) or a custom component created with a call to registerComponent() | -
| EntityObject | -Entity JS API Object | -The EntityObject that was retrieved from a call to createEntity() or retrieved from an event | -
Return Value
- - - -| Type | Value |
|---|---|
| Component JS API Object | -An object with the following fields, and additionally, all the fields as defined in the component | -
destroyComponent(EntityObject, ComponentIdentifier)
- -Removes the specified component from the given entity. If the entity has the component, it will be removed. Currently this only works with custom components and can't be used to remove components defined for an entity in JSON. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| ComponentIdentifier | -String | -The identifier of the component to remove from the entity. This is either the identifier of a built-in component (check the Script Components section) or a custom component created with a call to registerComponent() | -
| EntityObject | -Entity JS API Object | -The EntityObject that was retrieved from a call to createEntity() or retrieved from an event | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -The component was successfully removed from the entity | -
getComponent(EntityObject, ComponentIdentifier)
- -Looks for the specified component in the entity. If it exists, retrieves the data from the component and returns it. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| ComponentIdentifier | -String | -The identifier of the component to retrieve from the entity. This is either the identifier of a built-in component (check the Script Components section) or a custom component created with a call to registerComponent() | -
| EntityObject | -Entity JS API Object | -The EntityObject that was retrieved from a call to createEntity() or retrieved from an event | -
Return Value
- - - -| Type | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Component JS API Object | -An object with the following fields, and additionally, all the fields as defined in the component Component JS API Object - - - -
- - |
-
hasComponent(EntityObject, ComponentIdentifier)
- -Checks if the given entity has the specified component. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| ComponentIdentifier | -String | -The identifier of the component to check on the entity. This is either the identifier of a built-in component (check the Script Components section) or a custom component created with a call to registerComponent() | -
| EntityObject | -Entity JS API Object | -The EntityObject that was retrieved from a call to createEntity() or retrieved from an event | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -The EntityObject has the component | -
registerComponent(ComponentIdentifier, ComponentData)
- -Creates a custom component that only exists in script. It can be then added, removed, and updated from entities. These custom components only exist while the Script Engine is running. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| ComponentData | -JavaScript Object | -A JavaScript Object that defines the name of the fields and the data each field holds inside the component. | -
| ComponentIdentifier | -String | -The identifier of the custom component. It is required to use a namespace so you can uniquely refer to it later without overlapping a name with a built-in component: for example 'myPack:myCustomComponent' | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -The component was successfully registered | -
Entity Bindings
- - - -createEntity()
- -Creates an empty entity with no components and does not place it in the world. The empty entity will be of type custom and have a blank identifier. This is NOT a valid entity that exists in the world, just an empty one that only scripts know about.NOTE: Entities are created first on the server, with the client notified of new entities afterwards. Be aware that if you send the result object to the client right away, the created entity might not exist on the client yet. - -Return Value
- - - -| Type | Value |
|---|---|
| Entity JS API Object | -An object representing the newly created entity | -
createEntity(Type, TemplateIdentifier)
- -Creates an entity and applies the specified template as defined in JSON. This allows you to quickly create an entity from the applied Behavior Packs as the base for an entity created in scripting. The entity will be spawned into the world with all the components, component groups, and event triggers that are defined in the JSON file of the identifier specified. Only works on scripts registered on the server.NOTE: Entities are created first on the server, with the client notified of new entities afterwards. Be aware that if you send the result object to the client right away, the created entity might not exist on the client yet. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| TemplateIdentifier | -String | -This can be any of the entity identifiers from the applied Behavior Packs. For example specifying minecraft:cow here will make the provided entity a cow as defined in JSON | -
| Type | -String | -Specifies the type of the entity that is being created by the template. Valid inputs are `entity` and `item_entity` | -
Return Value
- - - -| Type | Value |
|---|---|
| Entity JS API Object | -An object representing the newly created entity | -
destroyEntity(EntityObject)
- -Destroys an entity identified by the EntityObject. If the entity exists in the world this will remove it from the world and destroy it. This also makes the EntityObject no longer valid - you should only destroy an entity after you are done with it and no longer need to reference it again. This does NOT kill the entity. There won't be an event for its death: it will be removed. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| EntityObject | -Entity JS API Object | -The object that was retrieved from a call to createEntity() or retrieved from an entity event | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -The entity was successfully destroyed | -
isValidEntity(EntityObject)
- -Checks if the given EntityObject corresponds to a valid entity. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| EntityObject | -Entity JS API Object | -The object that was retrieved from a call to createEntity() or retrieved from an entity event | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -The entity is in the Script Engine's database of entities | -
Entity Queries
- -Entity Queries are a way for you to filter for entities based on their components. Once you have registered a query, you can request all the entities that are captured by it. Entity Queries will only ever return entities that are currently active in the level. If your query extends into chunks that are not currently loaded, entities there will not be included in the query. - -addFilterToQuery(Query, ComponentIdentifier)
- -Allows you to add filters to your query. The query will only contain entities that have all the components specified.By default no filters are added. This will allow queries to capture all entities.| Name | Type | Description |
|---|---|---|
| ComponentIdentifier | -String | -This is the identifier of the component that will be added to the filter list. Only entities that have that component will be listed in the query | -
| Query | -Query JS API Object | -The object containing the ID of the query that you want to apply the filter to | -
getEntitiesFromQuery(Query)
- -Allows you to fetch the entities captured by a query. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| Query | -Query JS API Object | -This is the query you registered earlier using registerQuery() | -
Return Value
- - - -| Type | Value |
|---|---|
| Array | -An array of EntityObjects representing the entities found within the query | -
getEntitiesFromQuery(Query, ComponentField1_Min, ComponentField2_Min, ComponentField3_Min, ComponentField1_Max, ComponentField2_Max, ComponentField3_Max)
- -Allows you to fetch the entities captured by a query that was created with a component filter built-in. The only entities that will be returned are those entities that have the component that was defined when the query was registered and that have a value in the three fields on that component that were defined in the query within the values specified in the call to getEntitiesFromQuery. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| ComponentField1_Max | -Decimal | -The maximum value that the first component field needs to be on an entity for that entity to be included in the query | -
| ComponentField1_Min | -Decimal | -The minimum value that the first component field needs to be on an entity for that entity to be included in the query | -
| ComponentField2_Max | -Decimal | -The maximum value that the second component field needs to be on an entity for that entity to be included in the query | -
| ComponentField2_Min | -Decimal | -The minimum value that the second component field needs to be on an entity for that entity to be included in the query | -
| ComponentField3_Max | -Decimal | -The maximum value that the third component field needs to be on an entity for that entity to be included in the query | -
| ComponentField3_Min | -Decimal | -The minimum value that the third component field needs to be on an entity for that entity to be included in the query | -
| Query | -Query JS API Object | -This is the query you created earlier using registerQuery(...) | -
Return Value
- - - -| Type | Value |
|---|---|
| Array | -An array of EntityObjects representing the entities found within the query | -
registerQuery()
- -Allows you to register a query. A query will contain all entities that meet the filter requirement.No filters are added by default when you register a query so it will capture all entities. - -Return Value
- - - -| Type | Value |
|---|---|
| Query JS API Object | -An object containing the ID of the query | -
registerQuery(Component, ComponentField1, ComponentField2, ComponentField3)
- -Allows you to register a query that will only show entities that have the given component and define which fields of that component will be used as a filter when getting the entities from the query. You can either provide just the component identifier, or the component identifier and the name of 3 properties on that component to be tested (If you do specify property names, you must specify 3). - -Parameters
- - - -| Name | Type | Default Value | Description |
|---|---|---|---|
| Component | -String | -- | This is the identifier of the component that will be used to filter entities when | -
| ComponentField1 | -String | -"x" | -This is the name of the first field of the component that we want to filter entities by. By default this is set to x. | -
| ComponentField2 | -String | -"y" | -This is the name of the second field of the component that we want to filter entities by. By default this is set to y. | -
| ComponentField3 | -String | -"z" | -This is the name of the third field of the component that we want to filter entities by. By default this is set to z. | -
Return Value
- - - -| Type | Value |
|---|---|
| Query JS API Object | -An object containing the ID of the query | -
Event Bindings
- -These are the bindings used to handle events. For a list of events you can react to or trigger, check the Events section of this document. - -broadcastEvent(EventIdentifier, EventData)
- -Allows you to trigger an event with the desired data from script. Anything that signed up to listen for the event will be notified and the given data delivered to them. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| EventData | -JavaScript Object | -The data for the event. You can create a new JavaScript Object with the parameters you want to pass in to the listener and the engine will take care of delivering the data to them | -
| EventIdentifier | -String | -This is the identifier of the event we want to react to. Can be the identifier of a built-in event or a custom one from script | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -Successfully broadcasted the event | -
createEventData(EventIdentifier)
- -Creates an object with all the required fields and default data for the specified event. If the event is a custom event, it needs to have been previously registered. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| EventIdentifier | -String | -This is the identifier of the custom event we are registering. The namespace is required and can't be set to minecraft. | -
Return Value
- - - -| Type | Value |
|---|---|
| JavaScript Object | -The object containing the event data | -
listenForEvent(EventIdentifier, CallbackObject)
- -Allows you to register a JavaScript object that gets called whenever the specified event is broadcast. The event can either be a built-in event or an event specified in script. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| CallbackObject | -JavaScript Object | -The JavaScript object that will get called whenever the event is broadcast | -
| EventIdentifier | -String | -This is the identifier of the event to which we want to react. Can be the identifier of a built-in event or a custom one from script | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -Successfully registered to listen for the event | -
registerEventData(EventIdentifier, EventData)
- -Registers the Event to the script engine. This allows you to create Event Data by calling createEventData and have it initialized with the correct default data and fields. Only custom events need to be registered. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| EventData | -JavaScript Object | -The JavaScript object with the correct fields and default values for the event | -
| EventIdentifier | -String | -This is the identifier of the custom event we are registering. The namespace is required and can't be set to minecraft. | -
Return Value
- - - -| Type | Value |
|---|---|
| Boolean | -Successfully registered the event data | -
Logging Bindings
- - - -log(Message)
- -The log function is accessed through the server or client objects and allows for logging a message to the ContentLog file. On Windows 10 devices it is located at ' %APPDATA%\..\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\logs ' - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| Message | -String | -The message that you want to send to the log file | -
Slash Commands
- -You can use the traditional Slash Command system from scripts. Currently you can either trigger an event ("minecraft:execute_command") or use the executeCommand binding. Commands in scripts are restricted to server scripts, they can't be run from the client's side at the moment. - -executeCommand(Command, Callback)
- -Allows you to execute a Slash Command on the server. The command will be queried and executed at the end of the current frame. All data output from the command will be compiled on a JavaScript Object and sent to the Callback object specified in the second parameter. - -| Name | Type | Description |
|---|---|---|
| Callback | -JSON Object | -The JavaScript object that will be called after the command executes | -
| Command | -String | -The slash command to run | -
Script Components
- -This is the documentation for the attributes, properties, and components available from the Minecraft Script Engine.There are two kinds of components: server components and client components. We will go into a bit more detail on what they are in their respective sections below.Components can be added, retrieved, updated, and removed from entities. They do not exist on their own. Currently only user-defined components can be added and removed from entities. A component must be in an entity in order to retrieve or update it.Check the Script Engine Bindings section to see how to add, remove, retrieve, and update components. This section deals with the specific API of each component.Block Components
- -These components are only found on block objects and can only be on block objects - -minecraft:blockstate
- -This component contains all the blockstates on a block object. Blockstates control all different aspects of blocks from their orientation to the type of wood they are. Blockstates are represented by numbers, bools, or strings. Please see the Blockstates Documentation to see the valid values for each state. This component allows for the getting and setting of these states.Client Components
- -These components only run on the client where the script ran and can only be used from client scripts. - -minecraft:molang
- -The Molang component gives access to the Molang variables in an entity. To learn more about Molang variables review the add-on documentation. In scripts, you can get and set these variables that are defined in the entity's JSON files. Because of how the Molang variables are formatted (variable.isgrazing for example) you must use the [] operator on the object to access the variable. The example below shows how to use the [] operator to access the variable.Level Components
- -These are the components that belong to the level. They can only belong on the level object and cannot be removed from it. You can get the components and change their data through the global server object.let levelComponent = this.getComponent(server.level, "minecraft:example_level_component"); - -minecraft:ticking_areas
- -This component gives access to the static ticking areas in the level. The component contains an array of ticking areas. The ticking areas can be accessed by name or by UUID if they were not given a name.Back to topminecraft:weather
- -The weather component allows users to change the level's weather. Rain and lightning levels can be changed independently and the default weather cycle can be turned off completely. - -| Name | Type | Description |
|---|---|---|
| do_weather_cycle | -Boolean | -This is the world option that determines if the vanilla weather cycle will be used | -
| lightning_level | -Decimal | -A value between 0 and 1 that determines how much lightning and thunder there is | -
| lightning_time | -Integer | -How long, in ticks, it will lightning and thunder for | -
| rain_level | -Decimal | -A value between 0 and 1 that determains how heavy the rainfall is | -
| rain_time | -Integer | -How long, in ticks, it will rain for | -
Server Components
- -These are the components that run on the server and are synced with all the clients (players) in the world.As much as possible, the API of each component matches its JSON counterpart (with some differences noted). - -minecraft:armor_container
- -This component represents the armor contents of an entity. The component contains an array of ItemStack JS API Objects representing each slot in the armor container. NOTE: Currently items and containers are read-only. Slots are ordered from head to feet. -minecraft:attack
- -This component controls the Attack Damage attribute from the entity. It allows you to change the current minimum and maximum values. Once the changes are applied, the current attack of the entity will be reset to the minimum specified. With the minimum and maximum changed to the values specified. Any buffs or debuffs will be left intact. - -| Name | Type | Default Value | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| damage | -Range [a, b] | -- | Range of the random amount of damage the melee attack deals. A negative value can heal the entity instead of hurting it
|
-
minecraft:collision_box
- -Sets the width and height of the Entity's collision box. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| height | -Decimal | -1.0 | -Height of the collision box in blocks. A negative value will be assumed to be 0. | -
| width | -Decimal | -1.0 | -Width and Depth of the collision box in blocks. A negative value will be assumed to be 0. | -
minecraft:container
- -This component represents the container of a block. The component contains an array of ItemStack JS API Objects representing each slot in the container. This specific component is used for blocks. Refer to inventory components for entities. NOTE: Currently items and containers are read-only. Slots are ordered left to right. -minecraft:damage_sensor
- -Defines what events to call when this entity is damaged by specific entities or items. - -| Name | Type | Default Value | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggers | -List | -- | List of triggers with the events to call when taking specific kinds of damage.
|
-
minecraft:equipment
- -Sets the Equipment table to use for this Entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| slot_drop_chance | -List | -- | A list of slots with the chance to drop an equipped item from that slot. | -
| table | -String | -- | The file path to the equipment table, relative to the behavior pack's root. | -
minecraft:equippable
- -Defines an entity's behavior for having items equipped to it. - -slots
- -List of slots and the item that can be equipped. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| accepted_items | -List | -- | The list of items that can go in this slot. | -
| interact_text | -String | -- | Text to be displayed when the entity can be equipped with this item when playing with Touch-screen controls. | -
| item | -String | -- | Identifier of the item that can be equipped for this slot. | -
| on_equip | -String | -- | Event to trigger when this entity is equipped with this item. | -
| on_unequip | -String | -- | Event to trigger when this item is removed from this entity. | -
| slot | -Integer | -0 | -The slot number of this slot. | -
minecraft:explode
- -Defines how the entity explodes. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| breaks_blocks | -Boolean | -true | -If true, the explosion will destroy blocks in the explosion radius. | -
| causes_fire | -Boolean | -false | -If true, blocks in the explosion radius will be set on fire. | -
| destroy_affected_by_griefing | -Boolean | -false | -If true, whether the explosion breaks blocks is affected by the mob griefing game rule. | -
| fire_affected_by_griefing | -Boolean | -false | -If true, whether the explosion causes fire is affected by the mob griefing game rule. | -
| fuse_length | -Range [a, b] | -[0.0, 0.0] | -The range for the random amount of time the fuse will be lit before exploding, a negative value means the explosion will be immediate. | -
| fuse_lit | -Boolean | -false | -If true, the fuse is already lit when this component is added to the entity. | -
| max_resistance | -Decimal | -3.40282e+38 | -A blocks explosion resistance will be capped at this value when an explosion occurs. | -
| power | -Decimal | -3 | -The radius of the explosion in blocks and the amount of damage the explosion deals. | -
minecraft:hand_container
- -This component represents the contents of an entity's hands. The component contains an array of ItemStack JS API Objects representing each slot in the hand container. NOTE: Currently items and containers are read-only. Slot 0 is main-hand Slot 1 is off-hand. -minecraft:healable
- -Defines the interactions with this entity for healing it. - -| Name | Type | Default Value | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| filters | -Minecraft Filter | -- | The filter group that defines the conditions for using this item to heal the entity. | -||||||||||||
| force_use | -Boolean | -false | -Determines if item can be used regardless of entity being at full health. | -||||||||||||
| items | -Array | -- | The array of items that can be used to heal this entity.
|
-
minecraft:health
- -Defines the current and maximum possible health of the entity. Upon applying the component back to the entity the health will change. If it reaches 0 or below the entity will die. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| max | -Integer | -10 | -The maximum health the entity can heal | -
| value | -Integer | -1 | -Current health of the entity | -
minecraft:hotbar_container
- -This component represents the hotbar contents of a player. The component contains an array of ItemStack JS API Objects representing each slot in the hotbar. NOTE: Currently items and containers are read-only. Slots are ordered left to right. -minecraft:interact
- -Defines the ways the player can interact with the entity to which this component is applied. - -| Name | Type | Default Value | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| add_items | -JSON Object | -- | Loot table with items to add to the player's inventory upon successful interaction
|
-||||||||||||||||
| cooldown | -Decimal | -0.0 | -Time in seconds before this entity can be interacted with again | -||||||||||||||||
| hurt_item | -Integer | -0 | -The amount of damage the item will take when used to interact with this entity. A value of 0 means the item won't lose durability | -||||||||||||||||
| interact_text | -String | -- | Text to show when the player is able to interact in this way with this entity when playing with Touch-screen controls | -||||||||||||||||
| on_interact | -String | -- | An event identifier to fire when the interaction occurs | -||||||||||||||||
| particle_on_start | -JSON Object | -- | Particle effect that will be triggered at the start of the interaction
|
-||||||||||||||||
| play_sounds | -Array | -- | An array of sound identifiers to play when the interaction occurs | -||||||||||||||||
| spawn_entities | -Array | -- | An array of entity identifiers to spawn when the interaction occurs | -||||||||||||||||
| spawn_items | -JSON Object | -- | Loot table with items to drop on the ground upon successful interaction
|
-||||||||||||||||
| swing | -Boolean | -false | -If true, the player will do the 'swing' animation when interacting with this entity | -||||||||||||||||
| transform_to_item | -String | -- | The item used will transform to this item upon successful interaction. Format: itemName:auxValue | -||||||||||||||||
| use_item | -Boolean | -false | -If true, the interaction will use an item | -
minecraft:inventory
- -Defines the entity's inventory (size, restrictions, etc.). Currently this does not allow changing the entity's inventory contents. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| additional_slots_per_strength | -Integer | -0 | -Number of slots that this entity can gain per extra strength | -
| can_be_siphoned_from | -Boolean | -false | -If true, the contents of this inventory can be removed by a hopper | -
| container_type | -String | -none | -Type of container this entity has. Can be horse, minecart_chest, minecart_hopper, inventory, container or hopper | -
| inventory_size | -Integer | -5 | -Number of slots the container has | -
| private | -Boolean | -false | -If true, only the entity can access the inventory | -
| restrict_to_owner | -Boolean | -false | -If true, the entity's inventory can only be accessed by its owner or itself | -
minecraft:inventory_container
- -This component represents the inventory contents of an entity. The component contains an array of ItemStack JS API Objects representing each slot in the inventory. NOTE: Currently items and containers are read-only.Slot 0-8 is the hotbar, 9-16 is the top row of the player's inventory, 17-24 is the middle row, 25-32 is the bottom row -minecraft:lookat
- -Defines the behavior when another entity looks at this entity. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| allow_invulnerable | -Boolean | -false | -If true, invulnerable entities (e.g. Players in creative mode) are considered valid targets. | -
| filters | -Minecraft Filter | -- | Defines the entities that can trigger this component. | -
| look_cooldown | -Range [a, b] | -[0, 0] | -The range for the random amount of time during which the entity is 'cooling down' and won't get angered or look for a target. | -
| look_event | -String | -- | The event identifier to run when the entities specified in filters look at this entity. | -
| search_radius | -Decimal | -10 | -Maximum distance this entity will look for another entity looking at it. | -
| set_target | -Boolean | -true | -If true, this entity will set the attack target as the entity that looked at it. | -
minecraft:nameable
- -Nameable component describes an entity's ability to be named using a nametag and whether the name shows up or not once applied. Additionally, scripting allows setting the name of the entity directly with the property 'name'. - -| Name | Type | Default Value | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| allow_name_tag_renaming | -Boolean | -true | -If true, this entity can be renamed with name tags | -||||||||||||
| always_show | -Boolean | -false | -If true, the name will always be shown | -||||||||||||
| default_trigger | -String | -- | Trigger to run when the entity gets named | -||||||||||||
| name | -String | -- | The current name of the entity, empty if the entity hasn't been named yet, making this non-empty will apply the name to the entity | -||||||||||||
| name_actions | -JSON Object | -- | Describes the special names for this entity and the events to call when the entity acquires those names
|
-
minecraft:position
- -This component allows you to control an entity's current position in the world. Once applied the entity will be teleported to the new position specified. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| x | -Decimal | -0.0 | -Position along the X-Axis (east-west) of the entity | -
| y | -Decimal | -0.0 | -Position along the Y-Axis (height) of the entity | -
| z | -Decimal | -0.0 | -Position along the Z-Axis (north-south) of the entity | -
minecraft:rotation
- -This component allows you to control an entity's current rotation in the world as well as the entity's head rotation. Once applied, the entity will be rotated as specified. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| x | -Decimal | -0.0 | -Controls the head rotation looking up and down | -
| y | -Decimal | -0.0 | -Controls the body rotation parallel to the floor | -
minecraft:shooter
- -Defines the entity's ranged attacks. This doesn't allow the entity to use a ranged attack: it only defines what kind of projectile it shoots. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| auxVal | -Integer | --1 | -ID of the Potion effect to be applied on hit | -
| def | -String | -- | Entity identifier to use as projectile for the ranged attack. The entity must have the projectile component to be able to be shot as a projectile | -
minecraft:spawn_entity
- -Adds a timer after which this entity will spawn another entity or item (similar to vanilla's chicken's egg-laying behavior). - -| Name | Type | Default Value | Description |
|---|---|---|---|
| filters | -Minecraft Filter | -- | If present, the specified entity will only spawn if the filter evaluates to true. | -
| max_wait_time | -Integer | -600 | -Maximum amount of time to randomly wait in seconds before another entity is spawned. | -
| min_wait_time | -Integer | -300 | -Minimum amount of time to randomly wait in seconds before another entity is spawned. | -
| num_to_spawn | -Integer | -1 | -The number of entities of this type to spawn each time that this triggers. | -
| should_leash | -Boolean | -false | -If true, this the spawned entity will be leashed to the parent. | -
| single_use | -Boolean | -false | -If true, this component will only ever spawn the specified entity once. | -
| spawn_entity | -String | -- | Identifier of the entity to spawn, leave empty to spawn the item defined above instead. | -
| spawn_event | -String | -minecraft:entity_born | -Event to call when the entity is spawned. | -
| spawn_item | -String | -egg | -Item identifier of the item to spawn. | -
| spawn_method | -String | -born | -Method to use to spawn the entity. | -
| spawn_sound | -String | -plop | -Identifier of the sound effect to play when the entity is spawned. | -
minecraft:tag
- -The tag component gives access to the array of entity tags that an entity may have. With this component you can add and remove any of the entity tags.Back to topminecraft:teleport
- -This controls the entity's ability to teleport itself (similar to the Enderman). If you wish to teleport the entity once use the Position component instead. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| dark_teleport_chance | -Decimal | -0.01 | -Modifies the chance that the entity will teleport if the entity is in darkness | -
| light_teleport_chance | -Decimal | -0.01 | -Modifies the chance that the entity will teleport if the entity is in daylight | -
| max_random_teleport_time | -Decimal | -20 | -Maximum amount of time in seconds between random teleports | -
| min_random_teleport_time | -Decimal | -0 | -Minimum amount of time in seconds between random teleports | -
| random_teleport_cube | -Vector [a, b, c] | -[32, 16, 32] | -Entity will teleport to a random position within the area defined by this cube | -
| random_teleports | -Boolean | -true | -If true, the entity will teleport randomly | -
| target_distance | -Decimal | -16 | -Maximum distance the entity will teleport when chasing a target | -
| target_teleport_chance | -Decimal | -1 | -The chance that the entity will teleport between 0.0 and 1.0. 1.0 means 100% | -
minecraft:tick_world
- -The tick world component is a read-only component that allows users to access the ticking areas on entities as well as the ticking area's data. - -| Name | Type | Description |
|---|---|---|
| distance_to_players | -Decimal | -distance_to_players | -
| never_despawn | -Boolean | -Whether or not this ticking area will despawn when a player is out of range | -
| radius | -Integer | -The radius in chunks of the ticking area | -
| ticking_area | -Entity Ticking Area JS API Object | -The ticking area entity that is attached to this entity | -
minecraft:ticking_area_description
- -Describes the ticking area's region. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| is_circle | -Boolean | -- | Is the area a circle. If false the area is a square. | -
| max | -Vector [a, b, c] | -- | (if area is a square) The edge of the area. | -
| name | -String | -- | The name of the area. | -
| origin | -Vector [a, b, c] | -- | The origin position of the area. | -
| radius | -Vector [a, b, c] | -- | (if area is a circle) The radius of the area. | -
Script Events
- -Here you can find the list of events that you can listen for and respond to in your scripts.Client Events
- - - -Listening Events
- -The following Minecraft events are events the Script Engine is listening for and to which you can react in scripts. - -minecraft:client_entered_world
- -This event is fired whenever a player joins the world. The event data contains the player entity object.Back to topminecraft:hit_result_changed
- -This event is triggered whenever the reticle changes from pointing at a block or air to pointing at an entity and the other way around. Up to 1000 blocks away. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was hit or null if it fired when moving off of an entity | -
| position | -Vector [a, b, c] | -The position of the entity that was hit or null if it fired when moving off an entity | -
minecraft:hit_result_continuous
- -This event is triggered every update and tells you what entity the reticle is pointing to in the world up to 1000 blocks away. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was hit or null if it not pointing at an entity | -
| position | -Vector [a, b, c] | -The position of the entity that was hit or block that was hit | -
minecraft:pick_hit_result_changed
- -This event is triggered whenever the mouse pointer changes from pointing at a block or air to pointing at an entity and the other way around. Up to 1000 blocks away. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was hit or null if it fired when moving off of an entity | -
| position | -Vector [a, b, c] | -The position of the entity that was hit or null if it fired when moving off an entity | -
minecraft:pick_hit_result_continuous
- -This event is triggered every update and tells you what entity the mouse pointer is pointing to in the world up to 1000 blocks away. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was hit or null if it not pointing at an entity | -
| position | -Vector [a, b, c] | -The position of the entity that was hit or block that was hit | -
Trigger-able Events
- -The following Minecraft Events can be triggered from scripting and cause the game to respond accordingly. - -minecraft:display_chat_event
- -This event is used to display a chat message to the specific player that is running the client script. The event data is the message to be displayed in plain text. Special formatting is supported the same way it would be if a player was sending the message. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| message | -String | -- | The chat message that will be displayed | -
minecraft:load_ui
- -This event is used to show a UI screen to the specific player running the client script. This event will add the UI screen to the top of the UI screen stack. The screen will be shown immediately after the event is triggered. Only screens defined in a HTML file can be shown using this event.| Name | Type | Default Value | Description |
|---|---|---|---|
| options | -JSON Object | -- | You can define the following options for the screen by setting their value to true or false: absorbs_input - -If true, input will not be passed down to any other screens underneathBack to top- - always_accepts_input - -If true, the screen will always accept and process input for as long as it is in the stack, even if other custom UI screens appear on top of itBack to top- - force_render_below - -If true, this screen will be rendered even if another screen is on top of it and will render over them, including the HUDBack to top- - - -If true, the screen will be treated as the pause menu and the pause menu won't be allowed to show on top of this screenBack to top - - render_game_behind - -If true, the game will continue to be rendered underneath this screenBack to top- - render_only_when_topmost - -If true, this screen will only be rendered if it is the screen at the top of the stackBack to top- - should_steal_mouse - -If true, the screen will capture the mouse pointer and limit its movement to the UI screenBack to top- - |
-
| path | -String | -- | The file path to the screen's HTML file | -
minecraft:script_logger_config
- -This event is used to turn various levels of logging on and off for client scripts. Note that turning logging on/off is not limited to the script that broadcasted the event. It will affect ALL client scripts including those in other Behavior Packs that are applied to the world. See the Debugging section for more information on logging. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| log_errors | -Boolean | -false | -Set to true to log any scripting errors that occur on the client | -
| log_information | -Boolean | -false | -Set to true to log any general scripting information that occurs on the client. This includes any logging done with client.log() | -
| log_warnings | -Boolean | -false | -Set to true to log any scripting warnings that occur on the client | -
minecraft:send_ui_event
- -This event is used to send UI events to the UI Engine for the specific player running the script. After the event is triggered, the UI event will be sent immediately.Custom UI is based on HTML 5. Review the scripting demo for an example of a custom UI file. - -| Name | Type | Description |
|---|---|---|
| data | -String | -The data for the UI event being triggered | -
| eventIdentifier | -String | -The identifier of the UI event | -
minecraft:spawn_particle_attached_entity
- -This event is used to create a particle effect that will follow an entity around. This particle effect is only visible to the specific player that is running the client script where you fired the event. Any effect defined in a JSON file (both in your resource pack and in Minecraft) can be used here. Molang variables defined in the JSON of the effect can then be used to control that effect by changing them in the entity to which it is attached. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| effect | -String | -- | The identifier of the particle effect you want to attach to the entity. This is the same name you gave the effect in its JSON file | -
| entity | -Entity JS API Object | -- | The entity object you want to attach the effect to | -
| offset | -Vector [a, b, c] | -[0, 0, 0] | -The offset from the entity's "center" where you want to spawn the effect | -
minecraft:spawn_particle_in_world
- -This event is used to create a static particle effect in the world. This particle effect is only visible to the specific player that is running the client script where you fired the event. Any effect defined in a JSON file (both in your resource pack and in Minecraft) can be used here. Once the effect is spawned you won't be able to control it further. Unlike the server version of the event, the client version will spawn the particle in the dimension the player is currently in. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| effect | -String | -- | The identifier of the particle effect you want to attach to spawn. This is the same name you gave the effect in its JSON file | -
| position | -Vector [a, b, c] | -[0, 0, 0] | -The position in the world where you want to spawn the effect | -
minecraft:unload_ui
- -This event is used to remove a UI screen from the stack of the specific player running the client script. The event data contains the name of the screen to remove as a string. After the event is triggered the screen will be scheduled to be removed from the stack the next time the UI Engine can do so. Only screens defined in a HTML file can be removed using this event.Back to topServer Events
- - - -Listening Events
- -The following Minecraft events are events the Script Engine is listening for and to which you can react in scripts. - -minecraft:block_destruction_started
- -This event is triggered whenever a player starts to destroy a block. - -| Name | Type | Description |
|---|---|---|
| block_position | -JavaScript Object | -The position of the block that is being destroyed | -
| player | -Entity JS API Object | -The player that started destoying the block | -
minecraft:block_destruction_stopped
- -This event is triggered whenever a player stops destroying a block. - -| Name | Type | Description |
|---|---|---|
| block_position | -JavaScript Object | -The position of the block that was being destroyed | -
| destruction_progress | -Decimal | -How far along the destruction was before it was stopped (0 - 1 range) | -
| player | -Entity JS API Object | -The player that stopped destoying the block | -
minecraft:block_exploded
- -This event is triggered whenever a block is destroyed by an explosion. - -| Name | Type | Description |
|---|---|---|
| block_identifier | -String | -The identifier of the block that was destroyed | -
| block_position | -JavaScript Object | -The position of the block that was destroyed by the explosion | -
| cause | -String | -The cause of the block's destruction | -
| entity | -Entity JS API Object | -The entity that exploded | -
minecraft:block_interacted_with
- -This event is triggered whenever a player interacts with a block. - -| Name | Type | Description |
|---|---|---|
| block_position | -JavaScript Object | -The position of the block that is being interacted with | -
| player | -Entity JS API Object | -The player that interacted with the block | -
minecraft:entity_acquired_item
- -This event is triggered whenever an entity acquires an item. - -| Name | Type | Description |
|---|---|---|
| acquired_amount | -Integer | -The total number of items acquired by the entity during this event | -
| acquisition_method | -String | -The way the entity acquired the item | -
| entity | -Entity JS API Object | -The entity who acquired the item | -
| item_stack | -ItemStack JS API Object | -The item that was acquired | -
| secondary_entity | -Entity JS API Object | -If it exists, the entity that affected the item before it was acquired. Example: A player completes a trade with a villager. The `entity` property would be the player and the `secondary_entity` would be the villager | -
minecraft:entity_attack
- -This event is triggered whenever an entity is being attacked by another entity. This does not guarantee the entity was or will be hurt by the attack. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that attacked | -
| target | -Entity JS API Object | -The entity that was targeted in the attack | -
minecraft:entity_carried_item_changed
- -This event is triggered whenever an entity changes the item carried in their hand. - -| Name | Type | Description |
|---|---|---|
| carried_item | -ItemStack JS API Object | -The item that is now in the entities hands | -
| entity | -Entity JS API Object | -The entity that changed what they were carrying | -
| hand | -String | -Defines which hand the item was equipped to. Either main or offhand. | -
| previous_carried_item | -ItemStack JS API Object | -The item that was previously in the entities hands | -
minecraft:entity_created
- -This event is triggered whenever an entity is added to the world. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was just created | -
minecraft:entity_death
- -This event is triggered whenever an entity dies. This won't be triggered when an entity is removed (such as when using destroyEntity). Not all of these values are present with every entity death. - -| Name | Type | Description |
|---|---|---|
| block_position | -JavaScript Object | -The position of the block that killed the entity | -
| cause | -String | -The cause of the entity's death | -
| entity | -Entity JS API Object | -The entity that died | -
| killer | -Entity JS API Object | -The entity that killed the entity | -
| projectile_type | -String | -The type of the projectile that killed the entity | -
minecraft:entity_definition_event
- -This event is triggered whenever an entity definition event is triggered by either script or the entity's JSON. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was affected | -
| event | -String | -The event that was triggered | -
minecraft:entity_dropped_item
- -This event is triggered whenever an entity drops an item. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity who dropped the item | -
| item_stack | -ItemStack JS API Object | -The item that was dropped | -
minecraft:entity_equipped_armor
- -This event is triggered whenever an entity equips an item in their armor slots. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity who is equipping the armor | -
| item_stack | -ItemStack JS API Object | -The armor that is being equipped | -
| slot | -String | -Defines which slot the item was equipped to. | -
minecraft:entity_hurt
- -This event is triggered whenever an entity is hurt. - -| Name | Type | Description |
|---|---|---|
| absorbed_damage | -Integer | -The amount the damage was reduced by by the entity's absorption effect | -
| attacker | -Entity JS API Object | -Present only when damaged by an entity or projectile. The entity that attacked and caused the damage | -
| block_position | -Vector [a, b, c] | -Present only when damaged by a block. This is the position of the block that hit the entity | -
| cause | -String | -The way the entity took damage. Refer to the Damage Source documentation for a complete list of sources | -
| damage | -Integer | -The amount of damage the entity took after immunity and armor are taken into account | -
| entity | -Entity JS API Object | -The entity that took damage | -
| projectile_type | -String | -Present only when damaged by a projectile. This is the identifier of the projectile that hit the entity | -
minecraft:entity_sneak
- -This event is triggered whenever an entity flag's value changes. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that changed their sneaking state | -
| sneaking | -Boolean | -If true, the entity just started sneaking. If false, the entity just stopped sneaking | -
minecraft:entity_start_riding
- -This event is triggered whenever an entity becomes a rider on another entity. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The rider | -
| ride | -Entity JS API Object | -The entity being ridden | -
minecraft:entity_stop_riding
- -This event is triggered whenever an entity stops riding another entity. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was riding another entity | -
| entity_is_being_destroyed | -Boolean | -If true, the rider stopped riding because they are now dead | -
| exit_from_rider | -Boolean | -If true, the rider stopped riding by their own decision | -
| switching_rides | -Boolean | -If true, the rider stopped riding because they are now riding a different entity | -
minecraft:entity_tick
- -This event is triggered whenever an entity is ticked. This event will not fire when a player is ticked. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was ticked | -
minecraft:entity_use_item
- -This event is triggered whenever an entity uses an item. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity who is using the item | -
| item_stack | -ItemStack JS API Object | -The item that is being used | -
| use_method | -String | -The way the entity used the item | -
minecraft:piston_moved_block
- -This event is triggered whenever a piston moves a block. - -| Name | Type | Description |
|---|---|---|
| block_position | -JavaScript Object | -The position of the block that was moved | -
| piston_action | -String | -The action the piston took, "extended" or "retracted" | -
| piston_position | -JavaScript Object | -The position of the piston that moved the block | -
minecraft:play_sound
- -This event is used to play a sound effect. Currently, sounds can only be played at a fixed position in the world. Global sounds and sounds played by an entity will be supported in a later update. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| pitch | -Decimal | -1.0 | -The pitch of the sound effect. A value of 1.0 will play the sound effect with regular pitch | -
| position | -Vector [a, b, c] | -[0, 0, 0] | -The position in the world we want to play the sound at | -
| sound | -String | -- | The identifier of the sound you want to play. Only sounds defined in the applied resource packs can be played | -
| volume | -Decimal | -1.0 | -The volume of the sound effect. A value of 1.0 will play the sound effect at the volume it was recorded at | -
minecraft:player_attacked_entity
- -This event is triggered whenever a player attacks an entity. - -| Name | Type | Description |
|---|---|---|
| attacked_entity | -Entity JS API Object | -The entity that was attacked by the player | -
| player | -Entity JS API Object | -The player that attacked an entity | -
minecraft:player_destroyed_block
- -This event is triggered whenever a player destroys a block. - -| Name | Type | Description |
|---|---|---|
| block_identifier | -String | -The identifier of the block that was destroyed | -
| block_position | -JavaScript Object | -The position of the block that was destroyed | -
| player | -Entity JS API Object | -The player that destroyed the block | -
minecraft:player_placed_block
- -This event is triggered whenever a player places a block. - -| Name | Type | Description |
|---|---|---|
| block_position | -JavaScript Object | -The position of the block that was placed | -
| player | -Entity JS API Object | -The player that placed the block | -
minecraft:projectile_hit
- -This event is triggered whenever a projectile hits something. - -| Name | Type | Description |
|---|---|---|
| entity | -Entity JS API Object | -The entity that was hit by the projectile, if any | -
| owner | -Entity JS API Object | -The entity that fired the projectile | -
| position | -Vector [a, b, c] | -The position of the collision | -
| projectile | -Entity JS API Object | -The projectile in question | -
minecraft:weather_changed
- -This event is triggered whenever the weather changes. It contains information about the weather it is changing to. - -| Name | Type | Description |
|---|---|---|
| dimension | -String | -The name of the dimension where the weather change happened | -
| lightning | -Boolean | -Tells if the new weather has lightning | -
| raining | -Boolean | -Tells if the new weather has rain | -
Trigger-able Events
- -The following Minecraft events can be triggered from scripting and the game will respond, accordingly. - -minecraft:display_chat_event
- -This event is used to send a chat message from the server to the players. The event data is the message being sent as a string. Special formatting is supported the same way it would be if a player was sending the message. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| message | -String | -- | The chat message that will be displayed | -
minecraft:entity_definition_event
- -This event is used to trigger events that Entity Definition JSON files are listening for. For example, you can trigger the minecraft:become_charged event on a creeper to turn it into a charged creeper. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| entity | -Entity JS API Object | -- | The entity object you want to attach the effect to | -
| event | -String | -- | The identifier of the event to trigger on that entity. Both built-in (minecraft:) and custom events are supported | -
minecraft:execute_command
- -This event is used to execute a slash command on the server with the World Owner permission level. The event data contains the slash command as a string. The slash command will be processed and will run after the event is sent. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| command | -String | -- | The command that will be run | -
minecraft:play_sound
- -This event is used to play a sound effect. Currently, sounds can only be played at a fixed position in the world. Global sounds and sounds played by an entity will be supported in a later update. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| pitch | -Decimal | -1.0 | -The pitch of the sound effect. A value of 1.0 will play the sound effect with regular pitch | -
| position | -Vector [a, b, c] | -[0, 0, 0] | -The position in the world we want to play the sound at | -
| sound | -String | -- | The identifier of the sound you want to play. Only sounds defined in the applied resource packs can be played | -
| volume | -Decimal | -1.0 | -The volume of the sound effect. A value of 1.0 will play the sound effect at the volume it was recorded at | -
minecraft:script_logger_config
- -This event is used to turn various levels of logging on and off for server scripts. Note that turning logging on/off is not limited to the script that broadcasted the event. It will affect ALL server scripts including those in other Behavior Packs that are applied to the world. See the Debugging section for more information on logging. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| log_errors | -Boolean | -false | -Set to true to log any scripting errors that occur on the server | -
| log_information | -Boolean | -false | -Set to true to log any general scripting information that occurs on the server. This includes any logging done with server.log() | -
| log_warnings | -Boolean | -false | -Set to true to log any scripting warnings that occur on the server | -
minecraft:spawn_particle_attached_entity
- -This event is used to create a particle effect that will follow an entity around. This particle effect is visible to all players. Any effect defined in a JSON file (both in your resource pack and in Minecraft) can be used here. Molang variables defined in the JSON of the effect can then be used to control that effect by changing them in the entity to which it is attached. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| effect | -String | -- | The identifier of the particle effect you want to attach to the entity. This is the same identifier you gave the effect in its JSON file | -
| entity | -Entity JS API Object | -- | The entity object you want to attach the effect to | -
| offset | -Vector [a, b, c] | -[0, 0, 0] | -The offset from the entity's "center" where you want to spawn the effect | -
minecraft:spawn_particle_in_world
- -This event is used to create a static particle effect in the world. This particle effect is visible to all players. Any effect defined in a JSON file (both in your resource pack and in Minecraft) can be used here. Once the effect is spawned you won't be able to control it further. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| dimension | -String | -overworld | -The dimension in which you want to spawn the effect. Can be "overworld", "nether", or "the end" | -
| effect | -String | -- | The identifier of the particle effect you want to attach to spawn. This is the same name you gave the effect in its JSON file | -
| position | -Vector [a, b, c] | -[0, 0, 0] | -The position in the world where you want to spawn the effect | -
Scripting System
- -The Minecraft Script Engine uses the JavaScript language.You can write JavaScript scripts and bundle them with Behavior Packs to listen and respond to game events, get and modify data in components that entities have, and affect different parts of the game.Breaking Changes
- -While we continue to work and refine the experimental Scripting API we might need to make changes that will break your current scripts. Please check this section if your scripts aren't working as expected. - -| Category | Change |
|---|---|
| Components | -Calls to getComponent now return the component's parameters inside of the 'data' parameter of the return object. | -
| Events | -Event data objects now hold the event's parameters inside of the 'data' parameter of the event data object. | -
| UI | -engine.on now takes a facet name. In order to check for the script engine starting and connect it to the UI you will need the following:engine.on("facet:updated:core.scripting", ...);Followed by the following line after you are done doing your initialization:engine.trigger("facet:request", ["core.scripting"]); | -
Debugging
- -Your script isn't working or doing what you want it to do? Fret not! We have built some debugging capabilities into the Script Engine to help you figure out what's going on with your script. If you are new to programming or want to learn more about debugging we suggest checking out the documentation about debugging with Visual Studio available here: https://docs.microsoft.com/visualstudio/debugger There are two ways to tell what happened when something goes wrong with a script: in-game and advanced, which we will describe below. You only need the game and your script to debug in-game, but you will need a Windows 10 PC and Visual Studio installed for the advanced debugging. - -In-Game
- -When you run a script in the game, the Script Engine will print out error messages whenever something goes wrong. For example, if you try to get a component that the script engine doesn't know about you will get an error.To look at these messages you can open the chat screen which will have all the generated error messages there; or you can open the log file that the game generated. The location of the log file varies by platform. On Windows 10 you can find the log file in ' %APPDATA%\..\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\logs 'We strongly encourage you to build further debug messages and tools into your scripts while working on them. This will help you discern when something isn't working quite right. Reach out on the official Discord channel if you need additional help: https://discord.gg/MinecraftBack to topReal-Time (Advanced)
- -If you have a Windows 10 PC with Visual Studio installed, you can attach the Visual Studio debugger and debug your script in real-time.If you installed Visual Studio with the components mentioned in the "Recommended" section of this document you will have installed and enabled the Just-In-Time Debugger. This tool will pop-up a message from Visual Studio whenever an exception occurs in your script and allow you to open Visual Studio on the line of your script that broke.Additionally, you can connect to the Script Engine manually and debug your code. You can use remote debugging to connect and debug Minecraft running on another device. Please refer to the Visual Studio Debugger documentation above for instructions on how to use remote debugging.First you need to start up Visual Studio. If this is the first time you have launched Visual Studio after installation, we suggest setting up your environment for JavaScript development and logging in to your Microsoft account when prompted. This will set up the Visual Studio interface with the most important tools you will need.Once you have Visual Studio open you should launch Minecraft. Then create a new world with Experimental Gameplay enabled and apply the Behavior Pack containing your scripts.After creating the world go back to Visual Studio and click on the Debug menu. Then click on "Attach to Process". In the window that opens there will be a search box titled Filter Process. Click on it and type Minecraft.Once the list is narrowed down to only the instance of Minecraft running, you can verify that the Script Engine is running by looking at the Type column. This will say Script and either x86 or x64.Select the process and click on Attach to attach the debugger to the game. Now you will be able to press the Pause button to pause the Script Engine when the next line of script code runs. This allows you to inspect the values of variables in your script and break into Visual Studio if an error occurs in your code.WARNING: When you hit a breakpoint to step through code with a debugger, it is possible for a client to time out and disconnect or for the server to disconnect all players.Back to topDemos
- -Here are some demos from your friends at Minecraft to help you get started with scripting. Simply unzip them to check out the code, or import them as a .mcpack to play with them - -| Demo | Last Updated | Download Link |
|---|---|---|
| Mob Arena | -10/24/2018 | -https://aka.ms/minecraftscripting_mobarena | -
| Turn-Based RPG | -10/24/2018 | -https://aka.ms/minecraftscripting_turnbased | -
Getting Started
- -First you will need to download the latest Vanilla Behavior Pack. You can get this from the following link: https://aka.ms/behaviorpacktemplate Once you have downloaded the Behavior Pack, unzip it to a folder. Inside the Behavior Pack you will find the scripts folder which contains all the scripting files you want to run.In the scripts folder you will find two folders: one for client scripts and one for server scripts.-Server Scripts: These scripts run on the server side of the game. This includes spawning new entities, adding components, or modifying components on an entity.-Client Scripts: These scripts run on each individual player's side of the game. This is a good place to respond to events and manage anything specific to the player.Once you have chosen whether you are making a client or server script, simply add a new blank text file with .js extension to the appropriate folder, and open it in your preferred code editor. Then code away! You can have as many or as few JavaScript files as you want here (the name of the files doesn't matter) and they will all be run independently of each other! NOTE: For scripts to be run by the game, you need to enable Experimental Gameplay on the world where you will run scripts on. This will be necessary while scripting is still in beta.When entering a world that has client scripts in it, you will be prompted to accept that you wish to run scripts on your device (this will show up both for local worlds as well as multiplayer worlds).Additionally, if your pack contains client scripts, you need to include a client_data module in the pack's manifest. This tells the game anything in the scripts/client folder needs to be sent over to the clients. Please refer to the Add-on Documentation page for more information on the pack's manifest contents.Known Issues
- -This is the list of currently known issues with the Minecraft Script Engine - -| Issue | Workaround |
|---|---|
| Calling removeEntity on a dying entity might cause the game to crash | -Don't call removeEntity the same frame you reduced the entity's damage to 0. Removing the entity forces it to be removed right away. Instead, save any dying entities and clean the up on the next frame (See the Turn-Based Demo for an example of this) | -
| Custom UI doesn't retain state upon suspend and resume | -Currently there's no workaround for this issue | -
| Custom UI doesn't work in VR or MR mode | -Currently you will only be able to use custom UI when running the game in regular mode | -
| Exiting a world without scripts and entering one that has scripts might cause the wrong world to load | -Restart Minecraft before loading a new world with scripts | -
| Scripts are not loaded properly from archived packs | -Unzip script packs before applying them to a world. If you import a script pack with the .mcpack extension, it will unzip it for you | -
Pre-Requisites
- -So you want to make your own Scripts? That's awesome! In this section you will find the list of minimum and recommended software you will need.NOTE: Scripts are only supported on Windows 10 PCs at the moment. If you try to open a world with scripts on a device that doesn't support scripts, you will see an error message letting you know you can't enter the world. - -| Software | Minimum | Recommended |
|---|---|---|
| Code Editor | -Visual Studio Code or any plain-text editor | -Visual Studio Community 2017 with the following components installed: 'JavaScript diagnostics', 'JavaScript and TypeScript language support', 'Just-In-Time debugger' | -
| Debugger | -N/A | -Visual Studio Community 2017 | -
| Minecraft | -Minecraft on your Windows 10 device | -Minecraft on your Windows 10 device | -
| Other | -Vanilla Behavior Pack available from https://aka.ms/behaviorpacktemplate | -Vanilla Behavior Pack available from https://aka.ms/behaviorpacktemplate | -
| Storage | -1.0 GB of free space for text editor, game, and scripts | -3.0 GB of free space for Visual Studio, game, and scripts | -
Structure of a Script
- -In this section you can find a quick description of the basic structure of a JavaScript script file for the Minecraft Script Engine. If you would like to learn more about JavaScript or want to follow a fundamentals tutorial, you can check the official documentation on the Mozilla Developer Network here: https://developer.mozilla.org/docs/Web/JavaScript These are, in a way, the required parts of a script but they are by no means the only parts you can have. You can create additional methods as needed - just make sure they are called from somewhere in one of the methods below! - -1. System Registration
- -First off we need to register the system for our file. This signs up our script to be set-up either on the client or server threads of the game. Generally speaking, you will choose based on whether you put the script file in the client or server folders. To do that simply call registerSystem on either the client or server and give it the version of the API you require. - -| Name | Type | Description |
|---|---|---|
| majorVersion | -Integer | -This is the major version of the Minecraft Script Engine your script was designed to work with | -
| minorVersion | -Integer | -This is the revision of the Minecraft Script Engine your script was designed to work with | -
2. System Initialization
- -This is the first method that gets called immediately after the system is registered. It will run as soon as the script loads at world start.You can use this to set up the environment for your script: register custom components and events, sign up event listeners, etc. This will run BEFORE the world is ready and the player has been added to it. This function should be used to initialize variables and setup event listeners. You shouldn't try to spawn or interact with any entities at this point! You should also avoid interaction with UI elements or sending messages to the chat window since this is called before the player is ready.3. System Update
- -This method gets called once every game tick. The server and client tick at 20 times per second. This is a good place to get, check, and react to component changes.4. System Shutdown
- -This method gets called when the Minecraft Script Engine is shutting down. For the client this is when they leave the world; for the server this is after the last player has exited the world.User-Defined Components
- -User-Defined components are a special kind of component that can be defined in script and no built-in game system acts on it.The component needs to be registered with the Script Engine by giving it a name and a set of fields in the format name:value. Once applied, the component behaves like any of the built-in components: you can get it from an entity, modify its values, and apply the changes.Currently User-Defined components are the only components that can be dynamically added and removed from an entity using scripts. They don't need to be previously defined in an entity's JSON file. In the current version these components will NOT be saved out or loaded back in: they only exist while the entity is there and need to be added back when reloading the level.Index
-Back to top -Texture Sets
- -Minecraft supports a Physically Based Rendering (PBR) color pipeline (e.g. used for Ray Tracing). This uses more texture data than simply 'color' to enable richer, more realistic visuals. With the PBR approach, you can have layers for different specular reflections, emissivity, normal maps, etc. which goes beyond the Classic color pipeline for Vanilla Minecraft. Texture Sets have been added as the feature for defining multiple PBR layers for a texture resource. Texture sets are data driven from json files.Texture Set Json Schema
- -Layers
- -A texture_set.json file may specify several layers.Layers are references to texture image resources. they can also be defined in .json as values for uniform solid values as an alternative to referencing texture images in a pack. - -Color
- -- This is an RGB 3-channel image (defaults to uniform alpha of 1.0), or an RGBA 4-channel image, or a 4 value array for a uniform color with alpha.- This is the only required layer.- It is the only layer used by the Classic pipeline.- Typically there is lighting baked in the color image.Back to topNormal
- -- 3-channel normal map image (or 4-channel where the 4th channel is ignored).- Mutually exclusive with the `heightmap` layer.Back to topHeightmap
- -- 1-channel layer image or a single value in json for a uniform heightmap.- Mutually exclusive with the `normal` layer.Back to topMetalness_emissive_roughness
- -- 3-channel image (or 4-channel where the 4th channel is ignored) or a 3 value array for a uniform MER.- RGB images map Red to Metalness, Green to Emissive, and Blue to Roughness.Back to topSpecifying uniform values
- -Instead of referencing a texture image for a Texture Set layer, values can instead be specified in the *texture_set.json file, which is effectively the equivalent to referencing a texture image filled uniformly with that value or values for the respective channels.The values in the json can be specified in any of the following formats:- 0 to 255 numeric range, or as a vector of such integers for a multi-channel layer.- Hexadecimal RGB or ARGB for 3 and 4 channels respectively, also as 2 hex digits for a single channel layer.Back to topExamples of *.texture_set.json files
- - -All the layer values can be mixed and match with references to image textures, hexadecimal and numerical values. -Invalid *.texture_set.json
- -If a Texture Set is invalid, we'll log a CONTENT_ERROR and the Texture Set will not be used.A Texture Set is invalid if:- Json data cannot be parsed, or doesn't meet the Texture Set schema.- Color layer is not specified. Having a color layer in the .texture_set.json is required.- Both heightmap and normal layers are defined.- If a referenced texture does not exist in the same resource pack or the referenced texture cannot be parsed.- Any layer is defined with an unexpected number of channels: - For layers that are specified with referenced images: Color, MER, and Normal support 3 or 4 channel images; Heightmap support 1-channel images only. - For layers that are specified with numerical or hexadecimal values: Color support 4-channel values; MER support 3-channel values;Back to topResource Stack Behaviour
- -- Texture Set definitions can only reference images that exist in the same resource pack as the definition.- Texture images in higher priority resource packs do not override a Texture Set's reference to a texture in its own pack.- In the resource pack stack, Texture Set definitions for the same texture resource don't get merged. The higher priority pack's Texture Set definition will override the lower priority one.Back to topReferencing Texture Resources
- -The priority of file extensions, in case you have duplicate image references, is: .tga > .png > .jpg > .jpeg. For example: if grass.png and grass.tga both exist in the folder, grass.tga will be chosen. This also applies to other data driven files, like actor json referencing a texture resource.Back to topIndex
-| Scripting System |
|---|
| Engine Bindings |
| Getting The Script Engine |
| Script Bindings |
Scripting System
- -The custom UI for Minecraft is based on HTML 5.You can write JavaScript within the HTML file to listen and respond to events from the UI Engine. These events can be triggered by the UI Engine itself or you can trigger them from your scripts.In order to use custom UI, the resource pack containing the custom UI needs to have the custom UI capabilities enabled. To do this, simply add "experimental_custom_ui" to the capabilities array in the pack's manifest. You can check the Turn-Based RPG demo for an example of how to do this.Engine Bindings
- - - -on(EventIdentifier, Callback)
- -This is used to get events from the UI Engine. These events can be originally sent from client scripts using `send_ui_event`, or created by the game and passed along by the UI Engine. The data sent from scripts to this function must be a string. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| Callback | -JavaScript Object | -The callback that will be called when the event happens | -
| EventIdentifier | -String | -Specifies the event that function will react to | -
trigger(EventIdentifier, Arguments)
- -This is used to send events to the UI Engine. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| Arguments | -JavaScript Object | -The arguments passed to the callback | -
| EventIdentifier | -String | -Specifies the event that function will react to | -
Getting The Script Engine
- -In order to create a link between the UI Engine and the Script Engine you need to capture the instance of the Script Engine.The engine.on() function needs to listen for the event "facet:updated:scripting" and you need to store the return value.You will then need to request the script engine by triggering the "facet:request" event and passing it "scripting" in a vector.The order of the calls is important. If you trigger the request before you registered the listener you won't be able to capture the callback.Script Bindings
- - - -triggerEvent(Data)
- -This triggers the minecraft:ui_event on client scripts with the provided data. - -Parameters
- - - -| Name | Type | Description |
|---|---|---|
| Data | -String | -This string will be sent to "minecraft:ui_event" event in client scripts | -
Index
-| Volumes |
|---|
| Volume Components |
| Volume Definition Properties |
| Volume Description Properties |
Volumes
- -Volume Components
- -These are the various possible components for this entity - -| Name | Type | Default Value | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| minecraft:bounds | -- | - | Component that defines a minimum and maximum block position for a bounding box and which world dimension the bounding box is in. Every volume must have a bounds component.
|
-||||||||||||||||
| minecraft:fog | -- | - | Displays the given fog whenever a player enters the volume. Each volume can only have one fog attached.
|
-||||||||||||||||
| minecraft:on_actor_enter | -- | - | Component that defines what happens when an actor enters the volume. Can contain multiple json objects.
|
-||||||||||||||||
| minecraft:on_actor_leave | -- | - | Component that defines what happens when an actor leaves the volume.
|
-
Volume Definition Properties
- -The properties of a minecraft:volume entity. Note that every volume must have a bounds component. All other components are optional. - -| Name | Type | Default Value | Description |
|---|---|---|---|
| format_version | -String | -- | Specifies the version of the game this entity was made in. Minimum supported version is 1.17.0. Current supported version is 1.17.0. | -
Volume Description Properties
- -The description contains a single 'identifier' string - -| Name | Type | Default Value | Description |
|---|---|---|---|
| identifier | -String | -- | The unique identifier for this volume. It must be of the form 'namespace:name', where namespace cannot be 'minecraft'. | -