Add BlockState.getMaterial()

TomyLobo · TomyLobo · commit 20503ddf462b · 2026-04-30T03:52:54.000+02:00
diff --git a/verification/src/changes/accepted-bukkit-public-api-changes.json b/verification/src/changes/accepted-bukkit-public-api-changes.json
@@ -8,5 +8,15 @@
                 "ANNOTATION_REMOVED"
             ]
         }
+    ],
+    "Replaced by default method": [
+        {
+            "type": "com.sk89q.worldedit.bukkit.BukkitBlockRegistry",
+            "member": "Method com.sk89q.worldedit.bukkit.BukkitBlockRegistry.getMaterial(com.sk89q.worldedit.world.block.BlockType)",
+            "changes": [
+                "METHOD_REMOVED",
+                "ANNOTATION_REMOVED"
+            ]
+        }
     ]
 }
diff --git a/verification/src/changes/accepted-sponge-public-api-changes.json b/verification/src/changes/accepted-sponge-public-api-changes.json
@@ -1,2 +1,11 @@
 {
+    "Replaced by default method": [
+        {
+            "type": "com.sk89q.worldedit.sponge.SpongeBlockRegistry",
+            "member": "Method com.sk89q.worldedit.sponge.SpongeBlockRegistry.getMaterial(com.sk89q.worldedit.world.block.BlockType)",
+            "changes": [
+                "METHOD_REMOVED"
+            ]
+        }
+    ]
 }
diff --git a/worldedit-bukkit/adapters/adapter-1.21.11/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_11/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-1.21.11/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_11/PaperweightAdapter.java
@@ -586,6 +586,11 @@ public BlockMaterial getBlockMaterial(BlockType blockType) {
         return new PaperweightBlockMaterial(mcBlockState);
     }
 
