chore: merge api-14 for updates

gabizou · gabizou · commit 7394a7b9b54f · 2025-03-14T19:18:47.000-07:00
Signed-off-by: Gabriel Harris-Rouquette &lt;gabizou@me.com&gt;
diff --git a/gradle/verification-metadata.xml b/gradle/verification-metadata.xml
@@ -3,6 +3,10 @@
    <configuration>
       <verify-metadata>true</verify-metadata>
       <verify-signatures>false</verify-signatures>
+      <trusted-artifacts>
+         <trust file=".*-javadoc[.]jar" regex="true"/>
+         <trust file=".*-sources[.]jar" regex="true"/>
+      </trusted-artifacts>
    </configuration>
    <components>
       <component group="aopalliance" name="aopalliance" version="1.0">
diff --git a/src/main/java/org/spongepowered/api/data/type/HandPreference.java b/src/main/java/org/spongepowered/api/data/type/HandPreference.java
@@ -36,6 +36,6 @@
  * <p>For players, this is controlled by the left hand/right hand setting</p>
  */
 @CatalogedBy(HandPreferences.class)
-public interface HandPreference extends DefaultedRegistryValue, ComponentLike {
+public interface HandPreference extends DefaultedRegistryValue, ComponentLike, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/entity/living/player/server/ServerPlayer.java b/src/main/java/org/spongepowered/api/entity/living/player/server/ServerPlayer.java
@@ -46,6 +46,7 @@
 import org.spongepowered.api.event.Cause;
 import org.spongepowered.api.item.inventory.Container;
 import org.spongepowered.api.item.inventory.Inventory;
+import org.spongepowered.api.network.ServerConnectionState;
 import org.spongepowered.api.network.ServerSideConnection;
 import org.spongepowered.api.scoreboard.Scoreboard;
 import org.spongepowered.api.service.permission.Subject;
@@ -184,6 +185,14 @@ default SetValue.Mutable<SkinPart> displayedSkinParts() {
      */
     ServerSideConnection connection();
 
+    /**
+     * Gets the appropriate {@link ServerConnectionState.Game} linking this player to a
+     * connection state.
+     *
+     * @return The connection state
+     */
+    ServerConnectionState.Game connectionState();
+
     /**
      * Gets this player's {@link TabList}.
      *
diff --git a/src/main/java/org/spongepowered/api/event/lifecycle/FreezeRegistryEvent.java b/src/main/java/org/spongepowered/api/event/lifecycle/FreezeRegistryEvent.java
@@ -0,0 +1,79 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * 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 org.spongepowered.api.event.lifecycle;
+
+import org.spongepowered.api.Engine;
+import org.spongepowered.api.ResourceKey;
+import org.spongepowered.api.event.GenericEvent;
+import org.spongepowered.api.registry.Registry;
+import org.spongepowered.api.registry.RegistryHolder;
+import org.spongepowered.api.registry.RegistryType;
+
+import java.util.function.Consumer;
+
+public interface FreezeRegistryEvent extends LifecycleEvent {
+
+    /**
+     * Fired after a layer has established its registries
+     * and is no longer accepting any type of modifications.
+     *
+     * <p><strong>Note:</strong> Layers might be reloadable!
+     * When a registry is being reloaded, this event is fired
+     * again for the relevant registries.</p>
+     */
+    interface Post extends FreezeRegistryEvent {
+
+        /**
+         * Gets the built {@link RegistryHolder registry holder}.
+         *
+         * @return The registry holder.
+         */
+        RegistryHolder holder();
+
+        /**
+         * <p>Fetch a registry by its type.</p>
+         *
+         * <p>The consumer will be called if it matches the current set of
+         * registries being created.</p>
+         *
+         * @param registryType The registry type to fetch.
+         * @param consumer The consumer to be called if found.
+         */
+        default <T> void registry(RegistryType<T> registryType, Consumer<Registry<T>> consumer) {
+            this.holder().findRegistry(registryType).ifPresent(consumer);
+        }
+
+        interface GameScoped extends Post {
+        }
+
+        interface EngineScoped<E extends Engine> extends Post, GenericEvent<E> {
+        }
+
+        interface WorldScoped extends Post {
+
+            ResourceKey worldKey();
+        }
+    }
+}
diff --git a/src/main/java/org/spongepowered/api/world/WorldType.java b/src/main/java/org/spongepowered/api/world/WorldType.java
@@ -24,6 +24,7 @@
  */
 package org.spongepowered.api.world;
 
+import org.spongepowered.api.Sponge;
 import org.spongepowered.api.data.Key;
 import org.spongepowered.api.data.value.Value;
 import org.spongepowered.api.datapack.DataPackSerializable;
@@ -36,6 +37,10 @@
 @CatalogedBy(WorldTypes.class)
 public interface WorldType extends DefaultedRegistryValue, ContextSource, WorldTypeDataFetcher, DataPackSerializable {
 
+    static WorldType.Builder builder() {
+        return Sponge.game().builderProvider().provide(WorldType.Builder.class);
+    }
+
     interface Builder extends org.spongepowered.api.util.Builder<WorldType, Builder>, CopyableBuilder<WorldType, Builder> {
 
         <V> Builder add(Key<? extends Value<V>> key, V value);
diff --git a/src/main/java/org/spongepowered/api/world/server/WorldArchetype.java b/src/main/java/org/spongepowered/api/world/server/WorldArchetype.java
@@ -0,0 +1,56 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * 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 org.spongepowered.api.world.server;
+
+import org.spongepowered.api.Sponge;
+import org.spongepowered.api.world.generation.config.WorldGenerationConfig;
+
+import java.util.Optional;
+
+public interface WorldArchetype {
+
+    static WorldArchetype.Builder builder() {
+        return Sponge.game().builderProvider().provide(WorldArchetype.Builder.class);
+    }
+
+    static WorldArchetype of(WorldArchetypeType type) {
+        return WorldArchetype.builder().type(type).build();
+    }
+
+    static WorldArchetype of(WorldArchetypeType type, WorldGenerationConfig generationConfig) {
+        return WorldArchetype.builder().type(type).generationConfig(generationConfig).build();
+    }
+
+    WorldArchetypeType type();
+
+    Optional<WorldGenerationConfig> generationConfig();
+
+    interface Builder extends org.spongepowered.api.util.Builder<WorldArchetype, Builder> {
+
+        Builder type(WorldArchetypeType type);
+
+        Builder generationConfig(WorldGenerationConfig generationConfig);
+    }
+}
diff --git a/src/main/java/org/spongepowered/api/world/server/storage/ServerWorldProperties.java b/src/main/java/org/spongepowered/api/world/server/storage/ServerWorldProperties.java
@@ -44,7 +44,7 @@
 import org.spongepowered.api.world.gamerule.GameRuleHolder;
 import org.spongepowered.api.world.generation.config.WorldGenerationConfig;
 import org.spongepowered.api.world.server.ServerWorld;
-import org.spongepowered.api.world.server.WorldArchetypeType;
+import org.spongepowered.api.world.server.WorldArchetype;
 import org.spongepowered.api.world.storage.WorldProperties;
 import org.spongepowered.api.world.weather.Weather;
 import org.spongepowered.api.world.weather.WeatherUniverse;
@@ -493,15 +493,15 @@ static LoadOptions getOrLoad(Consumer<ServerWorldProperties> getCallback, Consum
 
         /**
          * Load a new {@link ServerWorldProperties} from disk
-         * or create a new one with the provided {@link WorldArchetypeType}.
+         * or create a new one with the provided {@link WorldArchetype}.
          * Do not attempt to use the already loaded instance.
          *
          * <p>This operation fails if properties were already loaded.</p>
          *
          * @param worldArchetype The archetype to use for creation.
          * @return The load options.
          */
-        static LoadOptions loadOrCreate(WorldArchetypeType worldArchetype) {
+        static LoadOptions loadOrCreate(WorldArchetype worldArchetype) {
             return LoadOptions.builder()
                 .load()
                 .create(worldArchetype)
@@ -510,7 +510,7 @@ static LoadOptions loadOrCreate(WorldArchetypeType worldArchetype) {
 
         /**
          * Load a new {@link ServerWorldProperties} from disk
-         * or create a new one with the provided {@link WorldArchetypeType}.
+         * or create a new one with the provided {@link WorldArchetype}.
          * Do not attempt to use the already loaded instance.
          *
          * <p>This operation fails if properties were already loaded.</p>
@@ -520,7 +520,7 @@ static LoadOptions loadOrCreate(WorldArchetypeType worldArchetype) {
          *                       creation for additional configuration.
          * @return The load options.
          */
-        static LoadOptions loadOrCreate(WorldArchetypeType worldArchetype, Consumer<ServerWorldProperties> createCallback) {
+        static LoadOptions loadOrCreate(WorldArchetype worldArchetype, Consumer<ServerWorldProperties> createCallback) {
             return LoadOptions.builder()
                 .load()
                 .create(worldArchetype)
@@ -530,7 +530,7 @@ static LoadOptions loadOrCreate(WorldArchetypeType worldArchetype, Consumer<Serv
 
         /**
          * Load a new {@link ServerWorldProperties} from disk
-         * or create a new one with the provided {@link WorldArchetypeType}.
+         * or create a new one with the provided {@link WorldArchetype}.
          * Do not attempt to use the already loaded instance.
          *
          * <p>This operation fails if properties were already loaded.</p>
@@ -542,7 +542,7 @@ static LoadOptions loadOrCreate(WorldArchetypeType worldArchetype, Consumer<Serv
          *                       creation for additional configuration.
          * @return The load options.
          */
-        static LoadOptions loadOrCreate(Consumer<ServerWorldProperties> loadCallback, WorldArchetypeType worldArchetype, Consumer<ServerWorldProperties> createCallback) {
+        static LoadOptions loadOrCreate(Consumer<ServerWorldProperties> loadCallback, WorldArchetype worldArchetype, Consumer<ServerWorldProperties> createCallback) {
             return LoadOptions.builder()
                 .load()
                 .loadCallback(loadCallback)
@@ -554,12 +554,12 @@ static LoadOptions loadOrCreate(Consumer<ServerWorldProperties> loadCallback, Wo
         /**
          * Get the already loaded {@link ServerWorldProperties} or
          * attempt to load it from disk. If not found, create a new one
-         * with the provided {@link WorldArchetypeType}.
+         * with the provided {@link WorldArchetype}.
          *
          * @param worldArchetype The archetype to use for creation.
          * @return The load options.
          */
-        static LoadOptions getLoadOrCreate(WorldArchetypeType worldArchetype) {
+        static LoadOptions getLoadOrCreate(WorldArchetype worldArchetype) {
             return LoadOptions.builder()
                 .get()
                 .load()
@@ -570,14 +570,14 @@ static LoadOptions getLoadOrCreate(WorldArchetypeType worldArchetype) {
         /**
          * Get the already loaded {@link ServerWorldProperties} or
          * attempt to load it from disk. If not found, create a new one
-         * with the provided {@link WorldArchetypeType}.
+         * with the provided {@link WorldArchetype}.
          *
          * @param worldArchetype The archetype to use for creation.
          * @param createCallback The consumer to call after successful
          *                       creation for additional configuration.
          * @return The load options.
          */
-        static LoadOptions getLoadOrCreate(WorldArchetypeType worldArchetype, Consumer<ServerWorldProperties> createCallback) {
+        static LoadOptions getLoadOrCreate(WorldArchetype worldArchetype, Consumer<ServerWorldProperties> createCallback) {
             return LoadOptions.builder()
                 .get()
                 .load()
@@ -589,7 +589,7 @@ static LoadOptions getLoadOrCreate(WorldArchetypeType worldArchetype, Consumer<S
         /**
          * Get the already loaded {@link ServerWorldProperties} or
          * attempt to load it from disk. If not found, create a new one
-         * with the provided {@link WorldArchetypeType}.
+         * with the provided {@link WorldArchetype}.
          *
          * @param getCallback The consumer to call after successful
          *                    get operation for additional configuration.
@@ -600,7 +600,7 @@ static LoadOptions getLoadOrCreate(WorldArchetypeType worldArchetype, Consumer<S
          *                       creation for additional configuration.
          * @return The load options.
          */
-        static LoadOptions getLoadOrCreate(Consumer<ServerWorldProperties> getCallback, Consumer<ServerWorldProperties> loadCallback, WorldArchetypeType worldArchetype, Consumer<ServerWorldProperties> createCallback) {
+        static LoadOptions getLoadOrCreate(Consumer<ServerWorldProperties> getCallback, Consumer<ServerWorldProperties> loadCallback, WorldArchetype worldArchetype, Consumer<ServerWorldProperties> createCallback) {
             return LoadOptions.builder()
                 .get()
                 .getCallback(getCallback)
@@ -613,23 +613,23 @@ static LoadOptions getLoadOrCreate(Consumer<ServerWorldProperties> getCallback,
 
         /**
          * Create a new {@link ServerWorldProperties} with the given
-         * {@link WorldArchetypeType} but do not attempt to load
+         * {@link WorldArchetype} but do not attempt to load
          * it from disk or use the already loaded instance.
          *
          * <p>The operation fails if properties could not be created.</p>
          *
          * @param worldArchetype The archetype to use.
          * @return The load options.
          */
-        static LoadOptions create(WorldArchetypeType worldArchetype) {
+        static LoadOptions create(WorldArchetype worldArchetype) {
             return LoadOptions.builder()
                 .create(worldArchetype)
                 .build();
         }
 
         /**
          * Create a new {@link ServerWorldProperties} with the given
-         * {@link WorldArchetypeType} but do not attempt to load
+         * {@link WorldArchetype} but do not attempt to load
          * it from disk or use the already loaded instance.
          *
          * <p>The operation fails if properties could not be created.</p>
@@ -639,7 +639,7 @@ static LoadOptions create(WorldArchetypeType worldArchetype) {
          *                       creation for additional configuration.
          * @return The load options.
          */
-        static LoadOptions create(WorldArchetypeType worldArchetype, Consumer<ServerWorldProperties> createCallback) {
+        static LoadOptions create(WorldArchetype worldArchetype, Consumer<ServerWorldProperties> createCallback) {
             return LoadOptions.builder()
                 .create(worldArchetype)
                 .createCallback(createCallback)
@@ -685,7 +685,7 @@ interface LoadOperation {
 
         interface CreateOperation {
 
-            WorldArchetypeType worldArchetype();
+            WorldArchetype worldArchetype();
 
             Optional<Consumer<ServerWorldProperties>> createCallback();
         }
@@ -696,7 +696,7 @@ interface Builder extends org.spongepowered.api.util.Builder<LoadOptions, Builde
 
             Builder.LoadStep load();
 
-            Builder.CreateStep create(WorldArchetypeType worldArchetype);
+            Builder.CreateStep create(WorldArchetype worldArchetype);
 
             interface GetStep extends Builder {
 

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,6 @@`
`36`	`36`	`* <p>For players, this is controlled by the left hand/right hand setting</p>`
`37`	`37`	`*/`
`38`	`38`	`@CatalogedBy(HandPreferences.class)`
`39`		`-public interface HandPreference extends DefaultedRegistryValue, ComponentLike {`
	`39`	`+public interface HandPreference extends DefaultedRegistryValue, ComponentLike, StringRepresentable {`
`40`	`40`
`41`	`41`	`}`