Merge branch 'api-8' into api-9

Author: zml2008

.github/workflows/ci.yaml

@@ -10,6 +10,9 @@ on:
   release:
     types: [released]
 
+env:
+  PROJECT_NAME: spongeapi
+
 jobs:
   build:
     # Only run on PRs if the source branch is on someone else's repo
@@ -23,6 +26,8 @@ jobs:
       # Setup
       - name: Check out
         uses: actions/checkout@v2
+        with:
+          ssh-key: ${{ secrets.SPONGE_JD_DEPLOY_KEY }}
       - name: Setup JDK 16
         uses: actions/setup-java@v2
         with:
@@ -60,13 +65,15 @@ jobs:
       - name: Determine status
         if: "${{ runner.os == 'Linux' }}"
         run: |
-          if [ "$(./gradlew properties | awk '/^version:/ { print $2; }' | grep '\-SNAPSHOT')" ]; then
+          VERSION=$(./gradlew :properties | awk '/^version:/ { print $2; }')
+          if [ "$(echo $VERSION | grep '\-SNAPSHOT')" ]; then
             echo "STATUS=snapshot" >> $GITHUB_ENV
           else
             echo "STATUS=release" >> $GITHUB_ENV
           fi
-      - name: Publish with Gradle (snapshot)
-        if: "${{ runner.os == 'Linux' && env.STATUS != 'release' && github.event_name == 'push' && startsWith(github.ref, 'refs/heads/api-') }}"
+          echo "PROJECT_VERSION=$VERSION" >> $GITHUB_ENV
+      - name: Publish with Gradle
+        if: "${{ runner.os == 'Linux' && ((env.STATUS != 'release' && github.event_name == 'push' && startsWith(github.ref, 'refs/heads/api-')) || (env.STATUS == 'release' && github.event_name == 'release')) }}"
         run: ./gradlew -PforceSign=true publish
         env:
           ORG_GRADLE_PROJECT_githubPackagesUsername: "${{ github.actor }}"
@@ -79,17 +86,17 @@ jobs:
           ORG_GRADLE_PROJECT_sonatypePassword: "${{ secrets.SPONGE_MAVEN_OSSRH_PASSWORD }}"
           ORG_GRADLE_PROJECT_spongeSigningKey: "${{ secrets.SPONGE_SIGNING_KEY }}"
           ORG_GRADLE_PROJECT_spongeSigningPassword: "${{ secrets.SPONGE_SIGNING_PASSWORD }}"
