SPIGOT-6832: Further improve Player#getPing docs

This commit is contained in:
md_5 2021-12-04 08:19:20 +11:00
parent 9115281ff1
commit 1c9ca40548
No known key found for this signature in database
GPG key ID: E8E901AC7C617C11

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
*/