feat: started plot gui rework

This commit is contained in:
Pierre Maurice Schwang
2022-06-04 01:19:49 +02:00
parent fd8832ac98
commit 7cb5df6253
10 changed files with 602 additions and 91 deletions

View File

@ -34,24 +34,21 @@ import com.plotsquared.core.location.Location;
import com.plotsquared.core.permissions.Permission;
import com.plotsquared.core.player.PlotPlayer;
import com.plotsquared.core.plot.Plot;
import com.plotsquared.core.plot.PlotInventory;
import com.plotsquared.core.plot.PlotItemStack;
import com.plotsquared.core.plot.flag.PlotFlag;
import com.plotsquared.core.plot.flag.implementations.MusicFlag;
import com.plotsquared.core.util.EventDispatcher;
import com.plotsquared.core.util.InventoryUtil;
import com.plotsquared.core.util.Permissions;
import com.sk89q.worldedit.world.item.ItemType;
import com.plotsquared.core.util.gui.PlotInventory;
import com.plotsquared.core.util.gui.PlotInventoryProvider;
import com.sk89q.worldedit.world.item.ItemTypes;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.minimessage.tag.Tag;
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
import org.checkerframework.checker.nullness.qual.NonNull;
import javax.annotation.Nullable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Locale;
import java.util.List;
import java.util.stream.Stream;
@CommandDeclaration(command = "music",
permission = "plots.music",
@ -60,20 +57,33 @@ import java.util.Locale;
requiredType = RequiredType.PLAYER)
public class Music extends SubCommand {
private static final Collection<String> DISCS = Arrays
.asList("music_disc_13", "music_disc_cat", "music_disc_blocks", "music_disc_chirp",
"music_disc_far", "music_disc_mall", "music_disc_mellohi", "music_disc_stal",
"music_disc_strad", "music_disc_ward", "music_disc_11", "music_disc_wait", "music_disc_otherside",
"music_disc_pigstep"
);
private static final List<String> DISCS = Stream.of(
"music_disc_13",
"music_disc_cat",
"music_disc_blocks",
"music_disc_chirp",
"music_disc_far",
"music_disc_mall",
"music_disc_mellohi",
"music_disc_stal",
"music_disc_strad",
"music_disc_ward",
"music_disc_11",
"music_disc_wait",
"music_disc_otherside",
"music_disc_pigstep"
).filter(s -> ItemTypes.get(s) != null).toList();
private final InventoryUtil inventoryUtil;
private final EventDispatcher eventDispatcher;
private final PlotInventoryProvider<?, ?> inventoryProvider;
@Inject
public Music(final @Nullable InventoryUtil inventoryUtil, final @NonNull EventDispatcher eventDispatcher) {
this.inventoryUtil = inventoryUtil;
public Music(
final @NonNull EventDispatcher eventDispatcher, final
PlotInventoryProvider<?, ?> inventoryProvider
) {
this.eventDispatcher = eventDispatcher;
this.inventoryProvider = inventoryProvider;
}
@Override
@ -99,85 +109,67 @@ public class Music extends SubCommand {
);
return true;
}
PlotInventory inv = new PlotInventory(
this.inventoryUtil,
player,
2,
TranslatableCaption.of("plotjukebox.jukebox_header").getComponent(player)
) {
@Override
public boolean onClick(int index) {
PlotItemStack item = getItem(index);
if (item == null) {
return true;
}
if (item.getType() == ItemTypes.BEDROCK) {
PlotFlag<?, ?> plotFlag = plot.getFlagContainer().getFlag(MusicFlag.class)
.createFlagInstance(item.getType());
PlotFlagRemoveEvent event = eventDispatcher.callFlagRemove(plotFlag, plot);
if (event.getEventResult() == Result.DENY) {
getPlayer().sendMessage(
TranslatableCaption.of("events.event_denied"),
TagResolver.resolver("value", Tag.inserting(Component.text("Music removal")))
);
return true;
}
plot.removeFlag(event.getFlag());
getPlayer().sendMessage(
TranslatableCaption.of("flag.flag_removed"),
TagResolver.builder()
.tag("flag", Tag.inserting(Component.text("music")))
.tag("value", Tag.inserting(Component.text("music_disc")))
.build()
);
} else if (item.getName().toLowerCase(Locale.ENGLISH).contains("disc")) {
PlotFlag<?, ?> plotFlag = plot.getFlagContainer().getFlag(MusicFlag.class)
.createFlagInstance(item.getType());
PlotFlagAddEvent event = eventDispatcher.callFlagAdd(plotFlag, plot);
if (event.getEventResult() == Result.DENY) {
getPlayer().sendMessage(
TranslatableCaption.of("events.event_denied"),
TagResolver.resolver("value", Tag.inserting(Component.text("Music addition")))
);
return true;
}
plot.setFlag(event.getFlag());
getPlayer().sendMessage(
TranslatableCaption.of("flag.flag_added"),
TagResolver.builder()
.tag("flag", Tag.inserting(Component.text("music")))
.tag("value", Tag.inserting(Component.text(event.getFlag().getValue().toString())))
.build()
);
} else {
getPlayer().sendMessage(TranslatableCaption.of("flag.flag_not_added"));
}
return false;
}
};
int index = 0;
final PlotInventory<?, ?> inventory = inventoryProvider.createInventory(
9 * 2,
TranslatableCaption.of("plotjukebox.jukebox_header")
);
for (final String disc : DISCS) {
final String name = String.format("<gold>%s</gold>", disc);
final String[] lore = {TranslatableCaption.of("plotjukebox.click_to_play").getComponent(player)};
ItemType type = ItemTypes.get(disc);
if (type == null) {
continue;
}
final PlotItemStack item = new PlotItemStack(type, 1, name, lore);
if (inv.setItemChecked(index, item)) {
index++;
}
PlotItemStack itemStack = new PlotItemStack(
disc, 1, String.format("<gold>%s</gold>", disc),
TranslatableCaption.of("plotjukebox.click_to_play").getComponent(player)
);
inventory.addItem(itemStack, (item, clicker) -> {
clicker.closeInventory();
PlotFlag<?, ?> plotFlag = plot.getFlagContainer().getFlag(MusicFlag.class)
.createFlagInstance(item.getType());
PlotFlagAddEvent event = eventDispatcher.callFlagAdd(plotFlag, plot);
if (event.getEventResult() == Result.DENY) {
clicker.sendMessage(
TranslatableCaption.of("events.event_denied"),
TagResolver.resolver("value", Tag.inserting(Component.text("Music addition")))
);
return;
}
plot.setFlag(event.getFlag());
clicker.sendMessage(
TranslatableCaption.of("flag.flag_added"),
TagResolver.builder()
.tag("flag", Tag.inserting(Component.text("music")))
.tag("value", Tag.inserting(Component.text(event.getFlag().getValue().toString())))
.build()
);
});
}
// Always add the cancel button
// if (player.getMeta("music") != null) {
String name = TranslatableCaption.of("plotjukebox.cancel_music").getComponent(player);
String[] lore = {TranslatableCaption.of("plotjukebox.reset_music").getComponent(player)};
inv.setItem(index, new PlotItemStack("bedrock", 1, name, lore));
// }
inv.openInventory();
PlotItemStack cancelItem = new PlotItemStack(
ItemTypes.BEDROCK, 1,
TranslatableCaption.of("plotjukebox.cancel_music").getComponent(player),
TranslatableCaption.of("plotjukebox.reset_music").getComponent(player)
);
inventory.setItem(inventory.size() - 1, cancelItem, (item, clicker) -> {
clicker.closeInventory();
PlotFlag<?, ?> plotFlag = plot.getFlagContainer().getFlag(MusicFlag.class)
.createFlagInstance(item.getType());
PlotFlagRemoveEvent event = eventDispatcher.callFlagRemove(plotFlag, plot);
if (event.getEventResult() == Result.DENY) {
clicker.sendMessage(
TranslatableCaption.of("events.event_denied"),
TagResolver.resolver("value", Tag.inserting(Component.text("Music removal")))
);
return;
}
plot.removeFlag(event.getFlag());
clicker.sendMessage(
TranslatableCaption.of("flag.flag_removed"),
TagResolver.builder()
.tag("flag", Tag.inserting(Component.text("music")))
.tag("value", Tag.inserting(Component.text("music_disc")))
.build()
);
});
inventory.open(player);
return true;
}

