From: ShadowNinja <shadowninja@minetest.net>
Date: Sat, 3 Jun 2017 18:39:49 +0000 (-0400)
Subject: Update remove_player documentation
X-Git-Tag: 0.4.16~1
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=e4d3639d403f1d7cc4223bcca3816d8f19198cb6;p=oweals%2Fminetest.git

Update remove_player documentation

This function only removes player meta data,
not player authentication data.
---

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 9bf0b551b..ddfd0c202 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2789,6 +2789,7 @@ These functions return the leftover itemstack.
 * `minetest.get_server_status()`: returns server status string
 * `minetest.get_server_uptime()`: returns the server uptime in seconds
 * `minetest.remove_player(name)`: remove player from database (if he is not connected).
+    * Does not remove player authentication data, minetest.player_exists will continue to return true.
     * Returns a code (0: successful, 1: no such player, 2: player is connected)
 
 ### Bans