Merge pull request #776 from DRE2N/events; resolves #661

New event API

core/src/main/java/de/erethon/dungeonsxl/event/DataReloadEvent.java → api/src/main/java/de/erethon/dungeonsxl/api/event/DataReloadEvent.java

@@ -1,26 +1,26 @@
 /*
- * Copyright (C) 2012-2020 Frank Baumann
+ * Copyright (C) 2014-2020 Daniel Saukel
  *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ * This library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNULesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package de.erethon.dungeonsxl.event;
+package de.erethon.dungeonsxl.api.event;
 
 import org.bukkit.event.Cancellable;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 
 /**
+ * Fired when the plugin is reloaded with /dxl reload.
+ *
  * @author Daniel Saukel
  */
 public class DataReloadEvent extends Event implements Cancellable {

api/src/main/java/de/erethon/dungeonsxl/api/event/group/GroupCollectRewardEvent.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright (C) 2014-2020 Daniel Saukel
+ *
+ * This library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNULesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package de.erethon.dungeonsxl.api.event.group;
+
+import de.erethon.dungeonsxl.api.Reward;
+import de.erethon.dungeonsxl.api.player.GamePlayer;
+import de.erethon.dungeonsxl.api.player.PlayerGroup;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
+
+/**
+ * Fired when a group collects a reward.
+ * <p>
+ * In the default implementation, this happens when a player opens a reward chest.
+ *
+ * @author Daniel Saukel
+ */
+public class GroupCollectRewardEvent extends GroupEvent implements Cancellable {
+
+    private static final HandlerList handlers = new HandlerList();
+    private boolean cancelled;
+
+    private GamePlayer collector;
+    private Reward reward;
+
+    public GroupCollectRewardEvent(PlayerGroup group, GamePlayer collector, Reward reward) {
+        super(group);
+        this.collector = collector;
+        this.reward = reward;
+    }
+
+    /**
+     * Returns the player who collected the reward.
+     * <p>
+     * Note that this may be null if addons add a way to give rewards that cannot be attributed to one collector.
+     *
+     * @return the player who collected the reward
+     */
+    public GamePlayer getCollector() {
+        return collector;
+    }
+
+    /**
+     * Returns the reward the group collected.
+     *
+     * @return the reward the group collected
+     */
+    public Reward getReward() {
+        return reward;
+    }
+
+    /**
+     * Sets the reward the group collected.
+     *
+     * @param reward the reward
+     */
+    public void setReward(Reward reward) {
+        this.reward = reward;
+    }
+
+    @Override
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return cancelled;
+    }
+
+    @Override
+    public void setCancelled(boolean cancelled) {
+        this.cancelled = cancelled;
+    }
+
+}

api/src/main/java/de/erethon/dungeonsxl/api/event/group/GroupCreateEvent.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright (C) 2014-2020 Daniel Saukel
+ *
+ * This library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNULesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package de.erethon.dungeonsxl.api.event.group;
+
+import de.erethon.dungeonsxl.api.player.GlobalPlayer;
+import de.erethon.dungeonsxl.api.player.PlayerGroup;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
+
+/**
+ * Fired when a group is created explicitly or implicitly.
+ *
+ * @author Daniel Saukel
+ */
+public class GroupCreateEvent extends GroupEvent implements Cancellable {
+
+    /**
+     * The reason why the group is created.
+     */
+    public enum Cause {
+
+        ANNOUNCER,
+        COMMAND,
+        /**
+         * When a group is created to mirror the state of a party plugin.
+         *
+         * @see de.erethon.dungeonsxl.api.player.GroupAdapter
+         */
+        GROUP_ADAPTER,
+        GROUP_SIGN,
+        /**
+         * When a group is created by an addon.
+         */
+        CUSTOM
+
+    }
+
+    private static final HandlerList handlers = new HandlerList();
+    private boolean cancelled;
+
+    private GlobalPlayer creator;
+    private Cause cause;
+
+    public GroupCreateEvent(PlayerGroup group, GlobalPlayer creator, Cause cause) {
+        super(group);
+        this.creator = creator;
+        this.cause = cause;
+    }
+
+    /**
+     * Returns the player who created the group.
+     *
+     * @return the player who created the group
+     */
+    public GlobalPlayer getCreator() {
+        return creator;
+    }
+
+    /**
+     * Returns the cause for the group creation.
+     *
+     * @return the cause for the group creation
+     */
+    public Cause getCause() {
+        return cause;
+    }
+
+    @Override
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return cancelled;
+    }
+
+    @Override
+    public void setCancelled(boolean cancelled) {
+        this.cancelled = cancelled;
+    }
+
+}