View File

@ -258,4 +258,8 @@ public class ConsolePlayer extends PlotPlayer<Actor> {
return true;
}
@Override
public void closeInventory() {
}
}

View File

@ -1015,6 +1015,12 @@ public abstract class PlotPlayer<P> implements CommandCaller, OfflinePlotPlayer,
public @NonNull
abstract Audience getAudience();
/**
* Closes the current open inventory, if present
* @since TODO
*/
public abstract void closeInventory();
/**
* Get this player's {@link LockRepository}
*

View File

@ -0,0 +1,145 @@
/*
* _____ _ _ _____ _
* | __ \| | | | / ____| | |
* | |__) | | ___ | |_| (___ __ _ _ _ __ _ _ __ ___ __| |
* | ___/| |/ _ \| __|\___ \ / _` | | | |/ _` | '__/ _ \/ _` |
* | | | | (_) | |_ ____) | (_| | |_| | (_| | | | __/ (_| |
* |_| |_|\___/ \__|_____/ \__, |\__,_|\__,_|_| \___|\__,_|
* | |
* |_|
* PlotSquared plot management system for Minecraft
* Copyright (C) 2014 - 2022 IntellectualSites
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.plotsquared.core.util.gui;
import com.plotsquared.core.configuration.caption.Caption;
import com.plotsquared.core.player.PlotPlayer;
import com.plotsquared.core.plot.PlotItemStack;
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
/**
* @param <P> The platform player
* @param <I> The platform item object
* @since TODO
*/
public abstract class PlotInventory<P, I> {
private final PlotInventoryClickHandler<P> NOOP_CLICK_HANDLER = (x, y) -> {
};
private final int size;
private final Caption titleCaption;
private final TagResolver[] titleResolvers;
/**
* Instantiates a new Plot inventory.
*
* @param size The size of the inventory - must be a multiple of 9
* @param titleCaption The caption to use for the title
* @param titleResolvers The tag resolvers to use for the title
* @since 7.0.0
*/
protected PlotInventory(int size, Caption titleCaption, TagResolver... titleResolvers) {
this.size = size;
this.titleCaption = titleCaption;
this.titleResolvers = titleResolvers;
}
/**
* Set an item in this inventory at a specific slot / index.
* Overrides existing items and click handler.
*
* @param slot The slot / index where to place the item
* @param item The item to add to this inventory
* @param onClick The handler to call when clicking this item
* @since TODO
*/
public abstract void setItem(int slot, PlotItemStack item, PlotInventoryClickHandler<P> onClick);
/**
* Set an item in this inventory at a specific slot / index.
* Overrides existing items and click handler.
*
* @param slot The slot / index where to place the item
* @param item The item to add to this inventory
* @since TODO
*/
public void setItem(int slot, PlotItemStack item) {
setItem(slot, item, NOOP_CLICK_HANDLER);
}
/**
* Add an item to this inventory, at the first slot possible (first empty slot, or first slot with the exact same item)
*
* @param item The item to add to this inventory
* @param onClick The handler to call when clicking this item
* @since TODO
*/
public abstract void addItem(PlotItemStack item, PlotInventoryClickHandler<P> onClick);
/**
* Add an item to this inventory, at the first slot possible (first empty slot, or first slot with the exact same item)
*
* @param item The item to add to this inventory
* @since TODO
*/
public void addItem(PlotItemStack item) {
addItem(item, NOOP_CLICK_HANDLER);
}
/**
* Opens this inventory for a specific {@link PlotPlayer}
*
* @param player The player to open this inventory for
* @since TODO
*/
public void open(PlotPlayer<?> player) {
this.openPlatformPlayer((PlotPlayer<P>) player);
}
protected abstract void openPlatformPlayer(PlotPlayer<P> player);
/**
* Close this inventory for a specific {@link PlotPlayer}
*
* @param player The player to close this inventory for
* @since TODO
*/
public void close(PlotPlayer<?> player) {
this.closePlatformPlayer((PlotPlayer<P>) player);
}
protected abstract void closePlatformPlayer(PlotPlayer<P> player);
public abstract I toPlatformItem(PlotItemStack item);
/**
* @return the size of this inventory (must be a multiple of 9)
* @since TODO
*/
public int size() {
return size;
}
protected Caption titleCaption() {
return titleCaption;
}
protected TagResolver[] titleResolvers() {
return titleResolvers;
}
}

