The Spigot bug currently makes every right click of a coral trigger twice, causing the portal to close - * immediately. This fix should detect the bug without breaking wall coral buttons once the bug is fixed.
+ *This will only display portal info if the portal has no sign and is not silent.
+ * + * @param blockThe clicked block
+ * @param playerThe player that clicked the block
+ */ + private void displayPortalInfo(Block block, Player player) { + Portal portal = PortalHandler.getByBlock(block); + if (portal == null) { + return; + } + + //Display portal information as a portal without a sign does not display any + if (portal.getOptions().hasNoSign() && !portal.getOptions().isSilent()) { + MessageSender sender = Stargate.getMessageSender(); + sender.sendSuccessMessage(player, ChatColor.GOLD + "[PORTAL INFO]"); + sender.sendSuccessMessage(player, String.format("Portal name: %s", portal.getName())); + sender.sendSuccessMessage(player, String.format("Portal destination: %s", portal.getDestinationName())); + sender.sendSuccessMessage(player, String.format("Portal network: %s", portal.getNetwork())); + } + } + + /** + * This function decides if a right click of a block is caused by a Spigot bug + * + *The Spigot bug currently makes every right click of some blocks trigger twice, causing the portal to close + * immediately, or causing portal information printing twice. This fix should detect the bug without breaking + * clicking once the bug is fixed.
* * @param eventThe event causing the right click
* @param blockThe block to check
* @returnTrue if the click is a bug and should be cancelled
*/ private boolean clickIsBug(PlayerInteractEvent event, Block block) { - if (MaterialHelper.isWallCoral(block.getType())) { - if (previousEvent != null && - event.getPlayer() == previousEvent.getPlayer() && eventTime + 15 > System.currentTimeMillis()) { - previousEvent = null; - eventTime = 0; - return true; - } - previousEvent = event; - eventTime = System.currentTimeMillis(); + if (previousEvent != null && + event.getPlayer() == previousEvent.getPlayer() && eventTime + 15 > System.currentTimeMillis()) { + previousEvent = null; + eventTime = 0; + return true; } + previousEvent = event; + eventTime = System.currentTimeMillis(); return false; } diff --git a/src/main/java/net/knarcraft/stargate/portal/PortalSignDrawer.java b/src/main/java/net/knarcraft/stargate/portal/PortalSignDrawer.java index b86b566..c84a1d1 100644 --- a/src/main/java/net/knarcraft/stargate/portal/PortalSignDrawer.java +++ b/src/main/java/net/knarcraft/stargate/portal/PortalSignDrawer.java @@ -63,9 +63,11 @@ public class PortalSignDrawer { Block signBlock = portal.getSignLocation().getBlock(); BlockState state = signBlock.getState(); if (!(state instanceof Sign sign)) { - Stargate.logWarning("Sign block is not a Sign object"); - Stargate.debug("Portal::drawSign", String.format("Block: %s @ %s", signBlock.getType(), - signBlock.getLocation())); + if (!portal.getOptions().hasNoSign()) { + Stargate.logWarning("Sign block is not a Sign object"); + Stargate.debug("Portal::drawSign", String.format("Block: %s @ %s", signBlock.getType(), + signBlock.getLocation())); + } return null; } return sign; @@ -122,7 +124,6 @@ public class PortalSignDrawer { } clearSign(sign); sign.setLine(0, portal.getName()); - sign.setLine(3, errorColor + Stargate.getString("signInvalidGate")); sign.update(); } diff --git a/src/main/java/net/knarcraft/stargate/portal/property/PortalOption.java b/src/main/java/net/knarcraft/stargate/portal/property/PortalOption.java index 438a5f1..9b4cce3 100644 --- a/src/main/java/net/knarcraft/stargate/portal/property/PortalOption.java +++ b/src/main/java/net/knarcraft/stargate/portal/property/PortalOption.java @@ -53,7 +53,12 @@ public enum PortalOption { /** * This option allows a portal which does not display a teleportation message, for better immersion */ - SILENT('i', "stargate.option.silent", 21); + SILENT('i', "stargate.option.silent", 21), + + /** + * This option causes a fixed portal's sign to be removed after creation + */ + NO_SIGN('e', "stargate.option.nosign", 22); private final char characterRepresentation; private final String permissionString; diff --git a/src/main/java/net/knarcraft/stargate/portal/property/PortalOptions.java b/src/main/java/net/knarcraft/stargate/portal/property/PortalOptions.java index 5a3d892..03cf40f 100644 --- a/src/main/java/net/knarcraft/stargate/portal/property/PortalOptions.java +++ b/src/main/java/net/knarcraft/stargate/portal/property/PortalOptions.java @@ -25,12 +25,17 @@ public class PortalOptions { if (this.isAlwaysOn() && !isFixed) { this.options.put(PortalOption.ALWAYS_ON, false); - Stargate.debug("Portal", "Can not create a non-fixed always-on gate. Setting AlwaysOn = false"); + Stargate.debug("PortalOptions", "Can not create a non-fixed always-on gate. Setting AlwaysOn = false"); } if ((this.isRandom() || this.isBungee()) && !this.isAlwaysOn()) { this.options.put(PortalOption.ALWAYS_ON, true); - Stargate.debug("Portal", "Gate marked as random or bungee, set to always-on"); + Stargate.debug("PortalOptions", "Gate marked as random or bungee, set to always-on"); + } + + if (this.hasNoSign() && !this.isFixed) { + this.options.put(PortalOption.NO_SIGN, false); + Stargate.debug("PortalOptions", "Gate marked with no sign, but not fixed. Setting NoSign = false"); } } @@ -177,4 +182,15 @@ public class PortalOptions { return this.options.get(PortalOption.SILENT); } + /** + * Gets whether this portal has no sign + * + *An always-on portal is allowed to not have a sign as it will never be interacted with anyway.
+ * + * @returnWhether this portal has no sign
+ */ + public boolean hasNoSign() { + return this.options.get(PortalOption.NO_SIGN); + } + } diff --git a/src/main/java/net/knarcraft/stargate/utility/PortalFileHelper.java b/src/main/java/net/knarcraft/stargate/utility/PortalFileHelper.java index a283300..73d933b 100644 --- a/src/main/java/net/knarcraft/stargate/utility/PortalFileHelper.java +++ b/src/main/java/net/knarcraft/stargate/utility/PortalFileHelper.java @@ -122,7 +122,8 @@ public final class PortalFileHelper { builder.append(options.isNoNetwork()).append(':'); builder.append(options.isRandom()).append(':'); builder.append(options.isBungee()).append(':'); - builder.append(options.isSilent()); + builder.append(options.isSilent()).append(':'); + builder.append(options.hasNoSign()); } /** diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 391d6d6..79570e2 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -98,6 +98,7 @@ permissions: stargate.option.nonetwork: true stargate.option.random: true stargate.option.silent: true + stargate.option.nosign: true stargate.option.hidden: description: Allows the creation of a hidden stargate default: false @@ -125,6 +126,9 @@ permissions: stargate.option.silent: description: Allows the creation of a stargate which does not output anything to the chat default: false + stargate.option.nosign: + description: Allows the creation of a stargate which has no sign + default: false stargate.admin.hidden: description: Allows this player to see all hidden stargates default: false