Brush-related expressions

src/main/java/ch/njol/skript/expressions/ExprBrushableItem.java

@@ -0,0 +1,78 @@
+package ch.njol.skript.expressions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.classes.Changer;
+import ch.njol.skript.classes.Changer.ChangeMode;
+import ch.njol.skript.doc.*;
+import ch.njol.skript.expressions.base.SimplePropertyExpression;
+import ch.njol.util.coll.CollectionUtils;
+import org.bukkit.block.Block;
+import org.bukkit.block.BrushableBlock;
+import org.bukkit.block.BlockState;
+import org.bukkit.event.Event;
+import org.bukkit.inventory.ItemStack;
+import org.jetbrains.annotations.Nullable;
+
+@Name("Buried Item")
+@Description({
+	"Represents the item that is uncovered when dusting.",
+	"The only blocks that can currently be \"dusted\" are Suspicious Gravel and Suspicious Sand."
+})
+@Examples({
+	"send target block's brushable item",
+	"set {_gravel}'s brushable item to emerald"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Minecraft 1.20+")
+public class ExprBrushableItem extends SimplePropertyExpression<Block, ItemStack> {
+
+	private static final boolean SUPPORTS_DUSTING = Skript.classExists("org.bukkit.block.BrushableBlock");
+
+	static {
+		if (SUPPORTS_DUSTING)
+			register(ExprBrushableItem.class, ItemStack.class,
+				"(brushable|buried) item",
+				"blocks");
+	}
+
+	@Override
+	public @Nullable ItemStack convert(Block block) {
+		if (block.getState() instanceof BrushableBlock brushableBlock) {
+			return brushableBlock.getItem();
+		}
+		return null;
+	}
+
+	@Override
+	public Class<?> @Nullable [] acceptChange(ChangeMode mode) {
+		if (mode == ChangeMode.SET || mode == ChangeMode.DELETE) {
+			return CollectionUtils.array(ItemStack.class);
+		}
+		return null;
+	}
+
+	@Override
+	public void change(Event event, Object @Nullable [] delta, ChangeMode mode) {
+		if (mode == ChangeMode.SET || mode == ChangeMode.DELETE) {
+			ItemStack newItem = (mode == ChangeMode.SET) ? (ItemStack) delta[0] : null;
+			for (Block block : getExpr().getArray(event)) {
+				BlockState state = block.getState();
+				if (state instanceof BrushableBlock brushableBlock) {
+					brushableBlock.setItem(newItem);
+					state.update();
+				}
+			}
+		}
+	}
+
+	@Override
+	public Class<? extends ItemStack> getReturnType() {
+		return ItemStack.class;
+	}
+
+	@Override
+	protected String getPropertyName() {
+		return "brushable item";
+	}
+
+}

src/main/java/ch/njol/skript/expressions/ExprDustedStage.java

@@ -0,0 +1,140 @@
+package ch.njol.skript.expressions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.classes.Changer.ChangeMode;
+import ch.njol.skript.doc.*;
+import ch.njol.skript.expressions.base.PropertyExpression;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.util.Kleenean;
+import ch.njol.util.coll.CollectionUtils;
+import org.bukkit.block.Block;
+import org.bukkit.block.data.BlockData;
+import org.bukkit.block.data.Brushable;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+
+@Name("Dusted Stage")
+@Description({
+	"Represents how far the block has been uncovered.",
+	"The only blocks that can currently be \"dusted\" are Suspicious Gravel and Suspicious Sand."
+})
+@Examples({
+	"send target block's maximum dusted stage",
+	"set {_sand}'s dusted stage to 2"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Minecraft 1.20+")
+public class ExprDustedStage extends PropertyExpression<Object, Integer> {
+
+	private static final boolean SUPPORTS_DUSTING = Skript.classExists("org.bukkit.block.data.Brushable");
+
+	static {
+		if (SUPPORTS_DUSTING)
+			register(ExprDustedStage.class, Integer.class,
+				"[:max[imum]] dust[ed|ing] (value|stage|progress[ion])",
+				"blocks/blockdatas");
+	}
+
+	private boolean isMax;
+
+	@Override
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		setExpr((Expression<Block>) exprs[0]);
+		isMax = parseResult.hasTag("max");
+		return true;
+	}
+
+	@Override
+	protected Integer @Nullable [] get(Event event, Object[] source) {
+		return get(source, obj -> {
+			Brushable brushable = getBrushable(obj);
+			if (brushable != null) {
+				return isMax ? brushable.getMaximumDusted() : brushable.getDusted();
+			}
+			return null;
+		});
+	}
+
+	@Override
+	public Class<?> @Nullable [] acceptChange(ChangeMode mode) {
+		if (isMax) {
+			Skript.error("Attempting to modify the max dusted stage is not supported.");
+			return null;
+		}
+
+		return switch (mode) {
+			case SET, ADD, REMOVE, RESET -> CollectionUtils.array(Integer.class);
+			default -> null;
+		};
+	}
+
+	@Override
+	public void change(Event event, Object @Nullable [] delta, ChangeMode mode) {
+		if (isMax) return;
+		Integer value = (delta != null && delta.length > 0) ? (Integer) delta[0] : null;
+
+		for (Object obj : getExpr().getArray(event)) {
+			Brushable brushable = getBrushable(obj);
+			if (brushable == null)
+				continue;
+
+			int currentValue = brushable.getDusted();
+			int maxValue = brushable.getMaximumDusted();
+			int newValue = currentValue;
+
+			switch (mode) {
+				case SET -> {
+					if (value != null) {
+						newValue = value;
+					}
+				}
+				case ADD -> {
+					if (value != null) {
+						newValue = currentValue + value;
+					}
+				}
+				case REMOVE -> {
+					if (value != null) {
+						newValue = currentValue - value;
+					}
+				}
+				case RESET -> newValue = 0;
+				default -> {
+					return;
+				}
+			}
+
+			newValue = Math.max(0, Math.min(newValue, maxValue));
+
+			brushable.setDusted(newValue);
+			if (obj instanceof Block) {
+				((Block) obj).setBlockData(brushable);
+			}
+		}
+	}
+
+	@Nullable
+	private Brushable getBrushable(Object obj) {
+		if (obj instanceof Block block) {
+			BlockData blockData = block.getBlockData();
+			if (blockData instanceof Brushable)
+				return (Brushable) blockData;
+		} else if (obj instanceof Brushable brushable) {
+			return brushable;
+		}
+		return null;
+	}
+
+
+	@Override
+	public Class<? extends Integer> getReturnType() {
+		return Integer.class;
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return getExpr().toString(event, debug) + "'s " + (isMax ? "maximum " : "") + " dusted stage";
+	}
+
+}

src/test/skript/tests/syntaxes/expressions/ExprDusted.sk

@@ -0,0 +1,57 @@
+test "Dusted Stage" when running minecraft "1.20":
+    set block 1 block under event-location to stone
+    set block at event-location to suspicious gravel
+    set {_block} to block at event-location
+    set {_blockdata} to block data of {_block}
+
+    set dusted stage of {_block} to 2
+    assert dusted stage of {_block} is 2 with "Failed to set dusted stage to 2"
+
+    assert maximum dusted stage of {_block} is 3 with "Maximum dusted stage should be 3"
+
+    add 1 to dusted stage of {_block}
+    assert dusted stage of {_block} is 3 with "Failed to add 1 to dusted stage"
+
+    add 5 to dusted stage of {_block}
+    assert dusted stage of {_block} is 3 with "Dusted stage should be capped at maximum value"
+
+    remove 2 from dusted stage of {_block}
+    assert dusted stage of {_block} is 1 with "Failed to remove 2 from dusted stage"
+
+    remove 5 from dusted stage of {_block}
+    assert dusted stage of {_block} is 0 with "Dusted stage should be capped at minimum value"
+
+    set dusted stage of {_block} to 2
+    reset dusted stage of {_block}
+    assert dusted stage of {_block} is 0 with "Failed to reset dusted stage"
+
+    set dusted stage of {_blockdata} to 2
+    assert dusted stage of {_blockdata} is 2 with "Failed to set dusted stage on blockdata"
+
+    set block at event-location to suspicious sand
+    set {_sand} to block at event-location
+
+    set dusted stage of {_sand} to 1
+    assert dusted stage of {_sand} is 1 with "Failed to set dusted stage on suspicious sand"
+    add 1 to dusted stage of {_sand}
+    assert dusted stage of {_sand} is 2 with "Failed to add to dusted stage on suspicious sand"
+
+    set block at event-location to air
+    set block 1 block under event-location to air
+
+test "Brushable Item" when running minecraft "1.20":
+	set block 1 block under event-location to stone
+	set block at event-location to suspicious gravel
+	set {_block} to block at event-location
+
+	set {_block}'s brushable item to gold nugget
+	assert {_block}'s brushable item is gold nugget with "Failed to set brushable item to gold nugget"
+
+	set {_block}'s brushable item to diamond
+	assert {_block}'s brushable item is diamond with "Failed to set brushable item to diamond"
+
+	set {_block}'s brushable item to air
+	assert {_block}'s brushable item is air with "Failed to clear brushable item"
+	set block at {_block} to air
+	set block 1 block under {_block} to air
+