From 1dacb882e0b4293a21bed2f135b3ebc01c0fe065 Mon Sep 17 00:00:00 2001 From: Dennis C Date: Sun, 17 Jul 2022 23:27:48 +0200 Subject: [PATCH] [1.18] Allow blocks to provide a dynamic MaterialColor for display on maps (#8855) --- .../block/state/BlockBehaviour.java.patch | 3 +- .../common/extensions/IForgeBlock.java | 15 +++++ .../debug/block/DynamicMapColorTest.java | 60 +++++++++++++++++++ src/test/resources/META-INF/mods.toml | 2 + .../blockstates/test_block.json | 5 ++ .../models/item/test_block.json | 3 + 6 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 src/test/java/net/minecraftforge/debug/block/DynamicMapColorTest.java create mode 100644 src/test/resources/assets/dyn_map_color_test/blockstates/test_block.json create mode 100644 src/test/resources/assets/dyn_map_color_test/models/item/test_block.json diff --git a/patches/minecraft/net/minecraft/world/level/block/state/BlockBehaviour.java.patch b/patches/minecraft/net/minecraft/world/level/block/state/BlockBehaviour.java.patch index cf662902d0..cc5be4be2b 100644 --- a/patches/minecraft/net/minecraft/world/level/block/state/BlockBehaviour.java.patch +++ b/patches/minecraft/net/minecraft/world/level/block/state/BlockBehaviour.java.patch @@ -89,7 +89,8 @@ } public MaterialColor m_60780_(BlockGetter p_60781_, BlockPos p_60782_) { - return this.f_60598_; +- return this.f_60598_; ++ return m_60734_().getMapColor(this.m_7160_(), p_60781_, p_60782_, this.f_60598_); } + /** @deprecated use {@link BlockState#rotate(LevelAccessor, BlockPos, Rotation)} */ diff --git a/src/main/java/net/minecraftforge/common/extensions/IForgeBlock.java b/src/main/java/net/minecraftforge/common/extensions/IForgeBlock.java index e2aa48bf1e..c86f1ca103 100644 --- a/src/main/java/net/minecraftforge/common/extensions/IForgeBlock.java +++ b/src/main/java/net/minecraftforge/common/extensions/IForgeBlock.java @@ -24,7 +24,9 @@ import net.minecraft.world.entity.projectile.WitherSkull; import net.minecraft.world.item.*; import net.minecraft.world.item.context.UseOnContext; import net.minecraft.world.level.block.*; +import net.minecraft.world.level.block.state.BlockBehaviour; import net.minecraft.world.level.material.FluidState; +import net.minecraft.world.level.material.MaterialColor; import net.minecraft.world.level.pathfinder.BlockPathTypes; import net.minecraft.tags.BlockTags; import net.minecraft.core.Direction; @@ -845,4 +847,17 @@ public interface IForgeBlock * @param newState The new state of the block at the given position */ default void onBlockStateChange(LevelReader level, BlockPos pos, BlockState oldState, BlockState newState) { } + + /** + * Returns the {@link MaterialColor} shown on the map. + * + * @param state The state of this block + * @param level The level this block is in + * @param pos The blocks position in the level + * @param defaultColor The {@code MaterialColor} configured for the given {@code BlockState} in the {@link BlockBehaviour.Properties} + */ + default MaterialColor getMapColor(BlockState state, BlockGetter level, BlockPos pos, MaterialColor defaultColor) + { + return defaultColor; + } } diff --git a/src/test/java/net/minecraftforge/debug/block/DynamicMapColorTest.java b/src/test/java/net/minecraftforge/debug/block/DynamicMapColorTest.java new file mode 100644 index 0000000000..95c133c2d8 --- /dev/null +++ b/src/test/java/net/minecraftforge/debug/block/DynamicMapColorTest.java @@ -0,0 +1,60 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ + +package net.minecraftforge.debug.block; + +import net.minecraft.core.BlockPos; +import net.minecraft.world.item.BlockItem; +import net.minecraft.world.item.Item; +import net.minecraft.world.level.BlockGetter; +import net.minecraft.world.level.block.Block; +import net.minecraft.world.level.block.state.BlockState; +import net.minecraft.world.level.material.Material; +import net.minecraft.world.level.material.MaterialColor; +import net.minecraftforge.eventbus.api.IEventBus; +import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; +import net.minecraftforge.registries.*; + +@Mod(DynamicMapColorTest.MOD_ID) +public class DynamicMapColorTest +{ + public static final String MOD_ID = "dyn_map_color_test"; + + private static final DeferredRegister BLOCKS = DeferredRegister.create(ForgeRegistries.BLOCKS, MOD_ID); + private static final DeferredRegister ITEMS = DeferredRegister.create(ForgeRegistries.ITEMS, MOD_ID); + + private static final RegistryObject TEST_BLOCK = BLOCKS.register("test_block", TestBlock::new); + private static final RegistryObject TEST_BLOCK_ITEM = ITEMS.register("test_block", () -> new BlockItem( + TEST_BLOCK.get(), + new Item.Properties() + )); + + public DynamicMapColorTest() + { + IEventBus modBus = FMLJavaModLoadingContext.get().getModEventBus(); + BLOCKS.register(modBus); + ITEMS.register(modBus); + } + + private static class TestBlock extends Block + { + public TestBlock() + { + super(Properties.of(Material.GLASS)); + } + + @Override + public MaterialColor getMapColor(BlockState state, BlockGetter level, BlockPos pos, MaterialColor defaultColor) + { + BlockState below = level.getBlockState(pos.below()); + if (!below.isAir()) + { + return below.getMapColor(level, pos); + } + return defaultColor; + } + } +} diff --git a/src/test/resources/META-INF/mods.toml b/src/test/resources/META-INF/mods.toml index 692741a286..422aaac357 100644 --- a/src/test/resources/META-INF/mods.toml +++ b/src/test/resources/META-INF/mods.toml @@ -232,5 +232,7 @@ license="LGPL v2.1" modId="mod_mismatch_test" [[mods]] modId="blockstate_change_test" +[[mods]] + modId="dyn_map_color_test" # ADD ABOVE THIS LINE diff --git a/src/test/resources/assets/dyn_map_color_test/blockstates/test_block.json b/src/test/resources/assets/dyn_map_color_test/blockstates/test_block.json new file mode 100644 index 0000000000..9fad80f416 --- /dev/null +++ b/src/test/resources/assets/dyn_map_color_test/blockstates/test_block.json @@ -0,0 +1,5 @@ +{ + "variants": { + "": { "model": "minecraft:block/glass" } + } +} \ No newline at end of file diff --git a/src/test/resources/assets/dyn_map_color_test/models/item/test_block.json b/src/test/resources/assets/dyn_map_color_test/models/item/test_block.json new file mode 100644 index 0000000000..df778dc059 --- /dev/null +++ b/src/test/resources/assets/dyn_map_color_test/models/item/test_block.json @@ -0,0 +1,3 @@ +{ + "parent": "minecraft:item/glass" +} \ No newline at end of file