Skip to content

Improve object creation of ItemStacks in the GUI class #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve object creation of ItemStacks in the GUI class #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2625bfe
Improve item creation in the GUI class
theEvilReaper Jun 15, 2024
f251d08
Add documentation
theEvilReaper Jun 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 138 additions & 79 deletions src/main/java/net/onelitefeather/bettergopaint/utils/GUI.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,47 @@
import org.bukkit.Bukkit;
import org.bukkit.Material;
import org.bukkit.inventory.Inventory;
import org.bukkit.inventory.ItemStack;
import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;

public class GUI {
import java.util.List;

/**
* A utility class to generate GUIs for the goPaint plugin.
* @version 1.0.0
* @since 1.0.0
*/
public final class GUI {

private static final String INCREASE_DECREASE_LORE = "\n§7Left click to increase\n§7Right click to decrease";
private static final ItemStack WHITE_DECORATION = Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", "");
private static final ItemStack LIME_DECORATION = Items.create(Material.LIME_STAINED_GLASS_PANE, 1, "§7", "");
private static final ItemStack YELLOW_DECORATION = Items.create(Material.YELLOW_STAINED_GLASS_PANE, 1, "§7", "");
private static final ItemStack RED_DECORATION = Items.create(Material.RED_STAINED_GLASS_PANE, 1, "§7", "");
private static final ItemStack ORANGE_DECORATION = Items.create(Material.ORANGE_STAINED_GLASS_PANE, 1, "§7", "");
private static final ItemStack EMPTY_SLOT = Items.create(Material.BARRIER, 1, "§cEmpty Slot", "\n§7Click with a block to set");
private static final BetterGoPaint plugin = JavaPlugin.getPlugin(BetterGoPaint.class);

public static @NotNull Inventory create(PlayerBrush pb) {
private GUI() {
throw new UnsupportedOperationException("This class cannot be instantiated");
}

/**
* Creates a new {@link Inventory} with the current {@link PlayerBrush} settings.
* @param pb the player brush to get the settings from
* @return the generated inventory
*/
public static @NotNull Inventory create(@NotNull PlayerBrush pb) {
Inventory inv = Bukkit.createInventory(null, 54, Component.text("goPaint Menu", NamedTextColor.DARK_BLUE));
update(inv, pb);
return inv;
}

/**
* Generates an {@link Inventory} with all the brushes represented by an {@link ItemStack}.
* @return the generated inventory
*/
public static @NotNull Inventory generateBrushes() {
Inventory inv = Bukkit.createInventory(null, 27, Component.text("goPaint Brushes", NamedTextColor.DARK_BLUE));
// FILLER
Expand All @@ -62,156 +90,148 @@ public class GUI {
return inv;
}

/**
* Applies a default formating to the given {@link Inventory}.
* @param inventory the inventory to format
*/
private static void formatDefault(@NotNull Inventory inventory) {
for (int slot = 0; slot < inventory.getSize(); slot++) {
inventory.setItem(slot, Items.create(Material.GRAY_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(slot, LIME_DECORATION);
}
}

/**
* Updates the given {@link Inventory} with the current {@link PlayerBrush} settings.
* @param inventory the inventory to update
* @param playerBrush the player brush to get the settings from
*/
public static void update(@NotNull Inventory inventory, @NotNull PlayerBrush playerBrush) {
Brush brush = playerBrush.brush();

// FILLER
formatDefault(inventory);

// goPaint toggle
if (playerBrush.enabled()) {
inventory.setItem(1, Items.create(Material.LIME_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(10, Items.create(Settings.settings().generic.DEFAULT_BRUSH, 1, "§6goPaint Brush",
"§a§lEnabled\n\n§7Left click with item to export\n§7Right click to toggle"
));
inventory.setItem(19, Items.create(Material.LIME_STAINED_GLASS_PANE, 1, "§7", ""));
} else {
inventory.setItem(1, Items.create(Material.RED_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(10, Items.create(Settings.settings().generic.DEFAULT_BRUSH, 1, "§6goPaint Brush",
"§c§lDisabled\n\n§7Left click with item to export\n§7Right click to toggle"
));
inventory.setItem(19, Items.create(Material.RED_STAINED_GLASS_PANE, 1, "§7", ""));
}

setPaintToggle(inventory, playerBrush);
// Brushes + Chance
inventory.setItem(2, Items.create(Material.ORANGE_STAINED_GLASS_PANE, 1, "§7", ""));

inventory.setItem(2, ORANGE_DECORATION);

String clicks = "\n§7Shift click to select\n§7Click to cycle brush\n\n";

inventory.setItem(11, Items.createHead(brush.getHead(), 1, "§6Selected Brush type",
clicks + plugin.getBrushManager().getBrushLore(brush)
));
inventory.setItem(20, Items.create(Material.ORANGE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(20, ORANGE_DECORATION);

// chance
if (brush instanceof SprayBrush) {
inventory.setItem(3, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(3, WHITE_DECORATION);
inventory.setItem(12, Items.create(Material.GOLD_NUGGET, 1,
"§6Place chance: §e" + playerBrush.chance() + "%",
"\n§7Left click to increase\n§7Right click to decrease"
INCREASE_DECREASE_LORE
));
inventory.setItem(21, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(21, WHITE_DECORATION);
}

// axis
if (brush instanceof DiscBrush) {
inventory.setItem(3, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(3, WHITE_DECORATION);
inventory.setItem(12, Items.create(Material.COMPASS, 1,
"§6Axis: §e" + playerBrush.axis(), "\n§7Click to change"
));
inventory.setItem(21, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(21, WHITE_DECORATION);
}


// thickness
if (brush instanceof OverlayBrush || brush instanceof UnderlayBrush) {
inventory.setItem(3, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(3, WHITE_DECORATION);
inventory.setItem(12, Items.create(Material.BOOK, 1,
"§6Layer Thickness: §e" + playerBrush.thickness(),
"\n§7Left click to increase\n§7Right click to decrease"
INCREASE_DECREASE_LORE
));
inventory.setItem(21, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(21, WHITE_DECORATION);
}

// angle settings
if (brush instanceof AngleBrush) {
inventory.setItem(3, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(3, WHITE_DECORATION);
inventory.setItem(12, Items.create(Material.DAYLIGHT_DETECTOR, 1,
"§6Angle Check Distance: §e" + playerBrush.angleDistance(),
"\n§7Left click to increase\n§7Right click to decrease"
INCREASE_DECREASE_LORE
));
inventory.setItem(21, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));

inventory.setItem(4, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(21, WHITE_DECORATION);
inventory.setItem(4, WHITE_DECORATION);
inventory.setItem(13, Items.create(Material.BLAZE_ROD, 1,
"§6Maximum Angle: §e" + playerBrush.angleHeightDifference() + "°",
"\n§7Left click to increase\n§7Right click to decrease\n§7Shift click to change by 15"
));
inventory.setItem(22, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(22, WHITE_DECORATION);
}

// fracture settings
if (brush instanceof FractureBrush) {
inventory.setItem(3, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(3, WHITE_DECORATION);
inventory.setItem(12, Items.create(Material.DAYLIGHT_DETECTOR, 1,
"§6Fracture Check Distance: §e" + playerBrush.fractureDistance(),
"\n§7Left click to increase\n§7Right click to decrease"
INCREASE_DECREASE_LORE
));
inventory.setItem(21, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(21, WHITE_DECORATION);
}

if (brush instanceof SplatterBrush || brush instanceof PaintBrush || brush instanceof GradientBrush) {
inventory.setItem(3, WHITE_DECORATION);
inventory.setItem(12, Items.create(Material.BLAZE_POWDER, 1,
"§6Falloff Strength: §e" + playerBrush.falloffStrength() + "%",
INCREASE_DECREASE_LORE
));
inventory.setItem(21, WHITE_DECORATION);
}
// angle settings
if (brush instanceof GradientBrush) {
inventory.setItem(4, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(4, WHITE_DECORATION);
inventory.setItem(13, Items.create(Material.MAGMA_CREAM, 1,
"§6Mixing Strength: §e" + playerBrush.mixingStrength() + "%",
"\n§7Left click to increase\n§7Right click to decrease"
INCREASE_DECREASE_LORE
));
inventory.setItem(22, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
}

if (brush instanceof SplatterBrush || brush instanceof PaintBrush || brush instanceof GradientBrush) {
inventory.setItem(3, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(12, Items.create(Material.BLAZE_POWDER, 1,
"§6Falloff Strength: §e" + playerBrush.falloffStrength() + "%",
"\n§7Left click to increase\n§7Right click to decrease"
));
inventory.setItem(21, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(22, WHITE_DECORATION);
}


// Size
inventory.setItem(5, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(5, WHITE_DECORATION);
inventory.setItem(14, Items.create(Material.BROWN_MUSHROOM, 1,
"§6Brush Size: §e" + playerBrush.size(),
"\n§7Left click to increase\n§7Right click to decrease\n§7Shift click to change by 10"
));
inventory.setItem(23, Items.create(Material.WHITE_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(23, WHITE_DECORATION);

// Mask toggle
if (playerBrush.maskEnabled()) {
inventory.setItem(6, Items.create(Material.LIME_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(15, Items.create(Material.JACK_O_LANTERN, 1,
"§6Mask",
"§a§lEnabled\n\n§7Click to toggle"
));
inventory.setItem(24, Items.create(Material.LIME_STAINED_GLASS_PANE, 1, "§7", ""));
} else {
inventory.setItem(6, Items.create(Material.RED_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(15, Items.create(Material.CARVED_PUMPKIN, 1, "§6Mask", "§c§lDisabled\n\n§7Click to toggle"));
inventory.setItem(24, Items.create(Material.RED_STAINED_GLASS_PANE, 1, "§7", ""));
}
setMaskItems(inventory, playerBrush);

// Surface Mode toggle
addSurfaceModeSwitch(inventory, playerBrush);

// Place Block
for (int x = 37; x <= 41; x++) {
inventory.setItem(x, Items.create(Material.YELLOW_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(x, YELLOW_DECORATION);
}
for (int x = 46; x <= 50; x++) {
inventory.setItem(x, Items.create(Material.BARRIER, 1, "§cEmpty Slot", "\n§7Click with a block to set"));
inventory.setItem(x, EMPTY_SLOT);
}

// Block Change
setBlockChangeItems(inventory, playerBrush);

// Mask Block
inventory.setItem(43, YELLOW_DECORATION);
inventory.setItem(52, Items.create(playerBrush.mask(), 1, "§6Current Mask", "\n§7Left click with a block to change"));
}

private static void setBlockChangeItems(@NotNull Inventory inventory, @NotNull PlayerBrush playerBrush) {
final List<Material> blocks = playerBrush.blocks();
if (blocks.isEmpty()) return;
int x = 46;
int size = playerBrush.blocks().size();
int chance = size == 0 ? 0 : 100 / size;
int chance = blocks.isEmpty() ? 0 : 100 / blocks.size();
for (Material material : playerBrush.blocks()) {
if (chance > 64) {
inventory.setItem(x, Items.create(material, 1,
Expand All @@ -226,30 +246,69 @@ public static void update(@NotNull Inventory inventory, @NotNull PlayerBrush pla
}
x++;
}
}

// Mask Block
inventory.setItem(43, Items.create(Material.YELLOW_STAINED_GLASS_PANE, 1, "§7", ""));
inventory.setItem(52, Items.create(playerBrush.mask(), 1, "§6Current Mask", "\n§7Left click with a block to change"));
/**
* Set the relevant {@link ItemStack}'s into an {@link Inventory} to represent the goPaint toggle
*
* @param inventory the inventory to set the items in
* @param playerBrush the {@link PlayerBrush} to get the goPaint status from
*/
private static void setPaintToggle(@NotNull Inventory inventory, @NotNull PlayerBrush playerBrush) {
final String lore = "§a§lEnabled\n\n§7Left click with item to export\n§7Right click to toggle";
final String displayName = "§6goPaint Brush";
final boolean hasBrushEnabled = playerBrush.enabled();
inventory.setItem(1, hasBrushEnabled ? LIME_DECORATION : RED_DECORATION);
inventory.setItem(10, Items.create(Settings.settings().generic.DEFAULT_BRUSH, 1, displayName, lore));
inventory.setItem(19, hasBrushEnabled ? LIME_DECORATION : RED_DECORATION);
}

private static void addSurfaceModeSwitch(Inventory inv, PlayerBrush playerBrush) {
Material pane = switch (playerBrush.surfaceMode()) {
case DIRECT -> Material.LIME_STAINED_GLASS_PANE;
case DISABLED -> Material.RED_STAINED_GLASS_PANE;
case RELATIVE -> Material.ORANGE_STAINED_GLASS_PANE;
/**
* Set the relevant {@link ItemStack}'s into an {@link Inventory} to represent the mask toggle
*
* @param inventory the inventory to set the items in
* @param playerBrush the {@link PlayerBrush} to get the mask status from
*/
private static void setMaskItems(@NotNull Inventory inventory, @NotNull PlayerBrush playerBrush) {
if (playerBrush.maskEnabled()) {
inventory.setItem(6, LIME_DECORATION);
inventory.setItem(15, Items.create(Material.JACK_O_LANTERN, 1,
"§6Mask",
"§a§lEnabled\n\n§7Click to toggle"
));
inventory.setItem(24, LIME_DECORATION);
return;
}
final ItemStack mask = Items.create(Material.CARVED_PUMPKIN, 1, "§6Mask", "§c§lDisabled\n\n§7Click to toggle");
inventory.setItem(6, RED_DECORATION);
inventory.setItem(15, mask);
inventory.setItem(24, RED_DECORATION);
}

/**
* Add the surface mode switch to the {@link Inventory}.
*
* @param inv the inventory to add the switch to
* @param playerBrush the {@link PlayerBrush} to get the surface mode from
*/
private static void addSurfaceModeSwitch(@NotNull Inventory inv, @NotNull PlayerBrush playerBrush) {
// Reuses the constant for the pane to reduce object creation
ItemStack pane = switch (playerBrush.surfaceMode()) {
case DIRECT -> LIME_DECORATION;
case DISABLED -> RED_DECORATION;
case RELATIVE -> ORANGE_DECORATION;
};
String color = switch (playerBrush.surfaceMode()) {
case DIRECT -> "§a";
case DISABLED -> "§c";
case RELATIVE -> "§6";
};

inv.setItem(7, Items.create(pane, 1, "§7", ""));
inv.setItem(7, pane);
inv.setItem(16, Items.create(Material.LIGHT_WEIGHTED_PRESSURE_PLATE, 1,
"§6Surface Mode",
color + "§l" + playerBrush.surfaceMode().getName() + "\n\n§7Click to toggle"
));
inv.setItem(25, Items.create(pane, 1, "§7", ""));
inv.setItem(25, pane);
}

}
Loading