diff --git a/README.md b/README.md index 8817a2e..85f68f7 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ The only permission normal players will need is `minigames.join` which is set to |----------------------------------------|----------|-----------------------------|-------------------------------------------------------------------------------------| | /miniGamesReload | /mreload | | Reloads all data from disk. | | /miniGamesLeave | /mleave | | Leaves the current mini-game. | +| /miniGamesMenu | /mmenu | | Shows a menu of actions if used while in an arena | | /dropperList | /dlist | | Lists available dropper arenas. | | [/dropperJoin](#dropperjoin) | /djoin | \ \[mode] | Joins the selected arena. | | /dropperCreate | /dcreate | \ | Creates a new dropper arena with the given name. The spawn is set to your location. | @@ -153,16 +154,16 @@ This command allows editing the specified property for the specified parkour are These are all the options that can be changed for an arena. -| Option | Details | -|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| name | The name of the arena. Used mainly to select the arena in commands. | -| spawnLocation | The spawn location of any player joining the arena. Use `56.546,64.0,44.45` to specify coordinates, or `here`, `this` or any other string to select your current location. | -| exitLocation | The location players will be sent to when exiting the arena. If not set, the player will be sent to where they joined from. Valid values are the same as for spawnLocation. | -| winBlockType | The type of block players must hit to win the arena. It can be any material as long as it's a block, and not a type of air. | -| winLocation | The location players must reach to win the arena (see spawnLocation for valid values). If set, this overrides, and is used instead of, the win block type. | -| checkpointAdd | Adds a new checkpoint to the arena's checkpoints (see spawnLocation for valid values). | -| checkpointClear | Clears all current checkpoints. Give any value to execute. If not given a value, current checkpoints are shown. | -| killPlaneBlocks | A comma-separated list of materials which will force a loss on hit. +WOOL and other [material tags](#notes-about-material-tags) are supported as well. | +| Option | Details | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | The name of the arena. Used mainly to select the arena in commands. Note that underscore (_) cannot be used if you want to utilize placeholders, as it's used to split placeholder arguments. | +| spawnLocation | The spawn location of any player joining the arena. Use `56.546,64.0,44.45` to specify coordinates, or `here`, `this` or any other string to select your current location. | +| exitLocation | The location players will be sent to when exiting the arena. If not set, the player will be sent to where they joined from. Valid values are the same as for spawnLocation. | +| winBlockType | The type of block players must hit to win the arena. It can be any material as long as it's a block, and not a type of air. | +| winLocation | The location players must reach to win the arena (see spawnLocation for valid values). If set, this overrides, and is used instead of, the win block type. | +| checkpointAdd | Adds a new checkpoint to the arena's checkpoints (see spawnLocation for valid values). | +| checkpointClear | Clears all current checkpoints. Give any value to execute. If not given a value, current checkpoints are shown. | +| killPlaneBlocks | A comma-separated list of materials which will force a loss on hit. +WOOL and other [material tags](#notes-about-material-tags) are supported as well. | ## Configuration options @@ -185,8 +186,6 @@ These are all the options that can be changed for an arena. | mustDoGroupedInSequence | true/false | true | Whether grouped dropper arenas must be played in the correct sequence | | ignoreRecordsUntilGroupBeatenOnce | true/false | false | Whether records won't be registered unless the player has already beaten all arenas in a group. That means players are required to do a second play-through to register a record for a grouped arena. | | mustDoNormalModeFirst | true/false | true | Whether a player must do the normal/default game-mode before playing any other game-modes | -| makePlayersInvisible | true/false | false | Whether players should be made invisible while playing in a dropper arena | -| disableHitCollision | true/false | true | Whether players should have their entity hit collision disabled while in an arena. This prevents players from pushing each-other if in the same arena. | | liquidHitBoxDepth | -1 < decimal < 0 | -0.8 | This decides how far inside a non-solid block the player must go before detection triggers (-1, 0). The closer to -1 it is, the more accurate it will seem to the player, but the likelihood of not detecting the hit increases. | | solidHitBoxDistance | 0 < decimal < 1 | 0.2 | This decides the distance the player must be from a block below them before a hit triggers (0, 1). If too low, the likelihood of detecting the hit decreases, but it won't look like the player hit the block without being near. | | blockWhitelist | list | [see this](#blockwhitelist-default) | A whitelist for which blocks won't trigger a loss when hit/passed through. The win block check happens before the loss check, so even blocks on the whitelist can be used as the win-block. "+" denotes a [material tag](#notes-about-material-tags). | @@ -198,7 +197,6 @@ These are all the options that can be changed for an arena. | enforceCheckpointOrder | true/false | false | Whether to enforce the order in which a player must reach checkpoints. Enabling this ensures that a player cannot trigger a previous checkpoint by accident. It also ensures players cannot skip a checkpoint, even if the arena layout makes it possible. | | mustDoGroupedInSequence | true/false | true | Whether grouped dropper arenas must be played in the correct sequence | | ignoreRecordsUntilGroupBeatenOnce | true/false | false | Whether records won't be registered unless the player has already beaten all arenas in a group. That means players are required to do a second play-through to register a record for a grouped arena. | -| makePlayersInvisible | true/false | false | Whether players should be made invisible while playing in a dropper arena | | killPlaneBlocks | list | [see this](#killplaneblocks-default) | The types of blocks compromising parkour arenas' kill planes. Add any materials you want to use for the "bottom" of your parkour arenas. +WOOL and other [material tags](#notes-about-material-tags) are supported. | #### blockWhitelist default: @@ -261,6 +259,20 @@ Example tags: - +FENCE_GATES - +FENCES +## Language customization + +Most or all strings are customizable. If you place a strings.yml file in the plugin folder, it will take +priority over built-in languages. If you want to change strings, look at MiniGames/src/main/resources/strings.yml for +the proper keys. All strings have the format: ENUM: "Displayed string". The enum must be identical as it defines which +string you have changed. All strings belonging to a language are beneath the language code and indented with two spaces. + +The easiest way to add a new language is to copy an existing language and paste it into your custom strings.yml and +change strings as necessary. If you don't include all strings, the remaining will use the built-in English translation. +Remember to change the language code to whichever you use for your custom language. + +The interval messages are unique in that if several values are separated by comma (option1,option2,option3), a random +message will be chosen each time it's displayed. + ## License MiniGames is licensed under the GNU Public License Version 3.0. This includes every source and resource file. See the diff --git a/pom.xml b/pom.xml index 6565d30..67c25eb 100644 --- a/pom.xml +++ b/pom.xml @@ -40,6 +40,26 @@ false + + + net.knarcraft:knarlib + + net/knarcraft/knarlib/** + + + + net.knarcraft:knargui + + net/knarcraft/knargui/** + + + + + *.MF + *.yml + + + @@ -62,13 +82,17 @@ placeholderapi https://repo.extendedclip.com/content/repositories/placeholderapi/ + + knarcraft-repo + https://git.knarcraft.net/api/packages/EpicKnarvik97/maven + org.spigotmc spigot-api - 1.19.4-R0.1-SNAPSHOT + 1.20-R0.1-SNAPSHOT provided @@ -89,5 +113,17 @@ 2.10.0 provided + + net.knarcraft + knargui + 1.0-SNAPSHOT + compile + + + net.knarcraft + knarlib + 1.2.3 + compile + diff --git a/src/main/java/net/knarcraft/minigames/MiniGames.java b/src/main/java/net/knarcraft/minigames/MiniGames.java index c717939..8321365 100644 --- a/src/main/java/net/knarcraft/minigames/MiniGames.java +++ b/src/main/java/net/knarcraft/minigames/MiniGames.java @@ -1,7 +1,12 @@ package net.knarcraft.minigames; +import net.knarcraft.knargui.GUIListener; +import net.knarcraft.knarlib.formatting.StringFormatter; +import net.knarcraft.knarlib.formatting.Translator; +import net.knarcraft.knarlib.property.ColorConversion; import net.knarcraft.minigames.arena.ArenaPlayerRegistry; import net.knarcraft.minigames.arena.ArenaSession; +import net.knarcraft.minigames.arena.PlayerVisibilityManager; import net.knarcraft.minigames.arena.dropper.DropperArena; import net.knarcraft.minigames.arena.dropper.DropperArenaData; import net.knarcraft.minigames.arena.dropper.DropperArenaGameMode; @@ -25,6 +30,7 @@ import net.knarcraft.minigames.arena.reward.EconomyReward; import net.knarcraft.minigames.arena.reward.ItemReward; import net.knarcraft.minigames.arena.reward.PermissionReward; import net.knarcraft.minigames.command.LeaveArenaCommand; +import net.knarcraft.minigames.command.MenuCommand; import net.knarcraft.minigames.command.ReloadCommand; import net.knarcraft.minigames.command.dropper.CreateDropperArenaCommand; import net.knarcraft.minigames.command.dropper.DropperGroupListCommand; @@ -49,16 +55,19 @@ import net.knarcraft.minigames.command.parkour.ParkourGroupSwapCommand; import net.knarcraft.minigames.command.parkour.RemoveParkourArenaCommand; import net.knarcraft.minigames.command.parkour.RemoveParkourArenaTabCompleter; import net.knarcraft.minigames.config.DropperConfiguration; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.config.ParkourConfiguration; import net.knarcraft.minigames.config.SharedConfiguration; import net.knarcraft.minigames.container.SerializableMaterial; import net.knarcraft.minigames.container.SerializableUUID; import net.knarcraft.minigames.listener.CommandListener; import net.knarcraft.minigames.listener.DamageListener; +import net.knarcraft.minigames.listener.InteractListener; import net.knarcraft.minigames.listener.MoveListener; import net.knarcraft.minigames.listener.PlayerStateChangeListener; import net.knarcraft.minigames.placeholder.DropperRecordExpansion; import net.knarcraft.minigames.placeholder.ParkourRecordExpansion; +import net.md_5.bungee.api.ChatColor; import org.bukkit.Bukkit; import org.bukkit.command.CommandExecutor; import org.bukkit.command.PluginCommand; @@ -88,6 +97,9 @@ public final class MiniGames extends JavaPlugin { private ParkourRecordExpansion parkourRecordExpansion; private ParkourArenaHandler parkourArenaHandler; private ArenaPlayerRegistry parkourArenaPlayerRegistry; + private PlayerVisibilityManager playerVisibilityManager; + private Translator translator; + private StringFormatter stringFormatter; /** * Gets an instance of this plugin @@ -163,6 +175,33 @@ public final class MiniGames extends JavaPlugin { return this.parkourConfiguration; } + /** + * Gets the manager keeping track of player visibility + * + * @return

The player visibility manager

+ */ + public PlayerVisibilityManager getPlayerVisibilityManager() { + return this.playerVisibilityManager; + } + + /** + * Gets the translator to get messages from + * + * @return

The translator

+ */ + public Translator getTranslator() { + return this.translator; + } + + /** + * Gets the string formatter to get formatted messages from + * + * @return

The string formatter

+ */ + public StringFormatter getStringFormatter() { + return this.stringFormatter; + } + /** * Gets the current session of the given player * @@ -198,6 +237,8 @@ public final class MiniGames extends JavaPlugin { // Reload configuration this.reloadConfig(); + translator.loadLanguages(this.getDataFolder(), "en", + getConfig().getString("language", "en")); this.sharedConfiguration.load(this.getConfig()); this.dropperConfiguration.load(this.getConfig()); this.parkourConfiguration.load(this.getConfig()); @@ -235,47 +276,35 @@ public final class MiniGames extends JavaPlugin { public void onEnable() { // Plugin startup logic instance = this; - this.saveDefaultConfig(); - getConfig().options().copyDefaults(true); - saveConfig(); - reloadConfig(); - this.sharedConfiguration = new SharedConfiguration(this.getConfig()); - this.dropperConfiguration = new DropperConfiguration(this.getConfig()); - this.parkourConfiguration = new ParkourConfiguration(this.getConfig()); - this.dropperArenaPlayerRegistry = new DropperArenaPlayerRegistry(); - this.dropperArenaHandler = new DropperArenaHandler(this.dropperArenaPlayerRegistry); - this.dropperArenaHandler.load(); - this.parkourArenaPlayerRegistry = new ParkourArenaPlayerRegistry(); - this.parkourArenaHandler = new ParkourArenaHandler(this.parkourArenaPlayerRegistry); - this.parkourArenaHandler.load(); - PluginManager pluginManager = getServer().getPluginManager(); - pluginManager.registerEvents(new DamageListener(), this); - pluginManager.registerEvents(new MoveListener(this.dropperConfiguration, this.parkourConfiguration), this); - pluginManager.registerEvents(new PlayerStateChangeListener(), this); - pluginManager.registerEvents(new CommandListener(), this); + // Load configuration + loadConfiguration(); - registerCommand("miniGamesReload", new ReloadCommand(), null); - registerCommand("miniGamesLeave", new LeaveArenaCommand(), null); + // Register all listeners + registerListeners(); - registerCommand("dropperCreate", new CreateDropperArenaCommand(), null); - registerCommand("dropperList", new ListDropperArenaCommand(), null); - registerCommand("dropperJoin", new JoinDropperArenaCommand(), new JoinDropperArenaTabCompleter()); - registerCommand("dropperEdit", new EditDropperArenaCommand(this.dropperConfiguration), new EditDropperArenaTabCompleter()); - registerCommand("dropperRemove", new RemoveDropperArenaCommand(), new RemoveDropperArenaTabCompleter()); - registerCommand("dropperGroupSet", new DropperGroupSetCommand(), null); - registerCommand("dropperGroupSwap", new DropperGroupSwapCommand(), null); - registerCommand("dropperGroupList", new DropperGroupListCommand(), null); + // Register all commands + registerCommands(); - registerCommand("parkourCreate", new CreateParkourArenaCommand(), null); - registerCommand("parkourList", new ListParkourArenaCommand(), null); - registerCommand("parkourJoin", new JoinParkourArenaCommand(), new JoinParkourArenaTabCompleter()); - registerCommand("parkourEdit", new EditParkourArenaCommand(), new EditParkourArenaTabCompleter()); - registerCommand("parkourRemove", new RemoveParkourArenaCommand(), new RemoveParkourArenaTabCompleter()); - registerCommand("parkourGroupSet", new ParkourGroupSetCommand(), null); - registerCommand("parkourGroupSwap", new ParkourGroupSwapCommand(), null); - registerCommand("parkourGroupList", new ParkourGroupListCommand(), null); + // Integrate with other plugins + doPluginIntegration(); + } + @Override + public void onDisable() { + // Kill all sessions before exiting + for (DropperArena arena : dropperArenaHandler.getArenas().values()) { + dropperArenaPlayerRegistry.removeForArena(arena, true); + } + for (ParkourArena arena : parkourArenaHandler.getArenas().values()) { + parkourArenaPlayerRegistry.removeForArena(arena, true); + } + } + + /** + * Sets up integration with third-party plugins + */ + private void doPluginIntegration() { if (Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null) { this.dropperRecordExpansion = new DropperRecordExpansion(this); if (!this.dropperRecordExpansion.register()) { @@ -288,15 +317,40 @@ public final class MiniGames extends JavaPlugin { } } - @Override - public void onDisable() { - // Kill all sessions before exiting - for (DropperArena arena : dropperArenaHandler.getArenas().values()) { - dropperArenaPlayerRegistry.removeForArena(arena, true); - } - for (ParkourArena arena : parkourArenaHandler.getArenas().values()) { - parkourArenaPlayerRegistry.removeForArena(arena, true); - } + /** + * Loads all configuration values used by this plugin + */ + private void loadConfiguration() { + this.saveDefaultConfig(); + getConfig().options().copyDefaults(true); + saveConfig(); + reloadConfig(); + + setupStringFormatter(); + + this.sharedConfiguration = new SharedConfiguration(this.getConfig()); + this.dropperConfiguration = new DropperConfiguration(this.getConfig()); + this.parkourConfiguration = new ParkourConfiguration(this.getConfig()); + this.dropperArenaPlayerRegistry = new DropperArenaPlayerRegistry(); + this.dropperArenaHandler = new DropperArenaHandler(this.dropperArenaPlayerRegistry); + this.dropperArenaHandler.load(); + this.parkourArenaPlayerRegistry = new ParkourArenaPlayerRegistry(); + this.parkourArenaHandler = new ParkourArenaHandler(this.parkourArenaPlayerRegistry); + this.parkourArenaHandler.load(); + this.playerVisibilityManager = new PlayerVisibilityManager(); + } + + /** + * Registers all listeners used by this plugin + */ + private void registerListeners() { + PluginManager pluginManager = getServer().getPluginManager(); + pluginManager.registerEvents(new DamageListener(), this); + pluginManager.registerEvents(new MoveListener(this.dropperConfiguration, this.parkourConfiguration), this); + pluginManager.registerEvents(new PlayerStateChangeListener(), this); + pluginManager.registerEvents(new CommandListener(), this); + pluginManager.registerEvents(new GUIListener(true), this); + pluginManager.registerEvents(new InteractListener(), this); } /** @@ -319,4 +373,60 @@ public final class MiniGames extends JavaPlugin { } } + /** + * Registers all commands used by this plugin + */ + private void registerCommands() { + registerCommand("miniGamesReload", new ReloadCommand(), null); + registerCommand("miniGamesLeave", new LeaveArenaCommand(), null); + registerCommand("miniGamesMenu", new MenuCommand(), null); + + registerDropperCommands(); + registerParkourCommands(); + } + + /** + * Registers all commands related to droppers + */ + private void registerDropperCommands() { + registerCommand("dropperCreate", new CreateDropperArenaCommand(), null); + registerCommand("dropperList", new ListDropperArenaCommand(), null); + registerCommand("dropperJoin", new JoinDropperArenaCommand(), new JoinDropperArenaTabCompleter()); + registerCommand("dropperEdit", new EditDropperArenaCommand(this.dropperConfiguration), new EditDropperArenaTabCompleter()); + registerCommand("dropperRemove", new RemoveDropperArenaCommand(), new RemoveDropperArenaTabCompleter()); + registerCommand("dropperGroupSet", new DropperGroupSetCommand(), null); + registerCommand("dropperGroupSwap", new DropperGroupSwapCommand(), null); + registerCommand("dropperGroupList", new DropperGroupListCommand(), null); + } + + /** + * Registers all commands related to parkour + */ + private void registerParkourCommands() { + registerCommand("parkourCreate", new CreateParkourArenaCommand(), null); + registerCommand("parkourList", new ListParkourArenaCommand(), null); + registerCommand("parkourJoin", new JoinParkourArenaCommand(), new JoinParkourArenaTabCompleter()); + registerCommand("parkourEdit", new EditParkourArenaCommand(), new EditParkourArenaTabCompleter()); + registerCommand("parkourRemove", new RemoveParkourArenaCommand(), new RemoveParkourArenaTabCompleter()); + registerCommand("parkourGroupSet", new ParkourGroupSetCommand(), null); + registerCommand("parkourGroupSwap", new ParkourGroupSwapCommand(), null); + registerCommand("parkourGroupList", new ParkourGroupListCommand(), null); + } + + /** + * Sets up the translator and the string formatter + */ + private void setupStringFormatter() { + translator = new Translator(); + translator.registerMessageCategory(MiniGameMessage.ERROR_PLAYER_ONLY); + translator.loadLanguages(this.getDataFolder(), "en", + getConfig().getString("language", "en")); + stringFormatter = new StringFormatter(this.getDescription().getName(), translator); + stringFormatter.setColorConversion(ColorConversion.RGB); + stringFormatter.setNamePrefix("#546EED[&r&l"); + stringFormatter.setNameSuffix("#546EED]"); + stringFormatter.setErrorColor(ChatColor.RED); + stringFormatter.setSuccessColor(ChatColor.GREEN); + } + } diff --git a/src/main/java/net/knarcraft/minigames/arena/AbstractArenaPlayerRegistry.java b/src/main/java/net/knarcraft/minigames/arena/AbstractArenaPlayerRegistry.java index c9b17d7..405cb76 100644 --- a/src/main/java/net/knarcraft/minigames/arena/AbstractArenaPlayerRegistry.java +++ b/src/main/java/net/knarcraft/minigames/arena/AbstractArenaPlayerRegistry.java @@ -29,6 +29,11 @@ public abstract class AbstractArenaPlayerRegistry implements Ar loadEntryStates(); } + @Override + public @NotNull Set getPlayingPlayers() { + return arenaPlayers.keySet(); + } + @Override public @Nullable PlayerEntryState getEntryState(@NotNull UUID playerId) { return this.entryStates.get(playerId); @@ -65,13 +70,15 @@ public abstract class AbstractArenaPlayerRegistry implements Ar @Override public void removeForArena(K arena, boolean immediately) { + Set removed = new HashSet<>(); for (Map.Entry entry : this.arenaPlayers.entrySet()) { if (entry.getValue().getArena() == arena) { // Kick the player gracefully - entry.getValue().triggerQuit(immediately); - this.arenaPlayers.remove(entry.getKey()); + entry.getValue().triggerQuit(immediately, false); + removed.add(entry.getKey()); } } + removed.forEach(this.arenaPlayers::remove); } /** diff --git a/src/main/java/net/knarcraft/minigames/arena/AbstractArenaSession.java b/src/main/java/net/knarcraft/minigames/arena/AbstractArenaSession.java index 79cff03..16362fb 100644 --- a/src/main/java/net/knarcraft/minigames/arena/AbstractArenaSession.java +++ b/src/main/java/net/knarcraft/minigames/arena/AbstractArenaSession.java @@ -1,7 +1,8 @@ package net.knarcraft.minigames.arena; -import net.knarcraft.minigames.config.Message; -import net.knarcraft.minigames.container.PlaceholderContainer; +import net.knarcraft.knarlib.formatting.StringFormatter; +import net.knarcraft.minigames.MiniGames; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.property.RecordResult; import net.knarcraft.minigames.util.PlayerTeleporter; import org.bukkit.Location; @@ -14,7 +15,7 @@ public abstract class AbstractArenaSession implements ArenaSession { private final @NotNull ArenaGameMode gameMode; private final @NotNull Player player; protected int deaths; - protected final long startTime; + protected long startTime; protected PlayerEntryState entryState; /** @@ -33,13 +34,25 @@ public abstract class AbstractArenaSession implements ArenaSession { } @Override - public void triggerQuit(boolean immediately) { + public void triggerQuit(boolean immediately, boolean removeSession) { // Stop this session - removeSession(); + if (removeSession) { + removeSession(); + } // Teleport the player out of the arena teleportToExit(immediately); + // Make the player visible to everyone + MiniGames.getInstance().getPlayerVisibilityManager().showPlayersFor(player); - player.sendMessage(Message.SUCCESS_ARENA_QUIT.getMessage()); + MiniGames.getInstance().getStringFormatter().displaySuccessMessage(player, MiniGameMessage.SUCCESS_ARENA_QUIT); + } + + @Override + public void reset() { + this.deaths = 0; + this.startTime = System.currentTimeMillis(); + PlayerTeleporter.teleportPlayer(this.player, this.arena.getSpawnLocation(), false, false); + this.entryState.setArenaState(); } /** @@ -56,16 +69,17 @@ public abstract class AbstractArenaSession implements ArenaSession { // Gets a string representation of the played game-mode String gameModeString = getGameModeString(); - Message recordInfoMessage = switch (recordResult) { - case WORLD_RECORD -> Message.RECORD_ACHIEVED_GLOBAL; - case PERSONAL_BEST -> Message.RECORD_ACHIEVED_PERSONAL; + MiniGameMessage recordInfoMiniGameMessage = switch (recordResult) { + case WORLD_RECORD -> MiniGameMessage.RECORD_ACHIEVED_GLOBAL; + case PERSONAL_BEST -> MiniGameMessage.RECORD_ACHIEVED_PERSONAL; default -> throw new IllegalStateException("Unexpected value: " + recordResult); }; - String recordInfo = recordInfoMessage.getPartialMessage("{recordType}", type); + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); + String recordInfo = stringFormatter.replacePlaceholder(recordInfoMiniGameMessage, "{recordType}", type); - PlaceholderContainer placeholderContainer = new PlaceholderContainer().add("{gameMode}", gameModeString); - placeholderContainer.add("{recordInfo}", recordInfo); - player.sendMessage(Message.SUCCESS_RECORD_ACHIEVED.getMessage(placeholderContainer)); + stringFormatter.displaySuccessMessage(player, stringFormatter.replacePlaceholders( + MiniGameMessage.SUCCESS_RECORD_ACHIEVED, new String[]{"{gameMode}", "{recordInfo}"}, + new String[]{gameModeString, recordInfo})); } /** diff --git a/src/main/java/net/knarcraft/minigames/arena/AbstractPlayerEntryState.java b/src/main/java/net/knarcraft/minigames/arena/AbstractPlayerEntryState.java index d1bf53b..8c06be1 100644 --- a/src/main/java/net/knarcraft/minigames/arena/AbstractPlayerEntryState.java +++ b/src/main/java/net/knarcraft/minigames/arena/AbstractPlayerEntryState.java @@ -2,16 +2,22 @@ package net.knarcraft.minigames.arena; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.container.SerializableUUID; +import net.knarcraft.minigames.property.PersistentDataKey; import org.bukkit.Bukkit; import org.bukkit.GameMode; import org.bukkit.Location; +import org.bukkit.NamespacedKey; import org.bukkit.entity.Player; -import org.bukkit.potion.PotionEffect; -import org.bukkit.potion.PotionEffectType; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.ItemMeta; +import org.bukkit.persistence.PersistentDataType; import org.jetbrains.annotations.NotNull; import java.util.HashMap; +import java.util.HashSet; import java.util.Map; +import java.util.Objects; +import java.util.Set; import java.util.UUID; import java.util.logging.Level; @@ -21,7 +27,6 @@ import java.util.logging.Level; public abstract class AbstractPlayerEntryState implements PlayerEntryState { protected final UUID playerId; - private final boolean makePlayerInvisible; private final Location entryLocation; private final boolean originalIsFlying; private final GameMode originalGameMode; @@ -33,12 +38,10 @@ public abstract class AbstractPlayerEntryState implements PlayerEntryState { /** * Instantiates a new abstract player entry state * - * @param player

The player whose state this should keep track of

- * @param makePlayerInvisible

Whether players should be made invisible while in the arena

+ * @param player

The player whose state this should keep track of

*/ - public AbstractPlayerEntryState(@NotNull Player player, boolean makePlayerInvisible) { + public AbstractPlayerEntryState(@NotNull Player player) { this.playerId = player.getUniqueId(); - this.makePlayerInvisible = makePlayerInvisible; this.entryLocation = player.getLocation().clone(); this.originalIsFlying = player.isFlying(); this.originalGameMode = player.getGameMode(); @@ -52,7 +55,6 @@ public abstract class AbstractPlayerEntryState implements PlayerEntryState { * Instantiates a new abstract player entry state * * @param playerId

The id of the player whose state this should keep track of

- * @param makePlayerInvisible

Whether players should be made invisible while in the arena

* @param entryLocation

The location the player entered from

* @param originalIsFlying

Whether the player was flying before entering the arena

* @param originalGameMode

The game-mode of the player before entering the arena

@@ -61,12 +63,11 @@ public abstract class AbstractPlayerEntryState implements PlayerEntryState { * @param originalIsSwimming

Whether the player was swimming before entering the arena

* @param originalCollideAble

Whether the player was collide-able before entering the arena

*/ - public AbstractPlayerEntryState(@NotNull UUID playerId, boolean makePlayerInvisible, Location entryLocation, + public AbstractPlayerEntryState(@NotNull UUID playerId, Location entryLocation, boolean originalIsFlying, GameMode originalGameMode, boolean originalAllowFlight, boolean originalInvulnerable, boolean originalIsSwimming, boolean originalCollideAble) { this.playerId = playerId; - this.makePlayerInvisible = makePlayerInvisible; this.entryLocation = entryLocation; this.originalIsFlying = originalIsFlying; this.originalGameMode = originalGameMode; @@ -81,18 +82,6 @@ public abstract class AbstractPlayerEntryState implements PlayerEntryState { return this.playerId; } - @Override - public void setArenaState() { - Player player = getPlayer(); - if (player == null) { - return; - } - if (this.makePlayerInvisible) { - player.addPotionEffect(new PotionEffect(PotionEffectType.INVISIBILITY, - PotionEffect.INFINITE_DURATION, 3)); - } - } - @Override public boolean restore() { Player player = getPlayer(); @@ -105,15 +94,13 @@ public abstract class AbstractPlayerEntryState implements PlayerEntryState { @Override public void restore(@NotNull Player player) { - player.setFlying(this.originalIsFlying); - player.setGameMode(this.originalGameMode); + player.setCollidable(this.originalCollideAble); player.setAllowFlight(this.originalAllowFlight); + player.setFlying(player.getAllowFlight() && this.originalIsFlying); + player.setGameMode(this.originalGameMode); player.setInvulnerable(this.originalInvulnerable); player.setSwimming(this.originalIsSwimming); - player.setCollidable(this.originalCollideAble); - if (this.makePlayerInvisible) { - player.removePotionEffect(PotionEffectType.INVISIBILITY); - } + removeMenuItem(player); } @Override @@ -140,7 +127,6 @@ public abstract class AbstractPlayerEntryState implements PlayerEntryState { public Map serialize() { Map data = new HashMap<>(); data.put("playerId", new SerializableUUID(this.playerId)); - data.put("makePlayerInvisible", this.makePlayerInvisible); data.put("entryLocation", this.entryLocation); data.put("originalIsFlying", this.originalIsFlying); data.put("originalGameMode", this.originalGameMode.name()); @@ -151,4 +137,42 @@ public abstract class AbstractPlayerEntryState implements PlayerEntryState { return data; } + /** + * Removes the menu item from the given player's inventory + * + * @param player

The player to remove the menu item from

+ */ + private void removeMenuItem(Player player) { + Set itemsToRemove = new HashSet<>(); + player.getInventory().forEach((item) -> { + if (item == null) { + return; + } + ItemMeta meta = item.getItemMeta(); + if (meta == null) { + return; + } + Integer persistentData = meta.getPersistentDataContainer().get(new NamespacedKey(MiniGames.getInstance(), + PersistentDataKey.MENU_ITEM.getKeyName()), PersistentDataType.INTEGER); + if (persistentData != null && persistentData == PersistentDataKey.MENU_ITEM.getDataValue()) { + itemsToRemove.add(item); + } + }); + for (ItemStack toRemove : itemsToRemove) { + player.getInventory().remove(toRemove); + } + } + + /** + * Gets a boolean value from a serialization map + * + * @param data

The serialization data to look through

+ * @param key

The key to get

+ * @return

The boolean value of the key

+ */ + protected static boolean getBoolean(Map data, String key) { + Boolean value = (Boolean) data.get(key); + return Objects.requireNonNullElse(value, false); + } + } diff --git a/src/main/java/net/knarcraft/minigames/arena/ArenaPlayerRegistry.java b/src/main/java/net/knarcraft/minigames/arena/ArenaPlayerRegistry.java index cb10111..20f0db2 100644 --- a/src/main/java/net/knarcraft/minigames/arena/ArenaPlayerRegistry.java +++ b/src/main/java/net/knarcraft/minigames/arena/ArenaPlayerRegistry.java @@ -3,6 +3,7 @@ package net.knarcraft.minigames.arena; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; +import java.util.Set; import java.util.UUID; /** @@ -12,6 +13,13 @@ import java.util.UUID; */ public interface ArenaPlayerRegistry { + /** + * Gets the ids of the players currently playing + * + * @return

The ids of the playing players

+ */ + @NotNull Set getPlayingPlayers(); + /** * Gets the current entry state for the given player * diff --git a/src/main/java/net/knarcraft/minigames/arena/ArenaSession.java b/src/main/java/net/knarcraft/minigames/arena/ArenaSession.java index f1afd43..8003b62 100644 --- a/src/main/java/net/knarcraft/minigames/arena/ArenaSession.java +++ b/src/main/java/net/knarcraft/minigames/arena/ArenaSession.java @@ -1,5 +1,6 @@ package net.knarcraft.minigames.arena; +import net.knarcraft.minigames.gui.ArenaGUI; import org.jetbrains.annotations.NotNull; /** @@ -27,9 +28,10 @@ public interface ArenaSession { /** * Triggers a quit for the player playing in this session * - * @param immediately

Whether to to the teleportation immediately, not using any timers

+ * @param immediately

Whether to to the teleportation immediately, not using any timers

+ * @param removeSession

Whether to also remove the session. Should usually be true.

*/ - void triggerQuit(boolean immediately); + void triggerQuit(boolean immediately, boolean removeSession); /** * Gets the arena this session is being played in @@ -38,4 +40,16 @@ public interface ArenaSession { */ @NotNull Arena getArena(); + /** + * Gets the GUI with this arena's options + * + * @return

This arena's GUI

+ */ + @NotNull ArenaGUI getGUI(); + + /** + * Resets the session to allow a player to try again + */ + void reset(); + } diff --git a/src/main/java/net/knarcraft/minigames/arena/PlayerVisibilityManager.java b/src/main/java/net/knarcraft/minigames/arena/PlayerVisibilityManager.java new file mode 100644 index 0000000..9e2e342 --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/arena/PlayerVisibilityManager.java @@ -0,0 +1,109 @@ +package net.knarcraft.minigames.arena; + +import net.knarcraft.minigames.MiniGames; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.HashSet; +import java.util.Set; +import java.util.UUID; + +/** + * A manager for keeping track of which players have set other players as hidden + */ +public class PlayerVisibilityManager { + + private final Set displayingEnabledFor = new HashSet<>(); + + /** + * Toggles whether players should be hidden for the player with the given id + * + * @param player

The the player to update

+ */ + public void toggleHidePlayers(@NotNull ArenaPlayerRegistry playerRegistry, @NotNull Player player) { + if (displayingEnabledFor.contains(player.getUniqueId())) { + displayingEnabledFor.remove(player.getUniqueId()); + // Make all other players hidden + changeVisibilityFor(playerRegistry, player, true); + } else { + displayingEnabledFor.add(player.getUniqueId()); + // Make all other players visible again + changeVisibilityFor(playerRegistry, player, false); + } + + } + + /** + * Gets whether the given player is currently hiding other players + * + * @param player

The player to check

+ * @return

True if currently hiding other players

+ */ + public boolean isHidingPlayers(Player player) { + return !this.displayingEnabledFor.contains(player.getUniqueId()); + } + + /** + * Updates which players are seen as hidden + * + * @param playerRegistry

The registry containing all playing players

+ * @param player

The player that joined the arena

+ */ + public void updateHiddenPlayers(@NotNull ArenaPlayerRegistry playerRegistry, @NotNull Player player) { + boolean hideForPlayer = !displayingEnabledFor.contains(player.getUniqueId()); + for (UUID playerId : playerRegistry.getPlayingPlayers()) { + Player otherPlayer = Bukkit.getPlayer(playerId); + if (otherPlayer == null) { + continue; + } + // Hide the arena player from the newly joined player + if (hideForPlayer) { + player.hidePlayer(MiniGames.getInstance(), otherPlayer); + } + // Hide the newly joined player from this player + if (!displayingEnabledFor.contains(playerId)) { + otherPlayer.hidePlayer(MiniGames.getInstance(), player); + } + } + } + + /** + * Makes all players visible to the given player + * + * @param player

The player to update visibility for

+ */ + public void showPlayersFor(@NotNull Player player) { + for (Player otherPlayer : Bukkit.getOnlinePlayers()) { + player.showPlayer(MiniGames.getInstance(), otherPlayer); + otherPlayer.showPlayer(MiniGames.getInstance(), player); + } + } + + /** + * Changes whether the given player can see the other players in the arena + * + * @param playerRegistry

The player registry containing other players

+ * @param player

The player to change the visibility for

+ * @param hide

Whether to hide the players or show the players

+ */ + private void changeVisibilityFor(@Nullable ArenaPlayerRegistry playerRegistry, @NotNull Player player, boolean hide) { + if (playerRegistry == null) { + return; + } + for (UUID playerId : playerRegistry.getPlayingPlayers()) { + Player otherPlayer = Bukkit.getPlayer(playerId); + if (otherPlayer == null) { + continue; + } + + if (hide) { + player.hidePlayer(MiniGames.getInstance(), otherPlayer); + } else { + player.showPlayer(MiniGames.getInstance(), otherPlayer); + } + } + } + +} diff --git a/src/main/java/net/knarcraft/minigames/arena/dropper/DropperArena.java b/src/main/java/net/knarcraft/minigames/arena/dropper/DropperArena.java index eb5cbc0..ba3d627 100644 --- a/src/main/java/net/knarcraft/minigames/arena/dropper/DropperArena.java +++ b/src/main/java/net/knarcraft/minigames/arena/dropper/DropperArena.java @@ -206,7 +206,7 @@ public class DropperArena implements Arena { try { DropperArenaStorageHelper.saveDropperArenaData(getData()); return true; - } catch (IOException e) { + } catch (IOException exception) { return false; } } diff --git a/src/main/java/net/knarcraft/minigames/arena/dropper/DropperArenaHandler.java b/src/main/java/net/knarcraft/minigames/arena/dropper/DropperArenaHandler.java index bc07a47..1bb3f5b 100644 --- a/src/main/java/net/knarcraft/minigames/arena/dropper/DropperArenaHandler.java +++ b/src/main/java/net/knarcraft/minigames/arena/dropper/DropperArenaHandler.java @@ -3,7 +3,7 @@ package net.knarcraft.minigames.arena.dropper; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.ArenaHandler; import net.knarcraft.minigames.arena.ArenaPlayerRegistry; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.util.DropperArenaStorageHelper; import java.io.IOException; @@ -32,9 +32,10 @@ public class DropperArenaHandler extends ArenaHandler(this.arenaGroups.values())); - } catch (IOException e) { - MiniGames.log(Level.SEVERE, Message.ERROR_CANNOT_SAVE_ARENA_GROUPS.getMessage()); - MiniGames.log(Level.SEVERE, e.getMessage()); + } catch (IOException exception) { + MiniGames.log(Level.SEVERE, MiniGames.getInstance().getTranslator().getTranslatedMessage( + MiniGameMessage.ERROR_CANNOT_SAVE_ARENA_GROUPS)); + MiniGames.log(Level.SEVERE, exception.getMessage()); } } @@ -54,10 +55,10 @@ public class DropperArenaHandler extends ArenaHandlerTrue if the player has started moving

+ */ + public boolean getStartedMoving() { + return this.startedMoving; + } + /** * Gets the player playing in this session * @@ -78,11 +93,13 @@ public class DropperArenaSession extends AbstractArenaSession { registerRecord(); } + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); + // Mark the arena as cleared if (this.arena.getData().setCompleted(this.gameMode, this.player)) { - this.player.sendMessage(Message.SUCCESS_ARENA_FIRST_CLEAR.getMessage()); + stringFormatter.displaySuccessMessage(this.player, MiniGameMessage.SUCCESS_ARENA_FIRST_CLEAR); } - this.player.sendMessage(Message.SUCCESS_ARENA_WIN.getMessage()); + stringFormatter.displaySuccessMessage(this.player, MiniGameMessage.SUCCESS_ARENA_WIN); // Teleport the player out of the arena teleportToExit(false); @@ -101,6 +118,17 @@ public class DropperArenaSession extends AbstractArenaSession { return this.arena; } + @Override + public @NotNull ArenaGUI getGUI() { + return new DropperGUI(player); + } + + @Override + public void reset() { + this.startedMoving = false; + super.reset(); + } + @Override protected void removeSession() { // Remove this session for game sessions to stop listeners from fiddling more with the player diff --git a/src/main/java/net/knarcraft/minigames/arena/dropper/DropperPlayerEntryState.java b/src/main/java/net/knarcraft/minigames/arena/dropper/DropperPlayerEntryState.java index 3a8e993..48e764c 100644 --- a/src/main/java/net/knarcraft/minigames/arena/dropper/DropperPlayerEntryState.java +++ b/src/main/java/net/knarcraft/minigames/arena/dropper/DropperPlayerEntryState.java @@ -16,7 +16,6 @@ import java.util.UUID; public class DropperPlayerEntryState extends AbstractPlayerEntryState { private final float originalFlySpeed; - private final boolean disableHitCollision; private final float horizontalVelocity; private final DropperArenaGameMode arenaGameMode; @@ -26,11 +25,10 @@ public class DropperPlayerEntryState extends AbstractPlayerEntryState { * @param player

The player whose state should be stored

*/ public DropperPlayerEntryState(@NotNull Player player, @NotNull DropperArenaGameMode arenaGameMode, - boolean makePlayerInvisible, boolean disableHitCollision, float horizontalVelocity) { - super(player, makePlayerInvisible); + float horizontalVelocity) { + super(player); this.originalFlySpeed = player.getFlySpeed(); this.arenaGameMode = arenaGameMode; - this.disableHitCollision = disableHitCollision; this.horizontalVelocity = horizontalVelocity; } @@ -38,31 +36,30 @@ public class DropperPlayerEntryState extends AbstractPlayerEntryState { * Instantiates a new parkour player entry state * * @param playerId

The id of the player whose state this should keep track of

- * @param makePlayerInvisible

Whether players should be made invisible while in the arena

* @param entryLocation

The location the player entered from

* @param originalIsFlying

Whether the player was flying before entering the arena

* @param originalGameMode

The game-mode of the player before entering the arena

* @param originalAllowFlight

Whether the player was allowed flight before entering the arena

* @param originalInvulnerable

Whether the player was invulnerable before entering the arena

* @param originalIsSwimming

Whether the player was swimming before entering the arena

+ * @param originalFlySpeed

The fly-speed of the player before entering the arena

+ * @param horizontalVelocity

The horizontal velocity of the player before entering the arena

* @param originalCollideAble

Whether the player was collide-able before entering the arena

*/ - public DropperPlayerEntryState(@NotNull UUID playerId, boolean makePlayerInvisible, Location entryLocation, + public DropperPlayerEntryState(@NotNull UUID playerId, Location entryLocation, boolean originalIsFlying, GameMode originalGameMode, boolean originalAllowFlight, boolean originalInvulnerable, boolean originalIsSwimming, - boolean originalCollideAble, float originalFlySpeed, boolean disableHitCollision, - float horizontalVelocity, DropperArenaGameMode arenaGameMode) { - super(playerId, makePlayerInvisible, entryLocation, originalIsFlying, originalGameMode, originalAllowFlight, + float originalFlySpeed, float horizontalVelocity, + DropperArenaGameMode arenaGameMode, boolean originalCollideAble) { + super(playerId, entryLocation, originalIsFlying, originalGameMode, originalAllowFlight, originalInvulnerable, originalIsSwimming, originalCollideAble); this.originalFlySpeed = originalFlySpeed; - this.disableHitCollision = disableHitCollision; this.horizontalVelocity = horizontalVelocity; this.arenaGameMode = arenaGameMode; } @Override public void setArenaState() { - super.setArenaState(); Player player = getPlayer(); if (player == null) { return; @@ -71,9 +68,6 @@ public class DropperPlayerEntryState extends AbstractPlayerEntryState { player.setFlying(true); player.setGameMode(GameMode.ADVENTURE); player.setSwimming(false); - if (this.disableHitCollision) { - player.setCollidable(false); - } // If playing on the inverted game-mode, negate the horizontal velocity to swap the controls if (this.arenaGameMode == DropperArenaGameMode.INVERTED) { @@ -104,7 +98,6 @@ public class DropperPlayerEntryState extends AbstractPlayerEntryState { public Map serialize() { Map data = super.serialize(); data.put("originalFlySpeed", this.originalFlySpeed); - data.put("disableHitCollision", this.disableHitCollision); data.put("horizontalVelocity", this.horizontalVelocity); data.put("arenaGameMode", this.arenaGameMode); return data; @@ -118,22 +111,20 @@ public class DropperPlayerEntryState extends AbstractPlayerEntryState { @SuppressWarnings("unused") public static DropperPlayerEntryState deserialize(Map data) { UUID playerId = ((SerializableUUID) data.get("playerId")).getRawValue(); - boolean makePlayerInvisible = (boolean) data.get("makePlayerInvisible"); Location entryLocation = (Location) data.get("entryLocation"); - boolean originalIsFlying = (boolean) data.get("originalIsFlying"); + boolean originalIsFlying = getBoolean(data, "originalIsFlying"); GameMode originalGameMode = GameMode.valueOf((String) data.get("originalGameMode")); - boolean originalAllowFlight = (boolean) data.get("originalAllowFlight"); - boolean originalInvulnerable = (boolean) data.get("originalInvulnerable"); - boolean originalIsSwimming = (boolean) data.get("originalIsSwimming"); - boolean originalCollideAble = (boolean) data.get("originalCollideAble"); + boolean originalAllowFlight = getBoolean(data, "originalAllowFlight"); + boolean originalInvulnerable = getBoolean(data, "originalInvulnerable"); + boolean originalIsSwimming = getBoolean(data, "originalIsSwimming"); float originalFlySpeed = ((Number) data.get("originalFlySpeed")).floatValue(); - boolean disableHitCollision = (boolean) data.get("disableHitCollision"); float horizontalVelocity = ((Number) data.get("horizontalVelocity")).floatValue(); DropperArenaGameMode arenaGameMode = (DropperArenaGameMode) data.get("arenaGameMode"); + boolean originalCollideAble = getBoolean(data, "originalCollideAble"); - return new DropperPlayerEntryState(playerId, makePlayerInvisible, entryLocation, originalIsFlying, - originalGameMode, originalAllowFlight, originalInvulnerable, originalIsSwimming, originalCollideAble, - originalFlySpeed, disableHitCollision, horizontalVelocity, arenaGameMode); + return new DropperPlayerEntryState(playerId, entryLocation, originalIsFlying, + originalGameMode, originalAllowFlight, originalInvulnerable, originalIsSwimming, + originalFlySpeed, horizontalVelocity, arenaGameMode, originalCollideAble); } } diff --git a/src/main/java/net/knarcraft/minigames/arena/parkour/ParkourArena.java b/src/main/java/net/knarcraft/minigames/arena/parkour/ParkourArena.java index ecd9a3c..3d05507 100644 --- a/src/main/java/net/knarcraft/minigames/arena/parkour/ParkourArena.java +++ b/src/main/java/net/knarcraft/minigames/arena/parkour/ParkourArena.java @@ -1,10 +1,10 @@ package net.knarcraft.minigames.arena.parkour; +import net.knarcraft.knarlib.util.MaterialHelper; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.Arena; import net.knarcraft.minigames.arena.ArenaGameMode; import net.knarcraft.minigames.arena.ArenaRecordsRegistry; -import net.knarcraft.minigames.util.MaterialHelper; import net.knarcraft.minigames.util.ParkourArenaStorageHelper; import net.knarcraft.minigames.util.StringSanitizer; import org.bukkit.Location; @@ -106,7 +106,7 @@ public class ParkourArena implements Arena { this.winLocation = winLocation; this.killPlaneBlockNames = killPlaneBlockNames; this.killPlaneBlocks = this.killPlaneBlockNames == null ? null : MaterialHelper.loadMaterialList( - new ArrayList<>(killPlaneBlockNames)); + new ArrayList<>(killPlaneBlockNames), "+", MiniGames.getInstance().getLogger()); this.checkpoints = checkpoints; this.parkourArenaData = parkourArenaData; this.parkourArenaHandler = arenaHandler; @@ -250,7 +250,7 @@ public class ParkourArena implements Arena { try { ParkourArenaStorageHelper.saveParkourArenaData(getData()); return true; - } catch (IOException e) { + } catch (IOException exception) { return false; } } @@ -366,7 +366,8 @@ public class ParkourArena implements Arena { if (killPlaneBlockNames.isEmpty()) { this.killPlaneBlocks = null; } else { - Set parsed = MaterialHelper.loadMaterialList(new ArrayList<>(killPlaneBlockNames)); + Set parsed = MaterialHelper.loadMaterialList(new ArrayList<>(killPlaneBlockNames), "+", + MiniGames.getInstance().getLogger()); if (parsed.isEmpty()) { return false; } diff --git a/src/main/java/net/knarcraft/minigames/arena/parkour/ParkourArenaHandler.java b/src/main/java/net/knarcraft/minigames/arena/parkour/ParkourArenaHandler.java index 7e52ff6..ba769da 100644 --- a/src/main/java/net/knarcraft/minigames/arena/parkour/ParkourArenaHandler.java +++ b/src/main/java/net/knarcraft/minigames/arena/parkour/ParkourArenaHandler.java @@ -3,7 +3,7 @@ package net.knarcraft.minigames.arena.parkour; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.ArenaHandler; import net.knarcraft.minigames.arena.ArenaPlayerRegistry; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.util.ParkourArenaStorageHelper; import java.io.IOException; @@ -32,9 +32,10 @@ public class ParkourArenaHandler extends ArenaHandler(this.arenaGroups.values())); - } catch (IOException e) { - MiniGames.log(Level.SEVERE, Message.ERROR_CANNOT_SAVE_ARENA_GROUPS.getMessage()); - MiniGames.log(Level.SEVERE, e.getMessage()); + } catch (IOException exception) { + MiniGames.log(Level.SEVERE, MiniGames.getInstance().getTranslator().getTranslatedMessage( + MiniGameMessage.ERROR_CANNOT_SAVE_ARENA_GROUPS)); + MiniGames.log(Level.SEVERE, exception.getMessage()); } } @@ -54,10 +55,10 @@ public class ParkourArenaHandler extends ArenaHandlerThe player whose state should be stored

*/ - public ParkourPlayerEntryState(@NotNull Player player, boolean makePlayerInvisible) { - super(player, makePlayerInvisible); + public ParkourPlayerEntryState(@NotNull Player player) { + super(player); } /** * Instantiates a new parkour player entry state * * @param playerId

The id of the player whose state this should keep track of

- * @param makePlayerInvisible

Whether players should be made invisible while in the arena

* @param entryLocation

The location the player entered from

* @param originalIsFlying

Whether the player was flying before entering the arena

* @param originalGameMode

The game-mode of the player before entering the arena

@@ -37,17 +36,15 @@ public class ParkourPlayerEntryState extends AbstractPlayerEntryState { * @param originalIsSwimming

Whether the player was swimming before entering the arena

* @param originalCollideAble

Whether the player was collide-able before entering the arena

*/ - public ParkourPlayerEntryState(@NotNull UUID playerId, boolean makePlayerInvisible, Location entryLocation, + public ParkourPlayerEntryState(@NotNull UUID playerId, Location entryLocation, boolean originalIsFlying, GameMode originalGameMode, boolean originalAllowFlight, - boolean originalInvulnerable, boolean originalIsSwimming, - boolean originalCollideAble) { - super(playerId, makePlayerInvisible, entryLocation, originalIsFlying, originalGameMode, originalAllowFlight, + boolean originalInvulnerable, boolean originalIsSwimming, boolean originalCollideAble) { + super(playerId, entryLocation, originalIsFlying, originalGameMode, originalAllowFlight, originalInvulnerable, originalIsSwimming, originalCollideAble); } @Override public void setArenaState() { - super.setArenaState(); Player player = getPlayer(); if (player == null) { return; @@ -56,7 +53,6 @@ public class ParkourPlayerEntryState extends AbstractPlayerEntryState { player.setFlying(false); player.setGameMode(GameMode.ADVENTURE); player.setSwimming(false); - player.setCollidable(false); } /** @@ -67,16 +63,15 @@ public class ParkourPlayerEntryState extends AbstractPlayerEntryState { @SuppressWarnings("unused") public static ParkourPlayerEntryState deserialize(Map data) { UUID playerId = ((SerializableUUID) data.get("playerId")).getRawValue(); - boolean makePlayerInvisible = (boolean) data.get("makePlayerInvisible"); Location entryLocation = (Location) data.get("entryLocation"); - boolean originalIsFlying = (boolean) data.get("originalIsFlying"); + boolean originalIsFlying = getBoolean(data, "originalIsFlying"); GameMode originalGameMode = GameMode.valueOf((String) data.get("originalGameMode")); - boolean originalAllowFlight = (boolean) data.get("originalAllowFlight"); - boolean originalInvulnerable = (boolean) data.get("originalInvulnerable"); - boolean originalIsSwimming = (boolean) data.get("originalIsSwimming"); - boolean originalCollideAble = (boolean) data.get("originalCollideAble"); + boolean originalAllowFlight = getBoolean(data, "originalAllowFlight"); + boolean originalInvulnerable = getBoolean(data, "originalInvulnerable"); + boolean originalIsSwimming = getBoolean(data, "originalIsSwimming"); + boolean originalCollideAble = getBoolean(data, "originalCollideAble"); - return new ParkourPlayerEntryState(playerId, makePlayerInvisible, entryLocation, originalIsFlying, + return new ParkourPlayerEntryState(playerId, entryLocation, originalIsFlying, originalGameMode, originalAllowFlight, originalInvulnerable, originalIsSwimming, originalCollideAble); } diff --git a/src/main/java/net/knarcraft/minigames/command/LeaveArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/LeaveArenaCommand.java index 177508e..0eec620 100644 --- a/src/main/java/net/knarcraft/minigames/command/LeaveArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/LeaveArenaCommand.java @@ -2,7 +2,7 @@ package net.knarcraft.minigames.command; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.ArenaSession; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.command.Command; import org.bukkit.command.CommandSender; import org.bukkit.command.TabExecutor; @@ -22,17 +22,19 @@ public class LeaveArenaCommand implements TabExecutor { public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] strings) { if (!(commandSender instanceof Player player)) { - commandSender.sendMessage(Message.ERROR_PLAYER_ONLY.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(commandSender, + MiniGameMessage.ERROR_PLAYER_ONLY); return false; } ArenaSession existingSession = MiniGames.getInstance().getSession(player.getUniqueId()); if (existingSession == null) { - commandSender.sendMessage(Message.ERROR_NOT_IN_ARENA.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(commandSender, + MiniGameMessage.ERROR_NOT_IN_ARENA); return false; } - existingSession.triggerQuit(false); + existingSession.triggerQuit(false, true); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/MenuCommand.java b/src/main/java/net/knarcraft/minigames/command/MenuCommand.java new file mode 100644 index 0000000..94727f2 --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/command/MenuCommand.java @@ -0,0 +1,41 @@ +package net.knarcraft.minigames.command; + +import net.knarcraft.minigames.MiniGames; +import net.knarcraft.minigames.config.MiniGameMessage; +import net.knarcraft.minigames.util.GUIHelper; +import org.bukkit.command.Command; +import org.bukkit.command.CommandSender; +import org.bukkit.command.TabExecutor; +import org.bukkit.entity.Player; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.ArrayList; +import java.util.List; + +/** + * The command for opening up an arena's menu + */ +public class MenuCommand implements TabExecutor { + + @Override + public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, + @NotNull String[] arguments) { + if (!(commandSender instanceof Player player)) { + MiniGames.getInstance().getStringFormatter().displayErrorMessage(commandSender, + MiniGameMessage.ERROR_PLAYER_ONLY); + return false; + } + + GUIHelper.openGUI(player); + return true; + } + + @Nullable + @Override + public List onTabComplete(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, + @NotNull String[] strings) { + return new ArrayList<>(); + } + +} diff --git a/src/main/java/net/knarcraft/minigames/command/ReloadCommand.java b/src/main/java/net/knarcraft/minigames/command/ReloadCommand.java index 36168b7..80da0ab 100644 --- a/src/main/java/net/knarcraft/minigames/command/ReloadCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/ReloadCommand.java @@ -1,7 +1,7 @@ package net.knarcraft.minigames.command; import net.knarcraft.minigames.MiniGames; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.command.Command; import org.bukkit.command.CommandSender; import org.bukkit.command.TabExecutor; @@ -20,7 +20,8 @@ public class ReloadCommand implements TabExecutor { public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] arguments) { MiniGames.getInstance().reload(); - commandSender.sendMessage(Message.SUCCESS_PLUGIN_RELOADED.getMessage()); + MiniGames.getInstance().getStringFormatter().displaySuccessMessage(commandSender, + MiniGameMessage.SUCCESS_PLUGIN_RELOADED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/dropper/CreateDropperArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/dropper/CreateDropperArenaCommand.java index 623c133..6e982ad 100644 --- a/src/main/java/net/knarcraft/minigames/command/dropper/CreateDropperArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/dropper/CreateDropperArenaCommand.java @@ -3,7 +3,7 @@ package net.knarcraft.minigames.command.dropper; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.dropper.DropperArena; import net.knarcraft.minigames.arena.dropper.DropperArenaHandler; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.util.StringSanitizer; import org.bukkit.command.Command; import org.bukkit.command.CommandExecutor; @@ -20,7 +20,8 @@ public class CreateDropperArenaCommand implements CommandExecutor { public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] arguments) { if (!(commandSender instanceof Player player)) { - commandSender.sendMessage(Message.ERROR_PLAYER_ONLY.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(commandSender, + MiniGameMessage.ERROR_PLAYER_ONLY); return false; } @@ -41,13 +42,15 @@ public class CreateDropperArenaCommand implements CommandExecutor { DropperArena existingArena = arenaHandler.getArena(arenaName); if (existingArena != null) { - commandSender.sendMessage(Message.ERROR_ARENA_NAME_COLLISION.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(commandSender, + MiniGameMessage.ERROR_ARENA_NAME_COLLISION); return false; } DropperArena arena = new DropperArena(arenaName, player.getLocation(), arenaHandler); arenaHandler.addArena(arena); - commandSender.sendMessage(Message.SUCCESS_ARENA_CREATED.getMessage()); + MiniGames.getInstance().getStringFormatter().displaySuccessMessage(commandSender, + MiniGameMessage.SUCCESS_ARENA_CREATED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupListCommand.java b/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupListCommand.java index c571e09..fe654d8 100644 --- a/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupListCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupListCommand.java @@ -1,10 +1,11 @@ package net.knarcraft.minigames.command.dropper; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.dropper.DropperArena; import net.knarcraft.minigames.arena.dropper.DropperArenaGroup; import net.knarcraft.minigames.arena.dropper.DropperArenaHandler; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.command.Command; import org.bukkit.command.CommandSender; import org.bukkit.command.TabExecutor; @@ -60,13 +61,15 @@ public class DropperGroupListCommand implements TabExecutor { private boolean displayOrderedArenaNames(@NotNull DropperArenaHandler arenaHandler, @NotNull CommandSender sender, @NotNull String groupName) { DropperArenaGroup arenaGroup = arenaHandler.getGroup(groupName); + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); if (arenaGroup == null) { - sender.sendMessage(Message.ERROR_GROUP_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(sender, MiniGameMessage.ERROR_GROUP_NOT_FOUND); return false; } // Send a list of all stages (arenas in the group) - StringBuilder builder = new StringBuilder(Message.SUCCESS_GROUP_STAGES.getMessage("{group}", groupName)); + StringBuilder builder = new StringBuilder(stringFormatter.replacePlaceholder( + MiniGameMessage.SUCCESS_GROUP_STAGES, "{group}", groupName)); int counter = 1; for (UUID arenaId : arenaGroup.getArenas()) { DropperArena arena = arenaHandler.getArena(arenaId); @@ -74,7 +77,7 @@ public class DropperGroupListCommand implements TabExecutor { builder.append(counter++).append(". ").append(arena.getArenaName()).append("\n"); } } - sender.sendMessage(builder.toString()); + stringFormatter.displaySuccessMessage(sender, builder.toString()); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupSetCommand.java b/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupSetCommand.java index b1d3008..d1bfb4d 100644 --- a/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupSetCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupSetCommand.java @@ -4,7 +4,7 @@ import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.dropper.DropperArena; import net.knarcraft.minigames.arena.dropper.DropperArenaGroup; import net.knarcraft.minigames.arena.dropper.DropperArenaHandler; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.util.StringSanitizer; import net.knarcraft.minigames.util.TabCompleteHelper; import org.bukkit.command.Command; @@ -34,7 +34,8 @@ public class DropperGroupSetCommand implements TabExecutor { DropperArena specifiedArena = arenaHandler.getArena(arguments[0]); if (specifiedArena == null) { - commandSender.sendMessage(Message.ERROR_ARENA_NOT_FOUND.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(commandSender, + MiniGameMessage.ERROR_ARENA_NOT_FOUND); return false; } @@ -56,7 +57,8 @@ public class DropperGroupSetCommand implements TabExecutor { arenaHandler.setGroup(specifiedArena.getArenaId(), arenaGroup); - commandSender.sendMessage(Message.SUCCESS_ARENA_GROUP_UPDATED.getMessage()); + MiniGames.getInstance().getStringFormatter().displaySuccessMessage(commandSender, + MiniGameMessage.SUCCESS_ARENA_GROUP_UPDATED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupSwapCommand.java b/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupSwapCommand.java index f1832ab..404018b 100644 --- a/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupSwapCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/dropper/DropperGroupSwapCommand.java @@ -1,10 +1,11 @@ package net.knarcraft.minigames.command.dropper; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.dropper.DropperArena; import net.knarcraft.minigames.arena.dropper.DropperArenaGroup; import net.knarcraft.minigames.arena.dropper.DropperArenaHandler; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.command.Command; import org.bukkit.command.CommandSender; import org.bukkit.command.TabExecutor; @@ -29,30 +30,31 @@ public class DropperGroupSwapCommand implements TabExecutor { return false; } + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); DropperArenaHandler arenaHandler = MiniGames.getInstance().getDropperArenaHandler(); DropperArena arena1 = arenaHandler.getArena(arguments[0]); if (arena1 == null) { - commandSender.sendMessage(Message.ERROR_ARENA_1_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_1_NOT_FOUND); return false; } DropperArena arena2 = arenaHandler.getArena(arguments[1]); if (arena2 == null) { - commandSender.sendMessage(Message.ERROR_ARENA_2_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_2_NOT_FOUND); return false; } DropperArenaGroup arena1Group = arenaHandler.getGroup(arena1.getArenaId()); DropperArenaGroup arena2Group = arenaHandler.getGroup(arena2.getArenaId()); if (arena1Group == null || !arena1Group.equals(arena2Group)) { - commandSender.sendMessage(Message.ERROR_SWAP_DIFFERENT_GROUPS.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_SWAP_DIFFERENT_GROUPS); return false; } arena1Group.swapArenas(arena1Group.getArenas().indexOf(arena1.getArenaId()), arena1Group.getArenas().indexOf(arena2.getArenaId())); - commandSender.sendMessage(Message.SUCCESS_ARENAS_SWAPPED.getMessage()); + stringFormatter.displaySuccessMessage(commandSender, MiniGameMessage.SUCCESS_ARENAS_SWAPPED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/dropper/EditDropperArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/dropper/EditDropperArenaCommand.java index 7152f30..0172cda 100644 --- a/src/main/java/net/knarcraft/minigames/command/dropper/EditDropperArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/dropper/EditDropperArenaCommand.java @@ -1,11 +1,11 @@ package net.knarcraft.minigames.command.dropper; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.dropper.DropperArena; import net.knarcraft.minigames.arena.dropper.DropperArenaEditableProperty; import net.knarcraft.minigames.config.DropperConfiguration; -import net.knarcraft.minigames.config.Message; -import net.knarcraft.minigames.container.PlaceholderContainer; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.Location; import org.bukkit.Material; import org.bukkit.command.Command; @@ -33,8 +33,9 @@ public class EditDropperArenaCommand implements CommandExecutor { @Override public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] arguments) { + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); if (!(commandSender instanceof Player player)) { - commandSender.sendMessage(Message.ERROR_PLAYER_ONLY.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_PLAYER_ONLY); return false; } @@ -44,29 +45,31 @@ public class EditDropperArenaCommand implements CommandExecutor { DropperArena specifiedArena = MiniGames.getInstance().getDropperArenaHandler().getArena(arguments[0]); if (specifiedArena == null) { - commandSender.sendMessage(Message.ERROR_ARENA_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_NOT_FOUND); return false; } DropperArenaEditableProperty editableProperty = DropperArenaEditableProperty.getFromArgumentString(arguments[1]); if (editableProperty == null) { - commandSender.sendMessage(Message.ERROR_UNKNOWN_PROPERTY.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_UNKNOWN_PROPERTY); return false; } if (arguments.length < 3) { // Print the current value of the property String value = editableProperty.getCurrentValueAsString(specifiedArena); - commandSender.sendMessage(Message.SUCCESS_CURRENT_VALUE.getMessage(new PlaceholderContainer().add( - "{property}", editableProperty.getArgumentString()).add("{value}", value))); + stringFormatter.displaySuccessMessage(commandSender, stringFormatter.replacePlaceholders( + MiniGameMessage.SUCCESS_CURRENT_VALUE, new String[]{"{property}", "{value}"}, + new String[]{editableProperty.getArgumentString(), value})); return true; } else { boolean successful = changeValue(specifiedArena, editableProperty, arguments[2], player); if (successful) { - player.sendMessage(Message.SUCCESS_PROPERTY_CHANGED.getMessage("{property}", + stringFormatter.displaySuccessMessage(player, stringFormatter.replacePlaceholder( + MiniGameMessage.SUCCESS_PROPERTY_CHANGED, "{property}", editableProperty.getArgumentString())); } else { - player.sendMessage(Message.ERROR_PROPERTY_INPUT_INVALID.getMessage()); + stringFormatter.displayErrorMessage(player, MiniGameMessage.ERROR_PROPERTY_INPUT_INVALID); } return successful; } diff --git a/src/main/java/net/knarcraft/minigames/command/dropper/JoinDropperArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/dropper/JoinDropperArenaCommand.java index a5c4b6e..11c7fe9 100644 --- a/src/main/java/net/knarcraft/minigames/command/dropper/JoinDropperArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/dropper/JoinDropperArenaCommand.java @@ -1,5 +1,6 @@ package net.knarcraft.minigames.command.dropper; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.ArenaPlayerRegistry; import net.knarcraft.minigames.arena.dropper.DropperArena; @@ -7,7 +8,8 @@ import net.knarcraft.minigames.arena.dropper.DropperArenaGameMode; import net.knarcraft.minigames.arena.dropper.DropperArenaGroup; import net.knarcraft.minigames.arena.dropper.DropperArenaSession; import net.knarcraft.minigames.config.DropperConfiguration; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; +import net.knarcraft.minigames.util.GUIHelper; import net.knarcraft.minigames.util.PlayerTeleporter; import org.bukkit.command.Command; import org.bukkit.command.CommandExecutor; @@ -23,8 +25,9 @@ public class JoinDropperArenaCommand implements CommandExecutor { @Override public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] arguments) { + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); if (!(commandSender instanceof Player player)) { - commandSender.sendMessage(Message.ERROR_PLAYER_ONLY.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_PLAYER_ONLY); return false; } @@ -34,20 +37,20 @@ public class JoinDropperArenaCommand implements CommandExecutor { // Disallow joining if the player is already in a mini-game arena if (MiniGames.getInstance().getSession(player.getUniqueId()) != null) { - commandSender.sendMessage(Message.ERROR_ALREADY_PLAYING.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ALREADY_PLAYING); return false; } // Make sure the arena exists DropperArena specifiedArena = MiniGames.getInstance().getDropperArenaHandler().getArena(arguments[0]); if (specifiedArena == null) { - commandSender.sendMessage(Message.ERROR_ARENA_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_NOT_FOUND); return false; } // Deny vehicles as allowing this is tricky, and will cause problems in some cases if (player.isInsideVehicle() || !player.getPassengers().isEmpty()) { - commandSender.sendMessage(Message.ERROR_JOIN_IN_VEHICLE_OR_PASSENGER.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_JOIN_IN_VEHICLE_OR_PASSENGER); return false; } @@ -77,11 +80,13 @@ public class JoinDropperArenaCommand implements CommandExecutor { return false; } + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); + // Make sure the player has beaten the arena once in normal mode before playing another mode if (MiniGames.getInstance().getDropperConfiguration().mustDoNormalModeFirst() && gameMode != DropperArenaGameMode.DEFAULT && specifiedArena.getData().hasNotCompleted(DropperArenaGameMode.DEFAULT, player)) { - player.sendMessage(Message.ERROR_NORMAL_MODE_REQUIRED.getMessage()); + stringFormatter.displayErrorMessage(player, MiniGameMessage.ERROR_NORMAL_MODE_REQUIRED); return false; } @@ -90,16 +95,21 @@ public class JoinDropperArenaCommand implements CommandExecutor { ArenaPlayerRegistry playerRegistry = MiniGames.getInstance().getDropperArenaPlayerRegistry(); playerRegistry.registerPlayer(player.getUniqueId(), newSession); + // Update visibility and hit-box for the player + MiniGames.getInstance().getPlayerVisibilityManager().updateHiddenPlayers(playerRegistry, player); + // Try to teleport the player to the arena boolean teleported = PlayerTeleporter.teleportPlayer(player, specifiedArena.getSpawnLocation(), false, false); if (!teleported) { - player.sendMessage(Message.ERROR_ARENA_TELEPORT_FAILED.getMessage()); - newSession.triggerQuit(false); + stringFormatter.displayErrorMessage(player, MiniGameMessage.ERROR_ARENA_TELEPORT_FAILED); + newSession.triggerQuit(false, true); return false; } else { - // Make sure to update the state again in the air to remove a potential swimming state + // Update the player's state to follow the arena's rules newSession.getEntryState().setArenaState(); - player.sendMessage(Message.SUCCESS_ARENA_JOINED.getMessage()); + + player.getInventory().addItem(GUIHelper.getGUIOpenItem()); + stringFormatter.displaySuccessMessage(player, MiniGameMessage.SUCCESS_ARENA_JOINED); return true; } } @@ -115,18 +125,19 @@ public class JoinDropperArenaCommand implements CommandExecutor { */ private boolean doGroupChecks(@NotNull DropperArena dropperArena, @NotNull DropperArenaGroup arenaGroup, @NotNull DropperArenaGameMode arenaGameMode, @NotNull Player player) { + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); DropperConfiguration configuration = MiniGames.getInstance().getDropperConfiguration(); // Require that players beat all arenas in the group in the normal game-mode before trying challenge modes if (configuration.mustDoNormalModeFirst() && arenaGameMode != DropperArenaGameMode.DEFAULT && !arenaGroup.hasBeatenAll(DropperArenaGameMode.DEFAULT, player)) { - player.sendMessage(Message.ERROR_GROUP_NORMAL_MODE_REQUIRED.getMessage()); + stringFormatter.displayErrorMessage(player, MiniGameMessage.ERROR_GROUP_NORMAL_MODE_REQUIRED); return false; } // Require that the player has beaten the previous arena on the same game-mode before trying this one if (configuration.mustDoGroupedInSequence() && arenaGroup.cannotPlay(arenaGameMode, player, dropperArena.getArenaId())) { - player.sendMessage(Message.ERROR_PREVIOUS_ARENA_REQUIRED.getMessage()); + stringFormatter.displayErrorMessage(player, MiniGameMessage.ERROR_PREVIOUS_ARENA_REQUIRED); return false; } diff --git a/src/main/java/net/knarcraft/minigames/command/dropper/ListDropperArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/dropper/ListDropperArenaCommand.java index 36f6f52..142c014 100644 --- a/src/main/java/net/knarcraft/minigames/command/dropper/ListDropperArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/dropper/ListDropperArenaCommand.java @@ -1,6 +1,7 @@ package net.knarcraft.minigames.command.dropper; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.MiniGames; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.util.TabCompleteHelper; import org.bukkit.command.Command; import org.bukkit.command.CommandSender; @@ -19,11 +20,12 @@ public class ListDropperArenaCommand implements TabExecutor { @Override public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] arguments) { - StringBuilder builder = new StringBuilder(Message.SUCCESS_DROPPER_ARENAS_LIST.getMessage()); + StringBuilder builder = new StringBuilder(MiniGames.getInstance().getTranslator().getTranslatedMessage( + MiniGameMessage.SUCCESS_DROPPER_ARENAS_LIST)); for (String arenaName : TabCompleteHelper.getDropperArenas()) { builder.append("\n").append(arenaName); } - sender.sendMessage(builder.toString()); + MiniGames.getInstance().getStringFormatter().displaySuccessMessage(sender, builder.toString()); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/dropper/RemoveDropperArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/dropper/RemoveDropperArenaCommand.java index 0d3be62..8d17155 100644 --- a/src/main/java/net/knarcraft/minigames/command/dropper/RemoveDropperArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/dropper/RemoveDropperArenaCommand.java @@ -1,8 +1,9 @@ package net.knarcraft.minigames.command.dropper; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.dropper.DropperArena; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.command.Command; import org.bukkit.command.CommandExecutor; import org.bukkit.command.CommandSender; @@ -21,16 +22,18 @@ public class RemoveDropperArenaCommand implements CommandExecutor { return false; } + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); + // Get the specified arena DropperArena targetArena = MiniGames.getInstance().getDropperArenaHandler().getArena(arguments[0]); if (targetArena == null) { - commandSender.sendMessage(Message.ERROR_ARENA_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_NOT_FOUND); return false; } // Remove the arena MiniGames.getInstance().getDropperArenaHandler().removeArena(targetArena); - commandSender.sendMessage(Message.SUCCESS_ARENA_REMOVED.getMessage()); + stringFormatter.displaySuccessMessage(commandSender, MiniGameMessage.SUCCESS_ARENA_REMOVED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/parkour/CreateParkourArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/parkour/CreateParkourArenaCommand.java index 08be9ad..822dba6 100644 --- a/src/main/java/net/knarcraft/minigames/command/parkour/CreateParkourArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/parkour/CreateParkourArenaCommand.java @@ -1,9 +1,10 @@ package net.knarcraft.minigames.command.parkour; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.parkour.ParkourArena; import net.knarcraft.minigames.arena.parkour.ParkourArenaHandler; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.util.StringSanitizer; import org.bukkit.command.Command; import org.bukkit.command.CommandExecutor; @@ -19,8 +20,9 @@ public class CreateParkourArenaCommand implements CommandExecutor { @Override public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] arguments) { + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); if (!(commandSender instanceof Player player)) { - commandSender.sendMessage(Message.ERROR_PLAYER_ONLY.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_PLAYER_ONLY); return false; } @@ -41,13 +43,13 @@ public class CreateParkourArenaCommand implements CommandExecutor { ParkourArena existingArena = arenaHandler.getArena(arenaName); if (existingArena != null) { - commandSender.sendMessage(Message.ERROR_ARENA_NAME_COLLISION.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_NAME_COLLISION); return false; } ParkourArena arena = new ParkourArena(arenaName, player.getLocation(), arenaHandler); arenaHandler.addArena(arena); - commandSender.sendMessage(Message.SUCCESS_ARENA_CREATED.getMessage()); + stringFormatter.displaySuccessMessage(commandSender, MiniGameMessage.SUCCESS_ARENA_CREATED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/parkour/EditParkourArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/parkour/EditParkourArenaCommand.java index 8eb128e..2b28184 100644 --- a/src/main/java/net/knarcraft/minigames/command/parkour/EditParkourArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/parkour/EditParkourArenaCommand.java @@ -1,10 +1,10 @@ package net.knarcraft.minigames.command.parkour; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.parkour.ParkourArena; import net.knarcraft.minigames.arena.parkour.ParkourArenaEditableProperty; -import net.knarcraft.minigames.config.Message; -import net.knarcraft.minigames.container.PlaceholderContainer; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.Location; import org.bukkit.Material; import org.bukkit.command.Command; @@ -30,8 +30,9 @@ public class EditParkourArenaCommand implements CommandExecutor { @Override public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] arguments) { + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); if (!(commandSender instanceof Player player)) { - commandSender.sendMessage(Message.ERROR_PLAYER_ONLY.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_PLAYER_ONLY); return false; } @@ -41,29 +42,31 @@ public class EditParkourArenaCommand implements CommandExecutor { ParkourArena specifiedArena = MiniGames.getInstance().getParkourArenaHandler().getArena(arguments[0]); if (specifiedArena == null) { - commandSender.sendMessage(Message.ERROR_ARENA_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_NOT_FOUND); return false; } ParkourArenaEditableProperty editableProperty = ParkourArenaEditableProperty.getFromArgumentString(arguments[1]); if (editableProperty == null) { - commandSender.sendMessage(Message.ERROR_UNKNOWN_PROPERTY.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_UNKNOWN_PROPERTY); return false; } if (arguments.length < 3) { // Print the current value of the property String value = editableProperty.getCurrentValueAsString(specifiedArena); - commandSender.sendMessage(Message.SUCCESS_CURRENT_VALUE.getMessage(new PlaceholderContainer().add( - "{property}", editableProperty.getArgumentString()).add("{value}", value))); + stringFormatter.displaySuccessMessage(commandSender, stringFormatter.replacePlaceholders( + MiniGameMessage.SUCCESS_CURRENT_VALUE, new String[]{"{property}", "{value}"}, + new String[]{editableProperty.getArgumentString(), value})); return true; } else { boolean successful = changeValue(specifiedArena, editableProperty, arguments[2], player); if (successful) { - player.sendMessage(Message.SUCCESS_PROPERTY_CHANGED.getMessage("{property}", + stringFormatter.displaySuccessMessage(player, stringFormatter.replacePlaceholder( + MiniGameMessage.SUCCESS_PROPERTY_CHANGED, "{property}", editableProperty.getArgumentString())); } else { - player.sendMessage(Message.ERROR_PROPERTY_INPUT_INVALID.getMessage()); + stringFormatter.displayErrorMessage(player, MiniGameMessage.ERROR_PROPERTY_INPUT_INVALID); } return successful; } diff --git a/src/main/java/net/knarcraft/minigames/command/parkour/JoinParkourArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/parkour/JoinParkourArenaCommand.java index 0ae8189..2f931bd 100644 --- a/src/main/java/net/knarcraft/minigames/command/parkour/JoinParkourArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/parkour/JoinParkourArenaCommand.java @@ -1,13 +1,15 @@ package net.knarcraft.minigames.command.parkour; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.ArenaPlayerRegistry; import net.knarcraft.minigames.arena.parkour.ParkourArena; import net.knarcraft.minigames.arena.parkour.ParkourArenaGameMode; import net.knarcraft.minigames.arena.parkour.ParkourArenaGroup; import net.knarcraft.minigames.arena.parkour.ParkourArenaSession; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.config.ParkourConfiguration; +import net.knarcraft.minigames.util.GUIHelper; import net.knarcraft.minigames.util.PlayerTeleporter; import org.bukkit.command.Command; import org.bukkit.command.CommandExecutor; @@ -23,8 +25,9 @@ public class JoinParkourArenaCommand implements CommandExecutor { @Override public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] arguments) { + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); if (!(commandSender instanceof Player player)) { - commandSender.sendMessage(Message.ERROR_PLAYER_ONLY.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_PLAYER_ONLY); return false; } @@ -34,20 +37,20 @@ public class JoinParkourArenaCommand implements CommandExecutor { // Disallow joining if the player is already in a mini-game arena if (MiniGames.getInstance().getSession(player.getUniqueId()) != null) { - commandSender.sendMessage(Message.ERROR_ALREADY_PLAYING.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ALREADY_PLAYING); return false; } // Make sure the arena exists ParkourArena specifiedArena = MiniGames.getInstance().getParkourArenaHandler().getArena(arguments[0]); if (specifiedArena == null) { - commandSender.sendMessage(Message.ERROR_ARENA_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_NOT_FOUND); return false; } // Deny vehicles as allowing this is tricky, and will cause problems in some cases if (player.isInsideVehicle() || !player.getPassengers().isEmpty()) { - commandSender.sendMessage(Message.ERROR_JOIN_IN_VEHICLE_OR_PASSENGER.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_JOIN_IN_VEHICLE_OR_PASSENGER); return false; } @@ -73,7 +76,8 @@ public class JoinParkourArenaCommand implements CommandExecutor { // Don't allow joining the hardcore game-mode if there are no checkpoints to skip if (specifiedArena.hasNoCheckpoints() && gameMode == ParkourArenaGameMode.HARDCORE) { - player.sendMessage(Message.ERROR_HARDCORE_NO_CHECKPOINTS.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(player, + MiniGameMessage.ERROR_HARDCORE_NO_CHECKPOINTS); return false; } @@ -88,16 +92,23 @@ public class JoinParkourArenaCommand implements CommandExecutor { ArenaPlayerRegistry playerRegistry = MiniGames.getInstance().getParkourArenaPlayerRegistry(); playerRegistry.registerPlayer(player.getUniqueId(), newSession); + // Update visibility and hit-box for the player + MiniGames.getInstance().getPlayerVisibilityManager().updateHiddenPlayers(playerRegistry, player); + // Try to teleport the player to the arena boolean teleported = PlayerTeleporter.teleportPlayer(player, specifiedArena.getSpawnLocation(), false, false); if (!teleported) { - player.sendMessage(Message.ERROR_ARENA_TELEPORT_FAILED.getMessage()); - newSession.triggerQuit(false); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(player, + MiniGameMessage.ERROR_ARENA_TELEPORT_FAILED); + newSession.triggerQuit(false, true); return false; } else { - // Make sure to update the state again in the air to remove a potential swimming state + // Update the player's state to follow the arena's rules newSession.getEntryState().setArenaState(); - player.sendMessage(Message.SUCCESS_ARENA_JOINED.getMessage()); + + player.getInventory().addItem(GUIHelper.getGUIOpenItem()); + MiniGames.getInstance().getStringFormatter().displaySuccessMessage(player, + MiniGameMessage.SUCCESS_ARENA_JOINED); return true; } } @@ -118,7 +129,8 @@ public class JoinParkourArenaCommand implements CommandExecutor { // Require that the player has beaten the previous arena on the same game-mode before trying this one if (configuration.mustDoGroupedInSequence() && arenaGroup.cannotPlay(arenaGameMode, player, parkourArena.getArenaId())) { - player.sendMessage(Message.ERROR_PREVIOUS_ARENA_REQUIRED.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(player, + MiniGameMessage.ERROR_PREVIOUS_ARENA_REQUIRED); return false; } diff --git a/src/main/java/net/knarcraft/minigames/command/parkour/ListParkourArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/parkour/ListParkourArenaCommand.java index 884f9b3..9a0f732 100644 --- a/src/main/java/net/knarcraft/minigames/command/parkour/ListParkourArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/parkour/ListParkourArenaCommand.java @@ -1,6 +1,7 @@ package net.knarcraft.minigames.command.parkour; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.MiniGames; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.util.TabCompleteHelper; import org.bukkit.command.Command; import org.bukkit.command.CommandSender; @@ -19,11 +20,12 @@ public class ListParkourArenaCommand implements TabExecutor { @Override public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] arguments) { - StringBuilder builder = new StringBuilder(Message.SUCCESS_PARKOUR_ARENAS_LIST.getMessage()); + StringBuilder builder = new StringBuilder(MiniGames.getInstance().getTranslator().getTranslatedMessage( + MiniGameMessage.SUCCESS_PARKOUR_ARENAS_LIST)); for (String arenaName : TabCompleteHelper.getParkourArenas()) { builder.append("\n").append(arenaName); } - sender.sendMessage(builder.toString()); + MiniGames.getInstance().getStringFormatter().displaySuccessMessage(sender, builder.toString()); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupListCommand.java b/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupListCommand.java index 8e69d65..915a861 100644 --- a/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupListCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupListCommand.java @@ -1,10 +1,11 @@ package net.knarcraft.minigames.command.parkour; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.parkour.ParkourArena; import net.knarcraft.minigames.arena.parkour.ParkourArenaGroup; import net.knarcraft.minigames.arena.parkour.ParkourArenaHandler; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.command.Command; import org.bukkit.command.CommandSender; import org.bukkit.command.TabExecutor; @@ -60,14 +61,16 @@ public class ParkourGroupListCommand implements TabExecutor { */ private boolean displayOrderedArenaNames(@NotNull ParkourArenaHandler arenaHandler, @NotNull CommandSender sender, @NotNull String groupName) { + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); ParkourArenaGroup arenaGroup = arenaHandler.getGroup(groupName); if (arenaGroup == null) { - sender.sendMessage(Message.ERROR_GROUP_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(sender, MiniGameMessage.ERROR_GROUP_NOT_FOUND); return false; } // Send a list of all stages (arenas in the group) - StringBuilder builder = new StringBuilder(Message.SUCCESS_GROUP_STAGES.getMessage("{group}", groupName)); + StringBuilder builder = new StringBuilder(stringFormatter.replacePlaceholder( + MiniGameMessage.SUCCESS_GROUP_STAGES, "{group}", groupName)); int counter = 1; for (UUID arenaId : arenaGroup.getArenas()) { ParkourArena arena = arenaHandler.getArena(arenaId); @@ -75,7 +78,7 @@ public class ParkourGroupListCommand implements TabExecutor { builder.append("\n").append(counter++).append(". ").append(arena.getArenaName()); } } - sender.sendMessage(builder.toString()); + stringFormatter.displaySuccessMessage(sender, builder.toString()); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupSetCommand.java b/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupSetCommand.java index 7a60fae..e97081e 100644 --- a/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupSetCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupSetCommand.java @@ -1,10 +1,11 @@ package net.knarcraft.minigames.command.parkour; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.parkour.ParkourArena; import net.knarcraft.minigames.arena.parkour.ParkourArenaGroup; import net.knarcraft.minigames.arena.parkour.ParkourArenaHandler; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.util.StringSanitizer; import net.knarcraft.minigames.util.TabCompleteHelper; import org.bukkit.command.Command; @@ -30,11 +31,12 @@ public class ParkourGroupSetCommand implements TabExecutor { return false; } + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); ParkourArenaHandler arenaHandler = MiniGames.getInstance().getParkourArenaHandler(); ParkourArena specifiedArena = arenaHandler.getArena(arguments[0]); if (specifiedArena == null) { - commandSender.sendMessage(Message.ERROR_ARENA_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_NOT_FOUND); return false; } @@ -56,7 +58,7 @@ public class ParkourGroupSetCommand implements TabExecutor { arenaHandler.setGroup(specifiedArena.getArenaId(), arenaGroup); - commandSender.sendMessage(Message.SUCCESS_ARENA_GROUP_UPDATED.getMessage()); + stringFormatter.displaySuccessMessage(commandSender, MiniGameMessage.SUCCESS_ARENA_GROUP_UPDATED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupSwapCommand.java b/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupSwapCommand.java index a0c9784..f272017 100644 --- a/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupSwapCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/parkour/ParkourGroupSwapCommand.java @@ -1,10 +1,11 @@ package net.knarcraft.minigames.command.parkour; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.parkour.ParkourArena; import net.knarcraft.minigames.arena.parkour.ParkourArenaGroup; import net.knarcraft.minigames.arena.parkour.ParkourArenaHandler; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.command.Command; import org.bukkit.command.CommandSender; import org.bukkit.command.TabExecutor; @@ -30,29 +31,30 @@ public class ParkourGroupSwapCommand implements TabExecutor { } ParkourArenaHandler arenaHandler = MiniGames.getInstance().getParkourArenaHandler(); + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); ParkourArena arena1 = arenaHandler.getArena(arguments[0]); if (arena1 == null) { - commandSender.sendMessage(Message.ERROR_ARENA_1_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_1_NOT_FOUND); return false; } ParkourArena arena2 = arenaHandler.getArena(arguments[1]); if (arena2 == null) { - commandSender.sendMessage(Message.ERROR_ARENA_2_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_2_NOT_FOUND); return false; } ParkourArenaGroup arena1Group = arenaHandler.getGroup(arena1.getArenaId()); ParkourArenaGroup arena2Group = arenaHandler.getGroup(arena2.getArenaId()); if (arena1Group == null || !arena1Group.equals(arena2Group)) { - commandSender.sendMessage(Message.ERROR_SWAP_DIFFERENT_GROUPS.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_SWAP_DIFFERENT_GROUPS); return false; } arena1Group.swapArenas(arena1Group.getArenas().indexOf(arena1.getArenaId()), arena1Group.getArenas().indexOf(arena2.getArenaId())); - commandSender.sendMessage(Message.SUCCESS_ARENAS_SWAPPED.getMessage()); + stringFormatter.displaySuccessMessage(commandSender, MiniGameMessage.SUCCESS_ARENAS_SWAPPED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/command/parkour/RemoveParkourArenaCommand.java b/src/main/java/net/knarcraft/minigames/command/parkour/RemoveParkourArenaCommand.java index dc4ee3e..4d37ac7 100644 --- a/src/main/java/net/knarcraft/minigames/command/parkour/RemoveParkourArenaCommand.java +++ b/src/main/java/net/knarcraft/minigames/command/parkour/RemoveParkourArenaCommand.java @@ -1,8 +1,9 @@ package net.knarcraft.minigames.command.parkour; +import net.knarcraft.knarlib.formatting.StringFormatter; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.parkour.ParkourArena; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.command.Command; import org.bukkit.command.CommandExecutor; import org.bukkit.command.CommandSender; @@ -21,16 +22,18 @@ public class RemoveParkourArenaCommand implements CommandExecutor { return false; } + StringFormatter stringFormatter = MiniGames.getInstance().getStringFormatter(); + // Get the specified arena ParkourArena targetArena = MiniGames.getInstance().getParkourArenaHandler().getArena(arguments[0]); if (targetArena == null) { - commandSender.sendMessage(Message.ERROR_ARENA_NOT_FOUND.getMessage()); + stringFormatter.displayErrorMessage(commandSender, MiniGameMessage.ERROR_ARENA_NOT_FOUND); return false; } // Remove the arena MiniGames.getInstance().getParkourArenaHandler().removeArena(targetArena); - commandSender.sendMessage(Message.SUCCESS_ARENA_REMOVED.getMessage()); + stringFormatter.displaySuccessMessage(commandSender, MiniGameMessage.SUCCESS_ARENA_REMOVED); return true; } diff --git a/src/main/java/net/knarcraft/minigames/config/DropperConfiguration.java b/src/main/java/net/knarcraft/minigames/config/DropperConfiguration.java index d1d36ec..a238aec 100644 --- a/src/main/java/net/knarcraft/minigames/config/DropperConfiguration.java +++ b/src/main/java/net/knarcraft/minigames/config/DropperConfiguration.java @@ -19,8 +19,6 @@ public class DropperConfiguration extends MiniGameConfiguration { private boolean mustDoGroupedInSequence; private boolean ignoreRecordsUntilGroupBeatenOnce; private boolean mustDoNormalModeFirst; - private boolean makePlayersInvisible; - private boolean disableHitCollision; private boolean blockSneaking; private boolean blockSprinting; private Set blockWhitelist; @@ -97,24 +95,6 @@ public class DropperConfiguration extends MiniGameConfiguration { return this.ignoreRecordsUntilGroupBeatenOnce; } - /** - * Gets whether players should be made invisible while in an arena - * - * @return

Whether players should be made invisible

- */ - public boolean makePlayersInvisible() { - return this.makePlayersInvisible; - } - - /** - * Gets whether entity hit-collision of players in an arena should be disabled - * - * @return

Whether to disable hit collision

- */ - public boolean disableHitCollision() { - return this.disableHitCollision; - } - /** * Gets whether players trying to sneak while in a dropper arena to increase their downwards speed should be blocked * @@ -141,8 +121,6 @@ public class DropperConfiguration extends MiniGameConfiguration { this.mustDoGroupedInSequence = configuration.getBoolean(rootNode + "mustDoGroupedInSequence", true); this.ignoreRecordsUntilGroupBeatenOnce = configuration.getBoolean(rootNode + "ignoreRecordsUntilGroupBeatenOnce", false); this.mustDoNormalModeFirst = configuration.getBoolean(rootNode + "mustDoNormalModeFirst", true); - this.makePlayersInvisible = configuration.getBoolean(rootNode + "makePlayersInvisible", false); - this.disableHitCollision = configuration.getBoolean(rootNode + "disableHitCollision", true); this.blockSprinting = configuration.getBoolean(rootNode + "blockSprinting", true); this.blockSneaking = configuration.getBoolean(rootNode + "blockSneaking", true); this.blockWhitelist = loadMaterialList(rootNode + "blockWhitelist"); @@ -176,8 +154,6 @@ public class DropperConfiguration extends MiniGameConfiguration { "\n" + "Must do groups in sequence: " + mustDoGroupedInSequence + "\n" + "Ignore records until group beaten once: " + ignoreRecordsUntilGroupBeatenOnce + "\n" + "Must do normal mode first: " + mustDoNormalModeFirst + - "\n" + "Make players invisible: " + makePlayersInvisible + - "\n" + "Disable hit collision: " + disableHitCollision + "\n" + "Block whitelist: "); for (Material material : blockWhitelist) { builder.append("\n - ").append(material.name()); diff --git a/src/main/java/net/knarcraft/minigames/config/Message.java b/src/main/java/net/knarcraft/minigames/config/Message.java deleted file mode 100644 index 70aa79d..0000000 --- a/src/main/java/net/knarcraft/minigames/config/Message.java +++ /dev/null @@ -1,330 +0,0 @@ -package net.knarcraft.minigames.config; - -import net.knarcraft.minigames.MiniGames; -import net.knarcraft.minigames.container.PlaceholderContainer; -import net.knarcraft.minigames.util.ColorHelper; -import org.jetbrains.annotations.NotNull; - -import java.util.Map; - -/** - * A message which ca be displayed to the user - */ -public enum Message { - - /* ************** * - * Error messages * - * ************** */ - - /** - * The message displayed if saving arena groups fails - */ - ERROR_CANNOT_SAVE_ARENA_GROUPS("&cUnable to save current arena groups! Data loss can occur!"), - - /** - * The message displayed if an un-parse-able message is given by a user - */ - ERROR_MATERIAL_NOT_PARSE_ABLE("&cUnable to parse material: {material}"), - - /** - * The message displayed if a player tries to be teleported to/from an arena with a passenger - */ - ERROR_TELEPORT_WITH_PASSENGER("&cYou cannot be teleported with a passenger!"), - - /** - * The message displayed if a player tries to be teleported to/from an arena with a vehicle - */ - ERROR_TELEPORT_IN_VEHICLE("&cYou cannot be teleported while in a vehicle"), - - /** - * The message displayed if an arena cannot be loaded - */ - ERROR_ARENA_NOT_LOADED("&cCould not load the arena at configuration section {section}. Please check " + - "the {file} storage file for issues."), - - /** - * The message displayed if an arena's data cannot be loaded - */ - ERROR_ARENA_DATA_NOT_LOADED("&cUnable to load arena data for dropper arena: {arena}"), - - /** - * The message displayed if the user specifies an unrecognized arena - */ - ERROR_ARENA_NOT_FOUND("&cUnable to find the specified arena."), - - /** - * The message displayed if the user specifies an unrecognized group - */ - ERROR_GROUP_NOT_FOUND("&cUnable to find the specified group!"), - - /** - * The message displayed if the console tries to execute a player-only command - */ - ERROR_PLAYER_ONLY("&cThis command must be used by a player"), - - /** - * The message displayed if the name of an arena is duplicated - */ - ERROR_ARENA_NAME_COLLISION("&cThere already exists an arena with that name!"), - - /** - * The message displayed if the player is required to win on the default difficulty first - */ - ERROR_NORMAL_MODE_REQUIRED("&cYou must complete this arena in normal mode first!"), - - /** - * The message displayed if the player is required to win on the default difficulty for all arenas in the group first - */ - ERROR_GROUP_NORMAL_MODE_REQUIRED("&cYou have not yet beaten the default game-mode for all arenas in this group!"), - - /** - * The message displayed if the player is required to beat the previous arena in the group - */ - ERROR_PREVIOUS_ARENA_REQUIRED("&cYou have not yet beaten the previous arena!"), - - /** - * The message displayed if player teleportation failed for some reason - */ - ERROR_ARENA_TELEPORT_FAILED("&cUnable to teleport you to the arena."), - - /** - * The message displayed if the player tries to quit the arena while not in an arena - */ - ERROR_NOT_IN_ARENA("&cYou are not in a mini-games arena!"), - - /** - * The message displayed if the player tries to join an arena while already playing - * - *

This should in theory be impossible, as players cannot use any commands except /miniGamesLeave while playing - * in an arena.

- */ - ERROR_ALREADY_PLAYING("&cYou are already playing a mini-game!"), - - /** - * The message displayed if a player tries to join an arena with a passenger or riding a vehicle - */ - ERROR_JOIN_IN_VEHICLE_OR_PASSENGER("&cYou cannot join an arena while inside a vehicle or carrying a passenger."), - - /** - * The message displayed if the player tries to change an unrecognized arena property - */ - ERROR_UNKNOWN_PROPERTY("&cUnknown property specified."), - - /** - * The message displayed if the given input to /dEdit or /pEdit's value is invalid - */ - ERROR_PROPERTY_INPUT_INVALID("&cUnable to change the property. Make sure your input is valid!"), - - /** - * The message displayed if the first arena specified in /dgSwap or /pgSwap is invalid - */ - ERROR_ARENA_1_NOT_FOUND("&cUnable to find the first specified arena."), - - /** - * The message displayed if the second arena specified in /dgSwap or /pgSwap is invalid - */ - ERROR_ARENA_2_NOT_FOUND("&cUnable to find the second specified dropper arena."), - - /** - * The message displayed if the two groups specified for /dgSwap or /pgSwap are in different arenas - */ - ERROR_SWAP_DIFFERENT_GROUPS("&cYou cannot swap arenas in different groups!"), - - /** - * The message displayed if a player tries to use any command other than /mLeave while in an arena - */ - ERROR_ILLEGAL_COMMAND("&cYou cannot use that command while in an arena!"), - - /** - * The message displayed if the player is trying to join a parkour arena on hardcore which has no checkpoints - */ - ERROR_HARDCORE_NO_CHECKPOINTS("&cThis arena cannot be played in hardcore mode as it has no checkpoints!"), - - /* **************** * - * Success messages * - * **************** */ - - /** - * The message displayed if an arena's group has been changed - */ - SUCCESS_ARENA_GROUP_UPDATED("&aThe arena's group has been updated"), - - /** - * The message displayed if the MiniGames plugin is reloaded - */ - SUCCESS_PLUGIN_RELOADED("&aPlugin reloaded!"), - - /** - * The message displayed if a new arena has been created - */ - SUCCESS_ARENA_CREATED("&aThe arena was successfully created!"), - - /** - * The message displayed if a player clears/wins an arena for the first time - */ - SUCCESS_ARENA_FIRST_CLEAR("&aYou cleared the arena!"), - - /** - * The message displayed when a player wins an arena - */ - SUCCESS_ARENA_WIN("&aYou won!"), - - /** - * The message displayed when a player quits an arena - */ - SUCCESS_ARENA_QUIT("&aYou quit the arena!"), - - /** - * The message used to display the current value of an arena property - */ - SUCCESS_CURRENT_VALUE("&aCurrent value of {property} is: {value}"), - - /** - * The message used to announce that an arena property has been changed - */ - SUCCESS_PROPERTY_CHANGED("&aProperty {property} successfully changed"), - - /** - * The message displayed when two arenas' order in a group have been swapped - */ - SUCCESS_ARENAS_SWAPPED("&aThe arenas have been swapped!"), - - /** - * The message displayed when an arena has been removed - */ - SUCCESS_ARENA_REMOVED("&aThe specified arena has been successfully removed"), - - /** - * The header displayed before listing all dropper arenas - */ - SUCCESS_DROPPER_ARENAS_LIST("&aDropper arenas:&r"), - - /** - * The header displayed before listing all parkour arenas - */ - SUCCESS_PARKOUR_ARENAS_LIST("&aParkour arenas:&r"), - - /** - * The message displayed when a player reaches a new checkpoint in a parkour arena - */ - SUCCESS_CHECKPOINT_REACHED("&aCheckpoint reached!"), - - /** - * The header displayed before listing all arenas (stages) in a group - */ - SUCCESS_GROUP_STAGES("&a{group}'s stages:&r"), - - /** - * The message displayed when a new record has been achieved - */ - SUCCESS_RECORD_ACHIEVED("&aYou just set a {recordInfo} on the {gameMode} game-mode!"), - - /** - * The partial message used to describe that the player achieved a world record - */ - RECORD_ACHIEVED_GLOBAL("new {recordType} record"), - - /** - * The partial message used to describe that the player achieved a personal best record - */ - RECORD_ACHIEVED_PERSONAL("personal {recordType} record"), - - /** - * The message displayed when a player joins an arena - */ - SUCCESS_ARENA_JOINED("&aYou joined the arena."), - - /** - * The message displayed when a player is rewarded with an item - */ - SUCCESS_ITEM_REWARDED("&aYou have been rewarded {amount} {item}(s)"), - - /** - * The message displayed when a player is rewarded with a permission - */ - SUCCESS_PERMISSION_REWARDED("&aYou have been granted the permission: {permission}"), - - /** - * The message displayed when a player is rewarded with a permission, for a specific world - */ - SUCCESS_PERMISSION_REWARDED_WORLD("&aYou have been granted the permission: {permission} in world: {world}"), - - /** - * The message displayed when a player is rewarded by a command being run - */ - SUCCESS_COMMAND_REWARDED("&aThe command `{command}` has been run as your reward."), - - /** - * The message displayed when a player is rewarded with an amount of currency - */ - SUCCESS_ECONOMY_REWARDED("&aYou have been granted {currency}"), - ; - - private final @NotNull String defaultMessage; - - /** - * Instantiates a new message - * - * @param defaultMessage

The default value of the message

- */ - Message(@NotNull String defaultMessage) { - this.defaultMessage = defaultMessage; - } - - /** - * Gets the message this enum represents - * - * @return

The formatted message

- */ - public @NotNull String getMessage() { - return formatMessage(this.defaultMessage); - } - - /** - * Gets the message this enum represents - * - * @param placeholder

The placeholder to replace

- * @param replacement

The replacement to use

- * @return

The formatted message

- */ - public @NotNull String getMessage(@NotNull String placeholder, @NotNull String replacement) { - return formatMessage(this.defaultMessage.replace(placeholder, replacement)); - } - - /** - * Gets the message this enum represents, intended for display within another message - * - * @param placeholder

The placeholder to replace

- * @param replacement

The replacement to use

- * @return

The formatted message

- */ - public @NotNull String getPartialMessage(@NotNull String placeholder, @NotNull String replacement) { - return ColorHelper.translateAllColorCodes(this.defaultMessage.replace(placeholder, replacement)); - } - - /** - * Gets the message this enum represents - * - * @param placeholders

The placeholder -> replacement map specifying necessary replacements

- * @return

The formatted message

- */ - public @NotNull String getMessage(@NotNull PlaceholderContainer placeholders) { - String replaced = this.defaultMessage; - for (Map.Entry entry : placeholders.getPlaceholders().entrySet()) { - replaced = replaced.replace(entry.getKey(), entry.getValue()); - } - return formatMessage(replaced); - } - - /** - * Gets the formatted version of the given message - * - * @param message

The message to format

- * @return

The formatted message

- */ - private @NotNull String formatMessage(@NotNull String message) { - String prefix = MiniGames.getInstance().getDescription().getPrefix(); - return ColorHelper.translateAllColorCodes("#546EED[&r&l" + prefix + "#546EED]&r " + message); - } - -} diff --git a/src/main/java/net/knarcraft/minigames/config/MiniGameConfiguration.java b/src/main/java/net/knarcraft/minigames/config/MiniGameConfiguration.java index 6786308..d9ba06e 100644 --- a/src/main/java/net/knarcraft/minigames/config/MiniGameConfiguration.java +++ b/src/main/java/net/knarcraft/minigames/config/MiniGameConfiguration.java @@ -1,6 +1,7 @@ package net.knarcraft.minigames.config; -import net.knarcraft.minigames.util.MaterialHelper; +import net.knarcraft.knarlib.util.MaterialHelper; +import net.knarcraft.minigames.MiniGames; import org.bukkit.Material; import org.bukkit.configuration.file.FileConfiguration; import org.jetbrains.annotations.NotNull; @@ -46,7 +47,7 @@ public abstract class MiniGameConfiguration { */ public @NotNull Set loadMaterialList(@NotNull String path) { List blockWhitelist = configuration.getList(path, new ArrayList<>()); - return MaterialHelper.loadMaterialList(blockWhitelist); + return MaterialHelper.loadMaterialList(blockWhitelist, "+", MiniGames.getInstance().getLogger()); } } diff --git a/src/main/java/net/knarcraft/minigames/config/MiniGameMessage.java b/src/main/java/net/knarcraft/minigames/config/MiniGameMessage.java new file mode 100644 index 0000000..4fb9d62 --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/config/MiniGameMessage.java @@ -0,0 +1,238 @@ +package net.knarcraft.minigames.config; + +import net.knarcraft.knarlib.formatting.TranslatableMessage; +import org.jetbrains.annotations.NotNull; + +/** + * A message which ca be displayed to the user + */ +public enum MiniGameMessage implements TranslatableMessage { + + /* ************** * + * Error messages * + * ************** */ + + /** + * The message displayed if saving arena groups fails + */ + ERROR_CANNOT_SAVE_ARENA_GROUPS, + + /** + * The message displayed if an un-parse-able message is given by a user + */ + ERROR_MATERIAL_NOT_PARSE_ABLE, + + /** + * The message displayed if a player tries to be teleported to/from an arena with a passenger + */ + ERROR_TELEPORT_WITH_PASSENGER, + + /** + * The message displayed if a player tries to be teleported to/from an arena with a vehicle + */ + ERROR_TELEPORT_IN_VEHICLE, + + /** + * The message displayed if an arena cannot be loaded + */ + ERROR_ARENA_NOT_LOADED, + + /** + * The message displayed if an arena's data cannot be loaded + */ + ERROR_ARENA_DATA_NOT_LOADED, + + /** + * The message displayed if the user specifies an unrecognized arena + */ + ERROR_ARENA_NOT_FOUND, + + /** + * The message displayed if the user specifies an unrecognized group + */ + ERROR_GROUP_NOT_FOUND, + + /** + * The message displayed if the console tries to execute a player-only command + */ + ERROR_PLAYER_ONLY, + + /** + * The message displayed if the name of an arena is duplicated + */ + ERROR_ARENA_NAME_COLLISION, + + /** + * The message displayed if the player is required to win on the default difficulty first + */ + ERROR_NORMAL_MODE_REQUIRED, + + /** + * The message displayed if the player is required to win on the default difficulty for all arenas in the group first + */ + ERROR_GROUP_NORMAL_MODE_REQUIRED, + + /** + * The message displayed if the player is required to beat the previous arena in the group + */ + ERROR_PREVIOUS_ARENA_REQUIRED, + + /** + * The message displayed if player teleportation failed for some reason + */ + ERROR_ARENA_TELEPORT_FAILED, + + /** + * The message displayed if the player tries to quit the arena while not in an arena + */ + ERROR_NOT_IN_ARENA, + + /** + * The message displayed if the player tries to join an arena while already playing + * + *

This should in theory be impossible, as players cannot use any commands except /miniGamesLeave while playing + * in an arena.

+ */ + ERROR_ALREADY_PLAYING, + + /** + * The message displayed if a player tries to join an arena with a passenger or riding a vehicle + */ + ERROR_JOIN_IN_VEHICLE_OR_PASSENGER, + + /** + * The message displayed if the player tries to change an unrecognized arena property + */ + ERROR_UNKNOWN_PROPERTY, + + /** + * The message displayed if the given input to /dEdit or /pEdit's value is invalid + */ + ERROR_PROPERTY_INPUT_INVALID, + + /** + * The message displayed if the first arena specified in /dgSwap or /pgSwap is invalid + */ + ERROR_ARENA_1_NOT_FOUND, + + /** + * The message displayed if the second arena specified in /dgSwap or /pgSwap is invalid + */ + ERROR_ARENA_2_NOT_FOUND, + + /** + * The message displayed if the two groups specified for /dgSwap or /pgSwap are in different arenas + */ + ERROR_SWAP_DIFFERENT_GROUPS, + + /** + * The message displayed if a player tries to use any command other than /mLeave while in an arena + */ + ERROR_ILLEGAL_COMMAND, + + /** + * The message displayed if the player is trying to join a parkour arena on hardcore which has no checkpoints + */ + ERROR_HARDCORE_NO_CHECKPOINTS, + + /* **************** * + * Success messages * + * **************** */ + + /** + * The message displayed if an arena's group has been changed + */ + SUCCESS_ARENA_GROUP_UPDATED, + + /** + * The message displayed if the MiniGames plugin is reloaded + */ + SUCCESS_PLUGIN_RELOADED, + + /** + * The message displayed if a new arena has been created + */ + SUCCESS_ARENA_CREATED, + + /** + * The message displayed if a player clears/wins an arena for the first time + */ + SUCCESS_ARENA_FIRST_CLEAR, + + /** + * The message displayed when a player wins an arena + */ + SUCCESS_ARENA_WIN, + + /** + * The message displayed when a player quits an arena + */ + SUCCESS_ARENA_QUIT, + + /** + * The message used to display the current value of an arena property + */ + SUCCESS_CURRENT_VALUE, + + /** + * The message used to announce that an arena property has been changed + */ + SUCCESS_PROPERTY_CHANGED, + + /** + * The message displayed when two arenas' order in a group have been swapped + */ + SUCCESS_ARENAS_SWAPPED, + + /** + * The message displayed when an arena has been removed + */ + SUCCESS_ARENA_REMOVED, + + /** + * The header displayed before listing all dropper arenas + */ + SUCCESS_DROPPER_ARENAS_LIST, + + /** + * The header displayed before listing all parkour arenas + */ + SUCCESS_PARKOUR_ARENAS_LIST, + + /** + * The message displayed when a player reaches a new checkpoint in a parkour arena + */ + SUCCESS_CHECKPOINT_REACHED, + + /** + * The header displayed before listing all arenas (stages) in a group + */ + SUCCESS_GROUP_STAGES, + + /** + * The message displayed when a new record has been achieved + */ + SUCCESS_RECORD_ACHIEVED, + + /** + * The partial message used to describe that the player achieved a world record + */ + RECORD_ACHIEVED_GLOBAL, + + /** + * The partial message used to describe that the player achieved a personal best record + */ + RECORD_ACHIEVED_PERSONAL, + + /** + * The message displayed when a player joins an arena + */ + SUCCESS_ARENA_JOINED, + ; + + @Override + public @NotNull TranslatableMessage[] getAllMessages() { + return MiniGameMessage.values(); + } + +} diff --git a/src/main/java/net/knarcraft/minigames/config/ParkourConfiguration.java b/src/main/java/net/knarcraft/minigames/config/ParkourConfiguration.java index eb8703d..c0f3848 100644 --- a/src/main/java/net/knarcraft/minigames/config/ParkourConfiguration.java +++ b/src/main/java/net/knarcraft/minigames/config/ParkourConfiguration.java @@ -16,7 +16,6 @@ public class ParkourConfiguration extends MiniGameConfiguration { private boolean enforceCheckpointOrder; private boolean mustDoGroupedInSequence; private boolean ignoreRecordsUntilGroupBeatenOnce; - private boolean makePlayersInvisible; private Set killPlaneBlocks; /** @@ -55,15 +54,6 @@ public class ParkourConfiguration extends MiniGameConfiguration { return this.ignoreRecordsUntilGroupBeatenOnce; } - /** - * Gets whether players should be made invisible while in an arena - * - * @return

Whether players should be made invisible

- */ - public boolean makePlayersInvisible() { - return this.makePlayersInvisible; - } - /** * Gets all types of blocks constituting parkour arenas' kill planes * @@ -78,7 +68,6 @@ public class ParkourConfiguration extends MiniGameConfiguration { this.enforceCheckpointOrder = configuration.getBoolean(rootNode + "enforceCheckpointOrder", false); this.mustDoGroupedInSequence = configuration.getBoolean(rootNode + "mustDoGroupedInSequence", true); this.ignoreRecordsUntilGroupBeatenOnce = configuration.getBoolean(rootNode + "ignoreRecordsUntilGroupBeatenOnce", false); - this.makePlayersInvisible = configuration.getBoolean(rootNode + "makePlayersInvisible", false); this.killPlaneBlocks = loadMaterialList(rootNode + "killPlaneBlocks"); } @@ -89,7 +78,6 @@ public class ParkourConfiguration extends MiniGameConfiguration { "Current configuration:" + "\n" + "Must do groups in sequence: " + mustDoGroupedInSequence + "\n" + "Ignore records until group beaten once: " + ignoreRecordsUntilGroupBeatenOnce + - "\n" + "Make players invisible: " + makePlayersInvisible + "\n" + "Kill plane blocks: "); for (Material material : killPlaneBlocks) { builder.append("\n - ").append(material.name()); diff --git a/src/main/java/net/knarcraft/minigames/container/PlaceholderContainer.java b/src/main/java/net/knarcraft/minigames/container/PlaceholderContainer.java deleted file mode 100644 index ca88158..0000000 --- a/src/main/java/net/knarcraft/minigames/container/PlaceholderContainer.java +++ /dev/null @@ -1,41 +0,0 @@ -package net.knarcraft.minigames.container; - -import java.util.HashMap; -import java.util.Map; - -/** - * A container for keeping track of several placeholder to value mappings - */ -public class PlaceholderContainer { - - private final Map placeholders; - - /** - * Instantiates a new placeholder container - */ - public PlaceholderContainer() { - this.placeholders = new HashMap<>(); - } - - /** - * Gets all placeholders - * - * @return

All placeholders

- */ - public Map getPlaceholders() { - return new HashMap<>(this.placeholders); - } - - /** - * Adds a new placeholder - * - * @param placeholder

The placeholder to register

- * @param value

The value of the placeholder

- * @return

This object

- */ - public PlaceholderContainer add(String placeholder, String value) { - this.placeholders.put(placeholder, value); - return this; - } - -} diff --git a/src/main/java/net/knarcraft/minigames/gui/ArenaGUI.java b/src/main/java/net/knarcraft/minigames/gui/ArenaGUI.java new file mode 100644 index 0000000..a00dc43 --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/gui/ArenaGUI.java @@ -0,0 +1,163 @@ +package net.knarcraft.minigames.gui; + +import net.knarcraft.knargui.AbstractGUI; +import net.knarcraft.knargui.GUIAction; +import net.knarcraft.knargui.item.GUIItemFactory; +import net.knarcraft.knargui.item.PlayerHeadGUIItemFactory; +import net.knarcraft.minigames.MiniGames; +import net.knarcraft.minigames.arena.ArenaPlayerRegistry; +import net.knarcraft.minigames.arena.ArenaSession; +import net.knarcraft.minigames.arena.PlayerVisibilityManager; +import net.md_5.bungee.api.ChatColor; +import org.bukkit.Material; +import org.bukkit.event.inventory.ClickType; +import org.bukkit.inventory.ItemStack; + +import java.util.ArrayList; +import java.util.List; + +/** + * A generic GUI for all arenas + */ +public abstract class ArenaGUI extends AbstractGUI { + + /** + * Instantiates a new arena gui + * + * @param inventorySize

The size of the GUI's inventory

+ * @param inventoryName

The name of the inventory

+ */ + public ArenaGUI(int inventorySize, String inventoryName) { + super(inventorySize, inventoryName, null); + } + + /** + * Gets an item describing a retry arena action + * + * @return

An arena restart item

+ */ + protected ItemStack getRestartItem() { + PlayerHeadGUIItemFactory restartItemFactory = new PlayerHeadGUIItemFactory(); + restartItemFactory.useSkin("e23b225ed0443c4eec7cf30a034490485904e6eb3d53ef2ab9e39c73bdf22c30"); + List loreLines = getLoreLines(); + loreLines.add(ChatColor.GRAY + "Use this item to retry the arena"); + restartItemFactory.setName(ChatColor.BLUE + "Retry arena"); + restartItemFactory.setLore(loreLines); + return restartItemFactory.build(); + } + + /** + * Gets an item describing player visibility toggling + * + * @return

A player toggle item

+ */ + protected ItemStack getTogglePlayersItemDisabled() { + GUIItemFactory togglePlayersItemFactory = new GUIItemFactory(Material.PLAYER_HEAD); + List loreLines = getLoreLines(); + loreLines.add(ChatColor.GRAY + "Use this item to disable the visibility"); + loreLines.add(ChatColor.GRAY + "of other players"); + togglePlayersItemFactory.setName(ChatColor.BLUE + "Disable Players"); + togglePlayersItemFactory.setLore(loreLines); + return togglePlayersItemFactory.build(); + } + + /** + * Gets an item describing player visibility toggling + * + * @return

A player toggle item

+ */ + protected ItemStack getTogglePlayersItemEnabled() { + PlayerHeadGUIItemFactory togglePlayersItemFactory = new PlayerHeadGUIItemFactory(); + togglePlayersItemFactory.useSkin("c10591e6909e6a281b371836e462d67a2c78fa0952e910f32b41a26c48c1757c"); + List loreLines = getLoreLines(); + loreLines.add(ChatColor.GRAY + "Use this item to enable the visibility"); + loreLines.add(ChatColor.GRAY + "of other players"); + togglePlayersItemFactory.setName(ChatColor.BLUE + "Enable Players"); + togglePlayersItemFactory.setLore(loreLines); + return togglePlayersItemFactory.build(); + } + + + /** + * Gets an item describing a leave arena action + * + * @return

A leave item

+ */ + protected ItemStack getLeaveItem() { + GUIItemFactory leaveItemFactory = new GUIItemFactory(Material.BARRIER); + List loreLines = getLoreLines(); + loreLines.add(ChatColor.GRAY + "Use this item to leave the arena"); + leaveItemFactory.setName(ChatColor.DARK_RED + "Leave"); + leaveItemFactory.setLore(loreLines); + return leaveItemFactory.build(); + } + + /** + * Gets an arraylist with one blank line lore-lines can be added to + * + * @return

An arraylist with one blank line

+ */ + protected List getLoreLines() { + List loreLines = new ArrayList<>(); + loreLines.add(""); + return loreLines; + } + + /** + * Sets a click action for both right-click and left-click + * + * @param inventorySlot

The inventory slot the action should be added to

+ * @param action

The action to register

+ */ + protected void setAnyClickAction(int inventorySlot, GUIAction action) { + setClickAction(inventorySlot, ClickType.LEFT, action); + setClickAction(inventorySlot, ClickType.RIGHT, action); + } + + /** + * Gets the action to run when triggering the leave item + * + * @return

The leave action

+ */ + public static GUIAction getLeaveAction() { + return (player) -> { + ArenaSession session = MiniGames.getInstance().getSession(player.getUniqueId()); + if (session != null) { + session.triggerQuit(false, true); + } + }; + } + + /** + * Gets the action to run when triggering the restart action + * + * @return

The action for triggering a session restart

+ */ + public static GUIAction getRestartAction() { + return (player -> { + ArenaSession session = MiniGames.getInstance().getSession(player.getUniqueId()); + if (session != null) { + session.reset(); + } + }); + } + + /** + * Gets the action to run when triggering the toggle players action + * + * @param playerRegistry

The registry containing relevant players

+ * @return

The action for triggering player visibility

+ */ + public GUIAction getTogglePlayersAction(ArenaPlayerRegistry playerRegistry) { + return (player) -> { + PlayerVisibilityManager visibilityManager = MiniGames.getInstance().getPlayerVisibilityManager(); + visibilityManager.toggleHidePlayers(playerRegistry, player); + if (MiniGames.getInstance().getPlayerVisibilityManager().isHidingPlayers(player)) { + setItem(0, getTogglePlayersItemEnabled()); + } else { + setItem(0, getTogglePlayersItemDisabled()); + } + }; + } + +} diff --git a/src/main/java/net/knarcraft/minigames/gui/DropperGUI.java b/src/main/java/net/knarcraft/minigames/gui/DropperGUI.java new file mode 100644 index 0000000..acf2324 --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/gui/DropperGUI.java @@ -0,0 +1,31 @@ +package net.knarcraft.minigames.gui; + +import net.knarcraft.minigames.MiniGames; +import org.bukkit.entity.Player; + +/** + * A GUI used in the dropper arena + */ +public class DropperGUI extends ArenaGUI { + + /** + * Instantiates a new dropper gui + * + * @param player

The player the GUI is created for

+ */ + public DropperGUI(Player player) { + super(9, "Dropper"); + if (MiniGames.getInstance().getPlayerVisibilityManager().isHidingPlayers(player)) { + setItem(0, getTogglePlayersItemEnabled()); + } else { + setItem(0, getTogglePlayersItemDisabled()); + } + setItem(2, getLeaveItem()); + setItem(4, getRestartItem()); + + setAnyClickAction(0, getTogglePlayersAction(MiniGames.getInstance().getDropperArenaPlayerRegistry())); + setAnyClickAction(2, getLeaveAction()); + setAnyClickAction(4, getRestartAction()); + } + +} diff --git a/src/main/java/net/knarcraft/minigames/gui/MiniGamesGUI.java b/src/main/java/net/knarcraft/minigames/gui/MiniGamesGUI.java new file mode 100644 index 0000000..4dca1f4 --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/gui/MiniGamesGUI.java @@ -0,0 +1,27 @@ +package net.knarcraft.minigames.gui; + +import net.knarcraft.minigames.MiniGames; +import org.bukkit.entity.Player; + +/** + * A GUI used outside arenas + */ +public class MiniGamesGUI extends ArenaGUI { + + /** + * Instantiates a new mini games gui + * + * @param player

The player the GUI is created for

+ */ + public MiniGamesGUI(Player player) { + super(9, "MiniGames"); + if (MiniGames.getInstance().getPlayerVisibilityManager().isHidingPlayers(player)) { + setItem(0, getTogglePlayersItemEnabled()); + } else { + setItem(0, getTogglePlayersItemDisabled()); + } + + setAnyClickAction(0, getTogglePlayersAction(null)); + } + +} diff --git a/src/main/java/net/knarcraft/minigames/gui/ParkourGUI.java b/src/main/java/net/knarcraft/minigames/gui/ParkourGUI.java new file mode 100644 index 0000000..1783cc3 --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/gui/ParkourGUI.java @@ -0,0 +1,71 @@ +package net.knarcraft.minigames.gui; + +import net.knarcraft.knargui.GUIAction; +import net.knarcraft.knargui.item.GUIItemFactory; +import net.knarcraft.minigames.MiniGames; +import net.knarcraft.minigames.arena.ArenaSession; +import net.knarcraft.minigames.arena.parkour.ParkourArenaSession; +import net.md_5.bungee.api.ChatColor; +import org.bukkit.Material; +import org.bukkit.entity.Player; +import org.bukkit.inventory.ItemStack; + +import java.util.List; + +/** + * A GUI used in the parkour arena + */ +public class ParkourGUI extends ArenaGUI { + + /** + * Instantiates a new parkour gui + * + * @param player

The player the GUI is created for

+ */ + public ParkourGUI(Player player) { + super(9, "Parkour"); + if (MiniGames.getInstance().getPlayerVisibilityManager().isHidingPlayers(player)) { + setItem(0, getTogglePlayersItemEnabled()); + } else { + setItem(0, getTogglePlayersItemDisabled()); + } + setItem(2, getGiveUpItem()); + setItem(4, getLeaveItem()); + setItem(6, getRestartItem()); + + setAnyClickAction(0, getTogglePlayersAction(MiniGames.getInstance().getParkourArenaPlayerRegistry())); + setAnyClickAction(2, getGiveUpAction()); + setAnyClickAction(4, getLeaveAction()); + setAnyClickAction(6, getRestartAction()); + } + + /** + * Gets an item describing a give up action + * + * @return

A give up item

+ */ + private ItemStack getGiveUpItem() { + GUIItemFactory giveUpItemFactory = new GUIItemFactory(Material.RESPAWN_ANCHOR); + List loreLines = getLoreLines(); + loreLines.add(ChatColor.GRAY + "Use this item to give up"); + loreLines.add(ChatColor.GRAY + "and go to the last checkpoint"); + giveUpItemFactory.setName(ChatColor.RED + "Give up"); + giveUpItemFactory.setLore(loreLines); + return giveUpItemFactory.build(); + } + + /** + * Gets the action to run when triggering the give up item + * + * @return

The give up action

+ */ + public static GUIAction getGiveUpAction() { + return (player) -> { + ArenaSession session = MiniGames.getInstance().getSession(player.getUniqueId()); + if (session instanceof ParkourArenaSession) { + session.triggerLoss(); + } + }; + } + +} diff --git a/src/main/java/net/knarcraft/minigames/listener/CommandListener.java b/src/main/java/net/knarcraft/minigames/listener/CommandListener.java index 112231d..7d64d86 100644 --- a/src/main/java/net/knarcraft/minigames/listener/CommandListener.java +++ b/src/main/java/net/knarcraft/minigames/listener/CommandListener.java @@ -2,7 +2,7 @@ package net.knarcraft.minigames.listener; import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.ArenaSession; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.entity.Player; import org.bukkit.event.EventHandler; import org.bukkit.event.Listener; @@ -29,6 +29,8 @@ public class CommandListener implements Listener { allowedCommands.add("/mLeave"); allowedCommands.add("/dLeave"); allowedCommands.add("/pLeave"); + allowedCommands.add("/miniGamesMenu"); + allowedCommands.add("/mMenu"); String message = event.getMessage(); if (!message.startsWith("/")) { @@ -41,7 +43,7 @@ public class CommandListener implements Listener { } } - player.sendMessage(Message.ERROR_ILLEGAL_COMMAND.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(player, MiniGameMessage.ERROR_ILLEGAL_COMMAND); event.setCancelled(true); } diff --git a/src/main/java/net/knarcraft/minigames/listener/InteractListener.java b/src/main/java/net/knarcraft/minigames/listener/InteractListener.java new file mode 100644 index 0000000..c16b95b --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/listener/InteractListener.java @@ -0,0 +1,53 @@ +package net.knarcraft.minigames.listener; + +import net.knarcraft.minigames.MiniGames; +import net.knarcraft.minigames.gui.ArenaGUI; +import net.knarcraft.minigames.gui.ParkourGUI; +import net.knarcraft.minigames.property.PersistentDataKey; +import net.knarcraft.minigames.util.GUIHelper; +import org.bukkit.NamespacedKey; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.player.PlayerInteractEvent; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.ItemMeta; +import org.bukkit.persistence.PersistentDataType; + +/** + * A listener that listens for player interactions + */ +public class InteractListener implements Listener { + + @EventHandler + public void menuInteractListener(PlayerInteractEvent event) { + ItemStack item = event.getItem(); + if (item == null || !item.hasItemMeta()) { + return; + } + ItemMeta meta = item.getItemMeta(); + if (meta == null) { + return; + } + + Integer persistentData = meta.getPersistentDataContainer().get(new NamespacedKey(MiniGames.getInstance(), + PersistentDataKey.MENU_ITEM.getKeyName()), PersistentDataType.INTEGER); + + if (persistentData != null && persistentData == PersistentDataKey.MENU_ITEM.getDataValue()) { + event.setCancelled(true); + GUIHelper.openGUI(event.getPlayer()); + return; + } + + persistentData = meta.getPersistentDataContainer().get(new NamespacedKey(MiniGames.getInstance(), + PersistentDataKey.LEAVE_ITEM.getKeyName()), PersistentDataType.INTEGER); + if (persistentData != null) { + event.setCancelled(true); + if (persistentData == PersistentDataKey.LEAVE_ITEM.getDataValue()) { + ArenaGUI.getLeaveAction().run(event.getPlayer()); + } else if (persistentData == PersistentDataKey.GIVE_UP_ITEM.getDataValue()) { + ParkourGUI.getGiveUpAction().run(event.getPlayer()); + } + } + } + +} diff --git a/src/main/java/net/knarcraft/minigames/listener/MoveListener.java b/src/main/java/net/knarcraft/minigames/listener/MoveListener.java index 18a1bb7..5e50440 100644 --- a/src/main/java/net/knarcraft/minigames/listener/MoveListener.java +++ b/src/main/java/net/knarcraft/minigames/listener/MoveListener.java @@ -9,9 +9,10 @@ import net.knarcraft.minigames.arena.parkour.ParkourArena; import net.knarcraft.minigames.arena.parkour.ParkourArenaGameMode; import net.knarcraft.minigames.arena.parkour.ParkourArenaSession; import net.knarcraft.minigames.config.DropperConfiguration; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.config.ParkourConfiguration; import net.knarcraft.minigames.config.SharedConfiguration; +import org.bukkit.Bukkit; import org.bukkit.Location; import org.bukkit.block.Block; import org.bukkit.entity.Player; @@ -120,7 +121,8 @@ public class MoveListener implements Listener { // Register the checkpoint arenaSession.registerCheckpoint(checkpoint.clone()); - player.sendMessage(Message.SUCCESS_CHECKPOINT_REACHED.getMessage()); + MiniGames.getInstance().getStringFormatter().displaySuccessMessage(player, + MiniGameMessage.SUCCESS_CHECKPOINT_REACHED); return; } } @@ -132,14 +134,26 @@ public class MoveListener implements Listener { * @param arenaSession

The dropper session of the player triggering the event

*/ private void doDropperArenaChecks(@NotNull PlayerMoveEvent event, @NotNull DropperArenaSession arenaSession) { - if (event.getTo() == null) { + // If the player has yet to move in the arena, allow them to look around + boolean startedMoving = arenaSession.getStartedMoving(); + if (event.getTo() == null || + (!startedMoving && isSameLocation(event.getFrom(), event.getTo()))) { return; } + + // Marks the player as started moving if necessary, so they can no longer hang in the air + if (!startedMoving) { + arenaSession.setStartedMoving(); + } + // Prevent the player from flying upwards while in flight mode if (event.getFrom().getY() < event.getTo().getY() || (dropperConfiguration.blockSneaking() && event.getPlayer().isSneaking()) || (dropperConfiguration.blockSprinting() && event.getPlayer().isSprinting())) { event.setCancelled(true); + // Force movement downwards once the player lets go + Bukkit.getScheduler().scheduleSyncDelayedTask(MiniGames.getInstance(), + () -> updatePlayerVelocity(arenaSession), 1); return; } @@ -154,6 +168,18 @@ public class MoveListener implements Listener { updatePlayerVelocity(arenaSession); } + /** + * Checks if two locations are the same, excluding rotation + * + * @param location1

The first location to check

+ * @param location2

The second location to check

+ * @return

True if the locations are the same, excluding rotation

+ */ + private boolean isSameLocation(Location location1, Location location2) { + return location1.getX() == location2.getX() && location1.getY() == location2.getY() && + location1.getZ() == location2.getZ(); + } + /** * Check if the player in the session is triggering a block with a special significance * diff --git a/src/main/java/net/knarcraft/minigames/placeholder/RecordExpansion.java b/src/main/java/net/knarcraft/minigames/placeholder/RecordExpansion.java index 9dca66c..93a0822 100644 --- a/src/main/java/net/knarcraft/minigames/placeholder/RecordExpansion.java +++ b/src/main/java/net/knarcraft/minigames/placeholder/RecordExpansion.java @@ -1,6 +1,7 @@ package net.knarcraft.minigames.placeholder; import me.clip.placeholderapi.expansion.PlaceholderExpansion; +import net.knarcraft.minigames.MiniGames; import net.knarcraft.minigames.arena.Arena; import net.knarcraft.minigames.arena.ArenaGameMode; import net.knarcraft.minigames.arena.ArenaGroup; @@ -26,6 +27,7 @@ import java.util.Objects; import java.util.Set; import java.util.UUID; import java.util.function.Supplier; +import java.util.logging.Level; /** * A placeholder expansion for parkour record placeholders @@ -71,7 +73,14 @@ public abstract class RecordExpansion extends PlaceholderExpansion { ArenaGameMode gameMode = parseGameMode(parts[2]); SelectionType selectionType = SelectionType.getFromString(parts[3]); String identifier = parts[4]; - int recordNumber = Integer.parseInt(parts[5]) - 1; + int recordNumber; + try { + recordNumber = Integer.parseInt(parts[5]) - 1; + } catch (NumberFormatException exception) { + MiniGames.log(Level.WARNING, "Invalid placeholder given. " + parts[5] + + " supplied instead of record placement."); + return parameters; + } InfoType infoType = InfoType.getFromString(parts[6]); if (recordType == null || infoType == null) { diff --git a/src/main/java/net/knarcraft/minigames/property/PersistentDataKey.java b/src/main/java/net/knarcraft/minigames/property/PersistentDataKey.java new file mode 100644 index 0000000..4536ded --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/property/PersistentDataKey.java @@ -0,0 +1,45 @@ +package net.knarcraft.minigames.property; + +/** + * An enum for all persistent data keys used by this plugin + */ +public enum PersistentDataKey { + + MENU_ITEM("MiniGamesMenu", 1799804), + LEAVE_ITEM("MiniGamesAction", 1799871), + GIVE_UP_ITEM("MiniGamesAction", 1799872), + ; + + private final String keyName; + private final int dataValue; + + /** + * Instantiates a new persistent data key + * + * @param keyName

The name of this key

+ * @param dataValue

The integer data value of this key

+ */ + PersistentDataKey(String keyName, int dataValue) { + this.keyName = keyName; + this.dataValue = dataValue; + } + + /** + * Gets the name of this persistent data key + * + * @return

The name of this key

+ */ + public String getKeyName() { + return this.keyName; + } + + /** + * Gets the integer data value of this persistent data key + * + * @return

The integer data value

+ */ + public int getDataValue() { + return this.dataValue; + } + +} diff --git a/src/main/java/net/knarcraft/minigames/util/ArenaStorageHelper.java b/src/main/java/net/knarcraft/minigames/util/ArenaStorageHelper.java index 9abfd2d..34ac68a 100644 --- a/src/main/java/net/knarcraft/minigames/util/ArenaStorageHelper.java +++ b/src/main/java/net/knarcraft/minigames/util/ArenaStorageHelper.java @@ -35,7 +35,7 @@ public final class ArenaStorageHelper { try { configuration.save(new File(MiniGames.getInstance().getDataFolder(), key + "EntryStates.yml")); - } catch (IOException e) { + } catch (IOException exception) { MiniGames.log(Level.SEVERE, "Unable to save entry states to disk"); } } diff --git a/src/main/java/net/knarcraft/minigames/util/ColorHelper.java b/src/main/java/net/knarcraft/minigames/util/ColorHelper.java deleted file mode 100644 index 4b79d19..0000000 --- a/src/main/java/net/knarcraft/minigames/util/ColorHelper.java +++ /dev/null @@ -1,29 +0,0 @@ -package net.knarcraft.minigames.util; - -import net.md_5.bungee.api.ChatColor; - -import java.util.regex.Matcher; -import java.util.regex.Pattern; - -/** - * A helper class for converting colors - */ -public class ColorHelper { - - /** - * Translates all found color codes to formatting in a string - * - * @param message

The string to search for color codes

- * @return

The message with color codes translated

- */ - public static String translateAllColorCodes(String message) { - message = ChatColor.translateAlternateColorCodes('&', message); - Pattern pattern = Pattern.compile("&?(#[a-fA-F0-9]{6})"); - Matcher matcher = pattern.matcher(message); - while (matcher.find()) { - message = message.replace(matcher.group(), "" + ChatColor.of(matcher.group(1))); - } - return message; - } - -} diff --git a/src/main/java/net/knarcraft/minigames/util/DropperArenaStorageHelper.java b/src/main/java/net/knarcraft/minigames/util/DropperArenaStorageHelper.java index 524b736..0b2c22d 100644 --- a/src/main/java/net/knarcraft/minigames/util/DropperArenaStorageHelper.java +++ b/src/main/java/net/knarcraft/minigames/util/DropperArenaStorageHelper.java @@ -9,8 +9,7 @@ import net.knarcraft.minigames.arena.dropper.DropperArenaGameMode; import net.knarcraft.minigames.arena.dropper.DropperArenaGroup; import net.knarcraft.minigames.arena.dropper.DropperArenaRecordsRegistry; import net.knarcraft.minigames.arena.dropper.DropperArenaStorageKey; -import net.knarcraft.minigames.config.Message; -import net.knarcraft.minigames.container.PlaceholderContainer; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.container.SerializableMaterial; import net.knarcraft.minigames.container.SerializableUUID; import org.bukkit.Location; @@ -161,8 +160,9 @@ public final class DropperArenaStorageHelper { DropperArenaStorageKey.WIN_BLOCK_TYPE.getKey()); if (arenaName == null || spawnLocation == null) { - MiniGames.log(Level.SEVERE, Message.ERROR_ARENA_NOT_LOADED.getMessage(new PlaceholderContainer().add( - "{section}", configurationSection.getName()).add("{file}", "dropper_arenas"))); + MiniGames.log(Level.SEVERE, MiniGames.getInstance().getStringFormatter().replacePlaceholders( + MiniGameMessage.ERROR_ARENA_NOT_LOADED, new String[]{"{section}", "{file}"}, + new String[]{configurationSection.getName(), "dropper_arenas"})); return null; } if (winBlockType == null) { @@ -172,8 +172,8 @@ public final class DropperArenaStorageHelper { // Generate new, empty arena data if not available DropperArenaData arenaData = loadDropperArenaData(arenaId); if (arenaData == null) { - MiniGames.log(Level.SEVERE, Message.ERROR_ARENA_DATA_NOT_LOADED.getMessage("{arena}", - arenaId.toString())); + MiniGames.log(Level.SEVERE, MiniGames.getInstance().getStringFormatter().replacePlaceholder( + MiniGameMessage.ERROR_ARENA_DATA_NOT_LOADED, "{arena}", arenaId.toString())); arenaData = getEmptyDropperData(arenaId); } diff --git a/src/main/java/net/knarcraft/minigames/util/GUIHelper.java b/src/main/java/net/knarcraft/minigames/util/GUIHelper.java new file mode 100644 index 0000000..90e4ecc --- /dev/null +++ b/src/main/java/net/knarcraft/minigames/util/GUIHelper.java @@ -0,0 +1,58 @@ +package net.knarcraft.minigames.util; + +import net.knarcraft.knargui.item.PlayerHeadGUIItemFactory; +import net.knarcraft.minigames.MiniGames; +import net.knarcraft.minigames.arena.ArenaSession; +import net.knarcraft.minigames.gui.MiniGamesGUI; +import net.knarcraft.minigames.property.PersistentDataKey; +import org.bukkit.ChatColor; +import org.bukkit.NamespacedKey; +import org.bukkit.entity.Player; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.ItemMeta; +import org.bukkit.persistence.PersistentDataType; + +/** + * A helper class for the in-arena GUI + */ +public final class GUIHelper { + + private GUIHelper() { + + } + + /** + * Gets the item used for opening the mini-games menu + * + * @return

The item used for opening the GUI

+ */ + public static ItemStack getGUIOpenItem() { + PlayerHeadGUIItemFactory factory = new PlayerHeadGUIItemFactory(); + factory.useSkin("3fdab40434ed5d01f58c45ca0c9fada4662e1772ff43e2974979440a5cfe15c9"); + factory.setName(ChatColor.AQUA + "§ MiniGames Menu §"); + ItemStack item = factory.build(); + ItemMeta meta = item.getItemMeta(); + if (meta != null) { + meta.getPersistentDataContainer().set(new NamespacedKey(MiniGames.getInstance(), + PersistentDataKey.MENU_ITEM.getKeyName()), + PersistentDataType.INTEGER, PersistentDataKey.MENU_ITEM.getDataValue()); + } + item.setItemMeta(meta); + return item; + } + + /** + * Opens the correct GUI for the given player + * + * @param player

The player to show a GUI for

+ */ + public static void openGUI(Player player) { + ArenaSession existingSession = MiniGames.getInstance().getSession(player.getUniqueId()); + if (existingSession == null) { + new MiniGamesGUI(player).openFor(player); + } else { + existingSession.getGUI().openFor(player); + } + } + +} diff --git a/src/main/java/net/knarcraft/minigames/util/MaterialHelper.java b/src/main/java/net/knarcraft/minigames/util/MaterialHelper.java deleted file mode 100644 index 2a50b5a..0000000 --- a/src/main/java/net/knarcraft/minigames/util/MaterialHelper.java +++ /dev/null @@ -1,77 +0,0 @@ -package net.knarcraft.minigames.util; - -import net.knarcraft.minigames.MiniGames; -import net.knarcraft.minigames.config.Message; -import org.bukkit.Bukkit; -import org.bukkit.Material; -import org.bukkit.NamespacedKey; -import org.bukkit.Tag; -import org.jetbrains.annotations.NotNull; - -import java.util.HashSet; -import java.util.List; -import java.util.Set; -import java.util.logging.Level; -import java.util.regex.Matcher; -import java.util.regex.Pattern; - -/** - * A helper class for dealing with and parsing materials - */ -public final class MaterialHelper { - - private MaterialHelper() { - - } - - /** - * Loads the materials specified in the block whitelist - */ - public static @NotNull Set loadMaterialList(@NotNull List materials) { - Set parsedMaterials = new HashSet<>(); - for (Object value : materials) { - if (!(value instanceof String string)) { - continue; - } - - // Try to parse a material tag first - if (parseMaterialTag(parsedMaterials, string)) { - continue; - } - - // Try to parse a material name - Material matched = Material.matchMaterial(string); - if (matched != null) { - parsedMaterials.add(matched); - } else { - MiniGames.log(Level.WARNING, Message.ERROR_MATERIAL_NOT_PARSE_ABLE.getMessage("{material}", string)); - } - } - return parsedMaterials; - } - - /** - * Tries to parse the material tag in the specified material name - * - * @param targetSet

The set all parsed materials should be added to

- * @param materialName

The material name that might be a material tag

- * @return

True if a tag was found

- */ - private static boolean parseMaterialTag(@NotNull Set targetSet, @NotNull String materialName) { - Pattern pattern = Pattern.compile("^\\+([a-zA-Z_]+)"); - Matcher matcher = pattern.matcher(materialName); - if (matcher.find()) { - // The material is a material tag - Tag tag = Bukkit.getTag(Tag.REGISTRY_BLOCKS, NamespacedKey.minecraft( - matcher.group(1).toLowerCase()), Material.class); - if (tag != null) { - targetSet.addAll(tag.getValues()); - } else { - MiniGames.log(Level.WARNING, "Unable to parse: " + materialName); - } - return true; - } - return false; - } - -} diff --git a/src/main/java/net/knarcraft/minigames/util/ParkourArenaStorageHelper.java b/src/main/java/net/knarcraft/minigames/util/ParkourArenaStorageHelper.java index 375ab4b..1c00c64 100644 --- a/src/main/java/net/knarcraft/minigames/util/ParkourArenaStorageHelper.java +++ b/src/main/java/net/knarcraft/minigames/util/ParkourArenaStorageHelper.java @@ -9,8 +9,7 @@ import net.knarcraft.minigames.arena.parkour.ParkourArenaGameMode; import net.knarcraft.minigames.arena.parkour.ParkourArenaGroup; import net.knarcraft.minigames.arena.parkour.ParkourArenaRecordsRegistry; import net.knarcraft.minigames.arena.parkour.ParkourArenaStorageKey; -import net.knarcraft.minigames.config.Message; -import net.knarcraft.minigames.container.PlaceholderContainer; +import net.knarcraft.minigames.config.MiniGameMessage; import net.knarcraft.minigames.container.SerializableMaterial; import net.knarcraft.minigames.container.SerializableUUID; import org.bukkit.Location; @@ -166,8 +165,9 @@ public final class ParkourArenaStorageHelper { // The arena name and spawn location must be present if (arenaName == null || spawnLocation == null) { - MiniGames.log(Level.SEVERE, Message.ERROR_ARENA_NOT_LOADED.getMessage(new PlaceholderContainer().add( - "{section}", configurationSection.getName()).add("{file}", "parkour_arena"))); + MiniGames.log(Level.SEVERE, MiniGames.getInstance().getStringFormatter().replacePlaceholders( + MiniGameMessage.ERROR_ARENA_NOT_LOADED, new String[]{"{section}", "{file}"}, + new String[]{configurationSection.getName(), "parkour_arena"})); return null; } @@ -179,8 +179,8 @@ public final class ParkourArenaStorageHelper { // Generate new, empty arena data if not available ParkourArenaData arenaData = loadParkourArenaData(arenaId); if (arenaData == null) { - MiniGames.log(Level.SEVERE, Message.ERROR_ARENA_DATA_NOT_LOADED.getMessage("{arena}", - arenaId.toString())); + MiniGames.log(Level.SEVERE, MiniGames.getInstance().getStringFormatter().replacePlaceholder( + MiniGameMessage.ERROR_ARENA_DATA_NOT_LOADED, "{arena}", arenaId.toString())); arenaData = getEmptyParkourData(arenaId); } diff --git a/src/main/java/net/knarcraft/minigames/util/PlayerTeleporter.java b/src/main/java/net/knarcraft/minigames/util/PlayerTeleporter.java index 974a042..af700f7 100644 --- a/src/main/java/net/knarcraft/minigames/util/PlayerTeleporter.java +++ b/src/main/java/net/knarcraft/minigames/util/PlayerTeleporter.java @@ -1,7 +1,7 @@ package net.knarcraft.minigames.util; import net.knarcraft.minigames.MiniGames; -import net.knarcraft.minigames.config.Message; +import net.knarcraft.minigames.config.MiniGameMessage; import org.bukkit.Bukkit; import org.bukkit.Location; import org.bukkit.entity.Entity; @@ -36,7 +36,8 @@ public final class PlayerTeleporter { passenger.teleport(location); } } else { - player.sendMessage(Message.ERROR_TELEPORT_WITH_PASSENGER.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(player, + MiniGameMessage.ERROR_TELEPORT_WITH_PASSENGER); return false; } } @@ -46,7 +47,8 @@ public final class PlayerTeleporter { player.eject(); vehicle.teleport(location); } else { - player.sendMessage(Message.ERROR_TELEPORT_IN_VEHICLE.getMessage()); + MiniGames.getInstance().getStringFormatter().displayErrorMessage(player, + MiniGameMessage.ERROR_TELEPORT_IN_VEHICLE); return false; } } diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index b138669..63423cb 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -1,4 +1,7 @@ # Configuration values for mini-games + +# The chosen language for Launchpad. You can use "en" or any custom language specified in strings.yml +language: en parkour: # Whether to enforce the order in which a player must reach checkpoints. Enabling this ensures that a player cannot # trigger a previous checkpoint by accident. It also ensures players cannot skip a checkpoint, even if the arena @@ -12,9 +15,6 @@ parkour: # are required to do a second play-through to register a record for a grouped arena. ignoreRecordsUntilGroupBeatenOnce: false - # Whether players should be made invisible while playing in a dropper arena - makePlayersInvisible: false - # The blocks compromising parkour arenas' kill planes. Add any materials you want to use for the "bottom" of your # parkour arenas. killPlaneBlocks: @@ -48,13 +48,6 @@ dropper: # Whether a player must do the normal/default game-mode before playing any other game-modes mustDoNormalModeFirst: true - # Whether players should be made invisible while playing in a dropper arena - makePlayersInvisible: false - - # Whether players should have their entity hit collision disabled while in an arena. This prevents players from - # pushing each-other if in the same arena. - disableHitCollision: true - # A whitelist for which blocks won't trigger a loss when hit/passed through. The win block check happens before the # loss check, so even blocks on the whitelist can be used as the win-block. "+" denotes a material tag. blockWhitelist: diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 8fbd03b..3a2dafd 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -20,13 +20,17 @@ commands: - mleave - dleave - pleave - permission: minigames.join usage: / description: Used to leave the current dropper arena + miniGamesMenu: + aliases: + - mmenu + usage: / + description: Used to display an actions menu while in an arena dropperGroupSet: aliases: - dgset - permission: minigames.edit + permission: minigames.edit.dropper usage: | / - The group will be created if it doesn't already exist @@ -35,7 +39,7 @@ commands: dropperGroupSwap: aliases: - dgswap - permission: minigames.edit + permission: minigames.edit.dropper usage: | / - The two arenas must be in the same group @@ -43,7 +47,7 @@ commands: dropperGroupList: aliases: - dglist - permission: minigames.edit + permission: minigames.edit.dropper usage: | / [group] - Existing groups will be listed if used without an argument @@ -52,13 +56,13 @@ commands: dropperList: aliases: - dlist - permission: minigames.join + permission: minigames.join.dropper usage: / description: Used to list all current dropper arenas dropperJoin: aliases: - djoin - permission: minigames.join + permission: minigames.join.dropper usage: | / [mode] - Mode can be used to select challenge modes which can be played after beating the arena. @@ -68,7 +72,7 @@ commands: dropperCreate: aliases: - dcreate - permission: minigames.create + permission: minigames.create.dropper usage: | / [new value] - Valid properties: name, spawnLocation, exitLocation, verticalVelocity, horizontalVelocity, winBlockType @@ -76,13 +80,13 @@ commands: dropperEdit: aliases: - dedit - permission: minigames.edit + permission: minigames.edit.dropper usage: / (Details not finalized) description: Used to edit an existing dropper arena dropperRemove: aliases: - dremove - permission: minigames.remove + permission: minigames.remove.dropper usage: / description: Used to remove an existing dropper arena parkourGroupSet: @@ -97,7 +101,7 @@ commands: parkourGroupSwap: aliases: - pgswap - permission: minigames.edit + permission: minigames.edit.parkour usage: | / - The two arenas must be in the same group @@ -105,7 +109,7 @@ commands: parkourGroupList: aliases: - pglist - permission: minigames.edit + permission: minigames.edit.parkour usage: | / [group] - Existing groups will be listed if used without an argument @@ -114,13 +118,13 @@ commands: parkourList: aliases: - plist - permission: minigames.join + permission: minigames.join.parkour usage: / description: Used to list all current parkour arenas parkourJoin: aliases: - pjoin - permission: minigames.join + permission: minigames.join.parkour usage: | / [mode] - Mode can be used to select challenge modes which can be played after beating the arena. @@ -129,7 +133,7 @@ commands: parkourCreate: aliases: - pcreate - permission: minigames.create + permission: minigames.create.parkour usage: | / [new value] - Valid properties: name, spawnLocation, exitLocation, winBlockType, winLocation, checkpointAdd, checkpointClear, killPlaneBlocks @@ -137,13 +141,13 @@ commands: parkourEdit: aliases: - pedit - permission: minigames.edit + permission: minigames.edit.parkour usage: / (Details not finalized) description: Used to edit an existing parkour arena parkourRemove: aliases: - dremove - permission: minigames.remove + permission: minigames.remove.parkour usage: / description: Used to remove an existing parkour arena permissions: diff --git a/src/main/resources/strings.yml b/src/main/resources/strings.yml new file mode 100644 index 0000000..cf2062a --- /dev/null +++ b/src/main/resources/strings.yml @@ -0,0 +1,43 @@ +en: + ERROR_CANNOT_SAVE_ARENA_GROUPS: "Unable to save current arena groups! Data loss can occur!" + ERROR_MATERIAL_NOT_PARSE_ABLE: "Unable to parse material: {material}" + ERROR_TELEPORT_WITH_PASSENGER: "You cannot be teleported with a passenger!" + ERROR_TELEPORT_IN_VEHICLE: "You cannot be teleported while in a vehicle" + ERROR_ARENA_NOT_LOADED: "Could not load the arena at configuration section {section}. Please check the {file} storage file for issues." + ERROR_ARENA_DATA_NOT_LOADED: "Unable to load arena data for dropper arena: {arena}" + ERROR_ARENA_NOT_FOUND: "Unable to find the specified arena." + ERROR_GROUP_NOT_FOUND: "Unable to find the specified group!" + ERROR_PLAYER_ONLY: "This command must be used by a player" + ERROR_ARENA_NAME_COLLISION: "There already exists an arena with that name!" + ERROR_NORMAL_MODE_REQUIRED: "You must complete this arena in normal mode first!" + ERROR_GROUP_NORMAL_MODE_REQUIRED: "You have not yet beaten the default game-mode for all arenas in this group!" + ERROR_PREVIOUS_ARENA_REQUIRED: "You have not yet beaten the previous arena!" + ERROR_ARENA_TELEPORT_FAILED: "Unable to teleport you to the arena." + ERROR_NOT_IN_ARENA: "You are not in a mini-games arena!" + ERROR_ALREADY_PLAYING: "You are already playing a mini-game!" + ERROR_JOIN_IN_VEHICLE_OR_PASSENGER: "You cannot join an arena while inside a vehicle or carrying a passenger." + ERROR_UNKNOWN_PROPERTY: "Unknown property specified." + ERROR_PROPERTY_INPUT_INVALID: "Unable to change the property. Make sure your input is valid!" + ERROR_ARENA_1_NOT_FOUND: "Unable to find the first specified arena." + ERROR_ARENA_2_NOT_FOUND: "Unable to find the second specified dropper arena." + ERROR_SWAP_DIFFERENT_GROUPS: "You cannot swap arenas in different groups!" + ERROR_ILLEGAL_COMMAND: "You cannot use that command while in an arena!" + ERROR_HARDCORE_NO_CHECKPOINTS: "This arena cannot be played in hardcore mode as it has no checkpoints!" + SUCCESS_ARENA_GROUP_UPDATED: "The arena's group has been updated" + SUCCESS_PLUGIN_RELOADED: "Plugin reloaded!" + SUCCESS_ARENA_CREATED: "The arena was successfully created!" + SUCCESS_ARENA_FIRST_CLEAR: "You cleared the arena!" + SUCCESS_ARENA_WIN: "You won!" + SUCCESS_ARENA_QUIT: "You quit the arena!" + SUCCESS_CURRENT_VALUE: "Current value of {property} is: {value}" + SUCCESS_PROPERTY_CHANGED: "Property {property} successfully changed" + SUCCESS_ARENAS_SWAPPED: "The arenas have been swapped!" + SUCCESS_ARENA_REMOVED: "The specified arena has been successfully removed" + SUCCESS_DROPPER_ARENAS_LIST: "Dropper arenas:&r" + SUCCESS_PARKOUR_ARENAS_LIST: "Parkour arenas:&r" + SUCCESS_CHECKPOINT_REACHED: "Checkpoint reached!" + SUCCESS_GROUP_STAGES: "{group}'s stages:&r" + SUCCESS_RECORD_ACHIEVED: "You just set a {recordInfo} on the {gameMode} game-mode!" + RECORD_ACHIEVED_GLOBAL: "new {recordType} record" + RECORD_ACHIEVED_PERSONAL: "personal {recordType} record" + SUCCESS_ARENA_JOINED: "You joined the arena." \ No newline at end of file