Custom Trapdoors
intermediate
scripting
FORMAT & MIN ENGINE VERSION 1.21.90
This tutorial assumes a good understanding of blocks and basic knowledge of scripting. Check out the blocks guide before starting.
Trapdoors are versatile blocks that serve well as parts of doors, fences, decorations, and, well — as trapdoors! It's no wonder you want to make your own to add to Minecraft's collection. Here's how it's done:
Block JSON
This is the block JSON you'll need for basic trapdoor functionality. It includes the rotation for each permutation of your trapdoor, meaning it can be placed in the same orientations as vanilla trapdoors.
BP/blocks/custom_trapdoor.json
json
{
"format_version": "1.21.90",
"minecraft:block": {
"description": {
"identifier": "wiki:custom_trapdoor",
"menu_category": {
"category": "construction",
"group": "minecraft:itemGroup.name.trapdoor"
},
"states": {
"wiki:open": [false, true]
},
"traits": {
"minecraft:placement_position": {
"enabled_states": ["minecraft:vertical_half"]
},
"minecraft:placement_direction": {
"enabled_states": ["minecraft:cardinal_direction"]
}
}
},
"components": {
"wiki:toggleable": {
"block_state": "wiki:open",
"enable_sound": "open.wooden_trapdoor",
"disable_sound": "close.wooden_trapdoor"
},
"minecraft:collision_box": {
"origin": [-8, 0, -8],
"size": [16, 2.92, 16]
},
"tag:one_way_collidable": {}, // Prevents the player from being pushed out by the trapdoor collision, just like vanilla
"tag:trapdoors": {},
"minecraft:selection_box": {
"origin": [-8, 0, -8],
"size": [16, 2.92, 16]
},
"minecraft:geometry": {
"identifier": "geometry.trapdoor",
"culling": "wiki:culling.trapdoor"
},
"minecraft:material_instances": {
"*": {
"texture": "wiki:custom_trapdoor",
"render_method": "alpha_test_single_sided"
}
},
"minecraft:liquid_detection": {
"detection_rules": [
{
"liquid_type": "water",
"can_contain_liquid": true
}
]
}
},
"permutations": [
// Top Closed
{
"condition": "q.block_state('minecraft:vertical_half') == 'top' && q.block_state('minecraft:cardinal_direction') == 'north' && !q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [0, 0, 180] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'top' && q.block_state('minecraft:cardinal_direction') == 'south' && !q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [180, 0, 0] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'top' && q.block_state('minecraft:cardinal_direction') == 'east' && !q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [180, 90, 0] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'top' && q.block_state('minecraft:cardinal_direction') == 'west' && !q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [180, -90, 0] }
}
},
// Top Open
{
"condition": "q.block_state('minecraft:vertical_half') == 'top' && q.block_state('minecraft:cardinal_direction') == 'north' && q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [90, 0, 0] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'top' && q.block_state('minecraft:cardinal_direction') == 'south' && q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [-90, 0, 180] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'top' && q.block_state('minecraft:cardinal_direction') == 'east' && q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [0, -90, 90] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'top' && q.block_state('minecraft:cardinal_direction') == 'west' && q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [180, 90, 90] }
}
},
// Bottom Closed
{
"condition": "q.block_state('minecraft:vertical_half') == 'bottom' && q.block_state('minecraft:cardinal_direction') == 'north' && !q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [0, 0, 0] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'bottom' && q.block_state('minecraft:cardinal_direction') == 'south' && !q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [0, 180, 0] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'bottom' && q.block_state('minecraft:cardinal_direction') == 'east' && !q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [0, -90, 0] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'bottom' && q.block_state('minecraft:cardinal_direction') == 'west' && !q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [0, 90, 0] }
}
},
// Bottom Open
{
"condition": "q.block_state('minecraft:vertical_half') == 'bottom' && q.block_state('minecraft:cardinal_direction') == 'north' && q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [90, 0, 180] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'bottom' && q.block_state('minecraft:cardinal_direction') == 'south' && q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [-90, 0, 0] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'bottom' && q.block_state('minecraft:cardinal_direction') == 'east' && q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [0, 90, 90] }
}
},
{
"condition": "q.block_state('minecraft:vertical_half') == 'bottom' && q.block_state('minecraft:cardinal_direction') == 'west' && q.block_state('wiki:open')",
"components": {
"minecraft:transformation": { "rotation": [180, -90, 90] }
}
}
]
}
}Custom Component Script
Now, it's time to put these permutations to use. The following script will allow the player to open and close the trapdoor by interacting with it. Don't forget to import this script into your main script entry.
BP/scripts/custom_trapdoor.js
js
import { system } from "@minecraft/server";
/** @type {import("@minecraft/server").BlockCustomComponent} */
const BlockToggleableComponent = {
onPlayerInteract({ block, dimension }, { params }) {
const currentValue = block.permutation.getState(params.block_state);
const toggledValue = !currentValue;
const toggleableState = params.block_state;
const toggleSound = toggledValue ? params.enable_sound : params.disable_sound;
block.setPermutation(block.permutation.withState(toggleableState, toggledValue));
dimension.playSound(toggleSound, block.center());
},
};
system.beforeEvents.startup.subscribe(({ blockComponentRegistry }) => {
blockComponentRegistry.registerCustomComponent("wiki:toggleable", BlockToggleableComponent);
});Block Model & Culling
This will be the geometry used for your custom trapdoors.
Geometry JSON
RP/models/blocks/trapdoor.geo.json
json
{
"format_version": "1.21.90",
"minecraft:geometry": [
{
"description": {
"identifier": "geometry.trapdoor",
"texture_width": 16,
"texture_height": 16
},
"bones": [
{
"name": "trapdoor",
"pivot": [0, 0, 0],
"cubes": [
{
"origin": [-8, 0, -8],
"size": [16, 2.9, 16],
"uv": {
"north": { "uv": [16, 3], "uv_size": [-16, -3] },
"east": { "uv": [16, 3], "uv_size": [-16, -3] },
"south": { "uv": [16, 3], "uv_size": [-16, -3] },
"west": { "uv": [16, 3], "uv_size": [-16, -3] },
"up": { "uv": [16, 16], "uv_size": [-16, -16] },
"down": { "uv": [0, 0], "uv_size": [16, 16] }
}
}
]
}
],
"item_display_transforms": {
"firstperson_righthand": {
"translation": [0, 2.6, 0]
},
"thirdperson_righthand": {
"translation": [0, 3.35, 2.25],
"rotation": [70, 225, 0]
},
"fixed": {
"translation": [0, 3.45, 0]
},
"gui": {
"fit_to_frame": false,
"translation": [0, -0.15, 0],
"scale": [0.625, 0.625, 0.625]
},
"ground": {
"translation": [0, 4.65, 0]
}
}
}
]
}Block Culling Rules JSON
RP/block_culling/trapdoor.json
json
{
"format_version": "1.21.80",
"minecraft:block_culling_rules": {
"description": {
"identifier": "wiki:culling.trapdoor"
},
"rules": [
{
"direction": "down",
"geometry_part": {
"bone": "trapdoor",
"cube": 0,
"face": "down"
}
},
{
"direction": "north",
"geometry_part": {
"bone": "trapdoor",
"cube": 0,
"face": "north"
}
},
{
"direction": "south",
"geometry_part": {
"bone": "trapdoor",
"cube": 0,
"face": "south"
}
},
{
"direction": "west",
"geometry_part": {
"bone": "trapdoor",
"cube": 0,
"face": "west"
}
},
{
"direction": "east",
"geometry_part": {
"bone": "trapdoor",
"cube": 0,
"face": "east"
}
}
]
}
}Contributors
Text and image content on this page is licensed under the Creative Commons Attribution 4.0 International License
Code samples on this page are licensed under the MIT License