From a71c2da3f8ee329977902a36274d720908a77c48 Mon Sep 17 00:00:00 2001
From: madmaxoft
Date: Wed, 30 Jul 2014 17:07:57 +0200
Subject: APIDump: Added notes about cache to cMojangAPI.
---
MCServer/Plugins/APIDump/APIDesc.lua | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
(limited to 'MCServer')
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 692ca80ac..2a8ae90f9 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1619,7 +1619,13 @@ a_Player:OpenWindow(Window);
Mojang uses two formats for UUIDs, short and dashed. MCServer works with short UUIDs internally, but
will convert to dashed UUIDs where needed - in the protocol login for example. The MakeUUIDShort()
and MakeUUIDDashed() functions are provided for plugins to use for conversion between the two
- formats.
+ formats.
+
+ This class will cache values returned by the API service. The cache will hold the values for 7 days
+ by default, after that, they will no longer be available. This is in order to not let the server get
+ banned from using the API service, since they are rate-limited to 600 queries per 10 minutes. The
+ cache contents also gets updated whenever a player successfully joins, since that makes the server
+ contact the API service, too, and retrieve the relevant data.
]],
Functions =
{
--
cgit v1.2.3