Merge branch 'dev/patch' into dev/feature

Author: APickledWalrus

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

@@ -7,38 +7,48 @@
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.util.Kleenean;
+import ch.njol.util.Math2;
 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."
-})
-@Example("send target block's maximum dusted stage")
-@Example("set {_sand}'s dusted stage to 2")
+@Name("Brushing Stage")
+@Description("""
+	Represents how far the block has been uncovered.
+	The only blocks that can currently be "brushed" are Suspicious Gravel and Suspicious Sand.
+	0 means the block is untouched, the max (usually 3) means nearly fulled brushed.
+	Resetting this value will set it to 0.
+	""")
+@Example("""
+	# prevent dusting past level 1
+	on player change block:
+		if dusting progress of future event-blockdata > 1:
+			cancel event
+	""")
+@Example("""
+	# draw particles when dusting is complete!
+	on player change block:
+		if brushing progress of event-block is max brushing stage of event-block:
+			draw 20 totem of undying particles at event-block
+	""")
 @Since("2.12")
-@RequiredPlugins("Minecraft 1.20+")
+@Keywords({"brush", "brushing", "dusting"})
 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");
+		register(ExprDustedStage.class, Integer.class,
+			"[:max[imum]] (dust|brush)[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]);
+		setExpr(exprs[0]);
 		isMax = parseResult.hasTag("max");
 		return true;
 	}
@@ -70,7 +80,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
 	@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;
+		int value = delta == null ? 0 : (Integer) delta[0];
 
 		for (Object obj : getExpr().getArray(event)) {
 			Brushable brushable = getBrushable(obj);
@@ -79,35 +89,15 @@ public void change(Event event, Object @Nullable [] delta, ChangeMode mode) {
 
 			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);
+			long newValue = switch (mode) {
+				case SET, RESET -> value;
+				case ADD -> Math2.addClamped(currentValue, value);
+				case REMOVE -> Math2.addClamped(currentValue, -value);
+				default -> throw new IllegalArgumentException("Change mode " + mode + " is not valid for ExprDustedStage!");
+			};
+			brushable.setDusted(Math.clamp(newValue, 0, maxValue));
+			if (obj instanceof Block block) {
+				block.setBlockData(brushable);
 			}
 		}
 	}
@@ -116,15 +106,14 @@ public void change(Event event, Object @Nullable [] delta, ChangeMode mode) {
 	private Brushable getBrushable(Object obj) {
 		if (obj instanceof Block block) {
 			BlockData blockData = block.getBlockData();
-			if (blockData instanceof Brushable)
-				return (Brushable) blockData;
+			if (blockData instanceof Brushable brushable)
+				return brushable;
 		} else if (obj instanceof Brushable brushable) {
 			return brushable;
 		}
 		return null;
 	}
 
-
 	@Override
 	public Class<? extends Integer> getReturnType() {
 		return Integer.class;

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

@@ -0,0 +1,46 @@
+test "dusting progress":
+	set {_old} to block data of test-block
+	set block at test-block to suspicious gravel
+	set {_block} to block at test-block
+	set {_blockdata} to block data of {_block}
+
+	# test getting initial value
+	assert dusting progress of {_block} is 0 with "Initial dusting progress should be 0"
+
+	# test setting
+	set dusting progress of {_block} to 2
+	assert dusting progress of {_block} is 2 with "Failed to set dusting progress to 2"
+
+	# test max dusting progress
+	assert max dusting progress of {_block} is 3 with "Max dusting progress should be 3"
+	assert maximum dusting progress of {_block} is 3 with "Maximum dusting progress should be 3"
+
+	# test adding
+	set dusting progress of {_block} to 1
+	add 1 to dusting progress of {_block}
+	assert dusting progress of {_block} is 2 with "Failed to add 1 to dusting progress"
+
+	# test clamping at max
+	add 99 to dusting progress of {_block}
+	assert dusting progress of {_block} is 3 with "Dusting progress should be clamped at max"
+
+	# test removing
+	set dusting progress of {_block} to 2
+	remove 1 from dusting progress of {_block}
+	assert dusting progress of {_block} is 1 with "Failed to remove 1 from dusting progress"
+
+	# test clamping at min
+	remove 99 from dusting progress of {_block}
+	assert dusting progress of {_block} is 0 with "Dusting progress should be clamped at 0"
+
+	# test reset
+	set dusting progress of {_block} to 2
+	assert dusting progress of {_block} is 2 with "Failed to set dusting progress"
+	reset dusting progress of {_block}
+	assert dusting progress of {_block} is 0 with "Failed to reset dusting progress"
+
+	# test with blockdata
+	set dusting progress of {_blockdata} to 2
+	assert dusting progress of {_blockdata} is 2 with "Failed to set dusting progress on blockdata"
+
+	set block data of test-block to {_old}