Merge remote-tracking branch 'origin/api-8' into api-9

Author: ImMorpheus

build.gradle.kts

@@ -51,20 +51,18 @@ dependencies {
 
     // Adventure
     api(platform("net.kyori:adventure-bom:$adventureVersion"))
-    api("net.kyori:adventure-api") {
-        exclude(group = "org.checkerframework", module = "checker-qual")
-    }
+    api("net.kyori:adventure-api")
     api("net.kyori:adventure-text-serializer-gson") {
-        exclude(group = "org.checkerframework", module = "checker-qual")
         exclude(group = "com.google.code.gson", module = "gson")
         exclude(group = "net.kyori", module = "adventure-api")
     }
     api("net.kyori:adventure-text-serializer-legacy") {
-        exclude(group = "org.checkerframework", module = "checker-qual")
         exclude(group = "net.kyori", module = "adventure-api")
     }
     api("net.kyori:adventure-text-serializer-plain") {
-        exclude(group = "org.checkerframework", module = "checker-qual")
+        exclude(group = "net.kyori", module = "adventure-api")
+    }
+    api("net.kyori:adventure-text-minimessage") {
         exclude(group = "net.kyori", module = "adventure-api")
     }
 

gradle.properties

@@ -6,7 +6,7 @@ projectDescription=A plugin API for Minecraft: Java Edition
 
 org.gradle.parallel=true
 
-adventureVersion=4.9.3
+adventureVersion=4.10.0
 caffeineVersion=3.0.4
 configurateVersion=4.1.2
 errorproneVersion=2.10.0

src/main/java/org/spongepowered/api/adventure/SpongeComponents.java

@@ -27,6 +27,7 @@
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.event.ClickEvent;
+import net.kyori.adventure.text.flattener.ComponentFlattener;
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.command.CommandCause;
 import org.spongepowered.api.registry.DefaultedRegistryReference;
@@ -99,6 +100,17 @@ public static Component resolve(
         return SpongeComponents.factory().render(component, senderContext, resolver, otherResolvers);
     }
 
+    /**
+     * Get a {@link ComponentFlattener} with access to server-specific information
+     *
+     * <p>This flattener can be used for custom formats where translatable strings should be localized server-side.</p>
+     *
+     * @return The flattener
+     */
+    public static ComponentFlattener flattener() {
+        return SpongeComponents.factory().flattener();
+    }
+
     private static Factory factory() {
         return Sponge.game().factoryProvider().provide(Factory.class);
     }
@@ -123,5 +135,7 @@ Component render(
             final DefaultedRegistryReference<ResolveOperation>... otherResolvers
         );
 
+        ComponentFlattener flattener();
+
     }
 }

src/main/java/org/spongepowered/api/item/inventory/ItemStack.java

@@ -25,6 +25,8 @@
 package org.spongepowered.api.item.inventory;
 
 import net.kyori.adventure.text.ComponentLike;
+import net.kyori.adventure.text.event.HoverEvent;
+import net.kyori.adventure.text.event.HoverEventSource;
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.block.BlockSnapshot;
 import org.spongepowered.api.block.BlockState;