-      - name: Publish with Gradle (release)
-        if: "${{ runner.os == 'Linux' && env.STATUS == 'release' && github.event_name == 'release' }}"
-        run: ./gradlew publish
-        env:
-          ORG_GRADLE_PROJECT_githubPackagesUsername: "${{ github.actor }}"
-          ORG_GRADLE_PROJECT_githubPackagesPassword: "${{ secrets.GITHUB_TOKEN }}"
-          ORG_GRADLE_PROJECT_spongeSnapshotRepo: "${{ secrets.SPONGE_MAVEN_SNAPSHOT_REPO_URL }}"
-          ORG_GRADLE_PROJECT_spongeReleaseRepo: "${{ secrets.SPONGE_MAVEN_RELEASE_REPO_URL }}"
-          ORG_GRADLE_PROJECT_spongeUsername: "${{ secrets.SPONGE_MAVEN_REPO_USER }}"
-          ORG_GRADLE_PROJECT_spongePassword: "${{ secrets.SPONGE_MAVEN_REPO_PASSWORD }}"
-          ORG_GRADLE_PROJECT_sonatypeUsername: "${{ secrets.SPONGE_MAVEN_OSSRH_USER }}"
-          ORG_GRADLE_PROJECT_sonatypePassword: "${{ secrets.SPONGE_MAVEN_OSSRH_PASSWORD }}"
-          ORG_GRADLE_PROJECT_spongeSigningKey: "${{ secrets.SPONGE_SIGNING_KEY }}"
-          ORG_GRADLE_PROJECT_spongeSigningPassword: "${{ secrets.SPONGE_SIGNING_PASSWORD }}"
+      - name: Publish Javadoc
+        if: "${{ runner.os == 'Linux' && ((env.STATUS != 'release' && github.event_name == 'push' && startsWith(github.ref, 'refs/heads/api-')) || (env.STATUS == 'release' && github.event_name == 'release')) }}"
+        run: |
+          git clone [email protected]:SpongePowered/APIJavadocs.git publish-jd -b data -c core.sshCommand="$(git config --local --get core.sshCommand)" -c user.name=Spongie -c user.email="[email protected]"
+          cd publish-jd
+          DESTDIR="$PROJECT_NAME/$PROJECT_VERSION"
+          rm -rf $DESTDIR
+          mkdir -p $DESTDIR
+          cp -R ../build/docs/javadoc/* $DESTDIR
+          git add .
+          git commit -m "Publishing javadoc for $PROJECT_NAME $PROJECT_VERSION"
+          git push origin
+          cd ..
+          rm -rf publish-jd

gradle.properties

@@ -6,7 +6,7 @@ projectDescription=A plugin API for Minecraft: Java Edition
 
 org.gradle.parallel=true
 
-adventureVersion=4.8.0
+adventureVersion=4.8.1
 caffeineVersion=3.0.2
 configurateVersion=4.1.1
 errorproneVersion=2.7.1

src/main/java/org/spongepowered/api/data/Keys.java

@@ -200,6 +200,7 @@
 import org.spongepowered.api.item.ItemType;
 import org.spongepowered.api.item.ItemTypes;
 import org.spongepowered.api.item.enchantment.Enchantment;
+import org.spongepowered.api.item.enchantment.EnchantmentTypes;
 import org.spongepowered.api.item.inventory.Inventory;
 import org.spongepowered.api.item.inventory.ItemStack;
 import org.spongepowered.api.item.inventory.ItemStackSnapshot;
@@ -342,6 +343,12 @@ public final class Keys {
      */
     public static final Key<Value<Ticks>> ATTACK_TIME = Keys.key(ResourceKey.sponge("attack_time"), Ticks.class);
 
+    /**
+     * Remaining ticks of the auto spin attack a {@link Living} is doing.
+     * @see #IS_AUTO_SPIN_ATTACK
+     */
+    public static final Key<Value<Ticks>> AUTO_SPIN_ATTACK_TICKS = Keys.key(ResourceKey.sponge("auto_spin_attack_ticks"), Ticks.class);
+
     /**
      * The author of a {@link ItemTypes#WRITTEN_BOOK} {@link ItemStack}.
      */