+    @Override
+    public BlockMaterial getBlockMaterial(BlockState blockState) {
+        return new PaperweightBlockMaterial(adapt(blockState));
+    }
+
     @SuppressWarnings({ "unchecked", "rawtypes" })
     private static final LoadingCache<net.minecraft.world.level.block.state.properties.Property, Property<?>> PROPERTY_CACHE = CacheBuilder.newBuilder().build(new CacheLoader<>() {
         @Override
diff --git a/worldedit-bukkit/adapters/adapter-1.21.4/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_4/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-1.21.4/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_4/PaperweightAdapter.java
@@ -567,6 +567,11 @@ public BlockMaterial getBlockMaterial(BlockType blockType) {
         return new PaperweightBlockMaterial(mcBlockState);
     }
 
+    @Override
+    public BlockMaterial getBlockMaterial(BlockState blockState) {
+        return new PaperweightBlockMaterial(adapt(blockState));
+    }
+
     @SuppressWarnings({ "unchecked", "rawtypes" })
     private static final LoadingCache<net.minecraft.world.level.block.state.properties.Property, Property<?>> PROPERTY_CACHE = CacheBuilder.newBuilder().build(new CacheLoader<>() {
         @Override
diff --git a/worldedit-bukkit/adapters/adapter-1.21.5/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_5/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-1.21.5/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_5/PaperweightAdapter.java
@@ -565,6 +565,11 @@ public BlockMaterial getBlockMaterial(BlockType blockType) {
         return new PaperweightBlockMaterial(mcBlockState);
     }
 
+    @Override
+    public BlockMaterial getBlockMaterial(BlockState blockState) {
+        return new PaperweightBlockMaterial(adapt(blockState));
+    }
+
     @SuppressWarnings({ "unchecked", "rawtypes" })
     private static final LoadingCache<net.minecraft.world.level.block.state.properties.Property, Property<?>> PROPERTY_CACHE = CacheBuilder.newBuilder().build(new CacheLoader<>() {
         @Override
diff --git a/worldedit-bukkit/adapters/adapter-1.21.6/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_6/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-1.21.6/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_6/PaperweightAdapter.java
@@ -587,6 +587,11 @@ public BlockMaterial getBlockMaterial(BlockType blockType) {
         return new PaperweightBlockMaterial(mcBlockState);
     }
 
+    @Override
+    public BlockMaterial getBlockMaterial(BlockState blockState) {
+        return new PaperweightBlockMaterial(adapt(blockState));
+    }
+
     @SuppressWarnings({ "unchecked", "rawtypes" })
     private static final LoadingCache<net.minecraft.world.level.block.state.properties.Property, Property<?>> PROPERTY_CACHE = CacheBuilder.newBuilder().build(new CacheLoader<>() {
         @Override
diff --git a/worldedit-bukkit/adapters/adapter-1.21.9/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_9/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-1.21.9/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_21_9/PaperweightAdapter.java
@@ -586,6 +586,11 @@ public BlockMaterial getBlockMaterial(BlockType blockType) {
         return new PaperweightBlockMaterial(mcBlockState);
     }
 
+    @Override
+    public BlockMaterial getBlockMaterial(BlockState blockState) {
+        return new PaperweightBlockMaterial(adapt(blockState));
+    }
+
     @SuppressWarnings({ "unchecked", "rawtypes" })
     private static final LoadingCache<net.minecraft.world.level.block.state.properties.Property, Property<?>> PROPERTY_CACHE = CacheBuilder.newBuilder().build(new CacheLoader<>() {
         @Override
diff --git a/worldedit-bukkit/adapters/adapter-26.1/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v26_1/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-26.1/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v26_1/PaperweightAdapter.java
@@ -603,6 +603,11 @@ public BlockMaterial getBlockMaterial(BlockType blockType) {
         return new PaperweightBlockMaterial(mcBlockState);
     }
 
+    @Override
+    public BlockMaterial getBlockMaterial(BlockState blockState) {
+        return new PaperweightBlockMaterial(adapt(blockState));
+    }
+
     @SuppressWarnings({ "unchecked", "rawtypes" })
     private static final LoadingCache<net.minecraft.world.level.block.state.properties.Property, Property<?>> PROPERTY_CACHE = CacheBuilder.newBuilder().build(new CacheLoader<>() {
         @Override
diff --git a/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/BukkitBlockRegistry.java b/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/BukkitBlockRegistry.java
@@ -47,15 +47,15 @@ public Component getRichName(BlockType blockType) {
 
     @Nullable
     @Override
-    public BlockMaterial getMaterial(BlockType blockType) {
-        Material mat = BukkitAdapter.adapt(blockType);
+    public BlockMaterial getMaterial(BlockState blockState) {
+        Material mat = BukkitAdapter.adapt(blockState.getBlockType());
         if (mat == null) {
             return null;
         }
         return materialMap.computeIfAbsent(mat, material -> {
             BlockMaterial platformMaterial = null;
             if (WorldEditPlugin.getInstance().getBukkitImplAdapter() != null) {
-                platformMaterial = WorldEditPlugin.getInstance().getBukkitImplAdapter().getBlockMaterial(blockType);
+                platformMaterial = WorldEditPlugin.getInstance().getBukkitImplAdapter().getBlockMaterial(blockState);
             }
             return new BukkitBlockMaterial(platformMaterial, material);
         });
diff --git a/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/adapter/BukkitImplAdapter.java b/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/adapter/BukkitImplAdapter.java
@@ -161,6 +161,17 @@ default void tickWatchdog() {
     @Nullable
     BlockMaterial getBlockMaterial(BlockType blockType);
 
+    /**
+     * Gets the block material for the given block state.
+     *
+     * @param blockState the block state
+     * @return the material
+     */
+    @Nullable
+    default BlockMaterial getBlockMaterial(BlockState blockState) {
+        return getBlockMaterial(blockState.getBlockType());
+    }
+
     /**
      * Get a map of {@code string -> property}.
      *
diff --git a/worldedit-core-mc/src/main/java/com/sk89q/worldedit/coremc/internal/CoreMcBlockRegistry.java b/worldedit-core-mc/src/main/java/com/sk89q/worldedit/coremc/internal/CoreMcBlockRegistry.java
@@ -52,10 +52,9 @@ public Component getRichName(BlockType blockType) {
     }
 
     @Override
-    public BlockMaterial getMaterial(BlockType blockType) {
-        Block block = platform.getAdapter().toNativeBlock(blockType);
+    public BlockMaterial getMaterial(BlockState blockState) {
         return materialMap.computeIfAbsent(
-            block.defaultBlockState(),
+            platform.getAdapter().toNativeBlockState(blockState),
             CoreMcBlockMaterial::new
         );
     }
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/world/block/BlockState.java b/worldedit-core/src/main/java/com/sk89q/worldedit/world/block/BlockState.java
@@ -19,9 +19,12 @@
 
 package com.sk89q.worldedit.world.block;
 
+import com.sk89q.worldedit.WorldEdit;
+import com.sk89q.worldedit.extension.platform.Capability;
 import com.sk89q.worldedit.internal.block.BlockStateIdAccess;
 import com.sk89q.worldedit.registry.state.Property;
 import com.sk89q.worldedit.util.concurrency.LazyReference;
+import com.sk89q.worldedit.world.registry.BlockMaterial;
 import org.enginehub.linbus.tree.LinCompoundTag;
 
 import java.util.HashSet;
@@ -74,6 +77,11 @@ public BlockType getBlockType() {
         return this.blockType;
     }
 
+    public BlockMaterial getMaterial() {
+        return WorldEdit.getInstance().getPlatformManager()
+                .queryCapability(Capability.GAME_HOOKS).getRegistries().getBlockRegistry().getMaterial(this);
+    }
+
     @Override
     public <V> BlockState with(final Property<V> property, final V value) {
         if (this.stateListIndex == -1) {
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/world/block/BlockType.java b/worldedit-core/src/main/java/com/sk89q/worldedit/world/block/BlockType.java
@@ -72,7 +72,7 @@ public class BlockType implements Keyed {
     @SuppressWarnings("this-escape")
     private final LazyReference<BlockMaterial> blockMaterial
         = LazyReference.from(() -> WorldEdit.getInstance().getPlatformManager()
-        .queryCapability(Capability.GAME_HOOKS).getRegistries().getBlockRegistry().getMaterial(this));
+        .queryCapability(Capability.GAME_HOOKS).getRegistries().getBlockRegistry().getMaterial(getDefaultState()));
     @SuppressWarnings("this-escape")
     @Deprecated
     private final LazyReference<String> name = LazyReference.from(() -> WorldEdit.getInstance().getPlatformManager()
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/world/registry/BlockRegistry.java b/worldedit-core/src/main/java/com/sk89q/worldedit/world/registry/BlockRegistry.java
@@ -19,6 +19,7 @@
 
 package com.sk89q.worldedit.world.registry;
 
+import com.sk89q.worldedit.internal.util.NonAbstractForCompatibility;
 import com.sk89q.worldedit.registry.state.Property;
 import com.sk89q.worldedit.util.formatting.text.Component;
 import com.sk89q.worldedit.world.block.BlockState;
@@ -59,9 +60,30 @@ default String getName(BlockType blockType) {
      *
      * @param blockType the block
      * @return the material, or null if the material information is not known
+     * @deprecated Use {@link BlockRegistry#getMaterial(BlockState)} instead.
      */
+    @Deprecated
     @Nullable
-    BlockMaterial getMaterial(BlockType blockType);
+    default BlockMaterial getMaterial(BlockType blockType) {
+        return getMaterial(blockType.getDefaultState());
+    }
+
+    /**
+     * Get the material for the given block state.
+     *
+     * @param blockState the block state
+     * @return the material, or null if the material information is not known
+     * @apiNote This must be overridden by new subclasses. See {@link NonAbstractForCompatibility}
+     *          for details
+     */
+    @NonAbstractForCompatibility(
+        delegateName = "getMaterial",
+        delegateParams = { BlockType.class }
+    )
+    @Nullable
+    default BlockMaterial getMaterial(BlockState blockState) {
+        return getMaterial(blockState.getBlockType());
+    }
 
     /**
      * Get an unmodifiable map of states for this block.
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/world/registry/BundledBlockRegistry.java b/worldedit-core/src/main/java/com/sk89q/worldedit/world/registry/BundledBlockRegistry.java
@@ -69,8 +69,8 @@ public String getName(BlockType blockType) {
 
     @Nullable
     @Override
-    public BlockMaterial getMaterial(BlockType blockType) {
-        return new PassthroughBlockMaterial(BundledBlockData.getInstance().getMaterialById(blockType.id()));
+    public BlockMaterial getMaterial(BlockType blockState) {
+        return new PassthroughBlockMaterial(BundledBlockData.getInstance().getMaterialById(blockState.id()));
     }
 
     @Nullable
diff --git a/worldedit-sponge/src/main/java/com/sk89q/worldedit/sponge/SpongeBlockRegistry.java b/worldedit-sponge/src/main/java/com/sk89q/worldedit/sponge/SpongeBlockRegistry.java
@@ -50,19 +50,16 @@ public Component getRichName(BlockType blockType) {
     }
 
     @Override
-    public BlockMaterial getMaterial(BlockType blockType) {
-        org.spongepowered.api.block.BlockType spongeBlockType =
-            Sponge.game().registry(RegistryTypes.BLOCK_TYPE)
-                .value(ResourceKey.resolve(blockType.id()));
+    public BlockMaterial getMaterial(BlockState blockState) {
         return materialMap.computeIfAbsent(
-            spongeBlockType.defaultState(),
-            m -> {
-                net.minecraft.world.level.block.state.BlockState blockState =
-                    (net.minecraft.world.level.block.state.BlockState) m;
-                return new SpongeBlockMaterial(
-                    blockState
-                );
-            }
+                SpongeAdapter.adapt(blockState),
+                m -> {
+                    net.minecraft.world.level.block.state.BlockState mcBlockState =
+                            (net.minecraft.world.level.block.state.BlockState) m;
+                    return new SpongeBlockMaterial(
+                            mcBlockState
+                    );
+                }
         );
     }
 

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,15 @@`
`8`	`8`	`"ANNOTATION_REMOVED"`
`9`	`9`	`]`
`10`	`10`	`}`
	`11`	`+ ],`
	`12`	`+ "Replaced by default method": [`
	`13`	`+ {`
	`14`	`+ "type": "com.sk89q.worldedit.bukkit.BukkitBlockRegistry",`
	`15`	`+ "member": "Method com.sk89q.worldedit.bukkit.BukkitBlockRegistry.getMaterial(com.sk89q.worldedit.world.block.BlockType)",`
	`16`	`+ "changes": [`
	`17`	`+ "METHOD_REMOVED",`
	`18`	`+ "ANNOTATION_REMOVED"`
	`19`	`+ ]`
	`20`	`+ }`
`11`	`21`	`]`
`12`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,11 @@`
`1`	`1`	`{`
	`2`	`+ "Replaced by default method": [`
	`3`	`+ {`
	`4`	`+ "type": "com.sk89q.worldedit.sponge.SpongeBlockRegistry",`
	`5`	`+ "member": "Method com.sk89q.worldedit.sponge.SpongeBlockRegistry.getMaterial(com.sk89q.worldedit.world.block.BlockType)",`
	`6`	`+ "changes": [`
	`7`	`+ "METHOD_REMOVED"`
	`8`	`+ ]`
	`9`	`+ }`
	`10`	`+ ]`
`2`	`11`	`}`