Use new player abilities over adventure settings

Author: Kazzuk

api/src/main/java/org/cloudburstmc/api/Server.java

@@ -75,7 +75,7 @@ public interface Server {
 
     Map<UUID, ? extends Player> getOnlinePlayers();
 
-    GameMode getGamemode();
+    GameMode getGameMode();
 
     Level getDefaultLevel();
 

api/src/main/java/org/cloudburstmc/api/event/Cancellable.java

@@ -1,8 +1,5 @@
 package org.cloudburstmc.api.event;
 
-/**
- * Created by Nukkit Team.
- */
 public interface Cancellable {
 
     boolean isCancelled();

api/src/main/java/org/cloudburstmc/api/event/player/PlayerAbilityChangeEvent.java

@@ -0,0 +1,55 @@
+package org.cloudburstmc.api.event.player;
+
+import org.cloudburstmc.api.event.Cancellable;
+import org.cloudburstmc.api.player.Ability;
+import org.cloudburstmc.api.player.Player;
+
+/**
+ * Fired when a boolean ability flag on a player is about to change.
+ *
+ * <p>Plugins may redirect the outcome to a different value by calling
+ * {@link #setNewValue(boolean)}.</p>
+ */
+public final class PlayerAbilityChangeEvent extends PlayerEvent implements Cancellable {
+
+    private final Ability ability;
+    private final boolean oldValue;
+    private boolean newValue;
+
+    public PlayerAbilityChangeEvent(Player player, Ability ability, boolean oldValue, boolean newValue) {
+        super(player);
+        this.ability = ability;
+        this.oldValue = oldValue;
+        this.newValue = newValue;
+    }
+
+    /**
+     * The ability flag that is changing.
+     */
+    public Ability getAbility() {
+        return ability;
+    }
+
+    /**
+     * The value of the ability flag before this change is applied.
+     */
+    public boolean getOldValue() {
+        return oldValue;
+    }
+
+    /**
+     * The value that will be applied if this event is not cancelled.
+     */
+    public boolean getNewValue() {
+        return newValue;
+    }
+
+    /**
+     * Overrides the value that will be applied.
+     *
+     * @param newValue the value to apply to the ability flag
+     */
+    public void setNewValue(boolean newValue) {
+        this.newValue = newValue;
+    }
+}

api/src/main/java/org/cloudburstmc/api/event/player/PlayerGameModeChangeEvent.java

@@ -1,19 +1,106 @@
 package org.cloudburstmc.api.event.player;
 
+import net.kyori.adventure.text.Component;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.cloudburstmc.api.event.Cancellable;
 import org.cloudburstmc.api.player.GameMode;
 import org.cloudburstmc.api.player.Player;
 
+/**
+ * Called when a player's game mode is about to change.
+ */
 public final class PlayerGameModeChangeEvent extends PlayerEvent implements Cancellable {
 
-    protected final GameMode gamemode;
+    private final GameMode newGameMode;
+    private final Cause cause;
+    private boolean cancelled;
+    @Nullable
+    private Component cancelMessage;
 
-    public PlayerGameModeChangeEvent(Player player, GameMode newGameMode) {
+    /**
+     * @param player        the player whose game mode is changing
+     * @param newGameMode   the game mode being applied
+     * @param cause         the reason the game mode is changing
+     * @param cancelMessage the message sent to the command sender if the event is
+     *                      canceled, or {@code null} if no message should be sent.
+     *                      Only meaningful when the cause is {@link Cause#COMMAND}.
+     */
+    public PlayerGameModeChangeEvent(Player player, GameMode newGameMode, Cause cause, @Nullable Component cancelMessage) {
         super(player);
-        this.gamemode = newGameMode;
+        this.newGameMode = newGameMode;
+        this.cause = cause;
+        this.cancelMessage = cancelMessage;
     }
 
-    public GameMode getNewGamemode() {
-        return gamemode;
+    @Override
+    public boolean isCancelled() {
+        return cancelled;
+    }
+
+    @Override
+    public void setCancelled(boolean cancelled) {
+        this.cancelled = cancelled;
+    }
+
+    /**
+     * Returns the game mode the player is switching to.
+     */
+    public GameMode getNewGameMode() {
+        return newGameMode;
+    }
+
+    /**
+     * Returns the reason this game mode change was triggered.
+     */
+    public Cause getCause() {
+        return cause;
+    }
+
+    /**
+     * Returns the message that will be sent to the command sender if this event
+     * is canceled. Only meaningful when the cause is {@link Cause#COMMAND}.
+     *
+     * @return the cancel message, or {@code null} if none is set
+     */
+    @Nullable
+    public Component cancelMessage() {
+        return cancelMessage;
+    }
+
+    /**
+     * Sets the message that will be sent to the command sender if this event is
+     * canceled.
+     *
+     * @param cancelMessage the message to send, or {@code null} to suppress it
+     */
+    public void cancelMessage(@Nullable Component cancelMessage) {
+        this.cancelMessage = cancelMessage;
+    }
+
+    /**
+     * The reason a player's game mode was changed.
+     */
+    public enum Cause {
+        /**
+         * A plugin changed the player's game mode via {@link Player#setGameMode(GameMode)}.
+         */
+        PLUGIN,
+        /**
+         * The {@code /gamemode} command was used.
+         */
+        COMMAND,
+        /**
+         * The player's game mode was changed because the server's default game mode
+         * was applied (e.g. on join when {@code force-gamemode} is enabled).
+         *
+         * <p>The player may not be fully initialized when this cause is in use.
+         * Check {@link Player#isSpawned()} before modifying player state.</p>
+         */
+        DEFAULT_GAMEMODE,
+        /**
+         * Fallback cause for use by third-party code constructing this event
+         * without a specific reason.
+         */
+        UNKNOWN
     }
 }

api/src/main/java/org/cloudburstmc/api/event/server/QueryRegenerateEvent.java

@@ -2,6 +2,7 @@
 
 import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
 import org.cloudburstmc.api.Server;
+import org.cloudburstmc.api.player.GameMode;
 import org.cloudburstmc.api.player.Player;
 import org.cloudburstmc.api.plugin.PluginContainer;
 
@@ -49,7 +50,7 @@ public QueryRegenerateEvent(Server server, int timeout) {
         //this.listPlugins = server.getConfig().getSettings().isQueryPlugins();
         this.plugins = server.getPluginManager().getAllPlugins().toArray(new PluginContainer[0]);
         this.players = server.getOnlinePlayers().values().toArray(new Player[0]);
-        this.gameType = server.getGamemode().isSurvival() ? "SMP" : "CMP";
+        this.gameType = server.getGameMode() == GameMode.SURVIVAL ? "SMP" : "CMP";
         this.version = server.getVersion();
         this.server_engine = server.getName() + " " + server.getImplementationVersion();
         this.map = server.getDefaultLevel() == null ? "unknown" : server.getDefaultLevel().getName();

api/src/main/java/org/cloudburstmc/api/player/Ability.java

@@ -0,0 +1,24 @@
+package org.cloudburstmc.api.player;
+
+/**
+ * Boolean ability flags that can be granted or revoked on a player.
+ */
+public enum Ability {
+    BUILD,
+    MINE,
+    DOORS_AND_SWITCHES,
+    OPEN_CONTAINERS,
+    ATTACK_PLAYERS,
+    ATTACK_MOBS,
+    OPERATOR_COMMANDS,
+    TELEPORT,
+    INVULNERABLE,
+    FLYING,
+    MAY_FLY,
+    INSTABUILD,
+    LIGHTNING,
+    MUTED,
+    WORLD_BUILDER,
+    NO_CLIP,
+    PRIVILEGED_BUILDER
+}