Overhaul shape as layout

Author: APickledWalrus

src/main/java/io/github/apickledwalrus/skriptgui/SkriptGUI.java

@@ -93,10 +93,10 @@ public void load(SkriptAddon addon) {
 			ExprGUIValues::register,
 			ExprGUIWithId::register,
 			ExprLastGUI::register,
+			ExprLayout::register,
 			ExprLockStatus::register,
 			ExprNextSlot::register,
 			ExprPaginatedList::register,
-			ExprShape::register,
 			ExprVirtualInventory::register,
 			SecCreateGUI::register,
 			SecMakeSlot::register,

…tgui/elements/expressions/ExprShape.java …gui/elements/expressions/ExprLayout.javasrc/main/java/io/github/apickledwalrus/skriptgui/elements/expressions/ExprShape.java renamed to src/main/java/io/github/apickledwalrus/skriptgui/elements/expressions/ExprLayout.java src/main/java/io/github/apickledwalrus/skriptgui/elements/expressions/ExprShape.java renamed to src/main/java/io/github/apickledwalrus/skriptgui/elements/expressions/ExprLayout.java

@@ -12,49 +12,47 @@
 import org.jspecify.annotations.Nullable;
 import org.skriptlang.skript.registration.SyntaxRegistry;
 
-@Name("GUI Shape")
-@Description("The shape of a GUI, which controls how its items are laid out.")
+@Name("GUI Layout")
+@Description("The layout of a GUI, which controls how its items are displayed.")
 @Example("""
-	set the shape of the player's gui to "xxxxxxxxx", "x-------x", and "xxxxxxxxx"
+	set the layout of the player's gui to "xxxxxxxxx", "x-------x", and "xxxxxxxxx"
 	""")
 @Since("1.0.0, 1.3.0 (support outside of edit sections)")
-public class ExprShape extends SimplePropertyExpression<GUI, String> {
+public class ExprLayout extends SimplePropertyExpression<GUI, String> {
 
 	public static void register(SyntaxRegistry syntaxRegistry) {
 		syntaxRegistry.register(SyntaxRegistry.EXPRESSION,
-			infoBuilder(ExprShape.class, String.class, "[gui] shape[s]", "guis", false)
-				.supplier(ExprShape::new)
+			infoBuilder(ExprLayout.class, String.class, "[gui] (layout|shape)[s]", "guis", false)
+				.supplier(ExprLayout::new)
 				.build());
 	}
 
 	@Override
 	public String convert(GUI gui) {
-		return gui.getRawShape();
+		return gui.getLayout();
 	}
 
 	@Override
 	public Class<?> @Nullable [] acceptChange(ChangeMode mode) {
 		return switch (mode) {
-			case ADD, DELETE, RESET -> CollectionUtils.array(String[].class);
+			case SET, DELETE, RESET -> CollectionUtils.array(String[].class);
 			default -> null;
 		};
 	}
 
 	@Override
 	public void change(Event event, Object @Nullable [] delta, ChangeMode mode) {
-		if (delta == null) {
-			for (GUI gui : getExpr().getArray(event)) {
-				gui.resetShape();
+		String layout = null;
+		if (delta != null) {
+			StringBuilder layoutBuilder = new StringBuilder();
+			for (Object string : delta) {
+				layoutBuilder.append((String) string);
 			}
-			return;
+			layout = layoutBuilder.toString();
 		}
 
-		String[] newShape = new String[delta.length];
-		for (int i = 0; i < delta.length; i++) {
-			newShape[i] = (String) delta[i];
-		}
 		for (GUI gui : getExpr().getArray(event)) {
-			gui.setShape(newShape);
+			gui.setLayout(layout);
 		}
 	}
 
@@ -65,7 +63,7 @@ public Class<? extends String> getReturnType() {
 
 	@Override
 	protected String getPropertyName() {
-		return "shape";
+		return "layout";
 	}
 
 }

src/main/java/io/github/apickledwalrus/skriptgui/elements/expressions/ExprNextSlot.java

@@ -24,7 +24,7 @@
 @Name("Next GUI Slot")
 @Description("""
 	Obtains the next open slot of a GUI.
-	This is a single character representing the next available character of the shape.
+	This is a single character representing the next available character of the layout.
 	""")
 @Example("make the next gui slot with dirt named \"Slot: %the next gui slot%\"")
 @Since("1.3.0")

src/main/java/io/github/apickledwalrus/skriptgui/elements/sections/SecCreateGUI.java

@@ -30,7 +30,7 @@
 	create a gui with virtual chest inventory with 3 rows named "My GUI"
 	""")
 @Example("""
-	create a gui with a virtual chest inventory with shape "xxxxxxxxx", "x-------x", and "xxxxxxxxx"
+	create a gui with a virtual chest inventory with layout "xxxxxxxxx", "x-------x", and "xxxxxxxxx"
 	""")
 @Example("""
 	edit the player's gui:
@@ -42,15 +42,15 @@ public class SecCreateGUI extends EffectSection {
 	public static void register(SyntaxRegistry syntaxRegistry) {
 		syntaxRegistry.register(SyntaxRegistry.SECTION, SyntaxInfo.builder(SecCreateGUI.class)
 			.supplier(SecCreateGUI::new)
-			.addPatterns("create [a] [new] gui [[with id[entifier]] %-string%] with [a] %inventory% [removable:(and|with) ([re]mov[e]able|stealable) items] [(and|with) shape %-strings%]",
+			.addPatterns("create [a] [new] gui [[with id[entifier]] %-string%] with [a] %inventory% [removable:(and|with) ([re]mov[e]able|stealable) items] [(and|with) (layout|shape) %-strings%]",
 				"(change|edit) [gui] %gui%")
 			.build());
 	}
 
 	private @Nullable Expression<String> id;
 	private Expression<Inventory> inventory;
 	private boolean removableItems;
-	private @Nullable Expression<String> shape;
+	private @Nullable Expression<String> layout;
 
 	private @Nullable Expression<GUI> gui;
 
@@ -67,7 +67,7 @@ public boolean init(Expression<?>[] expressions, int matchedPattern, Kleenean kl
 		} else {
 			id = (Expression<String>) expressions[0];
 			inventory = (Expression<Inventory>) expressions[1];
-			shape = (Expression<String>) expressions[2];
+			layout = (Expression<String>) expressions[2];
 			removableItems = parseResult.hasTag("removable");
 		}
 
@@ -96,7 +96,16 @@ public boolean init(Expression<?>[] expressions, int matchedPattern, Kleenean kl
 				name = exprVirtualInventory.getName();
 			}
 
-			gui = new GUI(inventory, removableItems, name, shape == null ? null : shape.getArray(event));
+			String layout = null;
+			if (this.layout != null) {
+				StringBuilder layoutBuilder = new StringBuilder();
+				for (String string : this.layout.getArray(event)) {
+					layoutBuilder.append(string);
+				}
+				layout = layoutBuilder.toString();
+			}
+
+			gui = new GUI(inventory, removableItems, name, layout);
 
 			String id = this.id == null ? null : this.id.getSingle(event);
 			if (id != null && !id.isEmpty()) {
@@ -152,7 +161,7 @@ public String toString(@Nullable Event event, boolean debug) {
 			.appendIf(id != null, "with id", id)
 			.append("with", inventory)
 			.appendIf(removableItems, "with removable items")
-			.appendIf(shape != null, "and shape", shape)
+			.appendIf(layout != null, "and layout", layout)
 			.toString();
 	}
 

src/main/java/io/github/apickledwalrus/skriptgui/elements/sections/SecSlotChange.java

@@ -27,10 +27,10 @@
 @Name("GUI Slot Change")
 @Description("""
 	A section for executing code when a slot changes.
-	Note that for shaped GUIs, where multiple slots are represented by a single character, the section will execute when any of those slots change.
+	Note that for GUIs with a layout, where multiple slots are represented by a single character, the section will execute when any of those slots change.
 	""")
 @Example("""
-	create a gui with a virtual chest inventory with shape "xxxxxxxxx", "x-------x", and "xxxxxxxxx"
+	create a gui with a virtual chest inventory with layout "xxxxxxxxx", "x-------x", and "xxxxxxxxx"
 		run when slot 1 changes:
 			send "You changed slot 1"
 		run when slot "-" changes: