api/2.4.1 - Cloud for commands, ping command, more api

api/build.gradle.kts

@@ -1,8 +1,24 @@
 plugins {
+    // Allow blossom to mark sources root of templates
+    idea
     id("geyser.publish-conventions")
+    alias(libs.plugins.blossom)
 }
 
 dependencies {
     api(libs.base.api)
     api(libs.math)
-}
+}
+
+version = property("version")!!
+val apiVersion = (version as String).removeSuffix("-SNAPSHOT")
+
+sourceSets {
+    main {
+        blossom {
+            javaSources {
+                property("version", apiVersion)
+            }
+        }
+    }
+}

api/src/main/java-templates/org.geysermc.geyser.api/BuildData.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2024 GeyserMC. http://geysermc.org
+ *
+ * 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.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.api;
+
+import org.geysermc.api.util.ApiVersion;
+
+/**
+ * Not a public API. For internal use only. May change without notice.
+ * This class is processed before compilation to insert build properties.
+ */
+class BuildData {
+    static final String VERSION = "{{ version }}";
+    static final ApiVersion API_VERSION;
+
+    static {
+        String[] parts = VERSION.split("\\.");
+        if (parts.length != 3) {
+            throw new RuntimeException("Invalid api version: " + VERSION);
+        }
+
+        try {
+            int human = Integer.parseInt(parts[0]);
+            int major = Integer.parseInt(parts[1]);
+            int minor = Integer.parseInt(parts[2]);
+            API_VERSION = new ApiVersion(human, major, minor);
+        } catch (Exception e) {
+            throw new RuntimeException("Invalid api version: " + VERSION, e);
+        }
+    }
+}

api/src/main/java/org/geysermc/geyser/api/GeyserApi.java

@@ -29,6 +29,7 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.geysermc.api.Geyser;
 import org.geysermc.api.GeyserApiBase;
+import org.geysermc.api.util.ApiVersion;
 import org.geysermc.geyser.api.command.CommandSource;
 import org.geysermc.geyser.api.connection.GeyserConnection;
 import org.geysermc.geyser.api.event.EventBus;
@@ -169,4 +170,14 @@ public interface GeyserApi extends GeyserApiBase {
     static GeyserApi api() {
         return Geyser.api(GeyserApi.class);
     }
+
+    /**
+     * Returns the {@link ApiVersion} representing the current Geyser api version.
+     * See the <a href="https://github.com/geysermc/api/blob/master/geyser-versioning.md">Geyser version outline</a>)
+     *
+     * @return the current geyser api version
+     */
+     default ApiVersion geyserApiVersion() {
+        return BuildData.API_VERSION;
+     }
 }

api/src/main/java/org/geysermc/geyser/api/command/Command.java

@@ -28,7 +28,9 @@
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.geysermc.geyser.api.GeyserApi;
 import org.geysermc.geyser.api.connection.GeyserConnection;
+import org.geysermc.geyser.api.event.lifecycle.GeyserRegisterPermissionsEvent;
 import org.geysermc.geyser.api.extension.Extension;
+import org.geysermc.geyser.api.util.TriState;
 
 import java.util.Collections;
 import java.util.List;
