Migrate WorldBorder API to use ticks (#13223)

Author: Doc94

paper-api/src/main/java/io/papermc/paper/event/world/border/WorldBorderBoundsChangeEvent.java

@@ -1,11 +1,14 @@
 package io.papermc.paper.event.world.border;
 
+import io.papermc.paper.util.Tick;
 import org.bukkit.World;
 import org.bukkit.WorldBorder;
 import org.bukkit.event.Cancellable;
 import org.bukkit.event.HandlerList;
 import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Range;
 import org.jspecify.annotations.NullMarked;
+import java.time.Duration;
 
 /**
  * Called when a world border changes its bounds, either over time, or instantly.
@@ -66,27 +69,49 @@ public void setNewSize(final double newSize) {
         this.newSize = Math.min(this.worldBorder.getMaxSize(), Math.max(1.0D, newSize));
     }
 
+    /**
+     * Gets the time in ticks for the change. Will be 0 if instant.
+     *
+     * @return the time in ticks for the change
+     */
+    public long getDurationTicks() {
+        return this.duration;
+    }
+
     /**
      * Gets the time in milliseconds for the change. Will be 0 if instant.
      *
      * @return the time in milliseconds for the change
+     * @deprecated in favor of {@link #getDurationTicks()}
      */
+    @Deprecated(forRemoval = true, since = "1.21.11")
     public long getDuration() {
-        return this.duration;
+        return Tick.of(this.duration).toMillis();
+    }
+
+    /**
+     * Sets the time in ticks for the change. Will change {@link #getType()} to return
+     * {@link Type#STARTED_MOVE}.
+     *
+     * @param duration the time in ticks for the change
+     */
+    public void setDurationTicks(@Range(from = 0, to = Integer.MAX_VALUE) final long duration) {
+        this.duration = Math.clamp(duration, 0L, Integer.MAX_VALUE);
+        if (this.type == Type.INSTANT_MOVE) {
+            this.type = Type.STARTED_MOVE;
+        }
     }
 
     /**
      * Sets the time in milliseconds for the change. Will change {@link #getType()} to return
      * {@link Type#STARTED_MOVE}.
      *
      * @param duration the time in milliseconds for the change
+     * @deprecated in favor of {@link #setDurationTicks(long)}
      */
+    @Deprecated(forRemoval = true, since = "1.21.11")
     public void setDuration(final long duration) {
-        // PAIL: TODO: Magic Values
-        this.duration = Math.min(9223372036854775L, Math.max(0L, duration));
-        if (duration >= 0 && this.type == Type.INSTANT_MOVE) {
-            this.type = Type.STARTED_MOVE;
-        }
+        this.setDurationTicks(Tick.tick().fromDuration(Duration.ofMillis(Math.clamp(duration, 0L, Integer.MAX_VALUE))));
     }
 
     @Override

paper-api/src/main/java/org/bukkit/WorldBorder.java

@@ -1,6 +1,9 @@
 package org.bukkit;
 
+import java.time.Duration;
 import java.util.concurrent.TimeUnit;
+import com.google.common.base.Preconditions;
+import io.papermc.paper.util.Tick;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -12,20 +15,19 @@ public interface WorldBorder {
      * @return the associated world, or null if this world border is not associated
      * with any specific world, such as those created via {@link Server#createWorldBorder()}
      */
-    @Nullable
-    public World getWorld();
+    @Nullable World getWorld();
 
     /**
      * Resets the border to default values.
      */
-    public void reset();
+    void reset();
 
     /**
      * Gets the current side length of the border.
      *
      * @return The current side length of the border.
      */
-    public double getSize();
+    double getSize();
 
     /**
      * Sets the border to a square region with the specified side length in blocks.
@@ -34,7 +36,7 @@ public interface WorldBorder {
      *
      * @throws IllegalArgumentException if newSize is less than 1.0D or greater than {@link #getMaxSize()}
      */
-    public void setSize(double newSize);
+    void setSize(double newSize);
 
     /**
      * Sets the border to a square region with the specified side length in blocks.
@@ -43,8 +45,24 @@ public interface WorldBorder {
      * @param seconds The time in seconds in which the border grows or shrinks from the previous size to that being set.
      *
      * @throws IllegalArgumentException if newSize is less than 1.0D or greater than {@link #getMaxSize()}
+     * @see #setSize(double, TimeUnit, long)
+     * @deprecated Use {@link #changeSize(double, long)} instead
      */
-    public void setSize(double newSize, long seconds);
+    @Deprecated(since = "1.21.11", forRemoval = true)
+    default void setSize(double newSize, long seconds) {
+        this.setSize(Math.min(this.getMaxSize(), Math.max(1.0D, newSize)), TimeUnit.SECONDS, Math.clamp(seconds, 0L, Integer.MAX_VALUE));
+    }
+
+    /**
+     * Sets the border to a square region with the specified side length in blocks.
+     *
+     * @param newSize The new side length of the border.
+     * @param ticks The time in ticks in which the border grows or shrinks from the previous size to that being set.
+     *
+     * @throws IllegalArgumentException if newSize is less than 1.0D or greater than {@link #getMaxSize()}
+     * @throws IllegalArgumentException if ticks are less than 0
+     */
+    void changeSize(double newSize, long ticks);
 
     /**
      * Sets the border to a square region with the specified side length in blocks.
@@ -54,16 +72,22 @@ public interface WorldBorder {
      * @param time The time in which the border grows or shrinks from the previous size to that being set.
      *
      * @throws IllegalArgumentException if unit is <code>null</code> or newSize is less than 1.0D or greater than {@link #getMaxSize()}
+     *
+     * @see Tick
+     * @deprecated Use {@link #changeSize(double, long)} instead
      */
-    public void setSize(double newSize, @NotNull TimeUnit unit, long time);
+    @Deprecated(since = "1.21.11", forRemoval = true)
+    default void setSize(double newSize, @NotNull TimeUnit unit, long time) {
+        Preconditions.checkArgument(unit != null, "TimeUnit cannot be null.");
+        this.changeSize(newSize, Tick.tick().fromDuration(Duration.of(time, unit.toChronoUnit())));
+    }
 
     /**
      * Gets the current border center.
      *
      * @return The current border center.
      */
-    @NotNull
-    public Location getCenter();
+    @NotNull Location getCenter();
 
     /**
      * Sets the new border center.
@@ -73,7 +97,7 @@ public interface WorldBorder {
      *
      * @throws IllegalArgumentException if the absolute value of x or z is higher than {@link #getMaxCenterCoordinate()}
      */
-    public void setCenter(double x, double z);
+    void setCenter(double x, double z);
 
     /**
      * Sets the new border center.
@@ -82,84 +106,106 @@ public interface WorldBorder {
      *
      * @throws IllegalArgumentException if location is <code>null</code> or the absolute value of {@link Location#getX()} or {@link Location#getZ()} is higher than {@link #getMaxCenterCoordinate()}
      */
-    public void setCenter(@NotNull Location location);
+    void setCenter(@NotNull Location location);
 
     /**
      * Gets the current border damage buffer.
      *
      * @return The current border damage buffer.
      */
-    public double getDamageBuffer();
+    double getDamageBuffer();
 
     /**
      * Sets the amount of blocks a player may safely be outside the border before taking damage.
      *
      * @param blocks The amount of blocks. (The default is 5 blocks.)
      */
-    public void setDamageBuffer(double blocks);
+    void setDamageBuffer(double blocks);
 
     /**
      * Gets the current border damage amount.
      *
      * @return The current border damage amount.
      */
-    public double getDamageAmount();
+    double getDamageAmount();
 
     /**
      * Sets the amount of damage a player takes when outside the border plus the border buffer.
      *
      * @param damage The amount of damage. (The default is 0.2 damage per second per block.)
      */
-    public void setDamageAmount(double damage);
+    void setDamageAmount(double damage);
 
     /**
      * Gets the current border warning time in seconds.
      *
      * @return The current border warning time in seconds.
+     * @deprecated Use {@link #getWarningTimeTicks()} instead
+     */
+    @Deprecated(since = "1.21.11", forRemoval = true)
+    default int getWarningTime() {
+        return (int) Tick.of(this.getWarningTimeTicks()).toSeconds();
+    }
+
+    /**
+     * Gets the current border warning time in ticks.
+     *
+     * @return The current border warning time in ticks.
+     */
+    int getWarningTimeTicks();
+
+    /**
+     * Sets the warning time that causes the screen to be tinted red when a contracting border will reach the player within the specified time.
+     *
+     * @param seconds The amount of time in seconds.
+     * @deprecated Use {@link #setWarningTimeTicks(int)} instead
      */
-    public int getWarningTime();
+    @Deprecated(since = "1.21.11", forRemoval = true)
+    default void setWarningTime(int seconds) {
+        this.setWarningTimeTicks(Tick.tick().fromDuration(Duration.ofSeconds(seconds)));
+    }
 
     /**
      * Sets the warning time that causes the screen to be tinted red when a contracting border will reach the player within the specified time.
      *
-     * @param seconds The amount of time in seconds. (The default is 15 seconds.)
+     * @param ticks The number of ticks.
      */
-    public void setWarningTime(int seconds);
+    void setWarningTimeTicks(int ticks);
 
     /**
      * Gets the current border warning distance.
      *
      * @return The current border warning distance.
      */
-    public int getWarningDistance();
+    int getWarningDistance();
 
     /**
      * Sets the warning distance that causes the screen to be tinted red when the player is within the specified number of blocks from the border.
      *
      * @param distance The distance in blocks. (The default is 5 blocks.)
      */
-    public void setWarningDistance(int distance);
+    void setWarningDistance(int distance);
 
     /**
      * Check if the specified location is inside this border.
      *
      * @param location the location to check
      * @return if this location is inside the border or not
      */
-    public boolean isInside(@NotNull Location location);
+    boolean isInside(@NotNull Location location);
 
     /**
      * Gets the maximum possible size of a WorldBorder.
      *
      * @return The maximum size the WorldBorder
      */
-    public double getMaxSize();
+    double getMaxSize();
 
     /**
      * Gets the absolute value of the maximum x/z center coordinate of a
      * WorldBorder.
      *
      * @return The absolute maximum center coordinate of the WorldBorder
      */
-    public double getMaxCenterCoordinate();
+    double getMaxCenterCoordinate();
 }

paper-server/patches/sources/net/minecraft/world/level/border/WorldBorder.java.patch

@@ -4,7 +4,7 @@
      double centerZ;
      int absoluteMaxSize = 29999984;
      WorldBorder.BorderExtent extent = new WorldBorder.StaticBorderExtent(5.999997E7F);
-+    public net.minecraft.server.level.ServerLevel world; // CraftBukkit
++    public net.minecraft.server.level.@org.jspecify.annotations.Nullable ServerLevel world; // CraftBukkit
 
      public WorldBorder() {
          this(WorldBorder.Settings.DEFAULT);
@@ -52,8 +52,8 @@
 +        if (this.world != null) {
 +            io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent event = new io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent(world.getWorld(), world.getWorld().getWorldBorder(), io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent.Type.INSTANT_MOVE, getSize(), size, 0);
 +            if (!event.callEvent()) return;
-+            if (event.getType() == io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent.Type.STARTED_MOVE && event.getDuration() > 0) { // If changed to a timed transition
-+                lerpSizeBetween(event.getOldSize(), event.getNewSize(), event.getDuration(), this.world.getGameTime());
++            if (event.getType() == io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent.Type.STARTED_MOVE && event.getDurationTicks() > 0) { // If changed to a timed transition
++                lerpSizeBetween(event.getOldSize(), event.getNewSize(), event.getDurationTicks(), this.world.getGameTime());
 +                return;
 +            }
 +            size = event.getNewSize();
@@ -77,7 +77,7 @@
 +            io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent event = new io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent(world.getWorld(), world.getWorld().getWorldBorder(), type, oldSize, newSize, time);
 +            if (!event.callEvent()) return;
 +            newSize = event.getNewSize();
-+            time = event.getDuration();
++            time = event.getDurationTicks();
 +        }
 +        // Paper end - Add worldborder events
          this.extent = (WorldBorder.BorderExtent)(oldSize == newSize
@@ -91,7 +91,7 @@
          this.listeners.add(listener);
      }
 
-@@ -298,6 +_,21 @@
+@@ -298,6 +_,22 @@
          }
      }
 
@@ -103,7 +103,8 @@
 +        this.setWarningBlocks(settings.warningBlocks());
 +        this.setWarningTime(settings.warningTime());
 +        if (settings.lerpTime() > 0L) {
-+            this.lerpSizeBetween(settings.size(), settings.lerpTarget(), settings.lerpTime(), this.world.getGameTime());
++            final long startTime = (this.world != null) ? this.world.getGameTime() : 0; // Virtual Borders don't have a World
++            this.lerpSizeBetween(settings.size(), settings.lerpTarget(), settings.lerpTime(), startTime);
 +        } else {
 +            this.setSize(settings.size());
 +        }

paper-server/src/main/java/org/bukkit/craftbukkit/CraftWorldBorder.java

@@ -1,7 +1,6 @@
 package org.bukkit.craftbukkit;
 
 import com.google.common.base.Preconditions;
-import java.util.concurrent.TimeUnit;
 import net.minecraft.core.BlockPos;
 import org.bukkit.Location;
 import org.bukkit.World;
@@ -39,22 +38,17 @@ public double getSize() {
 
     @Override
     public void setSize(double newSize) {
-        this.setSize(newSize, 0L);
+        this.changeSize(newSize, 0);
     }
 
     @Override
-    public void setSize(double newSize, long time) {
-        this.setSize(Math.min(this.getMaxSize(), Math.max(1.0D, newSize)), TimeUnit.SECONDS, Math.min(9223372036854775L, Math.max(0L, time)));
-    }
-
-    @Override
-    public void setSize(double newSize, TimeUnit unit, long time) {
-        Preconditions.checkArgument(unit != null, "TimeUnit cannot be null.");
-        Preconditions.checkArgument(time >= 0, "time cannot be lower than 0");
+    public void changeSize(double newSize, long ticks) {
+        Preconditions.checkArgument(ticks >= 0, "ticks cannot be lower than 0");
         Preconditions.checkArgument(newSize >= 1.0D && newSize <= this.getMaxSize(), "newSize must be between 1.0D and %s", this.getMaxSize());
 
-        if (time > 0L) {
-            this.handle.lerpSizeBetween(this.handle.getSize(), newSize, unit.toMillis(time), this.getWorld().getGameTime());
+        if (ticks > 0L) {
+            final long startTime = (this.getWorld() != null) ? this.getWorld().getGameTime() : 0; // Virtual Borders don't have a World
+            this.handle.lerpSizeBetween(this.handle.getSize(), newSize, ticks, startTime);
         } else {
             this.handle.setSize(newSize);
         }
@@ -102,13 +96,15 @@ public void setDamageAmount(double damage) {
     }
 
     @Override
-    public int getWarningTime() {
+    public int getWarningTimeTicks() {
         return this.handle.getWarningTime();
     }
 
     @Override
-    public void setWarningTime(int time) {
-        this.handle.setWarningTime(time);
+    public void setWarningTimeTicks(final int ticks) {
+        Preconditions.checkArgument(ticks >= 0, "ticks cannot be lower than 0");
+
+        this.handle.setWarningTime(ticks);
     }
 
     @Override