GH-1134 Add permissions allowing to ignore sleep count for night skip and phantom spawn (#1135)

* Add sleep controllers for ignore sleeping and preventing spawn of phantoms when holding appropriate permission

* Add a new line between static field and class declaration

* Update eternalcore-core/src/main/java/com/eternalcode/core/feature/sleep/PlayerJoinSleepController.java

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* improve event fields and add javadoc

* Update PhantomSpawnAttemptEvent.java

Co-authored-by: Piotr Zych <[email protected]>

* Update PhantomSpawnAttemptEvent.java

Co-authored-by: Piotr Zych <[email protected]>

* Update PhantomSpawnAttemptEvent.java

Co-authored-by: Piotr Zych <[email protected]>

* Update PhantomSpawnAttemptEvent.java

Co-authored-by: Piotr Zych <[email protected]>

* Update PhantomSpawnAttemptEvent.java

Co-authored-by: Piotr Zych <[email protected]>

* Update PlayerJoinSleepController.java

Co-authored-by: Piotr Zych <[email protected]>

* Update PhantomSpawnAttemptEvent.java

Co-authored-by: Piotr Zych <[email protected]>

* Adjust event field names to P1otrulla's demands

* remove duplicate code to fix build

* Update eternalcore-core/src/main/java/com/eternalcode/core/feature/sleep/PhantomSpawnController.java

Co-authored-by: Norbert Dejlich <[email protected]>

* Update eternalcore-core/src/main/java/com/eternalcode/core/feature/sleep/PlayerJoinSleepController.java

Co-authored-by: Norbert Dejlich <[email protected]>

* Update eternalcore-core/src/main/java/com/eternalcode/core/feature/sleep/PhantomSpawnController.java

Co-authored-by: Norbert Dejlich <[email protected]>

* inline field

* Update PhantomSpawnController.java

Co-authored-by: Michał Wojtas <[email protected]>

* Update PlayerJoinSleepController.java

Co-authored-by: Michał Wojtas <[email protected]>

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Piotr Zych <[email protected]>
Co-authored-by: Norbert Dejlich <[email protected]>
Co-authored-by: Michał Wojtas <[email protected]>

Author: 5 people

eternalcore-core/src/main/java/com/eternalcode/core/feature/sleep/PhantomSpawnController.java

@@ -0,0 +1,34 @@
+package com.eternalcode.core.feature.sleep;
+
+import com.eternalcode.annotations.scan.permission.PermissionDocs;
+import com.eternalcode.core.injector.annotations.Inject;
+import com.eternalcode.core.injector.annotations.component.Controller;
+import com.eternalcode.paper.phantom.PhantomEventInitializer;
+import com.eternalcode.paper.phantom.PhantomSpawnAttemptEvent;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.Listener;
+import org.bukkit.plugin.Plugin;
+
+@Controller
+@PermissionDocs(
+    name = "Phantom Spawn Ignore",
+    permission = "eternalcore.sleep.noinsomnia",
+    description = "Player with this permission will not spawn phantoms"
+)
+class PhantomSpawnController implements Listener {
+
+    @Inject
+    PhantomSpawnController(Plugin plugin) {
+        new PhantomEventInitializer(plugin).initialize();
+    }
+
+    @EventHandler
+    void onPhantomSpawnAttempt(PhantomSpawnAttemptEvent event) {
+        if (event.getEntity() instanceof Player player) {
+            if (player.hasPermission("eternalcore.sleep.noinsomnia")) {
+                event.setCancelled(true);
+            }
+        }
+    }
+}

eternalcore-core/src/main/java/com/eternalcode/core/feature/sleep/PlayerJoinSleepController.java

@@ -0,0 +1,27 @@
+package com.eternalcode.core.feature.sleep;
+
+import com.eternalcode.annotations.scan.permission.PermissionDocs;
+import com.eternalcode.core.injector.annotations.component.Controller;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.Listener;
+import org.bukkit.event.player.PlayerJoinEvent;
+
+@Controller
+@PermissionDocs(
+    name = "Sleep Ignore",
+    permission = "eternalcore.sleep.ignore",
+    description = "Player with this permission will ignore sleep count needed to skip the night"
+)
+class PlayerJoinSleepController implements Listener {
+
+    private static final String SLEEP_IGNORE_PERMISSION = "eternalcore.sleep.ignore";
+
+    @EventHandler
+    void onPlayerJoin(PlayerJoinEvent event) {
+        Player player = event.getPlayer();
+        if (player.hasPermission(SLEEP_IGNORE_PERMISSION)) {
+            player.setSleepingIgnored(true);
+        }
+    }
+}

eternalcore-paper/src/main/java/com/eternalcode/paper/phantom/PhantomEventInitializer.java

@@ -0,0 +1,17 @@
+package com.eternalcode.paper.phantom;
+
+import org.bukkit.Bukkit;
+import org.bukkit.plugin.Plugin;
+
+public class PhantomEventInitializer {
+
+    private final Plugin plugin;
+
+    public PhantomEventInitializer(Plugin plugin) {
+        this.plugin = plugin;
+    }
+
+    public void initialize() {
+        Bukkit.getPluginManager().registerEvents(new PhantomEventWrapper(), this.plugin);
+    }
+}

eternalcore-paper/src/main/java/com/eternalcode/paper/phantom/PhantomEventWrapper.java

@@ -0,0 +1,25 @@
+package com.eternalcode.paper.phantom;
+
+import com.destroystokyo.paper.event.entity.PhantomPreSpawnEvent;
+import org.bukkit.Bukkit;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
+import org.bukkit.event.Listener;
+
+class PhantomEventWrapper implements Listener {
+
+    @EventHandler(priority = EventPriority.HIGH)
+    void onPhantomSpawn(PhantomPreSpawnEvent event) {
+        PhantomSpawnAttemptEvent attemptEvent = new PhantomSpawnAttemptEvent(
+            event.getSpawningEntity(),
+            event.getSpawnLocation(),
+            event.getReason()
+        );
+
+        Bukkit.getPluginManager().callEvent(attemptEvent);
+
+        if (attemptEvent.isCancelled()) {
+            event.setCancelled(true);
+        }
+    }
+}

eternalcore-paper/src/main/java/com/eternalcode/paper/phantom/PhantomSpawnAttemptEvent.java

@@ -0,0 +1,59 @@
+package com.eternalcode.paper.phantom;
+
+import org.bukkit.Location;
+import org.bukkit.entity.Entity;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+import org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Internal event of {@link com.destroystokyo.paper.event.entity.PhantomPreSpawnEvent}
+ */
+public class PhantomSpawnAttemptEvent extends Event implements Cancellable {
+
+    private static final HandlerList HANDLER_LIST = new HandlerList();
+
+    private final Entity entity;
+    private final Location location;
+    private final SpawnReason spawnReason;
+    private boolean cancelled = false;
+
+    public PhantomSpawnAttemptEvent(Entity entity, Location location, SpawnReason spawnReason) {
+        this.entity = entity;
+        this.location = location;
+        this.spawnReason = spawnReason;
+    }
+
+    public Entity getEntity() {
+        return this.entity;
+    }
+
+    public Location getLocation() {
+        return this.location;
+    }
+
+    public SpawnReason getSpawnReason() {
+        return this.spawnReason;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return cancelled;
+    }
+
+    @Override
+    public void setCancelled(boolean cancelled) {
+        this.cancelled = cancelled;
+    }
+
+    @Override
+    public @NotNull HandlerList getHandlers() {
+        return HANDLER_LIST;
+    }
+
+    public static HandlerList getHandlerList() {
+        return HANDLER_LIST;
+    }
+}