PaperMC/patches/api/0438-Add-player-idle-duration-API.patch
2024-01-16 19:27:39 +01:00

41 lines
1.5 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: booky10 <boooky10@gmail.com>
Date: Sat, 14 Oct 2023 03:11:11 +0200
Subject: [PATCH] Add player idle duration API
Implements API for getting and resetting a player's idle duration.
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
index 8ca61bca18c5520d20b0405d5add37759349560b..c09f423fe2a029c933bd2697c8ff104fc4230cf0 100644
--- a/src/main/java/org/bukkit/entity/Player.java
+++ b/src/main/java/org/bukkit/entity/Player.java
@@ -3508,6 +3508,29 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
void increaseWardenWarningLevel();
// Paper end
+ // Paper start
+ /**
+ * The idle duration is reset when the player
+ * sends specific action packets.
+ * <p>
+ * After the idle duration exceeds {@link org.bukkit.Bukkit#getIdleTimeout()}, the
+ * player will be kicked for {@link org.bukkit.event.player.PlayerKickEvent.Cause#IDLING}.
+ *
+ * @return the current idle duration of this player
+ */
+ @NotNull Duration getIdleDuration();
+
+ /**
+ * Resets this player's idle duration.
+ * <p>
+ * After the idle duration exceeds {@link org.bukkit.Bukkit#getIdleTimeout()}, the
+ * player will be kicked for {@link org.bukkit.event.player.PlayerKickEvent.Cause#IDLING}.
+ *
+ * @see #getIdleDuration()
+ */
+ void resetIdleDuration();
+ // Paper end
+
@NotNull
@Override
Spigot spigot();