@@ -58,15 +60,15 @@ public interface Command {
      * Gets the permission node associated with
      * this command.
      *
-     * @return the permission node for this command
+     * @return the permission node for this command if defined, otherwise an empty string
      */
     @NonNull
     String permission();
 
     /**
-     * Gets the aliases for this command.
+     * Gets the aliases for this command, as an unmodifiable list
      *
-     * @return the aliases for this command
+     * @return the aliases for this command as an unmodifiable list
      */
     @NonNull
     List<String> aliases();
@@ -75,35 +77,39 @@ public interface Command {
      * Gets if this command is designed to be used only by server operators.
      *
      * @return if this command is designated to be used only by server operators.
+     * @deprecated this method is not guaranteed to provide meaningful or expected results.
      */
-    boolean isSuggestedOpOnly();
+    @Deprecated(forRemoval = true)
+    default boolean isSuggestedOpOnly() {
+        return false;
+    }
 
     /**
-     * Gets if this command is executable on console.
-     *
-     * @return if this command is executable on console
+     * @return true if this command is executable on console
+     * @deprecated use {@link #isPlayerOnly()} instead (inverted)
      */
-    boolean isExecutableOnConsole();
+    @Deprecated(forRemoval = true)
+    default boolean isExecutableOnConsole() {
+        return !isPlayerOnly();
+    }
 
     /**
-     * Gets the subcommands associated with this
-     * command. Mainly used within the Geyser Standalone
-     * GUI to know what subcommands are supported.
-     *
-     * @return the subcommands associated with this command
+     * @return true if this command can only be used by players
      */
-    @NonNull
-    default List<String> subCommands() {
-        return Collections.emptyList();
-    }
+    boolean isPlayerOnly();
 
     /**
-     * Used to send a deny message to Java players if this command can only be used by Bedrock players.
-     *
-     * @return true if this command can only be used by Bedrock players.
+     * @return true if this command can only be used by Bedrock players
      */
-    default boolean isBedrockOnly() {
-        return false;
+    boolean isBedrockOnly();
+
+    /**
+     * @deprecated this method will always return an empty immutable list
+     */
+    @Deprecated(forRemoval = true)
+    @NonNull
+    default List<String> subCommands() {
+        return Collections.emptyList();
     }
 
     /**
@@ -128,86 +134,119 @@ interface Builder<T extends CommandSource> {
          * is an instance of this source.
          *
          * @param sourceType the source type
-         * @return the builder
+         * @return this builder
          */
         Builder<T> source(@NonNull Class<? extends T> sourceType);
 
         /**
          * Sets the command name.
          *
          * @param name the command name
-         * @return the builder
+         * @return this builder
          */
         Builder<T> name(@NonNull String name);
 
         /**
          * Sets the command description.
          *
          * @param description the command description
-         * @return the builder
+         * @return this builder
          */
         Builder<T> description(@NonNull String description);
 
         /**
-         * Sets the permission node.
+         * Sets the permission node required to run this command. <br>
+         * It will not be registered with any permission registries, such as an underlying server,
+         * or a permissions Extension (unlike {@link #permission(String, TriState)}).
          *
          * @param permission the permission node
-         * @return the builder
+         * @return this builder
          */
         Builder<T> permission(@NonNull String permission);
 
+        /**
+         * Sets the permission node and its default value. The usage of the default value is platform dependant
+         * and may or may not be used. For example, it may be registered to an underlying server.
+         * <p>
+         * Extensions may instead listen for {@link GeyserRegisterPermissionsEvent} to register permissions,
+         * especially if the same permission is required by multiple commands. Also see this event for TriState meanings.
+         *
+         * @param permission the permission node
+         * @param defaultValue the node's default value
+         * @return this builder
+         * @deprecated this method is experimental and may be removed in the future
+         */
+        @Deprecated
+        Builder<T> permission(@NonNull String permission, @NonNull TriState defaultValue);
+
         /**
          * Sets the aliases.
          *
          * @param aliases the aliases
-         * @return the builder
+         * @return this builder
          */
         Builder<T> aliases(@NonNull List<String> aliases);
 
         /**
          * Sets if this command is designed to be used only by server operators.
          *
          * @param suggestedOpOnly if this command is designed to be used only by server operators
-         * @return the builder
+         * @return this builder
+         * @deprecated this method is not guaranteed to produce meaningful or expected results
          */
+        @Deprecated(forRemoval = true)
         Builder<T> suggestedOpOnly(boolean suggestedOpOnly);
 
         /**
          * Sets if this command is executable on console.
          *
          * @param executableOnConsole if this command is executable on console
-         * @return the builder
+         * @return this builder
+         * @deprecated use {@link #isPlayerOnly()} instead (inverted)
          */
+        @Deprecated(forRemoval = true)
         Builder<T> executableOnConsole(boolean executableOnConsole);
 
         /**
-         * Sets the subcommands.
+         * Sets if this command can only be executed by players.
          *
-         * @param subCommands the subcommands
-         * @return the builder
+         * @param playerOnly if this command is player only
+         * @return this builder
          */
-        Builder<T> subCommands(@NonNull List<String> subCommands);
+        Builder<T> playerOnly(boolean playerOnly);
 
         /**
-         * Sets if this command is bedrock only.
+         * Sets if this command can only be executed by bedrock players.
          *
          * @param bedrockOnly if this command is bedrock only
-         * @return the builder
+         * @return this builder
          */
         Builder<T> bedrockOnly(boolean bedrockOnly);
 
+        /**
+         * Sets the subcommands.
+         *
+         * @param subCommands the subcommands
+         * @return this builder
+         * @deprecated this method has no effect
+         */
+        @Deprecated(forRemoval = true)
+        default Builder<T> subCommands(@NonNull List<String> subCommands) {
+            return this;
+        }
+
         /**
          * Sets the {@link CommandExecutor} for this command.
          *
          * @param executor the command executor
-         * @return the builder
+         * @return this builder
          */
         Builder<T> executor(@NonNull CommandExecutor<T> executor);
 
         /**
          * Builds the command.
          *
-         * @return the command
+         * @return a new command from this builder
          */
         @NonNull
         Command build();

api/src/main/java/org/geysermc/geyser/api/command/CommandSource.java

@@ -26,6 +26,10 @@
 package org.geysermc.geyser.api.command;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.geysermc.geyser.api.connection.GeyserConnection;
+
+import java.util.UUID;
 
 /**
  * Represents an instance capable of sending commands.
@@ -64,6 +68,17 @@ default void sendMessage(String[] messages) {
      */
     boolean isConsole();
 
+    /**
+     * @return a Java UUID if this source represents a player, otherwise null
+     */
+    @Nullable UUID playerUuid();
+
+    /**
+     * @return a GeyserConnection if this source represents a Bedrock player that is connected
+     * to this Geyser instance, otherwise null
+     */
+    @Nullable GeyserConnection connection();
+
     /**
      * Returns the locale of the command source.
      *

api/src/main/java/org/geysermc/geyser/api/connection/GeyserConnection.java

@@ -132,4 +132,9 @@ public interface GeyserConnection extends Connection, CommandSource {
     @Deprecated
     @NonNull
     Set<String> fogEffects();
+
+    /**
+     * Returns the current ping of the connection.
+     */
+    int ping();
 }

api/src/main/java/org/geysermc/geyser/api/entity/EntityData.java

@@ -81,4 +81,10 @@ public interface EntityData {
      * @return whether the movement is locked
      */
     boolean isMovementLocked();
+
+    /**
+     * Sends a request to the Java server to switch the items in the main and offhand.
+     * There is no guarantee of the server accepting the request.
+     */
+    void switchHands();
 }

api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineCommandsEvent.java

@@ -50,7 +50,7 @@ public interface GeyserDefineCommandsEvent extends Event {
     /**
      * Gets all the registered built-in {@link Command}s.
      *
-     * @return all the registered built-in commands
+     * @return all the registered built-in commands as an unmodifiable map
      */
     @NonNull
     Map<String, Command> commands();