@@ -57,7 +59,7 @@
  * use {@link ValueContainer#get(Key)} in order to retrieve information regarding
  * this item stack.</p>
  */
-public interface ItemStack extends SerializableDataHolder.Mutable, ComponentLike {
+public interface ItemStack extends SerializableDataHolder.Mutable, ComponentLike, HoverEventSource<HoverEvent.ShowItem> {
 
     /**
      * Returns an empty {@link ItemStack}.

src/main/java/org/spongepowered/api/world/DefaultWorldKeys.java

@@ -25,19 +25,46 @@
 package org.spongepowered.api.world;
 
 import org.spongepowered.api.ResourceKey;
+import org.spongepowered.api.Sponge;
 import org.spongepowered.api.world.server.ServerWorld;
 
 /**
  * A listing of the {@link ResourceKey keys} of the default {@link ServerWorld worlds} in Minecraft.
  */
 public final class DefaultWorldKeys {
 
+    /**
+     * @deprecated Use {@link #DEFAULT} instead
+     */
+    @Deprecated
     public static final ResourceKey OVERWORLD = ResourceKey.minecraft("overworld");
 
-    public static final ResourceKey THE_NETHER = ResourceKey.minecraft("the_nether");
+    /**
+     * The default "world" of a running game session. Typically, the Overworld.
+     * <p>
+     * Refer to: <a href="https://minecraft.fandom.com/wiki/Overworld">Overworld</a>
+     */
+    public static final ResourceKey DEFAULT = Sponge.game().factoryProvider().provide(DefaultWorldKeys.Factory.class).defaultWorld();
 
-    public static final ResourceKey THE_END = ResourceKey.minecraft("the_end");
+    /**
+     * Refer to: <a href="https://minecraft.fandom.com/wiki/The_Nether">The Nether</a>
+     */
+    public static final ResourceKey THE_NETHER = Sponge.game().factoryProvider().provide(DefaultWorldKeys.Factory.class).theNether();
+
+    /**
+     * Refer to: <a href="https://minecraft.fandom.com/wiki/The_End">The End</a>
+     */
+    public static final ResourceKey THE_END = Sponge.game().factoryProvider().provide(DefaultWorldKeys.Factory.class).theEnd();
 
     private DefaultWorldKeys() {
     }
+
+    public interface Factory {
+
+        ResourceKey defaultWorld();
+
+        ResourceKey theNether();
+
+        ResourceKey theEnd();
+    }
 }

src/main/java/org/spongepowered/api/world/server/WorldManager.java

@@ -26,6 +26,7 @@
 
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.Server;
+import org.spongepowered.api.world.WorldType;
 import org.spongepowered.api.world.server.storage.ServerWorldProperties;
 
 import java.nio.file.Path;
@@ -73,7 +74,10 @@ public interface WorldManager {
      * <p>It is up to the implementation to define what the default world actually is.</p>
      *
      * @return The default world
+     *
+     * @deprecated Use {@link #world(ResourceKey)} with {@link org.spongepowered.api.world.DefaultWorldKeys#DEFAULT} instead
      */
+    @Deprecated
     ServerWorld defaultWorld();
 
     /**
@@ -128,9 +132,15 @@ default List<ResourceKey> offlineWorldKeys() {
      * @param uniqueId The unique id
      * @return The key or {@link Optional#empty()} if not found
      */
-    @Deprecated
     Optional<ResourceKey> worldKey(UUID uniqueId);
 
+    /**
+     * Retrieves all {@link ServerWorld worlds} that are of a particular {@link WorldType type}.
+     * @param type The type
+     * @return The {@link Collection worlds}
+     */
+    Collection<ServerWorld> worldsOfType(WorldType type);
+
     /**
      * Loads a {@link ServerWorld world} from a {@link WorldTemplate template}.
      *

src/main/java/org/spongepowered/api/world/server/storage/ServerWorldProperties.java

@@ -33,6 +33,7 @@
 import org.spongepowered.api.entity.living.trader.WanderingTrader;
 import org.spongepowered.api.util.Identifiable;
 import org.spongepowered.api.util.MinecraftDayTime;
+import org.spongepowered.api.util.Nameable;
 import org.spongepowered.api.util.Ticks;
 import org.spongepowered.api.world.SerializationBehavior;
 import org.spongepowered.api.world.WorldType;
@@ -46,7 +47,7 @@
 import java.util.Optional;
 import java.util.UUID;
 
-public interface ServerWorldProperties extends WorldProperties, Identifiable, ResourceKeyed, WeatherUniverse.Mutable {
+public interface ServerWorldProperties extends WorldProperties, Nameable, Identifiable, ResourceKeyed, WeatherUniverse.Mutable {
 
     /**
      * Gets the {@link ServerWorld} that correlates to this properties, if available.