View File

@ -0,0 +1,35 @@
/*
* _____ _ _ _____ _
* | __ \| | | | / ____| | |
* | |__) | | ___ | |_| (___ __ _ _ _ __ _ _ __ ___ __| |
* | ___/| |/ _ \| __|\___ \ / _` | | | |/ _` | '__/ _ \/ _` |
* | | | | (_) | |_ ____) | (_| | |_| | (_| | | | __/ (_| |
* |_| |_|\___/ \__|_____/ \__, |\__,_|\__,_|_| \___|\__,_|
* | |
* |_|
* PlotSquared plot management system for Minecraft
* Copyright (C) 2014 - 2022 IntellectualSites
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.plotsquared.core.util.gui;
import com.plotsquared.core.player.PlotPlayer;
import com.plotsquared.core.plot.PlotItemStack;
public interface PlotInventoryClickHandler<P> {
void handle(PlotItemStack itemStack, PlotPlayer<P> plotPlayer);
}

View File

@ -0,0 +1,49 @@
/*
* _____ _ _ _____ _
* | __ \| | | | / ____| | |
* | |__) | | ___ | |_| (___ __ _ _ _ __ _ _ __ ___ __| |
* | ___/| |/ _ \| __|\___ \ / _` | | | |/ _` | '__/ _ \/ _` |
* | | | | (_) | |_ ____) | (_| | |_| | (_| | | | __/ (_| |
* |_| |_|\___/ \__|_____/ \__, |\__,_|\__,_|_| \___|\__,_|
* | |
* |_|
* PlotSquared plot management system for Minecraft
* Copyright (C) 2014 - 2022 IntellectualSites
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.plotsquared.core.util.gui;
import com.plotsquared.core.configuration.caption.Caption;
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
/**
* Provider for creating a {@link PlotInventory}
*
* @param <P> The platform player
* @param <I> The platform item
*/
public interface PlotInventoryProvider<P, I> {
/**
* Creates a new {@link PlotInventory} based on the passed data for the current platform.
*
* @param size The size of the inventory (must be a multiple of 9)
* @param titleCaption The title for the inventory
* @param titleResolvers The (optional) placeholder resolvers for the inventory
* @return The platform inventory
*/
PlotInventory<P, I> createInventory(int size, Caption titleCaption, TagResolver... titleResolvers);
}