api/src/main/java/de/erethon/dungeonsxl/api/event/group/GroupDisbandEvent.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright (C) 2014-2020 Daniel Saukel
+ *
+ * This library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNULesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package de.erethon.dungeonsxl.api.event.group;
+
+import de.erethon.dungeonsxl.api.player.GlobalPlayer;
+import de.erethon.dungeonsxl.api.player.PlayerGroup;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
+
+/**
+ * Fired when a group is disbanded.
+ *
+ * @author Daniel Saukel
+ */
+public class GroupDisbandEvent extends GroupEvent implements Cancellable {
+
+    public enum Cause {
+
+        COMMAND,
+        DUNGEON_FINISHED,
+        GROUP_ADAPTER,
+        GROUP_IS_EMPTY,
+        LOST,
+        CUSTOM
+
+    }
+
+    private static final HandlerList handlers = new HandlerList();
+    private boolean cancelled;
+
+    private GlobalPlayer disbander;
+    private Cause cause;
+
+    public GroupDisbandEvent(PlayerGroup group, Cause cause) {
+        super(group);
+        this.cause = cause;
+    }
+
+    public GroupDisbandEvent(PlayerGroup group, GlobalPlayer disbander, Cause cause) {
+        super(group);
+        this.disbander = disbander;
+        this.cause = cause;
+    }
+
+    /**
+     * The player who disbanded the group.
+     * <p>
+     * This is null if the cause is {@link Cause#DUNGEON_FINISHED}, {@link Cause#GROUP_ADAPTER}, {@link Cause#LOST} or {@link Cause#CUSTOM}.
+     *
+     * @return the player who disbanded the group
+     */
+    public GlobalPlayer getDisbander() {
+        return disbander;
+    }
+
+    /**
+     * Returns the cause for the group deletion.
+     *
+     * @return the cause for the group deletion
+     */
+    public Cause getCause() {
+        return cause;
+    }
+
+    @Override
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return cancelled;
+    }
+
+    @Override
+    public void setCancelled(boolean cancelled) {
+        this.cancelled = cancelled;
+    }
+
+}

api/src/main/java/de/erethon/dungeonsxl/api/event/dungeon/DungeonEvent.java → api/src/main/java/de/erethon/dungeonsxl/api/event/group/GroupEvent.java

@@ -12,31 +12,31 @@
  * You should have received a copy of the GNU Lesser General Public License along with
  * this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package de.erethon.dungeonsxl.api.event.dungeon;
+package de.erethon.dungeonsxl.api.event.group;
 
-import de.erethon.dungeonsxl.api.dungeon.Dungeon;
+import de.erethon.dungeonsxl.api.player.PlayerGroup;
 import org.bukkit.event.Event;
 
 /**
- * Superclass for events involving {@link Dungeon}s.
+ * Superclass for events involving DungeonsXL groups.
  *
  * @author Daniel Saukel
  */
-public abstract class DungeonEvent extends Event {
+public abstract class GroupEvent extends Event {
 
-    protected Dungeon dungeon;
+    protected PlayerGroup group;
 
-    protected DungeonEvent(Dungeon dungeon) {
-        this.dungeon = dungeon;
+    protected GroupEvent(PlayerGroup group) {
+        this.group = group;
     }
 
     /**
-     * Returns the dungeon involved in this event.
+     * Returns the group involved in this event.
      *
-     * @return the dungeon involved in this event
+     * @return the group involved in this event
      */
-    public Dungeon getDungeon() {
-        return dungeon;
+    public PlayerGroup getGroup() {
+        return group;
     }
 
 }