AFK API

purpur-api/paper-patches/files/src/main/java/org/bukkit/entity/Player.java.patch

@@ -1,6 +1,6 @@
 --- a/src/main/java/org/bukkit/entity/Player.java
 +++ b/src/main/java/org/bukkit/entity/Player.java
-@@ -3911,4 +_,13 @@
+@@ -3911,4 +_,33 @@
       */
      void sendEntityEffect(org.bukkit.@NotNull EntityEffect effect, @NotNull Entity target);
      // Paper end - entity effect API
@@ -12,5 +12,25 @@
 +     * @return true if player uses PurpurClient
 +     */
 +    public boolean usesPurpurClient();
++
++    /**
++     * Check if player is AFK
++     *
++     * @return True if AFK
++     */
++    boolean isAfk();
++
++    /**
++     * Set player as AFK
++     *
++     * @param setAfk Whether to set AFK or not
++     */
++    void setAfk(boolean setAfk);
++
++    /**
++     * Reset the idle timer back to 0
++     * @deprecated Use {@link #resetIdleDuration()} instead
++     */
++    void resetIdleTimer();
 +    // Purpur end
  }

purpur-api/src/main/java/org/purpurmc/purpur/event/PlayerAFKEvent.java

@@ -0,0 +1,71 @@
+package org.purpurmc.purpur.event;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
+import org.bukkit.event.player.PlayerEvent;
+import org.jetbrains.annotations.ApiStatus;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+@NullMarked
+public class PlayerAFKEvent extends PlayerEvent implements Cancellable {
+    private static final HandlerList handlers = new HandlerList();
+    private final boolean setAfk;
+    private boolean shouldKick;
+    private @Nullable String broadcast;
+    private boolean cancel;
+
+    @ApiStatus.Internal
+    public PlayerAFKEvent(Player player, boolean setAfk, boolean shouldKick, @Nullable String broadcast, boolean async) {
+        super(player, async);
+        this.setAfk = setAfk;
+        this.shouldKick = shouldKick;
+        this.broadcast = broadcast;
+    }
+
+    /**
+     * Whether player is going afk or coming back
+     *
+     * @return True if going afk. False is coming back
+     */
+    public boolean isGoingAfk() {
+        return setAfk;
+    }
+
+    public boolean shouldKick() {
+        return shouldKick;
+    }
+
+    public void setShouldKick(boolean shouldKick) {
+        this.shouldKick = shouldKick;
+    }
+
+    @Nullable
+    public String getBroadcastMsg() {
+        return broadcast;
+    }
+
+    public void setBroadcastMsg(@Nullable String broadcast) {
+        this.broadcast = broadcast;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return cancel;
+    }
+
+    @Override
+    public void setCancelled(boolean cancel) {
+        this.cancel = cancel;
+    }
+
+    @Override
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+}