Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-29 12:27:59 +01:00
Code Issues Projects Releases Wiki Activity

SPIGOT-6832: Further improve Player#getPing docs

Browse Source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot 2021-12-04 08:19:20 +11:00
parent 9a4caaec10
commit 440c99dc37
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
paper-api/src/main/java/org/bukkit/entity/Player.java
View File

@ -1301,12 +1301,12 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
* Gets the player's estimated ping in milliseconds.
*
* In Vanilla this value represents a weighted average of the response time
* to the last four application layer ping packets sent. This value does not
* represent the network round trip time and as such may have less
* granularity and be impacted by other sources. For these reasons it
* <b>should not</b> be used for anti-cheat purposes. Its recommended use is
* only as a <b>qualitative</b> indicator of connection quality (Vanilla
* uses it for this purpose in the tab list).
* to application layer ping packets sent. This value does not represent the
* network round trip time and as such may have less granularity and be
* impacted by other sources. For these reasons it <b>should not</b> be used
* for anti-cheat purposes. Its recommended use is only as a
* <b>qualitative</b> indicator of connection quality (Vanilla uses it for
* this purpose in the tab list).
*
* @return player ping
*/