From cdbf514918f7df77ca2f86a1bff5fce35efdb3bd Mon Sep 17 00:00:00 2001
From: themode <themode@outlook.fr>
Date: Wed, 18 Nov 2020 07:44:57 +0100
Subject: [PATCH] Player#getPlayerSynchronizationTickDelay comment

---
 src/main/java/net/minestom/server/entity/Player.java | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/main/java/net/minestom/server/entity/Player.java b/src/main/java/net/minestom/server/entity/Player.java
index 126575812..0ef819fe4 100644
--- a/src/main/java/net/minestom/server/entity/Player.java
+++ b/src/main/java/net/minestom/server/entity/Player.java
@@ -108,6 +108,12 @@ public class Player extends LivingEntity implements CommandSender {
         Player.playerSynchronizationGroup = playerSynchronizationGroup;
     }
 
+    /**
+     * Gets the number of tick between each position synchronization.
+     *
+     * @param viewersCount the player viewers count
+     * @return the number of tick between each position synchronization.
+     */
     public static int getPlayerSynchronizationTickDelay(int viewersCount) {
         return viewersCount / playerSynchronizationGroup + 1;
     }