ExprNameBlock - add expression for custom name of block

- Ref SkriptLang/Skript#6826

Author: ShaneBeee

src/main/java/com/shanebeestudios/skbee/elements/text/expressions/ExprNameBlock.java

@@ -0,0 +1,87 @@
+package com.shanebeestudios.skbee.elements.text.expressions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.classes.Changer.ChangeMode;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.Since;
+import ch.njol.util.coll.CollectionUtils;
+import com.shanebeestudios.skbee.api.skript.base.SimplePropertyExpression;
+import com.shanebeestudios.skbee.api.wrapper.ComponentWrapper;
+import net.kyori.adventure.text.Component;
+import org.bukkit.block.Block;
+import org.bukkit.block.BlockState;
+import org.bukkit.block.Container;
+import org.bukkit.block.Skull;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+
+@Name("TextComponent - Block Name")
+@Description({"Get/set/delete the custom name of a block. This will work on container blocks and skulls.",
+    "Skulls require Paper 1.21.4(Build 214)+",
+    "Even though the custom name of any skull can be set, only a player head will retain its name when broken (Skeleton/creeper/etc skulls will not)."})
+@Examples({"set {_name} to component block name of target block",
+    "set component block name of target block to mini message from \"<rainbow>Mr Potato Head!\"",
+    "delete component block name of target block"})
+@Since("INSERT VERSION")
+public class ExprNameBlock extends SimplePropertyExpression<Block, ComponentWrapper> {
+
+    private static final boolean HAS_SKULL_NAME = Skript.methodExists(Skull.class, "customName");
+
+    static {
+        register(ExprNameBlock.class, ComponentWrapper.class,
+            "component [custom] block name", "block");
+    }
+
+    @Override
+    public @Nullable ComponentWrapper convert(Block block) {
+        BlockState state = block.getState();
+        Component component = null;
+        if (state instanceof Container container) {
+            component = container.customName();
+        } else if (state instanceof Skull skull && HAS_SKULL_NAME) {
+            component = skull.customName();
+        }
+        if (component != null) return ComponentWrapper.fromComponent(component);
+        return null;
+    }
+
+    @Override
+    public Class<?> @Nullable [] acceptChange(ChangeMode mode) {
+        if (mode == ChangeMode.SET) return CollectionUtils.array(ComponentWrapper.class);
+        else if (mode == ChangeMode.DELETE) return CollectionUtils.array();
+        return null;
+    }
+
+    @Override
+    public void change(Event event, Object @Nullable [] delta, ChangeMode mode) {
+        Component name = null;
+        if (delta != null && delta[0] instanceof ComponentWrapper cw) {
+            name = cw.getComponent();
+        }
+        for (Block block : getExpr().getArray(event)) {
+            setName(block, name);
+        }
+    }
+
+    private void setName(Block block, Component name) {
+        BlockState state = block.getState(false);
+        if (state instanceof Container container) {
+            container.customName(name);
+        } else if (state instanceof Skull skull && HAS_SKULL_NAME) {
+            skull.customName(name);
+        }
+    }
+
+    @Override
+    protected String getPropertyName() {
+        return "component block custom name";
+    }
+
+    @Override
+    public Class<? extends ComponentWrapper> getReturnType() {
+        return ComponentWrapper.class;
+    }
+
+}

src/test/scripts/elements/text/expressions/ExprNameBlock.sk

@@ -0,0 +1,12 @@
+test "SkBee - Text/ExprNameBlock":
+	set {_loc} to event-location
+	set {_data} to blockdata of block at {_loc}
+
+	set block at {_loc} to a player head
+	assert component block name of block at {_loc} is not set with "Should not have a name yet"
+	set component block name of block at {_loc} to mini message from "test"
+	assert component block name of block at {_loc} = mini message from "test" with "Name should now be 'test'"
+	delete component block name of block at {_loc}
+	assert component block name of block at {_loc} is not set with "Should no longer have a name after reset"
+
+	set block at {_loc} to {_data}