Add WorldRenderTownIconEvent

.gitignore

@@ -8,6 +8,10 @@
 # IntelliJ
 out/
 
+# Ecplise
+/.classpath
+/.project
+
 # Compiled class file
 *.class
 
@@ -110,4 +114,4 @@ buildNumber.properties
 .flattened-pom.xml
 
 # Common working directory
-run/
+run/

maptowny-api/src/main/java/me/silverwolfg11/maptowny/events/WorldRenderTownIconEvent.java

@@ -0,0 +1,143 @@
+/*
+ * Copyright (c) 2021 Silverwolfg11
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package me.silverwolfg11.maptowny.events;
+
+import me.silverwolfg11.maptowny.objects.MarkerOptions;
+import me.silverwolfg11.maptowny.objects.Polygon;
+import org.bukkit.Bukkit;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+import java.util.UUID;
+
+/**
+ * Event called when a town icon marker is about to be rendered on the web-map for a specific world.
+ *
+ * Cancelling this event will prevent this town icon marker from being rendered in the world on the Pl3xMap.
+ */
+public class WorldRenderTownIconEvent extends Event implements Cancellable {
+    private static final HandlerList handlers = new HandlerList();
+
+    private final String worldName;
+    private final String townName;
+    private final UUID townUUID;
+    private String iconKey;
+    private final MarkerOptions.Builder markerOptionsBuilder;
+
+    private boolean cancelled = false;
+
+    public WorldRenderTownIconEvent(String worldName, String townName, UUID townUUID, String iconKey, MarkerOptions.Builder markerOptionsBuilder) {
+        super(!Bukkit.isPrimaryThread());
+        this.worldName = worldName;
+        this.townName = townName;
+        this.townUUID = townUUID;
+        this.iconKey = iconKey;
+        this.markerOptionsBuilder = markerOptionsBuilder;
+    }
+
+    /**
+     * Get the name of the town being rendered.
+     *
+     * @return name of town being rendered.
+     */
+    @NotNull
+    public String getTownName() {
+        return townName;
+    }
+
+    /**
+     * Get the UUID of the town being rendered.
+     *
+     * @return uuid of town being rendered.
+     */
+    @NotNull
+    public UUID getTownUUID() {
+        return townUUID;
+    }
+
+    /**
+     * Get the name of the world where the town is being rendered.
+     *
+     * @return name of world.
+     */
+    @NotNull
+    public String getWorldName() {
+        return worldName;
+    }
+
+    /**
+     * Get the name of the iconKey.
+     *
+     * @return name of the iconKey that will render at the town's homeblock.
+     */
+    @NotNull
+    public String getIconKey() {
+        return iconKey;
+    }
+
+    /**
+     * Set the name of the iconKey to use for this town. If the supplied iconKey
+     * if not registered in the {@link MapPlatform} no icon will render for the town.
+     * 
+     * @param iconKey String key name that is registered in the {@link MapPlatform}.
+     */
+    public void setIconKey(String iconKey) {
+        this.iconKey = iconKey;
+    }
+
+    /**
+     * Get the marker options for the town icon marker.
+     *
+     * NOTE: These options are directly modifiable: the only options used for icons
+     * are name, clickToolTip and hoverToolTip. Other modifications will have no effect.
+     *
+     * @return marker options for the town's homeblock marker.
+     */
+    @NotNull
+    public MarkerOptions.Builder getMarkerOptions() {
+        return markerOptionsBuilder;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return cancelled;
+    }
+
+    @Override
+    public void setCancelled(boolean cancel) {
+        this.cancelled = cancel;
+    }
+
+    @NotNull
+    @Override
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+}

maptowny-plugin/src/main/java/me/silverwolfg11/maptowny/managers/TownyLayerManager.java

@@ -26,6 +26,7 @@
 import com.palmergames.bukkit.towny.object.Town;
 import me.silverwolfg11.maptowny.MapTowny;
 import me.silverwolfg11.maptowny.events.WorldRenderTownEvent;
+import me.silverwolfg11.maptowny.events.WorldRenderTownIconEvent;
 import me.silverwolfg11.maptowny.objects.LayerOptions;
 import me.silverwolfg11.maptowny.objects.MapConfig;
 import me.silverwolfg11.maptowny.objects.MarkerOptions;
@@ -281,6 +282,10 @@ public void renderTown(TownRenderEntry tre) {
 
                 worldProvider.addMultiPolyMarker(townKey, parts, optionsBuilder.build());
 
+                // Replace the tooltips to what our optionsBuilder has, as it might be altered via the event.
+                clickTooltip = optionsBuild.clickToolTip();
+                hoverTooltip = optionsBuild.hoverToolTip();
+
                 // Add outpost markers for the current world
                 renderOutpostMarker(tre, worldName, worldProvider, config.getIconSizeX(), config.getIconSizeY());
 
@@ -291,15 +296,22 @@ public void renderTown(TownRenderEntry tre) {
                     final String iconKey = tre.isCapital() ? CAPITAL_ICON : TOWN_ICON;
                     // Check if icon exists
                     if (homeblockPoint.isPresent() && mapPlatform.hasIcon(iconKey)) {
-                        MarkerOptions iconOptions = MarkerOptions.builder()
+                        MarkerOptions.Builder iconOptionsBuilder = MarkerOptions.builder()
                                                                  .name(tre.getTownName())
                                                                  .clickTooltip(clickTooltip)
-                                                                 .hoverTooltip(hoverTooltip)
-                                                                 .build();
+                                                                 .hoverTooltip(hoverTooltip);
+
+                        // Call icon event.
+                        WorldRenderTownIconEvent event = new WorldRenderTownIconEvent(worldName, tre.getTownName(), tre.getTownUUID(), iconKey, iconOptionsBuilder)
+                        Bukkit.getPluginManager().callEvent(event);
+
+                        // Skip rendering the town icon for the world if it is cancelled or the iconKey doesn't exist.
+                        if (event.isCancelled() || !mapPlatform.hasIcon(event.getIconKey()))
+                            continue;
 
-                        worldProvider.addIconMarker(townIconKey, iconKey, homeblockPoint.get(),
+                        worldProvider.addIconMarker(townIconKey, event.getIconKey(), homeblockPoint.get(),
                                                     config.getIconSizeX(), config.getIconSizeY(),
-                                                    iconOptions);
+                                                    iconOptionsBuilder.build());
                     }
                 }
             }