SPIGOT-6832: Further improve Player#getPing docs

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

View File

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