@@ -1176,6 +1183,12 @@ public final class Keys {
      */
     public static final Key<Value<Boolean>> IS_ATTACHED = Keys.key(ResourceKey.sponge("is_attached"), Boolean.class);
 
+    /**
+     * Whether a {@link Living} is doing an auto spin attack (doable with the {@link EnchantmentTypes#RIPTIDE} enchantment.)
+     * @see #AUTO_SPIN_ATTACK_TICKS
+     */
+    public static final Key<Value<Boolean>> IS_AUTO_SPIN_ATTACK = Keys.key(ResourceKey.sponge("is_auto_spin_attack"), Boolean.class);
+
     /**
      * Whether an entity is begging for food.
      * e.g. {@link Cat cats} or tamed {@link Wolf wolves}

src/main/java/org/spongepowered/api/event/entity/AttackEntityEvent.java

@@ -281,7 +281,7 @@ public interface AttackEntityEvent extends Event, Cancellable {
      *
      * @return The list of damage modifier functions
      */
-    List<? extends ModifierFunction<DamageModifier>> originalFunctions();
+    List<DamageFunction> originalFunctions();
 
     /**
      * Gets the "base" damage to deal to the targeted {@link Entity}. The

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

@@ -123,7 +123,7 @@ default Optional<? extends Player> closestPlayer(final int x, final int y, final
      * This gets a guaranteed {@link Chunk} at the desired block position; however,
      * the {@link Chunk} instance may be {@link Chunk#isEmpty() empty}, and
      * likewise, may not be generated, valid, pre-existing. It is important to
-     * check for these cases prior to attmepting to modify the chunk.
+     * check for these cases prior to attempting to modify the chunk.
      *
      * <p>Note that this is still different from {@link #chunk(Vector3i)}
      * due to it being a relative block position which can vary depending on
@@ -140,7 +140,7 @@ default Optional<? extends Player> closestPlayer(final int x, final int y, final
      * This gets a guaranteed {@link Chunk} at the desired block position; however,
      * the {@link Chunk} instance may be {@link Chunk#isEmpty() empty}, and
      * likewise, may not be generated, valid, pre-existing. It is important to
-     * check for these cases prior to attmepting to modify the chunk.
+     * check for these cases prior to attempting to modify the chunk.
      *
      * <p>Note that this is still different from {@link #chunk(Vector3i)}
      * due to the relative block position dictated by {@link Server#chunkLayout()},
@@ -156,10 +156,10 @@ default Optional<? extends Player> closestPlayer(final int x, final int y, final
 
     /**
      * {@inheritDoc}
-     * This gets a guaranteed {@link Chunk} at the desired block position; however,
+     * This gets a guaranteed {@link Chunk} at the desired chunk position; however,
      * the {@link Chunk} instance may be {@link Chunk#isEmpty() empty}, and
      * likewise, may not be generated, valid, pre-existing. It is important to
-     * check for these cases prior to attmepting to modify the chunk.
+     * check for these cases prior to attempting to modify the chunk.
      *
      * @param chunkPos The chunk position relative to the {@link Server#chunkLayout() chunk layout}
      * @return The available chunk at that position
@@ -172,10 +172,10 @@ default Chunk chunk(final Vector3i chunkPos) {
 
     /**
      * {@inheritDoc}
-     * This gets a guaranteed {@link Chunk} at the desired block position; however,
+     * This gets a guaranteed {@link Chunk} at the desired chunk position; however,
      * the {@link Chunk} instance may be {@link Chunk#isEmpty() empty}, and
      * likewise, may not be generated, valid, pre-existing. It is important to
-     * check for these cases prior to attmepting to modify the chunk.
+     * check for these cases prior to attempting to modify the chunk.
      *
      * @param cx The x chunk coordinate
      * @param cy The y coordinate

src/main/java/org/spongepowered/api/world/volume/Volume.java

@@ -24,6 +24,8 @@
  */
 package org.spongepowered.api.world.volume;
 
+import org.spongepowered.api.world.chunk.Chunk;
+import org.spongepowered.api.world.server.ServerWorld;
 import org.spongepowered.math.vector.Vector3i;
 
 import java.util.Objects;
@@ -62,11 +64,33 @@ default boolean containsBlock(final Vector3i position) {
      */
     boolean containsBlock(int x, int y, int z);
 
+    /**
+     * Returns true if {@link #containsBlock(Vector3i)} is true and the
+     * backing data is actually loaded - e.g. for a {@link ServerWorld}, this
+     * will only return true if the {@link Chunk} that contains this co-ordinate
+     * is fully loaded.
+     *
+     * @param position The position to check
+     * @return Whether or not the position has a block in this volume
+     *         <strong>and</strong> the location is loaded.
+     */
     default boolean isAreaAvailable(final Vector3i position) {
         Objects.requireNonNull(position, "position");
 
         return this.isAreaAvailable(position.x(), position.y(), position.z());
     }
 
+    /**
+     * Returns true if {@link #containsBlock(int, int, int)} is true and the
+     * backing data is actually loaded - e.g. for a {@link ServerWorld}, this
+     * will only return true if the {@link Chunk} that contains this co-ordinate
+     * is fully loaded.
+     *
+     * @param x The X coordinate to check
+     * @param y The Y coordinate to check
+     * @param z The Z coordinate to check
+     * @return Whether or not the position has a block in this volume
+     *         <strong>and</strong> the location is loaded.
+     */
     boolean isAreaAvailable(int x, int y, int z);
 }